src/util/helper.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file util/helper.c
  23  * @brief API for dealing with (SUID) helper processes that communicate via
  24  *          GNUNET_MessageHeaders on stdin/stdout
  25  * @author Philipp Toelke
  26  * @author Christian Grothoff
  27  */
  28 #include "platform.h"
  29 #include "gnunet_util_lib.h"
  30
  31
  32 /**
  33  * Entry in the queue of messages we need to transmit to the helper.
  34  */
  35 struct GNUNET_HELPER_SendHandle
  36 {
  37
  38   /**
  39    * This is an entry in a DLL.
  40    */
  41   struct GNUNET_HELPER_SendHandle *next;
  42
  43   /**
  44    * This is an entry in a DLL.
  45    */
  46   struct GNUNET_HELPER_SendHandle *prev;
  47
  48   /**
  49    * Message to transmit (allocated at the end of this struct)
  50    */
  51   const struct GNUNET_MessageHeader *msg;
  52
  53   /**
  54    * The handle to a helper process.
  55    */
  56   struct GNUNET_HELPER_Handle *h;
  57
  58   /**
  59    * Function to call upon completion.
  60    */
  61   GNUNET_HELPER_Continuation cont;
  62
  63   /**
  64    * Closure to 'cont'.
  65    */
  66   void *cont_cls;
  67
  68   /**
  69    * Current write position.
  70    */
  71   unsigned int wpos;
  72
  73 };
  74
  75
  76 /**
  77  * The handle to a helper process.
  78  */
  79 struct GNUNET_HELPER_Handle
  80 {
  81
  82   /**
  83    * PipeHandle to receive data from the helper
  84    */
  85   struct GNUNET_DISK_PipeHandle *helper_in;
  86
  87   /**
  88    * PipeHandle to send data to the helper
  89    */
  90   struct GNUNET_DISK_PipeHandle *helper_out;
  91
  92   /**
  93    * FileHandle to receive data from the helper
  94    */
  95   const struct GNUNET_DISK_FileHandle *fh_from_helper;
  96
  97   /**
  98    * FileHandle to send data to the helper
  99    */
 100   const struct GNUNET_DISK_FileHandle *fh_to_helper;
 101
 102   /**
 103    * The process id of the helper
 104    */
 105   struct GNUNET_OS_Process *helper_proc;
 106
 107   /**
 108    * The Message-Tokenizer that tokenizes the messages comming from the helper
 109    */
 110   struct GNUNET_SERVER_MessageStreamTokenizer *mst;
 111
 112   /**
 113    * The exception callback
 114    */
 115   GNUNET_HELPER_ExceptionCallback exp_cb;
 116
 117   /**
 118    * The closure for callbacks
 119    */
 120   void *cb_cls;
 121
 122   /**
 123    * First message queued for transmission to helper.
 124    */
 125   struct GNUNET_HELPER_SendHandle *sh_head;
 126
 127   /**
 128    * Last message queued for transmission to helper.
 129    */
 130   struct GNUNET_HELPER_SendHandle *sh_tail;
 131
 132   /**
 133    * Binary to run.
 134    */
 135   char *binary_name;
 136
 137   /**
 138    * NULL-terminated list of command-line arguments.
 139    */
 140   char **binary_argv;
 141
 142   /**
 143    * Task to read from the helper.
 144    */
 145   struct GNUNET_SCHEDULER_Task * read_task;
 146
 147   /**
 148    * Task to read from the helper.
 149    */
 150   struct GNUNET_SCHEDULER_Task * write_task;
 151
 152   /**
 153    * Restart task.
 154    */
 155   struct GNUNET_SCHEDULER_Task * restart_task;
 156
 157   /**
 158    * Does the helper support the use of a control pipe for signalling?
 159    */
 160   int with_control_pipe;
 161
 162   /**
 163    * Count start attempts to increase linear back off
 164    */
 165   unsigned int retry_back_off;
 166 };
 167
 168
 169 /**
 170  * Sends termination signal to the helper process.  The helper process is not
 171  * reaped; call GNUNET_HELPER_wait() for reaping the dead helper process.
 172  *
 173  * @param h the helper handle
 174  * @param soft_kill if GNUNET_YES, signals termination by closing the helper's
 175  *          stdin; GNUNET_NO to signal termination by sending SIGTERM to helper
 176  * @return #GNUNET_OK on success; #GNUNET_SYSERR on error
 177  */
 178 int
 179 GNUNET_HELPER_kill (struct GNUNET_HELPER_Handle *h,
 180                     int soft_kill)
 181 {
 182   struct GNUNET_HELPER_SendHandle *sh;
 183   int ret;
 184
 185   while (NULL != (sh = h->sh_head))
 186   {
 187     GNUNET_CONTAINER_DLL_remove (h->sh_head,
 188                                  h->sh_tail,
 189                                  sh);
 190     if (NULL != sh->cont)
 191       sh->cont (sh->cont_cls, GNUNET_NO);
 192     GNUNET_free (sh);
 193   }
 194   if (NULL != h->restart_task)
 195   {
 196     GNUNET_SCHEDULER_cancel (h->restart_task);
 197     h->restart_task = NULL;
 198   }
 199   if (NULL != h->read_task)
 200   {
 201     GNUNET_SCHEDULER_cancel (h->read_task);
 202     h->read_task = NULL;
 203   }
 204   if (NULL == h->helper_proc)
 205     return GNUNET_SYSERR;
 206   if (GNUNET_YES == soft_kill)
 207   {
 208     /* soft-kill only possible with pipes */
 209     GNUNET_assert (NULL != h->helper_in);
 210     ret = GNUNET_DISK_pipe_close (h->helper_in);
 211     h->helper_in = NULL;
 212     h->fh_to_helper = NULL;
 213     return ret;
 214   }
 215   if (0 != GNUNET_OS_process_kill (h->helper_proc, GNUNET_TERM_SIG))
 216     return GNUNET_SYSERR;
 217   return GNUNET_OK;
 218 }
 219
 220
 221 /**
 222  * Reap the helper process.  This call is blocking(!).  The helper process
 223  * should either be sent a termination signal before or should be dead before
 224  * calling this function
 225  *
 226  * @param h the helper handle
 227  * @return #GNUNET_OK on success; #GNUNET_SYSERR on error
 228  */
 229 int
 230 GNUNET_HELPER_wait (struct GNUNET_HELPER_Handle *h)
 231 {
 232   struct GNUNET_HELPER_SendHandle *sh;
 233   int ret;
 234
 235   ret = GNUNET_SYSERR;
 236   if (NULL != h->helper_proc)
 237   {
 238     ret = GNUNET_OS_process_wait (h->helper_proc);
 239     GNUNET_OS_process_destroy (h->helper_proc);
 240     h->helper_proc = NULL;
 241   }
 242   if (NULL != h->read_task)
 243   {
 244     GNUNET_SCHEDULER_cancel (h->read_task);
 245     h->read_task = NULL;
 246   }
 247   if (NULL != h->write_task)
 248   {
 249     GNUNET_SCHEDULER_cancel (h->write_task);
 250     h->write_task = NULL;
 251   }
 252   if (NULL != h->helper_in)
 253   {
 254     GNUNET_DISK_pipe_close (h->helper_in);
 255     h->helper_in = NULL;
 256     h->fh_to_helper = NULL;
 257   }
 258   if (NULL != h->helper_out)
 259   {
 260     GNUNET_DISK_pipe_close (h->helper_out);
 261     h->helper_out = NULL;
 262     h->fh_from_helper = NULL;
 263   }
 264   while (NULL != (sh = h->sh_head))
 265   {
 266     GNUNET_CONTAINER_DLL_remove (h->sh_head,
 267                                  h->sh_tail,
 268                                  sh);
 269     if (NULL != sh->cont)
 270       sh->cont (sh->cont_cls, GNUNET_NO);
 271     GNUNET_free (sh);
 272   }
 273   /* purge MST buffer */
 274   if (NULL != h->mst)
 275     (void) GNUNET_SERVER_mst_receive (h->mst, NULL, NULL, 0, GNUNET_YES, GNUNET_NO);
 276   return ret;
 277 }
 278
 279
 280 /**
 281  * Stop the helper process, we're closing down or had an error.
 282  *
 283  * @param h handle to the helper process
 284  * @param soft_kill if #GNUNET_YES, signals termination by closing the helper's
 285  *          stdin; #GNUNET_NO to signal termination by sending SIGTERM to helper
 286  */
 287 static void
 288 stop_helper (struct GNUNET_HELPER_Handle *h,
 289              int soft_kill)
 290 {
 291   if (NULL != h->restart_task)
 292   {
 293     GNUNET_SCHEDULER_cancel (h->restart_task);
 294     h->restart_task = NULL;
 295   }
 296   else
 297   {
 298     GNUNET_break (GNUNET_OK == GNUNET_HELPER_kill (h, soft_kill));
 299     GNUNET_break (GNUNET_OK == GNUNET_HELPER_wait (h));
 300   }
 301 }
 302
 303
 304 /**
 305  * Restart the helper process.
 306  *
 307  * @param cls handle to the helper process
 308  */
 309 static void
 310 restart_task (void *cls);
 311
 312
 313 /**
 314  * Read from the helper-process
 315  *
 316  * @param cls handle to the helper process
 317  */
 318 static void
 319 helper_read (void *cls)
 320 {
 321   struct GNUNET_HELPER_Handle *h = cls;
 322   const struct GNUNET_SCHEDULER_TaskContext *tc;
 323   char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE] GNUNET_ALIGN;
 324   ssize_t t;
 325
 326   h->read_task = NULL;
 327   tc = GNUNET_SCHEDULER_get_task_context ();
 328   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 329   {
 330     /* try again */
 331     h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 332                                                    h->fh_from_helper, &helper_read, h);
 333     return;
 334   }
 335   t = GNUNET_DISK_file_read (h->fh_from_helper, &buf, sizeof (buf));
 336   if (t < 0)
 337   {
 338     /* On read-error, restart the helper */
 339     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 340                 _("Error reading from `%s': %s\n"),
 341                 h->binary_name,
 342                 STRERROR (errno));
 343     if (NULL != h->exp_cb)
 344     {
 345       h->exp_cb (h->cb_cls);
 346       GNUNET_HELPER_stop (h, GNUNET_NO);
 347       return;
 348     }
 349     stop_helper (h, GNUNET_NO);
 350     /* Restart the helper */
 351     h->restart_task = GNUNET_SCHEDULER_add_delayed(
 352         GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 353             h->retry_back_off), &restart_task, h);
 354     return;
 355   }
 356   if (0 == t)
 357   {
 358     /* this happens if the helper is shut down via a
 359        signal, so it is not a "hard" error */
 360     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 361                 "Got 0 bytes from helper `%s' (EOF)\n",
 362                 h->binary_name);
 363     if (NULL != h->exp_cb)
 364     {
 365       h->exp_cb (h->cb_cls);
 366       GNUNET_HELPER_stop (h, GNUNET_NO);
 367       return;
 368     }
 369     stop_helper (h, GNUNET_NO);
 370     /* Restart the helper */
 371     h->restart_task = GNUNET_SCHEDULER_add_delayed(
 372         GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 373             h->retry_back_off), &restart_task, h);
 374     return;
 375   }
 376   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 377               "Got %u bytes from helper `%s'\n",
 378               (unsigned int) t,
 379               h->binary_name);
 380   h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 381                                                  h->fh_from_helper, &helper_read, h);
 382   if (GNUNET_SYSERR ==
 383       GNUNET_SERVER_mst_receive (h->mst, NULL, buf, t, GNUNET_NO, GNUNET_NO))
 384   {
 385     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 386                 _("Failed to parse inbound message from helper `%s'\n"),
 387                 h->binary_name);
 388     if (NULL != h->exp_cb)
 389     {
 390       h->exp_cb (h->cb_cls);
 391       GNUNET_HELPER_stop (h, GNUNET_NO);
 392       return;
 393     }
 394     stop_helper (h, GNUNET_NO);
 395     /* Restart the helper */
 396     h->restart_task = GNUNET_SCHEDULER_add_delayed(
 397         GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 398             h->retry_back_off), &restart_task, h);
 399     return;
 400   }
 401 }
 402
 403
 404 /**
 405  * Start the helper process.
 406  *
 407  * @param h handle to the helper process
 408  */
 409 static void
 410 start_helper (struct GNUNET_HELPER_Handle *h)
 411 {
 412   h->helper_in = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_YES, GNUNET_NO);
 413   h->helper_out = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_NO, GNUNET_YES);
 414   if ( (h->helper_in == NULL) || (h->helper_out == NULL))
 415   {
 416     /* out of file descriptors? try again later... */
 417     stop_helper (h, GNUNET_NO);
 418     h->restart_task =
 419       GNUNET_SCHEDULER_add_delayed(
 420           GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 421               h->retry_back_off), &restart_task, h);
 422     return;
 423   }
 424   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 425               "Starting HELPER process `%s'\n",
 426               h->binary_name);
 427   h->fh_from_helper =
 428       GNUNET_DISK_pipe_handle (h->helper_out, GNUNET_DISK_PIPE_END_READ);
 429   h->fh_to_helper =
 430       GNUNET_DISK_pipe_handle (h->helper_in, GNUNET_DISK_PIPE_END_WRITE);
 431   h->helper_proc =
 432     GNUNET_OS_start_process_vap (h->with_control_pipe, GNUNET_OS_INHERIT_STD_ERR,
 433                                  h->helper_in, h->helper_out, NULL,
 434                                  h->binary_name,
 435                                  h->binary_argv);
 436   if (NULL == h->helper_proc)
 437   {
 438     /* failed to start process? try again later... */
 439     stop_helper (h, GNUNET_NO);
 440     h->restart_task = GNUNET_SCHEDULER_add_delayed(
 441         GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 442             h->retry_back_off), &restart_task, h);
 443     return;
 444   }
 445   GNUNET_DISK_pipe_close_end (h->helper_out, GNUNET_DISK_PIPE_END_WRITE);
 446   GNUNET_DISK_pipe_close_end (h->helper_in, GNUNET_DISK_PIPE_END_READ);
 447   if (NULL != h->mst)
 448     h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 449                                                    h->fh_from_helper,
 450                                                    &helper_read,
 451                                                    h);
 452 }
 453
 454
 455 /**
 456  * Restart the helper process.
 457  *
 458  * @param cls handle to the helper process
 459  */
 460 static void
 461 restart_task (void *cls)
 462 {
 463   struct GNUNET_HELPER_Handle*h = cls;
 464
 465   h->restart_task = NULL;
 466   h->retry_back_off++;
 467   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 468               "Restarting helper with back-off %u\n",
 469               h->retry_back_off);
 470   start_helper (h);
 471 }
 472
 473
 474 /**
 475  * Starts a helper and begins reading from it. The helper process is
 476  * restarted when it dies except when it is stopped using GNUNET_HELPER_stop()
 477  * or when the exp_cb callback is not NULL.
 478  *
 479  * @param with_control_pipe does the helper support the use of a control pipe for signalling?
 480  * @param binary_name name of the binary to run
 481  * @param binary_argv NULL-terminated list of arguments to give when starting the binary (this
 482  *                    argument must not be modified by the client for
 483  *                     the lifetime of the helper handle)
 484  * @param cb function to call if we get messages from the helper
 485  * @param exp_cb the exception callback to call. Set this to NULL if the helper
 486  *          process has to be restarted automatically when it dies/crashes
 487  * @param cb_cls closure for the above callback
 488  * @return the new Handle, NULL on error
 489  */
 490 struct GNUNET_HELPER_Handle *
 491 GNUNET_HELPER_start (int with_control_pipe,
 492                      const char *binary_name,
 493                      char *const binary_argv[],
 494                      GNUNET_SERVER_MessageTokenizerCallback cb,
 495                      GNUNET_HELPER_ExceptionCallback exp_cb,
 496                      void *cb_cls)
 497 {
 498   struct GNUNET_HELPER_Handle *h;
 499   unsigned int c;
 500
 501   h = GNUNET_new (struct GNUNET_HELPER_Handle);
 502   h->with_control_pipe = with_control_pipe;
 503   /* Lookup in libexec path only if we are starting gnunet helpers */
 504   if (NULL != strstr (binary_name, "gnunet"))
 505     h->binary_name = GNUNET_OS_get_libexec_binary_path (binary_name);
 506   else
 507     h->binary_name = GNUNET_strdup (binary_name);
 508   for (c = 0; NULL != binary_argv[c]; c++);
 509   h->binary_argv = GNUNET_malloc (sizeof (char *) * (c + 1));
 510   for (c = 0; NULL != binary_argv[c]; c++)
 511     h->binary_argv[c] = GNUNET_strdup (binary_argv[c]);
 512   h->binary_argv[c] = NULL;
 513   h->cb_cls = cb_cls;
 514   if (NULL != cb)
 515     h->mst = GNUNET_SERVER_mst_create (cb, h->cb_cls);
 516   h->exp_cb = exp_cb;
 517   h->retry_back_off = 0;
 518   start_helper (h);
 519   return h;
 520 }
 521
 522
 523 /**
 524  * Free's the resources occupied by the helper handle
 525  *
 526  * @param h the helper handle to free
 527  */
 528 void
 529 GNUNET_HELPER_destroy (struct GNUNET_HELPER_Handle *h)
 530 {
 531   unsigned int c;
 532   struct GNUNET_HELPER_SendHandle *sh;
 533
 534   if (NULL != h->write_task)
 535   {
 536     GNUNET_SCHEDULER_cancel (h->write_task);
 537     h->write_task = NULL;
 538   }
 539   GNUNET_assert (NULL == h->read_task);
 540   GNUNET_assert (NULL == h->restart_task);
 541   while (NULL != (sh = h->sh_head))
 542   {
 543     GNUNET_CONTAINER_DLL_remove (h->sh_head,
 544                                  h->sh_tail,
 545                                  sh);
 546     if (NULL != sh->cont)
 547       sh->cont (sh->cont_cls, GNUNET_SYSERR);
 548     GNUNET_free (sh);
 549   }
 550   if (NULL != h->mst)
 551     GNUNET_SERVER_mst_destroy (h->mst);
 552   GNUNET_free (h->binary_name);
 553   for (c = 0; h->binary_argv[c] != NULL; c++)
 554     GNUNET_free (h->binary_argv[c]);
 555   GNUNET_free (h->binary_argv);
 556   GNUNET_free (h);
 557 }
 558
 559
 560 /**
 561  * Kills the helper, closes the pipe and frees the handle
 562  *
 563  * @param h handle to helper to stop
 564  * @param soft_kill if #GNUNET_YES, signals termination by closing the helper's
 565  *          stdin; #GNUNET_NO to signal termination by sending SIGTERM to helper
 566  */
 567 void
 568 GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h,
 569                     int soft_kill)
 570 {
 571   h->exp_cb = NULL;
 572   stop_helper (h, soft_kill);
 573   GNUNET_HELPER_destroy (h);
 574 }
 575
 576
 577 /**
 578  * Write to the helper-process
 579  *
 580  * @param cls handle to the helper process
 581  */
 582 static void
 583 helper_write (void *cls)
 584 {
 585   struct GNUNET_HELPER_Handle *h = cls;
 586   const struct GNUNET_SCHEDULER_TaskContext *tc;
 587   struct GNUNET_HELPER_SendHandle *sh;
 588   const char *buf;
 589   ssize_t t;
 590
 591   h->write_task = NULL;
 592   tc = GNUNET_SCHEDULER_get_task_context ();
 593   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 594   {
 595     /* try again */
 596     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 597                 "Helper write triggered during shutdown, retrying\n");
 598     h->write_task = GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
 599                                                      h->fh_to_helper, &helper_write, h);
 600     return;
 601   }
 602   if (NULL == (sh = h->sh_head))
 603   {
 604     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 605                 "Helper write had no work!\n");
 606     return; /* how did this happen? */
 607   }
 608   buf = (const char*) sh->msg;
 609   t = GNUNET_DISK_file_write (h->fh_to_helper,
 610                               &buf[sh->wpos],
 611                               ntohs (sh->msg->size) - sh->wpos);
 612   if (-1 == t)
 613   {
 614     /* On write-error, restart the helper */
 615     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 616                 _("Error writing to `%s': %s\n"),
 617                 h->binary_name,
 618                 STRERROR (errno));
 619     if (NULL != h->exp_cb)
 620     {
 621       h->exp_cb (h->cb_cls);
 622       GNUNET_HELPER_stop (h, GNUNET_NO);
 623       return;
 624     }
 625     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 626                 "Stopping and restarting helper task!\n");
 627     stop_helper (h, GNUNET_NO);
 628     /* Restart the helper */
 629       h->restart_task = GNUNET_SCHEDULER_add_delayed(
 630           GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 631               h->retry_back_off), &restart_task, h);
 632     return;
 633   }
 634   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 635               "Transmitted %u bytes to %s\n",
 636               (unsigned int) t,
 637               h->binary_name);
 638   sh->wpos += t;
 639   if (sh->wpos == ntohs (sh->msg->size))
 640   {
 641     GNUNET_CONTAINER_DLL_remove (h->sh_head,
 642                                  h->sh_tail,
 643                                  sh);
 644     if (NULL != sh->cont)
 645       sh->cont (sh->cont_cls, GNUNET_YES);
 646     GNUNET_free (sh);
 647   }
 648   if (NULL != h->sh_head)
 649     h->write_task = GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
 650                                                      h->fh_to_helper,
 651                                                      &helper_write,
 652                                                      h);
 653 }
 654
 655
 656 /**
 657  * Send an message to the helper.
 658  *
 659  * @param h helper to send message to
 660  * @param msg message to send
 661  * @param can_drop can the message be dropped if there is already one in the queue?
 662  * @param cont continuation to run once the message is out (#GNUNET_OK on succees, #GNUNET_NO
 663  *             if the helper process died, #GNUNET_SYSERR during #GNUNET_HELPER_destroy).
 664  * @param cont_cls closure for @a cont
 665  * @return NULL if the message was dropped,
 666  *         otherwise handle to cancel *cont* (actual transmission may
 667  *         not be abortable)
 668  */
 669 struct GNUNET_HELPER_SendHandle *
 670 GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h,
 671                     const struct GNUNET_MessageHeader *msg,
 672                     int can_drop,
 673                     GNUNET_HELPER_Continuation cont,
 674                     void *cont_cls)
 675 {
 676   struct GNUNET_HELPER_SendHandle *sh;
 677   uint16_t mlen;
 678
 679   if (NULL == h->fh_to_helper)
 680     return NULL;
 681   if ( (GNUNET_YES == can_drop) &&
 682        (NULL != h->sh_head) )
 683     return NULL;
 684   mlen = ntohs (msg->size);
 685   sh = GNUNET_malloc (sizeof (struct GNUNET_HELPER_SendHandle) + mlen);
 686   sh->msg = (const struct GNUNET_MessageHeader*) &sh[1];
 687   memcpy (&sh[1], msg, mlen);
 688   sh->h = h;
 689   sh->cont = cont;
 690   sh->cont_cls = cont_cls;
 691   GNUNET_CONTAINER_DLL_insert_tail (h->sh_head,
 692                                     h->sh_tail,
 693                                     sh);
 694   if (NULL == h->write_task)
 695     h->write_task = GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
 696                                                      h->fh_to_helper,
 697                                                      &helper_write,
 698                                                      h);
 699
 700   return sh;
 701 }
 702
 703 /**
 704  * Cancel a #GNUNET_HELPER_send operation.  If possible, transmitting the
 705  * message is also aborted, but at least 'cont' won't be
 706  * called.
 707  *
 708  * @param sh operation to cancel
 709  */
 710 void
 711 GNUNET_HELPER_send_cancel (struct GNUNET_HELPER_SendHandle *sh)
 712 {
 713   struct GNUNET_HELPER_Handle *h = sh->h;
 714
 715   sh->cont = NULL;
 716   sh->cont_cls = NULL;
 717   if (0 == sh->wpos)
 718   {
 719     GNUNET_CONTAINER_DLL_remove (h->sh_head, h->sh_tail, sh);
 720     GNUNET_free (sh);
 721     if (NULL == h->sh_head)
 722     {
 723       GNUNET_SCHEDULER_cancel (h->write_task);
 724       h->write_task = NULL;
 725     }
 726   }
 727 }
 728
 729
 730 /* end of helper.c */