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/domain-internal.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(const struct lttng_dynamic_pointer_array
*exclusions
)
201 const size_t count
= lttng_dynamic_pointer_array_get_count(exclusions
);
210 ret
= mi_lttng_writer_open_element(writer
, config_element_exclusions
);
215 for (i
= 0; i
< count
; i
++) {
216 const char *exclusion
= lttng_dynamic_pointer_array_get_pointer(
219 ret
= mi_lttng_writer_write_element_string(writer
,
220 config_element_exclusion
, exclusion
);
226 /* Close exclusions element */
227 ret
= mi_lttng_writer_close_element(writer
);
234 * Return allocated string for pretty-printing exclusion names.
237 char *print_exclusions(const struct lttng_dynamic_pointer_array
*exclusions
)
241 const char preamble
[] = " excluding ";
243 const size_t count
= lttng_dynamic_pointer_array_get_count(exclusions
);
249 /* Calculate total required length. */
250 for (i
= 0; i
< count
; i
++) {
251 const char *exclusion
= lttng_dynamic_pointer_array_get_pointer(
254 length
+= strlen(exclusion
) + 4;
257 length
+= sizeof(preamble
);
258 ret
= zmalloc(length
);
263 strncpy(ret
, preamble
, length
);
264 for (i
= 0; i
< count
; i
++) {
265 const char *exclusion
= lttng_dynamic_pointer_array_get_pointer(
269 strcat(ret
, exclusion
);
271 if (i
!= count
- 1) {
280 int check_exclusion_subsets(const char *event_name
, const char *exclusion
)
284 const char *e
= event_name
;
285 const char *x
= exclusion
;
287 /* Scan both the excluder and the event letter by letter */
301 /* Event is a subset of the excluder */
302 ERR("Event %s: %s excludes all events from %s",
303 event_name
, exclusion
, event_name
);
309 * Reached the end of the event name before the
310 * end of the exclusion: this is valid.
332 WARN("Event %s: %s does not exclude any events from %s",
333 event_name
, exclusion
, event_name
);
339 int validate_exclusion_list(const char *event_name
,
340 const struct lttng_dynamic_pointer_array
*exclusions
)
344 /* Event name must be a valid globbing pattern to allow exclusions. */
345 if (!strutils_is_star_glob_pattern(event_name
)) {
346 ERR("Event %s: Exclusions can only be used with a globbing pattern",
352 * If the event name is a star-at-end only globbing pattern,
353 * then we can validate the individual exclusions. Otherwise
354 * all exclusions are passed to the session daemon.
356 if (strutils_is_star_at_the_end_only_glob_pattern(event_name
)) {
357 size_t i
, num_exclusions
;
359 num_exclusions
= lttng_dynamic_pointer_array_get_count(exclusions
);
361 for (i
= 0; i
< num_exclusions
; i
++) {
362 const char *exclusion
=
363 lttng_dynamic_pointer_array_get_pointer(
366 if (!strutils_is_star_glob_pattern(exclusion
) ||
367 strutils_is_star_at_the_end_only_glob_pattern(exclusion
)) {
368 ret
= check_exclusion_subsets(event_name
, exclusion
);
386 static int create_exclusion_list_and_validate(const char *event_name
,
387 const char *exclusions_arg
,
388 struct lttng_dynamic_pointer_array
*exclusions
)
392 /* Split exclusions. */
393 ret
= strutils_split(exclusions_arg
, ',', true, exclusions
);
398 if (validate_exclusion_list(event_name
, exclusions
) !=
407 lttng_dynamic_pointer_array_reset(exclusions
);
413 static void warn_on_truncated_exclusion_names(const struct lttng_dynamic_pointer_array
*exclusions
,
417 const size_t num_exclusions
= lttng_dynamic_pointer_array_get_count(exclusions
);
419 for (i
= 0; i
< num_exclusions
; i
++) {
420 const char * const exclusion
= lttng_dynamic_pointer_array_get_pointer(exclusions
, i
);
422 if (strlen(exclusion
) >= LTTNG_SYMBOL_NAME_LEN
) {
423 WARN("Event exclusion \"%s\" will be truncated",
431 * Enabling event using the lttng API.
432 * Note: in case of error only the last error code will be return.
434 static int enable_events(char *session_name
)
436 int ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
;
437 int error_holder
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 1;
438 char *event_name
, *channel_name
= NULL
;
439 struct lttng_event
*ev
;
440 struct lttng_domain dom
= {};
441 struct lttng_dynamic_pointer_array exclusions
;
442 struct lttng_userspace_probe_location
*uprobe_loc
= NULL
;
444 lttng_dynamic_pointer_array_init(&exclusions
, NULL
);
446 ev
= lttng_event_create();
454 WARN("Kernel loglevels are not supported.");
458 /* Create lttng domain */
460 dom
.type
= LTTNG_DOMAIN_KERNEL
;
461 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
462 } else if (opt_userspace
) {
463 dom
.type
= LTTNG_DOMAIN_UST
;
465 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
466 } else if (opt_jul
) {
467 dom
.type
= LTTNG_DOMAIN_JUL
;
469 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
470 } else if (opt_log4j
) {
471 dom
.type
= LTTNG_DOMAIN_LOG4J
;
473 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
474 } else if (opt_python
) {
475 dom
.type
= LTTNG_DOMAIN_PYTHON
;
477 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
479 /* Checked by the caller. */
485 case LTTNG_DOMAIN_KERNEL
:
486 case LTTNG_DOMAIN_JUL
:
487 case LTTNG_DOMAIN_LOG4J
:
488 case LTTNG_DOMAIN_PYTHON
:
489 ERR("Event name exclusions are not yet implemented for %s events",
490 lttng_domain_type_str(dom
.type
));
493 case LTTNG_DOMAIN_UST
:
494 /* Exclusions supported */
502 * Adding a filter to a probe, function or userspace-probe would be
503 * denied by the kernel tracer as it's not supported at the moment. We
504 * do an early check here to warn the user.
506 if (opt_filter
&& opt_kernel
) {
507 switch (opt_event_type
) {
508 case LTTNG_EVENT_ALL
:
509 case LTTNG_EVENT_TRACEPOINT
:
510 case LTTNG_EVENT_SYSCALL
:
512 case LTTNG_EVENT_PROBE
:
513 case LTTNG_EVENT_USERSPACE_PROBE
:
514 case LTTNG_EVENT_FUNCTION
:
515 ERR("Filter expressions are not supported for %s events",
516 get_event_type_str(opt_event_type
));
525 channel_name
= opt_channel_name
;
527 handle
= lttng_create_handle(session_name
, &dom
);
528 if (handle
== NULL
) {
535 /* Open a events element */
536 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
543 if (opt_enable_all
) {
544 /* Default setup for enable all */
546 ev
->type
= opt_event_type
;
547 strcpy(ev
->name
, "*");
548 /* kernel loglevels not implemented */
549 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
551 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
552 strcpy(ev
->name
, "*");
553 ev
->loglevel_type
= opt_loglevel_type
;
557 assert(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
560 enum lttng_loglevel loglevel
;
562 name_search_ret
= loglevel_name_to_value(opt_loglevel
, &loglevel
);
563 ev
->loglevel
= (int) loglevel
;
564 } else if (opt_jul
) {
565 enum lttng_loglevel_jul loglevel
;
567 name_search_ret
= loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
568 ev
->loglevel
= (int) loglevel
;
569 } else if (opt_log4j
) {
570 enum lttng_loglevel_log4j loglevel
;
572 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
, &loglevel
);
573 ev
->loglevel
= (int) loglevel
;
576 enum lttng_loglevel_python loglevel
;
578 name_search_ret
= loglevel_python_name_to_value(opt_loglevel
, &loglevel
);
579 ev
->loglevel
= (int) loglevel
;
582 if (name_search_ret
== -1) {
583 ERR("Unknown loglevel %s", opt_loglevel
);
584 ret
= -LTTNG_ERR_INVALID
;
588 assert(opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
);
591 } else if (opt_jul
) {
592 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
593 } else if (opt_log4j
) {
594 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
595 } else if (opt_python
) {
596 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
602 ret
= create_exclusion_list_and_validate("*",
603 opt_exclude
, &exclusions
);
610 warn_on_truncated_exclusion_names(&exclusions
,
614 ret
= lttng_enable_event_with_exclusions(handle
,
617 lttng_dynamic_pointer_array_get_count(&exclusions
),
618 (char **) exclusions
.array
.buffer
.data
);
621 case LTTNG_ERR_KERN_EVENT_EXIST
:
622 WARN("Kernel events already enabled (channel %s, session %s)",
623 print_channel_name(channel_name
), session_name
);
626 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
628 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
629 ERR("Events: %s (channel %s, session %s)",
631 print_channel_name(channel_name
),
637 ERR("Events: %s (channel %s, session %s)",
639 ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
640 ? print_raw_channel_name(channel_name
)
641 : print_channel_name(channel_name
),
649 switch (opt_event_type
) {
650 case LTTNG_EVENT_TRACEPOINT
:
651 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
652 char *exclusion_string
= print_exclusions(&exclusions
);
654 if (!exclusion_string
) {
655 PERROR("Cannot allocate exclusion_string");
659 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
660 lttng_domain_type_str(dom
.type
),
662 print_channel_name(channel_name
),
664 free(exclusion_string
);
666 char *exclusion_string
= print_exclusions(&exclusions
);
668 if (!exclusion_string
) {
669 PERROR("Cannot allocate exclusion_string");
673 MSG("All %s tracepoints%s are enabled in channel %s",
674 lttng_domain_type_str(dom
.type
),
676 print_channel_name(channel_name
));
677 free(exclusion_string
);
680 case LTTNG_EVENT_SYSCALL
:
682 MSG("All %s system calls are enabled in channel %s",
683 lttng_domain_type_str(dom
.type
),
684 print_channel_name(channel_name
));
687 case LTTNG_EVENT_ALL
:
688 if (opt_loglevel
&& dom
.type
!= LTTNG_DOMAIN_KERNEL
) {
689 char *exclusion_string
= print_exclusions(&exclusions
);
691 if (!exclusion_string
) {
692 PERROR("Cannot allocate exclusion_string");
696 MSG("All %s events%s are enabled in channel %s for loglevel %s",
697 lttng_domain_type_str(dom
.type
),
699 print_channel_name(channel_name
),
701 free(exclusion_string
);
703 char *exclusion_string
= print_exclusions(&exclusions
);
705 if (!exclusion_string
) {
706 PERROR("Cannot allocate exclusion_string");
710 MSG("All %s events%s are enabled in channel %s",
711 lttng_domain_type_str(dom
.type
),
713 print_channel_name(channel_name
));
714 free(exclusion_string
);
719 * We should not be here since lttng_enable_event should have
720 * failed on the event type.
727 command_ret
= lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
729 lttng_dynamic_pointer_array_get_count(&exclusions
),
730 (char **) exclusions
.array
.buffer
.data
);
731 if (command_ret
< 0) {
732 switch (-command_ret
) {
733 case LTTNG_ERR_FILTER_EXIST
:
734 WARN("Filter on all events is already enabled"
735 " (channel %s, session %s)",
736 print_channel_name(channel_name
), session_name
);
739 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
741 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
742 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
744 print_channel_name(channel_name
),
745 session_name
, opt_filter
);
750 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
751 lttng_strerror(command_ret
),
752 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
753 ? print_raw_channel_name(channel_name
)
754 : print_channel_name(channel_name
),
755 session_name
, opt_filter
);
759 error_holder
= command_ret
;
762 MSG("Filter '%s' successfully set", opt_filter
);
767 /* The wildcard * is used for kernel and ust domain to
768 * represent ALL. We copy * in event name to force the wildcard use
771 * Note: this is strictly for semantic and printing while in
772 * machine interface mode.
774 strcpy(ev
->name
, "*");
776 /* If we reach here the events are enabled */
777 if (!error
&& !warn
) {
783 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
789 /* print exclusion */
790 ret
= mi_print_exclusion(&exclusions
);
797 ret
= mi_lttng_writer_write_element_bool(writer
,
798 mi_lttng_element_command_success
, success
);
804 /* Close event element */
805 ret
= mi_lttng_writer_close_element(writer
);
815 /* Strip event list */
816 event_name
= strtok(opt_event_list
, ",");
817 while (event_name
!= NULL
) {
818 /* Copy name and type of the event */
819 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
820 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
821 ev
->type
= opt_event_type
;
823 /* Kernel tracer action */
825 DBG("Enabling kernel event %s for channel %s",
827 print_channel_name(channel_name
));
829 switch (opt_event_type
) {
830 case LTTNG_EVENT_ALL
: /* Enable tracepoints and syscalls */
831 /* If event name differs from *, select tracepoint. */
832 if (strcmp(ev
->name
, "*")) {
833 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
836 case LTTNG_EVENT_TRACEPOINT
:
838 case LTTNG_EVENT_PROBE
:
839 ret
= parse_probe_opts(ev
, opt_probe
);
841 ERR("Unable to parse probe options");
846 case LTTNG_EVENT_USERSPACE_PROBE
:
847 assert(ev
->type
== LTTNG_EVENT_USERSPACE_PROBE
);
849 ret
= parse_userspace_probe_opts(opt_userspace_probe
, &uprobe_loc
);
852 case CMD_UNSUPPORTED
:
854 * Error message describing
855 * what is not supported was
856 * printed in the function.
861 ERR("Unable to parse userspace probe options");
867 ret
= lttng_event_set_userspace_probe_location(ev
, uprobe_loc
);
869 WARN("Failed to set probe location on event");
874 /* Ownership of the uprobe location was transferred to the event. */
877 case LTTNG_EVENT_FUNCTION
:
878 ret
= parse_probe_opts(ev
, opt_function
);
880 ERR("Unable to parse function probe options");
885 case LTTNG_EVENT_SYSCALL
:
886 ev
->type
= LTTNG_EVENT_SYSCALL
;
893 /* kernel loglevels not implemented */
894 ev
->loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
895 } else if (opt_userspace
) { /* User-space tracer action */
896 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name
,
897 print_channel_name(channel_name
), opt_loglevel
? : "<all>");
899 switch (opt_event_type
) {
900 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
902 case LTTNG_EVENT_TRACEPOINT
:
903 /* Copy name and type of the event */
904 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
905 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
906 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
908 case LTTNG_EVENT_PROBE
:
909 case LTTNG_EVENT_FUNCTION
:
910 case LTTNG_EVENT_SYSCALL
:
911 case LTTNG_EVENT_USERSPACE_PROBE
:
913 ERR("Event type not available for user-space tracing");
914 ret
= CMD_UNSUPPORTED
;
920 if (opt_event_type
!= LTTNG_EVENT_ALL
&& opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
921 ERR("Exclusion option can only be used with tracepoint events");
925 /* Free previously allocated items. */
926 lttng_dynamic_pointer_array_reset(&exclusions
);
927 ret
= create_exclusion_list_and_validate(
928 event_name
, opt_exclude
,
935 warn_on_truncated_exclusion_names(
939 ev
->loglevel_type
= opt_loglevel_type
;
941 enum lttng_loglevel loglevel
;
942 const int name_search_ret
= loglevel_name_to_value(opt_loglevel
, &loglevel
);
944 if (name_search_ret
== -1) {
945 ERR("Unknown loglevel %s", opt_loglevel
);
946 ret
= -LTTNG_ERR_INVALID
;
950 ev
->loglevel
= (int) loglevel
;
954 } else if (opt_jul
|| opt_log4j
|| opt_python
) {
955 if (opt_event_type
!= LTTNG_EVENT_ALL
&&
956 opt_event_type
!= LTTNG_EVENT_TRACEPOINT
) {
957 ERR("Event type not supported for domain.");
958 ret
= CMD_UNSUPPORTED
;
962 ev
->loglevel_type
= opt_loglevel_type
;
967 enum lttng_loglevel_jul loglevel
;
969 name_search_ret
= loglevel_jul_name_to_value(opt_loglevel
, &loglevel
);
970 ev
->loglevel
= (int) loglevel
;
971 } else if (opt_log4j
) {
972 enum lttng_loglevel_log4j loglevel
;
974 name_search_ret
= loglevel_log4j_name_to_value(opt_loglevel
, &loglevel
);
975 ev
->loglevel
= (int) loglevel
;
978 enum lttng_loglevel_python loglevel
;
980 name_search_ret
= loglevel_python_name_to_value(opt_loglevel
, &loglevel
);
981 ev
->loglevel
= (int) loglevel
;
984 if (name_search_ret
) {
985 ERR("Unknown loglevel %s", opt_loglevel
);
986 ret
= -LTTNG_ERR_INVALID
;
991 ev
->loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
992 } else if (opt_log4j
) {
993 ev
->loglevel
= LTTNG_LOGLEVEL_LOG4J_ALL
;
994 } else if (opt_python
) {
995 ev
->loglevel
= LTTNG_LOGLEVEL_PYTHON_DEBUG
;
998 ev
->type
= LTTNG_EVENT_TRACEPOINT
;
999 strncpy(ev
->name
, event_name
, LTTNG_SYMBOL_NAME_LEN
);
1000 ev
->name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
1006 char *exclusion_string
;
1008 command_ret
= lttng_enable_event_with_exclusions(handle
,
1011 lttng_dynamic_pointer_array_get_count(&exclusions
),
1012 (char **) exclusions
.array
.buffer
.data
);
1013 exclusion_string
= print_exclusions(&exclusions
);
1014 if (!exclusion_string
) {
1015 PERROR("Cannot allocate exclusion_string");
1019 if (command_ret
< 0) {
1020 /* Turn ret to positive value to handle the positive error code */
1021 switch (-command_ret
) {
1022 case LTTNG_ERR_KERN_EVENT_EXIST
:
1023 WARN("Kernel event %s%s already enabled (channel %s, session %s)",
1026 print_channel_name(channel_name
), session_name
);
1029 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1031 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
1032 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
1035 print_channel_name(channel_name
),
1040 case LTTNG_ERR_SDT_PROBE_SEMAPHORE
:
1041 ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)",
1042 event_name
, print_channel_name(channel_name
),
1047 ERR("Event %s%s: %s (channel %s, session %s)", event_name
,
1049 lttng_strerror(command_ret
),
1050 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1051 ? print_raw_channel_name(channel_name
)
1052 : print_channel_name(channel_name
),
1057 error_holder
= command_ret
;
1060 case LTTNG_DOMAIN_KERNEL
:
1061 case LTTNG_DOMAIN_UST
:
1062 MSG("%s event %s%s created in channel %s",
1063 lttng_domain_type_str(dom
.type
),
1066 print_channel_name(channel_name
));
1068 case LTTNG_DOMAIN_JUL
:
1069 case LTTNG_DOMAIN_LOG4J
:
1070 case LTTNG_DOMAIN_PYTHON
:
1072 * Don't print the default channel
1073 * name for agent domains.
1075 MSG("%s event %s%s enabled",
1076 lttng_domain_type_str(dom
.type
),
1084 free(exclusion_string
);
1088 char *exclusion_string
;
1090 /* Filter present */
1093 command_ret
= lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
1095 lttng_dynamic_pointer_array_get_count(&exclusions
),
1096 (char **) exclusions
.array
.buffer
.data
);
1097 exclusion_string
= print_exclusions(&exclusions
);
1098 if (!exclusion_string
) {
1099 PERROR("Cannot allocate exclusion_string");
1103 if (command_ret
< 0) {
1104 switch (-command_ret
) {
1105 case LTTNG_ERR_FILTER_EXIST
:
1106 WARN("Filter on event %s%s is already enabled"
1107 " (channel %s, session %s)",
1110 print_channel_name(channel_name
), session_name
);
1113 case LTTNG_ERR_TRACE_ALREADY_STARTED
:
1115 const char *msg
= "The command tried to enable an event in a new domain for a session that has already been started once.";
1116 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
->name
,
1119 print_channel_name(channel_name
),
1120 session_name
, opt_filter
);
1125 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev
->name
,
1127 lttng_strerror(command_ret
),
1128 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
1129 ? print_raw_channel_name(channel_name
)
1130 : print_channel_name(channel_name
),
1131 session_name
, opt_filter
);
1135 error_holder
= command_ret
;
1138 MSG("Event %s%s: Filter '%s' successfully set",
1139 event_name
, exclusion_string
,
1142 free(exclusion_string
);
1153 ret
= mi_lttng_event(writer
, ev
, 1, handle
->domain
.type
);
1159 /* print exclusion */
1160 ret
= mi_print_exclusion(&exclusions
);
1167 ret
= mi_lttng_writer_write_element_bool(writer
,
1168 mi_lttng_element_command_success
, success
);
1174 /* Close event element */
1175 ret
= mi_lttng_writer_close_element(writer
);
1183 event_name
= strtok(NULL
, ",");
1184 /* Reset warn, error and success */
1191 /* Close events element */
1192 ret
= mi_lttng_writer_close_element(writer
);
1205 lttng_destroy_handle(handle
);
1206 lttng_dynamic_pointer_array_reset(&exclusions
);
1207 lttng_userspace_probe_location_destroy(uprobe_loc
);
1209 /* Overwrite ret with error_holder if there was an actual error with
1210 * enabling an event.
1212 ret
= error_holder
? error_holder
: ret
;
1214 lttng_event_destroy(ev
);
1219 * Add event to trace session
1221 int cmd_enable_events(int argc
, const char **argv
)
1223 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
1224 static poptContext pc
;
1225 char *session_name
= 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 opt_event_list
= (char*) poptGetArg(pc
);
1325 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
1326 ERR("Missing event name(s).\n");
1331 leftover
= poptGetArg(pc
);
1333 ERR("Unknown argument: %s", leftover
);
1338 if (!opt_session_name
) {
1339 session_name
= get_session_name();
1340 if (session_name
== NULL
) {
1341 command_ret
= CMD_ERROR
;
1346 session_name
= opt_session_name
;
1349 command_ret
= enable_events(session_name
);
1358 /* Close output element */
1359 ret
= mi_lttng_writer_close_element(writer
);
1365 ret
= mi_lttng_writer_write_element_bool(writer
,
1366 mi_lttng_element_command_success
, success
);
1372 /* Command element close */
1373 ret
= mi_lttng_writer_command_close(writer
);
1382 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1383 /* Preserve original error code */
1384 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
1387 if (opt_session_name
== NULL
) {
1391 /* Overwrite ret if an error occurred in enable_events */
1392 ret
= command_ret
? command_ret
: ret
;
1394 poptFreeContext(pc
);