src/util/mq.c

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