testapp: gen-ust-events: augment captured fields

[lttng-tools.git] / tests / utils / testapp / gen-ust-events / gen-ust-events.c

diff --git a/tests/utils/testapp/gen-ust-events/gen-ust-events.c b/tests/utils/testapp/gen-ust-events/gen-ust-events.c
index 364545d5279e3fda785e566cf02115a3ccaccd9e..df1e58e417fa5f464b50a01f52fc2e3a97755881 100644 (file)
--- a/tests/utils/testapp/gen-ust-events/gen-ust-events.c
+++ b/tests/utils/testapp/gen-ust-events/gen-ust-events.c
@@ -1,18 +1,8 @@
 /*
- * Copyright (C) - 2012 David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
  *
- * This library is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License as published by the
- * Free Software Foundation; version 2.1 of the License.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * This library is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this library; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
 #define _LGPL_SOURCE
@@ -45,6 +35,9 @@ static struct option long_options[] =
        {"wait", required_argument, 0, 'w'},
        {"sync-after-first-event", required_argument, 0, 'a'},
        {"sync-before-last-event", required_argument, 0, 'b'},
+       {"sync-before-last-event-touch", required_argument, 0, 'c'},
+       {"sync-before-exit", required_argument, 0, 'd'},
+       {"sync-before-exit-touch", required_argument, 0, 'e'},
        {0, 0, 0, 0}
 };
 
@@ -55,12 +48,27 @@ int main(int argc, char **argv)
        int option;
        long values[] = { 1, 2, 3 };
        char text[10] = "test";
+       char escape[10] = "\\*";
        double dbl = 2.0;
        float flt = 2222.0;
+       uint32_t net_values[] = { 1, 2, 3 };
        int nr_iter = 100, ret = 0, first_event_file_created = 0;
        useconds_t nr_usec = 0;
        char *after_first_event_file_path = NULL;
        char *before_last_event_file_path = NULL;
+       /*
+        * Touch a file to indicate that all events except one were
+        * generated.
+        */
+       char *before_last_event_file_path_touch = NULL;
+       /* Touch file when we are exiting */
+       char *before_exit_file_path_touch = NULL;
+       /* Wait on file before exiting */
+       char *before_exit_file_path = NULL;
+
+       for (i = 0; i < 3; i++) {
+               net_values[i] = htonl(net_values[i]);
+       }
 
        while ((option = getopt_long(argc, argv, "i:w:a:b:c:d:",
                        long_options, &option_index)) != -1) {
@@ -71,6 +79,15 @@ int main(int argc, char **argv)
                case 'b':
                        before_last_event_file_path = strdup(optarg);
                        break;
+               case 'c':
+                       before_last_event_file_path_touch = strdup(optarg);
+                       break;
+               case 'd':
+                       before_exit_file_path = strdup(optarg);
+                       break;
+               case 'e':
+                       before_exit_file_path_touch = strdup(optarg);
+                       break;
                case 'i':
                        nr_iter = atoi(optarg);
                        break;
@@ -79,7 +96,6 @@ int main(int argc, char **argv)
                        break;
                case '?':
                        /* getopt_long already printed an error message. */
-                       break;
                default:
                        ret = -1;
                        goto end;
@@ -88,6 +104,17 @@ int main(int argc, char **argv)
 
        if (optind != argc) {
                fprintf(stderr, "Error: takes long options only.\n");
+
+               /*
+                * Aborting the test program for now because callers typically don't check
+                * the test program return value, and the transition from positional
+                * arguments to getopt causes hangs when caller scripts are not updated.
+                * An abort is easier to diagnose and fix. This is a temporary solution:
+                * we should eventually ensure that all scripts test and report the test
+                * app return values.
+                */
+               abort();
+
                ret = -1;
                goto end;
        }
@@ -100,6 +127,13 @@ int main(int argc, char **argv)
 
        for (i = 0; nr_iter < 0 || i < nr_iter; i++) {
                if (nr_iter >= 0 && i == nr_iter - 1) {
+                       if (before_last_event_file_path_touch) {
+                               ret = create_file(before_last_event_file_path_touch);
+                               if (ret != 0) {
+                                       goto end;
+                               }
+                       }
+
                        /*
                         * Wait on synchronization before writing last
                         * event.
@@ -113,7 +147,7 @@ int main(int argc, char **argv)
                }
                netint = htonl(i);
                tracepoint(tp, tptest, i, netint, values, text,
-                       strlen(text), dbl, flt);
+                       strlen(text), escape, net_values, dbl, flt);
 
                /*
                 * First loop we create the file if asked to indicate
@@ -140,8 +174,23 @@ int main(int argc, char **argv)
                }
        }
 
+       if (before_exit_file_path_touch) {
+               ret = create_file(before_exit_file_path_touch);
+               if (ret != 0) {
+                       goto end;
+               }
+       }
+       if (before_exit_file_path) {
+               ret = wait_on_file(before_exit_file_path);
+               if (ret != 0) {
+                       goto end;
+               }
+       }
 end:
        free(after_first_event_file_path);
        free(before_last_event_file_path);
+       free(before_last_event_file_path_touch);
+       free(before_exit_file_path);
+       free(before_exit_file_path_touch);
        exit(!ret ? EXIT_SUCCESS : EXIT_FAILURE);
 }