Tests: Fix: `wait_on_file()` returns too early

[lttng-tools.git] / tests / regression / tools / notification / notification.c

diff --git a/tests/regression/tools/notification/notification.c b/tests/regression/tools/notification/notification.c
index f69e884ae5435484265bed5cbfe767ef03e20991..f076bbd0e5f5373740061b13f47ef4efdfcd2ad9 100644 (file)
--- a/tests/regression/tools/notification/notification.c
+++ b/tests/regression/tools/notification/notification.c
@@ -5,23 +5,8 @@
  *
  * Copyright (C) 2017 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
  *
  *
  * Copyright (C) 2017 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
  *

- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
+ * SPDX-License-Identifier: MIT

  *
  *

- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.

  */
 
 #include <assert.h>
  */
 
 #include <assert.h>


@@ -35,6 +20,9 @@
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>

+#include <signal.h>
+#include <errno.h>
+#include <poll.h>

 
 #include <lttng/action/action.h>
 #include <lttng/action/notify.h>
 
 #include <lttng/action/action.h>
 #include <lttng/action/notify.h>


@@ -47,12 +35,57 @@
 #include <lttng/notification/channel.h>
 #include <lttng/notification/notification.h>
 #include <lttng/trigger/trigger.h>
 #include <lttng/notification/channel.h>
 #include <lttng/notification/notification.h>
 #include <lttng/trigger/trigger.h>

+#include <lttng/lttng.h>

 
 #include <tap/tap.h>
 
 #define NUM_TESTS 104
 
 #include <tap/tap.h>
 
 #define NUM_TESTS 104

+

 int nb_args = 0;
 int named_pipe_args_start = 0;
 int nb_args = 0;
 int named_pipe_args_start = 0;

