src/testbed/gnunet-testbed-profiler.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011, 2012 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  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_common.h"
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_testbed_service.h"
  31 #include "testbed_api_hosts.h"
  32
  33 /**
  34  * Generic loggins shorthand
  35  */
  36 #define LOG(kind,...)                                           \
  37   GNUNET_log (kind, __VA_ARGS__)
  38
  39
  40 /**
  41  * Handle to global configuration
  42  */
  43 struct GNUNET_CONFIGURATION_Handle *cfg;
  44
  45 /**
  46  * Peer linking - topology operation
  47  */
  48 struct GNUNET_TESTBED_Operation *topology_op;
  49
  50 /**
  51  * Name of the file with the hosts to run the test over (configuration option).
  52  * It will be NULL if ENABLE_LL is set
  53  */
  54 static char *hosts_file;
  55
  56 /**
  57  * Abort task identifier
  58  */
  59 static GNUNET_SCHEDULER_TaskIdentifier abort_task;
  60
  61 /**
  62  * Shutdown task identifier
  63  */
  64 static GNUNET_SCHEDULER_TaskIdentifier shutdown_task;
  65
  66 /**
  67  * Global event mask for all testbed events
  68  */
  69 uint64_t event_mask;
  70
  71 /**
  72  * Number of peers to be started by the profiler
  73  */
  74 static unsigned int num_peers;
  75
  76 /**
  77  * Number of timeout failures to tolerate
  78  */
  79 static unsigned int num_cont_fails;
  80
  81 /**
  82  * Continuous failures during overlay connect operations
  83  */
  84 static unsigned int cont_fails;
  85
  86 /**
  87  * Links which are successfully established
  88  */
  89 static unsigned int established_links;
  90
  91 /**
  92  * Links which are not successfully established
  93  */
  94 static unsigned int failed_links;
  95
  96 /**
  97  * Global testing status
  98  */
  99 static int result;
 100
 101
 102 /**
 103  * Shutdown nicely
 104  *
 105  * @param cls NULL
 106  * @param tc the task context
 107  */
 108 static void
 109 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 110 {
 111   shutdown_task = GNUNET_SCHEDULER_NO_TASK;
 112   if (GNUNET_SCHEDULER_NO_TASK != abort_task)
 113     GNUNET_SCHEDULER_cancel (abort_task);
 114   if (NULL != cfg)
 115     GNUNET_CONFIGURATION_destroy (cfg);
 116   GNUNET_SCHEDULER_shutdown (); /* Stop scheduler to shutdown testbed run */
 117 }
 118
 119
 120 /**
 121  * abort task to run on test timed out
 122  *
 123  * @param cls NULL
 124  * @param tc the task context
 125  */
 126 static void
 127 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 128 {
 129   LOG (GNUNET_ERROR_TYPE_WARNING, "Aborting\n");
 130   abort_task = GNUNET_SCHEDULER_NO_TASK;
 131   result = GNUNET_SYSERR;
 132   if (GNUNET_SCHEDULER_NO_TASK != shutdown_task)
 133     GNUNET_SCHEDULER_cancel (shutdown_task);
 134   shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
 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_cancel (abort_task);
 179         abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
 180         return;
 181       }
 182     }
 183     break;
 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   default:
 196     GNUNET_break (0);
 197   }
 198 }
 199
 200
 201 /**
 202  * Signature of a main function for a testcase.
 203  *
 204  * @param cls closure
 205  * @param num_peers number of peers in 'peers'
 206  * @param peers handle to peers run in the testbed
 207  * @param links_succeeded the number of overlay link connection attempts that
 208  *          succeeded
 209  * @param links_failed the number of overlay link
 210  */
 211 static void
 212 test_run (void *cls, unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers,
 213           unsigned int links_succeeded,
 214           unsigned int links_failed)
 215 {
 216   result = GNUNET_OK;
 217   fprintf (stdout, "\n");
 218   print_overlay_links_summary ();
 219   fprintf (stdout, "Testbed running, waiting for keystroke to shut down\n");
 220   fflush (stdout);
 221   (void) getc (stdin);
 222   fprintf (stdout, "Shutting down. Please wait\n");
 223   fflush (stdout);
 224   shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
 225 }
 226
 227
 228 /**
 229  * Main function that will be run by the scheduler.
 230  *
 231  * @param cls closure
 232  * @param args remaining command-line arguments
 233  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 234  * @param config configuration
 235  */
 236 static void
 237 run (void *cls, char *const *args, const char *cfgfile,
 238      const struct GNUNET_CONFIGURATION_Handle *config)
 239 {
 240   if (0 == num_peers)
 241   {
 242     LOG (GNUNET_ERROR_TYPE_ERROR, _("Exiting as the number of peers is %u\n"),
 243          num_peers);
 244     return;
 245   }
 246   cfg = GNUNET_CONFIGURATION_dup (config);
 247   event_mask = 0;
 248   event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
 249   event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
 250   GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask, controller_event_cb,
 251                       NULL, &test_run, NULL);
 252   abort_task =
 253       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_abort,
 254                                     NULL);
 255 }
 256
 257
 258 /**
 259  * Main function.
 260  *
 261  * @return 0 on success
 262  */
 263 int
 264 main (int argc, char *const *argv)
 265 {
 266   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 267     {'p', "num-peers", "COUNT",
 268      gettext_noop ("create COUNT number of peers"),
 269      GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers},
 270     {'e', "num-errors", "COUNT",
 271      gettext_noop ("tolerate COUNT number of continious timeout failures"),
 272      GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_cont_fails},
 273 #if !ENABLE_LL
 274     {'H', "hosts", "FILENAME",
 275      gettext_noop ("name of the file with the login information for the testbed"),
 276      GNUNET_YES, &GNUNET_GETOPT_set_string, &hosts_file},
 277 #endif
 278     GNUNET_GETOPT_OPTION_END
 279   };
 280   const char *binaryHelp = "gnunet-testbed-profiler [OPTIONS]";
 281   int ret;
 282
 283   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 284     return 2;
 285   result = GNUNET_SYSERR;
 286   ret =
 287       GNUNET_PROGRAM_run (argc, argv, "gnunet-testbed-profiler", binaryHelp,
 288                           options, &run, NULL);
 289   GNUNET_free ((void *) argv);
 290   if (GNUNET_OK != ret)
 291     return ret;
 292   if (GNUNET_OK != result)
 293     return 1;
 294   return 0;
 295 }