src/util/mq.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2012 Christian Grothoff (and other contributing authors)
   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  * @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    * usually points to the end of the containing GNUNET_MQ_Envelope
  49    */
  50   struct GNUNET_MessageHeader *mh;
  51
  52   /**
  53    * Queue the message is queued in, NULL if message is not queued.
  54    */
  55   struct GNUNET_MQ_Handle *parent_queue;
  56
  57   /**
  58    * Called after the message was sent irrevocably.
  59    */
  60   GNUNET_MQ_NotifyCallback sent_cb;
  61
  62   /**
  63    * Closure for send_cb
  64    */
  65   void *sent_cls;
  66 };
  67
  68
  69 /**
  70  * Handle to a message queue.
  71  */
  72 struct GNUNET_MQ_Handle
  73 {
  74   /**
  75    * Handlers array, or NULL if the queue should not receive messages
  76    */
  77   const struct GNUNET_MQ_MessageHandler *handlers;
  78
  79   /**
  80    * Closure for the handler callbacks,
  81    * as well as for the error handler.
  82    */
  83   void *handlers_cls;
  84
  85   /**
  86    * Actual implementation of message sending,
  87    * called when a message is added
  88    */
  89   GNUNET_MQ_SendImpl send_impl;
  90
  91   /**
  92    * Implementation-dependent queue destruction function
  93    */
  94   GNUNET_MQ_DestroyImpl destroy_impl;
  95
  96   /**
  97    * Implementation-specific state
  98    */
  99   void *impl_state;
 100
 101   /**
 102    * Callback will be called when an error occurs.
 103    */
 104   GNUNET_MQ_ErrorHandler error_handler;
 105
 106   /**
 107    * Linked list of messages pending to be sent
 108    */
 109   struct GNUNET_MQ_Envelope *envelope_head;
 110
 111   /**
 112    * Linked list of messages pending to be sent
 113    */
 114   struct GNUNET_MQ_Envelope *envelope_tail;
 115
 116   /**
 117    * Message that is currently scheduled to be
 118    * sent. Not the head of the message queue, as the implementation
 119    * needs to know if sending has been already scheduled or not.
 120    */
 121   struct GNUNET_MQ_Envelope *current_envelope;
 122
 123   /**
 124    * Map of associations, lazily allocated
 125    */
 126   struct GNUNET_CONTAINER_MultiHashMap32 *assoc_map;
 127
 128   /**
 129    * Task scheduled during #GNUNET_MQ_impl_send_continue.
 130    */
 131   GNUNET_SCHEDULER_TaskIdentifier continue_task;
 132
 133   /**
 134    * Next id that should be used for the assoc_map,
 135    * initialized lazily to a random value together with
 136    * assoc_map
 137    */
 138   uint32_t assoc_id;
 139 };
 140
 141
 142
 143
 144 struct ServerClientSocketState
 145 {
 146   struct GNUNET_SERVER_Client *client;
 147   struct GNUNET_SERVER_TransmitHandle* th;
 148 };
 149
 150
 151 struct ClientConnectionState
 152 {
 153   /**
 154    * Did we call receive alread alreadyy?
 155    */
 156   int receive_active;
 157
 158   /**
 159    * Do we also want to receive?
 160    */
 161   int receive_requested;
 162   struct GNUNET_CLIENT_Connection *connection;
 163   struct GNUNET_CLIENT_TransmitHandle *th;
 164 };
 165
 166
 167 /**
 168  * Call the message message handler that was registered
 169  * for the type of the given message in the given message queue.
 170  *
 171  * This function is indended to be used for the implementation
 172  * of message queues.
 173  *
 174  * @param mq message queue with the handlers
 175  * @param mh message to dispatch
 176  */
 177 void
 178 GNUNET_MQ_inject_message (struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *mh)
 179 {
 180   const struct GNUNET_MQ_MessageHandler *handler;
 181   int handled = GNUNET_NO;
 182
 183   handler = mq->handlers;
 184   if (NULL == handler)
 185     return;
 186   for (; NULL != handler->cb; handler++)
 187   {
 188     if (handler->type == ntohs (mh->type))
 189     {
 190       handler->cb (mq->handlers_cls, mh);
 191       handled = GNUNET_YES;
 192     }
 193   }
 194
 195   if (GNUNET_NO == handled)
 196     LOG (GNUNET_ERROR_TYPE_WARNING, "no handler for message of type %d\n", ntohs (mh->type));
 197 }
 198
 199
 200 /**
 201  * Call the error handler of a message queue with the given
 202  * error code.  If there is no error handler, log a warning.
 203  *
 204  * This function is intended to be used by the implementation
 205  * of message queues.
 206  *
 207  * @param mq message queue
 208  * @param error the error type
 209  */
 210 void
 211 GNUNET_MQ_inject_error (struct GNUNET_MQ_Handle *mq,
 212                         enum GNUNET_MQ_Error error)
 213 {
 214   if (NULL == mq->error_handler)
 215   {
 216     /* FIXME: log what kind of error occured */
 217     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "mq: got error, but no handler installed\n");
 218     return;
 219   }
 220   mq->error_handler (mq->handlers_cls, error);
 221 }
 222
 223
 224 void
 225 GNUNET_MQ_discard (struct GNUNET_MQ_Envelope *mqm)
 226 {
 227   GNUNET_assert (NULL == mqm->parent_queue);
 228   GNUNET_free (mqm);
 229 }
 230
 231
 232 /**
 233  * Send a message with the give message queue.
 234  * May only be called once per message.
 235  *
 236  * @param mq message queue
 237  * @param ev the envelope with the message to send.
 238  */
 239 void
 240 GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
 241 {
 242   GNUNET_assert (NULL != mq);
 243   GNUNET_assert (NULL == ev->parent_queue);
 244
 245   /* is the implementation busy? queue it! */
 246   if (NULL != mq->current_envelope)
 247   {
 248     GNUNET_CONTAINER_DLL_insert_tail (mq->envelope_head, mq->envelope_tail, ev);
 249     return;
 250   }
 251   mq->current_envelope = ev;
 252   mq->send_impl (mq, ev->mh, mq->impl_state);
 253 }
 254
 255
 256 /**
 257  * Task run to call the send implementation for the next queued
 258  * message, if any.  Only useful for implementing message queues,
 259  * results in undefined behavior if not used carefully.
 260  *
 261  * @param cls message queue to send the next message with
 262  * @param tc scheduler context
 263  */
 264 static void
 265 impl_send_continue (void *cls,
 266                     const struct GNUNET_SCHEDULER_TaskContext *tc)
 267 {
 268   struct GNUNET_MQ_Handle *mq = cls;
 269   struct GNUNET_MQ_Envelope *current_envelope;
 270
 271   mq->continue_task = GNUNET_SCHEDULER_NO_TASK;
 272   /* call is only valid if we're actually currently sending
 273    * a message */
 274   current_envelope = mq->current_envelope;
 275   GNUNET_assert (NULL != current_envelope);
 276   if (NULL == mq->envelope_head)
 277   {
 278     mq->current_envelope = NULL;
 279   }
 280   else
 281   {
 282     mq->current_envelope = mq->envelope_head;
 283     GNUNET_CONTAINER_DLL_remove (mq->envelope_head,
 284                                  mq->envelope_tail,
 285                                  mq->current_envelope);
 286     mq->send_impl (mq, mq->current_envelope->mh, mq->impl_state);
 287   }
 288   if (NULL != current_envelope->sent_cb)
 289     current_envelope->sent_cb (current_envelope->sent_cls);
 290   GNUNET_free (current_envelope);
 291 }
 292
 293
 294 /**
 295  * Call the send implementation for the next queued message,
 296  * if any.
 297  * Only useful for implementing message queues,
 298  * results in undefined behavior if not used carefully.
 299  *
 300  * @param mq message queue to send the next message with
 301  */
 302 void
 303 GNUNET_MQ_impl_send_continue (struct GNUNET_MQ_Handle *mq)
 304 {
 305   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == mq->continue_task);
 306   mq->continue_task = GNUNET_SCHEDULER_add_now (&impl_send_continue,
 307                                                 mq);
 308 }
 309
 310
 311 /**
 312  * Create a message queue for the specified handlers.
 313  *
 314  * @param send function the implements sending messages
 315  * @param destroy function that implements destroying the queue
 316  * @param cancel function that implements canceling a message
 317  * @param impl_state for the queue, passed to 'send' and 'destroy'
 318  * @param handlers array of message handlers
 319  * @param error_handler handler for read and write errors
 320  * @param cls closure for message handlers and error handler
 321  * @return a new message queue
 322  */
 323 struct GNUNET_MQ_Handle *
 324 GNUNET_MQ_queue_for_callbacks (GNUNET_MQ_SendImpl send,
 325                                GNUNET_MQ_DestroyImpl destroy,
 326                                GNUNET_MQ_CancelImpl cancel,
 327                                void *impl_state,
 328                                const struct GNUNET_MQ_MessageHandler *handlers,
 329                                GNUNET_MQ_ErrorHandler error_handler,
 330                                void *cls)
 331 {
 332   struct GNUNET_MQ_Handle *mq;
 333
 334   mq = GNUNET_new (struct GNUNET_MQ_Handle);
 335   mq->send_impl = send;
 336   mq->destroy_impl = destroy;
 337   mq->handlers = handlers;
 338   mq->handlers_cls = cls;
 339   mq->impl_state = impl_state;
 340
 341   return mq;
 342 }
 343
 344
 345 /**
 346  * Get the message that should currently be sent.
 347  * Fails if there is no current message.
 348  * Only useful for implementing message queues,
 349  * results in undefined behavior if not used carefully.
 350  *
 351  * @param mq message queue with the current message
 352  * @return message to send, never NULL
 353  */
 354 const struct GNUNET_MessageHeader *
 355 GNUNET_MQ_impl_current (struct GNUNET_MQ_Handle *mq)
 356 {
 357   if (NULL == mq->current_envelope)
 358     GNUNET_abort ();
 359   if (NULL == mq->current_envelope->mh)
 360     GNUNET_abort ();
 361   return mq->current_envelope->mh;
 362 }
 363
 364
 365 /**
 366  * Get the implementation state associated with the
 367  * message queue.
 368  *
 369  * While the GNUNET_MQ_Impl* callbacks receive the
 370  * implementation state, continuations that are scheduled
 371  * by the implementation function often only have one closure
 372  * argument, with this function it is possible to get at the
 373  * implementation state when only passing the GNUNET_MQ_Handle
 374  * as closure.
 375  *
 376  * @param mq message queue with the current message
 377  * @return message to send, never NULL
 378  */
 379 void *
 380 GNUNET_MQ_impl_state (struct GNUNET_MQ_Handle *mq)
 381 {
 382   return mq->impl_state;
 383 }
 384
 385
 386 struct GNUNET_MQ_Envelope *
 387 GNUNET_MQ_msg_ (struct GNUNET_MessageHeader **mhp, uint16_t size, uint16_t type)
 388 {
 389   struct GNUNET_MQ_Envelope *mqm;
 390
 391   mqm = GNUNET_malloc (sizeof *mqm + size);
 392   mqm->mh = (struct GNUNET_MessageHeader *) &mqm[1];
 393   mqm->mh->size = htons (size);
 394   mqm->mh->type = htons (type);
 395   if (NULL != mhp)
 396     *mhp = mqm->mh;
 397   return mqm;
 398 }
 399
 400
 401 /**
 402  * Implementation of the GNUNET_MQ_msg_nested_mh macro.
 403  *
 404  * @param mhp pointer to the message header pointer that will be changed to allocate at
 405  *        the newly allocated space for the message.
 406  * @param base_size size of the data before the nested message
 407  * @param type type of the message in the envelope
 408  * @param nested_mh the message to append to the message after base_size
 409  */
 410 struct GNUNET_MQ_Envelope *
 411 GNUNET_MQ_msg_nested_mh_ (struct GNUNET_MessageHeader **mhp, uint16_t base_size, uint16_t type,
 412                           const struct GNUNET_MessageHeader *nested_mh)
 413 {
 414   struct GNUNET_MQ_Envelope *mqm;
 415   uint16_t size;
 416
 417   if (NULL == nested_mh)
 418     return GNUNET_MQ_msg_ (mhp, base_size, type);
 419
 420   size = base_size + ntohs (nested_mh->size);
 421
 422   /* check for uint16_t overflow */
 423   if (size < base_size)
 424     return NULL;
 425
 426   mqm = GNUNET_MQ_msg_ (mhp, size, type);
 427   memcpy ((char *) mqm->mh + base_size, nested_mh, ntohs (nested_mh->size));
 428
 429   return mqm;
 430 }
 431
 432
 433 /**
 434  * Transmit a queued message to the session's client.
 435  *
 436  * @param cls consensus session
 437  * @param size number of bytes available in buf
 438  * @param buf where the callee should write the message
 439  * @return number of bytes written to buf
 440  */
 441 static size_t
 442 transmit_queued (void *cls, size_t size,
 443                  void *buf)
 444 {
 445   struct GNUNET_MQ_Handle *mq = cls;
 446   struct ServerClientSocketState *state = GNUNET_MQ_impl_state (mq);
 447   const struct GNUNET_MessageHeader *msg = GNUNET_MQ_impl_current (mq);
 448   size_t msg_size;
 449
 450   GNUNET_assert (NULL != buf);
 451
 452   msg_size = ntohs (msg->size);
 453   GNUNET_assert (size >= msg_size);
 454   memcpy (buf, msg, msg_size);
 455   state->th = NULL;
 456
 457   GNUNET_MQ_impl_send_continue (mq);
 458
 459   return msg_size;
 460 }
 461
 462
 463 static void
 464 server_client_destroy_impl (struct GNUNET_MQ_Handle *mq,
 465                             void *impl_state)
 466 {
 467   struct ServerClientSocketState *state = impl_state;
 468
 469   GNUNET_assert (NULL != mq);
 470   GNUNET_assert (NULL != state);
 471   GNUNET_SERVER_client_drop (state->client);
 472   GNUNET_free (state);
 473 }
 474
 475
 476 static void
 477 server_client_send_impl (struct GNUNET_MQ_Handle *mq,
 478                          const struct GNUNET_MessageHeader *msg, void *impl_state)
 479 {
 480   struct ServerClientSocketState *state = impl_state;
 481
 482   GNUNET_assert (NULL != mq);
 483   GNUNET_assert (NULL != state);
 484   state->th =
 485       GNUNET_SERVER_notify_transmit_ready (state->client, ntohs (msg->size),
 486                                            GNUNET_TIME_UNIT_FOREVER_REL,
 487                                            &transmit_queued, mq);
 488 }
 489
 490
 491 struct GNUNET_MQ_Handle *
 492 GNUNET_MQ_queue_for_server_client (struct GNUNET_SERVER_Client *client)
 493 {
 494   struct GNUNET_MQ_Handle *mq;
 495   struct ServerClientSocketState *scss;
 496
 497   mq = GNUNET_new (struct GNUNET_MQ_Handle);
 498   scss = GNUNET_new (struct ServerClientSocketState);
 499   mq->impl_state = scss;
 500   scss->client = client;
 501   GNUNET_SERVER_client_keep (client);
 502   mq->send_impl = server_client_send_impl;
 503   mq->destroy_impl = server_client_destroy_impl;
 504   return mq;
 505 }
 506
 507
 508 /**
 509  * Type of a function to call when we receive a message
 510  * from the service.
 511  *
 512  * @param cls closure
 513  * @param msg message received, NULL on timeout or fatal error
 514  */
 515 static void
 516 handle_client_message (void *cls,
 517                        const struct GNUNET_MessageHeader *msg)
 518 {
 519   struct GNUNET_MQ_Handle *mq = cls;
 520   struct ClientConnectionState *state;
 521
 522   state = mq->impl_state;
 523
 524   if (NULL == msg)
 525   {
 526     GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_READ);
 527     return;
 528   }
 529
 530   GNUNET_CLIENT_receive (state->connection, handle_client_message, mq,
 531                          GNUNET_TIME_UNIT_FOREVER_REL);
 532
 533   GNUNET_MQ_inject_message (mq, msg);
 534 }
 535
 536
 537 /**
 538  * Transmit a queued message to the session's client.
 539  *
 540  * @param cls consensus session
 541  * @param size number of bytes available in @a buf
 542  * @param buf where the callee should write the message
 543  * @return number of bytes written to buf
 544  */
 545 static size_t
 546 connection_client_transmit_queued (void *cls,
 547                                    size_t size,
 548                                    void *buf)
 549 {
 550   struct GNUNET_MQ_Handle *mq = cls;
 551   const struct GNUNET_MessageHeader *msg;
 552   struct ClientConnectionState *state = mq->impl_state;
 553   size_t msg_size;
 554
 555   GNUNET_assert (NULL != mq);
 556   msg = GNUNET_MQ_impl_current (mq);
 557
 558   if (NULL == buf)
 559   {
 560     GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_READ);
 561     return 0;
 562   }
 563
 564   if ( (GNUNET_YES == state->receive_requested) &&
 565        (GNUNET_NO == state->receive_active) )
 566   {
 567     state->receive_active = GNUNET_YES;
 568     GNUNET_CLIENT_receive (state->connection, handle_client_message, mq,
 569                            GNUNET_TIME_UNIT_FOREVER_REL);
 570   }
 571
 572
 573   msg_size = ntohs (msg->size);
 574   GNUNET_assert (size >= msg_size);
 575   memcpy (buf, msg, msg_size);
 576   state->th = NULL;
 577
 578   GNUNET_MQ_impl_send_continue (mq);
 579
 580   return msg_size;
 581 }
 582
 583
 584 static void
 585 connection_client_destroy_impl (struct GNUNET_MQ_Handle *mq, void *impl_state)
 586 {
 587   GNUNET_free (impl_state);
 588 }
 589
 590
 591 static void
 592 connection_client_send_impl (struct GNUNET_MQ_Handle *mq,
 593                              const struct GNUNET_MessageHeader *msg, void *impl_state)
 594 {
 595   struct ClientConnectionState *state = impl_state;
 596
 597   GNUNET_assert (NULL != state);
 598   GNUNET_assert (NULL == state->th);
 599   state->th =
 600       GNUNET_CLIENT_notify_transmit_ready (state->connection, ntohs (msg->size),
 601                                            GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_NO,
 602                                            &connection_client_transmit_queued, mq);
 603   GNUNET_assert (NULL != state->th);
 604 }
 605
 606
 607 struct GNUNET_MQ_Handle *
 608 GNUNET_MQ_queue_for_connection_client (struct GNUNET_CLIENT_Connection *connection,
 609                                        const struct GNUNET_MQ_MessageHandler *handlers,
 610                                        GNUNET_MQ_ErrorHandler error_handler,
 611                                        void *cls)
 612 {
 613   struct GNUNET_MQ_Handle *mq;
 614   struct ClientConnectionState *state;
 615
 616   GNUNET_assert (NULL != connection);
 617
 618   mq = GNUNET_new (struct GNUNET_MQ_Handle);
 619   mq->handlers = handlers;
 620   mq->error_handler = error_handler;
 621   mq->handlers_cls = cls;
 622   state = GNUNET_new (struct ClientConnectionState);
 623   state->connection = connection;
 624   mq->impl_state = state;
 625   mq->send_impl = connection_client_send_impl;
 626   mq->destroy_impl = connection_client_destroy_impl;
 627   if (NULL != handlers)
 628     state->receive_requested = GNUNET_YES;
 629
 630   return mq;
 631 }
 632
 633
 634 void
 635 GNUNET_MQ_replace_handlers (struct GNUNET_MQ_Handle *mq,
 636                             const struct GNUNET_MQ_MessageHandler *new_handlers,
 637                             void *cls)
 638 {
 639   /* FIXME: notify implementation? */
 640   /* FIXME: what about NULL handlers? abort receive? */
 641   mq->handlers = new_handlers;
 642   mq->handlers_cls = cls;
 643 }
 644
 645
 646 /**
 647  * Associate the assoc_data in mq with a unique request id.
 648  *
 649  * @param mq message queue, id will be unique for the queue
 650  * @param assoc_data to associate
 651  */
 652 uint32_t
 653 GNUNET_MQ_assoc_add (struct GNUNET_MQ_Handle *mq,
 654                      void *assoc_data)
 655 {
 656   uint32_t id;
 657
 658   if (NULL == mq->assoc_map)
 659   {
 660     mq->assoc_map = GNUNET_CONTAINER_multihashmap32_create (8);
 661     mq->assoc_id = 1;
 662   }
 663   id = mq->assoc_id++;
 664   GNUNET_CONTAINER_multihashmap32_put (mq->assoc_map, id, assoc_data,
 665                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
 666   return id;
 667 }
 668
 669
 670 void *
 671 GNUNET_MQ_assoc_get (struct GNUNET_MQ_Handle *mq, uint32_t request_id)
 672 {
 673   if (NULL == mq->assoc_map)
 674     return NULL;
 675   return GNUNET_CONTAINER_multihashmap32_get (mq->assoc_map, request_id);
 676 }
 677
 678
 679 void *
 680 GNUNET_MQ_assoc_remove (struct GNUNET_MQ_Handle *mq, uint32_t request_id)
 681 {
 682   void *val;
 683
 684   if (NULL == mq->assoc_map)
 685     return NULL;
 686   val = GNUNET_CONTAINER_multihashmap32_get (mq->assoc_map, request_id);
 687   GNUNET_CONTAINER_multihashmap32_remove_all (mq->assoc_map, request_id);
 688   return val;
 689 }
 690
 691
 692 void
 693 GNUNET_MQ_notify_sent (struct GNUNET_MQ_Envelope *mqm,
 694                        GNUNET_MQ_NotifyCallback cb,
 695                        void *cls)
 696 {
 697   mqm->sent_cb = cb;
 698   mqm->sent_cls = cls;
 699 }
 700
 701
 702 void
 703 GNUNET_MQ_destroy (struct GNUNET_MQ_Handle *mq)
 704 {
 705   if (NULL != mq->destroy_impl)
 706   {
 707     mq->destroy_impl (mq, mq->impl_state);
 708   }
 709   if (GNUNET_SCHEDULER_NO_TASK != mq->continue_task)
 710   {
 711     GNUNET_SCHEDULER_cancel (mq->continue_task);
 712     mq->continue_task = GNUNET_SCHEDULER_NO_TASK;
 713   }
 714   while (NULL != mq->envelope_head)
 715   {
 716     struct GNUNET_MQ_Envelope *ev;
 717     ev = mq->envelope_head;
 718     GNUNET_CONTAINER_DLL_remove (mq->envelope_head, mq->envelope_tail, ev);
 719     GNUNET_MQ_discard (ev);
 720   }
 721
 722   if (NULL != mq->current_envelope)
 723   {
 724     GNUNET_MQ_discard (mq->current_envelope);
 725     mq->current_envelope = NULL;
 726   }
 727
 728   if (NULL != mq->assoc_map)
 729   {
 730     GNUNET_CONTAINER_multihashmap32_destroy (mq->assoc_map);
 731     mq->assoc_map = NULL;
 732   }
 733
 734   GNUNET_free (mq);
 735 }
 736
 737
 738 struct GNUNET_MessageHeader *
 739 GNUNET_MQ_extract_nested_mh_ (const struct GNUNET_MessageHeader *mh, uint16_t base_size)
 740 {
 741   uint16_t whole_size;
 742   uint16_t nested_size;
 743   struct GNUNET_MessageHeader *nested_msg;
 744
 745   whole_size = ntohs (mh->size);
 746   GNUNET_assert (whole_size >= base_size);
 747
 748   nested_size = whole_size - base_size;
 749
 750   if (0 == nested_size)
 751     return NULL;
 752
 753   if (nested_size < sizeof (struct GNUNET_MessageHeader))
 754   {
 755     GNUNET_break_op (0);
 756     return NULL;
 757   }
 758
 759   nested_msg = (struct GNUNET_MessageHeader *) ((char *) mh + base_size);
 760
 761   if (ntohs (nested_msg->size) != nested_size)
 762   {
 763     GNUNET_break_op (0);
 764     nested_msg->size = htons (nested_size);
 765   }
 766
 767   return nested_msg;
 768 }
 769
 770