tests/utils/testapp/gen-ust-events/gen-ust-events.cpp

   1 /*
   2  * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #define _LGPL_SOURCE
   9 #include "signal-helper.hpp"
  10 #include "utils.h"
  11
  12 #include <arpa/inet.h>
  13 #include <errno.h>
  14 #include <fcntl.h>
  15 #include <getopt.h>
  16 #include <poll.h>
  17 #include <signal.h>
  18 #include <stdarg.h>
  19 #include <stdbool.h>
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <sys/mman.h>
  24 #include <sys/stat.h>
  25 #include <sys/types.h>
  26 #include <unistd.h>
  27
  28 #define TRACEPOINT_DEFINE
  29 #include "tp.h"
  30
  31 static struct option long_options[] = {
  32         /* These options set a flag. */
  33         { "iter", required_argument, 0, 'i' },
  34         { "wait", required_argument, 0, 'w' },
  35         { "sync-after-first-event", required_argument, 0, 'a' },
  36         { "sync-before-last-event", required_argument, 0, 'b' },
  37         { "sync-before-last-event-touch", required_argument, 0, 'c' },
  38         { "sync-before-exit", required_argument, 0, 'd' },
  39         { "sync-before-exit-touch", required_argument, 0, 'e' },
  40         { "emit-end-event", no_argument, 0, 'f' },
  41         { 0, 0, 0, 0 }
  42 };
  43
  44 int main(int argc, char **argv)
  45 {
  46         unsigned int i, netint;
  47         int option_index;
  48         int option;
  49         long values[] = { 1, 2, 3 };
  50         char text[10] = "test";
  51         char escape[10] = "\\*";
  52         double dbl = 2.0;
  53         float flt = 2222.0;
  54         uint32_t net_values[] = { 1, 2, 3 };
  55         int nr_iter = 100, ret = 0, first_event_file_created = 0;
  56         useconds_t nr_usec = 0;
  57         char *after_first_event_file_path = NULL;
  58         char *before_last_event_file_path = NULL;
  59         /*
  60          * Touch a file to indicate that all events except one were
  61          * generated.
  62          */
  63         char *before_last_event_file_path_touch = NULL;
  64         /* Touch file when we are exiting */
  65         char *before_exit_file_path_touch = NULL;
  66         /* Wait on file before exiting */
  67         char *before_exit_file_path = NULL;
  68         /* Emit an end event */
  69         bool emit_end_event = false;
  70
  71         for (i = 0; i < 3; i++) {
  72                 net_values[i] = htonl(net_values[i]);
  73         }
  74
  75         while ((option = getopt_long(argc, argv, "i:w:a:b:c:d:e:f", long_options, &option_index)) !=
  76                -1) {
  77                 switch (option) {
  78                 case 'a':
  79                         after_first_event_file_path = strdup(optarg);
  80                         break;
  81                 case 'b':
  82                         before_last_event_file_path = strdup(optarg);
  83                         break;
  84                 case 'c':
  85                         before_last_event_file_path_touch = strdup(optarg);
  86                         break;
  87                 case 'd':
  88                         before_exit_file_path = strdup(optarg);
  89                         break;
  90                 case 'e':
  91                         before_exit_file_path_touch = strdup(optarg);
  92                         break;
  93                 case 'f':
  94                         emit_end_event = true;
  95                         break;
  96                 case 'i':
  97                         nr_iter = atoi(optarg);
  98                         break;
  99                 case 'w':
 100                         nr_usec = atoi(optarg);
 101                         break;
 102                 case '?':
 103                         /* getopt_long already printed an error message. */
 104                 default:
 105                         ret = -1;
 106                         goto end;
 107                 }
 108         }
 109
 110         if (optind != argc) {
 111                 fprintf(stderr, "Error: takes long options only.\n");
 112
 113                 /*
 114                  * Aborting the test program for now because callers typically don't check
 115                  * the test program return value, and the transition from positional
 116                  * arguments to getopt causes hangs when caller scripts are not updated.
 117                  * An abort is easier to diagnose and fix. This is a temporary solution:
 118                  * we should eventually ensure that all scripts test and report the test
 119                  * app return values.
 120                  */
 121                 abort();
 122
 123                 ret = -1;
 124                 goto end;
 125         }
 126
 127         if (set_signal_handler()) {
 128                 ret = -1;
 129                 goto end;
 130         }
 131
 132         for (i = 0; nr_iter < 0 || i < nr_iter; i++) {
 133                 if (nr_iter >= 0 && i == nr_iter - 1) {
 134                         if (before_last_event_file_path_touch) {
 135                                 ret = create_file(before_last_event_file_path_touch);
 136                                 if (ret != 0) {
 137                                         goto end;
 138                                 }
 139                         }
 140
 141                         /*
 142                          * Wait on synchronization before writing last
 143                          * event.
 144                          */
 145                         if (before_last_event_file_path) {
 146                                 ret = wait_on_file(before_last_event_file_path);
 147                                 if (ret != 0) {
 148                                         goto end;
 149                                 }
 150                         }
 151                 }
 152                 netint = htonl(i);
 153                 tracepoint(tp,
 154                            tptest,
 155                            i,
 156                            netint,
 157                            values,
 158                            text,
 159                            strlen(text),
 160                            escape,
 161                            net_values,
 162                            dbl,
 163                            flt);
 164
 165                 /*
 166                  * First loop we create the file if asked to indicate
 167                  * that at least one tracepoint has been hit.
 168                  */
 169                 if (after_first_event_file_path && first_event_file_created == 0) {
 170                         ret = create_file(after_first_event_file_path);
 171
 172                         if (ret != 0) {
 173                                 goto end;
 174                         } else {
 175                                 first_event_file_created = 1;
 176                         }
 177                 }
 178
 179                 if (nr_usec) {
 180                         if (usleep_safe(nr_usec)) {
 181                                 ret = -1;
 182                                 goto end;
 183                         }
 184                 }
 185                 if (should_quit) {
 186                         break;
 187                 }
 188         }
 189
 190         if (emit_end_event) {
 191                 tracepoint(tp, end);
 192         }
 193
 194         if (before_exit_file_path_touch) {
 195                 ret = create_file(before_exit_file_path_touch);
 196                 if (ret != 0) {
 197                         goto end;
 198                 }
 199         }
 200         if (before_exit_file_path) {
 201                 ret = wait_on_file(before_exit_file_path);
 202                 if (ret != 0) {
 203                         goto end;
 204                 }
 205         }
 206 end:
 207         free(after_first_event_file_path);
 208         free(before_last_event_file_path);
 209         free(before_last_event_file_path_touch);
 210         free(before_exit_file_path);
 211         free(before_exit_file_path_touch);
 212         exit(!ret ? EXIT_SUCCESS : EXIT_FAILURE);
 213 }