+pid_t app_pid = -1;
+const char *app_state_file = NULL;
+
+static
+void wait_on_file(const char *path, bool file_exist)
+{
+       if (!path) {
+               return;
+       }
+       for (;;) {
+               int ret;
+               struct stat buf;
+
+               ret = stat(path, &buf);
+               if (ret == -1 && errno == ENOENT) {
+                       if (file_exist) {
+                               /*
+                                * The file does not exist. wait a bit and
+                                * continue looping until it does.
+                                */
+                               (void) poll(NULL, 0, 10);
+                               continue;
+                       }
+
+                       /*
+                        * File does not exist and the exit condition we want.
+                        * Break from the loop and return.
+                        */
+                       break;
+               }
+               if (ret) {
+                       perror("stat");
+                       exit(EXIT_FAILURE);
+               }
+               /*
+                * stat() returned 0, so the file exists. break now only if
+                * that's the exit condition we want.
+                */
+               if (file_exist) {
+                       break;
+               }
+       }
+}

 
 int write_pipe(const char *path, uint8_t data)
 {
 
 int write_pipe(const char *path, uint8_t data)
 {


@@ -68,6 +101,9 @@ int write_pipe(const char *path, uint8_t data)
        ret = write(fd, &data , sizeof(data));
        if (ret < 1) {
                perror("Named pipe write failed");
        ret = write(fd, &data , sizeof(data));
        if (ret < 1) {
                perror("Named pipe write failed");

+               if (close(fd)) {
+                       perror("Named pipe close failed");
+               }

                ret = -1;
                goto end;
        }
                ret = -1;
                goto end;
        }


@@ -84,8 +120,9 @@ end:
 
 int stop_consumer(const char **argv)
 {
 
 int stop_consumer(const char **argv)
 {

-       int ret = 0;
-       for (int i = named_pipe_args_start; i < nb_args; i++) {
+       int ret = 0, i;
+
+       for (i = named_pipe_args_start; i < nb_args; i++) {

                ret = write_pipe(argv[i], 49);
        }
        return ret;
                ret = write_pipe(argv[i], 49);
        }
        return ret;


@@ -93,18 +130,78 @@ int stop_consumer(const char **argv)
 
 int resume_consumer(const char **argv)
 {
 
 int resume_consumer(const char **argv)
 {

-       int ret = 0;
-       for (int i = named_pipe_args_start; i < nb_args; i++) {
+       int ret = 0, i;
+
+       for (i = named_pipe_args_start; i < nb_args; i++) {

                ret = write_pipe(argv[i], 0);
        }
        return ret;
 }
 
                ret = write_pipe(argv[i], 0);
        }
        return ret;
 }
 

+int suspend_application()
+{
+       int ret;
+       struct stat buf;
+
+       if (!stat(app_state_file, &buf)) {
+               fail("App is already in a suspended state.");
+               ret = -1;
+               goto error;
+       }
+
+       /*
+        * Send SIGUSR1 to application instructing it to bypass tracepoint.
+        */
+       ret = kill(app_pid, SIGUSR1);
+       if (ret) {
+               fail("SIGUSR1 failed. errno %d", errno);
+               ret = -1;
+               goto error;
+       }
+
+       wait_on_file(app_state_file, true);
+
+error:
+       return ret;
+
+}
+
+int resume_application()
+{
+       int ret;
+       struct stat buf;
+
+       ret = stat(app_state_file, &buf);
+       if (ret == -1 && errno == ENOENT) {
+               fail("State file does not exist");
+               goto error;
+       }
+       if (ret) {
+               perror("stat");
+               goto error;
+       }
+
+       ret = kill(app_pid, SIGUSR1);
+       if (ret) {
+               fail("SIGUSR1 failed. errno %d", errno);
+               ret = -1;
+               goto error;
+       }
+
+       wait_on_file(app_state_file, false);
+
+error:
+       return ret;
+
+}
+
+

 void test_triggers_buffer_usage_condition(const char *session_name,
                const char *channel_name,
                enum lttng_domain_type domain_type,
                enum lttng_condition_type condition_type)
 {
 void test_triggers_buffer_usage_condition(const char *session_name,
                const char *channel_name,
                enum lttng_domain_type domain_type,
                enum lttng_condition_type condition_type)
 {

+       unsigned int test_vector_size = 5, i;

        enum lttng_condition_status condition_status;
        struct lttng_action *action;
 
        enum lttng_condition_status condition_status;
        struct lttng_action *action;
 


@@ -119,8 +216,8 @@ void test_triggers_buffer_usage_condition(const char *session_name,
        ok(lttng_register_trigger(NULL) == -LTTNG_ERR_INVALID, "Registering a NULL trigger fails as expected");
 
        /* Test: register a trigger */
        ok(lttng_register_trigger(NULL) == -LTTNG_ERR_INVALID, "Registering a NULL trigger fails as expected");
 
        /* Test: register a trigger */

-       unsigned int test_vector_size = 5;
-       for (unsigned int  i = 0; i < pow(2,test_vector_size); i++) {
+
+       for (i = 0; i < pow(2,test_vector_size); i++) {

                int loop_ret = 0;
                char *test_tuple_string = NULL;
                unsigned int mask_position = 0;
                int loop_ret = 0;
                char *test_tuple_string = NULL;
                unsigned int mask_position = 0;


@@ -266,7 +363,7 @@ loop_end:
                         * registered trigger fail.
                         */
                        loop_ret = lttng_unregister_trigger(trigger);
                         * registered trigger fail.
                         */
                        loop_ret = lttng_unregister_trigger(trigger);

-                       ok(loop_ret == -LTTNG_ERR_TRIGGER_NOT_FOUND, "Unregister of a non-registerd  trigger fails as expected: %s", test_tuple_string);
+                       ok(loop_ret == -LTTNG_ERR_TRIGGER_NOT_FOUND, "Unregister of a non-registered trigger fails as expected: %s", test_tuple_string);

                } else {
                        ok(loop_ret == -LTTNG_ERR_INVALID_TRIGGER, "Trigger is invalid as expected and cannot be registered: %s", test_tuple_string);
                }
                } else {
                        ok(loop_ret == -LTTNG_ERR_INVALID_TRIGGER, "Trigger is invalid as expected and cannot be registered: %s", test_tuple_string);
                }


@@ -281,7 +378,18 @@ end:
        lttng_action_destroy(action);
 }
 
        lttng_action_destroy(action);
 }
 

-void test_notification_channel(const char *session_name, const char *channel_name, enum lttng_domain_type domain_type, const char **argv)
+static
+void wait_data_pending(const char *session_name)
+{
+       int ret;
+
+       do {
+               ret = lttng_data_pending(session_name);
+               assert(ret >= 0);
+       } while (ret != 0);
+}
+
+void test_notification_channel(const char *session_name, const char *channel_name, const enum lttng_domain_type domain_type, const char **argv)

 {
        int ret = 0;
        enum lttng_condition_status condition_status;
 {
        int ret = 0;
        enum lttng_condition_status condition_status;


@@ -462,10 +570,10 @@ void test_notification_channel(const char *session_name, const char *channel_nam
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID, "Subscribing to an invalid condition");
 
        nc_status = lttng_notification_channel_unsubscribe(notification_channel, dummy_invalid_condition);
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID, "Subscribing to an invalid condition");
 
        nc_status = lttng_notification_channel_unsubscribe(notification_channel, dummy_invalid_condition);

-       ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID, "Unsubscribing to an invalid condition");
+       ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_INVALID, "Unsubscribing from an invalid condition");

 
        nc_status = lttng_notification_channel_unsubscribe(notification_channel, dummy_condition);
 
        nc_status = lttng_notification_channel_unsubscribe(notification_channel, dummy_condition);

-       ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION, "Unsubscribing to an valid unknown condition");
+       ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION, "Unsubscribing from a valid unknown condition");

 
        /* Subscribe a valid low condition */
        nc_status = lttng_notification_channel_subscribe(notification_channel, low_condition);
 
        /* Subscribe a valid low condition */
        nc_status = lttng_notification_channel_subscribe(notification_channel, low_condition);


@@ -482,8 +590,8 @@ void test_notification_channel(const char *session_name, const char *channel_nam
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED, "Subscribe to a condition for which subscription was already done");
 
        /* Wait for notification to happen */
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED, "Subscribe to a condition for which subscription was already done");
 
        /* Wait for notification to happen */

-       lttng_start_tracing(session_name);

        stop_consumer(argv);
        stop_consumer(argv);

+       lttng_start_tracing(session_name);

 
        /* Wait for high notification */
        nc_status = lttng_notification_channel_get_next_notification(notification_channel, &notification);
 
        /* Wait for high notification */
        nc_status = lttng_notification_channel_get_next_notification(notification_channel, &notification);


@@ -494,8 +602,10 @@ void test_notification_channel(const char *session_name, const char *channel_nam
        lttng_notification_destroy(notification);
        notification = NULL;
 
        lttng_notification_destroy(notification);
        notification = NULL;
 

+       suspend_application();
+       lttng_stop_tracing_no_wait(session_name);

        resume_consumer(argv);
        resume_consumer(argv);

-       lttng_stop_tracing(session_name);
+       wait_data_pending(session_name);

 
        /*
         * Test that communication still work even if there is notification
 
        /*
         * Test that communication still work even if there is notification


@@ -517,8 +627,9 @@ void test_notification_channel(const char *session_name, const char *channel_nam
        notification = NULL;
 
        /* Stop consumer to force a high notification */
        notification = NULL;
 
        /* Stop consumer to force a high notification */

-       lttng_start_tracing(session_name);

        stop_consumer(argv);
        stop_consumer(argv);

+       resume_application();
+       lttng_start_tracing(session_name);

 
        nc_status = lttng_notification_channel_get_next_notification(notification_channel, &notification);
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&
 
        nc_status = lttng_notification_channel_get_next_notification(notification_channel, &notification);
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&


@@ -527,9 +638,10 @@ void test_notification_channel(const char *session_name, const char *channel_nam
        lttng_notification_destroy(notification);
        notification = NULL;
 
        lttng_notification_destroy(notification);
        notification = NULL;
 

-       /* Resume consumer to allow event consumption */
+       suspend_application();
+       lttng_stop_tracing_no_wait(session_name);

        resume_consumer(argv);
        resume_consumer(argv);

-       lttng_stop_tracing(session_name);
+       wait_data_pending(session_name);

 
        nc_status = lttng_notification_channel_get_next_notification(notification_channel, &notification);
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&
 
        nc_status = lttng_notification_channel_get_next_notification(notification_channel, &notification);
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&


@@ -538,9 +650,10 @@ void test_notification_channel(const char *session_name, const char *channel_nam
        lttng_notification_destroy(notification);
        notification = NULL;
 
        lttng_notification_destroy(notification);
        notification = NULL;
 

+       stop_consumer(argv);
+       resume_application();

        /* Stop consumer to force a high notification */
        lttng_start_tracing(session_name);
        /* Stop consumer to force a high notification */
        lttng_start_tracing(session_name);

-       stop_consumer(argv);

 
        nc_status = lttng_notification_channel_get_next_notification(notification_channel, &notification);
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&
 
        nc_status = lttng_notification_channel_get_next_notification(notification_channel, &notification);
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK && notification &&


@@ -550,8 +663,10 @@ void test_notification_channel(const char *session_name, const char *channel_nam
        notification = NULL;
 
        /* Resume consumer to allow event consumption */
        notification = NULL;
 
        /* Resume consumer to allow event consumption */

+       suspend_application();
+       lttng_stop_tracing_no_wait(session_name);

        resume_consumer(argv);
        resume_consumer(argv);

-       lttng_stop_tracing(session_name);
+       wait_data_pending(session_name);

 
        nc_status = lttng_notification_channel_unsubscribe(notification_channel, low_condition);
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK, "Unsubscribe low condition with pending notification");
 
        nc_status = lttng_notification_channel_unsubscribe(notification_channel, low_condition);
        ok(nc_status == LTTNG_NOTIFICATION_CHANNEL_STATUS_OK, "Unsubscribe low condition with pending notification");


@@ -563,6 +678,7 @@ end:
        lttng_trigger_destroy(trigger);
        lttng_action_destroy(action);
        lttng_condition_destroy(low_condition);
        lttng_trigger_destroy(trigger);
        lttng_action_destroy(action);
        lttng_condition_destroy(low_condition);

+       lttng_condition_destroy(high_condition);

        lttng_condition_destroy(dummy_invalid_condition);
        lttng_condition_destroy(dummy_condition);
 }
        lttng_condition_destroy(dummy_invalid_condition);
        lttng_condition_destroy(dummy_condition);
 }


@@ -576,19 +692,21 @@ int main(int argc, const char *argv[])
 
        plan_tests(NUM_TESTS);
 
 
        plan_tests(NUM_TESTS);
 

-       /* Argument 4 and upward are named pipe location for consumerd control */
-       named_pipe_args_start = 4;
+       /* Argument 6 and upward are named pipe location for consumerd control */
+       named_pipe_args_start = 6;

 
 

-       if (argc < 5) {
+       if (argc < 7) {

                fail("Missing parameter for tests to run %d", argc);
                goto error;
        }
 
        nb_args = argc;
 
                fail("Missing parameter for tests to run %d", argc);
                goto error;
        }
 
        nb_args = argc;
 

-       session_name = argv[1];
-       channel_name = argv[2];
-       domain_type_string= argv[3];
+       domain_type_string = argv[1];
+       session_name = argv[2];
+       channel_name = argv[3];
+       app_pid = (pid_t) atoi(argv[4]);
+       app_state_file = argv[5];

 
        if (!strcmp("LTTNG_DOMAIN_UST", domain_type_string)) {
                domain_type = LTTNG_DOMAIN_UST;
 
        if (!strcmp("LTTNG_DOMAIN_UST", domain_type_string)) {
                domain_type = LTTNG_DOMAIN_UST;