src/util/server.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 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.c
  23  * @brief library for building GNUnet network servers
  24  * @author Christian Grothoff
  25  *
  26  * TODO:
  27  * - fix inefficient memmove in message processing
  28  */
  29
  30 #include "platform.h"
  31 #include "gnunet_common.h"
  32 #include "gnunet_connection_lib.h"
  33 #include "gnunet_scheduler_lib.h"
  34 #include "gnunet_server_lib.h"
  35 #include "gnunet_time_lib.h"
  36 #include "gnunet_disk_lib.h"
  37
  38 #define DEBUG_SERVER GNUNET_NO
  39
  40 /**
  41  * List of arrays of message handlers.
  42  */
  43 struct HandlerList
  44 {
  45   /**
  46    * This is a linked list.
  47    */
  48   struct HandlerList *next;
  49
  50   /**
  51    * NULL-terminated array of handlers.
  52    */
  53   const struct GNUNET_SERVER_MessageHandler *handlers;
  54 };
  55
  56
  57 /**
  58  * List of arrays of message handlers.
  59  */
  60 struct NotifyList
  61 {
  62   /**
  63    * This is a linked list.
  64    */
  65   struct NotifyList *next;
  66
  67   /**
  68    * Function to call.
  69    */
  70   GNUNET_SERVER_DisconnectCallback callback;
  71
  72   /**
  73    * Closure for callback.
  74    */
  75   void *callback_cls;
  76 };
  77
  78
  79 /**
  80  * @brief handle for a server
  81  */
  82 struct GNUNET_SERVER_Handle
  83 {
  84   /**
  85    * My scheduler.
  86    */
  87   struct GNUNET_SCHEDULER_Handle *sched;
  88
  89   /**
  90    * List of handlers for incoming messages.
  91    */
  92   struct HandlerList *handlers;
  93
  94   /**
  95    * List of our current clients.
  96    */
  97   struct GNUNET_SERVER_Client *clients;
  98
  99   /**
 100    * Linked list of functions to call on disconnects by clients.
 101    */
 102   struct NotifyList *disconnect_notify_list;
 103
 104   /**
 105    * Function to call for access control.
 106    */
 107   GNUNET_CONNECTION_AccessCheck access;
 108
 109   /**
 110    * Closure for access.
 111    */
 112   void *access_cls;
 113
 114   /**
 115    * After how long should an idle connection time
 116    * out (on write).
 117    */
 118   struct GNUNET_TIME_Relative idle_timeout;
 119
 120   /**
 121    * maximum write buffer size for accepted sockets
 122    */
 123   size_t maxbuf;
 124
 125   /**
 126    * Pipe used to signal shutdown of the server.
 127    */
 128   struct GNUNET_DISK_PipeHandle *shutpipe;
 129
 130   /**
 131    * Socket used to listen for new connections.  Set to
 132    * "-1" by GNUNET_SERVER_destroy to initiate shutdown.
 133    */
 134   struct GNUNET_NETWORK_Handle *listen_socket;
 135
 136   /**
 137    * Set to GNUNET_YES if we are shutting down.
 138    */
 139   int do_shutdown;
 140
 141   /**
 142    * Do we ignore messages of types that we do not
 143    * understand or do we require that a handler
 144    * is found (and if not kill the connection)?
 145    */
 146   int require_found;
 147
 148 };
 149
 150
 151 /**
 152  * @brief handle for a client of the server
 153  */
 154 struct GNUNET_SERVER_Client
 155 {
 156
 157   /**
 158    * Size of the buffer for incoming data.  Should be
 159    * first so we get nice alignment.
 160    */
 161   char incoming_buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE];
 162
 163   /**
 164    * This is a linked list.
 165    */
 166   struct GNUNET_SERVER_Client *next;
 167
 168   /**
 169    * Server that this client belongs to.
 170    */
 171   struct GNUNET_SERVER_Handle *server;
 172
 173   /**
 174    * Client closure for callbacks.
 175    */
 176   void *client_closure;
 177
 178   /**
 179    * Callback to receive from client.
 180    */
 181   GNUNET_SERVER_ReceiveCallback receive;
 182
 183   /**
 184    * Callback to cancel receive from client.
 185    */
 186   GNUNET_SERVER_ReceiveCancelCallback receive_cancel;
 187
 188   /**
 189    * Callback to ask about transmit-ready notification.
 190    */
 191   GNUNET_SERVER_TransmitReadyCallback notify_transmit_ready;
 192
 193    /**
 194    * Callback to ask about transmit-ready notification.
 195    */
 196   GNUNET_SERVER_TransmitReadyCancelCallback notify_transmit_ready_cancel;
 197
 198   /**
 199    * Callback to check if client is still valid.
 200    */
 201   GNUNET_SERVER_CheckCallback check;
 202
 203   /**
 204    * Callback to destroy client.
 205    */
 206   GNUNET_SERVER_DestroyCallback destroy;
 207
 208   /**
 209    * Side-buffer for incoming data used when processing
 210    * is suspended.
 211    */
 212   char *side_buf;
 213
 214   /**
 215    * Number of bytes in the side buffer.
 216    */
 217   size_t side_buf_size;
 218
 219   /**
 220    * Last activity on this socket (used to time it out
 221    * if reference_count == 0).
 222    */
 223   struct GNUNET_TIME_Absolute last_activity;
 224
 225   /**
 226    * How many bytes in the "incoming_buffer" are currently
 227    * valid? (starting at offset 0).
 228    */
 229   size_t receive_pos;
 230
 231   /**
 232    * Number of external entities with a reference to
 233    * this client object.
 234    */
 235   unsigned int reference_count;
 236
 237   /**
 238    * Was processing if incoming messages suspended while
 239    * we were still processing data already received?
 240    * This is a counter saying how often processing was
 241    * suspended (once per handler invoked).
 242    */
 243   unsigned int suspended;
 244
 245   /**
 246    * Are we currently in the "process_client_buffer" function (and
 247    * will hence restart the receive job on exit if suspended == 0 once
 248    * we are done?).  If this is set, then "receive_done" will
 249    * essentially only decrement suspended; if this is not set, then
 250    * "receive_done" may need to restart the receive process (either
 251    * from the side-buffer or via select/recv).
 252    */
 253   int in_process_client_buffer;
 254
 255   /**
 256    * We're about to close down this client due to some serious
 257    * error.
 258    */
 259   int shutdown_now;
 260
 261 };
 262
 263
 264 /**
 265  * Server has been asked to shutdown, free resources.
 266  */
 267 static void
 268 destroy_server (struct GNUNET_SERVER_Handle *server)
 269 {
 270   struct GNUNET_SERVER_Client *pos;
 271   struct HandlerList *hpos;
 272   struct NotifyList *npos;
 273
 274 #if DEBUG_SERVER
 275   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 276               "Server shutting down.\n");
 277 #endif
 278   GNUNET_assert (server->listen_socket == NULL);
 279   if (GNUNET_OK != GNUNET_DISK_pipe_close (server->shutpipe))
 280     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
 281                          "pipe-close");
 282   while (server->clients != NULL)
 283     {
 284       pos = server->clients;
 285       server->clients = pos->next;
 286       pos->server = NULL;
 287     }
 288   while (NULL != (hpos = server->handlers))
 289     {
 290       server->handlers = hpos->next;
 291       GNUNET_free (hpos);
 292     }
 293   while (NULL != (npos = server->disconnect_notify_list))
 294     {
 295       server->disconnect_notify_list = npos->next;
 296       GNUNET_free (npos);
 297     }
 298   GNUNET_free (server);
 299 }
 300
 301
 302 /**
 303  * Scheduler says our listen socket is ready.
 304  * Process it!
 305  */
 306 static void
 307 process_listen_socket (void *cls,
 308                        const struct GNUNET_SCHEDULER_TaskContext *tc)
 309 {
 310   struct GNUNET_SERVER_Handle *server = cls;
 311   struct GNUNET_CONNECTION_Handle *sock;
 312   struct GNUNET_SERVER_Client *client;
 313   struct GNUNET_NETWORK_FDSet *r;
 314   const struct GNUNET_DISK_FileHandle *shutpipe;
 315
 316   if ((server->do_shutdown) ||
 317       ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0))
 318     {
 319       /* shutdown was initiated */
 320       GNUNET_assert (server->listen_socket != NULL);
 321       GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (server->listen_socket));
 322       server->listen_socket = NULL;
 323       if (server->do_shutdown)
 324         destroy_server (server);
 325       return;
 326     }
 327   shutpipe = GNUNET_DISK_pipe_handle (server->shutpipe, 0);
 328   GNUNET_assert (GNUNET_NETWORK_fdset_isset (tc->read_ready, server->listen_socket));
 329   GNUNET_assert (!GNUNET_NETWORK_fdset_handle_isset (tc->read_ready, shutpipe));
 330   sock = GNUNET_CONNECTION_create_from_accept (tc->sched,
 331                                                    server->access,
 332                                                    server->access_cls,
 333                                                    server->listen_socket,
 334                                                    server->maxbuf);
 335   if (sock != NULL)
 336     {
 337 #if DEBUG_SERVER
 338       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 339                   "Server accepted incoming connection.\n");
 340 #endif
 341       client = GNUNET_SERVER_connect_socket (server, sock);
 342       /* decrement reference count, we don't keep "client" alive */
 343       GNUNET_SERVER_client_drop (client);
 344     }
 345   /* listen for more! */
 346   r = GNUNET_NETWORK_fdset_create ();
 347   GNUNET_NETWORK_fdset_set (r, server->listen_socket);
 348   GNUNET_NETWORK_fdset_handle_set (r, shutpipe);
 349   GNUNET_SCHEDULER_add_select (server->sched,
 350                                GNUNET_YES,
 351                                GNUNET_SCHEDULER_PRIORITY_HIGH,
 352                                GNUNET_SCHEDULER_NO_TASK,
 353                                GNUNET_TIME_UNIT_FOREVER_REL,
 354                                r, NULL,
 355                                &process_listen_socket, server);
 356   GNUNET_NETWORK_fdset_destroy (r);
 357 }
 358
 359
 360 /**
 361  * Create and initialize a listen socket for the server.
 362  *
 363  * @return NULL on error, otherwise the listen socket
 364  */
 365 static struct GNUNET_NETWORK_Handle *
 366 open_listen_socket (const struct sockaddr *serverAddr, socklen_t socklen)
 367 {
 368   const static int on = 1;
 369   struct GNUNET_NETWORK_Handle *sock;
 370   uint16_t port;
 371
 372   switch (serverAddr->sa_family)
 373     {
 374     case AF_INET:
 375       port = ntohs (((const struct sockaddr_in *) serverAddr)->sin_port);
 376       break;
 377     case AF_INET6:
 378       port = ntohs (((const struct sockaddr_in6 *) serverAddr)->sin6_port);
 379       break;
 380     default:
 381       GNUNET_break (0);
 382       return NULL;
 383     }
 384   sock = GNUNET_NETWORK_socket_socket (serverAddr->sa_family, SOCK_STREAM, 0);
 385   if (NULL == sock)
 386     {
 387       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
 388       return NULL;
 389     }
 390 #ifndef MINGW
 391   if (GNUNET_OK != GNUNET_NETWORK_socket_set_inheritable (sock))
 392     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 393                          "fcntl");
 394 #endif
 395   if (GNUNET_NETWORK_socket_setsockopt (sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof (on)) != GNUNET_OK)
 396     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 397                          "setsockopt");
 398   /* bind the socket */
 399   if (GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen) != GNUNET_OK)
 400     {
 401       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
 402       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 403                   _
 404                   ("`%s' failed for port %d. Is the service already running?\n"),
 405                   "bind", port);
 406       GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
 407       return NULL;
 408     }
 409   if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
 410     {
 411       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
 412       GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
 413       return NULL;
 414     }
 415 #if DEBUG_SERVER
 416       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 417                   "Server starts to listen on port %u.\n",
 418                   port);
 419 #endif
 420   return sock;
 421 }
 422
 423
 424 /**
 425  * Create a new server.
 426  *
 427  * @param sched scheduler to use
 428  * @param access function for access control
 429  * @param access_cls closure for access
 430  * @param serverAddr address to listen on (including port), use NULL
 431  *        for internal server (no listening)
 432  * @param socklen length of serverAddr
 433  * @param maxbuf maximum write buffer size for accepted sockets
 434  * @param idle_timeout after how long should we timeout idle connections?
 435  * @param require_found if YES, connections sending messages of unknown type
 436  *        will be closed
 437  * @return handle for the new server, NULL on error
 438  *         (typically, "port" already in use)
 439  */
 440 struct GNUNET_SERVER_Handle *
 441 GNUNET_SERVER_create (struct GNUNET_SCHEDULER_Handle *sched,
 442                       GNUNET_CONNECTION_AccessCheck access,
 443                       void *access_cls,
 444                       const struct sockaddr *serverAddr,
 445                       socklen_t socklen,
 446                       size_t maxbuf,
 447                       struct GNUNET_TIME_Relative
 448                       idle_timeout, int require_found)
 449 {
 450   struct GNUNET_SERVER_Handle *ret;
 451   struct GNUNET_NETWORK_Handle *lsock;
 452   struct GNUNET_NETWORK_FDSet *r;
 453
 454   lsock = NULL;
 455   if (serverAddr != NULL)
 456     {
 457       lsock = open_listen_socket (serverAddr, socklen);
 458       if (lsock == NULL)
 459         return NULL;
 460     }
 461   ret = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
 462   if (NULL == (ret->shutpipe = GNUNET_DISK_pipe (GNUNET_NO)))
 463     {
 464       GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (lsock));
 465       GNUNET_free (ret);
 466       return NULL;
 467     }
 468   ret->sched = sched;
 469   ret->maxbuf = maxbuf;
 470   ret->idle_timeout = idle_timeout;
 471   ret->listen_socket = lsock;
 472   ret->access = access;
 473   ret->access_cls = access_cls;
 474   ret->require_found = require_found;
 475   if (lsock != NULL)
 476     {
 477       r = GNUNET_NETWORK_fdset_create ();
 478       GNUNET_NETWORK_fdset_set (r, ret->listen_socket);
 479       GNUNET_NETWORK_fdset_handle_set (r, GNUNET_DISK_pipe_handle (ret->shutpipe, 0));
 480       GNUNET_SCHEDULER_add_select (sched,
 481                                    GNUNET_YES,
 482                                    GNUNET_SCHEDULER_PRIORITY_HIGH,
 483                                    GNUNET_SCHEDULER_NO_TASK,
 484                                    GNUNET_TIME_UNIT_FOREVER_REL,
 485                                    r,
 486                                    NULL, &process_listen_socket, ret);
 487       GNUNET_NETWORK_fdset_destroy (r);
 488     }
 489   return ret;
 490 }
 491
 492
 493 /**
 494  * Free resources held by this server.
 495  */
 496 void
 497 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *s)
 498 {
 499   static char c;
 500
 501   GNUNET_assert (s->do_shutdown == GNUNET_NO);
 502   s->do_shutdown = GNUNET_YES;
 503   if (s->listen_socket == NULL)
 504     destroy_server (s);
 505   else
 506     GNUNET_break (1 == GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle (s->shutpipe, 1), &c, 1));
 507 }
 508
 509
 510 /**
 511  * Add additional handlers to an existing server.
 512  *
 513  * @param server the server to add handlers to
 514  * @param handlers array of message handlers for
 515  *        incoming messages; the last entry must
 516  *        have "NULL" for the "callback"; multiple
 517  *        entries for the same type are allowed,
 518  *        they will be called in order of occurence.
 519  *        These handlers can be removed later;
 520  *        the handlers array must exist until removed
 521  *        (or server is destroyed).
 522  */
 523 void
 524 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
 525                             const struct GNUNET_SERVER_MessageHandler
 526                             *handlers)
 527 {
 528   struct HandlerList *p;
 529
 530   p = GNUNET_malloc (sizeof (struct HandlerList));
 531   p->handlers = handlers;
 532   p->next = server->handlers;
 533   server->handlers = p;
 534 }
 535
 536
 537 /**
 538  * Inject a message into the server, pretend it came
 539  * from the specified client.  Delivery of the message
 540  * will happen instantly (if a handler is installed;
 541  * otherwise the call does nothing).
 542  *
 543  * @param server the server receiving the message
 544  * @param sender the "pretended" sender of the message
 545  *        can be NULL!
 546  * @param message message to transmit
 547  * @return GNUNET_OK if the message was OK and the
 548  *                   connection can stay open
 549  *         GNUNET_SYSERR if the connection to the
 550  *         client should be shut down
 551  */
 552 int
 553 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
 554                       struct GNUNET_SERVER_Client *sender,
 555                       const struct GNUNET_MessageHeader *message)
 556 {
 557   struct HandlerList *pos;
 558   const struct GNUNET_SERVER_MessageHandler *mh;
 559   unsigned int i;
 560   uint16_t type;
 561   uint16_t size;
 562   int found;
 563
 564   type = ntohs (message->type);
 565   size = ntohs (message->size);
 566 #if DEBUG_SERVER
 567   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 568               "Server schedules transmission of %u-byte message of type %u to client.\n",
 569               size,
 570               type);
 571 #endif
 572   pos = server->handlers;
 573   found = GNUNET_NO;
 574   while (pos != NULL)
 575     {
 576       i = 0;
 577       while (pos->handlers[i].callback != NULL)
 578         {
 579           mh = &pos->handlers[i];
 580           if (mh->type == type)
 581             {
 582               if ((mh->expected_size != 0) && (mh->expected_size != size))
 583                 {
 584                   GNUNET_break_op (0);
 585                   return GNUNET_SYSERR;
 586                 }
 587               if (sender != NULL)
 588                 sender->suspended++;
 589               mh->callback (mh->callback_cls, sender, message);
 590               found = GNUNET_YES;
 591             }
 592           i++;
 593         }
 594       pos = pos->next;
 595     }
 596   if (found == GNUNET_NO)
 597     {
 598       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 599                   _("Received message of unknown type %d\n"), type);
 600       if (server->require_found == GNUNET_YES)
 601         return GNUNET_SYSERR;
 602     }
 603   return GNUNET_OK;
 604 }
 605
 606
 607 /**
 608  * We're finished with this client and especially its input
 609  * processing.  If the RC is zero, free all resources otherwise wait
 610  * until RC hits zero to do so.
 611  */
 612 static void
 613 shutdown_incoming_processing (struct GNUNET_SERVER_Client *client)
 614 {
 615   struct GNUNET_SERVER_Client *prev;
 616   struct GNUNET_SERVER_Client *pos;
 617   struct GNUNET_SERVER_Handle *server;
 618   struct NotifyList *n;
 619   unsigned int rc;
 620
 621   rc = client->reference_count;
 622   if (client->server != NULL)
 623     {
 624       server = client->server;
 625       client->server = NULL;
 626       prev = NULL;
 627       pos = server->clients;
 628       while ((pos != NULL) && (pos != client))
 629         {
 630           prev = pos;
 631           pos = pos->next;
 632         }
 633       GNUNET_assert (pos != NULL);
 634       if (prev == NULL)
 635         server->clients = pos->next;
 636       else
 637         prev->next = pos->next;
 638       n = server->disconnect_notify_list;
 639       while (n != NULL)
 640         {
 641           n->callback (n->callback_cls, client);
 642           n = n->next;
 643         }
 644     }
 645   /* wait for RC to hit zero, then free */
 646   if (rc > 0)
 647     return;
 648   client->destroy (client->client_closure);
 649   GNUNET_free (client);
 650 }
 651
 652
 653 /**
 654  * Go over the contents of the client buffer; as long as full messages
 655  * are available, pass them on for processing.  Update the buffer
 656  * accordingly.  Handles fatal errors by shutting down the connection.
 657  *
 658  * @param client identifies which client receive buffer to process
 659  */
 660 static void
 661 process_client_buffer (struct GNUNET_SERVER_Client *client)
 662 {
 663   struct GNUNET_SERVER_Handle *server;
 664   const struct GNUNET_MessageHeader *hdr;
 665   size_t msize;
 666
 667   client->in_process_client_buffer = GNUNET_YES;
 668   server = client->server;
 669 #if DEBUG_SERVER
 670   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 671               "Private buffer contains %u bytes; client is %s and we are %s\n",
 672               client->receive_pos,
 673               client->suspended ? "suspended" : "up",
 674               client->shutdown_now ? "in shutdown" : "running");
 675 #endif
 676   while ((client->receive_pos >= sizeof (struct GNUNET_MessageHeader)) &&
 677          (0 == client->suspended) && (GNUNET_YES != client->shutdown_now))
 678     {
 679       hdr = (const struct GNUNET_MessageHeader *) &client->incoming_buffer;
 680       msize = ntohs (hdr->size);
 681       if (msize > client->receive_pos)
 682         {
 683 #if DEBUG_SERVER
 684           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 685                       "Total message size is %u, we only have %u bytes; need more data\n",
 686                       msize,
 687                       client->receive_pos);
 688 #endif
 689           break;
 690         }
 691 #if DEBUG_SERVER
 692       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 693                   "Passing %u bytes to callback for processing\n",
 694                   msize);
 695 #endif
 696       if ((msize < sizeof (struct GNUNET_MessageHeader)) ||
 697           (GNUNET_OK != GNUNET_SERVER_inject (server, client, hdr)))
 698         {
 699           client->in_process_client_buffer = GNUNET_NO;
 700           shutdown_incoming_processing (client);
 701           return;
 702         }
 703       /* FIXME: this is highly inefficient; we should
 704          try to avoid this if the new base address is
 705          already nicely aligned.  See old handler code... */
 706       memmove (client->incoming_buffer,
 707                &client->incoming_buffer[msize], client->receive_pos - msize);
 708       client->receive_pos -= msize;
 709     }
 710   client->in_process_client_buffer = GNUNET_NO;
 711   if (GNUNET_YES == client->shutdown_now)
 712     shutdown_incoming_processing (client);
 713 }
 714
 715
 716 /**
 717  * We are receiving an incoming message.  Process it.
 718  *
 719  * @param cls our closure (handle for the client)
 720  * @param buf buffer with data received from network
 721  * @param available number of bytes available in buf
 722  * @param addr address of the sender
 723  * @param addrlen length of addr
 724  * @param errCode code indicating errors receiving, 0 for success
 725  */
 726 static void
 727 process_incoming (void *cls,
 728                   const void *buf,
 729                   size_t available,
 730                   const struct sockaddr *addr,
 731                   socklen_t addrlen,
 732                   int errCode)
 733 {
 734   struct GNUNET_SERVER_Client *client = cls;
 735   struct GNUNET_SERVER_Handle *server = client->server;
 736   const char *cbuf = buf;
 737   size_t maxcpy;
 738
 739   if ((buf == NULL) ||
 740       (available == 0) ||
 741       (errCode != 0) ||
 742       (server == NULL) ||
 743       (client->shutdown_now == GNUNET_YES) ||
 744       (GNUNET_YES != client->check (client->client_closure)))
 745     {
 746       /* other side closed connection, error connecting, etc. */
 747       shutdown_incoming_processing (client);
 748       return;
 749     }
 750 #if DEBUG_SERVER
 751   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 752               "Server receives %u bytes from `%s'.\n",
 753               available,
 754               GNUNET_a2s(addr, addrlen));
 755 #endif
 756   GNUNET_SERVER_client_keep (client);
 757   client->last_activity = GNUNET_TIME_absolute_get ();
 758   /* process data (if available) */
 759   while (available > 0)
 760     {
 761       maxcpy = available;
 762       if (maxcpy > sizeof (client->incoming_buffer) - client->receive_pos)
 763         maxcpy = sizeof (client->incoming_buffer) - client->receive_pos;
 764 #if DEBUG_SERVER
 765       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 766                   "Can copy %u bytes to private buffer\n",
 767                   maxcpy);
 768 #endif
 769       memcpy (&client->incoming_buffer[client->receive_pos], cbuf, maxcpy);
 770       client->receive_pos += maxcpy;
 771       cbuf += maxcpy;
 772       available -= maxcpy;
 773       if (0 < client->suspended)
 774         {
 775           if (available > 0)
 776             {
 777 #if DEBUG_SERVER
 778               GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 779                           "Client has suspended processing; copying %u bytes to side buffer to be used later.\n",
 780                           available);
 781 #endif
 782               GNUNET_assert (client->side_buf_size == 0);
 783               GNUNET_assert (client->side_buf == NULL);
 784               client->side_buf_size = available;
 785               client->side_buf = GNUNET_malloc (available);
 786               memcpy (client->side_buf, cbuf, available);
 787               available = 0;
 788             }
 789           break;                /* do not run next client iteration! */
 790         }
 791 #if DEBUG_SERVER
 792       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 793                   "Now processing messages in private buffer\n");
 794 #endif
 795       process_client_buffer (client);
 796     }
 797   GNUNET_assert (available == 0);
 798   if ((client->suspended == 0) &&
 799       (GNUNET_YES != client->shutdown_now) && (client->server != NULL))
 800     {
 801       /* Finally, keep receiving! */
 802       client->receive (client->client_closure,
 803                        GNUNET_SERVER_MAX_MESSAGE_SIZE,
 804                        server->idle_timeout,
 805                        &process_incoming, client);
 806     }
 807   if (GNUNET_YES == client->shutdown_now)
 808     shutdown_incoming_processing (client);
 809   GNUNET_SERVER_client_drop (client);
 810 }
 811
 812
 813 /**
 814  * FIXME: document.
 815  */
 816 static void
 817 restart_processing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 818 {
 819   struct GNUNET_SERVER_Client *client = cls;
 820
 821   process_client_buffer (client);
 822   if (0 == client->suspended)
 823     client->receive (client->client_closure,
 824                      GNUNET_SERVER_MAX_MESSAGE_SIZE,
 825                      client->server->idle_timeout,
 826                      &process_incoming, client);
 827 }
 828
 829
 830 /**
 831  * Add a client to the set of our clients and
 832  * start receiving.
 833  */
 834 static void
 835 add_client (struct GNUNET_SERVER_Handle *server,
 836             struct GNUNET_SERVER_Client *client)
 837 {
 838   client->server = server;
 839   client->last_activity = GNUNET_TIME_absolute_get ();
 840   client->next = server->clients;
 841   server->clients = client;
 842   client->receive (client->client_closure,
 843                    GNUNET_SERVER_MAX_MESSAGE_SIZE,
 844                    server->idle_timeout,
 845                    &process_incoming, client);
 846 }
 847
 848
 849 /**
 850  * Create a request for receiving data from a socket.
 851  *
 852  * @param cls identifies the socket to receive from
 853  * @param max how much data to read at most
 854  * @param timeout when should this operation time out
 855  * @param receiver function to call for processing
 856  * @param receiver_cls closure for receiver
 857  */
 858 static void
 859 sock_receive (void *cls,
 860               size_t max,
 861               struct GNUNET_TIME_Relative timeout,
 862               GNUNET_CONNECTION_Receiver receiver, void *receiver_cls)
 863 {
 864   GNUNET_CONNECTION_receive (cls, max, timeout, receiver, receiver_cls);
 865 }
 866
 867
 868 /**
 869  * Wrapper to cancel receiving from a socket.
 870  *
 871  * @param cls handle to the GNUNET_CONNECTION_Handle to cancel
 872  */
 873 static void
 874 sock_receive_cancel (void *cls)
 875 {
 876   GNUNET_CONNECTION_receive_cancel (cls);
 877 }
 878
 879
 880 /**
 881  * FIXME: document.
 882  */
 883 static void *
 884 sock_notify_transmit_ready (void *cls,
 885                             size_t size,
 886                             struct GNUNET_TIME_Relative timeout,
 887                             GNUNET_CONNECTION_TransmitReadyNotify notify,
 888                             void *notify_cls)
 889 {
 890   return GNUNET_CONNECTION_notify_transmit_ready (cls, size, timeout, notify,
 891                                                notify_cls);
 892 }
 893
 894
 895 /**
 896  * FIXME: document.
 897  */
 898 static void
 899 sock_notify_transmit_ready_cancel (void *cls, void *h)
 900 {
 901   GNUNET_CONNECTION_notify_transmit_ready_cancel (h);
 902 }
 903
 904
 905 /**
 906  * Check if socket is still valid (no fatal errors have happened so far).
 907  *
 908  * @param cls the socket
 909  * @return GNUNET_YES if valid, GNUNET_NO otherwise
 910  */
 911 static int
 912 sock_check (void *cls)
 913 {
 914   return GNUNET_CONNECTION_check (cls);
 915 }
 916
 917
 918 /**
 919  * Destroy this socket (free resources).
 920  *
 921  * @param cls the socket
 922  */
 923 static void
 924 sock_destroy (void *cls)
 925 {
 926   GNUNET_CONNECTION_destroy (cls);
 927 }
 928
 929
 930 /**
 931  * Add a TCP socket-based connection to the set of handles managed by
 932  * this server.  Use this function for outgoing (P2P) connections that
 933  * we initiated (and where this server should process incoming
 934  * messages).
 935  *
 936  * @param server the server to use
 937  * @param connection the connection to manage (client must
 938  *        stop using this connection from now on)
 939  * @return the client handle (client should call
 940  *         "client_drop" on the return value eventually)
 941  */
 942 struct GNUNET_SERVER_Client *
 943 GNUNET_SERVER_connect_socket (struct
 944                               GNUNET_SERVER_Handle
 945                               *server,
 946                               struct GNUNET_CONNECTION_Handle *connection)
 947 {
 948   struct GNUNET_SERVER_Client *client;
 949
 950   client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
 951   client->client_closure = connection;
 952   client->receive = &sock_receive;
 953   client->receive_cancel = &sock_receive_cancel;
 954   client->notify_transmit_ready = &sock_notify_transmit_ready;
 955   client->notify_transmit_ready_cancel = &sock_notify_transmit_ready_cancel;
 956   client->check = &sock_check;
 957   client->destroy = &sock_destroy;
 958   client->reference_count = 1;
 959   add_client (server, client);
 960   return client;
 961 }
 962
 963
 964 /**
 965  * Add an arbitrary connection to the set of handles managed by this
 966  * server.  This can be used if a sending and receiving does not
 967  * really go over the network (internal transmission) or for servers
 968  * using UDP.
 969  *
 970  * @param server the server to use
 971  * @param chandle opaque handle for the connection
 972  * @param creceive receive function for the connection
 973  * @param ccancel cancel receive function for the connection
 974  * @param cnotify transmit notification function for the connection
 975  * @param cnotify_cancel transmit notification cancellation function for the connection
 976  * @param ccheck function to test if the connection is still up
 977  * @param cdestroy function to close and free the connection
 978  * @return the client handle (client should call
 979  *         "client_drop" on the return value eventually)
 980  */
 981 struct GNUNET_SERVER_Client *
 982 GNUNET_SERVER_connect_callback (struct
 983                                 GNUNET_SERVER_Handle
 984                                 *server,
 985                                 void *chandle,
 986                                 GNUNET_SERVER_ReceiveCallback
 987                                 creceive,
 988                                 GNUNET_SERVER_ReceiveCancelCallback
 989                                 ccancel,
 990                                 GNUNET_SERVER_TransmitReadyCallback
 991                                 cnotify,
 992                                 GNUNET_SERVER_TransmitReadyCancelCallback
 993                                 cnotify_cancel,
 994                                 GNUNET_SERVER_CheckCallback
 995                                 ccheck,
 996                                 GNUNET_SERVER_DestroyCallback cdestroy)
 997 {
 998   struct GNUNET_SERVER_Client *client;
 999
1000   client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
1001   client->client_closure = chandle;
1002   client->receive = creceive;
1003   client->receive_cancel = ccancel;
1004   client->notify_transmit_ready = cnotify;
1005   client->notify_transmit_ready_cancel = cnotify_cancel;
1006   client->check = ccheck;
1007   client->destroy = cdestroy;
1008   client->reference_count = 1;
1009   add_client (server, client);
1010   return client;
1011 }
1012
1013
1014 /**
1015  * Notify the server that the given client handle should
1016  * be kept (keeps the connection up if possible, increments
1017  * the internal reference counter).
1018  *
1019  * @param client the client to keep
1020  */
1021 void
1022 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
1023 {
1024   client->reference_count++;
1025 }
1026
1027
1028 /**
1029  * Notify the server that the given client handle is no
1030  * longer required.  Decrements the reference counter.  If
1031  * that counter reaches zero an inactive connection maybe
1032  * closed.
1033  *
1034  * @param client the client to drop
1035  */
1036 void
1037 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1038 {
1039   GNUNET_assert (client->reference_count > 0);
1040   client->reference_count--;
1041   if ((client->server == NULL) && (client->reference_count == 0))
1042     shutdown_incoming_processing (client);
1043 }
1044
1045
1046 /**
1047  * Obtain the network address of the other party.
1048  *
1049  * @param client the client to get the address for
1050  * @param addr where to store the address
1051  * @param addrlen where to store the length of the address
1052  * @return GNUNET_OK on success
1053  */
1054 int
1055 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1056                                   void **addr, size_t * addrlen)
1057 {
1058   if (client->receive != &sock_receive)
1059     return GNUNET_SYSERR;       /* not a network client */
1060   return GNUNET_CONNECTION_get_address (client->client_closure,
1061                                             addr, addrlen);
1062 }
1063
1064
1065 /**
1066  * Ask the server to notify us whenever a client disconnects.
1067  * This function is called whenever the actual network connection
1068  * is closed; the reference count may be zero or larger than zero
1069  * at this point.
1070  *
1071  * @param server the server manageing the clients
1072  * @param callback function to call on disconnect
1073  * @param callback_cls closure for callback
1074  */
1075 void
1076 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1077                                  GNUNET_SERVER_DisconnectCallback callback,
1078                                  void *callback_cls)
1079 {
1080   struct NotifyList *n;
1081
1082   n = GNUNET_malloc (sizeof (struct NotifyList));
1083   n->callback = callback;
1084   n->callback_cls = callback_cls;
1085   n->next = server->disconnect_notify_list;
1086   server->disconnect_notify_list = n;
1087 }
1088
1089
1090 /**
1091  * Ask the server to disconnect from the given client.
1092  * This is the same as returning GNUNET_SYSERR from a message
1093  * handler, except that it allows dropping of a client even
1094  * when not handling a message from that client.
1095  *
1096  * @param client the client to disconnect from
1097  */
1098 void
1099 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1100 {
1101   if (client->server == NULL)
1102     return;                     /* already disconnected */
1103   client->receive_cancel (client->client_closure);
1104   shutdown_incoming_processing (client);
1105 }
1106
1107
1108 /**
1109  * Notify us when the server has enough space to transmit
1110  * a message of the given size to the given client.
1111  *
1112  * @param client client to transmit message to
1113  * @param size requested amount of buffer space
1114  * @param timeout after how long should we give up (and call
1115  *        notify with buf NULL and size 0)?
1116  * @param callback function to call when space is available
1117  * @param callback_cls closure for callback
1118  * @return non-NULL if the notify callback was queued; can be used
1119  *           to cancel the request using
1120  *           GNUNET_CONNECTION_notify_transmit_ready_cancel.
1121  *         NULL if we are already going to notify someone else (busy)
1122  */
1123 struct GNUNET_CONNECTION_TransmitHandle *
1124 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1125                                      size_t size,
1126                                      struct GNUNET_TIME_Relative timeout,
1127                                      GNUNET_CONNECTION_TransmitReadyNotify
1128                                      callback, void *callback_cls)
1129 {
1130   return client->notify_transmit_ready (client->client_closure,
1131                                         size,
1132                                         timeout, callback, callback_cls);
1133 }
1134
1135
1136 /**
1137  * Resume receiving from this client, we are done processing the
1138  * current request.  This function must be called from within each
1139  * GNUNET_SERVER_MessageCallback (or its respective continuations).
1140  *
1141  * @param client client we were processing a message of
1142  * @param success GNUNET_OK to keep the connection open and
1143  *                          continue to receive
1144  *                GNUNET_SYSERR to close the connection (signal
1145  *                          serious error)
1146  */
1147 void
1148 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success)
1149 {
1150   char *sb;
1151
1152   if (client == NULL)
1153     return;
1154   GNUNET_assert (client->suspended > 0);
1155   client->suspended--;
1156   if (success != GNUNET_OK)
1157     client->shutdown_now = GNUNET_YES;
1158   if (client->suspended > 0)
1159     return;
1160   if (client->in_process_client_buffer == GNUNET_YES)
1161     return;
1162   if (client->side_buf_size > 0)
1163     {
1164       /* resume processing from side-buf */
1165       sb = client->side_buf;
1166       client->side_buf = NULL;
1167       /* this will also resume the receive job */
1168       if (GNUNET_YES != client->shutdown_now)
1169         process_incoming (client, sb, client->side_buf_size, NULL, 0, 0);
1170       else
1171         shutdown_incoming_processing (client);
1172       /* finally, free the side-buf */
1173       GNUNET_free (sb);
1174       return;
1175     }
1176   /* resume receive job */
1177   if (GNUNET_YES != client->shutdown_now)
1178     {
1179       GNUNET_SCHEDULER_add_continuation (client->server->sched,
1180                                          GNUNET_NO,
1181                                          &restart_processing,
1182                                          client,
1183                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
1184       return;
1185     }
1186   shutdown_incoming_processing (client);
1187 }
1188
1189
1190 /* end of server.c */