src/testbed/gnunet-testbed-profiler.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2008--2013 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @file testbed/gnunet-testbed-profiler.c
  23  * @brief Profiling driver for the testbed.
  24  * @author Sree Harsha Totakura <sreeharsha@totakura.in>
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_testbed_service.h"
  30 #include "testbed_api_hosts.h"
  31
  32 /**
  33  * Generic loggins shorthand
  34  */
  35 #define LOG(kind, ...)                                           \
  36   GNUNET_log (kind, __VA_ARGS__)
  37
  38
  39 /**
  40  * Handle to global configuration
  41  */
  42 struct GNUNET_CONFIGURATION_Handle *cfg;
  43
  44 /**
  45  * Peer linking - topology operation
  46  */
  47 struct GNUNET_TESTBED_Operation *topology_op;
  48
  49 /**
  50  * Name of the file with the hosts to run the test over (configuration option).
  51  * It will be NULL if ENABLE_LL is set
  52  */
  53 static char *hosts_file;
  54
  55 /**
  56  * Abort task identifier
  57  */
  58 static struct GNUNET_SCHEDULER_Task *abort_task;
  59
  60 /**
  61  * Global event mask for all testbed events
  62  */
  63 uint64_t event_mask;
  64
  65 /**
  66  * Number of peers to be started by the profiler
  67  */
  68 static unsigned int num_peers;
  69
  70 /**
  71  * Number of timeout failures to tolerate
  72  */
  73 static unsigned int num_cont_fails;
  74
  75 /**
  76  * Continuous failures during overlay connect operations
  77  */
  78 static unsigned int cont_fails;
  79
  80 /**
  81  * Links which are successfully established
  82  */
  83 static unsigned int established_links;
  84
  85 /**
  86  * Links which are not successfully established
  87  */
  88 static unsigned int failed_links;
  89
  90 /**
  91  * Global testing status
  92  */
  93 static int result;
  94
  95 /**
  96  * Are we running non interactively
  97  */
  98 static int noninteractive;
  99
 100
 101 /**
 102  * Shutdown nicely
 103  *
 104  * @param cls NULL
 105  */
 106 static void
 107 do_shutdown (void *cls)
 108 {
 109   if (NULL != abort_task)
 110   {
 111     GNUNET_SCHEDULER_cancel (abort_task);
 112     abort_task = NULL;
 113   }
 114   if (NULL != cfg)
 115   {
 116     GNUNET_CONFIGURATION_destroy (cfg);
 117     cfg = NULL;
 118   }
 119 }
 120
 121
 122 /**
 123  * abort task to run on test timed out
 124  *
 125  * @param cls NULL
 126  */
 127 static void
 128 do_abort (void *cls)
 129 {
 130   abort_task = NULL;
 131   LOG (GNUNET_ERROR_TYPE_WARNING,
 132        "Aborting\n");
 133   result = GNUNET_SYSERR;
 134   GNUNET_SCHEDULER_shutdown ();
 135 }
 136
 137
 138 /**
 139  * Function to print summary about how many overlay links we have made and how
 140  * many failed
 141  */
 142 static void
 143 print_overlay_links_summary ()
 144 {
 145   static int printed_already;
 146
 147   if (GNUNET_YES == printed_already)
 148     return;
 149   printed_already = GNUNET_YES;
 150   printf ("%u links succeeded\n", established_links);
 151   printf ("%u links failed due to timeouts\n", failed_links);
 152 }
 153
 154
 155 /**
 156  * Controller event callback
 157  *
 158  * @param cls NULL
 159  * @param event the controller event
 160  */
 161 static void
 162 controller_event_cb (void *cls,
 163                      const struct GNUNET_TESTBED_EventInformation *event)
 164 {
 165   switch (event->type)
 166   {
 167   case GNUNET_TESTBED_ET_OPERATION_FINISHED:
 168     /* Control reaches here when a peer linking operation fails */
 169     if (NULL != event->details.operation_finished.emsg)
 170     {
 171       printf ("F");
 172       fflush (stdout);
 173       failed_links++;
 174       if (++cont_fails > num_cont_fails)
 175       {
 176         printf ("\nAborting due to very high failure rate\n");
 177         print_overlay_links_summary ();
 178         GNUNET_SCHEDULER_shutdown ();
 179         return;
 180       }
 181     }
 182     break;
 183
 184   case GNUNET_TESTBED_ET_CONNECT:
 185     {
 186       if (0 != cont_fails)
 187         cont_fails--;
 188       if (0 == established_links)
 189         printf ("Establishing links. Please wait\n");
 190       printf (".");
 191       fflush (stdout);
 192       established_links++;
 193     }
 194     break;
 195
 196   default:
 197     GNUNET_break (0);
 198   }
 199 }
 200
 201
 202 /**
 203  * Signature of a main function for a testcase.
 204  *
 205  * @param cls closure
 206  * @param h the run handle
 207  * @param num_peers number of peers in 'peers'
 208  * @param peers handle to peers run in the testbed
 209  * @param links_succeeded the number of overlay link connection attempts that
 210  *          succeeded
 211  * @param links_failed the number of overlay link
 212  */
 213 static void
 214 test_run (void *cls,
 215           struct GNUNET_TESTBED_RunHandle *h,
 216           unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers,
 217           unsigned int links_succeeded,
 218           unsigned int links_failed)
 219 {
 220   result = GNUNET_OK;
 221   fprintf (stdout, "\n");
 222   print_overlay_links_summary ();
 223   GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
 224   if (noninteractive)
 225   {
 226     GNUNET_SCHEDULER_cancel (abort_task);
 227     abort_task = NULL;
 228     return;
 229   }
 230 #if (! ENABLE_SUPERMUC)
 231   fprintf (stdout, "Testbed running, waiting for keystroke to shut down\n");
 232   fflush (stdout);
 233   (void) getc (stdin);
 234 #endif
 235   fprintf (stdout, "Shutting down. Please wait\n");
 236   fflush (stdout);
 237   GNUNET_SCHEDULER_shutdown ();
 238 }
 239
 240
 241 /**
 242  * Main function that will be run by the scheduler.
 243  *
 244  * @param cls closure
 245  * @param args remaining command-line arguments
 246  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 247  * @param config configuration
 248  */
 249 static void
 250 run (void *cls, char *const *args, const char *cfgfile,
 251      const struct GNUNET_CONFIGURATION_Handle *config)
 252 {
 253   if (0 == num_peers)
 254   {
 255     LOG (GNUNET_ERROR_TYPE_ERROR, _ ("Exiting as the number of peers is %u\n"),
 256          num_peers);
 257     return;
 258   }
 259   cfg = GNUNET_CONFIGURATION_dup (config);
 260   event_mask = 0;
 261   event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
 262   event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
 263   GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask,
 264                       &controller_event_cb, NULL,
 265                       &test_run, NULL);
 266   abort_task =
 267     GNUNET_SCHEDULER_add_shutdown (&do_abort,
 268                                    NULL);
 269 }
 270
 271
 272 /**
 273  * Main function.
 274  *
 275  * @return 0 on success
 276  */
 277 int
 278 main (int argc, char *const *argv)
 279 {
 280   struct GNUNET_GETOPT_CommandLineOption options[] = {
 281     GNUNET_GETOPT_option_uint ('p',
 282                                "num-peers",
 283                                "COUNT",
 284                                gettext_noop ("create COUNT number of peers"),
 285                                &num_peers),
 286     GNUNET_GETOPT_option_uint ('e',
 287                                "num-errors",
 288                                "COUNT",
 289                                gettext_noop (
 290                                  "tolerate COUNT number of continious timeout failures"),
 291                                &num_cont_fails),
 292     GNUNET_GETOPT_option_flag ('n',
 293                                "non-interactive",
 294                                gettext_noop (
 295                                  "run profiler in non-interactive mode where upon "
 296                                  "testbed setup the profiler does not wait for a "
 297                                  "keystroke but continues to run until a termination "
 298                                  "signal is received"),
 299                                &noninteractive),
 300 #if ! ENABLE_SUPERMUC
 301     GNUNET_GETOPT_option_string ('H',
 302                                  "hosts",
 303                                  "FILENAME",
 304                                  gettext_noop (
 305                                    "name of the file with the login information for the testbed"),
 306                                  &hosts_file),
 307 #endif
 308     GNUNET_GETOPT_OPTION_END
 309   };
 310   const char *binaryHelp = "gnunet-testbed-profiler [OPTIONS]";
 311   int ret;
 312
 313   unsetenv ("XDG_DATA_HOME");
 314   unsetenv ("XDG_CONFIG_HOME");
 315   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 316     return 2;
 317   result = GNUNET_SYSERR;
 318   ret =
 319     GNUNET_PROGRAM_run (argc, argv, "gnunet-testbed-profiler", binaryHelp,
 320                         options, &run, NULL);
 321   GNUNET_free ((void *) argv);
 322   if (GNUNET_OK != ret)
 323     return ret;
 324   if (GNUNET_OK != result)
 325     return 1;
 326   return 0;
 327 }