src/testbed/gnunet-helper-testbed.c

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2008--2013, 2016 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, USA.
  19  */
  20
  21 /**
  22  * @file testbed/gnunet-helper-testbed.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.
  28  *
  29  *          This helper monitors for three termination events.  They are: (1)The
  30  *          stdin of the helper is closed for reading; (2)the helper received
  31  *          SIGTERM/SIGINT; (3)the testbed crashed.  In case of events 1 and 2
  32  *          the helper kills the testbed service.  When testbed crashed (event
  33  *          3), the helper should send a SIGTERM to its own process group; this
  34  *          behaviour will help terminate any child processes (peers) testbed
  35  *          has started and prevents them from leaking and running forever.
  36  *
  37  * @author Sree Harsha Totakura <sreeharsha@totakura.in>
  38  */
  39
  40
  41 #include "platform.h"
  42 #include "gnunet_util_lib.h"
  43 #include "gnunet_testing_lib.h"
  44 #include "gnunet_testbed_service.h"
  45 #include "testbed_helper.h"
  46 #include "testbed_api.h"
  47 #include <zlib.h>
  48
  49 /**
  50  * Generic logging shortcut
  51  */
  52 #define LOG(kind, ...)                                   \
  53   GNUNET_log (kind, __VA_ARGS__)
  54
  55 /**
  56  * Debug logging shorthand
  57  */
  58 #define LOG_DEBUG(...)                          \
  59   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
  60
  61
  62 /**
  63  * We need pipe control only on WINDOWS
  64  */
  65 #if WINDOWS
  66 #define PIPE_CONTROL GNUNET_YES
  67 #else
  68 #define PIPE_CONTROL GNUNET_NO
  69 #endif
  70
  71
  72 /**
  73  * Context for a single write on a chunk of memory
  74  */
  75 struct WriteContext
  76 {
  77   /**
  78    * The data to write
  79    */
  80   void *data;
  81
  82   /**
  83    * The length of the data
  84    */
  85   size_t length;
  86
  87   /**
  88    * The current position from where the write operation should begin
  89    */
  90   size_t pos;
  91 };
  92
  93
  94 /**
  95  * Handle to the testing system
  96  */
  97 static struct GNUNET_TESTING_System *test_system;
  98
  99 /**
 100  * Our message stream tokenizer
 101  */
 102 struct GNUNET_MessageStreamTokenizer *tokenizer;
 103
 104 /**
 105  * Disk handle from stdin
 106  */
 107 static struct GNUNET_DISK_FileHandle *stdin_fd;
 108
 109 /**
 110  * Disk handle for stdout
 111  */
 112 static struct GNUNET_DISK_FileHandle *stdout_fd;
 113
 114 /**
 115  * The process handle to the testbed service
 116  */
 117 static struct GNUNET_OS_Process *testbed;
 118
 119 /**
 120  * Pipe used to communicate shutdown via signal.
 121  */
 122 static struct GNUNET_DISK_PipeHandle *sigpipe;
 123
 124 /**
 125  * Task identifier for the read task
 126  */
 127 static struct GNUNET_SCHEDULER_Task *read_task_id;
 128
 129 /**
 130  * Task identifier for the write task
 131  */
 132 static struct GNUNET_SCHEDULER_Task *write_task_id;
 133
 134 /**
 135  * Task to kill the child
 136  */
 137 static struct GNUNET_SCHEDULER_Task *child_death_task_id;
 138
 139 /**
 140  * Are we done reading messages from stdin?
 141  */
 142 static int done_reading;
 143
 144 /**
 145  * Result to return in case we fail
 146  */
 147 static int status;
 148
 149
 150 /**
 151  * Task to shut down cleanly
 152  *
 153  * @param cls NULL
 154  */
 155 static void
 156 shutdown_task (void *cls)
 157 {
 158   LOG_DEBUG ("Shutting down\n");
 159   if (NULL != testbed)
 160   {
 161     LOG_DEBUG ("Killing testbed\n");
 162     GNUNET_break (0 == GNUNET_OS_process_kill (testbed, GNUNET_TERM_SIG));
 163   }
 164   if (NULL != read_task_id)
 165   {
 166     GNUNET_SCHEDULER_cancel (read_task_id);
 167     read_task_id = NULL;
 168   }
 169   if (NULL != write_task_id)
 170   {
 171     struct WriteContext *wc;
 172
 173     wc = GNUNET_SCHEDULER_cancel (write_task_id);
 174     write_task_id = NULL;
 175     GNUNET_free (wc->data);
 176     GNUNET_free (wc);
 177   }
 178   if (NULL != child_death_task_id)
 179   {
 180     GNUNET_SCHEDULER_cancel (child_death_task_id);
 181     child_death_task_id = NULL;
 182   }
 183   if (NULL != stdin_fd)
 184     (void) GNUNET_DISK_file_close (stdin_fd);
 185   if (NULL != stdout_fd)
 186     (void) GNUNET_DISK_file_close (stdout_fd);
 187   GNUNET_MST_destroy (tokenizer);
 188   tokenizer = NULL;
 189   if (NULL != testbed)
 190   {
 191     GNUNET_break (GNUNET_OK == GNUNET_OS_process_wait (testbed));
 192     GNUNET_OS_process_destroy (testbed);
 193     testbed = NULL;
 194   }
 195   if (NULL != test_system)
 196   {
 197     GNUNET_TESTING_system_destroy (test_system, GNUNET_YES);
 198     test_system = NULL;
 199   }
 200 }
 201
 202
 203 /**
 204  * Task to write to the standard out
 205  *
 206  * @param cls the WriteContext
 207  */
 208 static void
 209 write_task (void *cls)
 210 {
 211   struct WriteContext *wc = cls;
 212   ssize_t bytes_wrote;
 213
 214   GNUNET_assert (NULL != wc);
 215   write_task_id = NULL;
 216   bytes_wrote =
 217       GNUNET_DISK_file_write (stdout_fd, wc->data + wc->pos,
 218                               wc->length - wc->pos);
 219   if (GNUNET_SYSERR == bytes_wrote)
 220   {
 221     LOG (GNUNET_ERROR_TYPE_WARNING,
 222          "Cannot reply back configuration\n");
 223     GNUNET_free (wc->data);
 224     GNUNET_free (wc);
 225     return;
 226   }
 227   wc->pos += bytes_wrote;
 228   if (wc->pos == wc->length)
 229   {
 230     GNUNET_free (wc->data);
 231     GNUNET_free (wc);
 232     return;
 233   }
 234   write_task_id =
 235       GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
 236                                        stdout_fd,
 237                                        &write_task, wc);
 238 }
 239
 240
 241 /**
 242  * Task triggered whenever we receive a SIGCHLD (child
 243  * process died).
 244  *
 245  * @param cls closure, NULL if we need to self-restart
 246  */
 247 static void
 248 child_death_task (void *cls)
 249 {
 250   const struct GNUNET_DISK_FileHandle *pr;
 251   char c[16];
 252   enum GNUNET_OS_ProcessStatusType type;
 253   unsigned long code;
 254   int ret;
 255
 256   pr = GNUNET_DISK_pipe_handle (sigpipe, GNUNET_DISK_PIPE_END_READ);
 257   child_death_task_id = NULL;
 258   /* consume the signal */
 259   GNUNET_break (0 < GNUNET_DISK_file_read (pr, &c, sizeof (c)));
 260   LOG_DEBUG ("Got SIGCHLD\n");
 261   if (NULL == testbed)
 262   {
 263     GNUNET_break (0);
 264     return;
 265   }
 266   GNUNET_break (GNUNET_SYSERR !=
 267                 (ret = GNUNET_OS_process_status (testbed, &type, &code)));
 268   if (GNUNET_NO != ret)
 269   {
 270     GNUNET_OS_process_destroy (testbed);
 271     testbed = NULL;
 272     /* Send SIGTERM to our process group */
 273     if (0 != PLIBC_KILL (0, GNUNET_TERM_SIG))
 274     {
 275       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "signal");
 276       GNUNET_SCHEDULER_shutdown ();   /* Couldn't send the signal, we shutdown frowning */
 277     }
 278     return;
 279   }
 280   LOG_DEBUG ("Child hasn't died.  Resuming to monitor its status\n");
 281   child_death_task_id =
 282       GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 283                                       pr, &child_death_task, NULL);
 284 }
 285
 286
 287 /**
 288  * Functions with this signature are called whenever a
 289  * complete message is received by the tokenizer.
 290  *
 291  * Do not call #GNUNET_mst_destroy() in this callback
 292  *
 293  * @param cls identification of the client
 294  * @param message the actual message
 295  *
 296  * @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
 297  */
 298 static int
 299 tokenizer_cb (void *cls,
 300               const struct GNUNET_MessageHeader *message)
 301 {
 302   const struct GNUNET_TESTBED_HelperInit *msg;
 303   struct GNUNET_TESTBED_HelperReply *reply;
 304   struct GNUNET_CONFIGURATION_Handle *cfg;
 305   struct WriteContext *wc;
 306   char *binary;
 307   char *trusted_ip;
 308   char *hostname;
 309   char *config;
 310   char *xconfig;
 311   char *evstr;
 312   //char *str;
 313   size_t config_size;
 314   uLongf ul_config_size;
 315   size_t xconfig_size;
 316   uint16_t trusted_ip_size;
 317   uint16_t hostname_size;
 318   uint16_t msize;
 319
 320   msize = ntohs (message->size);
 321   if ((sizeof (struct GNUNET_TESTBED_HelperInit) >= msize) ||
 322       (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT != ntohs (message->type)))
 323   {
 324     LOG (GNUNET_ERROR_TYPE_WARNING,
 325          "Received unexpected message -- exiting\n");
 326     goto error;
 327   }
 328   msg = (const struct GNUNET_TESTBED_HelperInit *) message;
 329   trusted_ip_size = ntohs (msg->trusted_ip_size);
 330   trusted_ip = (char *) &msg[1];
 331   if ('\0' != trusted_ip[trusted_ip_size])
 332   {
 333     LOG (GNUNET_ERROR_TYPE_WARNING, "Trusted IP cannot be empty -- exiting\n");
 334     goto error;
 335   }
 336   hostname_size = ntohs (msg->hostname_size);
 337   if ((sizeof (struct GNUNET_TESTBED_HelperInit) + trusted_ip_size + 1 +
 338        hostname_size) >= msize)
 339   {
 340     GNUNET_break (0);
 341     LOG (GNUNET_ERROR_TYPE_WARNING, "Received unexpected message -- exiting\n");
 342     goto error;
 343   }
 344   ul_config_size = (uLongf) ntohs (msg->config_size);
 345   config = GNUNET_malloc (ul_config_size);
 346   xconfig_size =
 347       ntohs (message->size) - (trusted_ip_size + 1 +
 348                                sizeof (struct GNUNET_TESTBED_HelperInit));
 349   if (Z_OK !=
 350       uncompress ((Bytef *) config, &ul_config_size,
 351                   (const Bytef *) (trusted_ip + trusted_ip_size + 1 +
 352                                    hostname_size), (uLongf) xconfig_size))
 353   {
 354     LOG (GNUNET_ERROR_TYPE_WARNING,
 355          "Error while uncompressing config -- exiting\n");
 356     GNUNET_free (config);
 357     goto error;
 358   }
 359   cfg = GNUNET_CONFIGURATION_create ();
 360   if (GNUNET_OK !=
 361       GNUNET_CONFIGURATION_deserialize (cfg, config, ul_config_size, GNUNET_NO))
 362   {
 363     LOG (GNUNET_ERROR_TYPE_WARNING,
 364          "Unable to deserialize config -- exiting\n");
 365     GNUNET_free (config);
 366     goto error;
 367   }
 368   GNUNET_free (config);
 369   hostname = NULL;
 370   if (0 != hostname_size)
 371   {
 372     hostname = GNUNET_malloc (hostname_size + 1);
 373     (void) strncpy (hostname, ((char *) &msg[1]) + trusted_ip_size + 1,
 374                     hostname_size);
 375     hostname[hostname_size] = '\0';
 376   }
 377   /* unset GNUNET_TESTING_PREFIX if present as it is more relevant for testbed */
 378   evstr = getenv (GNUNET_TESTING_PREFIX);
 379   if (NULL != evstr)
 380   {
 381     /* unsetting the variable will invalidate the pointer! */
 382     evstr = GNUNET_strdup (evstr);
 383 #ifdef WINDOWS
 384     GNUNET_break (0 != SetEnvironmentVariable (GNUNET_TESTING_PREFIX, NULL));
 385 #else
 386     GNUNET_break (0 == unsetenv (GNUNET_TESTING_PREFIX));
 387 #endif
 388   }
 389   test_system =
 390       GNUNET_TESTING_system_create ("testbed-helper", trusted_ip, hostname,
 391                                     NULL);
 392   if (NULL != evstr)
 393   {
 394 #ifdef WINDOWS
 395     GNUNET_assert (0 != SetEnvironmentVariable (GNUNET_TESTING_PREFIX,
 396                                                 evstr));
 397 #else
 398     char *evar;
 399
 400     GNUNET_asprintf (&evar,
 401                      GNUNET_TESTING_PREFIX "=%s",
 402                      evstr);
 403     GNUNET_assert (0 == putenv (evar)); /* consumes 'evar',
 404                                            see putenv(): becomes part of envrionment! */
 405 #endif
 406     GNUNET_free (evstr);
 407     evstr = NULL;
 408   }
 409   GNUNET_free_non_null (hostname);
 410   hostname = NULL;
 411   GNUNET_assert (NULL != test_system);
 412   GNUNET_assert (GNUNET_OK ==
 413                  GNUNET_TESTING_configuration_create (test_system, cfg));
 414   GNUNET_assert (GNUNET_OK ==
 415                  GNUNET_CONFIGURATION_get_value_filename (cfg, "PATHS",
 416                                                         "DEFAULTCONFIG",
 417                                                         &config));
 418   if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg, config))
 419   {
 420     LOG (GNUNET_ERROR_TYPE_WARNING,
 421          "Unable to write config file: %s -- exiting\n", config);
 422     GNUNET_CONFIGURATION_destroy (cfg);
 423     GNUNET_free (config);
 424     goto error;
 425   }
 426   LOG_DEBUG ("Staring testbed with config: %s\n", config);
 427   binary = GNUNET_OS_get_libexec_binary_path ("gnunet-service-testbed");
 428   {
 429     char *evar;
 430
 431     /* expose testbed configuration through env variable */
 432     GNUNET_asprintf (&evar,
 433                      "%s=%s",
 434                      ENV_TESTBED_CONFIG,
 435                      config);
 436     GNUNET_assert (0 == putenv (evar));  /* consumes 'evar',
 437                                             see putenv(): becomes part of envrionment! */
 438     evstr = NULL;
 439   }
 440   testbed =
 441       GNUNET_OS_start_process (PIPE_CONTROL,
 442                                GNUNET_OS_INHERIT_STD_ERR /*verbose? */ ,
 443                                NULL, NULL, NULL,
 444                                binary,
 445                                "gnunet-service-testbed",
 446                                "-c", config,
 447                                NULL);
 448   GNUNET_free (binary);
 449   GNUNET_free (config);
 450   if (NULL == testbed)
 451   {
 452     LOG (GNUNET_ERROR_TYPE_WARNING,
 453          "Error starting gnunet-service-testbed -- exiting\n");
 454     GNUNET_CONFIGURATION_destroy (cfg);
 455     goto error;
 456   }
 457   done_reading = GNUNET_YES;
 458   config = GNUNET_CONFIGURATION_serialize (cfg, &config_size);
 459   GNUNET_CONFIGURATION_destroy (cfg);
 460   cfg = NULL;
 461   xconfig_size =
 462       GNUNET_TESTBED_compress_config_ (config, config_size, &xconfig);
 463   GNUNET_free (config);
 464   wc = GNUNET_new (struct WriteContext);
 465   wc->length = xconfig_size + sizeof (struct GNUNET_TESTBED_HelperReply);
 466   reply = GNUNET_realloc (xconfig, wc->length);
 467   memmove (&reply[1], reply, xconfig_size);
 468   reply->header.type = htons (GNUNET_MESSAGE_TYPE_TESTBED_HELPER_REPLY);
 469   reply->header.size = htons ((uint16_t) wc->length);
 470   reply->config_size = htons ((uint16_t) config_size);
 471   wc->data = reply;
 472   write_task_id =
 473       GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
 474                                        stdout_fd,
 475                                        &write_task, wc);
 476   child_death_task_id =
 477       GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 478                                       GNUNET_DISK_pipe_handle (sigpipe,
 479                                                                GNUNET_DISK_PIPE_END_READ),
 480                                       &child_death_task, NULL);
 481   return GNUNET_OK;
 482
 483 error:
 484   status = GNUNET_SYSERR;
 485   GNUNET_SCHEDULER_shutdown ();
 486   return GNUNET_SYSERR;
 487 }
 488
 489
 490 /**
 491  * Task to read from stdin
 492  *
 493  * @param cls NULL
 494  */
 495 static void
 496 read_task (void *cls)
 497 {
 498   char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE];
 499   ssize_t sread;
 500
 501   read_task_id = NULL;
 502   sread = GNUNET_DISK_file_read (stdin_fd,
 503                                  buf,
 504                                  sizeof (buf));
 505   if ( (GNUNET_SYSERR == sread) ||
 506        (0 == sread) )
 507   {
 508     LOG_DEBUG ("STDIN closed\n");
 509     GNUNET_SCHEDULER_shutdown ();
 510     return;
 511   }
 512   if (GNUNET_YES == done_reading)
 513   {
 514     /* didn't expect any more data! */
 515     GNUNET_break_op (0);
 516     GNUNET_SCHEDULER_shutdown ();
 517     return;
 518   }
 519   LOG_DEBUG ("Read %u bytes\n",
 520              (unsigned int) sread);
 521   /* FIXME: could introduce a GNUNET_MST_read2 to read
 522      directly from 'stdin_fd' and save a memcpy() here */
 523   if (GNUNET_OK !=
 524       GNUNET_MST_from_buffer (tokenizer,
 525                               buf,
 526                               sread,
 527                               GNUNET_NO,
 528                               GNUNET_NO))
 529   {
 530     GNUNET_break (0);
 531     GNUNET_SCHEDULER_shutdown ();
 532     return;
 533   }
 534   read_task_id                 /* No timeout while reading */
 535     = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 536                                       stdin_fd,
 537                                       &read_task,
 538                                       NULL);
 539 }
 540
 541
 542 /**
 543  * Main function that will be run.
 544  *
 545  * @param cls closure
 546  * @param args remaining command-line arguments
 547  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 548  * @param cfg configuration
 549  */
 550 static void
 551 run (void *cls,
 552      char *const *args,
 553      const char *cfgfile,
 554      const struct GNUNET_CONFIGURATION_Handle *cfg)
 555 {
 556   LOG_DEBUG ("Starting testbed helper...\n");
 557   tokenizer = GNUNET_MST_create (&tokenizer_cb, NULL);
 558   stdin_fd = GNUNET_DISK_get_handle_from_native (stdin);
 559   stdout_fd = GNUNET_DISK_get_handle_from_native (stdout);
 560   read_task_id =
 561       GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 562                                       stdin_fd,
 563                                       &read_task, NULL);
 564   GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
 565                                  NULL);
 566 }
 567
 568
 569 /**
 570  * Signal handler called for SIGCHLD.
 571  */
 572 static void
 573 sighandler_child_death ()
 574 {
 575   static char c;
 576   int old_errno;        /* back-up errno */
 577
 578   old_errno = errno;
 579   GNUNET_break (1 ==
 580                 GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
 581                                         (sigpipe, GNUNET_DISK_PIPE_END_WRITE),
 582                                         &c, sizeof (c)));
 583   errno = old_errno;
 584 }
 585
 586
 587 /**
 588  * Main function
 589  *
 590  * @param argc the number of command line arguments
 591  * @param argv command line arg array
 592  * @return return code
 593  */
 594 int
 595 main (int argc,
 596       char **argv)
 597 {
 598   struct GNUNET_SIGNAL_Context *shc_chld;
 599   struct GNUNET_GETOPT_CommandLineOption options[] = {
 600     GNUNET_GETOPT_OPTION_END
 601   };
 602   int ret;
 603
 604   status = GNUNET_OK;
 605   if (NULL == (sigpipe = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO,
 606                                            GNUNET_NO, GNUNET_NO)))
 607   {
 608     GNUNET_break (0);
 609     return 1;
 610   }
 611   shc_chld = GNUNET_SIGNAL_handler_install (GNUNET_SIGCHLD,
 612                                             &sighandler_child_death);
 613   ret = GNUNET_PROGRAM_run (argc, argv,
 614                             "gnunet-helper-testbed",
 615                             "Helper for starting gnunet-service-testbed",
 616                             options,
 617                             &run,
 618                             NULL);
 619   GNUNET_SIGNAL_handler_uninstall (shc_chld);
 620   shc_chld = NULL;
 621   GNUNET_DISK_pipe_close (sigpipe);
 622   if (GNUNET_OK != ret)
 623     return 1;
 624   return (GNUNET_OK == status) ? 0 : 1;
 625 }
 626
 627 /* end of gnunet-helper-testbed.c */