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