sessiond: add support for anonymous triggers
[lttng-tools.git] / tests / regression / tools / notification / notification.c
CommitLineData
434f8068
JR
1/*
2 * notification.c
3 *
4 * Tests suite for LTTng notification API
5 *
6 * Copyright (C) 2017 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
7 *
9d16b343 8 * SPDX-License-Identifier: MIT
434f8068 9 *
434f8068
JR
10 */
11
12#include <assert.h>
13#include <math.h>
14#include <stdbool.h>
15#include <stdio.h>
16#include <stdlib.h>
17#include <string.h>
18#include <unistd.h>
19#include <inttypes.h>
20#include <sys/types.h>
21#include <sys/stat.h>
22#include <fcntl.h>
854382b8 23#include <signal.h>
854382b8 24#include <poll.h>
434f8068 25
edf4b93e 26#include <common/compat/errno.h>
7948461b 27#include <lttng/lttng.h>
434f8068
JR
28
29#include <tap/tap.h>
30
26e2f47b
JR
31#define FIELD_NAME_MAX_LEN 256
32
33/* A callback to populate the condition capture descriptor. */
34typedef int (*condition_capture_desc_cb)(struct lttng_condition *condition);
35
36/* A callback for captured field validation. */
37typedef int (*validate_cb)(const struct lttng_event_field_value *event_field, unsigned iteration);
38
434f8068
JR
39int nb_args = 0;
40int named_pipe_args_start = 0;
7344b6a3 41pid_t app_pid = 0;
854382b8
JR
42const char *app_state_file = NULL;
43
26e2f47b
JR
44enum field_type {
45 FIELD_TYPE_PAYLOAD,
46 FIELD_TYPE_CONTEXT,
47 FIELD_TYPE_APP_CONTEXT,
48 FIELD_TYPE_ARRAY_FIELD,
49};
50
51struct capture_base_field_tuple {
52 char* field_name;
53 enum field_type field_type;
54 /* Do we expect a userspace capture? */
55 bool expected_ust;
56 /* Do we expect a kernel capture? */
57 bool expected_kernel;
58 validate_cb validate_ust;
59 validate_cb validate_kernel;
60};
61
62static
63const char *field_value_type_to_str(enum lttng_event_field_value_type type)
64{
65 switch (type) {
66 case LTTNG_EVENT_FIELD_VALUE_TYPE_UNKNOWN:
67 return "UNKNOWN";
68 case LTTNG_EVENT_FIELD_VALUE_TYPE_INVALID:
69 return "INVALID";
70 case LTTNG_EVENT_FIELD_VALUE_TYPE_UNSIGNED_INT:
71 return "UNSIGNED INT";
72 case LTTNG_EVENT_FIELD_VALUE_TYPE_SIGNED_INT:
73 return "SIGNED INT";
74 case LTTNG_EVENT_FIELD_VALUE_TYPE_UNSIGNED_ENUM:
75 return "UNSIGNED ENUM";
76 case LTTNG_EVENT_FIELD_VALUE_TYPE_SIGNED_ENUM:
77 return "SIGNED ENUM";
78 case LTTNG_EVENT_FIELD_VALUE_TYPE_REAL:
79 return "REAL";
80 case LTTNG_EVENT_FIELD_VALUE_TYPE_STRING:
81 return "STRING";
82 case LTTNG_EVENT_FIELD_VALUE_TYPE_ARRAY:
83 return "ARRAY";
84 default:
85 abort();
86 }
87}
88
89static int validate_type(const struct lttng_event_field_value *event_field,
90 enum lttng_event_field_value_type expect)
91{
92 int ret;
93 enum lttng_event_field_value_type value;
94
95 value = lttng_event_field_value_get_type(event_field);
96 if (value == LTTNG_EVENT_FIELD_VALUE_TYPE_INVALID) {
97 ret = 1;
98 goto end;
99 }
100
101 ok(expect == value, "Expected field type %s, got %s",
102 field_value_type_to_str(expect),
103 field_value_type_to_str(value));
104
105 ret = expect != value;
106
107end:
108 return ret;
109}
110
111/*
112 * Validate unsigned captured field against the iteration number.
113 */
114static int validate_unsigned_int_field(
115 const struct lttng_event_field_value *event_field,
116 unsigned int expected_value)
117{
118 int ret;
119 uint64_t value;
120 enum lttng_event_field_value_status status;
121
122 ret = validate_type(
123 event_field, LTTNG_EVENT_FIELD_VALUE_TYPE_UNSIGNED_INT);
124 if (ret) {
125 goto end;
126 }
127
128 status = lttng_event_field_value_unsigned_int_get_value(
129 event_field, &value);
130 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
131 fail("lttng_event_field_value_unsigned_int_get_value returned an error: status = %d",
132 (int) status);
133 ret = 1;
134 goto end;
135 }
136
137 ok(value == (uint64_t) expected_value,
138 "Expected unsigned integer value %u, got %" PRIu64,
139 expected_value, value);
140
141 ret = value != (uint64_t) expected_value;
142
143end:
144 return ret;
145}
146
147/*
148 * Validate signed captured field.
149 */
150static int validate_signed_int_field(
151 const struct lttng_event_field_value *event_field,
152 unsigned int iteration)
153{
154 int ret;
155 const int64_t expected = -1;
156 int64_t value;
157 enum lttng_event_field_value_status status;
158
159 /* Unused. */
160 (void) iteration;
161
162 ret = validate_type(
163 event_field, LTTNG_EVENT_FIELD_VALUE_TYPE_SIGNED_INT);
164 if (ret) {
165 goto end;
166 }
167
168 status = lttng_event_field_value_signed_int_get_value(
169 event_field, &value);
170 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
171 fail("lttng_event_field_value_signed_int_get_value returned an error: status = %d",
172 (int) status);
173 ret = 1;
174 goto end;
175 }
176
177 ok(value == expected,
178 "Expected signed integer value %" PRId64
179 ", got %" PRId64,
180 expected, value);
181
182 ret = value != expected;
183
184end:
185
186 return ret;
187}
188
189/*
190 * Validate array of unsigned int.
191 */
192static int validate_array_unsigned_int_field(
193 const struct lttng_event_field_value *event_field,
194 unsigned int iteration)
195{
196 int ret;
197 enum lttng_event_field_value_status status;
198 const unsigned int expected = 3;
199 unsigned int i, count;
200
201 /* Unused. */
202 (void) iteration;
203
204 ret = validate_type(event_field, LTTNG_EVENT_FIELD_VALUE_TYPE_ARRAY);
205 if (ret) {
206 goto end;
207 }
208
209 status = lttng_event_field_value_array_get_length(event_field, &count);
210 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
211 fail("lttng_event_field_value_array_get_length");
212 ret = 1;
213 goto end;
214 }
215
216 ok(count == expected, "Expected %d subelements, got %d", expected,
217 count);
218 if (count != expected) {
219 ret = 1;
220 goto end;
221 }
222
223 for (i = 1; i < count + 1; i++) {
224 const struct lttng_event_field_value *value;
225
226 status = lttng_event_field_value_array_get_element_at_index(
227 event_field, i - 1, &value);
228 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
229 fail("lttng_event_field_value_array_get_element_at_index returned an error: status = %d",
230 (int) status);
231 ret = 1;
232 goto end;
233 }
234
235 ret = validate_unsigned_int_field(value, i);
236 if (ret) {
237 goto end;
238 }
239 }
240
241 ret = 0;
242end:
243
244 return ret;
245}
246
247static int validate_array_unsigned_int_field_at_index(
248 const struct lttng_event_field_value *event_field,
249 unsigned int iteration)
250{
251 int ret;
252 const uint64_t expected_value = 2;
253 enum lttng_event_field_value_status status;
254 uint64_t value;
255
256 /* Unused. */
257 (void) iteration;
258
259 ret = validate_type(
260 event_field, LTTNG_EVENT_FIELD_VALUE_TYPE_UNSIGNED_INT);
261 if (ret) {
262 goto end;
263 }
264
265 status = lttng_event_field_value_unsigned_int_get_value(
266 event_field, &value);
267 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
268 fail("lttng_event_field_value_unsigned_int_get_value returned an error: status = %d",
269 (int) status);
270 ret = 1;
271 goto end;
272 }
273
274 ok(value == expected_value,
275 "Expected unsigned integer value %u, got %" PRIu64,
276 expected_value, value);
277
278 ret = 0;
279end:
280 return ret;
281}
282
283/*
284 * Validate sequence for a string (seqfield1):
285 *
286 * Value: "test" encoded in UTF-8: [116, 101, 115, 116]
287 */
288static int validate_seqfield1(const struct lttng_event_field_value *event_field,
289 unsigned int iteration)
290{
291 int ret;
292 enum lttng_event_field_value_status status;
293 unsigned int i, count;
294 const unsigned int expect[] = {116, 101, 115, 116};
295 const size_t array_count = sizeof(expect) / sizeof(*expect);
296
297 /* Unused. */
298 (void) iteration;
299
300 ret = validate_type(event_field, LTTNG_EVENT_FIELD_VALUE_TYPE_ARRAY);
301 if (ret) {
302 goto end;
303 }
304
305 status = lttng_event_field_value_array_get_length(event_field, &count);
306 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
307 fail("lttng_event_field_value_array_get_length returned an error: status = %d",
308 (int) status);
309 ret = 1;
310 goto end;
311 }
312
313 ok(count == array_count, "Expected %zu array sub-elements, got %d",
314 array_count, count);
315 if (count != array_count) {
316 ret = 1;
317 goto end;
318 }
319
320 for (i = 0; i < count; i++) {
321 const struct lttng_event_field_value *value;
322
323 status = lttng_event_field_value_array_get_element_at_index(
324 event_field, i, &value);
325 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
326 fail("lttng_event_field_value_array_get_element_at_index returned an error: status = %d",
327 (int) status);
328 ret = 1;
329 goto end;
330 }
331
332 ret = validate_unsigned_int_field(value, expect[i]);
333 if (ret) {
334 goto end;
335 }
336 }
337
338 ret = 0;
339end:
340 return ret;
341}
342
343static int validate_string(
344 const struct lttng_event_field_value *event_field,
345 const char *expect)
346{
347 int ret;
348 const char *value = NULL;
349 enum lttng_event_field_value_status status;
350
351 ret = validate_type(event_field, LTTNG_EVENT_FIELD_VALUE_TYPE_STRING);
352 if (ret) {
353 goto end;
354 }
355
356 status = lttng_event_field_value_string_get_value(event_field, &value);
357 if (!value) {
358 fail("lttng_event_field_value_array_get_length returned an error: status = %d",
359 (int) status);
360 ret = 1;
361 goto end;
362 }
363
364 ok(!strcmp(value, expect), "Expected string value \"%s\", got \"%s\"",
365 expect, value);
366
367 ret = 0;
368end:
369
370 return ret;
371}
372
373/*
374 * Validate string. Expected value is "test".
375 */
376static int validate_string_test(
377 const struct lttng_event_field_value *event_field,
378 unsigned int iteration)
379{
380 const char * const expect = "test";
381
382 /* Unused. */
383 (void) iteration;
384
385 return validate_string(event_field, expect);
386}
387
388/*
389 * Validate escaped string. Expected value is "\*".
390 */
391static int validate_string_escaped(
392 const struct lttng_event_field_value *event_field,
393 unsigned int iteration)
394{
395 const char * const expect = "\\*";
396
397 /* Unused. */
398 (void) iteration;
399
400 return validate_string(event_field, expect);
401}
402
403/*
404 * Validate real field.
405 */
406static int validate_real(
407 const struct lttng_event_field_value *event_field,
408 double expect)
409{
410 int ret;
411 double value;
412 enum lttng_event_field_value_status status;
413
414 ret = validate_type(event_field, LTTNG_EVENT_FIELD_VALUE_TYPE_REAL);
415 if (ret) {
416 goto end;
417 }
418
419 status = lttng_event_field_value_real_get_value(event_field, &value);
420 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
421 fail("lttng_event_field_value_real_get_value returned an error: status = %d",
422 (int) status);
423 ret = 1;
424 goto end;
425 }
426
427 ok(value == expect, "Expected real value %f, got %f", expect, value);
428 ret = value != expect;
429end:
430 return ret;
431}
432
433/*
434 * Validate floatfield.
435 */
436static int validate_floatfield(
437 const struct lttng_event_field_value *event_field,
438 unsigned int iteration)
439{
440 const double expect = 2222.0;
441
442 /* Unused. */
443 (void) iteration;
444
445 return validate_real(event_field, expect);
446}
447
448/*
449 * Validate doublefield.
450 */
451static int validate_doublefield(
452 const struct lttng_event_field_value *event_field,
453 unsigned int iteration)
454{
455 const double expect = 2.0;
456
457 /* Unused. */
458 (void) iteration;
459
460 return validate_real(event_field, expect);
461}
462
463/*
464 * Validate enum0: enum0 = ( "AUTO: EXPECT 0" : container = 0 )
465 */
466static int validate_enum0(const struct lttng_event_field_value *event_field,
467 unsigned int iteration)
468{
469 int ret;
470 enum lttng_event_field_value_status status;
471 uint64_t value;
472 const uint64_t expected_value = 0;
473
474 /* Unused. */
475 (void) iteration;
476
477 ret = validate_type(event_field,
478 LTTNG_EVENT_FIELD_VALUE_TYPE_UNSIGNED_ENUM);
479 if (ret) {
480 goto end;
481 }
482
483 status = lttng_event_field_value_unsigned_int_get_value(
484 event_field, &value);
485 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
486 fail("lttng_event_field_value_unsigned_int_get_value returned an error: status = %d",
487 (int) status);
488 ret = 1;
489 goto end;
490 }
491
492 ok(value == expected_value,
493 "Expected enum value %" PRIu64 ", got %" PRIu64,
494 expected_value, value);
495
496end:
497 return ret;
498}
499
500/*
501 * Validate enumnegative: enumnegative = ( "AUTO: EXPECT 0" : container = 0 )
502 *
503 * We expect 2 labels here.
504 */
505static int validate_enumnegative(
506 const struct lttng_event_field_value *event_field,
507 unsigned int iteration)
508{
509 int ret;
510 enum lttng_event_field_value_status status;
511 int64_t value;
512 const int64_t expected_value = -1;
513
514 /* Unused. */
515 (void) iteration;
516
517 ret = validate_type(event_field,
518 LTTNG_EVENT_FIELD_VALUE_TYPE_SIGNED_ENUM);
519 if (ret) {
520 goto end;
521 }
522
523 status = lttng_event_field_value_signed_int_get_value(
524 event_field, &value);
525 if (status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
526 fail("lttng_event_field_value_unsigned_int_get_value");
527 ret = 1;
528 goto end;
529 }
530
531 ok(value == expected_value,
532 "Expected enum value %" PRId64 ", got %" PRId64,
533 expected_value, value);
534
535end:
536 return ret;
537}
538
539static int validate_context_procname_ust(
540 const struct lttng_event_field_value *event_field,
541 unsigned int iteration)
542{
543 /* Unused. */
544 (void) iteration;
545 return validate_string(event_field, "gen-ust-events");
546}
547
548static int validate_context_procname_kernel(
549 const struct lttng_event_field_value *event_field,
550 unsigned int iteration)
551{
552 /* Unused. */
553 (void) iteration;
554 return validate_string(event_field, "echo");
555}
556
557struct capture_base_field_tuple test_capture_base_fields[] = {
558 { "DOESNOTEXIST", FIELD_TYPE_PAYLOAD, false, false, NULL, NULL },
559 { "intfield", FIELD_TYPE_PAYLOAD, true, true, validate_unsigned_int_field, validate_unsigned_int_field },
560 { "longfield", FIELD_TYPE_PAYLOAD, true, true, validate_unsigned_int_field, validate_unsigned_int_field },
561 { "signedfield", FIELD_TYPE_PAYLOAD, true, true, validate_signed_int_field, validate_signed_int_field },
562 { "arrfield1", FIELD_TYPE_PAYLOAD, true, true, validate_array_unsigned_int_field, validate_array_unsigned_int_field },
563 { "arrfield2", FIELD_TYPE_PAYLOAD, true, true, validate_string_test, validate_string_test },
564 { "arrfield3", FIELD_TYPE_PAYLOAD, true, true, validate_array_unsigned_int_field, validate_array_unsigned_int_field },
565 { "seqfield1", FIELD_TYPE_PAYLOAD, true, true, validate_seqfield1, validate_seqfield1 },
566 { "seqfield2", FIELD_TYPE_PAYLOAD, true, true, validate_string_test, validate_string_test },
567 { "seqfield3", FIELD_TYPE_PAYLOAD, true, true, validate_array_unsigned_int_field, validate_array_unsigned_int_field },
568 { "seqfield4", FIELD_TYPE_PAYLOAD, true, true, validate_array_unsigned_int_field, validate_array_unsigned_int_field },
569 { "arrfield1[1]", FIELD_TYPE_ARRAY_FIELD, true, true, validate_array_unsigned_int_field_at_index, validate_array_unsigned_int_field_at_index },
570 { "stringfield", FIELD_TYPE_PAYLOAD, true, true, validate_string_test, validate_string_test },
571 { "stringfield2", FIELD_TYPE_PAYLOAD, true, true, validate_string_escaped, validate_string_escaped },
572 { "floatfield", FIELD_TYPE_PAYLOAD, true, false, validate_floatfield, validate_floatfield },
573 { "doublefield", FIELD_TYPE_PAYLOAD, true, false, validate_doublefield, validate_doublefield },
574 { "enum0", FIELD_TYPE_PAYLOAD, true, true, validate_enum0, validate_enum0 },
575 { "enumnegative", FIELD_TYPE_PAYLOAD, true, true, validate_enumnegative, validate_enumnegative },
576 { "$ctx.procname", FIELD_TYPE_CONTEXT, true, true, validate_context_procname_ust, validate_context_procname_kernel },
577};
578
d150e7e5
JR
579static const char *get_notification_trigger_name(
580 struct lttng_notification *notification)
581{
65f64978
JG
582 const char *trigger_name = NULL;
583 enum lttng_trigger_status trigger_status;
584 const struct lttng_trigger *trigger;
585
586 trigger = lttng_notification_get_trigger(notification);
587 if (!trigger) {
588 fail("Failed to get trigger from notification");
d150e7e5
JR
589 goto end;
590 }
591
65f64978 592 trigger_status = lttng_trigger_get_name(trigger, &trigger_name);
0efb2ad7
JG
593 switch (trigger_status) {
594 case LTTNG_TRIGGER_STATUS_OK:
595 break;
596 case LTTNG_TRIGGER_STATUS_UNSET:
597 trigger_name = "(anonymous)";
598 break;
599 default:
65f64978 600 fail("Failed to get name from notification's trigger");
d150e7e5
JR
601 goto end;
602 }
65f64978 603
d150e7e5 604end:
65f64978 605 return trigger_name;
d150e7e5
JR
606}
607
608static int validator_notification_trigger_name(
609 struct lttng_notification *notification,
610 const char *trigger_name)
611{
612 int ret;
613 bool name_is_equal;
614 const char *name;
615
616 assert(notification);
617 assert(trigger_name);
618
619 name = get_notification_trigger_name(notification);
620 if (name == NULL) {
621 ret = 1;
622 goto end;
623 }
624
625 name_is_equal = (strcmp(trigger_name, name) == 0);
626 ok(name_is_equal, "Expected trigger name: %s got %s", trigger_name,
627 name);
628
629 ret = !name_is_equal;
630
631end:
632 return ret;
633}
634
854382b8
JR
635static
636void wait_on_file(const char *path, bool file_exist)
637{
638 if (!path) {
639 return;
640 }
641 for (;;) {
642 int ret;
643 struct stat buf;
644
645 ret = stat(path, &buf);
646 if (ret == -1 && errno == ENOENT) {
647 if (file_exist) {
f0784451
FD
648 /*
649 * The file does not exist. wait a bit and
650 * continue looping until it does.
651 */
652 (void) poll(NULL, 0, 10);
653 continue;
854382b8 654 }
f0784451
FD
655
656 /*
657 * File does not exist and the exit condition we want.
658 * Break from the loop and return.
659 */
660 break;
854382b8
JR
661 }
662 if (ret) {
663 perror("stat");
664 exit(EXIT_FAILURE);
665 }
f0784451
FD
666 /*
667 * stat() returned 0, so the file exists. break now only if
668 * that's the exit condition we want.
669 */
670 if (file_exist) {
671 break;
672 }
854382b8
JR
673 }
674}
434f8068 675
f12eb9c1 676static
434f8068
JR
677int write_pipe(const char *path, uint8_t data)
678{
679 int ret = 0;
680 int fd = 0;
681
682 fd = open(path, O_WRONLY | O_NONBLOCK);
683 if (fd < 0) {
684 perror("Could not open consumer control named pipe");
685 goto end;
686 }
687
688 ret = write(fd, &data , sizeof(data));
689 if (ret < 1) {
690 perror("Named pipe write failed");
eff748d0
JR
691 if (close(fd)) {
692 perror("Named pipe close failed");
693 }
434f8068
JR
694 ret = -1;
695 goto end;
696 }
697
698 ret = close(fd);
699 if (ret < 0) {
700 perror("Name pipe closing failed");
701 ret = -1;
702 goto end;
703 }
704end:
705 return ret;
706}
707
f12eb9c1 708static
434f8068
JR
709int stop_consumer(const char **argv)
710{
9df6c82a
JG
711 int ret = 0, i;
712
713 for (i = named_pipe_args_start; i < nb_args; i++) {
434f8068
JR
714 ret = write_pipe(argv[i], 49);
715 }
716 return ret;
717}
718
f12eb9c1 719static
434f8068
JR
720int resume_consumer(const char **argv)
721{
9df6c82a
JG
722 int ret = 0, i;
723
724 for (i = named_pipe_args_start; i < nb_args; i++) {
434f8068
JR
725 ret = write_pipe(argv[i], 0);
726 }
727 return ret;
728}
729
f12eb9c1
SM
730static
731int suspend_application(void)
854382b8
JR
732{
733 int ret;
734 struct stat buf;
735
736 if (!stat(app_state_file, &buf)) {
737 fail("App is already in a suspended state.");
738 ret = -1;
739 goto error;
740 }
741
742 /*
743 * Send SIGUSR1 to application instructing it to bypass tracepoint.
744 */
7344b6a3
FD
745 assert(app_pid > 1);
746
854382b8
JR
747 ret = kill(app_pid, SIGUSR1);
748 if (ret) {
749 fail("SIGUSR1 failed. errno %d", errno);
750 ret = -1;
751 goto error;
752 }
753
754 wait_on_file(app_state_file, true);
755
756error:
757 return ret;
758
759}
760
f12eb9c1 761static
a3ecaea8 762int resume_application(void)
854382b8
JR
763{
764 int ret;
765 struct stat buf;
766
767 ret = stat(app_state_file, &buf);
768 if (ret == -1 && errno == ENOENT) {
769 fail("State file does not exist");
770 goto error;
771 }
772 if (ret) {
773 perror("stat");
774 goto error;
775 }
776
7344b6a3
FD
777 assert(app_pid > 1);
778
854382b8
JR
779 ret = kill(app_pid, SIGUSR1);
780 if (ret) {
781 fail("SIGUSR1 failed. errno %d", errno);
782 ret = -1;
783 goto error;
784 }
785
786 wait_on_file(app_state_file, false);
787
788error:
789 return ret;
790
791}
792
793
f12eb9c1 794static
434f8068
JR
795void test_triggers_buffer_usage_condition(const char *session_name,
796 const char *channel_name,
797 enum lttng_domain_type domain_type,
798 enum lttng_condition_type condition_type)
799{
9df6c82a 800 unsigned int test_vector_size = 5, i;
434f8068
JR
801 enum lttng_condition_status condition_status;
802 struct lttng_action *action;
803
804 /* Set-up */
805 action = lttng_action_notify_create();
806 if (!action) {
807 fail("Setup error on action creation");
808 goto end;
809 }
810
811 /* Test lttng_register_trigger with null value */
812 ok(lttng_register_trigger(NULL) == -LTTNG_ERR_INVALID, "Registering a NULL trigger fails as expected");
813
814 /* Test: register a trigger */
9df6c82a
JG
815
816 for (i = 0; i < pow(2,test_vector_size); i++) {
434f8068
JR
817 int loop_ret = 0;
818 char *test_tuple_string = NULL;
819 unsigned int mask_position = 0;
820 bool session_name_set = false;
821 bool channel_name_set = false;
822 bool threshold_ratio_set = false;
823 bool threshold_byte_set = false;
824 bool domain_type_set = false;
825
826 struct lttng_trigger *trigger = NULL;
827 struct lttng_condition *condition = NULL;
828
829 /* Create base condition */
830 switch (condition_type) {
831 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
832 condition = lttng_condition_buffer_usage_low_create();
833 break;
834 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
835 condition = lttng_condition_buffer_usage_high_create();
836 break;
837 default:
838 loop_ret = 1;
839 goto loop_end;
840 }
841
842 if (!condition) {
843 loop_ret = 1;
844 goto loop_end;
845
846 }
847
848 /* Prepare the condition for trigger registration test */
849
850 /* Set session name */
851 if ((1 << mask_position) & i) {
852 condition_status = lttng_condition_buffer_usage_set_session_name(
853 condition, session_name);
854 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
855 loop_ret = 1;
856 goto loop_end;
857 }
858 session_name_set = true;
859 }
860 mask_position++;
861
862 /* Set channel name */
863 if ((1 << mask_position) & i) {
864 condition_status = lttng_condition_buffer_usage_set_channel_name(
865 condition, channel_name);
866 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
867 loop_ret = 1;
868 goto loop_end;
869 }
870 channel_name_set = true;
871 }
872 mask_position++;
873
874 /* Set threshold ratio */
875 if ((1 << mask_position) & i) {
876 condition_status = lttng_condition_buffer_usage_set_threshold_ratio(
877 condition, 0.0);
878 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
879 loop_ret = 1;
880 goto loop_end;
881 }
882 threshold_ratio_set = true;
883 }
884 mask_position++;
885
886 /* Set threshold byte */
887 if ((1 << mask_position) & i) {
888 condition_status = lttng_condition_buffer_usage_set_threshold(
889 condition, 0);
890 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
891 loop_ret = 1;
892 goto loop_end;
893 }
894 threshold_byte_set = true;
895 }
896 mask_position++;
897
898 /* Set domain type */
899 if ((1 << mask_position) & i) {
900 condition_status = lttng_condition_buffer_usage_set_domain_type(
901 condition, LTTNG_DOMAIN_UST);
902 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
903 loop_ret = 1;
904 goto loop_end;
905 }
906 domain_type_set = true;
907 }
908
909 /* Safety check */
910 if (mask_position != test_vector_size -1) {
911 assert("Logic error for test vector generation");
912 }
913
9479b7a7 914 loop_ret = asprintf(&test_tuple_string, "session name %s, channel name %s, threshold ratio %s, threshold byte %s, domain type %s",
434f8068
JR
915 session_name_set ? "set" : "unset",
916 channel_name_set ? "set" : "unset",
917 threshold_ratio_set ? "set" : "unset",
918 threshold_byte_set ? "set" : "unset",
919 domain_type_set? "set" : "unset");
920 if (!test_tuple_string || loop_ret < 0) {
921 loop_ret = 1;
922 goto loop_end;
923 }
924
925 /* Create trigger */
926 trigger = lttng_trigger_create(condition, action);
927 if (!trigger) {
928 loop_ret = 1;
929 goto loop_end;
930 }
931
932 loop_ret = lttng_register_trigger(trigger);
933
934loop_end:
935 if (loop_ret == 1) {
936 fail("Setup error occurred for tuple: %s", test_tuple_string);
937 goto loop_cleanup;
938 }
939
940 /* This combination happens three times */
941 if (session_name_set && channel_name_set
942 && (threshold_ratio_set || threshold_byte_set)
943 && domain_type_set) {
944 ok(loop_ret == 0, "Trigger is registered: %s", test_tuple_string);
945
946 /*
947 * Test that a trigger cannot be registered
948 * multiple time.
949 */
950 loop_ret = lttng_register_trigger(trigger);
951 ok(loop_ret == -LTTNG_ERR_TRIGGER_EXISTS, "Re-register trigger fails as expected: %s", test_tuple_string);
952
953 /* Test that a trigger can be unregistered */
954 loop_ret = lttng_unregister_trigger(trigger);
955 ok(loop_ret == 0, "Unregister trigger: %s", test_tuple_string);
956
957 /*
958 * Test that unregistration of a non-previously
959 * registered trigger fail.
960 */
961 loop_ret = lttng_unregister_trigger(trigger);
43e0c204 962 ok(loop_ret == -LTTNG_ERR_TRIGGER_NOT_FOUND, "Unregister of a non-registered trigger fails as expected: %s", test_tuple_string);
434f8068
JR
963 } else {
964 ok(loop_ret == -LTTNG_ERR_INVALID_TRIGGER, "Trigger is invalid as expected and cannot be registered: %s", test_tuple_string);
965 }
966
967loop_cleanup:
968 free(test_tuple_string);
969 lttng_trigger_destroy(trigger);
970 lttng_condition_destroy(condition);
971 }
972
973end:
974 lttng_action_destroy(action);
975}
976
ff2b03c8
JG
977static
978void wait_data_pending(const char *session_name)
979{
980 int ret;
981
982 do {
983 ret = lttng_data_pending(session_name);
984 assert(ret >= 0);
985 } while (ret != 0);
986}
987
f12eb9c1 988static
17423302
FD
989int setup_buffer_usage_condition(struct lttng_condition *condition,
990 const char *condition_name,
991 const char *session_name,
992 const char *channel_name,
993 const enum lttng_domain_type domain_type)
994{
995 enum lttng_condition_status condition_status;
996 int ret = 0;
997
998 condition_status = lttng_condition_buffer_usage_set_session_name(
999 condition, session_name);
1000 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
1001 fail("Failed to set session name on creation of condition `%s`",
1002 condition_name);
1003 ret = -1;
1004 goto end;
1005 }
1006
1007 condition_status = lttng_condition_buffer_usage_set_channel_name(
1008 condition, channel_name);
1009 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
1010 fail("Failed to set channel name on creation of condition `%s`",
1011 condition_name);
1012 ret = -1;
1013 goto end;
1014 }
1015
1016 condition_status = lttng_condition_buffer_usage_set_domain_type(
1017 condition, domain_type);
1018 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
1019 fail("Failed to set domain type on creation of condition `%s`",
1020 condition_name);
1021 ret = -1;
1022 goto end;
1023 }
1024
1025end:
1026 return ret;
1027}
1028
1029static
90fcb2ec
FD
1030void test_invalid_channel_subscription(
1031 const enum lttng_domain_type domain_type)
434f8068 1032{
434f8068
JR
1033 enum lttng_condition_status condition_status;
1034 enum lttng_notification_channel_status nc_status;
434f8068 1035 struct lttng_condition *dummy_condition = NULL;
90fcb2ec
FD
1036 struct lttng_condition *dummy_invalid_condition = NULL;
1037 struct lttng_notification_channel *notification_channel = NULL;
1038 int ret = 0;
434f8068 1039
90fcb2ec
FD
1040 notification_channel = lttng_notification_channel_create(
1041 lttng_session_daemon_notification_endpoint);
1042 ok(notification_channel, "Notification channel object creation");
1043 if (!notification_channel) {
434f8068
JR
1044 goto end;
1045 }
1046
90fcb2ec
FD
1047 /*
1048 * Create a dummy, empty (thus invalid) condition to test error paths.
1049 */
434f8068
JR
1050 dummy_invalid_condition = lttng_condition_buffer_usage_low_create();
1051 if (!dummy_invalid_condition) {
1052 fail("Setup error on condition creation");
1053 goto end;
1054 }
1055
90fcb2ec
FD
1056 /*
1057 * Test subscription and unsubscription of an invalid condition to/from
1058 * a channel.
1059 */
1060 nc_status = lttng_notification_channel_subscribe(
1061 notification_channel, dummy_invalid_condition);
1062 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID,
1063 "Subscribing to an invalid condition");
1064
1065 nc_status = lttng_notification_channel_unsubscribe(
1066 notification_channel, dummy_invalid_condition);
1067 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID,
1068 "Unsubscribing from an invalid condition");
1069
434f8068
JR
1070 /* Create a valid dummy condition with a ratio of 0.5 */
1071 dummy_condition = lttng_condition_buffer_usage_low_create();
1072 if (!dummy_condition) {
1073 fail("Setup error on dummy_condition creation");
1074 goto end;
434f8068 1075 }
90fcb2ec 1076
434f8068
JR
1077 condition_status = lttng_condition_buffer_usage_set_threshold_ratio(
1078 dummy_condition, 0.5);
1079 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
1080 fail("Setup error on condition creation");
1081 goto end;
1082 }
1083
17423302 1084 ret = setup_buffer_usage_condition(dummy_condition, "dummy_condition",
90fcb2ec 1085 "dummy_session", "dummy_channel", domain_type);
17423302
FD
1086 if (ret) {
1087 fail("Setup error on dummy condition creation");
434f8068
JR
1088 goto end;
1089 }
1090
90fcb2ec
FD
1091 /*
1092 * Test subscription and unsubscription to/from a channel with invalid
1093 * parameters.
1094 */
1095 nc_status = lttng_notification_channel_subscribe(NULL, NULL);
1096 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID,
1097 "Notification channel subscription is invalid: NULL, NULL");
1098
1099 nc_status = lttng_notification_channel_subscribe(
1100 notification_channel, NULL);
1101 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID,
1102 "Notification channel subscription is invalid: NON-NULL, NULL");
1103
1104 nc_status = lttng_notification_channel_subscribe(NULL, dummy_condition);
1105 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID,
1106 "Notification channel subscription is invalid: NULL, NON-NULL");
1107
1108 nc_status = lttng_notification_channel_unsubscribe(
1109 notification_channel, dummy_condition);
1110 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION,
1111 "Unsubscribing from a valid unknown condition");
1112
1113end:
1114 lttng_notification_channel_destroy(notification_channel);
1115 lttng_condition_destroy(dummy_invalid_condition);
1116 lttng_condition_destroy(dummy_condition);
1117 return;
1118}
1119
3780613c
FD
1120enum buffer_usage_type {
1121 BUFFER_USAGE_TYPE_LOW,
1122 BUFFER_USAGE_TYPE_HIGH,
1123};
1124
1125static int register_buffer_usage_notify_trigger(const char *session_name,
90fcb2ec
FD
1126 const char *channel_name,
1127 const enum lttng_domain_type domain_type,
3780613c
FD
1128 enum buffer_usage_type buffer_usage_type,
1129 double ratio,
1130 struct lttng_condition **condition,
1131 struct lttng_action **action,
1132 struct lttng_trigger **trigger)
90fcb2ec 1133{
90fcb2ec 1134 enum lttng_condition_status condition_status;
3780613c
FD
1135 struct lttng_action *tmp_action = NULL;
1136 struct lttng_condition *tmp_condition = NULL;
1137 struct lttng_trigger *tmp_trigger = NULL;
1138 int ret = 0;
90fcb2ec
FD
1139
1140 /* Set-up */
3780613c 1141 tmp_action = lttng_action_notify_create();
90fcb2ec
FD
1142 if (!action) {
1143 fail("Setup error on action creation");
3780613c
FD
1144 ret = -1;
1145 goto error;
434f8068
JR
1146 }
1147
3780613c
FD
1148 if (buffer_usage_type == BUFFER_USAGE_TYPE_LOW) {
1149 tmp_condition = lttng_condition_buffer_usage_low_create();
1150 } else {
1151 tmp_condition = lttng_condition_buffer_usage_high_create();
434f8068
JR
1152 }
1153
3780613c
FD
1154 if (!tmp_condition) {
1155 fail("Setup error on condition creation");
1156 ret = -1;
1157 goto error;
434f8068
JR
1158 }
1159
3780613c 1160 /* Set the buffer usage threashold */
434f8068 1161 condition_status = lttng_condition_buffer_usage_set_threshold_ratio(
3780613c 1162 tmp_condition, ratio);
434f8068 1163 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
3780613c
FD
1164 fail("Setup error on condition creation");
1165 ret = -1;
1166 goto error;
434f8068
JR
1167 }
1168
3780613c 1169 ret = setup_buffer_usage_condition(tmp_condition, "condition_name",
17423302
FD
1170 session_name, channel_name, domain_type);
1171 if (ret) {
3780613c
FD
1172 fail("Setup error on condition creation");
1173 ret = -1;
1174 goto error;
434f8068
JR
1175 }
1176
3780613c
FD
1177 /* Register the trigger for condition. */
1178 tmp_trigger = lttng_trigger_create(tmp_condition, tmp_action);
1179 if (!tmp_trigger) {
1180 fail("Setup error on trigger creation");
1181 ret = -1;
1182 goto error;
434f8068
JR
1183 }
1184
3780613c 1185 ret = lttng_register_trigger(tmp_trigger);
434f8068 1186 if (ret) {
3780613c
FD
1187 fail("Setup error on trigger registration");
1188 ret = -1;
1189 goto error;
434f8068
JR
1190 }
1191
3780613c
FD
1192 *condition = tmp_condition;
1193 *trigger = tmp_trigger;
1194 *action = tmp_action;
1195 goto end;
434f8068 1196
3780613c
FD
1197error:
1198 lttng_action_destroy(tmp_action);
1199 lttng_condition_destroy(tmp_condition);
1200 lttng_trigger_destroy(tmp_trigger);
1201
1202end:
1203 return ret;
1204}
1205
fa448dbe
FD
1206static void test_subscription_twice(const char *session_name,
1207 const char *channel_name,
1208 const enum lttng_domain_type domain_type)
1209{
1210 int ret = 0;
1211 enum lttng_notification_channel_status nc_status;
1212
1213 struct lttng_action *action = NULL;
1214 struct lttng_notification_channel *notification_channel = NULL;
1215 struct lttng_trigger *trigger = NULL;
1216
1217 struct lttng_condition *condition = NULL;
1218
1219 ret = register_buffer_usage_notify_trigger(session_name, channel_name,
1220 domain_type, BUFFER_USAGE_TYPE_LOW, 0.99, &condition,
1221 &action, &trigger);
1222 if (ret) {
1223 fail("Setup error on trigger registration");
1224 goto end;
1225 }
1226
1227 /* Begin testing. */
1228 notification_channel = lttng_notification_channel_create(
1229 lttng_session_daemon_notification_endpoint);
1230 ok(notification_channel, "Notification channel object creation");
1231 if (!notification_channel) {
1232 goto end;
1233 }
1234
1235 /* Subscribe a valid condition. */
1236 nc_status = lttng_notification_channel_subscribe(
1237 notification_channel, condition);
1238 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1239 "Subscribe to condition");
1240
1241 /* Subscribing again should fail. */
1242 nc_status = lttng_notification_channel_subscribe(
1243 notification_channel, condition);
1244 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED,
1245 "Subscribe to a condition for which subscription was already done");
1246
1247end:
1248 lttng_unregister_trigger(trigger);
1249 lttng_trigger_destroy(trigger);
1250 lttng_notification_channel_destroy(notification_channel);
1251 lttng_action_destroy(action);
1252 lttng_condition_destroy(condition);
1253}
1254
40ac6709 1255static void test_buffer_usage_notification_channel(const char *session_name,
3780613c
FD
1256 const char *channel_name,
1257 const enum lttng_domain_type domain_type,
1258 const char **argv)
1259{
1260 int ret = 0;
1261 enum lttng_notification_channel_status nc_status;
1262
1263 struct lttng_action *low_action = NULL;
1264 struct lttng_action *high_action = NULL;
1265 struct lttng_notification *notification = NULL;
1266 struct lttng_notification_channel *notification_channel = NULL;
1267 struct lttng_trigger *low_trigger = NULL;
1268 struct lttng_trigger *high_trigger = NULL;
1269
1270 struct lttng_condition *low_condition = NULL;
1271 struct lttng_condition *high_condition = NULL;
1272
1273 const double low_ratio = 0.0;
1274 const double high_ratio = 0.90;
1275
1276 ret = register_buffer_usage_notify_trigger(session_name, channel_name,
1277 domain_type, BUFFER_USAGE_TYPE_LOW, low_ratio,
1278 &low_condition, &low_action, &low_trigger);
1279 if (ret) {
1280 fail("Setup error on low trigger registration");
434f8068
JR
1281 goto end;
1282 }
1283
3780613c
FD
1284 ret = register_buffer_usage_notify_trigger(session_name, channel_name,
1285 domain_type, BUFFER_USAGE_TYPE_HIGH, high_ratio,
1286 &high_condition, &high_action, &high_trigger);
434f8068
JR
1287 if (ret) {
1288 fail("Setup error on high trigger registration");
1289 goto end;
1290 }
1291
1292 /* Begin testing */
a6ae2480
FD
1293 notification_channel = lttng_notification_channel_create(
1294 lttng_session_daemon_notification_endpoint);
434f8068
JR
1295 ok(notification_channel, "Notification channel object creation");
1296 if (!notification_channel) {
1297 goto end;
1298 }
1299
434f8068 1300 /* Subscribe a valid low condition */
a6ae2480
FD
1301 nc_status = lttng_notification_channel_subscribe(
1302 notification_channel, low_condition);
1303 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
40ac6709 1304 "Subscribe to low condition");
434f8068
JR
1305
1306 /* Subscribe a valid high condition */
a6ae2480
FD
1307 nc_status = lttng_notification_channel_subscribe(
1308 notification_channel, high_condition);
1309 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
40ac6709 1310 "Subscribe to high condition");
434f8068 1311
7676e0d2
FD
1312 resume_application();
1313
434f8068 1314 /* Wait for notification to happen */
434f8068 1315 stop_consumer(argv);
ff2b03c8 1316 lttng_start_tracing(session_name);
434f8068
JR
1317
1318 /* Wait for high notification */
67c93c15 1319 do {
a6ae2480
FD
1320 nc_status = lttng_notification_channel_get_next_notification(
1321 notification_channel, &notification);
67c93c15 1322 } while (nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED);
a6ae2480
FD
1323 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&
1324 lttng_condition_get_type(lttng_notification_get_condition(
1325 notification)) ==
1326 LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH,
434f8068
JR
1327 "High notification received after intermediary communication");
1328 lttng_notification_destroy(notification);
1329 notification = NULL;
1330
854382b8 1331 suspend_application();
ff2b03c8 1332 lttng_stop_tracing_no_wait(session_name);
434f8068 1333 resume_consumer(argv);
ff2b03c8 1334 wait_data_pending(session_name);
434f8068
JR
1335
1336 /*
1337 * Test that communication still work even if there is notification
1338 * waiting for consumption.
1339 */
1340
a6ae2480
FD
1341 nc_status = lttng_notification_channel_unsubscribe(
1342 notification_channel, low_condition);
1343 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1344 "Unsubscribe with pending notification");
434f8068 1345
a6ae2480
FD
1346 nc_status = lttng_notification_channel_subscribe(
1347 notification_channel, low_condition);
1348 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1349 "Subscribe with pending notification");
434f8068 1350
67c93c15 1351 do {
a6ae2480
FD
1352 nc_status = lttng_notification_channel_get_next_notification(
1353 notification_channel, &notification);
67c93c15 1354 } while (nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED);
a6ae2480
FD
1355 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&
1356 lttng_condition_get_type(lttng_notification_get_condition(
1357 notification)) ==
1358 LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW,
434f8068
JR
1359 "Low notification received after intermediary communication");
1360 lttng_notification_destroy(notification);
1361 notification = NULL;
1362
1363 /* Stop consumer to force a high notification */
ff2b03c8 1364 stop_consumer(argv);
854382b8 1365 resume_application();
434f8068 1366 lttng_start_tracing(session_name);
434f8068 1367
67c93c15 1368 do {
a6ae2480
FD
1369 nc_status = lttng_notification_channel_get_next_notification(
1370 notification_channel, &notification);
67c93c15 1371 } while (nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED);
434f8068 1372 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&
a6ae2480
FD
1373 lttng_condition_get_type(lttng_notification_get_condition(
1374 notification)) ==
1375 LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH,
434f8068
JR
1376 "High notification received after intermediary communication");
1377 lttng_notification_destroy(notification);
1378 notification = NULL;
1379
854382b8 1380 suspend_application();
ff2b03c8 1381 lttng_stop_tracing_no_wait(session_name);
434f8068 1382 resume_consumer(argv);
ff2b03c8 1383 wait_data_pending(session_name);
434f8068 1384
67c93c15 1385 do {
a6ae2480
FD
1386 nc_status = lttng_notification_channel_get_next_notification(
1387 notification_channel, &notification);
67c93c15 1388 } while (nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED);
434f8068 1389 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&
a6ae2480
FD
1390 lttng_condition_get_type(lttng_notification_get_condition(
1391 notification)) ==
1392 LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW,
434f8068
JR
1393 "Low notification received after re-subscription");
1394 lttng_notification_destroy(notification);
1395 notification = NULL;
1396
ff2b03c8 1397 stop_consumer(argv);
854382b8 1398 resume_application();
434f8068
JR
1399 /* Stop consumer to force a high notification */
1400 lttng_start_tracing(session_name);
434f8068 1401
67c93c15 1402 do {
a6ae2480
FD
1403 nc_status = lttng_notification_channel_get_next_notification(
1404 notification_channel, &notification);
67c93c15 1405 } while (nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED);
434f8068 1406 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&
a6ae2480
FD
1407 lttng_condition_get_type(lttng_notification_get_condition(
1408 notification)) ==
1409 LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH,
434f8068
JR
1410 "High notification");
1411 lttng_notification_destroy(notification);
1412 notification = NULL;
1413
ff2b03c8 1414 suspend_application();
7676e0d2
FD
1415
1416 /* Resume consumer to allow event consumption */
ff2b03c8 1417 lttng_stop_tracing_no_wait(session_name);
434f8068 1418 resume_consumer(argv);
ff2b03c8 1419 wait_data_pending(session_name);
434f8068 1420
a6ae2480
FD
1421 nc_status = lttng_notification_channel_unsubscribe(
1422 notification_channel, low_condition);
1423 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1424 "Unsubscribe low condition with pending notification");
1425
1426 nc_status = lttng_notification_channel_unsubscribe(
1427 notification_channel, high_condition);
1428 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1429 "Unsubscribe high condition with pending notification");
434f8068
JR
1430
1431end:
1432 lttng_notification_channel_destroy(notification_channel);
3780613c
FD
1433 lttng_trigger_destroy(low_trigger);
1434 lttng_trigger_destroy(high_trigger);
1435 lttng_action_destroy(low_action);
1436 lttng_action_destroy(high_action);
434f8068 1437 lttng_condition_destroy(low_condition);
eff748d0 1438 lttng_condition_destroy(high_condition);
434f8068
JR
1439}
1440
7948461b
FD
1441static void create_tracepoint_event_rule_trigger(const char *event_pattern,
1442 const char *trigger_name,
1443 const char *filter,
1444 unsigned int exclusion_count,
3e4ee3b3 1445 const char * const *exclusions,
7948461b 1446 enum lttng_domain_type domain_type,
26e2f47b 1447 condition_capture_desc_cb capture_desc_cb,
7948461b
FD
1448 struct lttng_condition **condition,
1449 struct lttng_trigger **trigger)
1450{
1451 enum lttng_event_rule_status event_rule_status;
1452 enum lttng_trigger_status trigger_status;
1453
1454 struct lttng_action *tmp_action = NULL;
1455 struct lttng_event_rule *event_rule = NULL;
1456 struct lttng_condition *tmp_condition = NULL;
1457 struct lttng_trigger *tmp_trigger = NULL;
1458 int ret;
1459
1460 assert(event_pattern);
1461 assert(trigger_name);
1462 assert(condition);
1463 assert(trigger);
1464
1465 event_rule = lttng_event_rule_tracepoint_create(domain_type);
1466 ok(event_rule, "Tracepoint event rule object creation");
1467
1468 event_rule_status = lttng_event_rule_tracepoint_set_pattern(
1469 event_rule, event_pattern);
1470 ok(event_rule_status == LTTNG_EVENT_RULE_STATUS_OK,
1471 "Setting tracepoint event rule pattern: '%s'",
1472 event_pattern);
1473
1474 if (filter) {
1475 event_rule_status = lttng_event_rule_tracepoint_set_filter(
1476 event_rule, filter);
1477 ok(event_rule_status == LTTNG_EVENT_RULE_STATUS_OK,
1478 "Setting tracepoint event rule filter: '%s'",
1479 filter);
1480 }
1481
1482 if (exclusions) {
1483 int i;
1484 bool success = true;
1485
1486 assert(domain_type == LTTNG_DOMAIN_UST);
1487 assert(exclusion_count > 0);
1488
1489 for (i = 0; i < exclusion_count; i++) {
1490 event_rule_status =
1491 lttng_event_rule_tracepoint_add_exclusion(
1492 event_rule,
1493 exclusions[i]);
1494 if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
1495 fail("Setting tracepoint event rule exclusion '%s'.",
1496 exclusions[i]);
1497 success = false;
1498 }
1499 }
1500
1501 ok(success, "Setting tracepoint event rule exclusions");
1502 }
1503
8dbb86b8 1504 tmp_condition = lttng_condition_event_rule_matches_create(event_rule);
7948461b
FD
1505 ok(tmp_condition, "Condition event rule object creation");
1506
26e2f47b
JR
1507 if (capture_desc_cb) {
1508 ret = capture_desc_cb(tmp_condition);
1509 if (ret) {
1510 fail("Failed to generate the condition capture descriptor");
1511 abort();
1512 }
1513 }
1514
7948461b
FD
1515 tmp_action = lttng_action_notify_create();
1516 ok(tmp_action, "Action event rule object creation");
1517
1518 tmp_trigger = lttng_trigger_create(tmp_condition, tmp_action);
1519 ok(tmp_trigger, "Trigger object creation %s", trigger_name);
1520
1521 trigger_status = lttng_trigger_set_name(tmp_trigger, trigger_name);
1522 ok(trigger_status == LTTNG_TRIGGER_STATUS_OK,
1523 "Setting name to trigger %s", trigger_name);
1524
1525 ret = lttng_register_trigger(tmp_trigger);
1526 ok(ret == 0, "Trigger registration %s", trigger_name);
1527
1528 lttng_event_rule_destroy(event_rule);
1529
1530 *condition = tmp_condition;
1531 *trigger = tmp_trigger;
1532
1533 return;
1534}
1535
d150e7e5 1536static struct lttng_notification *get_next_notification(
7948461b
FD
1537 struct lttng_notification_channel *notification_channel)
1538{
d150e7e5 1539 struct lttng_notification *local_notification = NULL;
7948461b 1540 enum lttng_notification_channel_status status;
7948461b
FD
1541
1542 /* Receive the next notification. */
1543 status = lttng_notification_channel_get_next_notification(
d150e7e5 1544 notification_channel, &local_notification);
7948461b
FD
1545
1546 switch (status) {
1547 case LTTNG_NOTIFICATION_CHANNEL_STATUS_OK:
1548 break;
d150e7e5
JR
1549 case LTTNG_NOTIFICATION_CHANNEL_STATUS_NOTIFICATIONS_DROPPED:
1550 fail("Notifications have been dropped");
1551 local_notification = NULL;
7948461b
FD
1552 break;
1553 default:
d150e7e5
JR
1554 /* Unhandled conditions / errors. */
1555 fail("Failed to get next notification (unknown notification channel status): status = %d",
1556 (int) status);
1557 local_notification = NULL;
7948461b
FD
1558 break;
1559 }
1560
d150e7e5 1561 return local_notification;
7948461b
FD
1562}
1563
1564static void test_tracepoint_event_rule_notification(
1565 enum lttng_domain_type domain_type)
1566{
1567 int i;
d150e7e5 1568 int ret;
7948461b
FD
1569 const int notification_count = 3;
1570 enum lttng_notification_channel_status nc_status;
1571 struct lttng_action *action = NULL;
1572 struct lttng_condition *condition = NULL;
1573 struct lttng_notification_channel *notification_channel = NULL;
1574 struct lttng_trigger *trigger = NULL;
1575 const char * const trigger_name = "my_precious";
1576 const char *pattern;
1577
1578 if (domain_type == LTTNG_DOMAIN_UST) {
1579 pattern = "tp:tptest";
1580 } else {
1581 pattern = "lttng_test_filter_event";
1582 }
1583
1584 create_tracepoint_event_rule_trigger(pattern, trigger_name, NULL, 0,
26e2f47b 1585 NULL, domain_type, NULL, &condition, &trigger);
7948461b
FD
1586
1587 notification_channel = lttng_notification_channel_create(
1588 lttng_session_daemon_notification_endpoint);
1589 ok(notification_channel, "Notification channel object creation");
1590
1591 nc_status = lttng_notification_channel_subscribe(
1592 notification_channel, condition);
1593 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1594 "Subscribe to tracepoint event rule condition");
1595
1596 resume_application();
1597
d150e7e5 1598 /* Get notifications. */
7948461b 1599 for (i = 0; i < notification_count; i++) {
d150e7e5 1600 struct lttng_notification *notification = get_next_notification(
7948461b
FD
1601 notification_channel);
1602
d150e7e5
JR
1603 ok(notification, "Received notification (%d/%d)", i + 1,
1604 notification_count);
1605
1606 /* Error. */
1607 if (notification == NULL) {
1608 goto end;
1609 }
1610
1611 ret = validator_notification_trigger_name(notification, trigger_name);
1612 lttng_notification_destroy(notification);
1613 if (ret) {
1614 goto end;
1615 }
7948461b
FD
1616 }
1617
d150e7e5 1618end:
7948461b
FD
1619 suspend_application();
1620 lttng_notification_channel_destroy(notification_channel);
1621 lttng_unregister_trigger(trigger);
1622 lttng_trigger_destroy(trigger);
1623 lttng_action_destroy(action);
1624 lttng_condition_destroy(condition);
1625 return;
1626}
1627
a740a242
FD
1628static void test_tracepoint_event_rule_notification_filter(
1629 enum lttng_domain_type domain_type)
1630{
1631 int i;
d150e7e5 1632 const int notification_count = 3;
a740a242 1633 enum lttng_notification_channel_status nc_status;
a740a242
FD
1634 struct lttng_condition *ctrl_condition = NULL, *condition = NULL;
1635 struct lttng_notification_channel *notification_channel = NULL;
1636 struct lttng_trigger *ctrl_trigger = NULL, *trigger = NULL;
1637 const char * const ctrl_trigger_name = "control_trigger";
1638 const char * const trigger_name = "trigger";
1639 const char *pattern;
1640 int ctrl_count = 0, count = 0;
1641
1642 if (domain_type == LTTNG_DOMAIN_UST) {
1643 pattern = "tp:tptest";
1644 } else {
1645 pattern = "lttng_test_filter_event";
1646 }
1647
1648 notification_channel = lttng_notification_channel_create(
1649 lttng_session_daemon_notification_endpoint);
1650 ok(notification_channel, "Notification channel object creation");
1651
1652 create_tracepoint_event_rule_trigger(pattern, ctrl_trigger_name, NULL,
26e2f47b 1653 0, NULL, domain_type, NULL, &ctrl_condition, &ctrl_trigger);
a740a242
FD
1654
1655 nc_status = lttng_notification_channel_subscribe(
1656 notification_channel, ctrl_condition);
1657 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1658 "Subscribe to tracepoint event rule condition");
1659
1660 /*
1661 * Attach a filter expression to get notification only if the
1662 * `intfield` is even.
1663 */
1664 create_tracepoint_event_rule_trigger(pattern, trigger_name,
26e2f47b 1665 "(intfield & 1) == 0", 0, NULL, domain_type, NULL, &condition,
a740a242
FD
1666 &trigger);
1667
1668 nc_status = lttng_notification_channel_subscribe(
1669 notification_channel, condition);
1670 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1671 "Subscribe to tracepoint event rule condition");
1672
1673 /*
1674 * We registered 2 notifications triggers, one with a filter and one
1675 * without (control). The one with a filter will only fired when the
1676 * `intfield` is a multiple of 2. We should get two times as many
1677 * control notifications as filter notifications.
1678 */
1679 resume_application();
1680
1681 /*
1682 * Get 3 notifications. We should get 1 for the regular trigger (with
1683 * the filter) and 2 from the control trigger. This works whatever
1684 * the order we receive the notifications.
1685 */
d150e7e5
JR
1686 for (i = 0; i < notification_count; i++) {
1687 const char *name;
1688 struct lttng_notification *notification = get_next_notification(
a740a242
FD
1689 notification_channel);
1690
d150e7e5
JR
1691 ok(notification, "Received notification (%d/%d)", i + 1,
1692 notification_count);
1693
1694 /* Error. */
1695 if (notification == NULL) {
1696 goto end;
1697 }
1698
1699 name = get_notification_trigger_name(notification);
1700 if (name == NULL) {
1701 lttng_notification_destroy(notification);
1702 goto end;
1703 }
1704
a740a242
FD
1705 if (strcmp(ctrl_trigger_name, name) == 0) {
1706 ctrl_count++;
1707 } else if (strcmp(trigger_name, name) == 0) {
1708 count++;
1709 }
1710
d150e7e5 1711 lttng_notification_destroy(notification);
a740a242
FD
1712 }
1713
1714 ok(ctrl_count / 2 == count,
1715 "Get twice as many control notif as of regular notif");
1716
d150e7e5 1717end:
a740a242
FD
1718 suspend_application();
1719
1720 lttng_unregister_trigger(trigger);
1721 lttng_unregister_trigger(ctrl_trigger);
1722 lttng_notification_channel_destroy(notification_channel);
1723 lttng_trigger_destroy(trigger);
1724 lttng_trigger_destroy(ctrl_trigger);
1725 lttng_condition_destroy(condition);
1726 lttng_condition_destroy(ctrl_condition);
1727}
1728
3e4ee3b3
FD
1729static void test_tracepoint_event_rule_notification_exclusion(
1730 enum lttng_domain_type domain_type)
1731{
1732 enum lttng_notification_channel_status nc_status;
1733 struct lttng_condition *ctrl_condition = NULL, *condition = NULL;
1734 struct lttng_notification_channel *notification_channel = NULL;
1735 struct lttng_trigger *ctrl_trigger = NULL, *trigger = NULL;
1736 int ctrl_count = 0, count = 0, i;
d150e7e5 1737 const int notification_count = 6;
3e4ee3b3
FD
1738 const char * const ctrl_trigger_name = "control_exclusion_trigger";
1739 const char * const trigger_name = "exclusion_trigger";
1740 const char * const pattern = "tp:tptest*";
1741 const char * const exclusions[] = {
1742 "tp:tptest2",
1743 "tp:tptest3",
1744 "tp:tptest4",
1745 "tp:tptest5"
1746 };
1747
1748 notification_channel = lttng_notification_channel_create(
1749 lttng_session_daemon_notification_endpoint);
1750 ok(notification_channel, "Notification channel object creation");
1751
1752 create_tracepoint_event_rule_trigger(pattern, ctrl_trigger_name, NULL,
26e2f47b
JR
1753 0, NULL, domain_type, NULL, &ctrl_condition,
1754 &ctrl_trigger);
3e4ee3b3
FD
1755
1756 nc_status = lttng_notification_channel_subscribe(
1757 notification_channel, ctrl_condition);
1758 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1759 "Subscribe to tracepoint event rule condition");
1760
1761 create_tracepoint_event_rule_trigger(pattern, trigger_name, NULL, 4,
26e2f47b
JR
1762 exclusions, domain_type, NULL, &condition,
1763 &trigger);
3e4ee3b3
FD
1764
1765 nc_status = lttng_notification_channel_subscribe(
1766 notification_channel, condition);
1767 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1768 "Subscribe to tracepoint event rule condition");
1769
1770 /*
1771 * We registered 2 notifications triggers, one with an exclusion and
1772 * one without (control).
1773 * - The trigger with an exclusion will fire once every iteration.
1774 * - The trigger without an exclusion will fire 5 times every
1775 * iteration.
1776 *
1777 * We should get 5 times as many notifications from the control
1778 * trigger.
1779 */
1780 resume_application();
1781
1782 /*
1783 * Get 6 notifications. We should get 1 for the regular trigger (with
1784 * the exclusion) and 5 from the control trigger. This works whatever
1785 * the order we receive the notifications.
1786 */
d150e7e5
JR
1787 for (i = 0; i < notification_count; i++) {
1788 const char *name;
1789 struct lttng_notification *notification = get_next_notification(
3e4ee3b3
FD
1790 notification_channel);
1791
d150e7e5
JR
1792 ok(notification, "Received notification (%d/%d)", i + 1,
1793 notification_count);
1794
1795 /* Error. */
1796 if (notification == NULL) {
1797 goto end;
1798 }
1799
1800 name = get_notification_trigger_name(notification);
1801 if (name == NULL) {
1802 lttng_notification_destroy(notification);
1803 goto end;
1804 }
1805
3e4ee3b3
FD
1806 if (strcmp(ctrl_trigger_name, name) == 0) {
1807 ctrl_count++;
1808 } else if (strcmp(trigger_name, name) == 0) {
1809 count++;
1810 }
1811
d150e7e5 1812 lttng_notification_destroy(notification);
3e4ee3b3
FD
1813 }
1814
1815 ok(ctrl_count / 5 == count,
1816 "Got 5 times as many control notif as of regular notif");
1817
d150e7e5 1818end:
3e4ee3b3
FD
1819 suspend_application();
1820
1821 lttng_unregister_trigger(trigger);
1822 lttng_unregister_trigger(ctrl_trigger);
1823 lttng_notification_channel_destroy(notification_channel);
1824 lttng_trigger_destroy(trigger);
1825 lttng_trigger_destroy(ctrl_trigger);
1826 lttng_condition_destroy(condition);
1827 lttng_condition_destroy(ctrl_condition);
1828 return;
1829}
1830
51704c8e
FD
1831static void test_kprobe_event_rule_notification(
1832 enum lttng_domain_type domain_type)
1833{
1834 int i, ret;
1835 const int notification_count = 3;
1836 enum lttng_notification_channel_status nc_status;
1837 enum lttng_event_rule_status event_rule_status;
1838 enum lttng_trigger_status trigger_status;
1839 struct lttng_notification_channel *notification_channel = NULL;
1840 struct lttng_condition *condition = NULL;
1841 struct lttng_kernel_probe_location *location = NULL;
1842 struct lttng_event_rule *event_rule = NULL;
1843 struct lttng_action *action = NULL;
1844 struct lttng_trigger *trigger = NULL;
1845 const char * const trigger_name = "kprobe_trigger";
1846 const char * const symbol_name = "lttng_test_filter_event_write";
1847
1848 action = lttng_action_notify_create();
1849 if (!action) {
1850 fail("Failed to create notify action");
1851 goto end;
1852 }
1853
1854 location = lttng_kernel_probe_location_symbol_create(symbol_name, 0);
1855 if (!location) {
1856 fail("Failed to create kernel probe location");
1857 goto end;
1858 }
1859
1860 notification_channel = lttng_notification_channel_create(
1861 lttng_session_daemon_notification_endpoint);
1862 ok(notification_channel, "Notification channel object creation");
1863
602a6d40 1864 event_rule = lttng_event_rule_kernel_probe_create(location);
51704c8e
FD
1865 ok(event_rule, "kprobe event rule object creation");
1866
d891bb52 1867 event_rule_status = lttng_event_rule_kernel_probe_set_event_name(
51704c8e
FD
1868 event_rule, trigger_name);
1869 ok(event_rule_status == LTTNG_EVENT_RULE_STATUS_OK,
1870 "Setting kprobe event rule name: '%s'", trigger_name);
1871
8dbb86b8 1872 condition = lttng_condition_event_rule_matches_create(event_rule);
51704c8e
FD
1873 ok(condition, "Condition event rule object creation");
1874
1875 /* Register the trigger for condition. */
1876 trigger = lttng_trigger_create(condition, action);
1877 if (!trigger) {
1878 fail("Failed to create trigger with kernel probe event rule condition and notify action");
1879 goto end;
1880 }
1881
1882 trigger_status = lttng_trigger_set_name(trigger, trigger_name);
1883 ok(trigger_status == LTTNG_TRIGGER_STATUS_OK,
1884 "Setting trigger name to '%s'", trigger_name);
1885
1886 ret = lttng_register_trigger(trigger);
1887 if (ret) {
1888 fail("Failed to register trigger with kernel probe event rule condition and notify action");
1889 goto end;
1890 }
1891
1892 nc_status = lttng_notification_channel_subscribe(
1893 notification_channel, condition);
1894 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
1895 "Subscribe to tracepoint event rule condition");
1896
1897 resume_application();
1898
1899 for (i = 0; i < notification_count; i++) {
d150e7e5 1900 struct lttng_notification *notification = get_next_notification(
51704c8e
FD
1901 notification_channel);
1902
d150e7e5
JR
1903 ok(notification, "Received notification (%d/%d)", i + 1,
1904 notification_count);
1905
1906 /* Error. */
1907 if (notification == NULL) {
1908 goto end;
1909 }
1910
1911 ret = validator_notification_trigger_name(notification, trigger_name);
1912 lttng_notification_destroy(notification);
1913 if (ret) {
1914 goto end;
1915 }
51704c8e
FD
1916 }
1917
1918end:
1919 suspend_application();
1920 lttng_notification_channel_destroy(notification_channel);
1921 lttng_unregister_trigger(trigger);
1922 lttng_trigger_destroy(trigger);
1923 lttng_action_destroy(action);
aab0598f 1924 lttng_event_rule_destroy(event_rule);
51704c8e
FD
1925 lttng_condition_destroy(condition);
1926 lttng_kernel_probe_location_destroy(location);
1927 return;
1928}
1929
45294d8a
FD
1930static void test_uprobe_event_rule_notification(
1931 enum lttng_domain_type domain_type,
1932 const char *testapp_path,
1933 const char *test_symbol_name)
1934{
1935 int i, ret;
1936 const int notification_count = 3;
1937 enum lttng_notification_channel_status nc_status;
1938 enum lttng_event_rule_status event_rule_status;
1939 enum lttng_trigger_status trigger_status;
1940 struct lttng_notification_channel *notification_channel = NULL;
1941 struct lttng_userspace_probe_location *probe_location = NULL;
1942 struct lttng_userspace_probe_location_lookup_method *lookup_method =
1943 NULL;
1944 struct lttng_condition *condition = NULL;
1945 struct lttng_event_rule *event_rule = NULL;
1946 struct lttng_action *action = NULL;
1947 struct lttng_trigger *trigger = NULL;
1948 const char * const trigger_name = "uprobe_trigger";
1949
1950 action = lttng_action_notify_create();
1951 if (!action) {
1952 fail("Failed to create notify action");
1953 goto end;
1954 }
1955
1956 lookup_method = lttng_userspace_probe_location_lookup_method_function_elf_create();
1957 if (!lookup_method) {
1958 fail("Setup error on userspace probe lookup method creation");
1959 goto end;
1960 }
1961
1962 probe_location = lttng_userspace_probe_location_function_create(
1963 testapp_path, test_symbol_name, lookup_method);
1964 if (!probe_location) {
1965 fail("Failed to create userspace probe location");
1966 goto end;
1967 }
1968
1969 notification_channel = lttng_notification_channel_create(
1970 lttng_session_daemon_notification_endpoint);
1971 ok(notification_channel, "Notification channel object creation");
1972
10685de6 1973 event_rule = lttng_event_rule_userspace_probe_create(probe_location);
45294d8a
FD
1974 ok(event_rule, "kprobe event rule object creation");
1975
405f9e7d 1976 event_rule_status = lttng_event_rule_userspace_probe_set_event_name(
45294d8a
FD
1977 event_rule, trigger_name);
1978 ok(event_rule_status == LTTNG_EVENT_RULE_STATUS_OK,
1979 "Setting uprobe event rule name: '%s'", trigger_name);
1980
8dbb86b8 1981 condition = lttng_condition_event_rule_matches_create(event_rule);
45294d8a
FD
1982 ok(condition, "Condition event rule object creation");
1983
1984 /* Register the trigger for condition. */
1985 trigger = lttng_trigger_create(condition, action);
1986 if (!trigger) {
1987 fail("Failed to create trigger with userspace probe event rule condition and notify action");
1988 goto end;
1989 }
1990
1991 trigger_status = lttng_trigger_set_name(trigger, trigger_name);
1992 ok(trigger_status == LTTNG_TRIGGER_STATUS_OK,
1993 "Setting name to trigger '%s'", trigger_name);
1994
1995 ret = lttng_register_trigger(trigger);
1996 if (ret) {
1997 fail("Failed to register trigger with userspace probe event rule condition and notify action");
1998 goto end;
1999 }
2000
2001 nc_status = lttng_notification_channel_subscribe(
2002 notification_channel, condition);
2003 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
2004 "Subscribe to tracepoint event rule condition");
2005
2006 resume_application();
2007
d150e7e5
JR
2008 for (i = 0; i < 3; i++) {
2009 struct lttng_notification *notification = get_next_notification(
45294d8a
FD
2010 notification_channel);
2011
d150e7e5
JR
2012 ok(notification, "Received notification (%d/%d)", i + 1,
2013 notification_count);
2014
2015 /* Error. */
2016 if (notification == NULL) {
2017 goto end;
2018 }
2019
2020 ret = validator_notification_trigger_name(notification, trigger_name);
2021 lttng_notification_destroy(notification);
2022 if (ret) {
2023 goto end;
2024 }
45294d8a
FD
2025 }
2026end:
2027 suspend_application();
2028
2029 lttng_notification_channel_destroy(notification_channel);
2030 lttng_unregister_trigger(trigger);
2031 lttng_trigger_destroy(trigger);
2032 lttng_action_destroy(action);
a877d1b5 2033 lttng_userspace_probe_location_destroy(probe_location);
45294d8a
FD
2034 lttng_event_rule_destroy(event_rule);
2035 lttng_condition_destroy(condition);
2036 return;
2037}
2038
aab0598f
FD
2039static void test_syscall_event_rule_notification(
2040 enum lttng_domain_type domain_type)
2041{
2042 int i, ret;
2043 const int notification_count = 3;
2044 enum lttng_notification_channel_status nc_status;
2045 enum lttng_event_rule_status event_rule_status;
2046 enum lttng_trigger_status trigger_status;
2047 struct lttng_notification_channel *notification_channel = NULL;
2048 struct lttng_condition *condition = NULL;
2049 struct lttng_event_rule *event_rule = NULL;
2050 struct lttng_action *action = NULL;
2051 struct lttng_trigger *trigger = NULL;
2052 const char * const trigger_name = "syscall_trigger";
2053 const char * const syscall_name = "openat";
2054
2055 action = lttng_action_notify_create();
2056 if (!action) {
2057 fail("Failed to create notify action");
2058 goto end;
2059 }
2060
2061 notification_channel = lttng_notification_channel_create(
2062 lttng_session_daemon_notification_endpoint);
2063 ok(notification_channel, "Notification channel object creation");
2064
57739a6b 2065 event_rule = lttng_event_rule_syscall_create(LTTNG_EVENT_RULE_SYSCALL_EMISSION_SITE_ENTRY);
aab0598f
FD
2066 ok(event_rule, "syscall event rule object creation");
2067
2068 event_rule_status = lttng_event_rule_syscall_set_pattern(
2069 event_rule, syscall_name);
2070 ok(event_rule_status == LTTNG_EVENT_RULE_STATUS_OK,
2071 "Setting syscall event rule pattern: '%s'", syscall_name);
2072
8dbb86b8 2073 condition = lttng_condition_event_rule_matches_create(event_rule);
aab0598f
FD
2074 ok(condition, "Condition syscall event rule object creation");
2075
2076 /* Register the trigger for condition. */
2077 trigger = lttng_trigger_create(condition, action);
2078 if (!trigger) {
2079 fail("Failed to create trigger with syscall event rule condition and notify action");
2080 goto end;
2081 }
2082
2083 trigger_status = lttng_trigger_set_name(trigger, trigger_name);
2084 ok(trigger_status == LTTNG_TRIGGER_STATUS_OK,
2085 "Setting name to trigger '%s'", trigger_name);
2086
2087 ret = lttng_register_trigger(trigger);
2088 if (ret) {
2089 fail("Failed to register trigger with syscall event rule condition and notify action");
2090 goto end;
2091 }
2092
2093 nc_status = lttng_notification_channel_subscribe(
2094 notification_channel, condition);
2095 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
2096 "Subscribe to tracepoint event rule condition");
2097
2098 resume_application();
2099
2100 for (i = 0; i < notification_count; i++) {
d150e7e5 2101 struct lttng_notification *notification = get_next_notification(
aab0598f
FD
2102 notification_channel);
2103
d150e7e5
JR
2104 ok(notification, "Received notification (%d/%d)", i + 1,
2105 notification_count);
2106
2107 /* Error. */
2108 if (notification == NULL) {
2109 goto end;
2110 }
2111
2112 ret = validator_notification_trigger_name(notification, trigger_name);
2113 lttng_notification_destroy(notification);
2114 if (ret) {
2115 goto end;
2116 }
aab0598f
FD
2117 }
2118end:
2119 suspend_application();
2120 lttng_notification_channel_destroy(notification_channel);
2121 lttng_unregister_trigger(trigger);
2122 lttng_trigger_destroy(trigger);
2123 lttng_action_destroy(action);
2124 lttng_condition_destroy(condition);
2125 return;
2126}
2127
acb98866
FD
2128static void test_syscall_event_rule_notification_filter(
2129 enum lttng_domain_type domain_type)
2130{
2131 int i, ret;
2132 const int notification_count = 3;
2133 enum lttng_notification_channel_status nc_status;
2134 enum lttng_event_rule_status event_rule_status;
2135 enum lttng_trigger_status trigger_status;
2136 struct lttng_notification_channel *notification_channel = NULL;
2137 struct lttng_condition *condition = NULL;
2138 struct lttng_event_rule *event_rule = NULL;
2139 struct lttng_action *action = NULL;
2140 struct lttng_trigger *trigger = NULL;
2141 const char * const trigger_name = "syscall_trigger";
2142 const char * const syscall_name = "openat";
2143 const char * const filter_pattern = "filename == \"/proc/cpuinfo\"";
2144
2145 action = lttng_action_notify_create();
2146 if (!action) {
2147 fail("Failed to create notify action");
2148 goto end;
2149 }
2150
2151 notification_channel = lttng_notification_channel_create(
2152 lttng_session_daemon_notification_endpoint);
2153 ok(notification_channel, "Notification channel object creation");
2154
57739a6b 2155 event_rule = lttng_event_rule_syscall_create(LTTNG_EVENT_RULE_SYSCALL_EMISSION_SITE_ENTRY);
acb98866
FD
2156 ok(event_rule, "syscall event rule object creation");
2157
2158 event_rule_status = lttng_event_rule_syscall_set_pattern(
2159 event_rule, syscall_name);
2160 ok(event_rule_status == LTTNG_EVENT_RULE_STATUS_OK,
2161 "Setting syscall event rule pattern: '%s'", syscall_name);
2162
2163 event_rule_status = lttng_event_rule_syscall_set_filter(
2164 event_rule, filter_pattern);
2165 ok(event_rule_status == LTTNG_EVENT_RULE_STATUS_OK,
2166 "Setting filter: '%s'", filter_pattern);
2167
8dbb86b8 2168 condition = lttng_condition_event_rule_matches_create(event_rule);
acb98866
FD
2169 ok(condition, "Condition event rule object creation");
2170
2171 /* Register the triggers for condition */
2172 trigger = lttng_trigger_create(condition, action);
2173 if (!trigger) {
2174 fail("Failed to create trigger with syscall filtering event rule condition and notify action");
2175 goto end;
2176 }
2177
2178 trigger_status = lttng_trigger_set_name(trigger, trigger_name);
2179 ok(trigger_status == LTTNG_TRIGGER_STATUS_OK,
2180 "Setting name to trigger '%s'", trigger_name);
2181
2182 ret = lttng_register_trigger(trigger);
2183 if (ret) {
2184 fail("Failed to register trigger with syscall filtering event rule condition and notify action");
2185 goto end;
2186 }
2187
2188 nc_status = lttng_notification_channel_subscribe(
2189 notification_channel, condition);
2190 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
2191 "Subscribe to tracepoint event rule condition");
2192
2193 resume_application();
2194
d150e7e5
JR
2195 for (i = 0; i < notification_count; i++) {
2196 struct lttng_notification *notification = get_next_notification(
acb98866
FD
2197 notification_channel);
2198
d150e7e5
JR
2199 ok(notification, "Received notification (%d/%d)", i + 1,
2200 notification_count);
2201
2202 /* Error. */
2203 if (notification == NULL) {
2204 goto end;
2205 }
2206
2207 ret = validator_notification_trigger_name(notification, trigger_name);
2208 lttng_notification_destroy(notification);
2209 if (ret) {
2210 goto end;
2211 }
acb98866
FD
2212 }
2213
2214end:
2215 suspend_application();
2216
2217 lttng_unregister_trigger(trigger);
2218 lttng_notification_channel_destroy(notification_channel);
2219 lttng_trigger_destroy(trigger);
2220 lttng_event_rule_destroy(event_rule);
2221 lttng_condition_destroy(condition);
2222 return;
2223}
2224
26e2f47b
JR
2225static int generate_capture_descr(struct lttng_condition *condition)
2226{
2227 int ret, i;
2228 struct lttng_event_expr *expr = NULL;
2229 const unsigned int basic_field_count = sizeof(test_capture_base_fields) /
2230 sizeof(*test_capture_base_fields);
2231 enum lttng_condition_status cond_status;
2232
2233 for (i = 0; i < basic_field_count; i++) {
2234 diag("Adding capture descriptor '%s'",
2235 test_capture_base_fields[i].field_name);
2236
2237 switch (test_capture_base_fields[i].field_type) {
2238 case FIELD_TYPE_PAYLOAD:
2239 expr = lttng_event_expr_event_payload_field_create(
2240 test_capture_base_fields[i].field_name);
2241 break;
2242 case FIELD_TYPE_CONTEXT:
2243 expr = lttng_event_expr_channel_context_field_create(
2244 test_capture_base_fields[i].field_name);
2245 break;
2246 case FIELD_TYPE_ARRAY_FIELD:
2247 {
2248 int nb_matches;
2249 unsigned int index;
2250 char field_name[FIELD_NAME_MAX_LEN];
2251 struct lttng_event_expr *array_expr = NULL;
2252
2253 nb_matches = sscanf(test_capture_base_fields[i].field_name,
2254 "%[^[][%u]", field_name, &index);
2255 if (nb_matches != 2) {
2256 fail("Unexpected array field name format: field name = '%s'",
2257 test_capture_base_fields[i].field_name);
2258 ret = 1;
2259 goto end;
2260 }
2261
2262 array_expr = lttng_event_expr_event_payload_field_create(
2263 field_name);
2264
2265 expr = lttng_event_expr_array_field_element_create(
2266 array_expr, index);
2267 break;
2268 }
2269 case FIELD_TYPE_APP_CONTEXT:
2270 fail("Application context tests are not implemented yet.");
2271 /* fallthrough. */
2272 default:
2273 ret = 1;
2274 goto end;
2275 }
2276
2277 if (expr == NULL) {
2278 fail("Failed to create capture expression");
2279 ret = -1;
2280 goto end;
2281 }
2282
8dbb86b8 2283 cond_status = lttng_condition_event_rule_matches_append_capture_descriptor(
26e2f47b
JR
2284 condition, expr);
2285 if (cond_status != LTTNG_CONDITION_STATUS_OK) {
2286 fail("Failed to append capture descriptor");
2287 ret = -1;
2288 lttng_event_expr_destroy(expr);
2289 goto end;
2290 }
2291 }
2292
2293 ret = 0;
2294
2295end:
2296 return ret;
2297}
2298
2299static int validator_notification_trigger_capture(
2300 enum lttng_domain_type domain,
2301 struct lttng_notification *notification,
2302 const int iteration)
2303{
2304 int ret;
2305 unsigned int capture_count, i;
8dbb86b8
JR
2306 enum lttng_evaluation_event_rule_matches_status
2307 event_rule_matches_evaluation_status;
26e2f47b
JR
2308 enum lttng_event_field_value_status event_field_value_status;
2309 const struct lttng_evaluation *evaluation;
2310 const struct lttng_event_field_value *captured_fields;
2311 bool at_least_one_error = false;
2312
2313 evaluation = lttng_notification_get_evaluation(notification);
2314 if (evaluation == NULL) {
2315 fail("Failed to get evaluation from notification during trigger capture test");
2316 ret = 1;
2317 goto end;
2318 }
2319
8dbb86b8
JR
2320 event_rule_matches_evaluation_status =
2321 lttng_evaluation_event_rule_matches_get_captured_values(
3ce811ee 2322 evaluation, &captured_fields);
8dbb86b8
JR
2323 if (event_rule_matches_evaluation_status !=
2324 LTTNG_EVALUATION_EVENT_RULE_MATCHES_STATUS_OK) {
26e2f47b 2325 diag("Failed to get event rule evaluation captured values: status = %d",
8dbb86b8 2326 (int) event_rule_matches_evaluation_status);
26e2f47b
JR
2327 ret = 1;
2328 goto end;
2329 }
2330
2331 event_field_value_status =
2332 lttng_event_field_value_array_get_length(captured_fields,
2333 &capture_count);
2334 if (event_field_value_status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
2335 fail("Failed to get count of captured value field array");
2336 ret = 1;
2337 goto end;
2338 }
2339
2340 for (i = 0; i < capture_count; i++) {
2341 const struct lttng_event_field_value *captured_field = NULL;
2342 validate_cb validate;
2343 bool expected;
2344
2345 diag("Validating capture of field '%s'",
2346 test_capture_base_fields[i].field_name);
2347 event_field_value_status =
2348 lttng_event_field_value_array_get_element_at_index(
2349 captured_fields, i,
2350 &captured_field);
2351
2352 switch(domain) {
2353 case LTTNG_DOMAIN_UST:
2354 expected = test_capture_base_fields[i].expected_ust;
2355 break;
2356 case LTTNG_DOMAIN_KERNEL:
2357 expected = test_capture_base_fields[i].expected_kernel;
2358 break;
2359 default:
2360 fail("Unexpected domain encountered: domain = %d",
2361 (int) domain);
2362 ret = 1;
2363 goto end;
2364 }
2365
2366 if (domain == LTTNG_DOMAIN_UST) {
2367 validate = test_capture_base_fields[i].validate_ust;
2368 } else {
2369 validate = test_capture_base_fields[i].validate_kernel;
2370 }
2371
2372 if (!expected) {
2373 ok(event_field_value_status == LTTNG_EVENT_FIELD_VALUE_STATUS_UNAVAILABLE,
2374 "No payload captured");
2375 continue;
2376 }
2377
2378 if (event_field_value_status != LTTNG_EVENT_FIELD_VALUE_STATUS_OK) {
2379 if (event_field_value_status ==
2380 LTTNG_EVENT_FIELD_VALUE_STATUS_UNAVAILABLE) {
2381 fail("Expected a capture but it is unavailable");
2382 } else {
2383 fail("lttng_event_field_value_array_get_element_at_index returned an error: status = %d",
2384 (int) event_field_value_status);
2385 }
2386
2387 ret = 1;
2388 goto end;
2389 }
2390
2391 diag("Captured field of type %s",
2392 field_value_type_to_str(
2393 lttng_event_field_value_get_type(captured_field)));
2394
2395 assert(validate);
2396 ret = validate(captured_field, iteration);
2397 if (ret) {
2398 at_least_one_error = true;
2399 }
2400 }
2401
2402 ret = at_least_one_error;
2403
2404end:
2405 return ret;
2406}
2407
2408static void test_tracepoint_event_rule_notification_capture(
2409 enum lttng_domain_type domain_type)
2410{
2411 enum lttng_notification_channel_status nc_status;
2412
2413 int i, ret;
2414 struct lttng_condition *condition = NULL;
2415 struct lttng_notification_channel *notification_channel = NULL;
2416 struct lttng_trigger *trigger = NULL;
2417 const char *trigger_name = "my_precious";
2418 const char *pattern;
2419
2420 if (domain_type == LTTNG_DOMAIN_UST) {
2421 pattern = "tp:tptest";
2422 } else {
2423 pattern = "lttng_test_filter_event";
2424 }
2425
2426 create_tracepoint_event_rule_trigger(pattern, trigger_name, NULL, 0,
2427 NULL, domain_type, generate_capture_descr, &condition,
2428 &trigger);
2429
2430 notification_channel = lttng_notification_channel_create(
2431 lttng_session_daemon_notification_endpoint);
2432 ok(notification_channel, "Notification channel object creation");
2433
2434 nc_status = lttng_notification_channel_subscribe(
2435 notification_channel, condition);
2436 ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK,
2437 "Subscribe to tracepoint event rule condition");
2438
2439 resume_application();
2440
2441 /* Get 3 notifications */
2442 for (i = 0; i < 3; i++) {
2443 struct lttng_notification *notification = get_next_notification(
2444 notification_channel);
2445 ok(notification, "Received notification");
2446
2447 /* Error */
2448 if (notification == NULL) {
2449 goto end;
2450 }
2451
2452 ret = validator_notification_trigger_name(notification, trigger_name);
2453 if (ret) {
2454 lttng_notification_destroy(notification);
2455 goto end;
2456 }
2457
2458 ret = validator_notification_trigger_capture(domain_type, notification, i);
2459 if (ret) {
2460 lttng_notification_destroy(notification);
2461 goto end;
2462 }
2463
2464 lttng_notification_destroy(notification);
2465 }
2466
2467end:
2468 suspend_application();
2469 lttng_notification_channel_destroy(notification_channel);
2470 lttng_unregister_trigger(trigger);
2471 lttng_trigger_destroy(trigger);
2472 lttng_condition_destroy(condition);
2473 return;
2474}
2475
434f8068
JR
2476int main(int argc, const char *argv[])
2477{
069fc1c5 2478 int test_scenario;
434f8068
JR
2479 const char *domain_type_string = NULL;
2480 enum lttng_domain_type domain_type = LTTNG_DOMAIN_NONE;
2481
a740a242
FD
2482 if (argc < 5) {
2483 fail("Missing test scenario, domain type, pid, or application state file argument(s)");
434f8068
JR
2484 goto error;
2485 }
2486
069fc1c5
FD
2487 test_scenario = atoi(argv[1]);
2488 domain_type_string = argv[2];
a740a242
FD
2489 app_pid = (pid_t) atoi(argv[3]);
2490 app_state_file = argv[4];
434f8068
JR
2491
2492 if (!strcmp("LTTNG_DOMAIN_UST", domain_type_string)) {
2493 domain_type = LTTNG_DOMAIN_UST;
2494 }
2495 if (!strcmp("LTTNG_DOMAIN_KERNEL", domain_type_string)) {
2496 domain_type = LTTNG_DOMAIN_KERNEL;
2497 }
2498 if (domain_type == LTTNG_DOMAIN_NONE) {
2499 fail("Unknown domain type");
2500 goto error;
2501 }
2502
a740a242
FD
2503 /*
2504 * Test cases are responsible for resuming the app when needed
2505 * and making sure it's suspended when returning.
2506 */
2507 suspend_application();
2508
069fc1c5
FD
2509 switch (test_scenario) {
2510 case 1:
2511 {
d150e7e5 2512 plan_tests(44);
7948461b 2513
069fc1c5 2514 /* Test cases that need gen-ust-event testapp. */
a740a242 2515 diag("Test basic notification error paths for %s domain",
069fc1c5
FD
2516 domain_type_string);
2517 test_invalid_channel_subscription(domain_type);
7948461b
FD
2518
2519 diag("Test tracepoint event rule notifications for domain %s",
2520 domain_type_string);
2521 test_tracepoint_event_rule_notification(domain_type);
2522
a740a242
FD
2523 diag("Test tracepoint event rule notifications with filter for domain %s",
2524 domain_type_string);
2525 test_tracepoint_event_rule_notification_filter(domain_type);
069fc1c5
FD
2526 break;
2527 }
2528 case 2:
2529 {
45294d8a 2530 const char *session_name, *channel_name;
d150e7e5 2531
069fc1c5
FD
2532 /* Test cases that need a tracing session enabled. */
2533 plan_tests(99);
7676e0d2 2534
069fc1c5
FD
2535 /*
2536 * Argument 7 and upward are named pipe location for consumerd
2537 * control.
2538 */
2539 named_pipe_args_start = 7;
2540
2541 if (argc < 8) {
2542 fail("Missing parameter for tests to run %d", argc);
2543 goto error;
2544 }
434f8068 2545
069fc1c5
FD
2546 nb_args = argc;
2547
a740a242
FD
2548 session_name = argv[5];
2549 channel_name = argv[6];
069fc1c5
FD
2550
2551 test_subscription_twice(session_name, channel_name,
2552 domain_type);
2553
2554 diag("Test trigger for domain %s with buffer_usage_low condition",
2555 domain_type_string);
2556 test_triggers_buffer_usage_condition(session_name, channel_name,
2557 domain_type,
2558 LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW);
2559
2560 diag("Test trigger for domain %s with buffer_usage_high condition",
2561 domain_type_string);
2562 test_triggers_buffer_usage_condition(session_name, channel_name,
2563 domain_type,
2564 LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH);
2565
2566 diag("Test buffer usage notification channel api for domain %s",
2567 domain_type_string);
2568 test_buffer_usage_notification_channel(session_name, channel_name,
2569 domain_type, argv);
2570 break;
2571 }
3e4ee3b3
FD
2572 case 3:
2573 {
2574 /*
2575 * Test cases that need a test app with more than one event
2576 * type.
2577 */
d150e7e5 2578 plan_tests(25);
3e4ee3b3
FD
2579
2580 /*
2581 * At the moment, the only test case of this scenario is
2582 * exclusion which is only supported by UST.
2583 */
2584 assert(domain_type == LTTNG_DOMAIN_UST);
2585 diag("Test tracepoint event rule notifications with exclusion for domain %s",
2586 domain_type_string);
2587 test_tracepoint_event_rule_notification_exclusion(domain_type);
2588
2589 break;
2590 }
51704c8e
FD
2591 case 4:
2592 {
602a6d40 2593 plan_tests(12);
51704c8e
FD
2594 /* Test cases that need the kernel tracer. */
2595 assert(domain_type == LTTNG_DOMAIN_KERNEL);
aab0598f 2596
51704c8e
FD
2597 diag("Test kprobe event rule notifications for domain %s",
2598 domain_type_string);
2599
2600 test_kprobe_event_rule_notification(domain_type);
2601
2602 break;
2603 }
aab0598f
FD
2604 case 5:
2605 {
d150e7e5 2606 plan_tests(25);
aab0598f
FD
2607 /* Test cases that need the kernel tracer. */
2608 assert(domain_type == LTTNG_DOMAIN_KERNEL);
2609
2610 diag("Test syscall event rule notifications for domain %s",
2611 domain_type_string);
2612
2613 test_syscall_event_rule_notification(domain_type);
2614
acb98866
FD
2615 diag("Test syscall filtering event rule notifications for domain %s",
2616 domain_type_string);
2617
2618 test_syscall_event_rule_notification_filter(domain_type);
2619
aab0598f
FD
2620 break;
2621 }
45294d8a
FD
2622 case 6:
2623 {
2624 const char *testapp_path, *test_symbol_name;
2625
10685de6 2626 plan_tests(12);
45294d8a
FD
2627
2628 if (argc < 7) {
2629 fail("Missing parameter for tests to run %d", argc);
2630 goto error;
2631 }
2632
2633 testapp_path = argv[5];
2634 test_symbol_name = argv[6];
2635 /* Test cases that need the kernel tracer. */
2636 assert(domain_type == LTTNG_DOMAIN_KERNEL);
2637
2638 diag("Test userspace-probe event rule notifications for domain %s",
2639 domain_type_string);
2640
2641 test_uprobe_event_rule_notification(
2642 domain_type, testapp_path, test_symbol_name);
2643
2644 break;
2645 }
26e2f47b
JR
2646 case 7:
2647 {
2648 switch(domain_type) {
2649 case LTTNG_DOMAIN_UST:
2650 plan_tests(222);
2651 break;
2652 case LTTNG_DOMAIN_KERNEL:
2653 plan_tests(216);
2654 break;
2655 default:
2656 assert(0);
2657 }
2658
2659 diag("Test tracepoint event rule notification captures for domain %s",
2660 domain_type_string);
2661 test_tracepoint_event_rule_notification_capture(domain_type);
2662
2663 break;
2664 }
2665
069fc1c5
FD
2666 default:
2667 abort();
2668 }
90fcb2ec 2669
434f8068
JR
2670error:
2671 return exit_status();
2672}
2673
This page took 0.149122 seconds and 4 git commands to generate.