2 * Copyright (C) 2021 Simon Marchi <simon.marchi@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
13 #include "../command.h"
14 #include "../loglevel.h"
15 #include "../uprobe.h"
17 #include "common/argpar/argpar.h"
18 #include "common/argpar-utils/argpar-utils.h"
19 #include "common/dynamic-array.h"
20 #include "common/mi-lttng.h"
21 #include "common/string-utils/string-utils.h"
22 #include "common/utils.h"
23 #include <lttng/domain-internal.h>
24 /* For lttng_event_rule_type_str(). */
25 #include <lttng/event-rule/event-rule-internal.h>
26 #include <lttng/lttng.h>
27 #include "common/filter/filter-ast.h"
28 #include "common/filter/filter-ir.h"
29 #include "common/dynamic-array.h"
31 #if (LTTNG_SYMBOL_NAME_LEN == 256)
32 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
35 #ifdef LTTNG_EMBED_HELP
36 static const char help_msg
[] =
37 #include <lttng-add-trigger.1.h>
69 static const struct argpar_opt_descr event_rule_opt_descrs
[] = {
70 { OPT_FILTER
, 'f', "filter", true },
71 { OPT_NAME
, 'n', "name", true },
72 { OPT_EXCLUDE_NAME
, 'x', "exclude-name", true },
73 { OPT_LOG_LEVEL
, 'l', "log-level", true },
74 { OPT_EVENT_NAME
, 'E', "event-name", true },
76 { OPT_TYPE
, 't', "type", true },
77 { OPT_LOCATION
, 'L', "location", true },
79 /* Capture descriptor */
80 { OPT_CAPTURE
, '\0', "capture", true },
82 ARGPAR_OPT_DESCR_SENTINEL
86 bool has_syscall_prefix(const char *arg
)
89 const char kernel_syscall_type_opt_prefix
[] = "kernel:syscall";
90 const size_t kernel_syscall_type_opt_prefix_len
=
91 sizeof(kernel_syscall_type_opt_prefix
) - 1;
92 const char syscall_type_opt_prefix
[] = "syscall";
93 const size_t syscall_type_opt_prefix_len
=
94 sizeof(syscall_type_opt_prefix
) - 1;
96 if (strncmp(arg
, syscall_type_opt_prefix
,
97 syscall_type_opt_prefix_len
) == 0) {
99 } else if (strncmp(arg
, kernel_syscall_type_opt_prefix
,
100 kernel_syscall_type_opt_prefix_len
) == 0) {
110 bool assign_event_rule_type(enum lttng_event_rule_type
*dest
, const char *arg
)
114 if (*dest
!= LTTNG_EVENT_RULE_TYPE_UNKNOWN
) {
115 ERR("More than one `--type` was specified.");
119 if (strcmp(arg
, "user") == 0 || strcmp(arg
, "user:tracepoint") == 0) {
120 *dest
= LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
;
121 } else if (strcmp(arg
, "kernel") == 0 ||
122 strcmp(arg
, "kernel:tracepoint") == 0) {
123 *dest
= LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
;
124 } else if (strcmp(arg
, "jul") == 0 || strcmp(arg
, "jul:logging") == 0) {
125 *dest
= LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
;
126 } else if (strcmp(arg
, "log4j") == 0 ||
127 strcmp(arg
, "log4j:logging") == 0) {
128 *dest
= LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
;
129 } else if (strcmp(arg
, "python") == 0 ||
130 strcmp(arg
, "python:logging") == 0) {
131 *dest
= LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
;
132 } else if (strcmp(arg
, "kprobe") == 0 ||
133 strcmp(arg
, "kernel:kprobe") == 0) {
134 *dest
= LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
;
135 } else if (strcmp(arg
, "kernel:uprobe") == 0) {
136 *dest
= LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
;
137 } else if (has_syscall_prefix(arg
)) {
139 * Matches the following:
143 * - syscall:entry+exit
146 * - kernel:syscall:entry
147 * - kernel:syscall:exit
148 * - kernel:syscall:entry+exit
151 * Validation for the right side is left to further usage sites.
153 *dest
= LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
;
155 ERR("Invalid `--type` value: %s", arg
);
170 bool assign_string(char **dest
, const char *src
, const char *opt_name
)
175 ERR("Duplicate '%s' given.", opt_name
);
181 PERROR("Failed to allocate string '%s'.", opt_name
);
195 static bool parse_syscall_emission_site_from_type(const char *str
,
196 enum lttng_event_rule_kernel_syscall_emission_site
*type
)
199 const char kernel_prefix
[] = "kernel:";
200 const size_t kernel_prefix_len
= sizeof(kernel_prefix
) - 1;
203 * If the passed string is of the form "kernel:syscall*", move the
204 * pointer passed "kernel:".
206 if (strncmp(str
, kernel_prefix
, kernel_prefix_len
) == 0) {
207 str
= &str
[kernel_prefix_len
];
210 if (strcmp(str
, "syscall") == 0 ||
211 strcmp(str
, "syscall:entry+exit") == 0) {
212 *type
= LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY_EXIT
;
213 } else if (strcmp(str
, "syscall:entry") == 0) {
214 *type
= LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_ENTRY
;
215 } else if (strcmp(str
, "syscall:exit") == 0) {
216 *type
= LTTNG_EVENT_RULE_KERNEL_SYSCALL_EMISSION_SITE_EXIT
;
228 * Parse `str` as a log level against the passed event rule type.
230 * Return the log level in `*log_level`. Return true in `*log_level_only` if
231 * the string specifies exactly this log level, false if it specifies at least
234 * Return true if the string was successfully parsed as a log level string.
236 static bool parse_log_level_string(const char *str
,
237 enum lttng_event_rule_type event_rule_type
,
239 bool *log_level_only
)
243 switch (event_rule_type
) {
244 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
246 enum lttng_loglevel log_level_min
, log_level_max
;
247 if (!loglevel_parse_range_string(
248 str
, &log_level_min
, &log_level_max
)) {
252 /* Only support VAL and VAL.. for now. */
253 if (log_level_min
!= log_level_max
&&
254 log_level_max
!= LTTNG_LOGLEVEL_EMERG
) {
258 *log_level
= (int) log_level_min
;
259 *log_level_only
= log_level_min
== log_level_max
;
262 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
264 enum lttng_loglevel_log4j log_level_min
, log_level_max
;
265 if (!loglevel_log4j_parse_range_string(
266 str
, &log_level_min
, &log_level_max
)) {
270 /* Only support VAL and VAL.. for now. */
271 if (log_level_min
!= log_level_max
&&
272 log_level_max
!= LTTNG_LOGLEVEL_LOG4J_FATAL
) {
276 *log_level
= (int) log_level_min
;
277 *log_level_only
= log_level_min
== log_level_max
;
280 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
282 enum lttng_loglevel_jul log_level_min
, log_level_max
;
283 if (!loglevel_jul_parse_range_string(
284 str
, &log_level_min
, &log_level_max
)) {
288 /* Only support VAL and VAL.. for now. */
289 if (log_level_min
!= log_level_max
&&
290 log_level_max
!= LTTNG_LOGLEVEL_JUL_SEVERE
) {
294 *log_level
= (int) log_level_min
;
295 *log_level_only
= log_level_min
== log_level_max
;
298 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
300 enum lttng_loglevel_python log_level_min
, log_level_max
;
301 if (!loglevel_python_parse_range_string(
302 str
, &log_level_min
, &log_level_max
)) {
306 /* Only support VAL and VAL.. for now. */
307 if (log_level_min
!= log_level_max
&&
309 LTTNG_LOGLEVEL_PYTHON_CRITICAL
) {
313 *log_level
= (int) log_level_min
;
314 *log_level_only
= log_level_min
== log_level_max
;
318 /* Invalid domain type. */
332 static int parse_kernel_probe_opts(const char *source
,
333 struct lttng_kernel_probe_location
**location
)
338 char name
[LTTNG_SYMBOL_NAME_LEN
];
339 char *symbol_name
= NULL
;
342 /* Check for symbol+offset. */
343 match
= sscanf(source
,
344 "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
348 if (*s_hex
== '\0') {
349 ERR("Kernel probe symbol offset is missing.");
353 symbol_name
= strndup(name
, LTTNG_SYMBOL_NAME_LEN
);
355 PERROR("Failed to copy kernel probe location symbol name.");
358 offset
= strtoul(s_hex
, NULL
, 0);
360 *location
= lttng_kernel_probe_location_symbol_create(
361 symbol_name
, offset
);
363 ERR("Failed to create symbol kernel probe location.");
370 /* Check for symbol. */
371 if (isalpha(name
[0]) || name
[0] == '_') {
372 match
= sscanf(source
,
373 "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
377 symbol_name
= strndup(name
, LTTNG_SYMBOL_NAME_LEN
);
379 ERR("Failed to copy kernel probe location symbol name.");
383 *location
= lttng_kernel_probe_location_symbol_create(
386 ERR("Failed to create symbol kernel probe location.");
394 /* Check for address. */
395 match
= sscanf(source
, "%18s", s_hex
);
399 if (*s_hex
== '\0') {
400 ERR("Invalid kernel probe location address.");
404 address
= strtoul(s_hex
, NULL
, 0);
405 *location
= lttng_kernel_probe_location_address_create(address
);
407 ERR("Failed to create symbol kernel probe location.");
425 struct lttng_event_expr
*ir_op_load_expr_to_event_expr(
426 const struct ir_load_expression
*load_expr
,
427 const char *capture_str
)
429 char *provider_name
= NULL
;
430 struct lttng_event_expr
*event_expr
= NULL
;
431 const struct ir_load_expression_op
*load_expr_op
= load_expr
->child
;
432 const enum ir_load_expression_type load_expr_child_type
=
435 switch (load_expr_child_type
) {
436 case IR_LOAD_EXPRESSION_GET_PAYLOAD_ROOT
:
437 case IR_LOAD_EXPRESSION_GET_CONTEXT_ROOT
:
439 const char *field_name
;
441 load_expr_op
= load_expr_op
->next
;
442 LTTNG_ASSERT(load_expr_op
);
443 LTTNG_ASSERT(load_expr_op
->type
== IR_LOAD_EXPRESSION_GET_SYMBOL
);
444 field_name
= load_expr_op
->u
.symbol
;
445 LTTNG_ASSERT(field_name
);
447 event_expr
= load_expr_child_type
== IR_LOAD_EXPRESSION_GET_PAYLOAD_ROOT
?
448 lttng_event_expr_event_payload_field_create(field_name
) :
449 lttng_event_expr_channel_context_field_create(field_name
);
451 ERR("Failed to create %s event expression: field name = `%s`.",
452 load_expr_child_type
== IR_LOAD_EXPRESSION_GET_PAYLOAD_ROOT
?
453 "payload field" : "channel context",
460 case IR_LOAD_EXPRESSION_GET_APP_CONTEXT_ROOT
:
463 const char *type_name
;
464 const char *field_name
;
466 load_expr_op
= load_expr_op
->next
;
467 LTTNG_ASSERT(load_expr_op
);
468 LTTNG_ASSERT(load_expr_op
->type
== IR_LOAD_EXPRESSION_GET_SYMBOL
);
469 field_name
= load_expr_op
->u
.symbol
;
470 LTTNG_ASSERT(field_name
);
473 * The field name needs to be of the form PROVIDER:TYPE. We
476 colon
= strchr(field_name
, ':');
478 ERR("Invalid app-specific context field name: missing colon in `%s`.",
483 type_name
= colon
+ 1;
484 if (*type_name
== '\0') {
485 ERR("Invalid app-specific context field name: missing type name after colon in `%s`.",
490 provider_name
= strndup(field_name
, colon
- field_name
);
491 if (!provider_name
) {
492 PERROR("Failed to allocate field name string");
496 event_expr
= lttng_event_expr_app_specific_context_field_create(
497 provider_name
, type_name
);
499 ERR("Failed to create app-specific context field event expression: provider name = `%s`, type name = `%s`",
500 provider_name
, type_name
);
507 ERR("%s: unexpected load expr type %d.", __func__
,
512 load_expr_op
= load_expr_op
->next
;
514 /* There may be a single array index after that. */
515 if (load_expr_op
->type
== IR_LOAD_EXPRESSION_GET_INDEX
) {
516 struct lttng_event_expr
*index_event_expr
;
517 const uint64_t index
= load_expr_op
->u
.index
;
519 index_event_expr
= lttng_event_expr_array_field_element_create(event_expr
, index
);
520 if (!index_event_expr
) {
521 ERR("Failed to create array field element event expression.");
525 event_expr
= index_event_expr
;
526 load_expr_op
= load_expr_op
->next
;
529 switch (load_expr_op
->type
) {
530 case IR_LOAD_EXPRESSION_LOAD_FIELD
:
532 * This is what we expect, IR_LOAD_EXPRESSION_LOAD_FIELD is
533 * always found at the end of the chain.
536 case IR_LOAD_EXPRESSION_GET_SYMBOL
:
537 ERR("While parsing expression `%s`: Capturing subfields is not supported.",
542 ERR("%s: unexpected load expression operator %s.", __func__
,
543 ir_load_expression_type_str(load_expr_op
->type
));
550 lttng_event_expr_destroy(event_expr
);
560 struct lttng_event_expr
*ir_op_load_to_event_expr(
561 const struct ir_op
*ir
, const char *capture_str
)
563 struct lttng_event_expr
*event_expr
= NULL
;
565 LTTNG_ASSERT(ir
->op
== IR_OP_LOAD
);
567 switch (ir
->data_type
) {
568 case IR_DATA_EXPRESSION
:
570 const struct ir_load_expression
*ir_load_expr
=
571 ir
->u
.load
.u
.expression
;
573 event_expr
= ir_op_load_expr_to_event_expr(
574 ir_load_expr
, capture_str
);
578 ERR("%s: unexpected data type: %s.", __func__
,
579 ir_data_type_str(ir
->data_type
));
587 const char *ir_operator_type_human_str(enum ir_op_type op
)
609 struct lttng_event_expr
*ir_op_root_to_event_expr(const struct ir_op
*ir
,
610 const char *capture_str
)
612 struct lttng_event_expr
*event_expr
= NULL
;
614 LTTNG_ASSERT(ir
->op
== IR_OP_ROOT
);
615 ir
= ir
->u
.root
.child
;
619 event_expr
= ir_op_load_to_event_expr(ir
, capture_str
);
624 ERR("While parsing expression `%s`: %s operators are not allowed in capture expressions.",
626 ir_operator_type_human_str(ir
->op
));
629 ERR("%s: unexpected IR op type: %s.", __func__
,
630 ir_op_type_str(ir
->op
));
638 void destroy_event_expr(void *ptr
)
640 lttng_event_expr_destroy((lttng_event_expr
*) ptr
);
643 struct parse_event_rule_res
{
645 struct lttng_event_rule
*er
;
647 /* Array of `struct lttng_event_expr *` */
648 struct lttng_dynamic_pointer_array capture_descriptors
;
652 struct parse_event_rule_res
parse_event_rule(int *argc
, const char ***argv
,
655 enum lttng_event_rule_type event_rule_type
=
656 LTTNG_EVENT_RULE_TYPE_UNKNOWN
;
657 struct argpar_iter
*argpar_iter
= NULL
;
658 const struct argpar_item
*argpar_item
= NULL
;
659 int consumed_args
= -1;
660 struct lttng_kernel_probe_location
*kernel_probe_location
= NULL
;
661 struct lttng_userspace_probe_location
*userspace_probe_location
= NULL
;
662 struct parse_event_rule_res res
= { 0 };
663 struct lttng_event_expr
*event_expr
= NULL
;
664 struct filter_parser_ctx
*parser_ctx
= NULL
;
665 struct lttng_log_level_rule
*log_level_rule
= NULL
;
667 /* Event rule type option */
668 char *event_rule_type_str
= NULL
;
670 /* Tracepoint and syscall options. */
672 /* Array of strings. */
673 struct lttng_dynamic_pointer_array exclude_names
;
675 /* For userspace / kernel probe and function. */
676 char *location
= NULL
;
677 char *event_name
= NULL
;
683 char *log_level_str
= NULL
;
685 lttng_dynamic_pointer_array_init(&res
.capture_descriptors
,
688 lttng_dynamic_pointer_array_init(&exclude_names
, free
);
690 argpar_iter
= argpar_iter_create(*argc
, *argv
, event_rule_opt_descrs
);
692 ERR("Failed to allocate an argpar iter.");
697 enum parse_next_item_status status
;
699 status
= parse_next_item(argpar_iter
, &argpar_item
,
700 argc_offset
, *argv
, false, NULL
, NULL
);
701 if (status
== PARSE_NEXT_ITEM_STATUS_ERROR
||
702 status
== PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
) {
704 } else if (status
== PARSE_NEXT_ITEM_STATUS_END
) {
708 LTTNG_ASSERT(status
== PARSE_NEXT_ITEM_STATUS_OK
);
710 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
711 const struct argpar_opt_descr
*descr
=
712 argpar_item_opt_descr(argpar_item
);
713 const char *arg
= argpar_item_opt_arg(argpar_item
);
717 if (!assign_event_rule_type(&event_rule_type
, arg
)) {
721 /* Save the string for later use. */
722 if (!assign_string(&event_rule_type_str
, arg
,
729 if (!assign_string(&location
, arg
,
736 if (!assign_string(&event_name
, arg
,
737 "--event-name/-E")) {
743 if (!assign_string(&filter
, arg
,
750 if (!assign_string(&name
, arg
,
756 case OPT_EXCLUDE_NAME
:
760 ret
= lttng_dynamic_pointer_array_add_pointer(
764 ERR("Failed to add pointer to dynamic pointer array.");
771 if (!assign_string(&log_level_str
, arg
,
781 ret
= filter_parser_ctx_create_from_filter_expression(
784 ERR("Failed to parse capture expression `%s`.", arg
);
788 event_expr
= ir_op_root_to_event_expr(
789 parser_ctx
->ir_root
, arg
);
792 * ir_op_root_to_event_expr has printed
798 ret
= lttng_dynamic_pointer_array_add_pointer(
799 &res
.capture_descriptors
,
806 * The ownership of event expression was
807 * transferred to the dynamic array.
817 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
819 /* Don't accept non-option arguments. */
820 ERR("Unexpected argument '%s'", arg
);
825 if (event_rule_type
== LTTNG_EVENT_RULE_TYPE_UNKNOWN
) {
826 ERR("Event rule requires a --type.");
831 * Option --name is applicable to event rules of type kernel, user, jul,
832 * log4j,python and syscall. If --name is omitted, it is implicitly
835 switch (event_rule_type
) {
836 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
837 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
838 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
839 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
840 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
841 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
849 ERR("Can't use --name with %s event rules.",
850 lttng_event_rule_type_str(
855 if (lttng_dynamic_pointer_array_get_count(&exclude_names
) > 0) {
856 ERR("Can't use --exclude-name/-x with %s event rules.",
857 lttng_event_rule_type_str(
864 * Option --location is only applicable to (and mandatory for) event
865 * rules of type {k,u}probe and function.
867 * Option --event-name is only applicable to event rules of type probe.
868 * If omitted, it defaults to the location.
870 switch (event_rule_type
) {
871 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
872 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
874 ERR("Event rule of type %s requires a --location.",
875 lttng_event_rule_type_str(event_rule_type
));
880 event_name
= strdup(location
);
887 ERR("Can't use --location with %s event rules.",
888 lttng_event_rule_type_str(event_rule_type
));
893 ERR("Can't use --event-name with %s event rules.",
894 lttng_event_rule_type_str(
901 * Update *argc and *argv so our caller can keep parsing what follows.
903 consumed_args
= argpar_iter_ingested_orig_args(argpar_iter
);
904 LTTNG_ASSERT(consumed_args
>= 0);
905 *argc
-= consumed_args
;
906 *argv
+= consumed_args
;
909 * Adding a filter to a probe, function or userspace-probe would be
910 * denied by the kernel tracer as it's not supported at the moment. We
911 * do an early check here to warn the user.
914 switch (event_rule_type
) {
915 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
916 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
917 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
918 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
919 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
920 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
923 ERR("Filter expressions are not supported for %s event rules.",
924 lttng_event_rule_type_str(event_rule_type
));
930 * If --exclude-name/-x was passed, split it into an exclusion list.
931 * Exclusions are only supported by
932 * LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT for now.
934 if (lttng_dynamic_pointer_array_get_count(&exclude_names
) > 0) {
935 if (event_rule_type
!= LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
) {
936 ERR("Event name exclusions are not yet implemented for %s event rules.",
937 lttng_event_rule_type_str(event_rule_type
));
941 if (validate_exclusion_list(name
, &exclude_names
) != 0) {
943 * Assume validate_exclusion_list already prints an
951 switch (event_rule_type
) {
952 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
953 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
954 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
955 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
960 if (strcmp(log_level_str
, "..") == 0) {
962 * ".." is the same as passing no log level
963 * option and correspond to the "ANY" case.
968 if (!parse_log_level_string(log_level_str
, event_rule_type
,
969 &log_level
, &log_level_only
)) {
970 ERR("Failed to parse log level string `%s`.",
975 if (log_level_only
) {
976 log_level_rule
= lttng_log_level_rule_exactly_create(log_level
);
978 log_level_rule
= lttng_log_level_rule_at_least_as_severe_as_create(log_level
);
981 if (log_level_rule
== NULL
) {
982 ERR("Failed to create log level rule object.");
988 ERR("Log levels are not supported for %s event rules.",
989 lttng_event_rule_type_str(event_rule_type
));
994 /* Finally, create the event rule object. */
995 switch (event_rule_type
) {
996 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
998 enum lttng_event_rule_status event_rule_status
;
1000 res
.er
= lttng_event_rule_user_tracepoint_create();
1002 ERR("Failed to create user_tracepoint event rule.");
1007 event_rule_status
= lttng_event_rule_user_tracepoint_set_name_pattern(
1009 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1010 ERR("Failed to set user_tracepoint event rule's pattern to '%s'.",
1017 event_rule_status
= lttng_event_rule_user_tracepoint_set_filter(
1019 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1020 ERR("Failed to set user_tracepoint event rule's filter to '%s'.",
1026 /* Set exclusion list. */
1027 if (lttng_dynamic_pointer_array_get_count(&exclude_names
) > 0) {
1029 int count
= lttng_dynamic_pointer_array_get_count(
1032 for (n
= 0; n
< count
; n
++) {
1033 const char *exclude_name
=
1034 (const char *) lttng_dynamic_pointer_array_get_pointer(
1039 lttng_event_rule_user_tracepoint_add_name_pattern_exclusion(
1042 if (event_rule_status
!=
1043 LTTNG_EVENT_RULE_STATUS_OK
) {
1044 ERR("Failed to set user_tracepoint exclusion list element '%s'",
1051 if (log_level_rule
) {
1053 lttng_event_rule_user_tracepoint_set_log_level_rule(
1054 res
.er
, log_level_rule
);
1056 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1057 ERR("Failed to set log level on event fule.");
1064 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
1066 enum lttng_event_rule_status event_rule_status
;
1068 res
.er
= lttng_event_rule_kernel_tracepoint_create();
1070 ERR("Failed to create kernel_tracepoint event rule.");
1075 event_rule_status
= lttng_event_rule_kernel_tracepoint_set_name_pattern(
1077 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1078 ERR("Failed to set kernel_tracepoint event rule's pattern to '%s'.",
1085 event_rule_status
= lttng_event_rule_kernel_tracepoint_set_filter(
1087 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1088 ERR("Failed to set kernel_tracepoint event rule's filter to '%s'.",
1095 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
1097 enum lttng_event_rule_status event_rule_status
;
1099 res
.er
= lttng_event_rule_jul_logging_create();
1101 ERR("Failed to create jul_logging event rule.");
1106 event_rule_status
= lttng_event_rule_jul_logging_set_name_pattern(
1108 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1109 ERR("Failed to set jul_logging event rule's pattern to '%s'.",
1116 event_rule_status
= lttng_event_rule_jul_logging_set_filter(
1118 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1119 ERR("Failed to set jul_logging event rule's filter to '%s'.",
1125 if (log_level_rule
) {
1127 lttng_event_rule_jul_logging_set_log_level_rule(
1128 res
.er
, log_level_rule
);
1130 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1131 ERR("Failed to set log level on event fule.");
1137 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
1139 enum lttng_event_rule_status event_rule_status
;
1141 res
.er
= lttng_event_rule_log4j_logging_create();
1143 ERR("Failed to create jul_logging event rule.");
1148 event_rule_status
= lttng_event_rule_log4j_logging_set_name_pattern(
1150 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1151 ERR("Failed to set jul_logging event rule's pattern to '%s'.",
1158 event_rule_status
= lttng_event_rule_log4j_logging_set_filter(
1160 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1161 ERR("Failed to set jul_logging event rule's filter to '%s'.",
1167 if (log_level_rule
) {
1169 lttng_event_rule_log4j_logging_set_log_level_rule(
1170 res
.er
, log_level_rule
);
1172 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1173 ERR("Failed to set log level on event fule.");
1179 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
1181 enum lttng_event_rule_status event_rule_status
;
1183 res
.er
= lttng_event_rule_python_logging_create();
1185 ERR("Failed to create jul_logging event rule.");
1190 event_rule_status
= lttng_event_rule_python_logging_set_name_pattern(
1192 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1193 ERR("Failed to set jul_logging event rule's pattern to '%s'.",
1200 event_rule_status
= lttng_event_rule_python_logging_set_filter(
1202 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1203 ERR("Failed to set jul_logging event rule's filter to '%s'.",
1209 if (log_level_rule
) {
1211 lttng_event_rule_python_logging_set_log_level_rule(
1212 res
.er
, log_level_rule
);
1214 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1215 ERR("Failed to set log level on event fule.");
1221 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
1224 enum lttng_event_rule_status event_rule_status
;
1226 ret
= parse_kernel_probe_opts(
1227 location
, &kernel_probe_location
);
1229 ERR("Failed to parse kernel probe location.");
1233 LTTNG_ASSERT(kernel_probe_location
);
1234 res
.er
= lttng_event_rule_kernel_kprobe_create(kernel_probe_location
);
1236 ERR("Failed to create kprobe event rule.");
1241 lttng_event_rule_kernel_kprobe_set_event_name(
1242 res
.er
, event_name
);
1243 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1244 ERR("Failed to set kprobe event rule's name to '%s'.",
1251 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
1254 enum lttng_event_rule_status event_rule_status
;
1256 ret
= parse_userspace_probe_opts(
1257 location
, &userspace_probe_location
);
1259 ERR("Failed to parse user space probe location.");
1263 res
.er
= lttng_event_rule_kernel_uprobe_create(userspace_probe_location
);
1265 ERR("Failed to create userspace probe event rule.");
1270 lttng_event_rule_kernel_uprobe_set_event_name(
1271 res
.er
, event_name
);
1272 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1273 ERR("Failed to set user space probe event rule's name to '%s'.",
1280 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
1282 enum lttng_event_rule_status event_rule_status
;
1283 enum lttng_event_rule_kernel_syscall_emission_site emission_site
;
1285 if (!parse_syscall_emission_site_from_type(
1286 event_rule_type_str
, &emission_site
)) {
1287 ERR("Failed to parse syscall type '%s'.", event_rule_type_str
);
1291 res
.er
= lttng_event_rule_kernel_syscall_create(emission_site
);
1293 ERR("Failed to create syscall event rule.");
1297 event_rule_status
= lttng_event_rule_kernel_syscall_set_name_pattern(
1299 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1300 ERR("Failed to set syscall event rule's pattern to '%s'.",
1306 event_rule_status
= lttng_event_rule_kernel_syscall_set_filter(
1308 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1309 ERR("Failed to set syscall event rule's filter to '%s'.",
1325 lttng_event_rule_destroy(res
.er
);
1327 lttng_dynamic_pointer_array_reset(&res
.capture_descriptors
);
1331 filter_parser_ctx_free(parser_ctx
);
1334 lttng_event_expr_destroy(event_expr
);
1335 argpar_item_destroy(argpar_item
);
1336 argpar_iter_destroy(argpar_iter
);
1339 lttng_dynamic_pointer_array_reset(&exclude_names
);
1340 free(log_level_str
);
1343 free(event_rule_type_str
);
1345 lttng_kernel_probe_location_destroy(kernel_probe_location
);
1346 lttng_userspace_probe_location_destroy(userspace_probe_location
);
1347 lttng_log_level_rule_destroy(log_level_rule
);
1352 struct lttng_condition
*handle_condition_event(int *argc
, const char ***argv
,
1355 struct parse_event_rule_res res
;
1356 struct lttng_condition
*c
;
1359 res
= parse_event_rule(argc
, argv
, argc_offset
);
1365 c
= lttng_condition_event_rule_matches_create(res
.er
);
1366 lttng_event_rule_destroy(res
.er
);
1372 for (i
= 0; i
< lttng_dynamic_pointer_array_get_count(&res
.capture_descriptors
);
1374 enum lttng_condition_status status
;
1375 struct lttng_event_expr
**expr
=
1376 (lttng_event_expr
**) lttng_dynamic_array_get_element(
1377 &res
.capture_descriptors
.array
, i
);
1380 LTTNG_ASSERT(*expr
);
1381 status
= lttng_condition_event_rule_matches_append_capture_descriptor(
1383 if (status
!= LTTNG_CONDITION_STATUS_OK
) {
1384 if (status
== LTTNG_CONDITION_STATUS_UNSUPPORTED
) {
1385 ERR("The capture feature is unsupported by the event-rule condition type");
1391 /* Ownership of event expression moved to `c` */
1398 lttng_condition_destroy(c
);
1402 lttng_dynamic_pointer_array_reset(&res
.capture_descriptors
);
1403 lttng_event_rule_destroy(res
.er
);
1407 struct condition_descr
{
1409 struct lttng_condition
*(*handler
) (int *argc
, const char ***argv
,
1414 struct condition_descr condition_descrs
[] = {
1415 { "event-rule-matches", handle_condition_event
},
1419 void print_valid_condition_names(void)
1423 ERR("Valid condition names are:");
1425 for (i
= 0; i
< ARRAY_SIZE(condition_descrs
); ++i
) {
1426 ERR(" %s", condition_descrs
[i
].name
);
1431 struct lttng_condition
*parse_condition(const char *condition_name
, int *argc
,
1432 const char ***argv
, int argc_offset
, int orig_arg_index
,
1433 const char *orig_arg
)
1436 struct lttng_condition
*cond
;
1437 const struct condition_descr
*descr
= NULL
;
1439 for (i
= 0; i
< ARRAY_SIZE(condition_descrs
); i
++) {
1440 if (strcmp(condition_name
, condition_descrs
[i
].name
) == 0) {
1441 descr
= &condition_descrs
[i
];
1447 ERR(WHILE_PARSING_ARG_N_ARG_FMT
"Unknown condition name '%s'",
1448 orig_arg_index
+ 1, orig_arg
, condition_name
);
1449 print_valid_condition_names();
1453 cond
= descr
->handler(argc
, argv
, argc_offset
);
1455 /* The handler has already printed an error message. */
1466 static struct lttng_rate_policy
*parse_rate_policy(const char *policy_str
)
1469 size_t num_token
= 0;
1470 struct lttng_dynamic_pointer_array tokens
;
1471 struct lttng_rate_policy
*policy
= NULL
;
1472 enum lttng_rate_policy_type policy_type
;
1473 unsigned long long value
;
1474 char *policy_type_str
;
1475 char *policy_value_str
;
1477 LTTNG_ASSERT(policy_str
);
1478 lttng_dynamic_pointer_array_init(&tokens
, NULL
);
1480 /* Rate policy fields are separated by ':'. */
1481 ret
= strutils_split(policy_str
, ':', 1, &tokens
);
1483 num_token
= lttng_dynamic_pointer_array_get_count(&tokens
);
1487 * Early sanity check that the number of parameter is exactly 2.
1490 if (num_token
!= 2) {
1491 ERR("Rate policy format is invalid.");
1495 policy_type_str
= (char *) lttng_dynamic_pointer_array_get_pointer(&tokens
, 0);
1496 policy_value_str
= (char *) lttng_dynamic_pointer_array_get_pointer(&tokens
, 1);
1498 /* Parse the type. */
1499 if (strcmp(policy_type_str
, "once-after") == 0) {
1500 policy_type
= LTTNG_RATE_POLICY_TYPE_ONCE_AFTER_N
;
1501 } else if (strcmp(policy_type_str
, "every") == 0) {
1502 policy_type
= LTTNG_RATE_POLICY_TYPE_EVERY_N
;
1504 ERR("Rate policy type `%s` unknown.", policy_type_str
);
1508 /* Parse the value. */
1509 if (utils_parse_unsigned_long_long(policy_value_str
, &value
) != 0) {
1510 ERR("Failed to parse rate policy value `%s` as an integer.",
1516 ERR("Rate policy value `%s` must be > 0.", policy_value_str
);
1520 switch (policy_type
) {
1521 case LTTNG_RATE_POLICY_TYPE_EVERY_N
:
1522 policy
= lttng_rate_policy_every_n_create(value
);
1524 case LTTNG_RATE_POLICY_TYPE_ONCE_AFTER_N
:
1525 policy
= lttng_rate_policy_once_after_n_create(value
);
1531 if (policy
== NULL
) {
1532 ERR("Failed to create rate policy `%s`.", policy_str
);
1536 lttng_dynamic_pointer_array_reset(&tokens
);
1540 static const struct argpar_opt_descr notify_action_opt_descrs
[] = {
1541 { OPT_RATE_POLICY
, '\0', "rate-policy", true },
1542 ARGPAR_OPT_DESCR_SENTINEL
1546 struct lttng_action
*handle_action_notify(int *argc
, const char ***argv
,
1549 struct lttng_action
*action
= NULL
;
1550 struct argpar_iter
*argpar_iter
= NULL
;
1551 const struct argpar_item
*argpar_item
= NULL
;
1552 struct lttng_rate_policy
*policy
= NULL
;
1554 argpar_iter
= argpar_iter_create(*argc
, *argv
, notify_action_opt_descrs
);
1556 ERR("Failed to allocate an argpar iter.");
1561 enum parse_next_item_status status
;
1563 status
= parse_next_item(argpar_iter
, &argpar_item
,
1564 argc_offset
, *argv
, false, NULL
,
1565 "While parsing `notify` action:");
1566 if (status
== PARSE_NEXT_ITEM_STATUS_ERROR
||
1567 status
== PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
) {
1569 } else if (status
== PARSE_NEXT_ITEM_STATUS_END
) {
1573 LTTNG_ASSERT(status
== PARSE_NEXT_ITEM_STATUS_OK
);
1575 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
1576 const struct argpar_opt_descr
*descr
=
1577 argpar_item_opt_descr(argpar_item
);
1578 const char *arg
= argpar_item_opt_arg(argpar_item
);
1580 switch (descr
->id
) {
1581 case OPT_RATE_POLICY
:
1583 policy
= parse_rate_policy(arg
);
1593 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
1595 ERR("Unexpected argument `%s`.", arg
);
1600 *argc
-= argpar_iter_ingested_orig_args(argpar_iter
);
1601 *argv
+= argpar_iter_ingested_orig_args(argpar_iter
);
1603 action
= lttng_action_notify_create();
1605 ERR("Failed to create notify action");
1610 enum lttng_action_status status
;
1611 status
= lttng_action_notify_set_rate_policy(action
, policy
);
1612 if (status
!= LTTNG_ACTION_STATUS_OK
) {
1613 ERR("Failed to set rate policy");
1621 lttng_action_destroy(action
);
1624 lttng_rate_policy_destroy(policy
);
1625 argpar_item_destroy(argpar_item
);
1626 argpar_iter_destroy(argpar_iter
);
1631 * Generic handler for a kind of action that takes a session name and an
1632 * optional rate policy.
1635 static struct lttng_action
*handle_action_simple_session_with_policy(int *argc
,
1638 struct lttng_action
*(*create_action_cb
)(void),
1639 enum lttng_action_status (*set_session_name_cb
)(
1640 struct lttng_action
*, const char *),
1641 enum lttng_action_status (*set_rate_policy_cb
)(
1642 struct lttng_action
*,
1643 const struct lttng_rate_policy
*),
1644 const char *action_name
)
1646 struct lttng_action
*action
= NULL
;
1647 struct argpar_iter
*argpar_iter
= NULL
;
1648 const struct argpar_item
*argpar_item
= NULL
;
1649 const char *session_name_arg
= NULL
;
1650 enum lttng_action_status action_status
;
1651 struct lttng_rate_policy
*policy
= NULL
;
1653 LTTNG_ASSERT(set_session_name_cb
);
1654 LTTNG_ASSERT(set_rate_policy_cb
);
1656 const struct argpar_opt_descr rate_policy_opt_descrs
[] = {
1657 { OPT_RATE_POLICY
, '\0', "rate-policy", true },
1658 ARGPAR_OPT_DESCR_SENTINEL
1661 argpar_iter
= argpar_iter_create(*argc
, *argv
, rate_policy_opt_descrs
);
1663 ERR("Failed to allocate an argpar iter.");
1668 enum parse_next_item_status status
;
1670 status
= parse_next_item(argpar_iter
, &argpar_item
, argc_offset
,
1672 "While parsing `%s` action:", action_name
);
1673 if (status
== PARSE_NEXT_ITEM_STATUS_ERROR
||
1674 status
== PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
) {
1676 } else if (status
== PARSE_NEXT_ITEM_STATUS_END
) {
1680 LTTNG_ASSERT(status
== PARSE_NEXT_ITEM_STATUS_OK
);
1682 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
1683 const struct argpar_opt_descr
*descr
=
1684 argpar_item_opt_descr(argpar_item
);
1685 const char *arg
= argpar_item_opt_arg(argpar_item
);
1687 switch (descr
->id
) {
1688 case OPT_RATE_POLICY
:
1690 policy
= parse_rate_policy(arg
);
1700 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
1701 unsigned int idx
= argpar_item_non_opt_non_opt_index(argpar_item
);
1705 session_name_arg
= arg
;
1708 ERR("Unexpected argument `%s`.", arg
);
1714 *argc
-= argpar_iter_ingested_orig_args(argpar_iter
);
1715 *argv
+= argpar_iter_ingested_orig_args(argpar_iter
);
1717 if (!session_name_arg
) {
1718 ERR("Missing session name.");
1722 action
= create_action_cb();
1724 ERR("Failed to allocate %s session action.", action_name
);
1728 action_status
= set_session_name_cb(action
, session_name_arg
);
1729 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
1730 ERR("Failed to set action %s session's session name to '%s'.",
1731 action_name
, session_name_arg
);
1736 action_status
= set_rate_policy_cb(action
, policy
);
1737 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
1738 ERR("Failed to set rate policy");
1746 lttng_action_destroy(action
);
1750 lttng_rate_policy_destroy(policy
);
1751 argpar_item_destroy(argpar_item
);
1752 argpar_iter_destroy(argpar_iter
);
1757 struct lttng_action
*handle_action_start_session(int *argc
,
1758 const char ***argv
, int argc_offset
)
1760 return handle_action_simple_session_with_policy(argc
, argv
,
1762 lttng_action_start_session_create
,
1763 lttng_action_start_session_set_session_name
,
1764 lttng_action_start_session_set_rate_policy
, "start");
1768 struct lttng_action
*handle_action_stop_session(int *argc
,
1769 const char ***argv
, int argc_offset
)
1771 return handle_action_simple_session_with_policy(argc
, argv
,
1773 lttng_action_stop_session_create
,
1774 lttng_action_stop_session_set_session_name
,
1775 lttng_action_stop_session_set_rate_policy
, "stop");
1779 struct lttng_action
*handle_action_rotate_session(int *argc
,
1780 const char ***argv
, int argc_offset
)
1782 return handle_action_simple_session_with_policy(argc
, argv
,
1784 lttng_action_rotate_session_create
,
1785 lttng_action_rotate_session_set_session_name
,
1786 lttng_action_rotate_session_set_rate_policy
,
1790 static const struct argpar_opt_descr snapshot_action_opt_descrs
[] = {
1791 { OPT_NAME
, 'n', "name", true },
1792 { OPT_MAX_SIZE
, 'm', "max-size", true },
1793 { OPT_CTRL_URL
, '\0', "ctrl-url", true },
1794 { OPT_DATA_URL
, '\0', "data-url", true },
1795 { OPT_URL
, '\0', "url", true },
1796 { OPT_PATH
, '\0', "path", true },
1797 { OPT_RATE_POLICY
, '\0', "rate-policy", true },
1798 ARGPAR_OPT_DESCR_SENTINEL
1802 struct lttng_action
*handle_action_snapshot_session(int *argc
,
1803 const char ***argv
, int argc_offset
)
1805 struct lttng_action
*action
= NULL
;
1806 struct argpar_iter
*argpar_iter
= NULL
;
1807 const struct argpar_item
*argpar_item
= NULL
;
1808 const char *session_name_arg
= NULL
;
1809 char *snapshot_name_arg
= NULL
;
1810 char *ctrl_url_arg
= NULL
;
1811 char *data_url_arg
= NULL
;
1812 char *max_size_arg
= NULL
;
1813 char *url_arg
= NULL
;
1814 char *path_arg
= NULL
;
1816 enum lttng_action_status action_status
;
1817 struct lttng_snapshot_output
*snapshot_output
= NULL
;
1818 struct lttng_rate_policy
*policy
= NULL
;
1820 unsigned int locations_specified
= 0;
1822 argpar_iter
= argpar_iter_create(*argc
, *argv
, snapshot_action_opt_descrs
);
1824 ERR("Failed to allocate an argpar iter.");
1829 enum parse_next_item_status status
;
1831 status
= parse_next_item(argpar_iter
, &argpar_item
, argc_offset
,
1832 *argv
, false, NULL
, "While parsing `snapshot` action:");
1833 if (status
== PARSE_NEXT_ITEM_STATUS_ERROR
||
1834 status
== PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
) {
1836 } else if (status
== PARSE_NEXT_ITEM_STATUS_END
) {
1840 LTTNG_ASSERT(status
== PARSE_NEXT_ITEM_STATUS_OK
);
1842 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
1843 const struct argpar_opt_descr
*descr
=
1844 argpar_item_opt_descr(argpar_item
);
1845 const char *arg
= argpar_item_opt_arg(argpar_item
);
1847 switch (descr
->id
) {
1849 if (!assign_string(&snapshot_name_arg
, arg
, "--name/-n")) {
1855 if (!assign_string(&max_size_arg
, arg
, "--max-size/-m")) {
1861 if (!assign_string(&ctrl_url_arg
, arg
, "--ctrl-url")) {
1867 if (!assign_string(&data_url_arg
, arg
, "--data-url")) {
1873 if (!assign_string(&url_arg
, arg
, "--url")) {
1879 if (!assign_string(&path_arg
, arg
, "--path")) {
1884 case OPT_RATE_POLICY
:
1886 policy
= parse_rate_policy(arg
);
1896 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
1897 const unsigned int idx
= argpar_item_non_opt_non_opt_index(argpar_item
);
1901 session_name_arg
= arg
;
1904 ERR("Unexpected argument `%s`.", arg
);
1910 *argc
-= argpar_iter_ingested_orig_args(argpar_iter
);
1911 *argv
+= argpar_iter_ingested_orig_args(argpar_iter
);
1913 if (!session_name_arg
) {
1914 ERR("Missing session name.");
1918 /* --ctrl-url and --data-url must come in pair. */
1919 if (ctrl_url_arg
&& !data_url_arg
) {
1920 ERR("--ctrl-url is specified, but --data-url is missing.");
1924 if (!ctrl_url_arg
&& data_url_arg
) {
1925 ERR("--data-url is specified, but --ctrl-url is missing.");
1929 locations_specified
+= !!(ctrl_url_arg
|| data_url_arg
);
1930 locations_specified
+= !!url_arg
;
1931 locations_specified
+= !!path_arg
;
1933 /* --ctrl-url/--data-url, --url and --path are mutually exclusive. */
1934 if (locations_specified
> 1) {
1935 ERR("The --ctrl-url/--data-url, --url, and --path options can't be used together.");
1940 * Did the user specify an option that implies using a
1941 * custom/unregistered output?
1943 if (url_arg
|| ctrl_url_arg
|| path_arg
) {
1944 snapshot_output
= lttng_snapshot_output_create();
1945 if (!snapshot_output
) {
1946 ERR("Failed to allocate a snapshot output.");
1951 action
= lttng_action_snapshot_session_create();
1953 ERR("Failed to allocate snapshot session action.");
1957 action_status
= lttng_action_snapshot_session_set_session_name(
1958 action
, session_name_arg
);
1959 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
1960 ERR("Failed to set action snapshot session's session name to '%s'.",
1965 if (snapshot_name_arg
) {
1966 if (!snapshot_output
) {
1967 ERR("Can't provide a snapshot output name without a snapshot output destination.");
1971 ret
= lttng_snapshot_output_set_name(
1972 snapshot_name_arg
, snapshot_output
);
1974 ERR("Failed to set name of snapshot output.");
1982 if (!snapshot_output
) {
1983 ERR("Can't provide a snapshot output max size without a snapshot output destination.");
1987 ret
= utils_parse_size_suffix(max_size_arg
, &max_size
);
1989 ERR("Failed to parse `%s` as a size.", max_size_arg
);
1993 ret
= lttng_snapshot_output_set_size(max_size
, snapshot_output
);
1995 ERR("Failed to set snapshot output's max size to %" PRIu64
" bytes.",
2003 struct lttng_uri
*uris
;
2005 if (!strstr(url_arg
, "://")) {
2006 ERR("Failed to parse '%s' as an URL.", url_arg
);
2010 num_uris
= uri_parse_str_urls(url_arg
, NULL
, &uris
);
2012 ERR("Failed to parse '%s' as an URL.", url_arg
);
2016 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
2017 ret
= lttng_snapshot_output_set_local_path(
2018 uris
[0].dst
.path
, snapshot_output
);
2021 ERR("Failed to assign '%s' as a local destination.",
2026 ret
= lttng_snapshot_output_set_network_url(
2027 url_arg
, snapshot_output
);
2030 ERR("Failed to assign '%s' as a network URL.",
2038 ret
= lttng_snapshot_output_set_local_path(
2039 path_arg
, snapshot_output
);
2041 ERR("Failed to parse '%s' as a local path.", path_arg
);
2048 * Two argument form, network output with separate control and
2051 ret
= lttng_snapshot_output_set_network_urls(
2052 ctrl_url_arg
, data_url_arg
, snapshot_output
);
2054 ERR("Failed to parse `%s` and `%s` as control and data URLs.",
2055 ctrl_url_arg
, data_url_arg
);
2060 if (snapshot_output
) {
2061 action_status
= lttng_action_snapshot_session_set_output(
2062 action
, snapshot_output
);
2063 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
2064 ERR("Failed to set snapshot session action's output.");
2068 /* Ownership of `snapshot_output` has been transferred to the action. */
2069 snapshot_output
= NULL
;
2073 enum lttng_action_status status
;
2074 status
= lttng_action_snapshot_session_set_rate_policy(
2076 if (status
!= LTTNG_ACTION_STATUS_OK
) {
2077 ERR("Failed to set rate policy");
2085 lttng_action_destroy(action
);
2089 free(snapshot_name_arg
);
2094 free(snapshot_output
);
2096 lttng_rate_policy_destroy(policy
);
2097 argpar_item_destroy(argpar_item
);
2098 argpar_iter_destroy(argpar_iter
);
2102 struct action_descr
{
2104 struct lttng_action
*(*handler
) (int *argc
, const char ***argv
,
2109 struct action_descr action_descrs
[] = {
2110 { "notify", handle_action_notify
},
2111 { "start-session", handle_action_start_session
},
2112 { "stop-session", handle_action_stop_session
},
2113 { "rotate-session", handle_action_rotate_session
},
2114 { "snapshot-session", handle_action_snapshot_session
},
2118 void print_valid_action_names(void)
2122 ERR("Valid action names are:");
2124 for (i
= 0; i
< ARRAY_SIZE(condition_descrs
); ++i
) {
2125 ERR(" %s", action_descrs
[i
].name
);
2130 struct lttng_action
*parse_action(const char *action_name
, int *argc
,
2131 const char ***argv
, int argc_offset
, int orig_arg_index
,
2132 const char *orig_arg
)
2135 struct lttng_action
*action
;
2136 const struct action_descr
*descr
= NULL
;
2138 for (i
= 0; i
< ARRAY_SIZE(action_descrs
); i
++) {
2139 if (strcmp(action_name
, action_descrs
[i
].name
) == 0) {
2140 descr
= &action_descrs
[i
];
2146 ERR(WHILE_PARSING_ARG_N_ARG_FMT
"Unknown action name '%s'",
2147 orig_arg_index
+ 1, orig_arg
, action_name
);
2148 print_valid_action_names();
2152 action
= descr
->handler(argc
, argv
, argc_offset
);
2154 /* The handler has already printed an error message. */
2166 struct argpar_opt_descr add_trigger_options
[] = {
2167 { OPT_HELP
, 'h', "help", false },
2168 { OPT_LIST_OPTIONS
, '\0', "list-options", false },
2169 { OPT_CONDITION
, '\0', "condition", true },
2170 { OPT_ACTION
, '\0', "action", true },
2171 { OPT_NAME
, '\0', "name", true },
2172 { OPT_OWNER_UID
, '\0', "owner-uid", true },
2173 ARGPAR_OPT_DESCR_SENTINEL
,
2177 void lttng_actions_destructor(void *p
)
2179 struct lttng_action
*action
= (lttng_action
*) p
;
2181 lttng_action_destroy(action
);
2184 int cmd_add_trigger(int argc
, const char **argv
)
2187 int my_argc
= argc
- 1;
2188 const char **my_argv
= argv
+ 1;
2189 struct lttng_condition
*condition
= NULL
;
2190 struct lttng_dynamic_pointer_array actions
;
2191 struct argpar_iter
*argpar_iter
= NULL
;
2192 const struct argpar_item
*argpar_item
= NULL
;
2193 const struct argpar_error
*argpar_error
= NULL
;
2194 struct lttng_action
*action_list
= NULL
;
2195 struct lttng_action
*action
= NULL
;
2196 struct lttng_trigger
*trigger
= NULL
;
2199 char *owner_uid
= NULL
;
2200 enum lttng_error_code ret_code
;
2201 struct mi_writer
*mi_writer
= NULL
;
2203 lttng_dynamic_pointer_array_init(&actions
, lttng_actions_destructor
);
2206 mi_writer
= mi_lttng_writer_create(
2207 fileno(stdout
), lttng_opt_mi
);
2213 /* Open command element. */
2214 ret
= mi_lttng_writer_command_open(mi_writer
,
2215 mi_lttng_element_command_add_trigger
);
2221 /* Open output element. */
2222 ret
= mi_lttng_writer_open_element(
2223 mi_writer
, mi_lttng_element_command_output
);
2231 enum parse_next_item_status status
;
2233 const struct argpar_opt_descr
*descr
;
2236 argpar_iter_destroy(argpar_iter
);
2237 argpar_iter
= argpar_iter_create(my_argc
, my_argv
,
2238 add_trigger_options
);
2240 ERR("Failed to create argpar iter.");
2244 status
= parse_next_item(argpar_iter
, &argpar_item
,
2245 argc
- my_argc
, my_argv
, true, &argpar_error
, NULL
);
2246 if (status
== PARSE_NEXT_ITEM_STATUS_ERROR
) {
2248 if (argpar_error_type(argpar_error
) ==
2249 ARGPAR_ERROR_TYPE_MISSING_OPT_ARG
) {
2250 int opt_id
= argpar_error_opt_descr(argpar_error
, NULL
)->id
;
2252 if (opt_id
== OPT_CONDITION
) {
2253 print_valid_condition_names();
2254 } else if (opt_id
== OPT_ACTION
) {
2255 print_valid_action_names();
2260 } else if (status
== PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
) {
2262 } else if (status
== PARSE_NEXT_ITEM_STATUS_END
) {
2266 LTTNG_ASSERT(status
== PARSE_NEXT_ITEM_STATUS_OK
);
2268 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_NON_OPT
) {
2269 ERR("Unexpected argument `%s`.",
2270 argpar_item_non_opt_arg(argpar_item
));
2274 ingested_args
= argpar_iter_ingested_orig_args(argpar_iter
);
2276 my_argc
-= ingested_args
;
2277 my_argv
+= ingested_args
;
2279 descr
= argpar_item_opt_descr(argpar_item
);
2280 arg
= argpar_item_opt_arg(argpar_item
);
2282 switch (descr
->id
) {
2287 case OPT_LIST_OPTIONS
:
2288 list_cmd_options_argpar(stdout
, add_trigger_options
);
2294 ERR("A --condition was already given.");
2298 condition
= parse_condition(arg
, &my_argc
, &my_argv
,
2299 argc
- my_argc
, argc
- my_argc
- ingested_args
,
2300 my_argv
[-ingested_args
]);
2303 * An error message was already printed by
2313 action
= parse_action(arg
, &my_argc
, &my_argv
,
2314 argc
- my_argc
, argc
- my_argc
- ingested_args
,
2315 my_argv
[-ingested_args
]);
2318 * An error message was already printed by
2324 ret
= lttng_dynamic_pointer_array_add_pointer(
2327 ERR("Failed to add pointer to pointer array.");
2331 /* Ownership of the action was transferred to the list. */
2338 if (!assign_string(&name
, arg
, "--name")) {
2346 if (!assign_string(&owner_uid
, arg
,
2359 ERR("Missing --condition.");
2363 if (lttng_dynamic_pointer_array_get_count(&actions
) == 0) {
2364 ERR("Need at least one --action.");
2368 action_list
= lttng_action_list_create();
2373 for (i
= 0; i
< lttng_dynamic_pointer_array_get_count(&actions
); i
++) {
2374 enum lttng_action_status status
;
2376 action
= (lttng_action
*) lttng_dynamic_pointer_array_steal_pointer(&actions
, i
);
2378 status
= lttng_action_list_add_action(action_list
, action
);
2379 if (status
!= LTTNG_ACTION_STATUS_OK
) {
2384 * The `lttng_action_list_add_action()` takes a reference to
2385 * the action. We can destroy ours.
2387 lttng_action_destroy(action
);
2391 trigger
= lttng_trigger_create(condition
, action_list
);
2397 enum lttng_trigger_status trigger_status
;
2402 uid
= strtol(owner_uid
, &end
, 10);
2403 if (end
== owner_uid
|| *end
!= '\0' || errno
!= 0) {
2404 ERR("Failed to parse `%s` as a user id.", owner_uid
);
2408 trigger_status
= lttng_trigger_set_owner_uid(trigger
, uid
);
2409 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
2410 ERR("Failed to set trigger's user identity.");
2416 ret_code
= lttng_register_trigger_with_name(trigger
, name
);
2418 ret_code
= lttng_register_trigger_with_automatic_name(trigger
);
2421 if (ret_code
!= LTTNG_OK
) {
2422 ERR("Failed to register trigger: %s.",
2423 lttng_strerror(-ret_code
));
2428 ret_code
= lttng_trigger_mi_serialize(trigger
, mi_writer
, NULL
);
2429 if (ret_code
!= LTTNG_OK
) {
2433 const char *returned_trigger_name
;
2434 const enum lttng_trigger_status trigger_status
=
2435 lttng_trigger_get_name(trigger
,
2436 &returned_trigger_name
);
2438 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
2439 WARN("Failed to retrieve the added trigger's name.");
2441 MSG("Added trigger `%s`.", returned_trigger_name
);
2454 if (lttng_opt_mi
&& mi_writer
) {
2457 /* Close output element. */
2458 mi_ret
= mi_lttng_writer_close_element(mi_writer
);
2464 mi_ret
= mi_lttng_writer_write_element_bool(mi_writer
,
2465 mi_lttng_element_command_success
, ret
? 0 : 1);
2471 /* Command element close. */
2472 mi_ret
= mi_lttng_writer_command_close(mi_writer
);
2480 argpar_error_destroy(argpar_error
);
2481 argpar_iter_destroy(argpar_iter
);
2482 argpar_item_destroy(argpar_item
);
2483 lttng_dynamic_pointer_array_reset(&actions
);
2484 lttng_condition_destroy(condition
);
2485 lttng_action_destroy(action_list
);
2486 lttng_action_destroy(action
);
2487 lttng_trigger_destroy(trigger
);
2490 if (mi_writer
&& mi_lttng_writer_destroy(mi_writer
)) {
2491 /* Preserve original error code. */
2492 ret
= ret
? ret
: CMD_ERROR
;