src/util/server_nc.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010 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 2, 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  * @file util/server_nc.c
  23  * @brief convenience functions for transmission of
  24  *        a notification stream
  25  * @author Christian Grothoff
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_common.h"
  30 #include "gnunet_connection_lib.h"
  31 #include "gnunet_container_lib.h"
  32 #include "gnunet_scheduler_lib.h"
  33 #include "gnunet_server_lib.h"
  34 #include "gnunet_time_lib.h"
  35
  36
  37 #define DEBUG_SERVER_NC GNUNET_NO
  38
  39 /**
  40  * Entry in list of messages pending to be transmitted.
  41  */
  42 struct PendingMessageList
  43 {
  44
  45   /**
  46    * This is a doubly-linked list.
  47    */
  48   struct PendingMessageList *next;
  49
  50   /**
  51    * This is a doubly-linked list.
  52    */
  53   struct PendingMessageList *prev;
  54
  55   /**
  56    * Message to transmit (allocated at the end of this
  57    * struct, do not free)
  58    */
  59   const struct GNUNET_MessageHeader *msg;
  60
  61   /**
  62    * Can this message be dropped?
  63    */
  64   int can_drop;
  65
  66 };
  67
  68
  69 /**
  70  * Lists of clients we manage for notifications.
  71  */
  72 struct ClientList
  73 {
  74
  75   /**
  76    * This is a linked list.
  77    */
  78   struct ClientList *next;
  79
  80   /**
  81    * Overall context this client belongs to.
  82    */
  83   struct GNUNET_SERVER_NotificationContext *nc;
  84
  85   /**
  86    * Handle to the client.
  87    */
  88   struct GNUNET_SERVER_Client *client;
  89
  90   /**
  91    * Handle for pending transmission request to the client (or NULL).
  92    */
  93   struct GNUNET_CONNECTION_TransmitHandle *th;
  94
  95   /**
  96    * Head of linked list of requests queued for transmission.
  97    */
  98   struct PendingMessageList *pending_head;
  99
 100   /**
 101    * Tail of linked list of requests queued for transmission.
 102    */
 103   struct PendingMessageList *pending_tail;
 104
 105   /**
 106    * Number of messages currently in the list.
 107    */
 108   unsigned int num_pending;
 109
 110 };
 111
 112
 113 /**
 114  * The notification context is the key datastructure for a convenience
 115  * API used for transmission of notifications to the client until the
 116  * client disconnects (or the notification context is destroyed, in
 117  * which case we disconnect these clients).  Essentially, all
 118  * (notification) messages are queued up until the client is able to
 119  * read them.
 120  */
 121 struct GNUNET_SERVER_NotificationContext
 122 {
 123
 124   /**
 125    * Server we do notifications for.
 126    */
 127   struct GNUNET_SERVER_Handle *server;
 128
 129   /**
 130    * List of clients receiving notifications.
 131    */
 132   struct ClientList *clients;
 133
 134   /**
 135    * Maximum number of optional messages to queue per client.
 136    */
 137   unsigned int queue_length;
 138
 139 };
 140
 141
 142 /**
 143  * Client has disconnected, clean up.
 144  *
 145  * @param cls our 'struct GNUNET_SERVER_NotificationContext *'
 146  * @param client handle of client that disconnected
 147  */
 148 static void
 149 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
 150 {
 151   struct GNUNET_SERVER_NotificationContext *nc = cls;
 152   struct ClientList *pos;
 153   struct ClientList *prev;
 154   struct PendingMessageList *pml;
 155
 156   if (client == NULL)
 157   {
 158     nc->server = NULL;
 159     return;
 160   }
 161   prev = NULL;
 162   pos = nc->clients;
 163   while (NULL != pos)
 164   {
 165     if (pos->client == client)
 166       break;
 167     prev = pos;
 168     pos = pos->next;
 169   }
 170   if (pos == NULL)
 171     return;
 172 #if DEBUG_SERVER_NC
 173   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 174               "Client disconnected, cleaning up %u messages in NC queue\n",
 175               pos->num_pending);
 176 #endif
 177   if (prev == NULL)
 178     nc->clients = pos->next;
 179   else
 180     prev->next = pos->next;
 181   while (NULL != (pml = pos->pending_head))
 182   {
 183     GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, pml);
 184     GNUNET_free (pml);
 185   }
 186   if (pos->th != NULL)
 187   {
 188     GNUNET_CONNECTION_notify_transmit_ready_cancel (pos->th);
 189     pos->th = NULL;
 190   }
 191   GNUNET_SERVER_client_drop (client);
 192   GNUNET_free (pos);
 193 }
 194
 195
 196 /**
 197  * Create a new notification context.
 198  *
 199  * @param server server for which this function creates the context
 200  * @param queue_length maximum number of messages to keep in
 201  *        the notification queue; optional messages are dropped
 202  *        it the queue gets longer than this number of messages
 203  * @return handle to the notification context
 204  */
 205 struct GNUNET_SERVER_NotificationContext *
 206 GNUNET_SERVER_notification_context_create (struct GNUNET_SERVER_Handle *server,
 207                                            unsigned int queue_length)
 208 {
 209   struct GNUNET_SERVER_NotificationContext *ret;
 210
 211   ret = GNUNET_malloc (sizeof (struct GNUNET_SERVER_NotificationContext));
 212   ret->server = server;
 213   ret->queue_length = queue_length;
 214   GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, ret);
 215   return ret;
 216 }
 217
 218
 219 /**
 220  * Destroy the context, force disconnect for all clients.
 221  *
 222  * @param nc context to destroy.
 223  */
 224 void
 225 GNUNET_SERVER_notification_context_destroy (struct
 226                                             GNUNET_SERVER_NotificationContext
 227                                             *nc)
 228 {
 229   struct ClientList *pos;
 230   struct PendingMessageList *pml;
 231
 232   while (NULL != (pos = nc->clients))
 233   {
 234     nc->clients = pos->next;
 235     GNUNET_SERVER_client_drop (pos->client);
 236     while (NULL != (pml = pos->pending_head))
 237     {
 238       GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, pml);
 239       GNUNET_free (pml);
 240     }
 241     GNUNET_free (pos);
 242   }
 243   if (nc->server != NULL)
 244     GNUNET_SERVER_disconnect_notify_cancel (nc->server,
 245                                             &handle_client_disconnect, nc);
 246   GNUNET_free (nc);
 247 }
 248
 249
 250 /**
 251  * Add a client to the notification context.
 252  *
 253  * @param nc context to modify
 254  * @param client client to add
 255  */
 256 void
 257 GNUNET_SERVER_notification_context_add (struct GNUNET_SERVER_NotificationContext
 258                                         *nc,
 259                                         struct GNUNET_SERVER_Client *client)
 260 {
 261   struct ClientList *cl;
 262
 263   cl = GNUNET_malloc (sizeof (struct ClientList));
 264   cl->next = nc->clients;
 265   cl->nc = nc;
 266   cl->client = client;
 267   GNUNET_SERVER_client_keep (client);
 268   nc->clients = cl;
 269 }
 270
 271
 272 /**
 273  * Function called to notify a client about the socket begin ready to
 274  * queue more data.  "buf" will be NULL and "size" zero if the socket
 275  * was closed for writing in the meantime.
 276  *
 277  * @param cls the 'struct ClientList *'
 278  * @param size number of bytes available in buf
 279  * @param buf where the callee should write the message
 280  * @return number of bytes written to buf
 281  */
 282 static size_t
 283 transmit_message (void *cls, size_t size, void *buf)
 284 {
 285   struct ClientList *cl = cls;
 286   char *cbuf = buf;
 287   struct PendingMessageList *pml;
 288   uint16_t msize;
 289   size_t ret;
 290
 291   cl->th = NULL;
 292   if (buf == NULL)
 293   {
 294     /* 'cl' should be freed via disconnect notification shortly */
 295 #if DEBUG_SERVER_NC
 296     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 297                 "Failed to transmit message from NC queue to client\n");
 298 #endif
 299     return 0;
 300   }
 301   ret = 0;
 302   while (NULL != (pml = cl->pending_head))
 303   {
 304     msize = ntohs (pml->msg->size);
 305     if (size < msize)
 306       break;
 307     GNUNET_CONTAINER_DLL_remove (cl->pending_head, cl->pending_tail, pml);
 308 #if DEBUG_SERVER_NC
 309     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 310                 "Copying message of type %u and size %u from pending queue to transmission buffer\n",
 311                 ntohs (pml->msg->type), msize);
 312 #endif
 313     memcpy (&cbuf[ret], pml->msg, msize);
 314     ret += msize;
 315     size -= msize;
 316     GNUNET_free (pml);
 317     cl->num_pending--;
 318   }
 319   if (pml != NULL)
 320   {
 321 #if DEBUG_SERVER_NC
 322     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 323                 "Have %u messages left in NC queue, will try transmission again\n",
 324                 cl->num_pending);
 325 #endif
 326     cl->th =
 327         GNUNET_SERVER_notify_transmit_ready (cl->client, ntohs (pml->msg->size),
 328                                              GNUNET_TIME_UNIT_FOREVER_REL,
 329                                              &transmit_message, cl);
 330   }
 331   else
 332     GNUNET_assert (cl->num_pending == 0);
 333   return ret;
 334 }
 335
 336
 337 /**
 338  * Send a message to a particular client.
 339  *
 340  * @param nc context to modify
 341  * @param client client to transmit to
 342  * @param msg message to send
 343  * @param can_drop can this message be dropped due to queue length limitations
 344  */
 345 static void
 346 do_unicast (struct GNUNET_SERVER_NotificationContext *nc,
 347             struct ClientList *client, const struct GNUNET_MessageHeader *msg,
 348             int can_drop)
 349 {
 350   struct PendingMessageList *pml;
 351   uint16_t size;
 352
 353   if ((client->num_pending > nc->queue_length) && (GNUNET_YES == can_drop))
 354   {
 355     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 356                 "Dropping message of type %u and size %u due to full queue (%u entries)\n",
 357                 ntohs (msg->type), ntohs (msg->size),
 358                 (unsigned int) nc->queue_length);
 359     return;                     /* drop! */
 360   }
 361   if (client->num_pending > nc->queue_length)
 362   {
 363     /* FIXME: consider checking for other messages in the
 364      * queue that are 'droppable' */
 365   }
 366   client->num_pending++;
 367   size = ntohs (msg->size);
 368   pml = GNUNET_malloc (sizeof (struct PendingMessageList) + size);
 369   pml->msg = (const struct GNUNET_MessageHeader *) &pml[1];
 370   pml->can_drop = can_drop;
 371 #if DEBUG_SERVER_NC
 372   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 373               "Adding message of type %u and size %u to pending queue (which has %u entries)\n",
 374               ntohs (msg->type), ntohs (msg->size),
 375               (unsigned int) nc->queue_length);
 376 #endif
 377   memcpy (&pml[1], msg, size);
 378   /* append */
 379   GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
 380                                     pml);
 381   if (client->th == NULL)
 382     client->th =
 383         GNUNET_SERVER_notify_transmit_ready (client->client,
 384                                              ntohs (client->pending_head->
 385                                                     msg->size),
 386                                              GNUNET_TIME_UNIT_FOREVER_REL,
 387                                              &transmit_message, client);
 388 }
 389
 390
 391 /**
 392  * Send a message to a particular client; must have
 393  * already been added to the notification context.
 394  *
 395  * @param nc context to modify
 396  * @param client client to transmit to
 397  * @param msg message to send
 398  * @param can_drop can this message be dropped due to queue length limitations
 399  */
 400 void
 401 GNUNET_SERVER_notification_context_unicast (struct
 402                                             GNUNET_SERVER_NotificationContext
 403                                             *nc,
 404                                             struct GNUNET_SERVER_Client *client,
 405                                             const struct GNUNET_MessageHeader
 406                                             *msg, int can_drop)
 407 {
 408   struct ClientList *pos;
 409
 410   pos = nc->clients;
 411   while (NULL != pos)
 412   {
 413     if (pos->client == client)
 414       break;
 415     pos = pos->next;
 416   }
 417   GNUNET_assert (pos != NULL);
 418   do_unicast (nc, pos, msg, can_drop);
 419 }
 420
 421
 422 /**
 423  * Send a message to all clients of this context.
 424  *
 425  * @param nc context to modify
 426  * @param msg message to send
 427  * @param can_drop can this message be dropped due to queue length limitations
 428  */
 429 void
 430 GNUNET_SERVER_notification_context_broadcast (struct
 431                                               GNUNET_SERVER_NotificationContext
 432                                               *nc,
 433                                               const struct GNUNET_MessageHeader
 434                                               *msg, int can_drop)
 435 {
 436   struct ClientList *pos;
 437
 438   pos = nc->clients;
 439   while (NULL != pos)
 440   {
 441     do_unicast (nc, pos, msg, can_drop);
 442     pos = pos->next;
 443   }
 444 }
 445
 446
 447 /* end of server_nc.c */