src/util/helper.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011, 2012 Christian Grothoff
   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 util/helper.c
  23  * @brief API for dealing with (SUID) helper processes that communicate via GNUNET_MessageHeaders on stdin/stdout
  24  * @author Philipp Toelke
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29
  30
  31 /**
  32  * Entry in the queue of messages we need to transmit to the helper.
  33  */
  34 struct HelperMessageQueueEntry
  35 {
  36
  37   /**
  38    * This is an entry in a DLL.
  39    */
  40   struct HelperMessageQueueEntry *next;
  41
  42   /**
  43    * This is an entry in a DLL.
  44    */
  45   struct HelperMessageQueueEntry *prev;
  46
  47   /**
  48    * Message to transmit (allocated at the end of this struct)
  49    */
  50   const struct GNUNET_MessageHeader *msg;
  51
  52   /**
  53    * Function to call upon completion.
  54    */
  55   GNUNET_HELPER_Continuation cont;
  56
  57   /**
  58    * Closure to 'cont'.
  59    */
  60   void *cont_cls;
  61
  62   /**
  63    * Current write position.
  64    */
  65   unsigned int wpos;
  66
  67 };
  68
  69
  70 /**
  71  * The handle to a helper process.
  72  */
  73 struct GNUNET_HELPER_Handle
  74 {
  75
  76   /**
  77    * PipeHandle to receive data from the helper
  78    */
  79   struct GNUNET_DISK_PipeHandle *helper_in;
  80
  81   /**
  82    * PipeHandle to send data to the helper
  83    */
  84   struct GNUNET_DISK_PipeHandle *helper_out;
  85
  86   /**
  87    * FileHandle to receive data from the helper
  88    */
  89   const struct GNUNET_DISK_FileHandle *fh_from_helper;
  90
  91   /**
  92    * FileHandle to send data to the helper
  93    */
  94   const struct GNUNET_DISK_FileHandle *fh_to_helper;
  95
  96   /**
  97    * The process id of the helper
  98    */
  99   struct GNUNET_OS_Process *helper_proc;
 100
 101   /**
 102    * The Message-Tokenizer that tokenizes the messages comming from the helper
 103    */
 104   struct GNUNET_SERVER_MessageStreamTokenizer *mst;
 105
 106   /**
 107    * First message queued for transmission to helper.
 108    */
 109   struct HelperMessageQueueEntry *mq_head;
 110
 111   /**
 112    * Last message queued for transmission to helper.
 113    */
 114   struct HelperMessageQueueEntry *mq_tail;
 115
 116   /**
 117    * Binary to run.
 118    */
 119   const char *binary_name;
 120
 121   /**
 122    * NULL-terminated list of command-line arguments.
 123    */
 124   char *const *binary_argv;
 125
 126   /**
 127    * Task to read from the helper.
 128    */
 129   GNUNET_SCHEDULER_TaskIdentifier read_task;
 130
 131   /**
 132    * Task to read from the helper.
 133    */
 134   GNUNET_SCHEDULER_TaskIdentifier write_task;
 135
 136   /**
 137    * Restart task.
 138    */
 139   GNUNET_SCHEDULER_TaskIdentifier restart_task;
 140 };
 141
 142
 143 /**
 144  * Stop the helper process, we're closing down or had an error.
 145  *
 146  * @param h handle to the helper process
 147  */
 148 static void
 149 stop_helper (struct GNUNET_HELPER_Handle *h)
 150 {
 151   struct HelperMessageQueueEntry *qe;
 152
 153   if (NULL != h->helper_proc)
 154   {
 155     GNUNET_OS_process_kill (h->helper_proc, SIGTERM);
 156     GNUNET_OS_process_wait (h->helper_proc);
 157     GNUNET_OS_process_close (h->helper_proc);
 158     h->helper_proc = NULL;
 159   }
 160   if (GNUNET_SCHEDULER_NO_TASK != h->restart_task)
 161   {
 162     GNUNET_SCHEDULER_cancel (h->restart_task);
 163     h->restart_task = GNUNET_SCHEDULER_NO_TASK;
 164   }
 165   if (GNUNET_SCHEDULER_NO_TASK != h->read_task)
 166   {
 167     GNUNET_SCHEDULER_cancel (h->read_task);
 168     h->read_task = GNUNET_SCHEDULER_NO_TASK;
 169   }
 170   if (GNUNET_SCHEDULER_NO_TASK != h->write_task)
 171   {
 172     GNUNET_SCHEDULER_cancel (h->write_task);
 173     h->write_task = GNUNET_SCHEDULER_NO_TASK;
 174   }
 175   if (NULL != h->helper_in)
 176   {
 177     GNUNET_DISK_pipe_close (h->helper_in);
 178     h->helper_in = NULL;
 179     h->fh_to_helper = NULL;
 180   }
 181   if (NULL != h->helper_out)
 182   {
 183     GNUNET_DISK_pipe_close (h->helper_out);
 184     h->helper_out = NULL;
 185     h->fh_from_helper = NULL;
 186   }
 187   while (NULL != (qe = h->mq_head))
 188   {
 189     GNUNET_CONTAINER_DLL_remove (h->mq_head,
 190                                  h->mq_tail,
 191                                  qe);
 192     qe->cont (qe->cont_cls, GNUNET_NO);
 193     GNUNET_free (qe);
 194   }
 195   /* purge MST buffer */
 196   GNUNET_SERVER_mst_receive (h->mst, NULL, NULL, 0, GNUNET_YES, GNUNET_NO);
 197 }
 198
 199
 200 /**
 201  * Restart the helper process.
 202  *
 203  * @param cls handle to the helper process
 204  * @param tc scheduler context
 205  */
 206 static void
 207 restart_task (void *cls,
 208               const struct GNUNET_SCHEDULER_TaskContext *tc);
 209
 210
 211 /**
 212  * Read from the helper-process
 213  *
 214  * @param cls handle to the helper process
 215  * @param tc scheduler context
 216  */
 217 static void
 218 helper_read (void *cls,
 219              const struct GNUNET_SCHEDULER_TaskContext *tsdkctx)
 220 {
 221   struct GNUNET_HELPER_Handle *h = cls;
 222   char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE];
 223   ssize_t t;
 224
 225   h->read_task = GNUNET_SCHEDULER_NO_TASK;
 226   if (0 != (tsdkctx->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 227   {
 228     /* try again */
 229     h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 230                                                    h->fh_from_helper, &helper_read, h);
 231     return;
 232   }
 233   t = GNUNET_DISK_file_read (h->fh_from_helper, &buf, sizeof (buf));
 234   if (t < 0)
 235   {
 236     /* On read-error, restart the helper */
 237     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 238                 _("Error reading from `%s': %s\n"),
 239                 h->binary_name,
 240                 STRERROR (errno));
 241     stop_helper (h);
 242     /* Restart the helper */
 243     h->restart_task =
 244       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
 245                                     &restart_task, h);
 246     return;
 247   }
 248   if (0 == t)
 249   {
 250     /* this happens if the helper is shut down via a
 251        signal, so it is not a "hard" error */
 252     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 253                 _("Got 0 bytes from helper `%s' (EOF)\n"),
 254                 h->binary_name);
 255     stop_helper (h);
 256     /* Restart the helper */
 257     h->restart_task =
 258       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
 259                                     &restart_task, h);
 260     return;
 261   }
 262   if (GNUNET_SYSERR ==
 263       GNUNET_SERVER_mst_receive (h->mst, NULL, buf, t, GNUNET_NO, GNUNET_NO))
 264   {
 265     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 266                 _("Failed to parse inbound message from helper `%s'\n"),
 267                 h->binary_name);
 268     stop_helper (h);
 269     /* Restart the helper */
 270     h->restart_task =
 271         GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
 272                                       &restart_task, h);
 273     return;
 274
 275   }
 276   h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 277                                                  h->fh_from_helper, &helper_read, h);
 278 }
 279
 280
 281 /**
 282  * Start the helper process.
 283  *
 284  * @param h handle to the helper process
 285  */
 286 static void
 287 start_helper (struct GNUNET_HELPER_Handle *h)
 288 {
 289   h->helper_in = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_YES, GNUNET_NO);
 290   h->helper_out = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_NO, GNUNET_YES);
 291   if ( (h->helper_in == NULL) || (h->helper_out == NULL))
 292   {
 293     /* out of file descriptors? try again later... */
 294     stop_helper (h);
 295     h->restart_task =
 296       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
 297                                     &restart_task, h);
 298     return;
 299   }
 300   h->fh_from_helper =
 301       GNUNET_DISK_pipe_handle (h->helper_out, GNUNET_DISK_PIPE_END_READ);
 302   h->fh_to_helper =
 303       GNUNET_DISK_pipe_handle (h->helper_in, GNUNET_DISK_PIPE_END_WRITE);
 304   h->helper_proc =
 305       GNUNET_OS_start_process_vap (h->helper_in, h->helper_out,
 306                                    h->binary_name,
 307                                    h->binary_argv);
 308   if (NULL == h->helper_proc)
 309   {
 310     /* failed to start process? try again later... */
 311     stop_helper (h);
 312     h->restart_task =
 313       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
 314                                     &restart_task, h);
 315     return;
 316   }
 317   GNUNET_DISK_pipe_close_end (h->helper_out, GNUNET_DISK_PIPE_END_WRITE);
 318   GNUNET_DISK_pipe_close_end (h->helper_in, GNUNET_DISK_PIPE_END_READ);
 319   h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 320                                                  h->fh_from_helper,
 321                                                  &helper_read,
 322                                                  h);
 323 }
 324
 325
 326 /**
 327  * Restart the helper process.
 328  *
 329  * @param cls handle to the helper process
 330  * @param tc scheduler context
 331  */
 332 static void
 333 restart_task (void *cls,
 334               const struct GNUNET_SCHEDULER_TaskContext *tc)
 335 {
 336   struct GNUNET_HELPER_Handle*h = cls;
 337
 338   h->restart_task = GNUNET_SCHEDULER_NO_TASK;
 339   start_helper (h);
 340 }
 341
 342
 343 /**
 344  * @brief Starts a helper and begins reading from it
 345  *
 346  * @param binary_name name of the binary to run
 347  * @param binary_argv NULL-terminated list of arguments to give when starting the binary (this
 348  *                    argument must not be modified by the client for
 349  *                     the lifetime of the helper h)
 350  * @param cb function to call if we get messages from the helper
 351  * @param cb_cls Closure for the callback
 352  * @return the new H, NULL on error
 353  */
 354 struct GNUNET_HELPER_Handle*
 355 GNUNET_HELPER_start (const char *binary_name,
 356                      char *const binary_argv[],
 357                      GNUNET_SERVER_MessageTokenizerCallback cb, void *cb_cls)
 358 {
 359   struct GNUNET_HELPER_Handle*h;
 360
 361   h =  GNUNET_malloc (sizeof (struct GNUNET_HELPER_Handle));
 362   h->binary_name = binary_name;
 363   h->binary_argv = binary_argv;
 364   h->mst = GNUNET_SERVER_mst_create (cb, cb_cls);
 365   start_helper (h);
 366   return h;
 367 }
 368
 369
 370 /**
 371  * @brief Kills the helper, closes the pipe and frees the h
 372  *
 373  * @param h h to helper to stop
 374  */
 375 void
 376 GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h)
 377 {
 378   struct HelperMessageQueueEntry *qe;
 379
 380   /* signal pending writes that we were stopped */
 381   while (NULL != (qe = h->mq_head))
 382   {
 383     GNUNET_CONTAINER_DLL_remove (h->mq_head,
 384                                  h->mq_tail,
 385                                  qe);
 386     qe->cont (qe->cont_cls, GNUNET_SYSERR);
 387     GNUNET_free (qe);
 388   }
 389   stop_helper (h);
 390   GNUNET_SERVER_mst_destroy (h->mst);
 391   GNUNET_free (h);
 392 }
 393
 394
 395 /**
 396  * Write to the helper-process
 397  *
 398  * @param cls handle to the helper process
 399  * @param tc scheduler context
 400  */
 401 static void
 402 helper_write (void *cls,
 403              const struct GNUNET_SCHEDULER_TaskContext *tsdkctx)
 404 {
 405   struct GNUNET_HELPER_Handle *h = cls;
 406   struct HelperMessageQueueEntry *qe;
 407   const char *buf;
 408   ssize_t t;
 409
 410   h->write_task = GNUNET_SCHEDULER_NO_TASK;
 411   if (0 != (tsdkctx->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 412   {
 413     /* try again */
 414     h->write_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 415                                                     h->fh_to_helper, &helper_write, h);
 416     return;
 417   }
 418   if (NULL == (qe = h->mq_head))
 419     return; /* how did this happen? */
 420   buf = (const char*) qe->msg;
 421   t = GNUNET_DISK_file_write (h->fh_to_helper, &buf[qe->wpos], ntohs (qe->msg->size) - qe->wpos);
 422   if (t <= 0)
 423   {
 424     /* On write-error, restart the helper */
 425     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 426                 _("Error writing to `%s': %s\n"),
 427                 h->binary_name,
 428                 STRERROR (errno));
 429     stop_helper (h);
 430     /* Restart the helper */
 431     h->restart_task =
 432       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
 433                                     &restart_task, h);
 434     return;
 435   }
 436   qe->wpos += t;
 437   if (qe->wpos == ntohs (qe->msg->size))
 438   {
 439     GNUNET_CONTAINER_DLL_remove (h->mq_head,
 440                                  h->mq_tail,
 441                                  qe);
 442     if (NULL != qe->cont)
 443       qe->cont (qe->cont_cls, GNUNET_YES);
 444     GNUNET_free (qe);
 445   }
 446   if (NULL != h->mq_head)
 447     h->write_task = GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
 448                                                      h->fh_to_helper,
 449                                                      &helper_write,
 450                                                      h);
 451 }
 452
 453
 454 /**
 455  * Send an message to the helper.
 456  *
 457  * @param h helper to send message to
 458  * @param msg message to send
 459  * @param can_drop can the message be dropped if there is already one in the queue?
 460  * @param cont continuation to run once the message is out (PREREQ_DONE on succees, CANCEL
 461  *             if the helper process died, NULL during GNUNET_HELPER_stop).
 462  * @param cont_cls closure for 'cont'
 463  * @return GNUNET_YES if the message will be sent
 464  *         GNUNET_NO if the message was dropped
 465  */
 466 int
 467 GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h,
 468                     const struct GNUNET_MessageHeader *msg,
 469                     int can_drop,
 470                     GNUNET_HELPER_Continuation cont,
 471                     void *cont_cls)
 472 {
 473   struct HelperMessageQueueEntry *qe;
 474   uint16_t mlen;
 475
 476   if (NULL == h->fh_to_helper)
 477     return GNUNET_NO;
 478   if ( (GNUNET_YES == can_drop) &&
 479        (h->mq_head != NULL) )
 480     return GNUNET_NO;
 481   mlen = ntohs (msg->size);
 482   qe = GNUNET_malloc (sizeof (struct HelperMessageQueueEntry) + mlen);
 483   qe->msg = (const struct GNUNET_MessageHeader*) &qe[1];
 484   memcpy (&qe[1], msg, mlen);
 485   qe->cont = cont;
 486   qe->cont_cls = cont_cls;
 487   GNUNET_CONTAINER_DLL_insert_tail (h->mq_head,
 488                                     h->mq_tail,
 489                                     qe);
 490   if (GNUNET_SCHEDULER_NO_TASK == h->write_task)
 491     h->write_task = GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
 492                                                      h->fh_to_helper,
 493                                                      &helper_write,
 494                                                      h);
 495
 496   return GNUNET_YES;
 497 }
 498
 499
 500 /* end of helper.c */