092f3c8e2dd3991d03b97ad498a1f5909af3029b
[lttng-tools.git] / src / bin / lttng / commands / add_trigger.c
1 /*
2 * Copyright (C) 2021 Simon Marchi <simon.marchi@efficios.com>
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 */
7
8 #include <ctype.h>
9 #include <stdio.h>
10
11 #include "../command.h"
12 #include "../loglevel.h"
13 #include "../uprobe.h"
14
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"
25
26 #if (LTTNG_SYMBOL_NAME_LEN == 256)
27 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
28 #endif
29
30 #ifdef LTTNG_EMBED_HELP
31 static const char help_msg[] =
32 #include <lttng-add-trigger.1.h>
33 ;
34 #endif
35
36 enum {
37 OPT_HELP,
38 OPT_LIST_OPTIONS,
39
40 OPT_CONDITION,
41 OPT_ACTION,
42 OPT_ID,
43 OPT_FIRE_ONCE_AFTER,
44 OPT_FIRE_EVERY,
45 OPT_USER_ID,
46
47 OPT_ALL,
48 OPT_FILTER,
49 OPT_EXCLUDE,
50 OPT_LOGLEVEL,
51 OPT_LOGLEVEL_ONLY,
52
53 OPT_USERSPACE,
54 OPT_KERNEL,
55 OPT_LOG4J,
56 OPT_JUL,
57 OPT_PYTHON,
58
59 OPT_FUNCTION,
60 OPT_PROBE,
61 OPT_USERSPACE_PROBE,
62 OPT_SYSCALL,
63 OPT_TRACEPOINT,
64
65 OPT_NAME,
66 OPT_MAX_SIZE,
67 OPT_DATA_URL,
68 OPT_CTRL_URL,
69 OPT_URL,
70 OPT_PATH,
71
72 OPT_CAPTURE,
73 };
74
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 },
81
82 /* Domains */
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 },
88
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" },
95
96 /* Capture descriptor */
97 { OPT_CAPTURE, '\0', "capture", true },
98
99 ARGPAR_OPT_DESCR_SENTINEL
100 };
101
102 static
103 bool assign_domain_type(enum lttng_domain_type *dest,
104 enum lttng_domain_type src)
105 {
106 bool ret;
107
108 if (*dest == LTTNG_DOMAIN_NONE || *dest == src) {
109 *dest = src;
110 ret = true;
111 } else {
112 ERR("Multiple domains specified.");
113 ret = false;
114 }
115
116 return ret;
117 }
118
119 static
120 bool assign_event_rule_type(enum lttng_event_rule_type *dest,
121 enum lttng_event_rule_type src)
122 {
123 bool ret;
124
125 if (*dest == LTTNG_EVENT_RULE_TYPE_UNKNOWN || *dest == src) {
126 *dest = src;
127 ret = true;
128 } else {
129 ERR("Multiple event types specified.");
130 ret = false;
131 }
132
133 return ret;
134 }
135
136 static
137 bool assign_string(char **dest, const char *src, const char *opt_name)
138 {
139 bool ret;
140
141 if (*dest) {
142 ERR("Duplicate '%s' given.", opt_name);
143 goto error;
144 }
145
146 *dest = strdup(src);
147 if (!*dest) {
148 PERROR("Failed to allocate string '%s'.", opt_name);
149 goto error;
150 }
151
152 ret = true;
153 goto end;
154
155 error:
156 ret = false;
157
158 end:
159 return ret;
160 }
161
162 /* This is defined in enable_events.c. */
163 LTTNG_HIDDEN
164 int create_exclusion_list_and_validate(const char *event_name,
165 const char *exclusions_arg,
166 char ***exclusion_list);
167
168 /*
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.
171 */
172 static
173 int parse_loglevel_string(const char *str, enum lttng_domain_type domain_type)
174 {
175 switch (domain_type) {
176 case LTTNG_DOMAIN_UST:
177 {
178 enum lttng_loglevel loglevel;
179 const int ret = loglevel_name_to_value(str, &loglevel);
180
181 return ret == -1 ? ret : (int) loglevel;
182 }
183 case LTTNG_DOMAIN_LOG4J:
184 {
185 enum lttng_loglevel_log4j loglevel;
186 const int ret = loglevel_log4j_name_to_value(str, &loglevel);
187
188 return ret == -1 ? ret : (int) loglevel;
189 }
190 case LTTNG_DOMAIN_JUL:
191 {
192 enum lttng_loglevel_jul loglevel;
193 const int ret = loglevel_jul_name_to_value(str, &loglevel);
194
195 return ret == -1 ? ret : (int) loglevel;
196 }
197 case LTTNG_DOMAIN_PYTHON:
198 {
199 enum lttng_loglevel_python loglevel;
200 const int ret = loglevel_python_name_to_value(str, &loglevel);
201
202 return ret == -1 ? ret : (int) loglevel;
203 }
204 default:
205 /* Invalid domain type. */
206 abort();
207 }
208 }
209
210 static int parse_kernel_probe_opts(const char *source,
211 struct lttng_kernel_probe_location **location)
212 {
213 int ret = 0;
214 int match;
215 char s_hex[19];
216 char name[LTTNG_SYMBOL_NAME_LEN];
217 char *symbol_name = NULL;
218 uint64_t offset;
219
220 /* Check for symbol+offset. */
221 match = sscanf(source,
222 "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
223 "[^'+']+%18s",
224 name, s_hex);
225 if (match == 2) {
226 if (*s_hex == '\0') {
227 ERR("Kernel probe symbol offset is missing.");
228 goto error;
229 }
230
231 symbol_name = strndup(name, LTTNG_SYMBOL_NAME_LEN);
232 if (!symbol_name) {
233 PERROR("Failed to copy kernel probe location symbol name.");
234 goto error;
235 }
236 offset = strtoul(s_hex, NULL, 0);
237
238 *location = lttng_kernel_probe_location_symbol_create(
239 symbol_name, offset);
240 if (!*location) {
241 ERR("Failed to create symbol kernel probe location.");
242 goto error;
243 }
244
245 goto end;
246 }
247
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
252 "s",
253 name);
254 if (match == 1) {
255 symbol_name = strndup(name, LTTNG_SYMBOL_NAME_LEN);
256 if (!symbol_name) {
257 ERR("Failed to copy kernel probe location symbol name.");
258 goto error;
259 }
260
261 *location = lttng_kernel_probe_location_symbol_create(
262 symbol_name, 0);
263 if (!*location) {
264 ERR("Failed to create symbol kernel probe location.");
265 goto error;
266 }
267
268 goto end;
269 }
270 }
271
272 /* Check for address. */
273 match = sscanf(source, "%18s", s_hex);
274 if (match > 0) {
275 uint64_t address;
276
277 if (*s_hex == '\0') {
278 ERR("Invalid kernel probe location address.");
279 goto error;
280 }
281
282 address = strtoul(s_hex, NULL, 0);
283 *location = lttng_kernel_probe_location_address_create(address);
284 if (!*location) {
285 ERR("Failed to create symbol kernel probe location.");
286 goto error;
287 }
288
289 goto end;
290 }
291
292 error:
293 /* No match */
294 ret = -1;
295 *location = NULL;
296
297 end:
298 free(symbol_name);
299 return ret;
300 }
301
302 static
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)
306 {
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 =
311 load_expr_op->type;
312
313 switch (load_expr_child_type) {
314 case IR_LOAD_EXPRESSION_GET_PAYLOAD_ROOT:
315 case IR_LOAD_EXPRESSION_GET_CONTEXT_ROOT:
316 {
317 const char *field_name;
318
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;
323 assert(field_name);
324
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);
328 if (!event_expr) {
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",
332 field_name);
333 goto error;
334 }
335
336 break;
337 }
338 case IR_LOAD_EXPRESSION_GET_APP_CONTEXT_ROOT:
339 {
340 const char *colon;
341 const char *type_name;
342 const char *field_name;
343
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;
348 assert(field_name);
349
350 /*
351 * The field name needs to be of the form PROVIDER:TYPE. We
352 * split it here.
353 */
354 colon = strchr(field_name, ':');
355 if (!colon) {
356 ERR("Invalid app-specific context field name: missing colon in `%s`.",
357 field_name);
358 goto error;
359 }
360
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`.",
364 field_name);
365 goto error;
366 }
367
368 provider_name = strndup(field_name, colon - field_name);
369 if (!provider_name) {
370 PERROR("Failed to allocate field name string");
371 goto error;
372 }
373
374 event_expr = lttng_event_expr_app_specific_context_field_create(
375 provider_name, type_name);
376 if (!event_expr) {
377 ERR("Failed to create app-specific context field event expression: provider name = `%s`, type name = `%s`",
378 provider_name, type_name);
379 goto error;
380 }
381
382 break;
383 }
384 default:
385 ERR("%s: unexpected load expr type %d.", __func__,
386 load_expr_op->type);
387 abort();
388 }
389
390 load_expr_op = load_expr_op->next;
391
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;
396
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.");
400 goto error;
401 }
402
403 event_expr = index_event_expr;
404 load_expr_op = load_expr_op->next;
405 }
406
407 switch (load_expr_op->type) {
408 case IR_LOAD_EXPRESSION_LOAD_FIELD:
409 /*
410 * This is what we expect, IR_LOAD_EXPRESSION_LOAD_FIELD is
411 * always found at the end of the chain.
412 */
413 break;
414 case IR_LOAD_EXPRESSION_GET_SYMBOL:
415 ERR("While parsing expression `%s`: Capturing subfields is not supported.",
416 capture_str);
417 goto error;
418
419 default:
420 ERR("%s: unexpected load expression operator %s.", __func__,
421 ir_load_expression_type_str(load_expr_op->type));
422 abort();
423 }
424
425 goto end;
426
427 error:
428 lttng_event_expr_destroy(event_expr);
429 event_expr = NULL;
430
431 end:
432 free(provider_name);
433
434 return event_expr;
435 }
436
437 static
438 struct lttng_event_expr *ir_op_load_to_event_expr(
439 const struct ir_op *ir, const char *capture_str)
440 {
441 struct lttng_event_expr *event_expr = NULL;
442
443 assert(ir->op == IR_OP_LOAD);
444
445 switch (ir->data_type) {
446 case IR_DATA_EXPRESSION:
447 {
448 const struct ir_load_expression *ir_load_expr =
449 ir->u.load.u.expression;
450
451 event_expr = ir_op_load_expr_to_event_expr(
452 ir_load_expr, capture_str);
453 break;
454 }
455 default:
456 ERR("%s: unexpected data type: %s.", __func__,
457 ir_data_type_str(ir->data_type));
458 abort();
459 }
460
461 return event_expr;
462 }
463
464 static
465 const char *ir_operator_type_human_str(enum ir_op_type op)
466 {
467 const char *name;
468
469 switch (op) {
470 case IR_OP_BINARY:
471 name = "Binary";
472 break;
473 case IR_OP_UNARY:
474 name = "Unary";
475 break;
476 case IR_OP_LOGICAL:
477 name = "Logical";
478 break;
479 default:
480 abort();
481 }
482
483 return name;
484 }
485
486 static
487 struct lttng_event_expr *ir_op_root_to_event_expr(const struct ir_op *ir,
488 const char *capture_str)
489 {
490 struct lttng_event_expr *event_expr = NULL;
491
492 assert(ir->op == IR_OP_ROOT);
493 ir = ir->u.root.child;
494
495 switch (ir->op) {
496 case IR_OP_LOAD:
497 event_expr = ir_op_load_to_event_expr(ir, capture_str);
498 break;
499 case IR_OP_BINARY:
500 case IR_OP_UNARY:
501 case IR_OP_LOGICAL:
502 ERR("While parsing expression `%s`: %s operators are not allowed in capture expressions.",
503 capture_str,
504 ir_operator_type_human_str(ir->op));
505 break;
506 default:
507 ERR("%s: unexpected IR op type: %s.", __func__,
508 ir_op_type_str(ir->op));
509 abort();
510 }
511
512 return event_expr;
513 }
514
515 static
516 void destroy_event_expr(void *ptr)
517 {
518 lttng_event_expr_destroy(ptr);
519 }
520
521 struct parse_event_rule_res {
522 /* Owned by this. */
523 struct lttng_event_rule *er;
524
525 /* Array of `struct lttng_event_expr *` */
526 struct lttng_dynamic_pointer_array capture_descriptors;
527 };
528
529 static
530 struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
531 {
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;
537 char *error = 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
545 /* Was the -a/--all flag provided? */
546 bool all_events = false;
547
548 /* Tracepoint name (non-option argument). */
549 const char *tracepoint_name = NULL;
550
551 /* Holds the argument of --probe / --userspace-probe. */
552 char *source = NULL;
553
554 /* Filter. */
555 char *filter = NULL;
556
557 /* Exclude. */
558 char *exclude = NULL;
559 char **exclusion_list = NULL;
560
561 /* Log level. */
562 char *loglevel_str = NULL;
563 bool loglevel_only = false;
564
565 lttng_dynamic_pointer_array_init(&res.capture_descriptors,
566 destroy_event_expr);
567 state = argpar_state_create(*argc, *argv, event_rule_opt_descrs);
568 if (!state) {
569 ERR("Failed to allocate an argpar state.");
570 goto error;
571 }
572
573 while (true) {
574 enum argpar_state_parse_next_status status;
575
576 ARGPAR_ITEM_DESTROY_AND_RESET(item);
577 status = argpar_state_parse_next(state, &item, &error);
578 if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR) {
579 ERR("%s", error);
580 goto error;
581 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT) {
582 /* Just stop parsing here. */
583 break;
584 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_END) {
585 break;
586 }
587
588 assert(status == ARGPAR_STATE_PARSE_NEXT_STATUS_OK);
589
590 if (item->type == ARGPAR_ITEM_TYPE_OPT) {
591 const struct argpar_item_opt *item_opt =
592 (const struct argpar_item_opt *) item;
593
594 switch (item_opt->descr->id) {
595 /* Domains. */
596 case OPT_USERSPACE:
597 if (!assign_domain_type(&domain_type, LTTNG_DOMAIN_UST)) {
598 goto error;
599 }
600
601 break;
602 case OPT_KERNEL:
603 if (!assign_domain_type(&domain_type, LTTNG_DOMAIN_KERNEL)) {
604 goto error;
605 }
606
607 break;
608 case OPT_LOG4J:
609 if (!assign_domain_type(&domain_type, LTTNG_DOMAIN_LOG4J)) {
610 goto error;
611 }
612
613 break;
614 case OPT_JUL:
615 if (!assign_domain_type(&domain_type, LTTNG_DOMAIN_JUL)) {
616 goto error;
617 }
618
619 break;
620 case OPT_PYTHON:
621 if (!assign_domain_type(&domain_type, LTTNG_DOMAIN_PYTHON)) {
622 goto error;
623 }
624
625 break;
626
627 /* Event rule types */
628 case OPT_FUNCTION:
629 if (!assign_event_rule_type(&event_rule_type,
630 LTTNG_EVENT_RULE_TYPE_KRETPROBE)) {
631 goto error;
632 }
633
634 break;
635 case OPT_PROBE:
636 if (!assign_event_rule_type(&event_rule_type,
637 LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE)) {
638 goto error;
639 }
640
641 if (!assign_string(&source, item_opt->arg, "source")) {
642 goto error;
643 }
644
645 break;
646 case OPT_USERSPACE_PROBE:
647 if (!assign_event_rule_type(&event_rule_type,
648 LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE)) {
649 goto error;
650 }
651
652 if (!assign_string(&source, item_opt->arg, "source")) {
653 goto error;
654 }
655
656 break;
657 case OPT_SYSCALL:
658 if (!assign_event_rule_type(&event_rule_type,
659 LTTNG_EVENT_RULE_TYPE_SYSCALL)) {
660 goto error;
661 }
662
663 break;
664 case OPT_TRACEPOINT:
665 if (!assign_event_rule_type(&event_rule_type,
666 LTTNG_EVENT_RULE_TYPE_TRACEPOINT)) {
667 goto error;
668 }
669
670 break;
671 case OPT_ALL:
672 all_events = true;
673 break;
674 case OPT_FILTER:
675 if (!assign_string(&filter, item_opt->arg,
676 "--filter/-f")) {
677 goto error;
678 }
679
680 break;
681 case OPT_EXCLUDE:
682 if (!assign_string(&exclude, item_opt->arg,
683 "--exclude/-x")) {
684 goto error;
685 }
686
687 break;
688 case OPT_LOGLEVEL:
689 case OPT_LOGLEVEL_ONLY:
690 if (!assign_string(&loglevel_str, item_opt->arg,
691 "--loglevel/--loglevel-only")) {
692 goto error;
693 }
694
695 loglevel_only = item_opt->descr->id ==
696 OPT_LOGLEVEL_ONLY;
697 break;
698 case OPT_CAPTURE:
699 {
700 int ret;
701 const char *capture_str = item_opt->arg;
702
703 ret = filter_parser_ctx_create_from_filter_expression(
704 capture_str, &parser_ctx);
705 if (ret) {
706 ERR("Failed to parse capture expression `%s`.",
707 capture_str);
708 goto error;
709 }
710
711 event_expr = ir_op_root_to_event_expr(
712 parser_ctx->ir_root,
713 capture_str);
714 if (!event_expr) {
715 /*
716 * ir_op_root_to_event_expr has printed
717 * an error message.
718 */
719 goto error;
720 }
721
722 ret = lttng_dynamic_pointer_array_add_pointer(
723 &res.capture_descriptors,
724 event_expr);
725 if (ret) {
726 goto error;
727 }
728
729 /*
730 * The ownership of event expression was
731 * transferred to the dynamic array.
732 */
733 event_expr = NULL;
734
735 break;
736 }
737 default:
738 abort();
739 }
740 } else {
741 const struct argpar_item_non_opt *item_non_opt =
742 (const struct argpar_item_non_opt *)
743 item;
744
745 /*
746 * Don't accept two non-option arguments/tracepoint
747 * names.
748 */
749 if (tracepoint_name) {
750 ERR("Unexpected argument '%s'",
751 item_non_opt->arg);
752 goto error;
753 }
754
755 tracepoint_name = item_non_opt->arg;
756 }
757 }
758
759 if (event_rule_type == LTTNG_EVENT_RULE_TYPE_UNKNOWN) {
760 event_rule_type = LTTNG_EVENT_RULE_TYPE_TRACEPOINT;
761 }
762
763 /*
764 * Option -a is applicable to event rules of type tracepoint and
765 * syscall, and it is equivalent to using "*" as the tracepoint name.
766 */
767 if (all_events) {
768 switch (event_rule_type) {
769 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
770 case LTTNG_EVENT_RULE_TYPE_SYSCALL:
771 break;
772 default:
773 ERR("Can't use -a/--all with %s event rules.",
774 lttng_event_rule_type_str(event_rule_type));
775 goto error;
776 }
777
778 if (tracepoint_name) {
779 ERR("Can't provide a tracepoint name with -a/--all.");
780 goto error;
781 }
782
783 /* In which case, it's equivalent to tracepoint name "*". */
784 tracepoint_name = "*";
785 }
786
787 /*
788 * A tracepoint name (or -a, for the event rule types that accept it)
789 * is required.
790 */
791 if (!tracepoint_name) {
792 ERR("Need to provide either a tracepoint name or -a/--all.");
793 goto error;
794 }
795
796 /*
797 * We don't support multiple tracepoint names for now.
798 */
799 if (strchr(tracepoint_name, ',')) {
800 ERR("Comma separated tracepoint names are not supported.");
801 goto error;
802 }
803
804 /*
805 * Update *argc and *argv so our caller can keep parsing what follows.
806 */
807 consumed_args = argpar_state_get_ingested_orig_args(state);
808 assert(consumed_args >= 0);
809 *argc -= consumed_args;
810 *argv += consumed_args;
811
812 /* Need to specify a domain. */
813 if (domain_type == LTTNG_DOMAIN_NONE) {
814 ERR("Please specify a domain (--kernel/--userspace/--jul/--log4j/--python).");
815 goto error;
816 }
817
818 /* Validate event rule type against domain. */
819 switch (event_rule_type) {
820 case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE:
821 case LTTNG_EVENT_RULE_TYPE_KRETPROBE:
822 case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE:
823 case LTTNG_EVENT_RULE_TYPE_SYSCALL:
824 if (domain_type != LTTNG_DOMAIN_KERNEL) {
825 ERR("Event type not available for user-space tracing.");
826 goto error;
827 }
828 break;
829
830 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
831 break;
832
833 default:
834 abort();
835 }
836
837 /*
838 * Adding a filter to a probe, function or userspace-probe would be
839 * denied by the kernel tracer as it's not supported at the moment. We
840 * do an early check here to warn the user.
841 */
842 if (filter && domain_type == LTTNG_DOMAIN_KERNEL) {
843 switch (event_rule_type) {
844 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
845 case LTTNG_EVENT_RULE_TYPE_SYSCALL:
846 break;
847 default:
848 ERR("Filter expressions are not supported for %s event rules.",
849 lttng_event_rule_type_str(event_rule_type));
850 goto error;
851 }
852 }
853
854 /* If --exclude/-x was passed, split it into an exclusion list. */
855 if (exclude) {
856 if (domain_type != LTTNG_DOMAIN_UST) {
857 ERR("Event name exclusions are not yet implemented for %s event rules.",
858 get_domain_str(domain_type));
859 goto error;
860 }
861
862
863 if (create_exclusion_list_and_validate(tracepoint_name, exclude,
864 &exclusion_list) != 0) {
865 ERR("Failed to create exclusion list.");
866 goto error;
867 }
868 }
869
870 if (loglevel_str && event_rule_type != LTTNG_EVENT_RULE_TYPE_TRACEPOINT) {
871 ERR("Log levels are only applicable to tracepoint event rules.");
872 goto error;
873 }
874
875 /* Finally, create the event rule object. */
876 switch (event_rule_type) {
877 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
878 {
879 enum lttng_event_rule_status event_rule_status;
880
881 res.er = lttng_event_rule_tracepoint_create(domain_type);
882 if (!res.er) {
883 ERR("Failed to create tracepoint event rule.");
884 goto error;
885 }
886
887 /* Set pattern. */
888 event_rule_status = lttng_event_rule_tracepoint_set_pattern(
889 res.er, tracepoint_name);
890 if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
891 ERR("Failed to set tracepoint event rule's pattern to '%s'.",
892 tracepoint_name);
893 goto error;
894 }
895
896 /* Set filter. */
897 if (filter) {
898 event_rule_status = lttng_event_rule_tracepoint_set_filter(
899 res.er, filter);
900 if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
901 ERR("Failed to set tracepoint event rule's filter to '%s'.",
902 filter);
903 goto error;
904 }
905 }
906
907 /* Set exclusion list. */
908 if (exclusion_list) {
909 int n;
910
911 for (n = 0; exclusion_list[n]; n++) {
912 event_rule_status = lttng_event_rule_tracepoint_add_exclusion(
913 res.er,
914 exclusion_list[n]);
915 if (event_rule_status !=
916 LTTNG_EVENT_RULE_STATUS_OK) {
917 ERR("Failed to set tracepoint exclusion list element '%s'",
918 exclusion_list[n]);
919 goto error;
920 }
921 }
922 }
923
924 if (loglevel_str) {
925 int loglevel;
926
927 if (domain_type == LTTNG_DOMAIN_KERNEL) {
928 ERR("Log levels are not supported by the kernel tracer.");
929 goto error;
930 }
931
932 loglevel = parse_loglevel_string(
933 loglevel_str, domain_type);
934 if (loglevel < 0) {
935 ERR("Failed to parse `%s` as a log level.",
936 loglevel_str);
937 goto error;
938 }
939
940 if (loglevel_only) {
941 event_rule_status = lttng_event_rule_tracepoint_set_log_level(
942 res.er,
943 loglevel);
944 } else {
945 event_rule_status = lttng_event_rule_tracepoint_set_log_level_range_lower_bound(
946 res.er,
947 loglevel);
948 }
949
950 if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
951 ERR("Failed to set log level on event fule.");
952 goto error;
953 }
954 }
955
956 break;
957 }
958 case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE:
959 {
960 int ret;
961 enum lttng_event_rule_status event_rule_status;
962
963
964 ret = parse_kernel_probe_opts(source, &kernel_probe_location);
965 if (ret) {
966 ERR("Failed to parse kernel probe location.");
967 goto error;
968 }
969
970 assert(kernel_probe_location);
971 res.er = lttng_event_rule_kernel_probe_create(kernel_probe_location);
972 if (!res.er) {
973 ERR("Failed to create kprobe event rule.");
974 goto error;
975 }
976
977 event_rule_status = lttng_event_rule_kernel_probe_set_event_name(res.er, tracepoint_name);
978 if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
979 ERR("Failed to set kprobe event rule's name to '%s'.", tracepoint_name);
980 goto error;
981 }
982
983 break;
984 }
985 case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE:
986 {
987 int ret;
988 enum lttng_event_rule_status event_rule_status;
989
990 ret = parse_userspace_probe_opts(
991 source, &userspace_probe_location);
992 if (ret) {
993 ERR("Failed to parse user space probe location.");
994 goto error;
995 }
996
997 res.er = lttng_event_rule_userspace_probe_create();
998 if (!res.er) {
999 ERR("Failed to create userspace probe event rule.");
1000 goto error;
1001 }
1002
1003 event_rule_status = lttng_event_rule_userspace_probe_set_location(
1004 res.er, userspace_probe_location);
1005 if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
1006 ERR("Failed to set user space probe event rule's location.");
1007 goto error;
1008 }
1009
1010 event_rule_status =
1011 lttng_event_rule_userspace_probe_set_event_name(
1012 res.er, tracepoint_name);
1013 if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
1014 ERR("Failed to set user space probe event rule's name to '%s'.",
1015 tracepoint_name);
1016 goto error;
1017 }
1018
1019 break;
1020 }
1021 case LTTNG_EVENT_RULE_TYPE_SYSCALL:
1022 {
1023 enum lttng_event_rule_status event_rule_status;
1024
1025 res.er = lttng_event_rule_syscall_create();
1026 if (!res.er) {
1027 ERR("Failed to create syscall event rule.");
1028 goto error;
1029 }
1030
1031 event_rule_status = lttng_event_rule_syscall_set_pattern(
1032 res.er, tracepoint_name);
1033 if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
1034 ERR("Failed to set syscall event rule's pattern to '%s'.",
1035 tracepoint_name);
1036 goto error;
1037 }
1038
1039 if (filter) {
1040 event_rule_status = lttng_event_rule_syscall_set_filter(
1041 res.er, filter);
1042 if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
1043 ERR("Failed to set syscall event rule's filter to '%s'.",
1044 filter);
1045 goto error;
1046 }
1047 }
1048
1049 break;
1050 }
1051 default:
1052 abort();
1053 goto error;
1054 }
1055
1056 goto end;
1057
1058 error:
1059 lttng_event_rule_destroy(res.er);
1060 res.er = NULL;
1061 lttng_dynamic_pointer_array_reset(&res.capture_descriptors);
1062
1063 end:
1064 if (parser_ctx) {
1065 filter_parser_ctx_free(parser_ctx);
1066 }
1067
1068 lttng_event_expr_destroy(event_expr);
1069 argpar_item_destroy(item);
1070 free(error);
1071 argpar_state_destroy(state);
1072 free(filter);
1073 free(exclude);
1074 free(loglevel_str);
1075 free(source);
1076 strutils_free_null_terminated_array_of_strings(exclusion_list);
1077 lttng_kernel_probe_location_destroy(kernel_probe_location);
1078 lttng_userspace_probe_location_destroy(userspace_probe_location);
1079 return res;
1080 }
1081
1082 static
1083 struct lttng_condition *handle_condition_event(int *argc, const char ***argv)
1084 {
1085 struct parse_event_rule_res res;
1086 struct lttng_condition *c;
1087 size_t i;
1088
1089 res = parse_event_rule(argc, argv);
1090 if (!res.er) {
1091 c = NULL;
1092 goto error;
1093 }
1094
1095 c = lttng_condition_on_event_create(res.er);
1096 lttng_event_rule_destroy(res.er);
1097 res.er = NULL;
1098 if (!c) {
1099 goto error;
1100 }
1101
1102 for (i = 0; i < lttng_dynamic_pointer_array_get_count(&res.capture_descriptors);
1103 i++) {
1104 enum lttng_condition_status status;
1105 struct lttng_event_expr **expr =
1106 lttng_dynamic_array_get_element(
1107 &res.capture_descriptors.array, i);
1108
1109 assert(expr);
1110 assert(*expr);
1111 status = lttng_condition_on_event_append_capture_descriptor(
1112 c, *expr);
1113 if (status != LTTNG_CONDITION_STATUS_OK) {
1114 if (status == LTTNG_CONDITION_STATUS_UNSUPPORTED) {
1115 ERR("The capture feature is unsupported by the event-rule condition type");
1116 }
1117
1118 goto error;
1119 }
1120
1121 /* Ownership of event expression moved to `c` */
1122 *expr = NULL;
1123 }
1124
1125 goto end;
1126
1127 error:
1128 lttng_condition_destroy(c);
1129 c = NULL;
1130
1131 end:
1132 lttng_dynamic_pointer_array_reset(&res.capture_descriptors);
1133 lttng_event_rule_destroy(res.er);
1134 return c;
1135 }
1136
1137 static
1138 struct lttng_condition *handle_condition_session_consumed_size(int *argc, const char ***argv)
1139 {
1140 struct lttng_condition *cond = NULL;
1141 struct argpar_state *state = NULL;
1142 struct argpar_item *item = NULL;
1143 const char *threshold_arg = NULL;
1144 const char *session_name_arg = NULL;
1145 uint64_t threshold;
1146 char *error = NULL;
1147 enum lttng_condition_status condition_status;
1148
1149 state = argpar_state_create(*argc, *argv, event_rule_opt_descrs);
1150 if (!state) {
1151 ERR("Failed to allocate an argpar state.");
1152 goto error;
1153 }
1154
1155 while (true) {
1156 enum argpar_state_parse_next_status status;
1157
1158 ARGPAR_ITEM_DESTROY_AND_RESET(item);
1159 status = argpar_state_parse_next(state, &item, &error);
1160 if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR) {
1161 ERR("%s", error);
1162 goto error;
1163 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT) {
1164 /* Just stop parsing here. */
1165 break;
1166 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_END) {
1167 break;
1168 }
1169
1170 assert(status == ARGPAR_STATE_PARSE_NEXT_STATUS_OK);
1171
1172 if (item->type == ARGPAR_ITEM_TYPE_OPT) {
1173 const struct argpar_item_opt *item_opt =
1174 (const struct argpar_item_opt *) item;
1175
1176 switch (item_opt->descr->id) {
1177 default:
1178 abort();
1179 }
1180 } else {
1181 const struct argpar_item_non_opt *item_non_opt;
1182
1183 assert(item->type == ARGPAR_ITEM_TYPE_NON_OPT);
1184
1185 item_non_opt = (const struct argpar_item_non_opt *) item;
1186
1187 switch (item_non_opt->non_opt_index) {
1188 case 0:
1189 session_name_arg = item_non_opt->arg;
1190 break;
1191 case 1:
1192 threshold_arg = item_non_opt->arg;
1193 break;
1194 default:
1195 ERR("Unexpected argument `%s`.",
1196 item_non_opt->arg);
1197 goto error;
1198 }
1199 }
1200 }
1201
1202 *argc -= argpar_state_get_ingested_orig_args(state);
1203 *argv += argpar_state_get_ingested_orig_args(state);
1204
1205 if (!session_name_arg) {
1206 ERR("Missing session name argument.");
1207 goto error;
1208 }
1209
1210 if (!threshold_arg) {
1211 ERR("Missing threshold argument.");
1212 goto error;
1213 }
1214
1215 if (utils_parse_size_suffix(threshold_arg, &threshold) != 0) {
1216 ERR("Failed to parse `%s` as a size.", threshold_arg);
1217 goto error;
1218 }
1219
1220 cond = lttng_condition_session_consumed_size_create();
1221 if (!cond) {
1222 ERR("Failed to allocate a session consumed size condition.");
1223 goto error;
1224 }
1225
1226 condition_status = lttng_condition_session_consumed_size_set_session_name(
1227 cond, session_name_arg);
1228 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
1229 ERR("Failed to set session consumed size condition's session name to '%s'.",
1230 session_name_arg);
1231 goto error;
1232 }
1233
1234 condition_status = lttng_condition_session_consumed_size_set_threshold(
1235 cond, threshold);
1236 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
1237 ERR("Failed to set session consumed size condition threshold.");
1238 goto error;
1239 }
1240
1241 goto end;
1242
1243 error:
1244 lttng_condition_destroy(cond);
1245 cond = NULL;
1246
1247 end:
1248 argpar_state_destroy(state);
1249 argpar_item_destroy(item);
1250 free(error);
1251 return cond;
1252 }
1253
1254 static
1255 struct lttng_condition *handle_condition_buffer_usage_high(int *argc, const char ***argv)
1256 {
1257 ERR("High buffer usage threshold conditions are unsupported for the moment.");
1258 return NULL;
1259 }
1260
1261 static
1262 struct lttng_condition *handle_condition_buffer_usage_low(int *argc, const char ***argv)
1263 {
1264 ERR("Low buffer usage threshold conditions are unsupported for the moment.");
1265 return NULL;
1266 }
1267
1268 static
1269 struct lttng_condition *handle_condition_session_rotation_ongoing(int *argc, const char ***argv)
1270 {
1271 ERR("Session rotation ongoing conditions are unsupported for the moment.");
1272 return NULL;
1273 }
1274
1275 static
1276 struct lttng_condition *handle_condition_session_rotation_completed(int *argc, const char ***argv)
1277 {
1278 ERR("Session rotation completed conditions are unsupported for the moment.");
1279 return NULL;
1280 }
1281
1282 struct condition_descr {
1283 const char *name;
1284 struct lttng_condition *(*handler) (int *argc, const char ***argv);
1285 };
1286
1287 static const
1288 struct condition_descr condition_descrs[] = {
1289 { "on-event", handle_condition_event },
1290 { "on-session-consumed-size", handle_condition_session_consumed_size },
1291 { "on-buffer-usage-high", handle_condition_buffer_usage_high },
1292 { "on-buffer-usage-low", handle_condition_buffer_usage_low },
1293 { "on-session-rotation-ongoing", handle_condition_session_rotation_ongoing },
1294 { "on-session-rotation-completed", handle_condition_session_rotation_completed },
1295 };
1296
1297 static
1298 struct lttng_condition *parse_condition(int *argc, const char ***argv)
1299 {
1300 int i;
1301 struct lttng_condition *cond;
1302 const char *condition_name;
1303 const struct condition_descr *descr = NULL;
1304
1305 if (*argc == 0) {
1306 ERR("Missing condition name.");
1307 goto error;
1308 }
1309
1310 condition_name = (*argv)[0];
1311
1312 (*argc)--;
1313 (*argv)++;
1314
1315 for (i = 0; i < ARRAY_SIZE(condition_descrs); i++) {
1316 if (strcmp(condition_name, condition_descrs[i].name) == 0) {
1317 descr = &condition_descrs[i];
1318 break;
1319 }
1320 }
1321
1322 if (!descr) {
1323 ERR("Unknown condition name '%s'", condition_name);
1324 goto error;
1325 }
1326
1327 cond = descr->handler(argc, argv);
1328 if (!cond) {
1329 /* The handler has already printed an error message. */
1330 goto error;
1331 }
1332
1333 goto end;
1334 error:
1335 cond = NULL;
1336 end:
1337 return cond;
1338 }
1339
1340
1341 static
1342 struct lttng_action *handle_action_notify(int *argc, const char ***argv)
1343 {
1344 return lttng_action_notify_create();
1345 }
1346
1347 static const struct argpar_opt_descr no_opt_descrs[] = {
1348 ARGPAR_OPT_DESCR_SENTINEL
1349 };
1350
1351 /*
1352 * Generic handler for a kind of action that takes a session name as its sole
1353 * argument.
1354 */
1355
1356 static
1357 struct lttng_action *handle_action_simple_session(
1358 int *argc, const char ***argv,
1359 struct lttng_action *(*create_action_cb)(void),
1360 enum lttng_action_status (*set_session_name_cb)(struct lttng_action *, const char *),
1361 const char *action_name)
1362 {
1363 struct lttng_action *action = NULL;
1364 struct argpar_state *state = NULL;
1365 struct argpar_item *item = NULL;
1366 const char *session_name_arg = NULL;
1367 char *error = NULL;
1368 enum lttng_action_status action_status;
1369
1370 state = argpar_state_create(*argc, *argv, no_opt_descrs);
1371 if (!state) {
1372 ERR("Failed to allocate an argpar state.");
1373 goto error;
1374 }
1375
1376 while (true) {
1377 enum argpar_state_parse_next_status status;
1378 const struct argpar_item_non_opt *item_non_opt;
1379
1380 ARGPAR_ITEM_DESTROY_AND_RESET(item);
1381 status = argpar_state_parse_next(state, &item, &error);
1382 if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR) {
1383 ERR("%s", error);
1384 goto error;
1385 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT) {
1386 /* Just stop parsing here. */
1387 break;
1388 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_END) {
1389 break;
1390 }
1391
1392 assert(status == ARGPAR_STATE_PARSE_NEXT_STATUS_OK);
1393 assert(item->type == ARGPAR_ITEM_TYPE_NON_OPT);
1394
1395 item_non_opt = (const struct argpar_item_non_opt *) item;
1396
1397 switch (item_non_opt->non_opt_index) {
1398 case 0:
1399 session_name_arg = item_non_opt->arg;
1400 break;
1401 default:
1402 ERR("Unexpected argument `%s`.", item_non_opt->arg);
1403 goto error;
1404 }
1405 }
1406
1407 *argc -= argpar_state_get_ingested_orig_args(state);
1408 *argv += argpar_state_get_ingested_orig_args(state);
1409
1410 if (!session_name_arg) {
1411 ERR("Missing session name.");
1412 goto error;
1413 }
1414
1415 action = create_action_cb();
1416 if (!action) {
1417 ERR("Failed to allocate %s session action.", action_name);
1418 goto error;
1419 }
1420
1421 action_status = set_session_name_cb(action, session_name_arg);
1422 if (action_status != LTTNG_ACTION_STATUS_OK) {
1423 ERR("Failed to set action %s session's session name to '%s'.",
1424 action_name, session_name_arg);
1425 goto error;
1426 }
1427
1428 goto end;
1429
1430 error:
1431 lttng_action_destroy(action);
1432 action = NULL;
1433 argpar_item_destroy(item);
1434 end:
1435 free(error);
1436 argpar_state_destroy(state);
1437 return action;
1438 }
1439
1440 static
1441 struct lttng_action *handle_action_start_session(int *argc,
1442 const char ***argv)
1443 {
1444 return handle_action_simple_session(argc, argv,
1445 lttng_action_start_session_create,
1446 lttng_action_start_session_set_session_name,
1447 "start");
1448 }
1449
1450 static
1451 struct lttng_action *handle_action_stop_session(int *argc,
1452 const char ***argv)
1453 {
1454 return handle_action_simple_session(argc, argv,
1455 lttng_action_stop_session_create,
1456 lttng_action_stop_session_set_session_name,
1457 "stop");
1458 }
1459
1460 static
1461 struct lttng_action *handle_action_rotate_session(int *argc,
1462 const char ***argv)
1463 {
1464 return handle_action_simple_session(argc, argv,
1465 lttng_action_rotate_session_create,
1466 lttng_action_rotate_session_set_session_name,
1467 "rotate");
1468 }
1469
1470 static const struct argpar_opt_descr snapshot_action_opt_descrs[] = {
1471 { OPT_NAME, 'n', "name", true },
1472 { OPT_MAX_SIZE, 'm', "max-size", true },
1473 { OPT_CTRL_URL, '\0', "ctrl-url", true },
1474 { OPT_DATA_URL, '\0', "data-url", true },
1475 { OPT_URL, '\0', "url", true },
1476 { OPT_PATH, '\0', "path", true },
1477 ARGPAR_OPT_DESCR_SENTINEL
1478 };
1479
1480 static
1481 struct lttng_action *handle_action_snapshot_session(int *argc,
1482 const char ***argv)
1483 {
1484 struct lttng_action *action = NULL;
1485 struct argpar_state *state = NULL;
1486 struct argpar_item *item = NULL;
1487 const char *session_name_arg = NULL;
1488 char *snapshot_name_arg = NULL;
1489 char *ctrl_url_arg = NULL;
1490 char *data_url_arg = NULL;
1491 char *max_size_arg = NULL;
1492 char *url_arg = NULL;
1493 char *path_arg = NULL;
1494 char *error = NULL;
1495 enum lttng_action_status action_status;
1496 struct lttng_snapshot_output *snapshot_output = NULL;
1497 int ret;
1498 unsigned int locations_specified = 0;
1499
1500 state = argpar_state_create(*argc, *argv, snapshot_action_opt_descrs);
1501 if (!state) {
1502 ERR("Failed to allocate an argpar state.");
1503 goto error;
1504 }
1505
1506 while (true) {
1507 enum argpar_state_parse_next_status status;
1508
1509 ARGPAR_ITEM_DESTROY_AND_RESET(item);
1510 status = argpar_state_parse_next(state, &item, &error);
1511 if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR) {
1512 ERR("%s", error);
1513 goto error;
1514 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT) {
1515 /* Just stop parsing here. */
1516 break;
1517 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_END) {
1518 break;
1519 }
1520
1521 assert(status == ARGPAR_STATE_PARSE_NEXT_STATUS_OK);
1522
1523 if (item->type == ARGPAR_ITEM_TYPE_OPT) {
1524 const struct argpar_item_opt *item_opt =
1525 (const struct argpar_item_opt *) item;
1526
1527 switch (item_opt->descr->id) {
1528 case OPT_NAME:
1529 if (!assign_string(&snapshot_name_arg, item_opt->arg, "--name/-n")) {
1530 goto error;
1531 }
1532
1533 break;
1534 case OPT_MAX_SIZE:
1535 if (!assign_string(&max_size_arg, item_opt->arg, "--max-size/-m")) {
1536 goto error;
1537 }
1538
1539 break;
1540 case OPT_CTRL_URL:
1541 if (!assign_string(&ctrl_url_arg, item_opt->arg, "--ctrl-url")) {
1542 goto error;
1543 }
1544
1545 break;
1546 case OPT_DATA_URL:
1547 if (!assign_string(&data_url_arg, item_opt->arg, "--data-url")) {
1548 goto error;
1549 }
1550
1551 break;
1552 case OPT_URL:
1553 if (!assign_string(&url_arg, item_opt->arg, "--url")) {
1554 goto error;
1555 }
1556
1557 break;
1558 case OPT_PATH:
1559 if (!assign_string(&path_arg, item_opt->arg, "--path")) {
1560 goto error;
1561 }
1562
1563 break;
1564 default:
1565 abort();
1566 }
1567 } else {
1568 const struct argpar_item_non_opt *item_non_opt;
1569
1570 assert(item->type == ARGPAR_ITEM_TYPE_NON_OPT);
1571
1572 item_non_opt = (const struct argpar_item_non_opt *) item;
1573
1574 switch (item_non_opt->non_opt_index) {
1575 case 0:
1576 session_name_arg = item_non_opt->arg;
1577 break;
1578 default:
1579 ERR("Unexpected argument `%s`.",
1580 item_non_opt->arg);
1581 goto error;
1582 }
1583 }
1584 }
1585
1586 *argc -= argpar_state_get_ingested_orig_args(state);
1587 *argv += argpar_state_get_ingested_orig_args(state);
1588
1589 if (!session_name_arg) {
1590 ERR("Missing session name.");
1591 goto error;
1592 }
1593
1594 /* --ctrl-url and --data-url must come in pair. */
1595 if (ctrl_url_arg && !data_url_arg) {
1596 ERR("--ctrl-url is specified, but --data-url is missing.");
1597 goto error;
1598 }
1599
1600 if (!ctrl_url_arg && data_url_arg) {
1601 ERR("--data-url is specified, but --ctrl-url is missing.");
1602 goto error;
1603 }
1604
1605 locations_specified += !!(ctrl_url_arg || data_url_arg);
1606 locations_specified += !!url_arg;
1607 locations_specified += !!path_arg;
1608
1609 /* --ctrl-url/--data-url, --url and --path are mutually exclusive. */
1610 if (locations_specified > 1) {
1611 ERR("The --ctrl-url/--data-url, --url, and --path options can't be used together.");
1612 goto error;
1613 }
1614
1615 /*
1616 * Did the user specify an option that implies using a
1617 * custom/unregistered output?
1618 */
1619 if (url_arg || ctrl_url_arg || path_arg) {
1620 snapshot_output = lttng_snapshot_output_create();
1621 if (!snapshot_output) {
1622 ERR("Failed to allocate a snapshot output.");
1623 goto error;
1624 }
1625 }
1626
1627 action = lttng_action_snapshot_session_create();
1628 if (!action) {
1629 ERR("Failed to allocate snapshot session action.");
1630 goto error;
1631 }
1632
1633 action_status = lttng_action_snapshot_session_set_session_name(
1634 action, session_name_arg);
1635 if (action_status != LTTNG_ACTION_STATUS_OK) {
1636 ERR("Failed to set action snapshot session's session name to '%s'.",
1637 session_name_arg);
1638 goto error;
1639 }
1640
1641 if (snapshot_name_arg) {
1642 if (!snapshot_output) {
1643 ERR("Can't provide a snapshot output name without a snapshot output destination.");
1644 goto error;
1645 }
1646
1647 ret = lttng_snapshot_output_set_name(
1648 snapshot_name_arg, snapshot_output);
1649 if (ret != 0) {
1650 ERR("Failed to set name of snapshot output.");
1651 goto error;
1652 }
1653 }
1654
1655 if (max_size_arg) {
1656 uint64_t max_size;
1657
1658 if (!snapshot_output) {
1659 ERR("Can't provide a snapshot output max size without a snapshot output destination.");
1660 goto error;
1661 }
1662
1663 ret = utils_parse_size_suffix(max_size_arg, &max_size);
1664 if (ret != 0) {
1665 ERR("Failed to parse `%s` as a size.", max_size_arg);
1666 goto error;
1667 }
1668
1669 ret = lttng_snapshot_output_set_size(max_size, snapshot_output);
1670 if (ret != 0) {
1671 ERR("Failed to set snapshot output's max size to %" PRIu64 " bytes.",
1672 max_size);
1673 goto error;
1674 }
1675 }
1676
1677 if (url_arg) {
1678 int num_uris;
1679 struct lttng_uri *uris;
1680
1681 if (!strstr(url_arg, "://")) {
1682 ERR("Failed to parse '%s' as an URL.", url_arg);
1683 goto error;
1684 }
1685
1686 num_uris = uri_parse_str_urls(url_arg, NULL, &uris);
1687 if (num_uris < 1) {
1688 ERR("Failed to parse '%s' as an URL.", url_arg);
1689 goto error;
1690 }
1691
1692 if (uris[0].dtype == LTTNG_DST_PATH) {
1693 ret = lttng_snapshot_output_set_local_path(
1694 uris[0].dst.path, snapshot_output);
1695 free(uris);
1696 if (ret != 0) {
1697 ERR("Failed to assign '%s' as a local destination.",
1698 url_arg);
1699 goto error;
1700 }
1701 } else {
1702 ret = lttng_snapshot_output_set_network_url(
1703 url_arg, snapshot_output);
1704 free(uris);
1705 if (ret != 0) {
1706 ERR("Failed to assign '%s' as a network URL.",
1707 url_arg);
1708 goto error;
1709 }
1710 }
1711 }
1712
1713 if (path_arg) {
1714 ret = lttng_snapshot_output_set_local_path(
1715 path_arg, snapshot_output);
1716 if (ret != 0) {
1717 ERR("Failed to parse '%s' as a local path.", path_arg);
1718 goto error;
1719 }
1720 }
1721
1722 if (ctrl_url_arg) {
1723 /*
1724 * Two argument form, network output with separate control and
1725 * data URLs.
1726 */
1727 ret = lttng_snapshot_output_set_network_urls(
1728 ctrl_url_arg, data_url_arg, snapshot_output);
1729 if (ret != 0) {
1730 ERR("Failed to parse `%s` and `%s` as control and data URLs.",
1731 ctrl_url_arg, data_url_arg);
1732 goto error;
1733 }
1734 }
1735
1736 if (snapshot_output) {
1737 action_status = lttng_action_snapshot_session_set_output(
1738 action, snapshot_output);
1739 if (action_status != LTTNG_ACTION_STATUS_OK) {
1740 ERR("Failed to set snapshot session action's output.");
1741 goto error;
1742 }
1743
1744 /* Ownership of `snapshot_output` has been transferred to the action. */
1745 snapshot_output = NULL;
1746 }
1747
1748 goto end;
1749
1750 error:
1751 lttng_action_destroy(action);
1752 action = NULL;
1753 free(error);
1754 end:
1755 free(snapshot_name_arg);
1756 free(path_arg);
1757 free(url_arg);
1758 free(ctrl_url_arg);
1759 free(data_url_arg);
1760 free(snapshot_output);
1761 free(max_size_arg);
1762 argpar_state_destroy(state);
1763 argpar_item_destroy(item);
1764 return action;
1765 }
1766
1767 struct action_descr {
1768 const char *name;
1769 struct lttng_action *(*handler) (int *argc, const char ***argv);
1770 };
1771
1772 static const
1773 struct action_descr action_descrs[] = {
1774 { "notify", handle_action_notify },
1775 { "start-session", handle_action_start_session },
1776 { "stop-session", handle_action_stop_session },
1777 { "rotate-session", handle_action_rotate_session },
1778 { "snapshot-session", handle_action_snapshot_session },
1779 };
1780
1781 static
1782 struct lttng_action *parse_action(int *argc, const char ***argv)
1783 {
1784 int i;
1785 struct lttng_action *action;
1786 const char *action_name;
1787 const struct action_descr *descr = NULL;
1788
1789 if (*argc == 0) {
1790 ERR("Missing action name.");
1791 goto error;
1792 }
1793
1794 action_name = (*argv)[0];
1795
1796 (*argc)--;
1797 (*argv)++;
1798
1799 for (i = 0; i < ARRAY_SIZE(action_descrs); i++) {
1800 if (strcmp(action_name, action_descrs[i].name) == 0) {
1801 descr = &action_descrs[i];
1802 break;
1803 }
1804 }
1805
1806 if (!descr) {
1807 ERR("Unknown action name: %s", action_name);
1808 goto error;
1809 }
1810
1811 action = descr->handler(argc, argv);
1812 if (!action) {
1813 /* The handler has already printed an error message. */
1814 goto error;
1815 }
1816
1817 goto end;
1818 error:
1819 action = NULL;
1820 end:
1821 return action;
1822 }
1823
1824 static const
1825 struct argpar_opt_descr add_trigger_options[] = {
1826 { OPT_HELP, 'h', "help", false },
1827 { OPT_LIST_OPTIONS, '\0', "list-options", false },
1828 { OPT_CONDITION, '\0', "condition", false },
1829 { OPT_ACTION, '\0', "action", false },
1830 { OPT_ID, '\0', "id", true },
1831 { OPT_FIRE_ONCE_AFTER, '\0', "fire-once-after", true },
1832 { OPT_FIRE_EVERY, '\0', "fire-every", true },
1833 { OPT_USER_ID, '\0', "user-id", true },
1834 ARGPAR_OPT_DESCR_SENTINEL,
1835 };
1836
1837 static
1838 void lttng_actions_destructor(void *p)
1839 {
1840 struct lttng_action *action = p;
1841
1842 lttng_action_destroy(action);
1843 }
1844
1845 int cmd_add_trigger(int argc, const char **argv)
1846 {
1847 int ret;
1848 int my_argc = argc - 1;
1849 const char **my_argv = argv + 1;
1850 struct lttng_condition *condition = NULL;
1851 struct lttng_dynamic_pointer_array actions;
1852 struct argpar_state *argpar_state = NULL;
1853 struct argpar_item *argpar_item = NULL;
1854 struct lttng_action *action_group = NULL;
1855 struct lttng_action *action = NULL;
1856 struct lttng_trigger *trigger = NULL;
1857 char *error = NULL;
1858 char *id = NULL;
1859 int i;
1860 char *fire_once_after_str = NULL;
1861 char *fire_every_str = NULL;
1862 char *user_id = NULL;
1863
1864 lttng_dynamic_pointer_array_init(&actions, lttng_actions_destructor);
1865
1866 while (true) {
1867 enum argpar_state_parse_next_status status;
1868 const struct argpar_item_opt *item_opt;
1869 int ingested_args;
1870
1871 argpar_state_destroy(argpar_state);
1872 argpar_state = argpar_state_create(my_argc, my_argv,
1873 add_trigger_options);
1874 if (!argpar_state) {
1875 ERR("Failed to create argpar state.");
1876 goto error;
1877 }
1878
1879 ARGPAR_ITEM_DESTROY_AND_RESET(argpar_item);
1880 status = argpar_state_parse_next(argpar_state, &argpar_item, &error);
1881 if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR) {
1882 ERR("%s", error);
1883 goto error;
1884 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT) {
1885 ERR("%s", error);
1886 goto error;
1887 } else if (status == ARGPAR_STATE_PARSE_NEXT_STATUS_END) {
1888 break;
1889 }
1890
1891 assert(status == ARGPAR_STATE_PARSE_NEXT_STATUS_OK);
1892
1893 if (argpar_item->type == ARGPAR_ITEM_TYPE_NON_OPT) {
1894 const struct argpar_item_non_opt *item_non_opt =
1895 (const struct argpar_item_non_opt *)
1896 argpar_item;
1897
1898 ERR("Unexpected argument `%s`.", item_non_opt->arg);
1899 goto error;
1900 }
1901
1902 item_opt = (const struct argpar_item_opt *) argpar_item;
1903
1904 ingested_args = argpar_state_get_ingested_orig_args(
1905 argpar_state);
1906
1907 my_argc -= ingested_args;
1908 my_argv += ingested_args;
1909
1910 switch (item_opt->descr->id) {
1911 case OPT_HELP:
1912 SHOW_HELP();
1913 ret = 0;
1914 goto end;
1915 case OPT_LIST_OPTIONS:
1916 list_cmd_options_argpar(stdout, add_trigger_options);
1917 ret = 0;
1918 goto end;
1919 case OPT_CONDITION:
1920 {
1921 if (condition) {
1922 ERR("A --condition was already given.");
1923 goto error;
1924 }
1925
1926 condition = parse_condition(&my_argc, &my_argv);
1927 if (!condition) {
1928 /*
1929 * An error message was already printed by
1930 * parse_condition.
1931 */
1932 goto error;
1933 }
1934
1935 break;
1936 }
1937 case OPT_ACTION:
1938 {
1939 action = parse_action(&my_argc, &my_argv);
1940 if (!action) {
1941 /*
1942 * An error message was already printed by
1943 * parse_condition.
1944 */
1945 goto error;
1946 }
1947
1948 ret = lttng_dynamic_pointer_array_add_pointer(
1949 &actions, action);
1950 if (ret) {
1951 ERR("Failed to add pointer to pointer array.");
1952 goto error;
1953 }
1954
1955 /* Ownership of the action was transferred to the group. */
1956 action = NULL;
1957
1958 break;
1959 }
1960 case OPT_ID:
1961 {
1962 if (!assign_string(&id, item_opt->arg, "--id")) {
1963 goto error;
1964 }
1965
1966 break;
1967 }
1968 case OPT_FIRE_ONCE_AFTER:
1969 {
1970 if (!assign_string(&fire_once_after_str, item_opt->arg,
1971 "--fire-once-after")) {
1972 goto error;
1973 }
1974
1975 break;
1976 }
1977 case OPT_FIRE_EVERY:
1978 {
1979 if (!assign_string(&fire_every_str, item_opt->arg,
1980 "--fire-every")) {
1981 goto error;
1982 }
1983
1984 break;
1985 }
1986 case OPT_USER_ID:
1987 {
1988 if (!assign_string(&user_id, item_opt->arg,
1989 "--user-id")) {
1990 goto error;
1991 }
1992
1993 break;
1994 }
1995 default:
1996 abort();
1997 }
1998 }
1999
2000 if (!condition) {
2001 ERR("Missing --condition.");
2002 goto error;
2003 }
2004
2005 if (lttng_dynamic_pointer_array_get_count(&actions) == 0) {
2006 ERR("Need at least one --action.");
2007 goto error;
2008 }
2009
2010 if (fire_every_str && fire_once_after_str) {
2011 ERR("Can't specify both --fire-once-after and --fire-every.");
2012 goto error;
2013 }
2014
2015 action_group = lttng_action_group_create();
2016 if (!action_group) {
2017 goto error;
2018 }
2019
2020 for (i = 0; i < lttng_dynamic_pointer_array_get_count(&actions); i++) {
2021 enum lttng_action_status status;
2022
2023 action = lttng_dynamic_pointer_array_steal_pointer(&actions, i);
2024
2025 status = lttng_action_group_add_action(action_group, action);
2026 if (status != LTTNG_ACTION_STATUS_OK) {
2027 goto error;
2028 }
2029
2030 /*
2031 * The `lttng_action_group_add_action()` takes a reference to
2032 * the action. We can destroy ours.
2033 */
2034 lttng_action_destroy(action);
2035 action = NULL;
2036 }
2037
2038 trigger = lttng_trigger_create(condition, action_group);
2039 if (!trigger) {
2040 goto error;
2041 }
2042
2043 if (id) {
2044 enum lttng_trigger_status trigger_status =
2045 lttng_trigger_set_name(trigger, id);
2046
2047 if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
2048 ERR("Failed to set trigger id.");
2049 goto error;
2050 }
2051 }
2052
2053 if (fire_once_after_str) {
2054 unsigned long long threshold;
2055 enum lttng_trigger_status trigger_status;
2056
2057 if (utils_parse_unsigned_long_long(fire_once_after_str, &threshold) != 0) {
2058 ERR("Failed to parse `%s` as an integer.", fire_once_after_str);
2059 goto error;
2060 }
2061
2062 trigger_status = lttng_trigger_set_firing_policy(trigger,
2063 LTTNG_TRIGGER_FIRING_POLICY_ONCE_AFTER_N,
2064 threshold);
2065 if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
2066 ERR("Failed to set trigger's policy to `fire once after N`.");
2067 goto error;
2068 }
2069 }
2070
2071 if (fire_every_str) {
2072 unsigned long long threshold;
2073 enum lttng_trigger_status trigger_status;
2074
2075 if (utils_parse_unsigned_long_long(fire_every_str, &threshold) != 0) {
2076 ERR("Failed to parse `%s` as an integer.", fire_every_str);
2077 goto error;
2078 }
2079
2080 trigger_status = lttng_trigger_set_firing_policy(trigger,
2081 LTTNG_TRIGGER_FIRING_POLICY_EVERY_N, threshold);
2082 if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
2083 ERR("Failed to set trigger's policy to `fire every N`.");
2084 goto error;
2085 }
2086 }
2087
2088 if (user_id) {
2089 enum lttng_trigger_status trigger_status;
2090 char *end;
2091 long long uid;
2092
2093 errno = 0;
2094 uid = strtol(user_id, &end, 10);
2095 if (end == user_id || *end != '\0' || errno != 0) {
2096 ERR("Failed to parse `%s` as a user id.", user_id);
2097 }
2098
2099 trigger_status = lttng_trigger_set_owner_uid(trigger, uid);
2100 if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
2101 ERR("Failed to set trigger's user identity.");
2102 goto error;
2103 }
2104 }
2105
2106 ret = lttng_register_trigger(trigger);
2107 if (ret) {
2108 ERR("Failed to register trigger: %s.", lttng_strerror(ret));
2109 goto error;
2110 }
2111
2112 MSG("Trigger registered successfully.");
2113
2114 goto end;
2115
2116 error:
2117 ret = 1;
2118
2119 end:
2120 argpar_state_destroy(argpar_state);
2121 argpar_item_destroy(argpar_item);
2122 lttng_dynamic_pointer_array_reset(&actions);
2123 lttng_condition_destroy(condition);
2124 lttng_action_destroy(action_group);
2125 lttng_action_destroy(action);
2126 lttng_trigger_destroy(trigger);
2127 free(error);
2128 free(id);
2129 free(fire_once_after_str);
2130 free(fire_every_str);
2131 free(user_id);
2132 return ret;
2133 }
This page took 0.125832 seconds and 4 git commands to generate.