4 * Tests suite for LTTng notification API
6 * Copyright (C) 2017 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
8 * SPDX-License-Identifier: MIT
20 #include <sys/types.h>
26 #include <common/compat/errno.h>
27 #include <lttng/action/action.h>
28 #include <lttng/action/notify.h>
29 #include <lttng/condition/buffer-usage.h>
30 #include <lttng/condition/condition.h>
31 #include <lttng/condition/evaluation.h>
32 #include <lttng/domain.h>
33 #include <lttng/endpoint.h>
34 #include <lttng/lttng-error.h>
35 #include <lttng/notification/channel.h>
36 #include <lttng/notification/notification.h>
37 #include <lttng/trigger/trigger.h>
38 #include <lttng/lttng.h>
45 int named_pipe_args_start
= 0;
47 const char *app_state_file
= NULL
;
50 void wait_on_file(const char *path
, bool file_exist
)
59 ret
= stat(path
, &buf
);
60 if (ret
== -1 && errno
== ENOENT
) {
63 * The file does not exist. wait a bit and
64 * continue looping until it does.
66 (void) poll(NULL
, 0, 10);
71 * File does not exist and the exit condition we want.
72 * Break from the loop and return.
81 * stat() returned 0, so the file exists. break now only if
82 * that's the exit condition we want.
91 int write_pipe(const char *path
, uint8_t data
)
96 fd
= open(path
, O_WRONLY
| O_NONBLOCK
);
98 perror("Could not open consumer control named pipe");
102 ret
= write(fd
, &data
, sizeof(data
));
104 perror("Named pipe write failed");
106 perror("Named pipe close failed");
114 perror("Name pipe closing failed");
123 int stop_consumer(const char **argv
)
127 for (i
= named_pipe_args_start
; i
< nb_args
; i
++) {
128 ret
= write_pipe(argv
[i
], 49);
134 int resume_consumer(const char **argv
)
138 for (i
= named_pipe_args_start
; i
< nb_args
; i
++) {
139 ret
= write_pipe(argv
[i
], 0);
145 int suspend_application(void)
150 if (!stat(app_state_file
, &buf
)) {
151 fail("App is already in a suspended state.");
157 * Send SIGUSR1 to application instructing it to bypass tracepoint.
159 ret
= kill(app_pid
, SIGUSR1
);
161 fail("SIGUSR1 failed. errno %d", errno
);
166 wait_on_file(app_state_file
, true);
174 int resume_application(void)
179 ret
= stat(app_state_file
, &buf
);
180 if (ret
== -1 && errno
== ENOENT
) {
181 fail("State file does not exist");
189 ret
= kill(app_pid
, SIGUSR1
);
191 fail("SIGUSR1 failed. errno %d", errno
);
196 wait_on_file(app_state_file
, false);
205 void test_triggers_buffer_usage_condition(const char *session_name
,
206 const char *channel_name
,
207 enum lttng_domain_type domain_type
,
208 enum lttng_condition_type condition_type
)
210 unsigned int test_vector_size
= 5, i
;
211 enum lttng_condition_status condition_status
;
212 struct lttng_action
*action
;
215 action
= lttng_action_notify_create();
217 fail("Setup error on action creation");
221 /* Test lttng_register_trigger with null value */
222 ok(lttng_register_trigger(NULL
) == -LTTNG_ERR_INVALID
, "Registering a NULL trigger fails as expected");
224 /* Test: register a trigger */
226 for (i
= 0; i
< pow(2,test_vector_size
); i
++) {
228 char *test_tuple_string
= NULL
;
229 unsigned int mask_position
= 0;
230 bool session_name_set
= false;
231 bool channel_name_set
= false;
232 bool threshold_ratio_set
= false;
233 bool threshold_byte_set
= false;
234 bool domain_type_set
= false;
236 struct lttng_trigger
*trigger
= NULL
;
237 struct lttng_condition
*condition
= NULL
;
239 /* Create base condition */
240 switch (condition_type
) {
241 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
242 condition
= lttng_condition_buffer_usage_low_create();
244 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
245 condition
= lttng_condition_buffer_usage_high_create();
258 /* Prepare the condition for trigger registration test */
260 /* Set session name */
261 if ((1 << mask_position
) & i
) {
262 condition_status
= lttng_condition_buffer_usage_set_session_name(
263 condition
, session_name
);
264 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
268 session_name_set
= true;
272 /* Set channel name */
273 if ((1 << mask_position
) & i
) {
274 condition_status
= lttng_condition_buffer_usage_set_channel_name(
275 condition
, channel_name
);
276 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
280 channel_name_set
= true;
284 /* Set threshold ratio */
285 if ((1 << mask_position
) & i
) {
286 condition_status
= lttng_condition_buffer_usage_set_threshold_ratio(
288 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
292 threshold_ratio_set
= true;
296 /* Set threshold byte */
297 if ((1 << mask_position
) & i
) {
298 condition_status
= lttng_condition_buffer_usage_set_threshold(
300 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
304 threshold_byte_set
= true;
308 /* Set domain type */
309 if ((1 << mask_position
) & i
) {
310 condition_status
= lttng_condition_buffer_usage_set_domain_type(
311 condition
, LTTNG_DOMAIN_UST
);
312 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
316 domain_type_set
= true;
320 if (mask_position
!= test_vector_size
-1) {
321 assert("Logic error for test vector generation");
324 loop_ret
= asprintf(&test_tuple_string
, "session name %s, channel name %s, threshold ratio %s, threshold byte %s, domain type %s",
325 session_name_set
? "set" : "unset",
326 channel_name_set
? "set" : "unset",
327 threshold_ratio_set
? "set" : "unset",
328 threshold_byte_set
? "set" : "unset",
329 domain_type_set
? "set" : "unset");
330 if (!test_tuple_string
|| loop_ret
< 0) {
336 trigger
= lttng_trigger_create(condition
, action
);
342 loop_ret
= lttng_register_trigger(trigger
);
346 fail("Setup error occurred for tuple: %s", test_tuple_string
);
350 /* This combination happens three times */
351 if (session_name_set
&& channel_name_set
352 && (threshold_ratio_set
|| threshold_byte_set
)
353 && domain_type_set
) {
354 ok(loop_ret
== 0, "Trigger is registered: %s", test_tuple_string
);
357 * Test that a trigger cannot be registered
360 loop_ret
= lttng_register_trigger(trigger
);
361 ok(loop_ret
== -LTTNG_ERR_TRIGGER_EXISTS
, "Re-register trigger fails as expected: %s", test_tuple_string
);
363 /* Test that a trigger can be unregistered */
364 loop_ret
= lttng_unregister_trigger(trigger
);
365 ok(loop_ret
== 0, "Unregister trigger: %s", test_tuple_string
);
368 * Test that unregistration of a non-previously
369 * registered trigger fail.
371 loop_ret
= lttng_unregister_trigger(trigger
);
372 ok(loop_ret
== -LTTNG_ERR_TRIGGER_NOT_FOUND
, "Unregister of a non-registered trigger fails as expected: %s", test_tuple_string
);
374 ok(loop_ret
== -LTTNG_ERR_INVALID_TRIGGER
, "Trigger is invalid as expected and cannot be registered: %s", test_tuple_string
);
378 free(test_tuple_string
);
379 lttng_trigger_destroy(trigger
);
380 lttng_condition_destroy(condition
);
384 lttng_action_destroy(action
);
388 void wait_data_pending(const char *session_name
)
393 ret
= lttng_data_pending(session_name
);
399 int setup_buffer_usage_condition(struct lttng_condition
*condition
,
400 const char *condition_name
,
401 const char *session_name
,
402 const char *channel_name
,
403 const enum lttng_domain_type domain_type
)
405 enum lttng_condition_status condition_status
;
408 condition_status
= lttng_condition_buffer_usage_set_session_name(
409 condition
, session_name
);
410 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
411 fail("Failed to set session name on creation of condition `%s`",
417 condition_status
= lttng_condition_buffer_usage_set_channel_name(
418 condition
, channel_name
);
419 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
420 fail("Failed to set channel name on creation of condition `%s`",
426 condition_status
= lttng_condition_buffer_usage_set_domain_type(
427 condition
, domain_type
);
428 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
429 fail("Failed to set domain type on creation of condition `%s`",
440 void test_notification_channel(const char *session_name
,
441 const char *channel_name
,
442 const enum lttng_domain_type domain_type
,
446 enum lttng_condition_status condition_status
;
447 enum lttng_notification_channel_status nc_status
;
449 struct lttng_action
*action
= NULL
;
450 struct lttng_notification
*notification
= NULL
;
451 struct lttng_notification_channel
*notification_channel
= NULL
;
452 struct lttng_trigger
*trigger
= NULL
;
454 struct lttng_condition
*low_condition
= NULL
;
455 struct lttng_condition
*high_condition
= NULL
;
456 struct lttng_condition
*dummy_invalid_condition
= NULL
;
457 struct lttng_condition
*dummy_condition
= NULL
;
459 double low_ratio
= 0.0;
460 double high_ratio
= 0.90;
463 action
= lttng_action_notify_create();
465 fail("Setup error on action creation");
469 /* Create a dummy, empty condition for later test */
470 dummy_invalid_condition
= lttng_condition_buffer_usage_low_create();
471 if (!dummy_invalid_condition
) {
472 fail("Setup error on condition creation");
476 /* Create a valid dummy condition with a ratio of 0.5 */
477 dummy_condition
= lttng_condition_buffer_usage_low_create();
478 if (!dummy_condition
) {
479 fail("Setup error on dummy_condition creation");
483 condition_status
= lttng_condition_buffer_usage_set_threshold_ratio(
484 dummy_condition
, 0.5);
485 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
486 fail("Setup error on condition creation");
490 ret
= setup_buffer_usage_condition(dummy_condition
, "dummy_condition",
491 session_name
, channel_name
, domain_type
);
493 fail("Setup error on dummy condition creation");
497 /* Register a low condition with a ratio */
498 low_condition
= lttng_condition_buffer_usage_low_create();
499 if (!low_condition
) {
500 fail("Setup error on low_condition creation");
503 condition_status
= lttng_condition_buffer_usage_set_threshold_ratio(
504 low_condition
, low_ratio
);
505 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
506 fail("Setup error on low_condition creation");
510 ret
= setup_buffer_usage_condition(low_condition
, "low_condition",
511 session_name
, channel_name
, domain_type
);
513 fail("Setup error on low condition creation");
517 /* Register a high condition with a ratio */
518 high_condition
= lttng_condition_buffer_usage_high_create();
519 if (!high_condition
) {
520 fail("Setup error on high_condition creation");
524 condition_status
= lttng_condition_buffer_usage_set_threshold_ratio(
525 high_condition
, high_ratio
);
526 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
527 fail("Setup error on high_condition creation");
531 ret
= setup_buffer_usage_condition(high_condition
, "high_condition",
532 session_name
, channel_name
, domain_type
);
534 fail("Setup error on high condition creation");
538 /* Register the triggers for low and high condition */
539 trigger
= lttng_trigger_create(low_condition
, action
);
541 fail("Setup error on low trigger creation");
545 ret
= lttng_register_trigger(trigger
);
547 fail("Setup error on low trigger registration");
551 lttng_trigger_destroy(trigger
);
554 trigger
= lttng_trigger_create(high_condition
, action
);
556 fail("Setup error on high trigger creation");
560 ret
= lttng_register_trigger(trigger
);
562 fail("Setup error on high trigger registration");
567 notification_channel
= lttng_notification_channel_create(
568 lttng_session_daemon_notification_endpoint
);
569 ok(notification_channel
, "Notification channel object creation");
570 if (!notification_channel
) {
574 /* Basic error path check */
575 nc_status
= lttng_notification_channel_subscribe(NULL
, NULL
);
576 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID
,
577 "Notification channel subscription is invalid: NULL, NULL");
579 nc_status
= lttng_notification_channel_subscribe(notification_channel
, NULL
);
580 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID
,
581 "Notification channel subscription is invalid: NON-NULL, NULL");
583 nc_status
= lttng_notification_channel_subscribe(NULL
, low_condition
);
584 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID
,
585 "Notification channel subscription is invalid: NULL, NON-NULL");
587 nc_status
= lttng_notification_channel_subscribe(
588 notification_channel
, dummy_invalid_condition
);
589 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID
,
590 "Subscribing to an invalid condition");
592 nc_status
= lttng_notification_channel_unsubscribe(
593 notification_channel
, dummy_invalid_condition
);
594 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID
,
595 "Unsubscribing from an invalid condition");
597 nc_status
= lttng_notification_channel_unsubscribe(
598 notification_channel
, dummy_condition
);
599 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION
,
600 "Unsubscribing from a valid unknown condition");
602 /* Subscribe a valid low condition */
603 nc_status
= lttng_notification_channel_subscribe(
604 notification_channel
, low_condition
);
605 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
,
606 "Subscribe to condition");
608 /* Subscribe a valid high condition */
609 nc_status
= lttng_notification_channel_subscribe(
610 notification_channel
, high_condition
);
611 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
,
612 "Subscribe to condition");
614 nc_status
= lttng_notification_channel_subscribe(
615 notification_channel
, low_condition
);
616 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED
,
617 "Subscribe to a condition for which subscription was already done");
619 nc_status
= lttng_notification_channel_subscribe(
620 notification_channel
, high_condition
);
621 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED
,
622 "Subscribe to a condition for which subscription was already done");
624 /* Wait for notification to happen */
626 lttng_start_tracing(session_name
);
628 /* Wait for high notification */
630 nc_status
= lttng_notification_channel_get_next_notification(
631 notification_channel
, ¬ification
);
632 } while (nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED
);
633 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
&& notification
&&
634 lttng_condition_get_type(lttng_notification_get_condition(
636 LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
,
637 "High notification received after intermediary communication");
638 lttng_notification_destroy(notification
);
641 suspend_application();
642 lttng_stop_tracing_no_wait(session_name
);
643 resume_consumer(argv
);
644 wait_data_pending(session_name
);
647 * Test that communication still work even if there is notification
648 * waiting for consumption.
651 nc_status
= lttng_notification_channel_unsubscribe(
652 notification_channel
, low_condition
);
653 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
,
654 "Unsubscribe with pending notification");
656 nc_status
= lttng_notification_channel_subscribe(
657 notification_channel
, low_condition
);
658 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
,
659 "Subscribe with pending notification");
662 nc_status
= lttng_notification_channel_get_next_notification(
663 notification_channel
, ¬ification
);
664 } while (nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED
);
665 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
&& notification
&&
666 lttng_condition_get_type(lttng_notification_get_condition(
668 LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
,
669 "Low notification received after intermediary communication");
670 lttng_notification_destroy(notification
);
673 /* Stop consumer to force a high notification */
675 resume_application();
676 lttng_start_tracing(session_name
);
679 nc_status
= lttng_notification_channel_get_next_notification(
680 notification_channel
, ¬ification
);
681 } while (nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED
);
682 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
&& notification
&&
683 lttng_condition_get_type(lttng_notification_get_condition(
685 LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
,
686 "High notification received after intermediary communication");
687 lttng_notification_destroy(notification
);
690 suspend_application();
691 lttng_stop_tracing_no_wait(session_name
);
692 resume_consumer(argv
);
693 wait_data_pending(session_name
);
696 nc_status
= lttng_notification_channel_get_next_notification(
697 notification_channel
, ¬ification
);
698 } while (nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED
);
699 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
&& notification
&&
700 lttng_condition_get_type(lttng_notification_get_condition(
702 LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
,
703 "Low notification received after re-subscription");
704 lttng_notification_destroy(notification
);
708 resume_application();
709 /* Stop consumer to force a high notification */
710 lttng_start_tracing(session_name
);
713 nc_status
= lttng_notification_channel_get_next_notification(
714 notification_channel
, ¬ification
);
715 } while (nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_INTERRUPTED
);
716 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
&& notification
&&
717 lttng_condition_get_type(lttng_notification_get_condition(
719 LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
,
720 "High notification");
721 lttng_notification_destroy(notification
);
724 /* Resume consumer to allow event consumption */
725 suspend_application();
726 lttng_stop_tracing_no_wait(session_name
);
727 resume_consumer(argv
);
728 wait_data_pending(session_name
);
730 nc_status
= lttng_notification_channel_unsubscribe(
731 notification_channel
, low_condition
);
732 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
,
733 "Unsubscribe low condition with pending notification");
735 nc_status
= lttng_notification_channel_unsubscribe(
736 notification_channel
, high_condition
);
737 ok(nc_status
== LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
,
738 "Unsubscribe high condition with pending notification");
741 lttng_notification_channel_destroy(notification_channel
);
742 lttng_trigger_destroy(trigger
);
743 lttng_action_destroy(action
);
744 lttng_condition_destroy(low_condition
);
745 lttng_condition_destroy(high_condition
);
746 lttng_condition_destroy(dummy_invalid_condition
);
747 lttng_condition_destroy(dummy_condition
);
750 int main(int argc
, const char *argv
[])
752 const char *session_name
= NULL
;
753 const char *channel_name
= NULL
;
754 const char *domain_type_string
= NULL
;
755 enum lttng_domain_type domain_type
= LTTNG_DOMAIN_NONE
;
757 plan_tests(NUM_TESTS
);
759 /* Argument 6 and upward are named pipe location for consumerd control */
760 named_pipe_args_start
= 6;
763 fail("Missing parameter for tests to run %d", argc
);
769 domain_type_string
= argv
[1];
770 session_name
= argv
[2];
771 channel_name
= argv
[3];
772 app_pid
= (pid_t
) atoi(argv
[4]);
773 app_state_file
= argv
[5];
775 if (!strcmp("LTTNG_DOMAIN_UST", domain_type_string
)) {
776 domain_type
= LTTNG_DOMAIN_UST
;
778 if (!strcmp("LTTNG_DOMAIN_KERNEL", domain_type_string
)) {
779 domain_type
= LTTNG_DOMAIN_KERNEL
;
781 if (domain_type
== LTTNG_DOMAIN_NONE
) {
782 fail("Unknown domain type");
786 diag("Test trigger for domain %s with buffer_usage_low condition", domain_type_string
);
787 test_triggers_buffer_usage_condition(session_name
, channel_name
, domain_type
, LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
);
788 diag("Test trigger for domain %s with buffer_usage_high condition", domain_type_string
);
789 test_triggers_buffer_usage_condition(session_name
, channel_name
, domain_type
, LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
);
791 diag("Test notification channel api for domain %s", domain_type_string
);
792 test_notification_channel(session_name
, channel_name
, domain_type
, argv
);
794 return exit_status();