2 * Copyright (C) 2021 Simon Marchi <simon.marchi@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
11 #include "../command.h"
12 #include "../loglevel.h"
13 #include "../uprobe.h"
15 #include "common/argpar/argpar.h"
16 #include "common/dynamic-array.h"
17 #include "common/string-utils/string-utils.h"
18 #include "common/utils.h"
19 /* For lttng_event_rule_type_str(). */
20 #include <lttng/event-rule/event-rule-internal.h>
21 #include <lttng/lttng.h>
22 #include "common/filter/filter-ast.h"
23 #include "common/filter/filter-ir.h"
24 #include "common/dynamic-array.h"
26 #if (LTTNG_SYMBOL_NAME_LEN == 256)
27 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
30 #ifdef LTTNG_EMBED_HELP
31 static const char help_msg
[] =
32 #include <lttng-add-trigger.1.h>
75 static const struct argpar_opt_descr event_rule_opt_descrs
[] = {
76 { OPT_ALL
, 'a', "all", false },
77 { OPT_FILTER
, 'f', "filter", true },
78 { OPT_EXCLUDE
, 'x', "exclude", true },
79 { OPT_LOGLEVEL
, '\0', "loglevel", true },
80 { OPT_LOGLEVEL_ONLY
, '\0', "loglevel-only", true },
83 { OPT_USERSPACE
, 'u', "userspace", false },
84 { OPT_KERNEL
, 'k', "kernel", false },
85 { OPT_LOG4J
, 'l', "log4j", false },
86 { OPT_JUL
, 'j', "jul", false },
87 { OPT_PYTHON
, 'p', "python", false },
89 /* Event rule types */
90 { OPT_FUNCTION
, '\0', "function", true },
91 { OPT_PROBE
, '\0', "probe", true },
92 { OPT_USERSPACE_PROBE
, '\0', "userspace-probe", true },
93 { OPT_SYSCALL
, '\0', "syscall" },
94 { OPT_TRACEPOINT
, '\0', "tracepoint" },
96 /* Capture descriptor */
97 { OPT_CAPTURE
, '\0', "capture", true },
99 ARGPAR_OPT_DESCR_SENTINEL
103 bool assign_domain_type(enum lttng_domain_type
*dest
,
104 enum lttng_domain_type src
)
108 if (*dest
== LTTNG_DOMAIN_NONE
|| *dest
== src
) {
112 ERR("Multiple domains specified.");
120 bool assign_event_rule_type(enum lttng_event_rule_type
*dest
,
121 enum lttng_event_rule_type src
)
125 if (*dest
== LTTNG_EVENT_RULE_TYPE_UNKNOWN
|| *dest
== src
) {
129 ERR("Multiple event types specified.");
137 bool assign_string(char **dest
, const char *src
, const char *opt_name
)
142 ERR("Duplicate '%s' given.", opt_name
);
148 PERROR("Failed to allocate string '%s'.", opt_name
);
162 /* This is defined in enable_events.c. */
164 int create_exclusion_list_and_validate(const char *event_name
,
165 const char *exclusions_arg
,
166 char ***exclusion_list
);
169 * Parse `str` as a log level in domain `domain_type`. Return -1 if the string
170 * is not recognized as a valid log level.
173 int parse_loglevel_string(const char *str
, enum lttng_domain_type domain_type
)
175 switch (domain_type
) {
176 case LTTNG_DOMAIN_UST
:
178 enum lttng_loglevel loglevel
;
179 const int ret
= loglevel_name_to_value(str
, &loglevel
);
181 return ret
== -1 ? ret
: (int) loglevel
;
183 case LTTNG_DOMAIN_LOG4J
:
185 enum lttng_loglevel_log4j loglevel
;
186 const int ret
= loglevel_log4j_name_to_value(str
, &loglevel
);
188 return ret
== -1 ? ret
: (int) loglevel
;
190 case LTTNG_DOMAIN_JUL
:
192 enum lttng_loglevel_jul loglevel
;
193 const int ret
= loglevel_jul_name_to_value(str
, &loglevel
);
195 return ret
== -1 ? ret
: (int) loglevel
;
197 case LTTNG_DOMAIN_PYTHON
:
199 enum lttng_loglevel_python loglevel
;
200 const int ret
= loglevel_python_name_to_value(str
, &loglevel
);
202 return ret
== -1 ? ret
: (int) loglevel
;
205 /* Invalid domain type. */
210 static int parse_kernel_probe_opts(const char *source
,
211 struct lttng_kernel_probe_location
**location
)
216 char name
[LTTNG_SYMBOL_NAME_LEN
];
217 char *symbol_name
= NULL
;
220 /* Check for symbol+offset. */
221 match
= sscanf(source
,
222 "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
226 if (*s_hex
== '\0') {
227 ERR("Kernel probe symbol offset is missing.");
231 symbol_name
= strndup(name
, LTTNG_SYMBOL_NAME_LEN
);
233 PERROR("Failed to copy kernel probe location symbol name.");
236 offset
= strtoul(s_hex
, NULL
, 0);
238 *location
= lttng_kernel_probe_location_symbol_create(
239 symbol_name
, offset
);
241 ERR("Failed to create symbol kernel probe location.");
248 /* Check for symbol. */
249 if (isalpha(name
[0]) || name
[0] == '_') {
250 match
= sscanf(source
,
251 "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
255 symbol_name
= strndup(name
, LTTNG_SYMBOL_NAME_LEN
);
257 ERR("Failed to copy kernel probe location symbol name.");
261 *location
= lttng_kernel_probe_location_symbol_create(
264 ERR("Failed to create symbol kernel probe location.");
272 /* Check for address. */
273 match
= sscanf(source
, "%18s", s_hex
);
277 if (*s_hex
== '\0') {
278 ERR("Invalid kernel probe location address.");
282 address
= strtoul(s_hex
, NULL
, 0);
283 *location
= lttng_kernel_probe_location_address_create(address
);
285 ERR("Failed to create symbol kernel probe location.");
303 struct lttng_event_expr
*ir_op_load_expr_to_event_expr(
304 const struct ir_load_expression
*load_expr
,
305 const char *capture_str
)
307 char *provider_name
= NULL
;
308 struct lttng_event_expr
*event_expr
= NULL
;
309 const struct ir_load_expression_op
*load_expr_op
= load_expr
->child
;
310 const enum ir_load_expression_type load_expr_child_type
=
313 switch (load_expr_child_type
) {
314 case IR_LOAD_EXPRESSION_GET_PAYLOAD_ROOT
:
315 case IR_LOAD_EXPRESSION_GET_CONTEXT_ROOT
:
317 const char *field_name
;
319 load_expr_op
= load_expr_op
->next
;
320 assert(load_expr_op
);
321 assert(load_expr_op
->type
== IR_LOAD_EXPRESSION_GET_SYMBOL
);
322 field_name
= load_expr_op
->u
.symbol
;
325 event_expr
= load_expr_child_type
== IR_LOAD_EXPRESSION_GET_PAYLOAD_ROOT
?
326 lttng_event_expr_event_payload_field_create(field_name
) :
327 lttng_event_expr_channel_context_field_create(field_name
);
329 ERR("Failed to create %s event expression: field name = `%s`.",
330 load_expr_child_type
== IR_LOAD_EXPRESSION_GET_PAYLOAD_ROOT
?
331 "payload field" : "channel context",
338 case IR_LOAD_EXPRESSION_GET_APP_CONTEXT_ROOT
:
341 const char *type_name
;
342 const char *field_name
;
344 load_expr_op
= load_expr_op
->next
;
345 assert(load_expr_op
);
346 assert(load_expr_op
->type
== IR_LOAD_EXPRESSION_GET_SYMBOL
);
347 field_name
= load_expr_op
->u
.symbol
;
351 * The field name needs to be of the form PROVIDER:TYPE. We
354 colon
= strchr(field_name
, ':');
356 ERR("Invalid app-specific context field name: missing colon in `%s`.",
361 type_name
= colon
+ 1;
362 if (*type_name
== '\0') {
363 ERR("Invalid app-specific context field name: missing type name after colon in `%s`.",
368 provider_name
= strndup(field_name
, colon
- field_name
);
369 if (!provider_name
) {
370 PERROR("Failed to allocate field name string");
374 event_expr
= lttng_event_expr_app_specific_context_field_create(
375 provider_name
, type_name
);
377 ERR("Failed to create app-specific context field event expression: provider name = `%s`, type name = `%s`",
378 provider_name
, type_name
);
385 ERR("%s: unexpected load expr type %d.", __func__
,
390 load_expr_op
= load_expr_op
->next
;
392 /* There may be a single array index after that. */
393 if (load_expr_op
->type
== IR_LOAD_EXPRESSION_GET_INDEX
) {
394 struct lttng_event_expr
*index_event_expr
;
395 const uint64_t index
= load_expr_op
->u
.index
;
397 index_event_expr
= lttng_event_expr_array_field_element_create(event_expr
, index
);
398 if (!index_event_expr
) {
399 ERR("Failed to create array field element event expression.");
403 event_expr
= index_event_expr
;
404 load_expr_op
= load_expr_op
->next
;
407 switch (load_expr_op
->type
) {
408 case IR_LOAD_EXPRESSION_LOAD_FIELD
:
410 * This is what we expect, IR_LOAD_EXPRESSION_LOAD_FIELD is
411 * always found at the end of the chain.
414 case IR_LOAD_EXPRESSION_GET_SYMBOL
:
415 ERR("While parsing expression `%s`: Capturing subfields is not supported.",
420 ERR("%s: unexpected load expression operator %s.", __func__
,
421 ir_load_expression_type_str(load_expr_op
->type
));
428 lttng_event_expr_destroy(event_expr
);
438 struct lttng_event_expr
*ir_op_load_to_event_expr(
439 const struct ir_op
*ir
, const char *capture_str
)
441 struct lttng_event_expr
*event_expr
= NULL
;
443 assert(ir
->op
== IR_OP_LOAD
);
445 switch (ir
->data_type
) {
446 case IR_DATA_EXPRESSION
:
448 const struct ir_load_expression
*ir_load_expr
=
449 ir
->u
.load
.u
.expression
;
451 event_expr
= ir_op_load_expr_to_event_expr(
452 ir_load_expr
, capture_str
);
456 ERR("%s: unexpected data type: %s.", __func__
,
457 ir_data_type_str(ir
->data_type
));
465 const char *ir_operator_type_human_str(enum ir_op_type op
)
487 struct lttng_event_expr
*ir_op_root_to_event_expr(const struct ir_op
*ir
,
488 const char *capture_str
)
490 struct lttng_event_expr
*event_expr
= NULL
;
492 assert(ir
->op
== IR_OP_ROOT
);
493 ir
= ir
->u
.root
.child
;
497 event_expr
= ir_op_load_to_event_expr(ir
, capture_str
);
502 ERR("While parsing expression `%s`: %s operators are not allowed in capture expressions.",
504 ir_operator_type_human_str(ir
->op
));
507 ERR("%s: unexpected IR op type: %s.", __func__
,
508 ir_op_type_str(ir
->op
));
516 void destroy_event_expr(void *ptr
)
518 lttng_event_expr_destroy(ptr
);
521 struct parse_event_rule_res
{
523 struct lttng_event_rule
*er
;
525 /* Array of `struct lttng_event_expr *` */
526 struct lttng_dynamic_pointer_array capture_descriptors
;
530 struct parse_event_rule_res
parse_event_rule(int *argc
, const char ***argv
)
532 enum lttng_domain_type domain_type
= LTTNG_DOMAIN_NONE
;
533 enum lttng_event_rule_type event_rule_type
=
534 LTTNG_EVENT_RULE_TYPE_UNKNOWN
;
535 struct argpar_state
*state
;
536 struct argpar_item
*item
= NULL
;
538 int consumed_args
= -1;
539 struct lttng_kernel_probe_location
*kernel_probe_location
= NULL
;
540 struct lttng_userspace_probe_location
*userspace_probe_location
= NULL
;
541 struct parse_event_rule_res res
= { 0 };
542 struct lttng_event_expr
*event_expr
= NULL
;
543 struct filter_parser_ctx
*parser_ctx
= NULL
;
544 struct lttng_log_level_rule
*log_level_rule
= NULL
;
546 /* Was the -a/--all flag provided? */
547 bool all_events
= false;
549 /* Tracepoint name (non-option argument). */
550 const char *tracepoint_name
= NULL
;
552 /* Holds the argument of --probe / --userspace-probe. */
559 char *exclude
= NULL
;
560 char **exclusion_list
= NULL
;
563 char *loglevel_str
= NULL
;
564 bool loglevel_only
= false;
566 lttng_dynamic_pointer_array_init(&res
.capture_descriptors
,
568 state
= argpar_state_create(*argc
, *argv
, event_rule_opt_descrs
);
570 ERR("Failed to allocate an argpar state.");
575 enum argpar_state_parse_next_status status
;
577 ARGPAR_ITEM_DESTROY_AND_RESET(item
);
578 status
= argpar_state_parse_next(state
, &item
, &error
);
579 if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR
) {
582 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT
) {
583 /* Just stop parsing here. */
585 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_END
) {
589 assert(status
== ARGPAR_STATE_PARSE_NEXT_STATUS_OK
);
591 if (item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
592 const struct argpar_item_opt
*item_opt
=
593 (const struct argpar_item_opt
*) item
;
595 switch (item_opt
->descr
->id
) {
598 if (!assign_domain_type(&domain_type
, LTTNG_DOMAIN_UST
)) {
604 if (!assign_domain_type(&domain_type
, LTTNG_DOMAIN_KERNEL
)) {
610 if (!assign_domain_type(&domain_type
, LTTNG_DOMAIN_LOG4J
)) {
616 if (!assign_domain_type(&domain_type
, LTTNG_DOMAIN_JUL
)) {
622 if (!assign_domain_type(&domain_type
, LTTNG_DOMAIN_PYTHON
)) {
628 /* Event rule types */
630 if (!assign_event_rule_type(&event_rule_type
,
631 LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
)) {
637 if (!assign_event_rule_type(&event_rule_type
,
638 LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE
)) {
642 if (!assign_string(&source
, item_opt
->arg
, "source")) {
647 case OPT_USERSPACE_PROBE
:
648 if (!assign_event_rule_type(&event_rule_type
,
649 LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE
)) {
653 if (!assign_string(&source
, item_opt
->arg
, "source")) {
659 if (!assign_event_rule_type(&event_rule_type
,
660 LTTNG_EVENT_RULE_TYPE_SYSCALL
)) {
666 if (!assign_event_rule_type(&event_rule_type
,
667 LTTNG_EVENT_RULE_TYPE_TRACEPOINT
)) {
676 if (!assign_string(&filter
, item_opt
->arg
,
683 if (!assign_string(&exclude
, item_opt
->arg
,
690 case OPT_LOGLEVEL_ONLY
:
691 if (!assign_string(&loglevel_str
, item_opt
->arg
,
692 "--loglevel/--loglevel-only")) {
696 loglevel_only
= item_opt
->descr
->id
==
702 const char *capture_str
= item_opt
->arg
;
704 ret
= filter_parser_ctx_create_from_filter_expression(
705 capture_str
, &parser_ctx
);
707 ERR("Failed to parse capture expression `%s`.",
712 event_expr
= ir_op_root_to_event_expr(
717 * ir_op_root_to_event_expr has printed
723 ret
= lttng_dynamic_pointer_array_add_pointer(
724 &res
.capture_descriptors
,
731 * The ownership of event expression was
732 * transferred to the dynamic array.
742 const struct argpar_item_non_opt
*item_non_opt
=
743 (const struct argpar_item_non_opt
*)
747 * Don't accept two non-option arguments/tracepoint
750 if (tracepoint_name
) {
751 ERR("Unexpected argument '%s'",
756 tracepoint_name
= item_non_opt
->arg
;
760 if (event_rule_type
== LTTNG_EVENT_RULE_TYPE_UNKNOWN
) {
761 event_rule_type
= LTTNG_EVENT_RULE_TYPE_TRACEPOINT
;
765 * Option -a is applicable to event rules of type tracepoint and
766 * syscall, and it is equivalent to using "*" as the tracepoint name.
769 switch (event_rule_type
) {
770 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
771 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
774 ERR("Can't use -a/--all with %s event rules.",
775 lttng_event_rule_type_str(event_rule_type
));
779 if (tracepoint_name
) {
780 ERR("Can't provide a tracepoint name with -a/--all.");
784 /* In which case, it's equivalent to tracepoint name "*". */
785 tracepoint_name
= "*";
789 * A tracepoint name (or -a, for the event rule types that accept it)
792 if (!tracepoint_name
) {
793 ERR("Need to provide either a tracepoint name or -a/--all.");
798 * We don't support multiple tracepoint names for now.
800 if (strchr(tracepoint_name
, ',')) {
801 ERR("Comma separated tracepoint names are not supported.");
806 * Update *argc and *argv so our caller can keep parsing what follows.
808 consumed_args
= argpar_state_get_ingested_orig_args(state
);
809 assert(consumed_args
>= 0);
810 *argc
-= consumed_args
;
811 *argv
+= consumed_args
;
813 /* Need to specify a domain. */
814 if (domain_type
== LTTNG_DOMAIN_NONE
) {
815 ERR("Please specify a domain (--kernel/--userspace/--jul/--log4j/--python).");
819 /* Validate event rule type against domain. */
820 switch (event_rule_type
) {
821 case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE
:
822 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION
:
823 case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE
:
824 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
825 if (domain_type
!= LTTNG_DOMAIN_KERNEL
) {
826 ERR("Event type not available for user-space tracing.");
831 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
839 * Adding a filter to a probe, function or userspace-probe would be
840 * denied by the kernel tracer as it's not supported at the moment. We
841 * do an early check here to warn the user.
843 if (filter
&& domain_type
== LTTNG_DOMAIN_KERNEL
) {
844 switch (event_rule_type
) {
845 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
846 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
849 ERR("Filter expressions are not supported for %s event rules.",
850 lttng_event_rule_type_str(event_rule_type
));
855 /* If --exclude/-x was passed, split it into an exclusion list. */
857 if (domain_type
!= LTTNG_DOMAIN_UST
) {
858 ERR("Event name exclusions are not yet implemented for %s event rules.",
859 get_domain_str(domain_type
));
864 if (create_exclusion_list_and_validate(tracepoint_name
, exclude
,
865 &exclusion_list
) != 0) {
866 ERR("Failed to create exclusion list.");
871 if (loglevel_str
&& event_rule_type
!= LTTNG_EVENT_RULE_TYPE_TRACEPOINT
) {
872 ERR("Log levels are only applicable to tracepoint event rules.");
876 /* Finally, create the event rule object. */
877 switch (event_rule_type
) {
878 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
880 enum lttng_event_rule_status event_rule_status
;
882 res
.er
= lttng_event_rule_tracepoint_create(domain_type
);
884 ERR("Failed to create tracepoint event rule.");
889 event_rule_status
= lttng_event_rule_tracepoint_set_pattern(
890 res
.er
, tracepoint_name
);
891 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
892 ERR("Failed to set tracepoint event rule's pattern to '%s'.",
899 event_rule_status
= lttng_event_rule_tracepoint_set_filter(
901 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
902 ERR("Failed to set tracepoint event rule's filter to '%s'.",
908 /* Set exclusion list. */
909 if (exclusion_list
) {
912 for (n
= 0; exclusion_list
[n
]; n
++) {
913 event_rule_status
= lttng_event_rule_tracepoint_add_exclusion(
916 if (event_rule_status
!=
917 LTTNG_EVENT_RULE_STATUS_OK
) {
918 ERR("Failed to set tracepoint exclusion list element '%s'",
928 if (domain_type
== LTTNG_DOMAIN_KERNEL
) {
929 ERR("Log levels are not supported by the kernel tracer.");
933 loglevel
= parse_loglevel_string(
934 loglevel_str
, domain_type
);
936 ERR("Failed to parse `%s` as a log level.",
942 log_level_rule
= lttng_log_level_rule_exactly_create(loglevel
);
944 log_level_rule
= lttng_log_level_rule_at_least_as_severe_as_create(loglevel
);
947 if (log_level_rule
== NULL
) {
948 ERR("Failed to create log level rule object.");
953 lttng_event_rule_tracepoint_set_log_level_rule(
954 res
.er
, log_level_rule
);
956 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
957 ERR("Failed to set log level on event fule.");
964 case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE
:
967 enum lttng_event_rule_status event_rule_status
;
970 ret
= parse_kernel_probe_opts(source
, &kernel_probe_location
);
972 ERR("Failed to parse kernel probe location.");
976 assert(kernel_probe_location
);
977 res
.er
= lttng_event_rule_kernel_probe_create(kernel_probe_location
);
979 ERR("Failed to create kprobe event rule.");
983 event_rule_status
= lttng_event_rule_kernel_probe_set_event_name(res
.er
, tracepoint_name
);
984 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
985 ERR("Failed to set kprobe event rule's name to '%s'.", tracepoint_name
);
991 case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE
:
994 enum lttng_event_rule_status event_rule_status
;
996 ret
= parse_userspace_probe_opts(
997 source
, &userspace_probe_location
);
999 ERR("Failed to parse user space probe location.");
1003 res
.er
= lttng_event_rule_userspace_probe_create(userspace_probe_location
);
1005 ERR("Failed to create userspace probe event rule.");
1009 event_rule_status
= lttng_event_rule_userspace_probe_set_event_name(
1010 res
.er
, tracepoint_name
);
1011 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1012 ERR("Failed to set user space probe event rule's name to '%s'.",
1019 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
1021 enum lttng_event_rule_status event_rule_status
;
1023 res
.er
= lttng_event_rule_syscall_create();
1025 ERR("Failed to create syscall event rule.");
1029 event_rule_status
= lttng_event_rule_syscall_set_pattern(
1030 res
.er
, tracepoint_name
);
1031 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1032 ERR("Failed to set syscall event rule's pattern to '%s'.",
1038 event_rule_status
= lttng_event_rule_syscall_set_filter(
1040 if (event_rule_status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1041 ERR("Failed to set syscall event rule's filter to '%s'.",
1057 lttng_event_rule_destroy(res
.er
);
1059 lttng_dynamic_pointer_array_reset(&res
.capture_descriptors
);
1063 filter_parser_ctx_free(parser_ctx
);
1066 lttng_event_expr_destroy(event_expr
);
1067 argpar_item_destroy(item
);
1069 argpar_state_destroy(state
);
1074 strutils_free_null_terminated_array_of_strings(exclusion_list
);
1075 lttng_kernel_probe_location_destroy(kernel_probe_location
);
1076 lttng_userspace_probe_location_destroy(userspace_probe_location
);
1077 lttng_log_level_rule_destroy(log_level_rule
);
1082 struct lttng_condition
*handle_condition_event(int *argc
, const char ***argv
)
1084 struct parse_event_rule_res res
;
1085 struct lttng_condition
*c
;
1088 res
= parse_event_rule(argc
, argv
);
1094 c
= lttng_condition_on_event_create(res
.er
);
1095 lttng_event_rule_destroy(res
.er
);
1101 for (i
= 0; i
< lttng_dynamic_pointer_array_get_count(&res
.capture_descriptors
);
1103 enum lttng_condition_status status
;
1104 struct lttng_event_expr
**expr
=
1105 lttng_dynamic_array_get_element(
1106 &res
.capture_descriptors
.array
, i
);
1110 status
= lttng_condition_on_event_append_capture_descriptor(
1112 if (status
!= LTTNG_CONDITION_STATUS_OK
) {
1113 if (status
== LTTNG_CONDITION_STATUS_UNSUPPORTED
) {
1114 ERR("The capture feature is unsupported by the event-rule condition type");
1120 /* Ownership of event expression moved to `c` */
1127 lttng_condition_destroy(c
);
1131 lttng_dynamic_pointer_array_reset(&res
.capture_descriptors
);
1132 lttng_event_rule_destroy(res
.er
);
1137 struct lttng_condition
*handle_condition_session_consumed_size(int *argc
, const char ***argv
)
1139 struct lttng_condition
*cond
= NULL
;
1140 struct argpar_state
*state
= NULL
;
1141 struct argpar_item
*item
= NULL
;
1142 const char *threshold_arg
= NULL
;
1143 const char *session_name_arg
= NULL
;
1146 enum lttng_condition_status condition_status
;
1148 state
= argpar_state_create(*argc
, *argv
, event_rule_opt_descrs
);
1150 ERR("Failed to allocate an argpar state.");
1155 enum argpar_state_parse_next_status status
;
1157 ARGPAR_ITEM_DESTROY_AND_RESET(item
);
1158 status
= argpar_state_parse_next(state
, &item
, &error
);
1159 if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR
) {
1162 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT
) {
1163 /* Just stop parsing here. */
1165 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_END
) {
1169 assert(status
== ARGPAR_STATE_PARSE_NEXT_STATUS_OK
);
1171 if (item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
1172 const struct argpar_item_opt
*item_opt
=
1173 (const struct argpar_item_opt
*) item
;
1175 switch (item_opt
->descr
->id
) {
1180 const struct argpar_item_non_opt
*item_non_opt
;
1182 assert(item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
);
1184 item_non_opt
= (const struct argpar_item_non_opt
*) item
;
1186 switch (item_non_opt
->non_opt_index
) {
1188 session_name_arg
= item_non_opt
->arg
;
1191 threshold_arg
= item_non_opt
->arg
;
1194 ERR("Unexpected argument `%s`.",
1201 *argc
-= argpar_state_get_ingested_orig_args(state
);
1202 *argv
+= argpar_state_get_ingested_orig_args(state
);
1204 if (!session_name_arg
) {
1205 ERR("Missing session name argument.");
1209 if (!threshold_arg
) {
1210 ERR("Missing threshold argument.");
1214 if (utils_parse_size_suffix(threshold_arg
, &threshold
) != 0) {
1215 ERR("Failed to parse `%s` as a size.", threshold_arg
);
1219 cond
= lttng_condition_session_consumed_size_create();
1221 ERR("Failed to allocate a session consumed size condition.");
1225 condition_status
= lttng_condition_session_consumed_size_set_session_name(
1226 cond
, session_name_arg
);
1227 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
1228 ERR("Failed to set session consumed size condition's session name to '%s'.",
1233 condition_status
= lttng_condition_session_consumed_size_set_threshold(
1235 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
1236 ERR("Failed to set session consumed size condition threshold.");
1243 lttng_condition_destroy(cond
);
1247 argpar_state_destroy(state
);
1248 argpar_item_destroy(item
);
1254 struct lttng_condition
*handle_condition_buffer_usage_high(int *argc
, const char ***argv
)
1256 ERR("High buffer usage threshold conditions are unsupported for the moment.");
1261 struct lttng_condition
*handle_condition_buffer_usage_low(int *argc
, const char ***argv
)
1263 ERR("Low buffer usage threshold conditions are unsupported for the moment.");
1268 struct lttng_condition
*handle_condition_session_rotation_ongoing(int *argc
, const char ***argv
)
1270 ERR("Session rotation ongoing conditions are unsupported for the moment.");
1275 struct lttng_condition
*handle_condition_session_rotation_completed(int *argc
, const char ***argv
)
1277 ERR("Session rotation completed conditions are unsupported for the moment.");
1281 struct condition_descr
{
1283 struct lttng_condition
*(*handler
) (int *argc
, const char ***argv
);
1287 struct condition_descr condition_descrs
[] = {
1288 { "on-event", handle_condition_event
},
1289 { "on-session-consumed-size", handle_condition_session_consumed_size
},
1290 { "on-buffer-usage-high", handle_condition_buffer_usage_high
},
1291 { "on-buffer-usage-low", handle_condition_buffer_usage_low
},
1292 { "on-session-rotation-ongoing", handle_condition_session_rotation_ongoing
},
1293 { "on-session-rotation-completed", handle_condition_session_rotation_completed
},
1297 struct lttng_condition
*parse_condition(int *argc
, const char ***argv
)
1300 struct lttng_condition
*cond
;
1301 const char *condition_name
;
1302 const struct condition_descr
*descr
= NULL
;
1305 ERR("Missing condition name.");
1309 condition_name
= (*argv
)[0];
1314 for (i
= 0; i
< ARRAY_SIZE(condition_descrs
); i
++) {
1315 if (strcmp(condition_name
, condition_descrs
[i
].name
) == 0) {
1316 descr
= &condition_descrs
[i
];
1322 ERR("Unknown condition name '%s'", condition_name
);
1326 cond
= descr
->handler(argc
, argv
);
1328 /* The handler has already printed an error message. */
1338 static const struct argpar_opt_descr notify_action_opt_descrs
[] = {
1339 { OPT_FIRE_ONCE_AFTER
, '\0', "fire-once-after", true },
1340 { OPT_FIRE_EVERY
, '\0', "fire-every", true },
1341 ARGPAR_OPT_DESCR_SENTINEL
1346 struct lttng_action
*handle_action_notify(int *argc
, const char ***argv
)
1348 struct lttng_action
*action
= NULL
;
1349 struct argpar_state
*state
= NULL
;
1350 struct argpar_item
*item
= NULL
;
1352 char *fire_once_after_str
= NULL
;
1353 char *fire_every_str
= NULL
;
1354 struct lttng_firing_policy
*policy
= NULL
;
1356 state
= argpar_state_create(*argc
, *argv
, notify_action_opt_descrs
);
1358 ERR("Failed to allocate an argpar state.");
1363 enum argpar_state_parse_next_status status
;
1365 ARGPAR_ITEM_DESTROY_AND_RESET(item
);
1366 status
= argpar_state_parse_next(state
, &item
, &error
);
1367 if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR
) {
1370 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT
) {
1371 /* Just stop parsing here. */
1373 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_END
) {
1377 assert(status
== ARGPAR_STATE_PARSE_NEXT_STATUS_OK
);
1379 if (item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
1380 const struct argpar_item_opt
*item_opt
=
1381 (const struct argpar_item_opt
*) item
;
1383 switch (item_opt
->descr
->id
) {
1384 case OPT_FIRE_ONCE_AFTER
:
1386 if (!assign_string(&fire_once_after_str
,
1388 "--fire-once-after")) {
1394 case OPT_FIRE_EVERY
:
1396 if (!assign_string(&fire_every_str
,
1409 const struct argpar_item_non_opt
*item_non_opt
;
1411 assert(item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
);
1413 item_non_opt
= (const struct argpar_item_non_opt
*) item
;
1415 switch (item_non_opt
->non_opt_index
) {
1417 ERR("Unexpected argument `%s`.",
1424 *argc
-= argpar_state_get_ingested_orig_args(state
);
1425 *argv
+= argpar_state_get_ingested_orig_args(state
);
1427 if (fire_once_after_str
&& fire_every_str
) {
1428 ERR("--fire-once and --fire-every are mutually exclusive.");
1432 if (fire_once_after_str
) {
1433 unsigned long long threshold
;
1435 if (utils_parse_unsigned_long_long(
1436 fire_once_after_str
, &threshold
) != 0) {
1437 ERR("Failed to parse `%s` as an integer.",
1438 fire_once_after_str
);
1442 if (threshold
== 0) {
1443 ERR("Once after N policy threshold cannot be `0`.");
1447 policy
= lttng_firing_policy_once_after_n_create(threshold
);
1449 ERR("Failed to create policy once after `%s`.",
1450 fire_once_after_str
);
1455 if (fire_every_str
) {
1456 unsigned long long interval
;
1457 if (utils_parse_unsigned_long_long(fire_every_str
, &interval
) !=
1459 ERR("Failed to parse `%s` as an integer.",
1463 if (interval
== 0) {
1464 ERR("Every N policy interval cannot be `0`.");
1468 policy
= lttng_firing_policy_every_n_create(interval
);
1470 ERR("Failed to create policy every `%s`.",
1476 action
= lttng_action_notify_create();
1478 ERR("Failed to create notify action");
1483 enum lttng_action_status status
;
1484 status
= lttng_action_notify_set_firing_policy(action
, policy
);
1485 if (status
!= LTTNG_ACTION_STATUS_OK
) {
1486 ERR("Failed to set firing policy");
1494 lttng_action_destroy(action
);
1498 free(fire_once_after_str
);
1499 free(fire_every_str
);
1500 lttng_firing_policy_destroy(policy
);
1501 argpar_state_destroy(state
);
1502 argpar_item_destroy(item
);
1507 * Generic handler for a kind of action that takes a session name and an
1508 * optional firing policy.
1511 static struct lttng_action
*handle_action_simple_session_with_policy(int *argc
,
1513 struct lttng_action
*(*create_action_cb
)(void),
1514 enum lttng_action_status (*set_session_name_cb
)(
1515 struct lttng_action
*, const char *),
1516 enum lttng_action_status (*set_firing_policy_cb
)(
1517 struct lttng_action
*,
1518 const struct lttng_firing_policy
*),
1519 const char *action_name
)
1521 struct lttng_action
*action
= NULL
;
1522 struct argpar_state
*state
= NULL
;
1523 struct argpar_item
*item
= NULL
;
1524 const char *session_name_arg
= NULL
;
1525 char *fire_once_after_str
= NULL
;
1526 char *fire_every_str
= NULL
;
1528 enum lttng_action_status action_status
;
1529 struct lttng_firing_policy
*policy
= NULL
;
1531 assert(set_session_name_cb
);
1532 assert(set_firing_policy_cb
);
1534 const struct argpar_opt_descr firing_policy_opt_descrs
[] = {
1535 { OPT_FIRE_ONCE_AFTER
, '\0', "fire-once-after", true },
1536 { OPT_FIRE_EVERY
, '\0', "fire-every", true },
1537 ARGPAR_OPT_DESCR_SENTINEL
1540 state
= argpar_state_create(*argc
, *argv
, firing_policy_opt_descrs
);
1542 ERR("Failed to allocate an argpar state.");
1547 enum argpar_state_parse_next_status status
;
1549 ARGPAR_ITEM_DESTROY_AND_RESET(item
);
1550 status
= argpar_state_parse_next(state
, &item
, &error
);
1551 if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR
) {
1554 } else if (status
==
1555 ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT
) {
1556 /* Just stop parsing here. */
1558 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_END
) {
1562 assert(status
== ARGPAR_STATE_PARSE_NEXT_STATUS_OK
);
1563 if (item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
1564 const struct argpar_item_opt
*item_opt
=
1565 (const struct argpar_item_opt
*) item
;
1567 switch (item_opt
->descr
->id
) {
1568 case OPT_FIRE_ONCE_AFTER
:
1570 if (!assign_string(&fire_once_after_str
,
1572 "--fire-once-after")) {
1578 case OPT_FIRE_EVERY
:
1580 if (!assign_string(&fire_every_str
,
1593 const struct argpar_item_non_opt
*item_non_opt
;
1594 item_non_opt
= (const struct argpar_item_non_opt
*) item
;
1596 switch (item_non_opt
->non_opt_index
) {
1598 session_name_arg
= item_non_opt
->arg
;
1601 ERR("Unexpected argument `%s`.",
1608 *argc
-= argpar_state_get_ingested_orig_args(state
);
1609 *argv
+= argpar_state_get_ingested_orig_args(state
);
1611 if (!session_name_arg
) {
1612 ERR("Missing session name.");
1616 if (fire_once_after_str
&& fire_every_str
) {
1617 ERR("--fire-once and --fire-every are mutually exclusive.");
1621 if (fire_once_after_str
) {
1622 unsigned long long threshold
;
1624 if (utils_parse_unsigned_long_long(
1625 fire_once_after_str
, &threshold
) != 0) {
1626 ERR("Failed to parse `%s` as an integer.",
1627 fire_once_after_str
);
1631 if (threshold
== 0) {
1632 ERR("Once after N policy threshold cannot be `0`.");
1636 policy
= lttng_firing_policy_once_after_n_create(threshold
);
1638 ERR("Failed to create policy once after `%s`.",
1639 fire_once_after_str
);
1644 if (fire_every_str
) {
1645 unsigned long long interval
;
1646 if (utils_parse_unsigned_long_long(fire_every_str
, &interval
) !=
1648 ERR("Failed to parse `%s` as an integer.",
1652 if (interval
== 0) {
1653 ERR("Every N policy interval cannot be `0`.");
1657 policy
= lttng_firing_policy_every_n_create(interval
);
1659 ERR("Failed to create policy every `%s`.",
1665 action
= create_action_cb();
1667 ERR("Failed to allocate %s session action.", action_name
);
1671 action_status
= set_session_name_cb(action
, session_name_arg
);
1672 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
1673 ERR("Failed to set action %s session's session name to '%s'.",
1674 action_name
, session_name_arg
);
1679 action_status
= set_firing_policy_cb(action
, policy
);
1680 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
1681 ERR("Failed to set firing policy");
1689 lttng_action_destroy(action
);
1691 argpar_item_destroy(item
);
1693 lttng_firing_policy_destroy(policy
);
1695 argpar_state_destroy(state
);
1700 struct lttng_action
*handle_action_start_session(int *argc
,
1703 return handle_action_simple_session_with_policy(argc
, argv
,
1704 lttng_action_start_session_create
,
1705 lttng_action_start_session_set_session_name
,
1706 lttng_action_start_session_set_firing_policy
, "start");
1710 struct lttng_action
*handle_action_stop_session(int *argc
,
1713 return handle_action_simple_session_with_policy(argc
, argv
,
1714 lttng_action_stop_session_create
,
1715 lttng_action_stop_session_set_session_name
,
1716 lttng_action_stop_session_set_firing_policy
, "stop");
1720 struct lttng_action
*handle_action_rotate_session(int *argc
,
1723 return handle_action_simple_session_with_policy(argc
, argv
,
1724 lttng_action_rotate_session_create
,
1725 lttng_action_rotate_session_set_session_name
,
1726 lttng_action_rotate_session_set_firing_policy
,
1730 static const struct argpar_opt_descr snapshot_action_opt_descrs
[] = {
1731 { OPT_NAME
, 'n', "name", true },
1732 { OPT_MAX_SIZE
, 'm', "max-size", true },
1733 { OPT_CTRL_URL
, '\0', "ctrl-url", true },
1734 { OPT_DATA_URL
, '\0', "data-url", true },
1735 { OPT_URL
, '\0', "url", true },
1736 { OPT_PATH
, '\0', "path", true },
1737 { OPT_FIRE_ONCE_AFTER
, '\0', "fire-once-after", true },
1738 { OPT_FIRE_EVERY
, '\0', "fire-every", true },
1739 ARGPAR_OPT_DESCR_SENTINEL
1743 struct lttng_action
*handle_action_snapshot_session(int *argc
,
1746 struct lttng_action
*action
= NULL
;
1747 struct argpar_state
*state
= NULL
;
1748 struct argpar_item
*item
= NULL
;
1749 const char *session_name_arg
= NULL
;
1750 char *snapshot_name_arg
= NULL
;
1751 char *ctrl_url_arg
= NULL
;
1752 char *data_url_arg
= NULL
;
1753 char *max_size_arg
= NULL
;
1754 char *url_arg
= NULL
;
1755 char *path_arg
= NULL
;
1757 char *fire_once_after_str
= NULL
;
1758 char *fire_every_str
= NULL
;
1759 enum lttng_action_status action_status
;
1760 struct lttng_snapshot_output
*snapshot_output
= NULL
;
1761 struct lttng_firing_policy
*policy
= NULL
;
1763 unsigned int locations_specified
= 0;
1765 state
= argpar_state_create(*argc
, *argv
, snapshot_action_opt_descrs
);
1767 ERR("Failed to allocate an argpar state.");
1772 enum argpar_state_parse_next_status status
;
1774 ARGPAR_ITEM_DESTROY_AND_RESET(item
);
1775 status
= argpar_state_parse_next(state
, &item
, &error
);
1776 if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR
) {
1779 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT
) {
1780 /* Just stop parsing here. */
1782 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_END
) {
1786 assert(status
== ARGPAR_STATE_PARSE_NEXT_STATUS_OK
);
1788 if (item
->type
== ARGPAR_ITEM_TYPE_OPT
) {
1789 const struct argpar_item_opt
*item_opt
=
1790 (const struct argpar_item_opt
*) item
;
1792 switch (item_opt
->descr
->id
) {
1794 if (!assign_string(&snapshot_name_arg
, item_opt
->arg
, "--name/-n")) {
1800 if (!assign_string(&max_size_arg
, item_opt
->arg
, "--max-size/-m")) {
1806 if (!assign_string(&ctrl_url_arg
, item_opt
->arg
, "--ctrl-url")) {
1812 if (!assign_string(&data_url_arg
, item_opt
->arg
, "--data-url")) {
1818 if (!assign_string(&url_arg
, item_opt
->arg
, "--url")) {
1824 if (!assign_string(&path_arg
, item_opt
->arg
, "--path")) {
1829 case OPT_FIRE_ONCE_AFTER
:
1831 if (!assign_string(&fire_once_after_str
,
1833 "--fire-once-after")) {
1839 case OPT_FIRE_EVERY
:
1841 if (!assign_string(&fire_every_str
,
1854 const struct argpar_item_non_opt
*item_non_opt
;
1856 assert(item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
);
1858 item_non_opt
= (const struct argpar_item_non_opt
*) item
;
1860 switch (item_non_opt
->non_opt_index
) {
1862 session_name_arg
= item_non_opt
->arg
;
1865 ERR("Unexpected argument `%s`.",
1872 *argc
-= argpar_state_get_ingested_orig_args(state
);
1873 *argv
+= argpar_state_get_ingested_orig_args(state
);
1875 if (!session_name_arg
) {
1876 ERR("Missing session name.");
1880 /* --ctrl-url and --data-url must come in pair. */
1881 if (ctrl_url_arg
&& !data_url_arg
) {
1882 ERR("--ctrl-url is specified, but --data-url is missing.");
1886 if (!ctrl_url_arg
&& data_url_arg
) {
1887 ERR("--data-url is specified, but --ctrl-url is missing.");
1891 locations_specified
+= !!(ctrl_url_arg
|| data_url_arg
);
1892 locations_specified
+= !!url_arg
;
1893 locations_specified
+= !!path_arg
;
1895 /* --ctrl-url/--data-url, --url and --path are mutually exclusive. */
1896 if (locations_specified
> 1) {
1897 ERR("The --ctrl-url/--data-url, --url, and --path options can't be used together.");
1902 * Did the user specify an option that implies using a
1903 * custom/unregistered output?
1905 if (url_arg
|| ctrl_url_arg
|| path_arg
) {
1906 snapshot_output
= lttng_snapshot_output_create();
1907 if (!snapshot_output
) {
1908 ERR("Failed to allocate a snapshot output.");
1913 /* Any firing policy ? */
1914 if (fire_once_after_str
&& fire_every_str
) {
1915 ERR("--fire-once and --fire-every are mutually exclusive.");
1919 if (fire_once_after_str
) {
1920 unsigned long long threshold
;
1922 if (utils_parse_unsigned_long_long(
1923 fire_once_after_str
, &threshold
) != 0) {
1924 ERR("Failed to parse `%s` as an integer.",
1925 fire_once_after_str
);
1929 if (threshold
== 0) {
1930 ERR("Once after N policy threshold cannot be `0`.");
1934 policy
= lttng_firing_policy_once_after_n_create(threshold
);
1936 ERR("Failed to create policy once after `%s`.",
1937 fire_once_after_str
);
1942 if (fire_every_str
) {
1943 unsigned long long interval
;
1944 if (utils_parse_unsigned_long_long(fire_every_str
, &interval
) !=
1946 ERR("Failed to parse `%s` as an integer.",
1950 if (interval
== 0) {
1951 ERR("Every N policy interval cannot be `0`.");
1955 policy
= lttng_firing_policy_every_n_create(interval
);
1957 ERR("Failed to create policy every `%s`.",
1963 action
= lttng_action_snapshot_session_create();
1965 ERR("Failed to allocate snapshot session action.");
1969 action_status
= lttng_action_snapshot_session_set_session_name(
1970 action
, session_name_arg
);
1971 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
1972 ERR("Failed to set action snapshot session's session name to '%s'.",
1977 if (snapshot_name_arg
) {
1978 if (!snapshot_output
) {
1979 ERR("Can't provide a snapshot output name without a snapshot output destination.");
1983 ret
= lttng_snapshot_output_set_name(
1984 snapshot_name_arg
, snapshot_output
);
1986 ERR("Failed to set name of snapshot output.");
1994 if (!snapshot_output
) {
1995 ERR("Can't provide a snapshot output max size without a snapshot output destination.");
1999 ret
= utils_parse_size_suffix(max_size_arg
, &max_size
);
2001 ERR("Failed to parse `%s` as a size.", max_size_arg
);
2005 ret
= lttng_snapshot_output_set_size(max_size
, snapshot_output
);
2007 ERR("Failed to set snapshot output's max size to %" PRIu64
" bytes.",
2015 struct lttng_uri
*uris
;
2017 if (!strstr(url_arg
, "://")) {
2018 ERR("Failed to parse '%s' as an URL.", url_arg
);
2022 num_uris
= uri_parse_str_urls(url_arg
, NULL
, &uris
);
2024 ERR("Failed to parse '%s' as an URL.", url_arg
);
2028 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
2029 ret
= lttng_snapshot_output_set_local_path(
2030 uris
[0].dst
.path
, snapshot_output
);
2033 ERR("Failed to assign '%s' as a local destination.",
2038 ret
= lttng_snapshot_output_set_network_url(
2039 url_arg
, snapshot_output
);
2042 ERR("Failed to assign '%s' as a network URL.",
2050 ret
= lttng_snapshot_output_set_local_path(
2051 path_arg
, snapshot_output
);
2053 ERR("Failed to parse '%s' as a local path.", path_arg
);
2060 * Two argument form, network output with separate control and
2063 ret
= lttng_snapshot_output_set_network_urls(
2064 ctrl_url_arg
, data_url_arg
, snapshot_output
);
2066 ERR("Failed to parse `%s` and `%s` as control and data URLs.",
2067 ctrl_url_arg
, data_url_arg
);
2072 if (snapshot_output
) {
2073 action_status
= lttng_action_snapshot_session_set_output(
2074 action
, snapshot_output
);
2075 if (action_status
!= LTTNG_ACTION_STATUS_OK
) {
2076 ERR("Failed to set snapshot session action's output.");
2080 /* Ownership of `snapshot_output` has been transferred to the action. */
2081 snapshot_output
= NULL
;
2085 enum lttng_action_status status
;
2086 status
= lttng_action_snapshot_session_set_firing_policy(
2088 if (status
!= LTTNG_ACTION_STATUS_OK
) {
2089 ERR("Failed to set firing policy");
2097 lttng_action_destroy(action
);
2101 free(snapshot_name_arg
);
2106 free(snapshot_output
);
2108 lttng_firing_policy_destroy(policy
);
2109 argpar_state_destroy(state
);
2110 argpar_item_destroy(item
);
2114 struct action_descr
{
2116 struct lttng_action
*(*handler
) (int *argc
, const char ***argv
);
2120 struct action_descr action_descrs
[] = {
2121 { "notify", handle_action_notify
},
2122 { "start-session", handle_action_start_session
},
2123 { "stop-session", handle_action_stop_session
},
2124 { "rotate-session", handle_action_rotate_session
},
2125 { "snapshot-session", handle_action_snapshot_session
},
2129 struct lttng_action
*parse_action(int *argc
, const char ***argv
)
2132 struct lttng_action
*action
;
2133 const char *action_name
;
2134 const struct action_descr
*descr
= NULL
;
2137 ERR("Missing action name.");
2141 action_name
= (*argv
)[0];
2146 for (i
= 0; i
< ARRAY_SIZE(action_descrs
); i
++) {
2147 if (strcmp(action_name
, action_descrs
[i
].name
) == 0) {
2148 descr
= &action_descrs
[i
];
2154 ERR("Unknown action name: %s", action_name
);
2158 action
= descr
->handler(argc
, argv
);
2160 /* The handler has already printed an error message. */
2172 struct argpar_opt_descr add_trigger_options
[] = {
2173 { OPT_HELP
, 'h', "help", false },
2174 { OPT_LIST_OPTIONS
, '\0', "list-options", false },
2175 { OPT_CONDITION
, '\0', "condition", false },
2176 { OPT_ACTION
, '\0', "action", false },
2177 { OPT_ID
, '\0', "id", true },
2178 { OPT_USER_ID
, '\0', "user-id", true },
2179 ARGPAR_OPT_DESCR_SENTINEL
,
2183 void lttng_actions_destructor(void *p
)
2185 struct lttng_action
*action
= p
;
2187 lttng_action_destroy(action
);
2190 int cmd_add_trigger(int argc
, const char **argv
)
2193 int my_argc
= argc
- 1;
2194 const char **my_argv
= argv
+ 1;
2195 struct lttng_condition
*condition
= NULL
;
2196 struct lttng_dynamic_pointer_array actions
;
2197 struct argpar_state
*argpar_state
= NULL
;
2198 struct argpar_item
*argpar_item
= NULL
;
2199 struct lttng_action
*action_group
= NULL
;
2200 struct lttng_action
*action
= NULL
;
2201 struct lttng_trigger
*trigger
= NULL
;
2205 char *user_id
= NULL
;
2207 lttng_dynamic_pointer_array_init(&actions
, lttng_actions_destructor
);
2210 enum argpar_state_parse_next_status status
;
2211 const struct argpar_item_opt
*item_opt
;
2214 argpar_state_destroy(argpar_state
);
2215 argpar_state
= argpar_state_create(my_argc
, my_argv
,
2216 add_trigger_options
);
2217 if (!argpar_state
) {
2218 ERR("Failed to create argpar state.");
2222 ARGPAR_ITEM_DESTROY_AND_RESET(argpar_item
);
2223 status
= argpar_state_parse_next(argpar_state
, &argpar_item
, &error
);
2224 if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR
) {
2227 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT
) {
2230 } else if (status
== ARGPAR_STATE_PARSE_NEXT_STATUS_END
) {
2234 assert(status
== ARGPAR_STATE_PARSE_NEXT_STATUS_OK
);
2236 if (argpar_item
->type
== ARGPAR_ITEM_TYPE_NON_OPT
) {
2237 const struct argpar_item_non_opt
*item_non_opt
=
2238 (const struct argpar_item_non_opt
*)
2241 ERR("Unexpected argument `%s`.", item_non_opt
->arg
);
2245 item_opt
= (const struct argpar_item_opt
*) argpar_item
;
2247 ingested_args
= argpar_state_get_ingested_orig_args(
2250 my_argc
-= ingested_args
;
2251 my_argv
+= ingested_args
;
2253 switch (item_opt
->descr
->id
) {
2258 case OPT_LIST_OPTIONS
:
2259 list_cmd_options_argpar(stdout
, add_trigger_options
);
2265 ERR("A --condition was already given.");
2269 condition
= parse_condition(&my_argc
, &my_argv
);
2272 * An error message was already printed by
2282 action
= parse_action(&my_argc
, &my_argv
);
2285 * An error message was already printed by
2291 ret
= lttng_dynamic_pointer_array_add_pointer(
2294 ERR("Failed to add pointer to pointer array.");
2298 /* Ownership of the action was transferred to the group. */
2305 if (!assign_string(&id
, item_opt
->arg
, "--id")) {
2313 if (!assign_string(&user_id
, item_opt
->arg
,
2326 ERR("Missing --condition.");
2330 if (lttng_dynamic_pointer_array_get_count(&actions
) == 0) {
2331 ERR("Need at least one --action.");
2335 action_group
= lttng_action_group_create();
2336 if (!action_group
) {
2340 for (i
= 0; i
< lttng_dynamic_pointer_array_get_count(&actions
); i
++) {
2341 enum lttng_action_status status
;
2343 action
= lttng_dynamic_pointer_array_steal_pointer(&actions
, i
);
2345 status
= lttng_action_group_add_action(action_group
, action
);
2346 if (status
!= LTTNG_ACTION_STATUS_OK
) {
2351 * The `lttng_action_group_add_action()` takes a reference to
2352 * the action. We can destroy ours.
2354 lttng_action_destroy(action
);
2358 trigger
= lttng_trigger_create(condition
, action_group
);
2364 enum lttng_trigger_status trigger_status
=
2365 lttng_trigger_set_name(trigger
, id
);
2367 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
2368 ERR("Failed to set trigger id.");
2374 enum lttng_trigger_status trigger_status
;
2379 uid
= strtol(user_id
, &end
, 10);
2380 if (end
== user_id
|| *end
!= '\0' || errno
!= 0) {
2381 ERR("Failed to parse `%s` as a user id.", user_id
);
2384 trigger_status
= lttng_trigger_set_owner_uid(trigger
, uid
);
2385 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
2386 ERR("Failed to set trigger's user identity.");
2391 ret
= lttng_register_trigger(trigger
);
2393 ERR("Failed to register trigger: %s.", lttng_strerror(ret
));
2397 MSG("Trigger registered successfully.");
2405 argpar_state_destroy(argpar_state
);
2406 argpar_item_destroy(argpar_item
);
2407 lttng_dynamic_pointer_array_reset(&actions
);
2408 lttng_condition_destroy(condition
);
2409 lttng_action_destroy(action_group
);
2410 lttng_action_destroy(action
);
2411 lttng_trigger_destroy(trigger
);