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   char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE] GNUNET_ALIGN;
 323   ssize_t t;
 324
 325   h->read_task = NULL;
 326   t = GNUNET_DISK_file_read (h->fh_from_helper, &buf, sizeof (buf));
 327   if (t < 0)
 328   {
 329     /* On read-error, restart the helper */
 330     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 331                 _("Error reading from `%s': %s\n"),
 332                 h->binary_name,
 333                 STRERROR (errno));
 334     if (NULL != h->exp_cb)
 335     {
 336       h->exp_cb (h->cb_cls);
 337       GNUNET_HELPER_stop (h, GNUNET_NO);
 338       return;
 339     }
 340     stop_helper (h, GNUNET_NO);
 341     /* Restart the helper */
 342     h->restart_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
 343                                                                                    h->retry_back_off),
 344                                                     &restart_task, h);
 345     return;
 346   }
 347   if (0 == t)
 348   {
 349     /* this happens if the helper is shut down via a
 350        signal, so it is not a "hard" error */
 351     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 352                 "Got 0 bytes from helper `%s' (EOF)\n",
 353                 h->binary_name);
 354     if (NULL != h->exp_cb)
 355     {
 356       h->exp_cb (h->cb_cls);
 357       GNUNET_HELPER_stop (h, GNUNET_NO);
 358       return;
 359     }
 360     stop_helper (h, GNUNET_NO);
 361     /* Restart the helper */
 362     h->restart_task
 363       = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
 364                                                                    h->retry_back_off),
 365                                      &restart_task, h);
 366     return;
 367   }
 368   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 369               "Got %u bytes from helper `%s'\n",
 370               (unsigned int) t,
 371               h->binary_name);
 372   h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 373                                                  h->fh_from_helper,
 374                                                  &helper_read, h);
 375   if (GNUNET_SYSERR ==
 376       GNUNET_SERVER_mst_receive (h->mst,
 377                                  NULL,
 378                                  buf, t,
 379                                  GNUNET_NO, GNUNET_NO))
 380   {
 381     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 382                 _("Failed to parse inbound message from helper `%s'\n"),
 383                 h->binary_name);
 384     if (NULL != h->exp_cb)
 385     {
 386       h->exp_cb (h->cb_cls);
 387       GNUNET_HELPER_stop (h, GNUNET_NO);
 388       return;
 389     }
 390     stop_helper (h, GNUNET_NO);
 391     /* Restart the helper */
 392     h->restart_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 393                                                                                   h->retry_back_off),
 394                                                     &restart_task, h);
 395     return;
 396   }
 397 }
 398
 399
 400 /**
 401  * Start the helper process.
 402  *
 403  * @param h handle to the helper process
 404  */
 405 static void
 406 start_helper (struct GNUNET_HELPER_Handle *h)
 407 {
 408   h->helper_in = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_YES, GNUNET_NO);
 409   h->helper_out = GNUNET_DISK_pipe (GNUNET_YES, GNUNET_YES, GNUNET_NO, GNUNET_YES);
 410   if ( (h->helper_in == NULL) || (h->helper_out == NULL))
 411   {
 412     /* out of file descriptors? try again later... */
 413     stop_helper (h, GNUNET_NO);
 414     h->restart_task =
 415       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 416                                                                   h->retry_back_off),
 417                                     &restart_task, h);
 418     return;
 419   }
 420   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 421               "Starting HELPER process `%s'\n",
 422               h->binary_name);
 423   h->fh_from_helper =
 424       GNUNET_DISK_pipe_handle (h->helper_out, GNUNET_DISK_PIPE_END_READ);
 425   h->fh_to_helper =
 426       GNUNET_DISK_pipe_handle (h->helper_in, GNUNET_DISK_PIPE_END_WRITE);
 427   h->helper_proc =
 428     GNUNET_OS_start_process_vap (h->with_control_pipe, GNUNET_OS_INHERIT_STD_ERR,
 429                                  h->helper_in, h->helper_out, NULL,
 430                                  h->binary_name,
 431                                  h->binary_argv);
 432   if (NULL == h->helper_proc)
 433   {
 434     /* failed to start process? try again later... */
 435     stop_helper (h, GNUNET_NO);
 436     h->restart_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 437                                                                                   h->retry_back_off),
 438                                                     &restart_task, h);
 439     return;
 440   }
 441   GNUNET_DISK_pipe_close_end (h->helper_out, GNUNET_DISK_PIPE_END_WRITE);
 442   GNUNET_DISK_pipe_close_end (h->helper_in, GNUNET_DISK_PIPE_END_READ);
 443   if (NULL != h->mst)
 444     h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
 445                                                    h->fh_from_helper,
 446                                                    &helper_read,
 447                                                    h);
 448 }
 449
 450
 451 /**
 452  * Restart the helper process.
 453  *
 454  * @param cls handle to the helper process
 455  */
 456 static void
 457 restart_task (void *cls)
 458 {
 459   struct GNUNET_HELPER_Handle*h = cls;
 460
 461   h->restart_task = NULL;
 462   h->retry_back_off++;
 463   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 464               "Restarting helper with back-off %u\n",
 465               h->retry_back_off);
 466   start_helper (h);
 467 }
 468
 469
 470 /**
 471  * Starts a helper and begins reading from it. The helper process is
 472  * restarted when it dies except when it is stopped using GNUNET_HELPER_stop()
 473  * or when the exp_cb callback is not NULL.
 474  *
 475  * @param with_control_pipe does the helper support the use of a control pipe for signalling?
 476  * @param binary_name name of the binary to run
 477  * @param binary_argv NULL-terminated list of arguments to give when starting the binary (this
 478  *                    argument must not be modified by the client for
 479  *                     the lifetime of the helper handle)
 480  * @param cb function to call if we get messages from the helper
 481  * @param exp_cb the exception callback to call. Set this to NULL if the helper
 482  *          process has to be restarted automatically when it dies/crashes
 483  * @param cb_cls closure for the above callback
 484  * @return the new Handle, NULL on error
 485  */
 486 struct GNUNET_HELPER_Handle *
 487 GNUNET_HELPER_start (int with_control_pipe,
 488                      const char *binary_name,
 489                      char *const binary_argv[],
 490                      GNUNET_SERVER_MessageTokenizerCallback cb,
 491                      GNUNET_HELPER_ExceptionCallback exp_cb,
 492                      void *cb_cls)
 493 {
 494   struct GNUNET_HELPER_Handle *h;
 495   unsigned int c;
 496
 497   h = GNUNET_new (struct GNUNET_HELPER_Handle);
 498   h->with_control_pipe = with_control_pipe;
 499   /* Lookup in libexec path only if we are starting gnunet helpers */
 500   if (NULL != strstr (binary_name, "gnunet"))
 501     h->binary_name = GNUNET_OS_get_libexec_binary_path (binary_name);
 502   else
 503     h->binary_name = GNUNET_strdup (binary_name);
 504   for (c = 0; NULL != binary_argv[c]; c++);
 505   h->binary_argv = GNUNET_malloc (sizeof (char *) * (c + 1));
 506   for (c = 0; NULL != binary_argv[c]; c++)
 507     h->binary_argv[c] = GNUNET_strdup (binary_argv[c]);
 508   h->binary_argv[c] = NULL;
 509   h->cb_cls = cb_cls;
 510   if (NULL != cb)
 511     h->mst = GNUNET_SERVER_mst_create (cb, h->cb_cls);
 512   h->exp_cb = exp_cb;
 513   h->retry_back_off = 0;
 514   start_helper (h);
 515   return h;
 516 }
 517
 518
 519 /**
 520  * Free's the resources occupied by the helper handle
 521  *
 522  * @param h the helper handle to free
 523  */
 524 void
 525 GNUNET_HELPER_destroy (struct GNUNET_HELPER_Handle *h)
 526 {
 527   unsigned int c;
 528   struct GNUNET_HELPER_SendHandle *sh;
 529
 530   if (NULL != h->write_task)
 531   {
 532     GNUNET_SCHEDULER_cancel (h->write_task);
 533     h->write_task = NULL;
 534   }
 535   GNUNET_assert (NULL == h->read_task);
 536   GNUNET_assert (NULL == h->restart_task);
 537   while (NULL != (sh = h->sh_head))
 538   {
 539     GNUNET_CONTAINER_DLL_remove (h->sh_head,
 540                                  h->sh_tail,
 541                                  sh);
 542     if (NULL != sh->cont)
 543       sh->cont (sh->cont_cls, GNUNET_SYSERR);
 544     GNUNET_free (sh);
 545   }
 546   if (NULL != h->mst)
 547     GNUNET_SERVER_mst_destroy (h->mst);
 548   GNUNET_free (h->binary_name);
 549   for (c = 0; h->binary_argv[c] != NULL; c++)
 550     GNUNET_free (h->binary_argv[c]);
 551   GNUNET_free (h->binary_argv);
 552   GNUNET_free (h);
 553 }
 554
 555
 556 /**
 557  * Kills the helper, closes the pipe and frees the handle
 558  *
 559  * @param h handle to helper to stop
 560  * @param soft_kill if #GNUNET_YES, signals termination by closing the helper's
 561  *          stdin; #GNUNET_NO to signal termination by sending SIGTERM to helper
 562  */
 563 void
 564 GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h,
 565                     int soft_kill)
 566 {
 567   h->exp_cb = NULL;
 568   stop_helper (h, soft_kill);
 569   GNUNET_HELPER_destroy (h);
 570 }
 571
 572
 573 /**
 574  * Write to the helper-process
 575  *
 576  * @param cls handle to the helper process
 577  */
 578 static void
 579 helper_write (void *cls)
 580 {
 581   struct GNUNET_HELPER_Handle *h = cls;
 582   struct GNUNET_HELPER_SendHandle *sh;
 583   const char *buf;
 584   ssize_t t;
 585
 586   h->write_task = NULL;
 587   if (NULL == (sh = h->sh_head))
 588   {
 589     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 590                 "Helper write had no work!\n");
 591     return; /* how did this happen? */
 592   }
 593   buf = (const char*) sh->msg;
 594   t = GNUNET_DISK_file_write (h->fh_to_helper,
 595                               &buf[sh->wpos],
 596                               ntohs (sh->msg->size) - sh->wpos);
 597   if (-1 == t)
 598   {
 599     /* On write-error, restart the helper */
 600     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 601                 _("Error writing to `%s': %s\n"),
 602                 h->binary_name,
 603                 STRERROR (errno));
 604     if (NULL != h->exp_cb)
 605     {
 606       h->exp_cb (h->cb_cls);
 607       GNUNET_HELPER_stop (h, GNUNET_NO);
 608       return;
 609     }
 610     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 611                 "Stopping and restarting helper task!\n");
 612     stop_helper (h, GNUNET_NO);
 613     /* Restart the helper */
 614     h->restart_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,
 615                                                                                   h->retry_back_off),
 616                                                     &restart_task, h);
 617     return;
 618   }
 619   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 620               "Transmitted %u bytes to %s\n",
 621               (unsigned int) t,
 622               h->binary_name);
 623   sh->wpos += t;
 624   if (sh->wpos == ntohs (sh->msg->size))
 625   {
 626     GNUNET_CONTAINER_DLL_remove (h->sh_head,
 627                                  h->sh_tail,
 628                                  sh);
 629     if (NULL != sh->cont)
 630       sh->cont (sh->cont_cls, GNUNET_YES);
 631     GNUNET_free (sh);
 632   }
 633   if (NULL != h->sh_head)
 634     h->write_task = GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
 635                                                      h->fh_to_helper,
 636                                                      &helper_write,
 637                                                      h);
 638 }
 639
 640
 641 /**
 642  * Send an message to the helper.
 643  *
 644  * @param h helper to send message to
 645  * @param msg message to send
 646  * @param can_drop can the message be dropped if there is already one in the queue?
 647  * @param cont continuation to run once the message is out (#GNUNET_OK on succees, #GNUNET_NO
 648  *             if the helper process died, #GNUNET_SYSERR during #GNUNET_HELPER_destroy).
 649  * @param cont_cls closure for @a cont
 650  * @return NULL if the message was dropped,
 651  *         otherwise handle to cancel *cont* (actual transmission may
 652  *         not be abortable)
 653  */
 654 struct GNUNET_HELPER_SendHandle *
 655 GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h,
 656                     const struct GNUNET_MessageHeader *msg,
 657                     int can_drop,
 658                     GNUNET_HELPER_Continuation cont,
 659                     void *cont_cls)
 660 {
 661   struct GNUNET_HELPER_SendHandle *sh;
 662   uint16_t mlen;
 663
 664   if (NULL == h->fh_to_helper)
 665     return NULL;
 666   if ( (GNUNET_YES == can_drop) &&
 667        (NULL != h->sh_head) )
 668     return NULL;
 669   mlen = ntohs (msg->size);
 670   sh = GNUNET_malloc (sizeof (struct GNUNET_HELPER_SendHandle) + mlen);
 671   sh->msg = (const struct GNUNET_MessageHeader*) &sh[1];
 672   GNUNET_memcpy (&sh[1], msg, mlen);
 673   sh->h = h;
 674   sh->cont = cont;
 675   sh->cont_cls = cont_cls;
 676   GNUNET_CONTAINER_DLL_insert_tail (h->sh_head,
 677                                     h->sh_tail,
 678                                     sh);
 679   if (NULL == h->write_task)
 680     h->write_task = GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL,
 681                                                      h->fh_to_helper,
 682                                                      &helper_write,
 683                                                      h);
 684
 685   return sh;
 686 }
 687
 688 /**
 689  * Cancel a #GNUNET_HELPER_send operation.  If possible, transmitting the
 690  * message is also aborted, but at least 'cont' won't be
 691  * called.
 692  *
 693  * @param sh operation to cancel
 694  */
 695 void
 696 GNUNET_HELPER_send_cancel (struct GNUNET_HELPER_SendHandle *sh)
 697 {
 698   struct GNUNET_HELPER_Handle *h = sh->h;
 699
 700   sh->cont = NULL;
 701   sh->cont_cls = NULL;
 702   if (0 == sh->wpos)
 703   {
 704     GNUNET_CONTAINER_DLL_remove (h->sh_head, h->sh_tail, sh);
 705     GNUNET_free (sh);
 706     if (NULL == h->sh_head)
 707     {
 708       GNUNET_SCHEDULER_cancel (h->write_task);
 709       h->write_task = NULL;
 710     }
 711   }
 712 }
 713
 714
 715 /* end of helper.c */