src/testbed/gnunet-testbed-helper.c

   1 /*
   2       This file is part of GNUnet
   3       (C) 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-helper.c
  23  * @brief Helper binary that is started from a remote controller to start
  24  *          gnunet-service-testbed. This binary also receives configuration
  25  *          from the remove controller which is put in a temporary location
  26  *          with ports and paths fixed so that gnunet-service-testbed runs
  27  *          without any hurdles. This binary also kills the testbed service
  28  *          should the connection from the remote controller is dropped
  29  * @author Sree Harsha Totakura <sreeharsha@totakura.in>
  30  */
  31
  32
  33 #include "platform.h"
  34 #include "gnunet_util_lib.h"
  35 #include "gnunet_testing_lib-new.h"
  36 #include "gnunet_testbed_service.h"
  37 #include "testbed_helper.h"
  38 #include "testbed_api.h"
  39 #include <zlib.h>
  40
  41 /**
  42  * Generic logging shortcut
  43  */
  44 #define LOG(kind, ...)                                   \
  45   GNUNET_log (kind, __VA_ARGS__)
  46
  47 /**
  48  * Debug logging shorthand
  49  */
  50 #define LOG_DEBUG(...)                          \
  51   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
  52
  53
  54 /**
  55  * Context for a single write on a chunk of memory
  56  */
  57 struct WriteContext
  58 {
  59   /**
  60    * The data to write
  61    */
  62   void *data;
  63
  64   /**
  65    * The length of the data
  66    */
  67   size_t length;
  68
  69   /**
  70    * The current position from where the write operation should begin
  71    */
  72   size_t pos;
  73 };
  74
  75
  76 /**
  77  * Handle to the testing system
  78  */
  79 static struct GNUNET_TESTING_System *test_system;
  80
  81 /**
  82  * Our message stream tokenizer
  83  */
  84 struct GNUNET_SERVER_MessageStreamTokenizer *tokenizer;
  85
  86 /**
  87  * Disk handle from stdin
  88  */
  89 static struct GNUNET_DISK_FileHandle *stdin_fd;
  90
  91 /**
  92  * Disk handle for stdout
  93  */
  94 static struct GNUNET_DISK_FileHandle *stdout_fd;
  95
  96 /**
  97  * The process handle to the testbed service
  98  */
  99 static struct GNUNET_OS_Process *testbed;
 100
 101 /**
 102  * Task identifier for the read task
 103  */
 104 static GNUNET_SCHEDULER_TaskIdentifier read_task_id;
 105
 106 /**
 107  * Task identifier for the write task
 108  */
 109 static GNUNET_SCHEDULER_TaskIdentifier write_task_id;
 110
 111 /**
 112  * Are we done reading messages from stdin?
 113  */
 114 static int done_reading;
 115
 116 /**
 117  * Result to return in case we fail
 118  */
 119 static int status;
 120
 121
 122 /**
 123  * Are we shutting down
 124  */
 125 static int in_shutdown;
 126
 127
 128 /**
 129  * Task to shutting down nicely
 130  *
 131  * @param cls NULL
 132  * @param tc the task context
 133  */
 134 static void
 135 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 136 {
 137   LOG_DEBUG ("Shutting down\n");
 138   in_shutdown = GNUNET_YES;
 139   if (GNUNET_SCHEDULER_NO_TASK != read_task_id)
 140   {
 141     GNUNET_SCHEDULER_cancel (read_task_id);
 142     read_task_id = GNUNET_SCHEDULER_NO_TASK;
 143   }
 144   if (GNUNET_SCHEDULER_NO_TASK != write_task_id)
 145   {
 146     GNUNET_SCHEDULER_cancel (write_task_id);
 147     write_task_id = GNUNET_SCHEDULER_NO_TASK;
 148   }
 149   if (NULL != stdin_fd)
 150     (void) GNUNET_DISK_file_close (stdin_fd);
 151   if (NULL != stdout_fd)
 152     (void) GNUNET_DISK_file_close (stdout_fd);
 153   GNUNET_SERVER_mst_destroy (tokenizer);
 154   tokenizer = NULL;
 155   if (NULL != testbed)
 156   {
 157     LOG_DEBUG ("Killing testbed\n");
 158     GNUNET_break (0 == GNUNET_OS_process_kill (testbed, SIGTERM));
 159     GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (testbed));
 160     GNUNET_OS_process_destroy (testbed);
 161     testbed = NULL;
 162   }
 163   if (NULL != test_system)
 164   {
 165     GNUNET_TESTING_system_destroy (test_system, GNUNET_YES);
 166     test_system = NULL;
 167   }
 168 }
 169
 170
 171 /**
 172  * Task to write to the standard out
 173  *
 174  * @param cls the WriteContext
 175  * @param tc the TaskContext
 176  */
 177 static void
 178 write_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 179 {
 180   struct WriteContext *wc = cls;
 181   ssize_t bytes_wrote;
 182
 183   GNUNET_assert (NULL != wc);
 184   write_task_id = GNUNET_SCHEDULER_NO_TASK;
 185   if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
 186   {
 187     GNUNET_free (wc->data);
 188     GNUNET_free (wc);
 189     return;
 190   }
 191   bytes_wrote = GNUNET_DISK_file_write (stdout_fd, wc->data + wc->pos,
 192                                         wc->length - wc->pos);
 193   GNUNET_assert (GNUNET_SYSERR != bytes_wrote);
 194   wc->pos += bytes_wrote;
 195   if (wc->pos == wc->length)
 196   {
 197     GNUNET_free (wc->data);
 198     GNUNET_free (wc);
 199     return;
 200   }
 201   write_task_id = GNUNET_SCHEDULER_add_write_file
 202     (GNUNET_TIME_UNIT_FOREVER_REL, stdout_fd, &write_task, wc);
 203 }
 204
 205
 206 /**
 207  * Functions with this signature are called whenever a
 208  * complete message is received by the tokenizer.
 209  *
 210  * Do not call GNUNET_SERVER_mst_destroy in callback
 211  *
 212  * @param cls closure
 213  * @param client identification of the client
 214  * @param message the actual message
 215  *
 216  * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
 217  */
 218 static int
 219 tokenizer_cb (void *cls, void *client,
 220               const struct GNUNET_MessageHeader *message)
 221 {
 222   const struct GNUNET_TESTBED_HelperInit *msg;
 223   struct GNUNET_TESTBED_HelperReply *reply;
 224   struct GNUNET_CONFIGURATION_Handle *cfg;
 225   struct WriteContext *wc;
 226   char *controller;
 227   char *config;
 228   char *xconfig;
 229   size_t config_size;
 230   uLongf ul_config_size;
 231   size_t xconfig_size;
 232   uint16_t cname_size;
 233
 234   if ((sizeof (struct GNUNET_TESTBED_HelperInit) >= ntohs (message->size)) ||
 235       (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT != ntohs (message->type)))
 236   {
 237     LOG (GNUNET_ERROR_TYPE_WARNING,
 238          "Received unexpected message -- exiting\n");
 239     goto error;
 240   }
 241   msg = (const struct GNUNET_TESTBED_HelperInit *) message;
 242   cname_size = ntohs (msg->cname_size);
 243   controller = (char *) &msg[1];
 244   if ('\0' != controller[cname_size])
 245   {
 246     LOG (GNUNET_ERROR_TYPE_WARNING,
 247          "Controller name cannot be empty -- exiting\n");
 248     goto error;
 249   }
 250   ul_config_size = (uLongf) ntohs (msg->config_size);
 251   config = GNUNET_malloc (ul_config_size);
 252   xconfig_size = ntohs (message->size) -
 253     (cname_size + 1 + sizeof (struct GNUNET_TESTBED_HelperInit));
 254   if (Z_OK != uncompress ((Bytef *) config, &ul_config_size,
 255                           (const Bytef *) (controller + cname_size + 1),
 256                           (uLongf) xconfig_size))
 257   {
 258     LOG (GNUNET_ERROR_TYPE_WARNING,
 259          "Error while uncompressing config -- exiting\n");
 260     GNUNET_free (config);
 261     goto error;
 262   }
 263   cfg = GNUNET_CONFIGURATION_create ();
 264   if (GNUNET_OK != GNUNET_CONFIGURATION_deserialize (cfg, config,
 265                                                      ul_config_size, GNUNET_NO))
 266   {
 267     LOG (GNUNET_ERROR_TYPE_WARNING,
 268          "Unable to deserialize config -- exiting\n");
 269     GNUNET_free (config);
 270     goto error;
 271   }
 272   GNUNET_free (config);
 273   test_system = GNUNET_TESTING_system_create ("testbed-helper", controller);
 274   GNUNET_assert (NULL != test_system);
 275   GNUNET_assert (GNUNET_OK ==  GNUNET_TESTING_configuration_create
 276                  (test_system, cfg));
 277   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string
 278                  (cfg, "PATHS", "DEFAULTCONFIG", &config));
 279   if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg, config))
 280   {
 281     LOG (GNUNET_ERROR_TYPE_WARNING,
 282          "Unable to write config file: %s -- exiting\n", config);
 283     GNUNET_CONFIGURATION_destroy (cfg);
 284     GNUNET_free (config);
 285     goto error;
 286   }
 287   LOG_DEBUG ("Staring testbed with config: %s\n", config);
 288   testbed = GNUNET_OS_start_process
 289     (GNUNET_YES, GNUNET_OS_INHERIT_STD_ERR /*verbose? */, NULL, NULL,
 290      "gnunet-service-testbed", "gnunet-service-testbed", "-c", config, NULL);
 291   GNUNET_free (config);
 292   if (NULL == testbed)
 293   {
 294     LOG (GNUNET_ERROR_TYPE_WARNING,
 295          "Error staring gnunet-service-testbed -- exiting\n");
 296     GNUNET_CONFIGURATION_destroy (cfg);
 297     goto error;
 298   }
 299   done_reading = GNUNET_YES;
 300   config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
 301   GNUNET_CONFIGURATION_destroy (cfg);
 302   cfg = NULL;
 303   xconfig_size = GNUNET_TESTBED_compress_config_ (config, config_size,
 304                                                   &xconfig);
 305   GNUNET_free (config);
 306   wc = GNUNET_malloc (sizeof (struct WriteContext));
 307   wc->length = xconfig_size + sizeof (struct GNUNET_TESTBED_HelperReply);
 308   reply = GNUNET_realloc (xconfig, wc->length);
 309   memmove (&reply[1], reply, xconfig_size);
 310   reply->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY);
 311   reply->header.size = htons ((uint16_t) wc->length);
 312   reply->config_size = htons ((uint16_t) config_size);
 313   wc->data = reply;
 314   write_task_id = GNUNET_SCHEDULER_add_write_file
 315     (GNUNET_TIME_UNIT_FOREVER_REL, stdout_fd, &write_task, wc);
 316   return GNUNET_OK;
 317
 318  error:
 319   status = GNUNET_SYSERR;
 320   GNUNET_SCHEDULER_shutdown ();
 321   return GNUNET_SYSERR;
 322 }
 323
 324
 325 /**
 326  * Task to read from stdin
 327  *
 328  * @param cls NULL
 329  * @param tc the task context
 330  */
 331 static void
 332 read_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 333 {
 334   char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE];
 335   ssize_t sread;
 336
 337   read_task_id = GNUNET_SCHEDULER_NO_TASK;
 338   if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
 339     return;
 340   sread = GNUNET_DISK_file_read (stdin_fd, buf, sizeof (buf));
 341   if ((GNUNET_SYSERR == sread) || (0 == sread))
 342   {
 343     GNUNET_SCHEDULER_shutdown ();
 344     return;
 345   }
 346   if (GNUNET_YES == done_reading)
 347   {
 348     /* didn't expect any more data! */
 349     GNUNET_SCHEDULER_shutdown ();
 350     return;
 351   }
 352   LOG_DEBUG ("Read %u bytes\n", sread);
 353   if (GNUNET_OK !=
 354       GNUNET_SERVER_mst_receive (tokenizer, NULL, buf, sread,
 355                                  GNUNET_NO, GNUNET_NO))
 356   {
 357     GNUNET_break (0);
 358     GNUNET_SCHEDULER_shutdown ();
 359     return;
 360   }
 361   read_task_id =                /* No timeout while reading */
 362     GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 363                                     stdin_fd, &read_task, NULL);
 364 }
 365
 366
 367 /**
 368  * Main function that will be run.
 369  *
 370  * @param cls closure
 371  * @param args remaining command-line arguments
 372  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 373  * @param cfg configuration
 374  */
 375 static void
 376 run (void *cls, char *const *args, const char *cfgfile,
 377      const struct GNUNET_CONFIGURATION_Handle * cfg)
 378 {
 379   LOG_DEBUG ("Starting testbed helper...\n");
 380   tokenizer = GNUNET_SERVER_mst_create (&tokenizer_cb, NULL);
 381   stdin_fd = GNUNET_DISK_get_handle_from_native (stdin);
 382   stdout_fd = GNUNET_DISK_get_handle_from_native (stdout);
 383   read_task_id =
 384     GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 385                                     stdin_fd, &read_task, NULL);
 386   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 387                                 &shutdown_task, NULL);
 388 }
 389
 390
 391 /**
 392  * Signal handler called for SIGCHLD.
 393  */
 394 static void
 395 sighandler_child_death ()
 396 {
 397   if ((NULL != testbed) && (GNUNET_NO == in_shutdown))
 398   {
 399     LOG_DEBUG ("Child died\n");
 400     GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (testbed));
 401     GNUNET_OS_process_destroy (testbed);
 402     testbed = NULL;
 403     GNUNET_SCHEDULER_shutdown ();       /* We are done too! */
 404   }
 405 }
 406
 407
 408 /**
 409  * Main function
 410  *
 411  * @param argc the number of command line arguments
 412  * @param argv command line arg array
 413  * @return return code
 414  */
 415 int main (int argc, char **argv)
 416 {
 417   struct GNUNET_SIGNAL_Context *shc_chld;
 418   struct GNUNET_GETOPT_CommandLineOption options[] = {
 419     GNUNET_GETOPT_OPTION_END
 420   };
 421   int ret;
 422
 423   status = GNUNET_OK;
 424   in_shutdown = GNUNET_NO;
 425   //sleep (60);
 426   shc_chld =
 427     GNUNET_SIGNAL_handler_install (GNUNET_SIGCHLD, &sighandler_child_death);
 428   ret = GNUNET_PROGRAM_run (argc, argv, "gnunet-testbed-helper",
 429                                  "Helper for starting gnunet-service-testbed",
 430                             options, &run, NULL);
 431   GNUNET_SIGNAL_handler_uninstall (shc_chld);
 432   shc_chld = NULL;
 433   if (GNUNET_OK != ret)
 434     return 1;
 435   return (GNUNET_OK == status) ? 0 : 1;
 436 }
 437
 438 /* end of gnunet-testbed-helper.c */