src/util/mq.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012-2014 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  * @author Florian Dold
  23  * @file util/mq.c
  24  * @brief general purpose request queue
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28
  29 #define LOG(kind,...) GNUNET_log_from (kind, "mq",__VA_ARGS__)
  30
  31
  32 struct GNUNET_MQ_Envelope
  33 {
  34   /**
  35    * Messages are stored in a linked list.
  36    * Each queue has its own list of envelopes.
  37    */
  38   struct GNUNET_MQ_Envelope *next;
  39
  40   /**
  41    * Messages are stored in a linked list
  42    * Each queue has its own list of envelopes.
  43    */
  44   struct GNUNET_MQ_Envelope *prev;
  45
  46   /**
  47    * Actual allocated message header.
  48    * The GNUNET_MQ_Envelope header is allocated at
  49    * the end of the message.
  50    */
  51   struct GNUNET_MessageHeader *mh;
  52
  53   /**
  54    * Queue the message is queued in, NULL if message is not queued.
  55    */
  56   struct GNUNET_MQ_Handle *parent_queue;
  57
  58   /**
  59    * Called after the message was sent irrevocably.
  60    */
  61   GNUNET_SCHEDULER_TaskCallback sent_cb;
  62
  63   /**
  64    * Closure for @e send_cb
  65    */
  66   void *sent_cls;
  67
  68   /**
  69    * Flags that were set for this envelope by
  70    * #GNUNET_MQ_env_set_options().   Only valid if
  71    * @e have_custom_options is set.
  72    */
  73   uint64_t flags;
  74
  75   /**
  76    * Additional options buffer set for this envelope by
  77    * #GNUNET_MQ_env_set_options().  Only valid if
  78    * @e have_custom_options is set.
  79    */
  80   const void *extra;
  81
  82   /**
  83    * Did the application call #GNUNET_MQ_env_set_options()?
  84    */
  85   int have_custom_options;
  86 };
  87
  88
  89 /**
  90  * Handle to a message queue.
  91  */
  92 struct GNUNET_MQ_Handle
  93 {
  94   /**
  95    * Handlers array, or NULL if the queue should not receive messages
  96    */
  97   struct GNUNET_MQ_MessageHandler *handlers;
  98
  99   /**
 100    * Actual implementation of message sending,
 101    * called when a message is added
 102    */
 103   GNUNET_MQ_SendImpl send_impl;
 104
 105   /**
 106    * Implementation-dependent queue destruction function
 107    */
 108   GNUNET_MQ_DestroyImpl destroy_impl;
 109
 110   /**
 111    * Implementation-dependent send cancel function
 112    */
 113   GNUNET_MQ_CancelImpl cancel_impl;
 114
 115   /**
 116    * Implementation-specific state
 117    */
 118   void *impl_state;
 119
 120   /**
 121    * Callback will be called when an error occurs.
 122    */
 123   GNUNET_MQ_ErrorHandler error_handler;
 124
 125   /**
 126    * Closure for the error handler.
 127    */
 128   void *error_handler_cls;
 129
 130   /**
 131    * Task to asynchronously run #impl_send_continue().
 132    */
 133   struct GNUNET_SCHEDULER_Task *send_task;
 134
 135   /**
 136    * Linked list of messages pending to be sent
 137    */
 138   struct GNUNET_MQ_Envelope *envelope_head;
 139
 140   /**
 141    * Linked list of messages pending to be sent
 142    */
 143   struct GNUNET_MQ_Envelope *envelope_tail;
 144
 145   /**
 146    * Message that is currently scheduled to be
 147    * sent. Not the head of the message queue, as the implementation
 148    * needs to know if sending has been already scheduled or not.
 149    */
 150   struct GNUNET_MQ_Envelope *current_envelope;
 151
 152   /**
 153    * Map of associations, lazily allocated
 154    */
 155   struct GNUNET_CONTAINER_MultiHashMap32 *assoc_map;
 156
 157   /**
 158    * Functions to call on queue destruction; kept in a DLL.
 159    */
 160   struct GNUNET_MQ_DestroyNotificationHandle *dnh_head;
 161
 162   /**
 163    * Functions to call on queue destruction; kept in a DLL.
 164    */
 165   struct GNUNET_MQ_DestroyNotificationHandle *dnh_tail;
 166
 167   /**
 168    * Additional options buffer set for this queue by
 169    * #GNUNET_MQ_set_options().  Default is 0.
 170    */
 171   const void *default_extra;
 172
 173   /**
 174    * Flags that were set for this queue by
 175    * #GNUNET_MQ_set_options().   Default is 0.
 176    */
 177   uint64_t default_flags;
 178
 179   /**
 180    * Next id that should be used for the @e assoc_map,
 181    * initialized lazily to a random value together with
 182    * @e assoc_map
 183    */
 184   uint32_t assoc_id;
 185
 186   /**
 187    * Number of entries we have in the envelope-DLL.
 188    */
 189   unsigned int queue_length;
 190
 191   /**
 192    * #GNUNET_YES if GNUNET_MQ_impl_evacuate was called.
 193    * FIXME: is this dead?
 194    */
 195   int evacuate_called;
 196
 197   /**
 198    * #GNUNET_YES if GNUNET_MQ_impl_send_in_flight() was called.
 199    */
 200   int in_flight;
 201 };
 202
 203
 204 /**
 205  * Implementation-specific state for connection to
 206  * client (MQ for server).
 207  */
 208 struct ServerClientSocketState
 209 {
 210   /**
 211    * Handle of the client that connected to the server.
 212    */
 213   struct GNUNET_SERVER_Client *client;
 214
 215   /**
 216    * Active transmission request to the client.
 217    */
 218   struct GNUNET_SERVER_TransmitHandle *th;
 219 };
 220
 221
 222 /**
 223  * Call the message message handler that was registered
 224  * for the type of the given message in the given message queue.
 225  *
 226  * This function is indended to be used for the implementation
 227  * of message queues.
 228  *
 229  * @param mq message queue with the handlers
 230  * @param mh message to dispatch
 231  */
 232 void
 233 GNUNET_MQ_inject_message (struct GNUNET_MQ_Handle *mq,
 234                           const struct GNUNET_MessageHeader *mh)
 235 {
 236   const struct GNUNET_MQ_MessageHandler *handler;
 237   int handled = GNUNET_NO;
 238   uint16_t ms = ntohs (mh->size);
 239
 240   if (NULL == mq->handlers)
 241     goto done;
 242   for (handler = mq->handlers; NULL != handler->cb; handler++)
 243   {
 244     if (handler->type == ntohs (mh->type))
 245     {
 246       handled = GNUNET_YES;
 247       if ( (handler->expected_size > ms) ||
 248            ( (handler->expected_size != ms) &&
 249              (NULL == handler->mv) ) )
 250       {
 251         /* Too small, or not an exact size and
 252            no 'mv' handler to check rest */
 253         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 254                     "Received malformed message of type %u\n",
 255                     (unsigned int) handler->type);
 256         GNUNET_MQ_inject_error (mq,
 257                                 GNUNET_MQ_ERROR_MALFORMED);
 258         break;
 259       }
 260       if ( (NULL == handler->mv) ||
 261            (GNUNET_OK ==
 262             handler->mv (handler->cls, mh)) )
 263       {
 264         /* message well-formed, pass to handler */
 265         handler->cb (handler->cls, mh);
 266       }
 267       else
 268       {
 269         /* Message rejected by check routine */
 270         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 271                     "Received malformed message of type %u\n",
 272                     (unsigned int) handler->type);
 273         GNUNET_MQ_inject_error (mq,
 274                                 GNUNET_MQ_ERROR_MALFORMED);
 275       }
 276       break;
 277     }
 278   }
 279  done:
 280   if (GNUNET_NO == handled)
 281     LOG (GNUNET_ERROR_TYPE_INFO,
 282          "No handler for message of type %d and size %d\n",
 283          ntohs (mh->type),
 284          ntohs (mh->size));
 285 }
 286
 287
 288 /**
 289  * Call the error handler of a message queue with the given
 290  * error code.  If there is no error handler, log a warning.
 291  *
 292  * This function is intended to be used by the implementation
 293  * of message queues.
 294  *
 295  * @param mq message queue
 296  * @param error the error type
 297  */
 298 void
 299 GNUNET_MQ_inject_error (struct GNUNET_MQ_Handle *mq,
 300                         enum GNUNET_MQ_Error error)
 301 {
 302   if (NULL == mq->error_handler)
 303   {
 304     LOG (GNUNET_ERROR_TYPE_WARNING,
 305          "Got error %d, but no handler installed\n",
 306          (int) error);
 307     return;
 308   }
 309   mq->error_handler (mq->error_handler_cls,
 310                      error);
 311 }
 312
 313
 314 /**
 315  * Discard the message queue message, free all
 316  * allocated resources. Must be called in the event
 317  * that a message is created but should not actually be sent.
 318  *
 319  * @param mqm the message to discard
 320  */
 321 void
 322 GNUNET_MQ_discard (struct GNUNET_MQ_Envelope *ev)
 323 {
 324   GNUNET_assert (NULL == ev->parent_queue);
 325   GNUNET_free (ev);
 326 }
 327
 328
 329 /**
 330  * Obtain the current length of the message queue.
 331  *
 332  * @param mq queue to inspect
 333  * @return number of queued, non-transmitted messages
 334  */
 335 unsigned int
 336 GNUNET_MQ_get_length (struct GNUNET_MQ_Handle *mq)
 337 {
 338   if (GNUNET_YES != mq->in_flight)
 339   {
 340     return mq->queue_length;
 341   }
 342   return mq->queue_length - 1;
 343 }
 344
 345
 346 /**
 347  * Send a message with the given message queue.
 348  * May only be called once per message.
 349  *
 350  * @param mq message queue
 351  * @param ev the envelope with the message to send.
 352  */
 353 void
 354 GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq,
 355                 struct GNUNET_MQ_Envelope *ev)
 356 {
 357   GNUNET_assert (NULL != mq);
 358   GNUNET_assert (NULL == ev->parent_queue);
 359
 360   mq->queue_length++;
 361   ev->parent_queue = mq;
 362   /* is the implementation busy? queue it! */
 363   if ( (NULL != mq->current_envelope) ||
 364        (NULL != mq->send_task) )
 365   {
 366     GNUNET_CONTAINER_DLL_insert_tail (mq->envelope_head,
 367                                       mq->envelope_tail,
 368                                       ev);
 369     return;
 370   }
 371   mq->current_envelope = ev;
 372   mq->send_impl (mq,
 373                  ev->mh,
 374                  mq->impl_state);
 375 }
 376
 377
 378 /**
 379  * Send a copy of a message with the given message queue.
 380  * Can be called repeatedly on the same envelope.
 381  *
 382  * @param mq message queue
 383  * @param ev the envelope with the message to send.
 384  */
 385 void
 386 GNUNET_MQ_send_copy (struct GNUNET_MQ_Handle *mq,
 387                      const struct GNUNET_MQ_Envelope *ev)
 388 {
 389   struct GNUNET_MQ_Envelope *env;
 390   uint16_t msize;
 391
 392   msize = ntohs (ev->mh->size);
 393   env = GNUNET_malloc (sizeof (struct GNUNET_MQ_Envelope) +
 394                        msize);
 395   env->mh = (struct GNUNET_MessageHeader *) &env[1];
 396   env->sent_cb = ev->sent_cb;
 397   env->sent_cls = ev->sent_cls;
 398   GNUNET_memcpy (&env[1],
 399           ev->mh,
 400           msize);
 401   GNUNET_MQ_send (mq,
 402                   env);
 403 }
 404
 405
 406 /**
 407  * Task run to call the send implementation for the next queued
 408  * message, if any.  Only useful for implementing message queues,
 409  * results in undefined behavior if not used carefully.
 410  *
 411  * @param cls message queue to send the next message with
 412  */
 413 static void
 414 impl_send_continue (void *cls)
 415 {
 416   struct GNUNET_MQ_Handle *mq = cls;
 417
 418   mq->send_task = NULL;
 419   /* call is only valid if we're actually currently sending
 420    * a message */
 421   if (NULL == mq->envelope_head)
 422     return;
 423   mq->current_envelope = mq->envelope_head;
 424   GNUNET_CONTAINER_DLL_remove (mq->envelope_head,
 425                                mq->envelope_tail,
 426                                mq->current_envelope);
 427   mq->send_impl (mq,
 428                  mq->current_envelope->mh,
 429                  mq->impl_state);
 430 }
 431
 432
 433 /**
 434  * Call the send implementation for the next queued message, if any.
 435  * Only useful for implementing message queues, results in undefined
 436  * behavior if not used carefully.
 437  *
 438  * @param mq message queue to send the next message with
 439  */
 440 void
 441 GNUNET_MQ_impl_send_continue (struct GNUNET_MQ_Handle *mq)
 442 {
 443   struct GNUNET_MQ_Envelope *current_envelope;
 444   GNUNET_SCHEDULER_TaskCallback cb;
 445
 446   GNUNET_assert (0 < mq->queue_length);
 447   mq->queue_length--;
 448   mq->in_flight = GNUNET_NO;
 449   current_envelope = mq->current_envelope;
 450   current_envelope->parent_queue = NULL;
 451   mq->current_envelope = NULL;
 452   GNUNET_assert (NULL == mq->send_task);
 453   mq->send_task = GNUNET_SCHEDULER_add_now (&impl_send_continue,
 454                                             mq);
 455   if (NULL != (cb = current_envelope->sent_cb))
 456   {
 457     current_envelope->sent_cb = NULL;
 458     cb (current_envelope->sent_cls);
 459   }
 460   GNUNET_free (current_envelope);
 461 }
 462
 463
 464 /**
 465  * Call the send notification for the current message, but do not
 466  * try to send the next message until #GNUNET_MQ_impl_send_continue
 467  * is called.
 468  *
 469  * Only useful for implementing message queues, results in undefined
 470  * behavior if not used carefully.
 471  *
 472  * @param mq message queue to send the next message with
 473  */
 474 void
 475 GNUNET_MQ_impl_send_in_flight (struct GNUNET_MQ_Handle *mq)
 476 {
 477   struct GNUNET_MQ_Envelope *current_envelope;
 478   GNUNET_SCHEDULER_TaskCallback cb;
 479
 480   mq->in_flight = GNUNET_YES;
 481   /* call is only valid if we're actually currently sending
 482    * a message */
 483   current_envelope = mq->current_envelope;
 484   GNUNET_assert (NULL != current_envelope);
 485   /* can't call cancel from now on anymore */
 486   current_envelope->parent_queue = NULL;
 487   if (NULL != (cb = current_envelope->sent_cb))
 488   {
 489     current_envelope->sent_cb = NULL;
 490     cb (current_envelope->sent_cls);
 491   }
 492 }
 493
 494
 495 /**
 496  * Create a message queue for the specified handlers.
 497  *
 498  * @param send function the implements sending messages
 499  * @param destroy function that implements destroying the queue
 500  * @param cancel function that implements canceling a message
 501  * @param impl_state for the queue, passed to 'send' and 'destroy'
 502  * @param handlers array of message handlers
 503  * @param error_handler handler for read and write errors
 504  * @param error_handler_cls closure for @a error_handler
 505  * @return a new message queue
 506  */
 507 struct GNUNET_MQ_Handle *
 508 GNUNET_MQ_queue_for_callbacks (GNUNET_MQ_SendImpl send,
 509                                GNUNET_MQ_DestroyImpl destroy,
 510                                GNUNET_MQ_CancelImpl cancel,
 511                                void *impl_state,
 512                                const struct GNUNET_MQ_MessageHandler *handlers,
 513                                GNUNET_MQ_ErrorHandler error_handler,
 514                                void *error_handler_cls)
 515 {
 516   struct GNUNET_MQ_Handle *mq;
 517   unsigned int i;
 518
 519   mq = GNUNET_new (struct GNUNET_MQ_Handle);
 520   mq->send_impl = send;
 521   mq->destroy_impl = destroy;
 522   mq->cancel_impl = cancel;
 523   if (NULL != handlers)
 524   {
 525     for (i=0;NULL != handlers[i].cb; i++) ;
 526     mq->handlers = GNUNET_new_array (i + 1,
 527                                      struct GNUNET_MQ_MessageHandler);
 528     GNUNET_memcpy (mq->handlers,
 529             handlers,
 530             i * sizeof (struct GNUNET_MQ_MessageHandler));
 531   }
 532   mq->error_handler = error_handler;
 533   mq->error_handler_cls = error_handler_cls;
 534   mq->impl_state = impl_state;
 535
 536   return mq;
 537 }
 538
 539
 540 /**
 541  * Change the closure argument in all of the `handlers` of the
 542  * @a mq.
 543  *
 544  * @param mq to modify
 545  * @param handlers_cls new closure to use
 546  */
 547 void
 548 GNUNET_MQ_set_handlers_closure (struct GNUNET_MQ_Handle *mq,
 549                                 void *handlers_cls)
 550 {
 551   unsigned int i;
 552
 553   if (NULL == mq->handlers)
 554     return;
 555   for (i=0;NULL != mq->handlers[i].cb; i++)
 556     mq->handlers[i].cls = handlers_cls;
 557 }
 558
 559
 560 /**
 561  * Get the message that should currently be sent.
 562  * Fails if there is no current message.
 563  * Only useful for implementing message queues,
 564  * results in undefined behavior if not used carefully.
 565  *
 566  * @param mq message queue with the current message
 567  * @return message to send, never NULL
 568  */
 569 const struct GNUNET_MessageHeader *
 570 GNUNET_MQ_impl_current (struct GNUNET_MQ_Handle *mq)
 571 {
 572   GNUNET_assert (NULL != mq->current_envelope);
 573   GNUNET_assert (NULL != mq->current_envelope->mh);
 574   return mq->current_envelope->mh;
 575 }
 576
 577
 578 /**
 579  * Get the implementation state associated with the
 580  * message queue.
 581  *
 582  * While the GNUNET_MQ_Impl* callbacks receive the
 583  * implementation state, continuations that are scheduled
 584  * by the implementation function often only have one closure
 585  * argument, with this function it is possible to get at the
 586  * implementation state when only passing the GNUNET_MQ_Handle
 587  * as closure.
 588  *
 589  * @param mq message queue with the current message
 590  * @return message to send, never NULL
 591  */
 592 void *
 593 GNUNET_MQ_impl_state (struct GNUNET_MQ_Handle *mq)
 594 {
 595   return mq->impl_state;
 596 }
 597
 598
 599 struct GNUNET_MQ_Envelope *
 600 GNUNET_MQ_msg_ (struct GNUNET_MessageHeader **mhp,
 601                 uint16_t size,
 602                 uint16_t type)
 603 {
 604   struct GNUNET_MQ_Envelope *ev;
 605
 606   ev = GNUNET_malloc (size + sizeof (struct GNUNET_MQ_Envelope));
 607   ev->mh = (struct GNUNET_MessageHeader *) &ev[1];
 608   ev->mh->size = htons (size);
 609   ev->mh->type = htons (type);
 610   if (NULL != mhp)
 611     *mhp = ev->mh;
 612   return ev;
 613 }
 614
 615
 616 /**
 617  * Create a new envelope by copying an existing message.
 618  *
 619  * @param hdr header of the message to copy
 620  * @return envelope containing @a hdr
 621  */
 622 struct GNUNET_MQ_Envelope *
 623 GNUNET_MQ_msg_copy (const struct GNUNET_MessageHeader *hdr)
 624 {
 625   struct GNUNET_MQ_Envelope *mqm;
 626   uint16_t size = ntohs (hdr->size);
 627
 628   mqm = GNUNET_malloc (sizeof (*mqm) + size);
 629   mqm->mh = (struct GNUNET_MessageHeader *) &mqm[1];
 630   GNUNET_memcpy (mqm->mh,
 631           hdr,
 632           size);
 633   return mqm;
 634 }
 635
 636
 637 /**
 638  * Implementation of the #GNUNET_MQ_msg_nested_mh macro.
 639  *
 640  * @param mhp pointer to the message header pointer that will be changed to allocate at
 641  *        the newly allocated space for the message.
 642  * @param base_size size of the data before the nested message
 643  * @param type type of the message in the envelope
 644  * @param nested_mh the message to append to the message after base_size
 645  */
 646 struct GNUNET_MQ_Envelope *
 647 GNUNET_MQ_msg_nested_mh_ (struct GNUNET_MessageHeader **mhp,
 648                           uint16_t base_size,
 649                           uint16_t type,
 650                           const struct GNUNET_MessageHeader *nested_mh)
 651 {
 652   struct GNUNET_MQ_Envelope *mqm;
 653   uint16_t size;
 654
 655   if (NULL == nested_mh)
 656     return GNUNET_MQ_msg_ (mhp, base_size, type);
 657
 658   size = base_size + ntohs (nested_mh->size);
 659
 660   /* check for uint16_t overflow */
 661   if (size < base_size)
 662     return NULL;
 663
 664   mqm = GNUNET_MQ_msg_ (mhp, size, type);
 665   GNUNET_memcpy ((char *) mqm->mh + base_size,
 666                  nested_mh,
 667                  ntohs (nested_mh->size));
 668
 669   return mqm;
 670 }
 671
 672
 673 /**
 674  * Transmit a queued message to the session's client.
 675  *
 676  * @param cls consensus session
 677  * @param size number of bytes available in @a buf
 678  * @param buf where the callee should write the message
 679  * @return number of bytes written to @a buf
 680  */
 681 static size_t
 682 transmit_queued (void *cls,
 683                  size_t size,
 684                  void *buf)
 685 {
 686   struct GNUNET_MQ_Handle *mq = cls;
 687   struct ServerClientSocketState *state = GNUNET_MQ_impl_state (mq);
 688   const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq);
 689   size_t msg_size;
 690
 691   GNUNET_assert (NULL != buf);
 692   msg_size = ntohs (msg->size);
 693   GNUNET_assert (size >= msg_size);
 694   GNUNET_memcpy (buf, msg, msg_size);
 695   state->th = NULL;
 696
 697   GNUNET_MQ_impl_send_continue (mq);
 698
 699   return msg_size;
 700 }
 701
 702
 703 static void
 704 server_client_destroy_impl (struct GNUNET_MQ_Handle *mq,
 705                             void *impl_state)
 706 {
 707   struct ServerClientSocketState *state = impl_state;
 708
 709   if (NULL != state->th)
 710   {
 711     GNUNET_SERVER_notify_transmit_ready_cancel (state->th);
 712     state->th = NULL;
 713   }
 714
 715   GNUNET_assert (NULL != mq);
 716   GNUNET_assert (NULL != state);
 717   GNUNET_SERVER_client_drop (state->client);
 718   GNUNET_free (state);
 719 }
 720
 721
 722 static void
 723 server_client_send_impl (struct GNUNET_MQ_Handle *mq,
 724                          const struct GNUNET_MessageHeader *msg,
 725                          void *impl_state)
 726 {
 727   struct ServerClientSocketState *state = impl_state;
 728
 729   GNUNET_assert (NULL != mq);
 730   state->th = GNUNET_SERVER_notify_transmit_ready (state->client,
 731                                                    ntohs (msg->size),
 732                                                    GNUNET_TIME_UNIT_FOREVER_REL,
 733                                                    &transmit_queued, mq);
 734 }
 735
 736
 737 struct GNUNET_MQ_Handle *
 738 GNUNET_MQ_queue_for_server_client (struct GNUNET_SERVER_Client *client)
 739 {
 740   struct GNUNET_MQ_Handle *mq;
 741   struct ServerClientSocketState *scss;
 742
 743   mq = GNUNET_new (struct GNUNET_MQ_Handle);
 744   scss = GNUNET_new (struct ServerClientSocketState);
 745   mq->impl_state = scss;
 746   scss->client = client;
 747   GNUNET_SERVER_client_keep (client);
 748   mq->send_impl = &server_client_send_impl;
 749   mq->destroy_impl = &server_client_destroy_impl;
 750   return mq;
 751 }
 752
 753
 754 /**
 755  * Associate the assoc_data in mq with a unique request id.
 756  *
 757  * @param mq message queue, id will be unique for the queue
 758  * @param assoc_data to associate
 759  */
 760 uint32_t
 761 GNUNET_MQ_assoc_add (struct GNUNET_MQ_Handle *mq,
 762                      void *assoc_data)
 763 {
 764   uint32_t id;
 765
 766   if (NULL == mq->assoc_map)
 767   {
 768     mq->assoc_map = GNUNET_CONTAINER_multihashmap32_create (8);
 769     mq->assoc_id = 1;
 770   }
 771   id = mq->assoc_id++;
 772   GNUNET_CONTAINER_multihashmap32_put (mq->assoc_map, id, assoc_data,
 773                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
 774   return id;
 775 }
 776
 777
 778 void *
 779 GNUNET_MQ_assoc_get (struct GNUNET_MQ_Handle *mq,
 780                      uint32_t request_id)
 781 {
 782   if (NULL == mq->assoc_map)
 783     return NULL;
 784   return GNUNET_CONTAINER_multihashmap32_get (mq->assoc_map, request_id);
 785 }
 786
 787
 788 void *
 789 GNUNET_MQ_assoc_remove (struct GNUNET_MQ_Handle *mq,
 790                         uint32_t request_id)
 791 {
 792   void *val;
 793
 794   if (NULL == mq->assoc_map)
 795     return NULL;
 796   val = GNUNET_CONTAINER_multihashmap32_get (mq->assoc_map,
 797                                              request_id);
 798   GNUNET_CONTAINER_multihashmap32_remove_all (mq->assoc_map,
 799                                               request_id);
 800   return val;
 801 }
 802
 803
 804 /**
 805  * Call a callback once the envelope has been sent, that is,
 806  * sending it can not be canceled anymore.
 807  * There can be only one notify sent callback per envelope.
 808  *
 809  * @param ev message to call the notify callback for
 810  * @param cb the notify callback
 811  * @param cb_cls closure for the callback
 812  */
 813 void
 814 GNUNET_MQ_notify_sent (struct GNUNET_MQ_Envelope *ev,
 815                        GNUNET_SCHEDULER_TaskCallback cb,
 816                        void *cb_cls)
 817 {
 818   GNUNET_assert (NULL == ev->sent_cb);
 819   ev->sent_cb = cb;
 820   ev->sent_cls = cb_cls;
 821 }
 822
 823
 824 /**
 825  * Handle we return for callbacks registered to be
 826  * notified when #GNUNET_MQ_destroy() is called on a queue.
 827  */
 828 struct GNUNET_MQ_DestroyNotificationHandle
 829 {
 830   /**
 831    * Kept in a DLL.
 832    */
 833   struct GNUNET_MQ_DestroyNotificationHandle *prev;
 834
 835   /**
 836    * Kept in a DLL.
 837    */
 838   struct GNUNET_MQ_DestroyNotificationHandle *next;
 839
 840   /**
 841    * Queue to notify about.
 842    */
 843   struct GNUNET_MQ_Handle *mq;
 844
 845   /**
 846    * Function to call.
 847    */
 848   GNUNET_SCHEDULER_TaskCallback cb;
 849
 850   /**
 851    * Closure for @e cb.
 852    */
 853   void *cb_cls;
 854 };
 855
 856
 857 /**
 858  * Destroy the message queue.
 859  *
 860  * @param mq message queue to destroy
 861  */
 862 void
 863 GNUNET_MQ_destroy (struct GNUNET_MQ_Handle *mq)
 864 {
 865   struct GNUNET_MQ_DestroyNotificationHandle *dnh;
 866
 867   if (NULL != mq->destroy_impl)
 868   {
 869     mq->destroy_impl (mq, mq->impl_state);
 870   }
 871   if (NULL != mq->send_task)
 872   {
 873     GNUNET_SCHEDULER_cancel (mq->send_task);
 874     mq->send_task = NULL;
 875   }
 876   while (NULL != mq->envelope_head)
 877   {
 878     struct GNUNET_MQ_Envelope *ev;
 879
 880     ev = mq->envelope_head;
 881     ev->parent_queue = NULL;
 882     GNUNET_CONTAINER_DLL_remove (mq->envelope_head,
 883                                  mq->envelope_tail,
 884                                  ev);
 885     GNUNET_assert (0 < mq->queue_length);
 886     mq->queue_length--;
 887     GNUNET_MQ_discard (ev);
 888   }
 889   if (NULL != mq->current_envelope)
 890   {
 891     /* we can only discard envelopes that
 892      * are not queued! */
 893     mq->current_envelope->parent_queue = NULL;
 894     GNUNET_MQ_discard (mq->current_envelope);
 895     mq->current_envelope = NULL;
 896     GNUNET_assert (0 < mq->queue_length);
 897     mq->queue_length--;
 898   }
 899   GNUNET_assert (0 == mq->queue_length);
 900   while (NULL != (dnh = mq->dnh_head))
 901   {
 902     dnh->cb (dnh->cb_cls);
 903     GNUNET_MQ_destroy_notify_cancel (dnh);
 904   }
 905   if (NULL != mq->assoc_map)
 906   {
 907     GNUNET_CONTAINER_multihashmap32_destroy (mq->assoc_map);
 908     mq->assoc_map = NULL;
 909   }
 910   GNUNET_free_non_null (mq->handlers);
 911   GNUNET_free (mq);
 912 }
 913
 914
 915 const struct GNUNET_MessageHeader *
 916 GNUNET_MQ_extract_nested_mh_ (const struct GNUNET_MessageHeader *mh,
 917                               uint16_t base_size)
 918 {
 919   uint16_t whole_size;
 920   uint16_t nested_size;
 921   const struct GNUNET_MessageHeader *nested_msg;
 922
 923   whole_size = ntohs (mh->size);
 924   GNUNET_assert (whole_size >= base_size);
 925   nested_size = whole_size - base_size;
 926   if (0 == nested_size)
 927     return NULL;
 928   if (nested_size < sizeof (struct GNUNET_MessageHeader))
 929   {
 930     GNUNET_break_op (0);
 931     return NULL;
 932   }
 933   nested_msg = (const struct GNUNET_MessageHeader *) ((char *) mh + base_size);
 934   if (ntohs (nested_msg->size) != nested_size)
 935   {
 936     GNUNET_break_op (0);
 937     return NULL;
 938   }
 939   return nested_msg;
 940 }
 941
 942
 943 /**
 944  * Cancel sending the message. Message must have been sent with
 945  * #GNUNET_MQ_send before.  May not be called after the notify sent
 946  * callback has been called
 947  *
 948  * @param ev queued envelope to cancel
 949  */
 950 void
 951 GNUNET_MQ_send_cancel (struct GNUNET_MQ_Envelope *ev)
 952 {
 953   struct GNUNET_MQ_Handle *mq = ev->parent_queue;
 954
 955   GNUNET_assert (NULL != mq);
 956   GNUNET_assert (NULL != mq->cancel_impl);
 957
 958   mq->evacuate_called = GNUNET_NO;
 959
 960   if (mq->current_envelope == ev)
 961   {
 962     // complex case, we already started with transmitting
 963     // the message
 964     GNUNET_assert (0 < mq->queue_length);
 965     mq->queue_length--;
 966     mq->cancel_impl (mq,
 967                      mq->impl_state);
 968     // continue sending the next message, if any
 969     if (NULL == mq->envelope_head)
 970     {
 971       mq->current_envelope = NULL;
 972     }
 973     else
 974     {
 975       mq->current_envelope = mq->envelope_head;
 976       GNUNET_CONTAINER_DLL_remove (mq->envelope_head,
 977                                    mq->envelope_tail,
 978                                    mq->current_envelope);
 979       mq->send_impl (mq,
 980                      mq->current_envelope->mh,
 981                      mq->impl_state);
 982     }
 983   }
 984   else
 985   {
 986     // simple case, message is still waiting in the queue
 987     GNUNET_CONTAINER_DLL_remove (mq->envelope_head,
 988                                  mq->envelope_tail,
 989                                  ev);
 990     GNUNET_assert (0 < mq->queue_length);
 991     mq->queue_length--;
 992   }
 993
 994   if (GNUNET_YES != mq->evacuate_called)
 995   {
 996     ev->parent_queue = NULL;
 997     ev->mh = NULL;
 998     /* also frees ev */
 999     GNUNET_free (ev);
1000   }
1001 }
1002
1003
1004 /**
1005  * Function to obtain the current envelope
1006  * from within #GNUNET_MQ_SendImpl implementations.
1007  *
1008  * @param mq message queue to interrogate
1009  * @return the current envelope
1010  */
1011 struct GNUNET_MQ_Envelope *
1012 GNUNET_MQ_get_current_envelope (struct GNUNET_MQ_Handle *mq)
1013 {
1014   return mq->current_envelope;
1015 }
1016
1017
1018 /**
1019  * Function to obtain the last envelope in the queue.
1020  *
1021  * @param mq message queue to interrogate
1022  * @return the last envelope in the queue
1023  */
1024 struct GNUNET_MQ_Envelope *
1025 GNUNET_MQ_get_last_envelope (struct GNUNET_MQ_Handle *mq)
1026 {
1027   if (NULL != mq->envelope_tail)
1028     return mq->envelope_tail;
1029
1030   return mq->current_envelope;
1031 }
1032
1033
1034 /**
1035  * Set application-specific options for this envelope.
1036  * Overrides the options set for the queue with
1037  * #GNUNET_MQ_set_options() for this message only.
1038  *
1039  * @param env message to set options for
1040  * @param flags flags to use (meaning is queue-specific)
1041  * @param extra additional buffer for further data (also queue-specific)
1042  */
1043 void
1044 GNUNET_MQ_env_set_options (struct GNUNET_MQ_Envelope *env,
1045                            uint64_t flags,
1046                            const void *extra)
1047 {
1048   env->flags = flags;
1049   env->extra = extra;
1050   env->have_custom_options = GNUNET_YES;
1051 }
1052
1053
1054 /**
1055  * Get application-specific options for this envelope.
1056  *
1057  * @param env message to set options for
1058  * @param[out] flags set to flags to use (meaning is queue-specific)
1059  * @return extra additional buffer for further data (also queue-specific)
1060  */
1061 const void *
1062 GNUNET_MQ_env_get_options (struct GNUNET_MQ_Envelope *env,
1063                            uint64_t *flags)
1064 {
1065   struct GNUNET_MQ_Handle *mq = env->parent_queue;
1066
1067   if (GNUNET_YES == env->have_custom_options)
1068   {
1069     *flags = env->flags;
1070     return env->extra;
1071   }
1072   if (NULL == mq)
1073   {
1074     *flags = 0;
1075     return NULL;
1076   }
1077   *flags = mq->default_flags;
1078   return mq->default_extra;
1079 }
1080
1081
1082 /**
1083  * Set application-specific options for this queue.
1084  *
1085  * @param mq message queue to set options for
1086  * @param flags flags to use (meaning is queue-specific)
1087  * @param extra additional buffer for further data (also queue-specific)
1088  */
1089 void
1090 GNUNET_MQ_set_options (struct GNUNET_MQ_Handle *mq,
1091                        uint64_t flags,
1092                        const void *extra)
1093 {
1094   mq->default_flags = flags;
1095   mq->default_extra = extra;
1096 }
1097
1098
1099 /**
1100  * Register function to be called whenever @a mq is being
1101  * destroyed.
1102  *
1103  * @param mq message queue to watch
1104  * @param cb function to call on @a mq destruction
1105  * @param cb_cls closure for @a cb
1106  * @return handle for #GNUNET_MQ_destroy_notify_cancel().
1107  */
1108 struct GNUNET_MQ_DestroyNotificationHandle *
1109 GNUNET_MQ_destroy_notify (struct GNUNET_MQ_Handle *mq,
1110                           GNUNET_SCHEDULER_TaskCallback cb,
1111                           void *cb_cls)
1112 {
1113   struct GNUNET_MQ_DestroyNotificationHandle *dnh;
1114
1115   dnh = GNUNET_new (struct GNUNET_MQ_DestroyNotificationHandle);
1116   dnh->mq = mq;
1117   dnh->cb = cb;
1118   dnh->cb_cls = cb_cls;
1119   GNUNET_CONTAINER_DLL_insert (mq->dnh_head,
1120                                mq->dnh_tail,
1121                                dnh);
1122   return dnh;
1123 }
1124
1125
1126 /**
1127  * Cancel registration from #GNUNET_MQ_destroy_notify().
1128  *
1129  * @param dnh handle for registration to cancel
1130  */
1131 void
1132 GNUNET_MQ_destroy_notify_cancel (struct GNUNET_MQ_DestroyNotificationHandle *dnh)
1133 {
1134   struct GNUNET_MQ_Handle *mq = dnh->mq;
1135
1136   GNUNET_CONTAINER_DLL_remove (mq->dnh_head,
1137                                mq->dnh_tail,
1138                                dnh);
1139   GNUNET_free (dnh);
1140 }
1141
1142
1143 /**
1144  * Insert @a env into the envelope DLL starting at @a env_head
1145  * Note that @a env must not be in any MQ while this function
1146  * is used with DLLs defined outside of the MQ module.  This
1147  * is just in case some application needs to also manage a
1148  * FIFO of envelopes independent of MQ itself and wants to
1149  * re-use the pointers internal to @a env.  Use with caution.
1150  *
1151  * @param[in|out] env_head of envelope DLL
1152  * @param[in|out] env_tail tail of envelope DLL
1153  * @param[in|out] env element to insert at the tail
1154  */
1155 void
1156 GNUNET_MQ_dll_insert_tail (struct GNUNET_MQ_Envelope **env_head,
1157                            struct GNUNET_MQ_Envelope **env_tail,
1158                            struct GNUNET_MQ_Envelope *env)
1159 {
1160   GNUNET_CONTAINER_DLL_insert_tail (*env_head,
1161                                     *env_tail,
1162                                     env);
1163 }
1164
1165
1166 /**
1167  * Remove @a env from the envelope DLL starting at @a env_head.
1168  * Note that @a env must not be in any MQ while this function
1169  * is used with DLLs defined outside of the MQ module. This
1170  * is just in case some application needs to also manage a
1171  * FIFO of envelopes independent of MQ itself and wants to
1172  * re-use the pointers internal to @a env.  Use with caution.
1173  *
1174  * @param[in|out] env_head of envelope DLL
1175  * @param[in|out] env_tail tail of envelope DLL
1176  * @param[in|out] env element to remove from the DLL
1177  */
1178 void
1179 GNUNET_MQ_dll_remove (struct GNUNET_MQ_Envelope **env_head,
1180                       struct GNUNET_MQ_Envelope **env_tail,
1181                       struct GNUNET_MQ_Envelope *env)
1182 {
1183   GNUNET_CONTAINER_DLL_remove (*env_head,
1184                                *env_tail,
1185                                env);
1186 }
1187
1188
1189 /* end of mq.c */