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
= strtoull(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
= strtoull(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 assert(load_expr_op
);
443 assert(load_expr_op
->type
== IR_LOAD_EXPRESSION_GET_SYMBOL
);
444 field_name
= load_expr_op
->u
.symbol
;
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 assert(load_expr_op
);
468 assert(load_expr_op
->type
== IR_LOAD_EXPRESSION_GET_SYMBOL
);
469 field_name
= load_expr_op
->u
.symbol
;
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 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 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(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 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
);
790 filter_parser_ctx_free(parser_ctx
);
794 * ir_op_root_to_event_expr has printed
800 ret
= lttng_dynamic_pointer_array_add_pointer(
801 &res
.capture_descriptors
,
808 * The ownership of event expression was
809 * transferred to the dynamic array.
819 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
821 /* Don't accept non-option arguments. */
822 ERR("Unexpected argument '%s'", arg
);
827 if (event_rule_type
== LTTNG_EVENT_RULE_TYPE_UNKNOWN
) {
828 ERR("Event rule requires a --type.");
833 * Option --name is applicable to event rules of type kernel, user, jul,
834 * log4j,python and syscall. If --name is omitted, it is implicitly
837 switch (event_rule_type
) {
838 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
839 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
840 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
841 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
842 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
843 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
851 ERR("Can't use --name with %s event rules.",
852 lttng_event_rule_type_str(
857 if (lttng_dynamic_pointer_array_get_count(&exclude_names
) > 0) {
858 ERR("Can't use --exclude-name/-x with %s event rules.",
859 lttng_event_rule_type_str(
866 * Option --location is only applicable to (and mandatory for) event
867 * rules of type {k,u}probe and function.
869 * Option --event-name is only applicable to event rules of type probe.
870 * If omitted, it defaults to the location.
872 switch (event_rule_type
) {
873 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
874 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
876 ERR("Event rule of type %s requires a --location.",
877 lttng_event_rule_type_str(event_rule_type
));
882 event_name
= strdup(location
);
889 ERR("Can't use --location with %s event rules.",
890 lttng_event_rule_type_str(event_rule_type
));
895 ERR("Can't use --event-name with %s event rules.",
896 lttng_event_rule_type_str(
903 * Update *argc and *argv so our caller can keep parsing what follows.
905 consumed_args
= argpar_iter_ingested_orig_args(argpar_iter
);
906 assert(consumed_args
>= 0);
907 *argc
-= consumed_args
;
908 *argv
+= consumed_args
;
911 * Adding a filter to a probe, function or userspace-probe would be
912 * denied by the kernel tracer as it's not supported at the moment. We
913 * do an early check here to warn the user.
916 switch (event_rule_type
) {
917 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
918 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
919 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
920 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
921 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
922 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
925 ERR("Filter expressions are not supported for %s event rules.",
926 lttng_event_rule_type_str(event_rule_type
));
932 * If --exclude-name/-x was passed, split it into an exclusion list.
933 * Exclusions are only supported by
934 * LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT for now.
936 if (lttng_dynamic_pointer_array_get_count(&exclude_names
) > 0) {
937 if (event_rule_type
!= LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
) {
938 ERR("Event name exclusions are not yet implemented for %s event rules.",
939 lttng_event_rule_type_str(event_rule_type
));
943 if (validate_exclusion_list(name
, &exclude_names
) != 0) {
945 * Assume validate_exclusion_list already prints an
953 switch (event_rule_type
) {
954 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
955 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
956 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
957 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
962 if (strcmp(log_level_str
, "..") == 0) {
964 * ".." is the same as passing no log level
965 * option and correspond to the "ANY" case.
970 if (!parse_log_level_string(log_level_str
, event_rule_type
,
971 &log_level
, &log_level_only
)) {
972 ERR("Failed to parse log level string `%s`.",
977 if (log_level_only
) {
978 log_level_rule
= lttng_log_level_rule_exactly_create(log_level
);
980 log_level_rule
= lttng_log_level_rule_at_least_as_severe_as_create(log_level
);
983 if (log_level_rule
== NULL
) {
984 ERR("Failed to create log level rule object.");
990 ERR("Log levels are not supported for %s event rules.",
991 lttng_event_rule_type_str(event_rule_type
));
996 /* Finally, create the event rule object. */
997 switch (event_rule_type
) {
998 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
:
1000 enum lttng_event_rule_status event_rule_status
;
1002 res
.er
= lttng_event_rule_user_tracepoint_create();
1004 ERR("Failed to create user_tracepoint event rule.");
1009 event_rule_status
= lttng_event_rule_user_tracepoint_set_name_pattern(
1011 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1012 ERR("Failed to set user_tracepoint event rule's pattern to '%s'.",
1019 event_rule_status
= lttng_event_rule_user_tracepoint_set_filter(
1021 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1022 ERR("Failed to set user_tracepoint event rule's filter to '%s'.",
1028 /* Set exclusion list. */
1029 if (lttng_dynamic_pointer_array_get_count(&exclude_names
) > 0) {
1031 int count
= lttng_dynamic_pointer_array_get_count(
1034 for (n
= 0; n
< count
; n
++) {
1035 const char *exclude_name
=
1036 lttng_dynamic_pointer_array_get_pointer(
1041 lttng_event_rule_user_tracepoint_add_name_pattern_exclusion(
1044 if (event_rule_status
!=
1045 LTTNG_EVENT_RULE_STATUS_OK
) {
1046 ERR("Failed to set user_tracepoint exclusion list element '%s'",
1053 if (log_level_rule
) {
1055 lttng_event_rule_user_tracepoint_set_log_level_rule(
1056 res
.er
, log_level_rule
);
1058 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1059 ERR("Failed to set log level on event fule.");
1066 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
:
1068 enum lttng_event_rule_status event_rule_status
;
1070 res
.er
= lttng_event_rule_kernel_tracepoint_create();
1072 ERR("Failed to create kernel_tracepoint event rule.");
1077 event_rule_status
= lttng_event_rule_kernel_tracepoint_set_name_pattern(
1079 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1080 ERR("Failed to set kernel_tracepoint event rule's pattern to '%s'.",
1087 event_rule_status
= lttng_event_rule_kernel_tracepoint_set_filter(
1089 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1090 ERR("Failed to set kernel_tracepoint event rule's filter to '%s'.",
1097 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
:
1099 enum lttng_event_rule_status event_rule_status
;
1101 res
.er
= lttng_event_rule_jul_logging_create();
1103 ERR("Failed to create jul_logging event rule.");
1108 event_rule_status
= lttng_event_rule_jul_logging_set_name_pattern(
1110 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1111 ERR("Failed to set jul_logging event rule's pattern to '%s'.",
1118 event_rule_status
= lttng_event_rule_jul_logging_set_filter(
1120 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1121 ERR("Failed to set jul_logging event rule's filter to '%s'.",
1127 if (log_level_rule
) {
1129 lttng_event_rule_jul_logging_set_log_level_rule(
1130 res
.er
, log_level_rule
);
1132 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1133 ERR("Failed to set log level on event fule.");
1139 case LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
:
1141 enum lttng_event_rule_status event_rule_status
;
1143 res
.er
= lttng_event_rule_log4j_logging_create();
1145 ERR("Failed to create jul_logging event rule.");
1150 event_rule_status
= lttng_event_rule_log4j_logging_set_name_pattern(
1152 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1153 ERR("Failed to set jul_logging event rule's pattern to '%s'.",
1160 event_rule_status
= lttng_event_rule_log4j_logging_set_filter(
1162 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1163 ERR("Failed to set jul_logging event rule's filter to '%s'.",
1169 if (log_level_rule
) {
1171 lttng_event_rule_log4j_logging_set_log_level_rule(
1172 res
.er
, log_level_rule
);
1174 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1175 ERR("Failed to set log level on event fule.");
1181 case LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
:
1183 enum lttng_event_rule_status event_rule_status
;
1185 res
.er
= lttng_event_rule_python_logging_create();
1187 ERR("Failed to create jul_logging event rule.");
1192 event_rule_status
= lttng_event_rule_python_logging_set_name_pattern(
1194 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1195 ERR("Failed to set jul_logging event rule's pattern to '%s'.",
1202 event_rule_status
= lttng_event_rule_python_logging_set_filter(
1204 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1205 ERR("Failed to set jul_logging event rule's filter to '%s'.",
1211 if (log_level_rule
) {
1213 lttng_event_rule_python_logging_set_log_level_rule(
1214 res
.er
, log_level_rule
);
1216 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1217 ERR("Failed to set log level on event fule.");
1223 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE
:
1226 enum lttng_event_rule_status event_rule_status
;
1228 ret
= parse_kernel_probe_opts(
1229 location
, &kernel_probe_location
);
1231 ERR("Failed to parse kernel probe location.");
1235 assert(kernel_probe_location
);
1236 res
.er
= lttng_event_rule_kernel_kprobe_create(kernel_probe_location
);
1238 ERR("Failed to create kprobe event rule.");
1243 lttng_event_rule_kernel_kprobe_set_event_name(
1244 res
.er
, event_name
);
1245 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1246 ERR("Failed to set kprobe event rule's name to '%s'.",
1253 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE
:
1256 enum lttng_event_rule_status event_rule_status
;
1258 ret
= parse_userspace_probe_opts(
1259 location
, &userspace_probe_location
);
1261 ERR("Failed to parse user space probe location.");
1265 res
.er
= lttng_event_rule_kernel_uprobe_create(userspace_probe_location
);
1267 ERR("Failed to create userspace probe event rule.");
1272 lttng_event_rule_kernel_uprobe_set_event_name(
1273 res
.er
, event_name
);
1274 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1275 ERR("Failed to set user space probe event rule's name to '%s'.",
1282 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL
:
1284 enum lttng_event_rule_status event_rule_status
;
1285 enum lttng_event_rule_kernel_syscall_emission_site emission_site
;
1287 if (!parse_syscall_emission_site_from_type(
1288 event_rule_type_str
, &emission_site
)) {
1289 ERR("Failed to parse syscall type '%s'.", event_rule_type_str
);
1293 res
.er
= lttng_event_rule_kernel_syscall_create(emission_site
);
1295 ERR("Failed to create syscall event rule.");
1299 event_rule_status
= lttng_event_rule_kernel_syscall_set_name_pattern(
1301 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1302 ERR("Failed to set syscall event rule's pattern to '%s'.",
1308 event_rule_status
= lttng_event_rule_kernel_syscall_set_filter(
1310 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1311 ERR("Failed to set syscall event rule's filter to '%s'.",
1327 lttng_event_rule_destroy(res
.er
);
1329 lttng_dynamic_pointer_array_reset(&res
.capture_descriptors
);
1333 filter_parser_ctx_free(parser_ctx
);
1336 lttng_event_expr_destroy(event_expr
);
1337 argpar_item_destroy(argpar_item
);
1338 argpar_iter_destroy(argpar_iter
);
1341 lttng_dynamic_pointer_array_reset(&exclude_names
);
1342 free(log_level_str
);
1345 free(event_rule_type_str
);
1347 lttng_kernel_probe_location_destroy(kernel_probe_location
);
1348 lttng_userspace_probe_location_destroy(userspace_probe_location
);
1349 lttng_log_level_rule_destroy(log_level_rule
);
1354 struct lttng_condition
*handle_condition_event(int *argc
, const char ***argv
,
1357 struct parse_event_rule_res res
;
1358 struct lttng_condition
*c
;
1361 res
= parse_event_rule(argc
, argv
, argc_offset
);
1367 c
= lttng_condition_event_rule_matches_create(res
.er
);
1368 lttng_event_rule_destroy(res
.er
);
1374 for (i
= 0; i
< lttng_dynamic_pointer_array_get_count(&res
.capture_descriptors
);
1376 enum lttng_condition_status status
;
1377 struct lttng_event_expr
**expr
=
1378 lttng_dynamic_array_get_element(
1379 &res
.capture_descriptors
.array
, i
);
1383 status
= lttng_condition_event_rule_matches_append_capture_descriptor(
1385 if (status
!= LTTNG_CONDITION_STATUS_OK
) {
1386 if (status
== LTTNG_CONDITION_STATUS_UNSUPPORTED
) {
1387 ERR("The capture feature is unsupported by the event-rule condition type");
1393 /* Ownership of event expression moved to `c` */
1400 lttng_condition_destroy(c
);
1404 lttng_dynamic_pointer_array_reset(&res
.capture_descriptors
);
1405 lttng_event_rule_destroy(res
.er
);
1409 struct condition_descr
{
1411 struct lttng_condition
*(*handler
) (int *argc
, const char ***argv
,
1416 struct condition_descr condition_descrs
[] = {
1417 { "event-rule-matches", handle_condition_event
},
1421 void print_valid_condition_names(void)
1425 ERR("Valid condition names are:");
1427 for (i
= 0; i
< ARRAY_SIZE(condition_descrs
); ++i
) {
1428 ERR(" %s", condition_descrs
[i
].name
);
1433 struct lttng_condition
*parse_condition(const char *condition_name
, int *argc
,
1434 const char ***argv
, int argc_offset
, int orig_arg_index
,
1435 const char *orig_arg
)
1438 struct lttng_condition
*cond
;
1439 const struct condition_descr
*descr
= NULL
;
1441 for (i
= 0; i
< ARRAY_SIZE(condition_descrs
); i
++) {
1442 if (strcmp(condition_name
, condition_descrs
[i
].name
) == 0) {
1443 descr
= &condition_descrs
[i
];
1449 ERR(WHILE_PARSING_ARG_N_ARG_FMT
"Unknown condition name '%s'",
1450 orig_arg_index
+ 1, orig_arg
, condition_name
);
1451 print_valid_condition_names();
1455 cond
= descr
->handler(argc
, argv
, argc_offset
);
1457 /* The handler has already printed an error message. */
1468 static struct lttng_rate_policy
*parse_rate_policy(const char *policy_str
)
1471 size_t num_token
= 0;
1472 struct lttng_dynamic_pointer_array tokens
;
1473 struct lttng_rate_policy
*policy
= NULL
;
1474 enum lttng_rate_policy_type policy_type
;
1475 unsigned long long value
;
1476 char *policy_type_str
;
1477 char *policy_value_str
;
1480 lttng_dynamic_pointer_array_init(&tokens
, NULL
);
1482 /* Rate policy fields are separated by ':'. */
1483 ret
= strutils_split(policy_str
, ':', 1, &tokens
);
1485 num_token
= lttng_dynamic_pointer_array_get_count(&tokens
);
1489 * Early sanity check that the number of parameter is exactly 2.
1492 if (num_token
!= 2) {
1493 ERR("Rate policy format is invalid.");
1497 policy_type_str
= lttng_dynamic_pointer_array_get_pointer(&tokens
, 0);
1498 policy_value_str
= lttng_dynamic_pointer_array_get_pointer(&tokens
, 1);
1500 /* Parse the type. */
1501 if (strcmp(policy_type_str
, "once-after") == 0) {
1502 policy_type
= LTTNG_RATE_POLICY_TYPE_ONCE_AFTER_N
;
1503 } else if (strcmp(policy_type_str
, "every") == 0) {
1504 policy_type
= LTTNG_RATE_POLICY_TYPE_EVERY_N
;
1506 ERR("Rate policy type `%s` unknown.", policy_type_str
);
1510 /* Parse the value. */
1511 if (utils_parse_unsigned_long_long(policy_value_str
, &value
) != 0) {
1512 ERR("Failed to parse rate policy value `%s` as an integer.",
1518 ERR("Rate policy value `%s` must be > 0.", policy_value_str
);
1522 switch (policy_type
) {
1523 case LTTNG_RATE_POLICY_TYPE_EVERY_N
:
1524 policy
= lttng_rate_policy_every_n_create(value
);
1526 case LTTNG_RATE_POLICY_TYPE_ONCE_AFTER_N
:
1527 policy
= lttng_rate_policy_once_after_n_create(value
);
1533 if (policy
== NULL
) {
1534 ERR("Failed to create rate policy `%s`.", policy_str
);
1538 lttng_dynamic_pointer_array_reset(&tokens
);
1542 static const struct argpar_opt_descr notify_action_opt_descrs
[] = {
1543 { OPT_RATE_POLICY
, '\0', "rate-policy", true },
1544 ARGPAR_OPT_DESCR_SENTINEL
1548 struct lttng_action
*handle_action_notify(int *argc
, const char ***argv
,
1551 struct lttng_action
*action
= NULL
;
1552 struct argpar_iter
*argpar_iter
= NULL
;
1553 const struct argpar_item
*argpar_item
= NULL
;
1554 struct lttng_rate_policy
*policy
= NULL
;
1556 argpar_iter
= argpar_iter_create(*argc
, *argv
, notify_action_opt_descrs
);
1558 ERR("Failed to allocate an argpar iter.");
1563 enum parse_next_item_status status
;
1565 status
= parse_next_item(argpar_iter
, &argpar_item
,
1566 argc_offset
, *argv
, false, NULL
,
1567 "While parsing `notify` action:");
1568 if (status
== PARSE_NEXT_ITEM_STATUS_ERROR
||
1569 status
== PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
) {
1571 } else if (status
== PARSE_NEXT_ITEM_STATUS_END
) {
1575 assert(status
== PARSE_NEXT_ITEM_STATUS_OK
);
1577 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
1578 const struct argpar_opt_descr
*descr
=
1579 argpar_item_opt_descr(argpar_item
);
1580 const char *arg
= argpar_item_opt_arg(argpar_item
);
1582 switch (descr
->id
) {
1583 case OPT_RATE_POLICY
:
1585 policy
= parse_rate_policy(arg
);
1595 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
1597 ERR("Unexpected argument `%s`.", arg
);
1602 *argc
-= argpar_iter_ingested_orig_args(argpar_iter
);
1603 *argv
+= argpar_iter_ingested_orig_args(argpar_iter
);
1605 action
= lttng_action_notify_create();
1607 ERR("Failed to create notify action");
1612 enum lttng_action_status status
;
1613 status
= lttng_action_notify_set_rate_policy(action
, policy
);
1614 if (status
!= LTTNG_ACTION_STATUS_OK
) {
1615 ERR("Failed to set rate policy");
1623 lttng_action_destroy(action
);
1626 lttng_rate_policy_destroy(policy
);
1627 argpar_item_destroy(argpar_item
);
1628 argpar_iter_destroy(argpar_iter
);
1633 * Generic handler for a kind of action that takes a session name and an
1634 * optional rate policy.
1637 static struct lttng_action
*handle_action_simple_session_with_policy(int *argc
,
1640 struct lttng_action
*(*create_action_cb
)(void),
1641 enum lttng_action_status (*set_session_name_cb
)(
1642 struct lttng_action
*, const char *),
1643 enum lttng_action_status (*set_rate_policy_cb
)(
1644 struct lttng_action
*,
1645 const struct lttng_rate_policy
*),
1646 const char *action_name
)
1648 struct lttng_action
*action
= NULL
;
1649 struct argpar_iter
*argpar_iter
= NULL
;
1650 const struct argpar_item
*argpar_item
= NULL
;
1651 const char *session_name_arg
= NULL
;
1652 enum lttng_action_status action_status
;
1653 struct lttng_rate_policy
*policy
= NULL
;
1655 assert(set_session_name_cb
);
1656 assert(set_rate_policy_cb
);
1658 const struct argpar_opt_descr rate_policy_opt_descrs
[] = {
1659 { OPT_RATE_POLICY
, '\0', "rate-policy", true },
1660 ARGPAR_OPT_DESCR_SENTINEL
1663 argpar_iter
= argpar_iter_create(*argc
, *argv
, rate_policy_opt_descrs
);
1665 ERR("Failed to allocate an argpar iter.");
1670 enum parse_next_item_status status
;
1672 status
= parse_next_item(argpar_iter
, &argpar_item
, argc_offset
,
1674 "While parsing `%s` action:", action_name
);
1675 if (status
== PARSE_NEXT_ITEM_STATUS_ERROR
||
1676 status
== PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
) {
1678 } else if (status
== PARSE_NEXT_ITEM_STATUS_END
) {
1682 assert(status
== PARSE_NEXT_ITEM_STATUS_OK
);
1684 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
1685 const struct argpar_opt_descr
*descr
=
1686 argpar_item_opt_descr(argpar_item
);
1687 const char *arg
= argpar_item_opt_arg(argpar_item
);
1689 switch (descr
->id
) {
1690 case OPT_RATE_POLICY
:
1692 policy
= parse_rate_policy(arg
);
1702 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
1703 unsigned int idx
= argpar_item_non_opt_non_opt_index(argpar_item
);
1707 session_name_arg
= arg
;
1710 ERR("Unexpected argument `%s`.", arg
);
1716 *argc
-= argpar_iter_ingested_orig_args(argpar_iter
);
1717 *argv
+= argpar_iter_ingested_orig_args(argpar_iter
);
1719 if (!session_name_arg
) {
1720 ERR("Missing session name.");
1724 action
= create_action_cb();
1726 ERR("Failed to allocate %s session action.", action_name
);
1730 action_status
= set_session_name_cb(action
, session_name_arg
);
1731 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
1732 ERR("Failed to set action %s session's session name to '%s'.",
1733 action_name
, session_name_arg
);
1738 action_status
= set_rate_policy_cb(action
, policy
);
1739 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
1740 ERR("Failed to set rate policy");
1748 lttng_action_destroy(action
);
1752 lttng_rate_policy_destroy(policy
);
1753 argpar_item_destroy(argpar_item
);
1754 argpar_iter_destroy(argpar_iter
);
1759 struct lttng_action
*handle_action_start_session(int *argc
,
1760 const char ***argv
, int argc_offset
)
1762 return handle_action_simple_session_with_policy(argc
, argv
,
1764 lttng_action_start_session_create
,
1765 lttng_action_start_session_set_session_name
,
1766 lttng_action_start_session_set_rate_policy
, "start");
1770 struct lttng_action
*handle_action_stop_session(int *argc
,
1771 const char ***argv
, int argc_offset
)
1773 return handle_action_simple_session_with_policy(argc
, argv
,
1775 lttng_action_stop_session_create
,
1776 lttng_action_stop_session_set_session_name
,
1777 lttng_action_stop_session_set_rate_policy
, "stop");
1781 struct lttng_action
*handle_action_rotate_session(int *argc
,
1782 const char ***argv
, int argc_offset
)
1784 return handle_action_simple_session_with_policy(argc
, argv
,
1786 lttng_action_rotate_session_create
,
1787 lttng_action_rotate_session_set_session_name
,
1788 lttng_action_rotate_session_set_rate_policy
,
1792 static const struct argpar_opt_descr snapshot_action_opt_descrs
[] = {
1793 { OPT_NAME
, 'n', "name", true },
1794 { OPT_MAX_SIZE
, 'm', "max-size", true },
1795 { OPT_CTRL_URL
, '\0', "ctrl-url", true },
1796 { OPT_DATA_URL
, '\0', "data-url", true },
1797 { OPT_URL
, '\0', "url", true },
1798 { OPT_PATH
, '\0', "path", true },
1799 { OPT_RATE_POLICY
, '\0', "rate-policy", true },
1800 ARGPAR_OPT_DESCR_SENTINEL
1804 struct lttng_action
*handle_action_snapshot_session(int *argc
,
1805 const char ***argv
, int argc_offset
)
1807 struct lttng_action
*action
= NULL
;
1808 struct argpar_iter
*argpar_iter
= NULL
;
1809 const struct argpar_item
*argpar_item
= NULL
;
1810 const char *session_name_arg
= NULL
;
1811 char *snapshot_name_arg
= NULL
;
1812 char *ctrl_url_arg
= NULL
;
1813 char *data_url_arg
= NULL
;
1814 char *max_size_arg
= NULL
;
1815 char *url_arg
= NULL
;
1816 char *path_arg
= NULL
;
1818 enum lttng_action_status action_status
;
1819 struct lttng_snapshot_output
*snapshot_output
= NULL
;
1820 struct lttng_rate_policy
*policy
= NULL
;
1822 unsigned int locations_specified
= 0;
1824 argpar_iter
= argpar_iter_create(*argc
, *argv
, snapshot_action_opt_descrs
);
1826 ERR("Failed to allocate an argpar iter.");
1831 enum parse_next_item_status status
;
1833 status
= parse_next_item(argpar_iter
, &argpar_item
, argc_offset
,
1834 *argv
, false, NULL
, "While parsing `snapshot` action:");
1835 if (status
== PARSE_NEXT_ITEM_STATUS_ERROR
||
1836 status
== PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
) {
1838 } else if (status
== PARSE_NEXT_ITEM_STATUS_END
) {
1842 assert(status
== PARSE_NEXT_ITEM_STATUS_OK
);
1844 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_OPT
) {
1845 const struct argpar_opt_descr
*descr
=
1846 argpar_item_opt_descr(argpar_item
);
1847 const char *arg
= argpar_item_opt_arg(argpar_item
);
1849 switch (descr
->id
) {
1851 if (!assign_string(&snapshot_name_arg
, arg
, "--name/-n")) {
1857 if (!assign_string(&max_size_arg
, arg
, "--max-size/-m")) {
1863 if (!assign_string(&ctrl_url_arg
, arg
, "--ctrl-url")) {
1869 if (!assign_string(&data_url_arg
, arg
, "--data-url")) {
1875 if (!assign_string(&url_arg
, arg
, "--url")) {
1881 if (!assign_string(&path_arg
, arg
, "--path")) {
1886 case OPT_RATE_POLICY
:
1888 policy
= parse_rate_policy(arg
);
1898 const char *arg
= argpar_item_non_opt_arg(argpar_item
);
1899 unsigned int idx
= argpar_item_non_opt_non_opt_index(argpar_item
);
1903 session_name_arg
= arg
;
1906 ERR("Unexpected argument `%s`.", arg
);
1912 *argc
-= argpar_iter_ingested_orig_args(argpar_iter
);
1913 *argv
+= argpar_iter_ingested_orig_args(argpar_iter
);
1915 if (!session_name_arg
) {
1916 ERR("Missing session name.");
1920 /* --ctrl-url and --data-url must come in pair. */
1921 if (ctrl_url_arg
&& !data_url_arg
) {
1922 ERR("--ctrl-url is specified, but --data-url is missing.");
1926 if (!ctrl_url_arg
&& data_url_arg
) {
1927 ERR("--data-url is specified, but --ctrl-url is missing.");
1931 locations_specified
+= !!(ctrl_url_arg
|| data_url_arg
);
1932 locations_specified
+= !!url_arg
;
1933 locations_specified
+= !!path_arg
;
1935 /* --ctrl-url/--data-url, --url and --path are mutually exclusive. */
1936 if (locations_specified
> 1) {
1937 ERR("The --ctrl-url/--data-url, --url, and --path options can't be used together.");
1942 * Did the user specify an option that implies using a
1943 * custom/unregistered output?
1945 if (url_arg
|| ctrl_url_arg
|| path_arg
) {
1946 snapshot_output
= lttng_snapshot_output_create();
1947 if (!snapshot_output
) {
1948 ERR("Failed to allocate a snapshot output.");
1953 action
= lttng_action_snapshot_session_create();
1955 ERR("Failed to allocate snapshot session action.");
1959 action_status
= lttng_action_snapshot_session_set_session_name(
1960 action
, session_name_arg
);
1961 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
1962 ERR("Failed to set action snapshot session's session name to '%s'.",
1967 if (snapshot_name_arg
) {
1968 if (!snapshot_output
) {
1969 ERR("Can't provide a snapshot output name without a snapshot output destination.");
1973 ret
= lttng_snapshot_output_set_name(
1974 snapshot_name_arg
, snapshot_output
);
1976 ERR("Failed to set name of snapshot output.");
1984 if (!snapshot_output
) {
1985 ERR("Can't provide a snapshot output max size without a snapshot output destination.");
1989 ret
= utils_parse_size_suffix(max_size_arg
, &max_size
);
1991 ERR("Failed to parse `%s` as a size.", max_size_arg
);
1995 ret
= lttng_snapshot_output_set_size(max_size
, snapshot_output
);
1997 ERR("Failed to set snapshot output's max size to %" PRIu64
" bytes.",
2005 struct lttng_uri
*uris
;
2007 if (!strstr(url_arg
, "://")) {
2008 ERR("Failed to parse '%s' as an URL.", url_arg
);
2012 num_uris
= uri_parse_str_urls(url_arg
, NULL
, &uris
);
2014 ERR("Failed to parse '%s' as an URL.", url_arg
);
2018 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
2019 ret
= lttng_snapshot_output_set_local_path(
2020 uris
[0].dst
.path
, snapshot_output
);
2023 ERR("Failed to assign '%s' as a local destination.",
2028 ret
= lttng_snapshot_output_set_network_url(
2029 url_arg
, snapshot_output
);
2032 ERR("Failed to assign '%s' as a network URL.",
2040 ret
= lttng_snapshot_output_set_local_path(
2041 path_arg
, snapshot_output
);
2043 ERR("Failed to parse '%s' as a local path.", path_arg
);
2050 * Two argument form, network output with separate control and
2053 ret
= lttng_snapshot_output_set_network_urls(
2054 ctrl_url_arg
, data_url_arg
, snapshot_output
);
2056 ERR("Failed to parse `%s` and `%s` as control and data URLs.",
2057 ctrl_url_arg
, data_url_arg
);
2062 if (snapshot_output
) {
2063 action_status
= lttng_action_snapshot_session_set_output(
2064 action
, snapshot_output
);
2065 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
2066 ERR("Failed to set snapshot session action's output.");
2070 /* Ownership of `snapshot_output` has been transferred to the action. */
2071 snapshot_output
= NULL
;
2075 enum lttng_action_status status
;
2076 status
= lttng_action_snapshot_session_set_rate_policy(
2078 if (status
!= LTTNG_ACTION_STATUS_OK
) {
2079 ERR("Failed to set rate policy");
2087 lttng_action_destroy(action
);
2091 free(snapshot_name_arg
);
2096 free(snapshot_output
);
2098 lttng_rate_policy_destroy(policy
);
2099 argpar_item_destroy(argpar_item
);
2100 argpar_iter_destroy(argpar_iter
);
2104 struct action_descr
{
2106 struct lttng_action
*(*handler
) (int *argc
, const char ***argv
,
2111 struct action_descr action_descrs
[] = {
2112 { "notify", handle_action_notify
},
2113 { "start-session", handle_action_start_session
},
2114 { "stop-session", handle_action_stop_session
},
2115 { "rotate-session", handle_action_rotate_session
},
2116 { "snapshot-session", handle_action_snapshot_session
},
2120 void print_valid_action_names(void)
2124 ERR("Valid action names are:");
2126 for (i
= 0; i
< ARRAY_SIZE(condition_descrs
); ++i
) {
2127 ERR(" %s", action_descrs
[i
].name
);
2132 struct lttng_action
*parse_action(const char *action_name
, int *argc
,
2133 const char ***argv
, int argc_offset
, int orig_arg_index
,
2134 const char *orig_arg
)
2137 struct lttng_action
*action
;
2138 const struct action_descr
*descr
= NULL
;
2140 for (i
= 0; i
< ARRAY_SIZE(action_descrs
); i
++) {
2141 if (strcmp(action_name
, action_descrs
[i
].name
) == 0) {
2142 descr
= &action_descrs
[i
];
2148 ERR(WHILE_PARSING_ARG_N_ARG_FMT
"Unknown action name '%s'",
2149 orig_arg_index
+ 1, orig_arg
, action_name
);
2150 print_valid_action_names();
2154 action
= descr
->handler(argc
, argv
, argc_offset
);
2156 /* The handler has already printed an error message. */
2168 struct argpar_opt_descr add_trigger_options
[] = {
2169 { OPT_HELP
, 'h', "help", false },
2170 { OPT_LIST_OPTIONS
, '\0', "list-options", false },
2171 { OPT_CONDITION
, '\0', "condition", true },
2172 { OPT_ACTION
, '\0', "action", true },
2173 { OPT_NAME
, '\0', "name", true },
2174 { OPT_OWNER_UID
, '\0', "owner-uid", true },
2175 ARGPAR_OPT_DESCR_SENTINEL
,
2179 void lttng_actions_destructor(void *p
)
2181 struct lttng_action
*action
= p
;
2183 lttng_action_destroy(action
);
2186 int cmd_add_trigger(int argc
, const char **argv
)
2189 int my_argc
= argc
- 1;
2190 const char **my_argv
= argv
+ 1;
2191 struct lttng_condition
*condition
= NULL
;
2192 struct lttng_dynamic_pointer_array actions
;
2193 struct argpar_iter
*argpar_iter
= NULL
;
2194 const struct argpar_item
*argpar_item
= NULL
;
2195 const struct argpar_error
*argpar_error
= NULL
;
2196 struct lttng_action
*action_list
= NULL
;
2197 struct lttng_action
*action
= NULL
;
2198 struct lttng_trigger
*trigger
= NULL
;
2201 char *owner_uid
= NULL
;
2202 enum lttng_error_code ret_code
;
2203 struct mi_writer
*mi_writer
= NULL
;
2205 lttng_dynamic_pointer_array_init(&actions
, lttng_actions_destructor
);
2208 mi_writer
= mi_lttng_writer_create(
2209 fileno(stdout
), lttng_opt_mi
);
2215 /* Open command element. */
2216 ret
= mi_lttng_writer_command_open(mi_writer
,
2217 mi_lttng_element_command_add_trigger
);
2223 /* Open output element. */
2224 ret
= mi_lttng_writer_open_element(
2225 mi_writer
, mi_lttng_element_command_output
);
2233 enum parse_next_item_status status
;
2235 const struct argpar_opt_descr
*descr
;
2238 argpar_iter_destroy(argpar_iter
);
2239 argpar_iter
= argpar_iter_create(my_argc
, my_argv
,
2240 add_trigger_options
);
2242 ERR("Failed to create argpar iter.");
2246 status
= parse_next_item(argpar_iter
, &argpar_item
,
2247 argc
- my_argc
, my_argv
, true, &argpar_error
, NULL
);
2248 if (status
== PARSE_NEXT_ITEM_STATUS_ERROR
) {
2250 if (argpar_error_type(argpar_error
) ==
2251 ARGPAR_ERROR_TYPE_MISSING_OPT_ARG
) {
2252 int opt_id
= argpar_error_opt_descr(argpar_error
, NULL
)->id
;
2254 if (opt_id
== OPT_CONDITION
) {
2255 print_valid_condition_names();
2256 } else if (opt_id
== OPT_ACTION
) {
2257 print_valid_action_names();
2262 } else if (status
== PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY
) {
2264 } else if (status
== PARSE_NEXT_ITEM_STATUS_END
) {
2268 assert(status
== PARSE_NEXT_ITEM_STATUS_OK
);
2270 if (argpar_item_type(argpar_item
) == ARGPAR_ITEM_TYPE_NON_OPT
) {
2271 ERR("Unexpected argument `%s`.",
2272 argpar_item_non_opt_arg(argpar_item
));
2276 ingested_args
= argpar_iter_ingested_orig_args(argpar_iter
);
2278 my_argc
-= ingested_args
;
2279 my_argv
+= ingested_args
;
2281 descr
= argpar_item_opt_descr(argpar_item
);
2282 arg
= argpar_item_opt_arg(argpar_item
);
2284 switch (descr
->id
) {
2289 case OPT_LIST_OPTIONS
:
2290 list_cmd_options_argpar(stdout
, add_trigger_options
);
2296 ERR("A --condition was already given.");
2300 condition
= parse_condition(arg
, &my_argc
, &my_argv
,
2301 argc
- my_argc
, argc
- my_argc
- ingested_args
,
2302 my_argv
[-ingested_args
]);
2305 * An error message was already printed by
2315 action
= parse_action(arg
, &my_argc
, &my_argv
,
2316 argc
- my_argc
, argc
- my_argc
- ingested_args
,
2317 my_argv
[-ingested_args
]);
2320 * An error message was already printed by
2326 ret
= lttng_dynamic_pointer_array_add_pointer(
2329 ERR("Failed to add pointer to pointer array.");
2333 /* Ownership of the action was transferred to the list. */
2340 if (!assign_string(&name
, arg
, "--name")) {
2348 if (!assign_string(&owner_uid
, arg
,
2361 ERR("Missing --condition.");
2365 if (lttng_dynamic_pointer_array_get_count(&actions
) == 0) {
2366 ERR("Need at least one --action.");
2370 action_list
= lttng_action_list_create();
2375 for (i
= 0; i
< lttng_dynamic_pointer_array_get_count(&actions
); i
++) {
2376 enum lttng_action_status status
;
2378 action
= lttng_dynamic_pointer_array_steal_pointer(&actions
, i
);
2380 status
= lttng_action_list_add_action(action_list
, action
);
2381 if (status
!= LTTNG_ACTION_STATUS_OK
) {
2386 * The `lttng_action_list_add_action()` takes a reference to
2387 * the action. We can destroy ours.
2389 lttng_action_destroy(action
);
2393 trigger
= lttng_trigger_create(condition
, action_list
);
2399 enum lttng_trigger_status trigger_status
;
2404 uid
= strtol(owner_uid
, &end
, 10);
2405 if (end
== owner_uid
|| *end
!= '\0' || errno
!= 0) {
2406 ERR("Failed to parse `%s` as a user id.", owner_uid
);
2410 trigger_status
= lttng_trigger_set_owner_uid(trigger
, uid
);
2411 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
2412 ERR("Failed to set trigger's user identity.");
2418 ret_code
= lttng_register_trigger_with_name(trigger
, name
);
2420 ret_code
= lttng_register_trigger_with_automatic_name(trigger
);
2423 if (ret_code
!= LTTNG_OK
) {
2424 ERR("Failed to register trigger: %s.",
2425 lttng_strerror(-ret_code
));
2430 ret_code
= lttng_trigger_mi_serialize(trigger
, mi_writer
, NULL
);
2431 if (ret_code
!= LTTNG_OK
) {
2435 const char *returned_trigger_name
;
2436 const enum lttng_trigger_status trigger_status
=
2437 lttng_trigger_get_name(trigger
,
2438 &returned_trigger_name
);
2440 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
2441 WARN("Failed to retrieve the added trigger's name.");
2443 MSG("Added trigger `%s`.", returned_trigger_name
);
2456 if (lttng_opt_mi
&& mi_writer
) {
2459 /* Close output element. */
2460 mi_ret
= mi_lttng_writer_close_element(mi_writer
);
2466 mi_ret
= mi_lttng_writer_write_element_bool(mi_writer
,
2467 mi_lttng_element_command_success
, ret
? 0 : 1);
2473 /* Command element close. */
2474 mi_ret
= mi_lttng_writer_command_close(mi_writer
);
2482 argpar_error_destroy(argpar_error
);
2483 argpar_iter_destroy(argpar_iter
);
2484 argpar_item_destroy(argpar_item
);
2485 lttng_dynamic_pointer_array_reset(&actions
);
2486 lttng_condition_destroy(condition
);
2487 lttng_action_destroy(action_list
);
2488 lttng_action_destroy(action
);
2489 lttng_trigger_destroy(trigger
);
2492 if (mi_writer
&& mi_lttng_writer_destroy(mi_writer
)) {
2493 /* Preserve original error code. */
2494 ret
= ret
? ret
: CMD_ERROR
;