src/util/server.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009-2013 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file util/server.c
  23  * @brief library for building GNUnet network servers
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_protocols.h"
  30
  31 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
  32
  33 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
  34
  35 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
  36
  37
  38 /**
  39  * List of arrays of message handlers.
  40  */
  41 struct HandlerList
  42 {
  43   /**
  44    * This is a linked list.
  45    */
  46   struct HandlerList *next;
  47
  48   /**
  49    * NULL-terminated array of handlers.
  50    */
  51   const struct GNUNET_SERVER_MessageHandler *handlers;
  52 };
  53
  54
  55 /**
  56  * List of arrays of message handlers.
  57  */
  58 struct NotifyList
  59 {
  60   /**
  61    * This is a doubly linked list.
  62    */
  63   struct NotifyList *next;
  64
  65   /**
  66    * This is a doubly linked list.
  67    */
  68   struct NotifyList *prev;
  69
  70   /**
  71    * Function to call.
  72    */
  73   GNUNET_SERVER_DisconnectCallback callback;
  74
  75   /**
  76    * Closure for callback.
  77    */
  78   void *callback_cls;
  79 };
  80
  81
  82 /**
  83  * @brief handle for a server
  84  */
  85 struct GNUNET_SERVER_Handle
  86 {
  87   /**
  88    * List of handlers for incoming messages.
  89    */
  90   struct HandlerList *handlers;
  91
  92   /**
  93    * Head of list of our current clients.
  94    */
  95   struct GNUNET_SERVER_Client *clients_head;
  96
  97   /**
  98    * Head of list of our current clients.
  99    */
 100   struct GNUNET_SERVER_Client *clients_tail;
 101
 102   /**
 103    * Head of linked list of functions to call on disconnects by clients.
 104    */
 105   struct NotifyList *disconnect_notify_list_head;
 106
 107   /**
 108    * Tail of linked list of functions to call on disconnects by clients.
 109    */
 110   struct NotifyList *disconnect_notify_list_tail;
 111
 112   /**
 113    * Head of linked list of functions to call on connects by clients.
 114    */
 115   struct NotifyList *connect_notify_list_head;
 116
 117   /**
 118    * Tail of linked list of functions to call on connects by clients.
 119    */
 120   struct NotifyList *connect_notify_list_tail;
 121
 122   /**
 123    * Function to call for access control.
 124    */
 125   GNUNET_CONNECTION_AccessCheck access;
 126
 127   /**
 128    * Closure for access.
 129    */
 130   void *access_cls;
 131
 132   /**
 133    * NULL-terminated array of sockets used to listen for new
 134    * connections.
 135    */
 136   struct GNUNET_NETWORK_Handle **listen_sockets;
 137
 138   /**
 139    * After how long should an idle connection time
 140    * out (on write).
 141    */
 142   struct GNUNET_TIME_Relative idle_timeout;
 143
 144   /**
 145    * Task scheduled to do the listening.
 146    */
 147   GNUNET_SCHEDULER_TaskIdentifier listen_task;
 148
 149   /**
 150    * Alternative function to create a MST instance.
 151    */
 152   GNUNET_SERVER_MstCreateCallback mst_create;
 153
 154   /**
 155    * Alternative function to destroy a MST instance.
 156    */
 157   GNUNET_SERVER_MstDestroyCallback mst_destroy;
 158
 159   /**
 160    * Alternative function to give data to a MST instance.
 161    */
 162   GNUNET_SERVER_MstReceiveCallback mst_receive;
 163
 164   /**
 165    * Closure for 'mst_'-callbacks.
 166    */
 167   void *mst_cls;
 168
 169   /**
 170    * Do we ignore messages of types that we do not understand or do we
 171    * require that a handler is found (and if not kill the connection)?
 172    */
 173   int require_found;
 174
 175   /**
 176    * Set to #GNUNET_YES once we are in 'soft' shutdown where we wait for
 177    * all non-monitor clients to disconnect before we call
 178    * #GNUNET_SERVER_destroy.  See 'test_monitor_clients'.  Set to
 179    * #GNUNET_SYSERR once the final destroy task has been scheduled
 180    * (we cannot run it in the same task).
 181    */
 182   int in_soft_shutdown;
 183 };
 184
 185
 186 /**
 187  * Handle server returns for aborting transmission to a client.
 188  */
 189 struct GNUNET_SERVER_TransmitHandle
 190 {
 191   /**
 192    * Function to call to get the message.
 193    */
 194   GNUNET_CONNECTION_TransmitReadyNotify callback;
 195
 196   /**
 197    * Closure for @e callback
 198    */
 199   void *callback_cls;
 200
 201   /**
 202    * Active connection transmission handle.
 203    */
 204   struct GNUNET_CONNECTION_TransmitHandle *cth;
 205
 206 };
 207
 208
 209 /**
 210  * @brief handle for a client of the server
 211  */
 212 struct GNUNET_SERVER_Client
 213 {
 214
 215   /**
 216    * This is a doubly linked list.
 217    */
 218   struct GNUNET_SERVER_Client *next;
 219
 220   /**
 221    * This is a doubly linked list.
 222    */
 223   struct GNUNET_SERVER_Client *prev;
 224
 225   /**
 226    * Processing of incoming data.
 227    */
 228   void *mst;
 229
 230   /**
 231    * Server that this client belongs to.
 232    */
 233   struct GNUNET_SERVER_Handle *server;
 234
 235   /**
 236    * Client closure for callbacks.
 237    */
 238   struct GNUNET_CONNECTION_Handle *connection;
 239
 240   /**
 241    * User context value, manipulated using
 242    * 'GNUNET_SERVER_client_{get/set}_user_context' functions.
 243    */
 244   void *user_context;
 245
 246   /**
 247    * ID of task used to restart processing.
 248    */
 249   GNUNET_SCHEDULER_TaskIdentifier restart_task;
 250
 251   /**
 252    * Task that warns about missing calls to #GNUNET_SERVER_receive_done.
 253    */
 254   GNUNET_SCHEDULER_TaskIdentifier warn_task;
 255
 256   /**
 257    * Time when the warn task was started.
 258    */
 259   struct GNUNET_TIME_Absolute warn_start;
 260
 261   /**
 262    * Last activity on this socket (used to time it out
 263    * if reference_count == 0).
 264    */
 265   struct GNUNET_TIME_Absolute last_activity;
 266
 267   /**
 268    * Transmission handle we return for this client from
 269    * #GNUNET_SERVER_notify_transmit_ready.
 270    */
 271   struct GNUNET_SERVER_TransmitHandle th;
 272
 273   /**
 274    * After how long should an idle connection time
 275    * out (on write).
 276    */
 277   struct GNUNET_TIME_Relative idle_timeout;
 278
 279   /**
 280    * Number of external entities with a reference to
 281    * this client object.
 282    */
 283   unsigned int reference_count;
 284
 285   /**
 286    * Was processing if incoming messages suspended while
 287    * we were still processing data already received?
 288    * This is a counter saying how often processing was
 289    * suspended (once per handler invoked).
 290    */
 291   unsigned int suspended;
 292
 293   /**
 294    * Last size given when user context was initialized; used for
 295    * sanity check.
 296    */
 297   size_t user_context_size;
 298
 299   /**
 300    * Are we currently in the "process_client_buffer" function (and
 301    * will hence restart the receive job on exit if suspended == 0 once
 302    * we are done?).  If this is set, then "receive_done" will
 303    * essentially only decrement suspended; if this is not set, then
 304    * "receive_done" may need to restart the receive process (either
 305    * from the side-buffer or via select/recv).
 306    */
 307   int in_process_client_buffer;
 308
 309   /**
 310    * We're about to close down this client.
 311    */
 312   int shutdown_now;
 313
 314   /**
 315    * Are we currently trying to receive? (#GNUNET_YES if we are,
 316    * #GNUNET_NO if we are not, #GNUNET_SYSERR if data is already
 317    * available in MST).
 318    */
 319   int receive_pending;
 320
 321   /**
 322    * Persist the file handle for this client no matter what happens,
 323    * force the OS to close once the process actually dies.  Should only
 324    * be used in special cases!
 325    */
 326   int persist;
 327
 328   /**
 329    * Is this client a 'monitor' client that should not be counted
 330    * when deciding on destroying the server during soft shutdown?
 331    * (see also #GNUNET_SERVICE_start)
 332    */
 333   int is_monitor;
 334
 335   /**
 336    * Type of last message processed (for warn_no_receive_done).
 337    */
 338   uint16_t warn_type;
 339 };
 340
 341
 342
 343 /**
 344  * Return user context associated with the given client.
 345  * Note: you should probably use the macro (call without the underscore).
 346  *
 347  * @param client client to query
 348  * @param size number of bytes in user context struct (for verification only)
 349  * @return pointer to user context
 350  */
 351 void *
 352 GNUNET_SERVER_client_get_user_context_ (struct GNUNET_SERVER_Client *client,
 353                                         size_t size)
 354 {
 355   if ((0 == client->user_context_size) &&
 356       (NULL == client->user_context))
 357     return NULL; /* never set */
 358   GNUNET_assert (size == client->user_context_size);
 359   return client->user_context;
 360 }
 361
 362
 363 /**
 364  * Set user context to be associated with the given client.
 365  * Note: you should probably use the macro (call without the underscore).
 366  *
 367  * @param client client to query
 368  * @param ptr pointer to user context
 369  * @param size number of bytes in user context struct (for verification only)
 370  */
 371 void
 372 GNUNET_SERVER_client_set_user_context_ (struct GNUNET_SERVER_Client *client,
 373                                         void *ptr,
 374                                         size_t size)
 375 {
 376   if (NULL == ptr)
 377   {
 378     client->user_context_size = 0;
 379     client->user_context = ptr;
 380     return;
 381   }
 382   client->user_context_size = size;
 383   client->user_context = ptr;
 384 }
 385
 386
 387 /**
 388  * Scheduler says our listen socket is ready.  Process it!
 389  *
 390  * @param cls handle to our server for which we are processing the listen
 391  *        socket
 392  * @param tc reason why we are running right now
 393  */
 394 static void
 395 process_listen_socket (void *cls,
 396                        const struct GNUNET_SCHEDULER_TaskContext *tc)
 397 {
 398   struct GNUNET_SERVER_Handle *server = cls;
 399   struct GNUNET_CONNECTION_Handle *sock;
 400   struct GNUNET_SERVER_Client *client;
 401   unsigned int i;
 402
 403   server->listen_task = GNUNET_SCHEDULER_NO_TASK;
 404   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 405   {
 406     /* ignore shutdown, someone else will take care of it! */
 407     GNUNET_SERVER_resume (server);
 408     return;
 409   }
 410   i = 0;
 411   while (NULL != server->listen_sockets[i])
 412   {
 413     if (GNUNET_NETWORK_fdset_isset (tc->read_ready, server->listen_sockets[i]))
 414     {
 415       sock =
 416           GNUNET_CONNECTION_create_from_accept (server->access,
 417                                                 server->access_cls,
 418                                                 server->listen_sockets[i]);
 419       if (NULL != sock)
 420       {
 421         LOG (GNUNET_ERROR_TYPE_DEBUG,
 422              "Server accepted incoming connection.\n");
 423         client = GNUNET_SERVER_connect_socket (server, sock);
 424         /* decrement reference count, we don't keep "client" alive */
 425         GNUNET_SERVER_client_drop (client);
 426       }
 427     }
 428     i++;
 429   }
 430   /* listen for more! */
 431   GNUNET_SERVER_resume (server);
 432 }
 433
 434
 435 /**
 436  * Create and initialize a listen socket for the server.
 437  *
 438  * @param server_addr address to listen on
 439  * @param socklen length of @a server_addr
 440  * @return NULL on error, otherwise the listen socket
 441  */
 442 static struct GNUNET_NETWORK_Handle *
 443 open_listen_socket (const struct sockaddr *server_addr, socklen_t socklen)
 444 {
 445   struct GNUNET_NETWORK_Handle *sock;
 446   uint16_t port;
 447   int eno;
 448
 449   switch (server_addr->sa_family)
 450   {
 451   case AF_INET:
 452     port = ntohs (((const struct sockaddr_in *) server_addr)->sin_port);
 453     break;
 454   case AF_INET6:
 455     port = ntohs (((const struct sockaddr_in6 *) server_addr)->sin6_port);
 456     break;
 457   case AF_UNIX:
 458     port = 0;
 459     break;
 460   default:
 461     GNUNET_break (0);
 462     port = 0;
 463     break;
 464   }
 465   sock = GNUNET_NETWORK_socket_create (server_addr->sa_family, SOCK_STREAM, 0);
 466   if (NULL == sock)
 467   {
 468     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket");
 469     errno = 0;
 470     return NULL;
 471   }
 472   /* bind the socket */
 473   if (GNUNET_OK != GNUNET_NETWORK_socket_bind (sock, server_addr, socklen))
 474   {
 475     eno = errno;
 476     if (EADDRINUSE != errno)
 477     {
 478       /* we don't log 'EADDRINUSE' here since an IPv4 bind may
 479        * fail if we already took the port on IPv6; if both IPv4 and
 480        * IPv6 binds fail, then our caller will log using the
 481        * errno preserved in 'eno' */
 482       LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "bind");
 483       if (0 != port)
 484         LOG (GNUNET_ERROR_TYPE_ERROR, _("`%s' failed for port %d (%s).\n"),
 485              "bind", port,
 486              (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
 487       eno = 0;
 488     }
 489     else
 490     {
 491       if (0 != port)
 492         LOG (GNUNET_ERROR_TYPE_WARNING,
 493              _("`%s' failed for port %d (%s): address already in use\n"),
 494              "bind", port,
 495              (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
 496       else if (AF_UNIX == server_addr->sa_family)
 497       {
 498         LOG (GNUNET_ERROR_TYPE_WARNING,
 499              _("`%s' failed for `%s': address already in use\n"),
 500              "bind",
 501              GNUNET_a2s (server_addr, socklen));
 502       }
 503     }
 504     GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
 505     errno = eno;
 506     return NULL;
 507   }
 508   if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
 509   {
 510     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "listen");
 511     GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
 512     errno = 0;
 513     return NULL;
 514   }
 515   if (0 != port)
 516     LOG (GNUNET_ERROR_TYPE_DEBUG, "Server starts to listen on port %u.\n",
 517          port);
 518   return sock;
 519 }
 520
 521
 522 /**
 523  * Create a new server.
 524  *
 525  * @param access function for access control
 526  * @param access_cls closure for access
 527  * @param lsocks NULL-terminated array of listen sockets
 528  * @param idle_timeout after how long should we timeout idle connections?
 529  * @param require_found if #GNUNET_YES, connections sending messages of unknown type
 530  *        will be closed
 531  * @return handle for the new server, NULL on error
 532  *         (typically, "port" already in use)
 533  */
 534 struct GNUNET_SERVER_Handle *
 535 GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access,
 536                                    void *access_cls,
 537                                    struct GNUNET_NETWORK_Handle **lsocks,
 538                                    struct GNUNET_TIME_Relative idle_timeout,
 539                                    int require_found)
 540 {
 541   struct GNUNET_SERVER_Handle *server;
 542
 543   server = GNUNET_new (struct GNUNET_SERVER_Handle);
 544   server->idle_timeout = idle_timeout;
 545   server->listen_sockets = lsocks;
 546   server->access = access;
 547   server->access_cls = access_cls;
 548   server->require_found = require_found;
 549   if (NULL != lsocks)
 550     GNUNET_SERVER_resume (server);
 551   return server;
 552 }
 553
 554
 555 /**
 556  * Create a new server.
 557  *
 558  * @param access function for access control
 559  * @param access_cls closure for access
 560  * @param server_addr address to listen on (including port), NULL terminated array
 561  * @param socklen length of server_addr
 562  * @param idle_timeout after how long should we timeout idle connections?
 563  * @param require_found if YES, connections sending messages of unknown type
 564  *        will be closed
 565  * @return handle for the new server, NULL on error
 566  *         (typically, "port" already in use)
 567  */
 568 struct GNUNET_SERVER_Handle *
 569 GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access, void *access_cls,
 570                       struct sockaddr *const *server_addr,
 571                       const socklen_t * socklen,
 572                       struct GNUNET_TIME_Relative idle_timeout,
 573                       int require_found)
 574 {
 575   struct GNUNET_NETWORK_Handle **lsocks;
 576   unsigned int i;
 577   unsigned int j;
 578   unsigned int k;
 579   int seen;
 580
 581   i = 0;
 582   while (NULL != server_addr[i])
 583     i++;
 584   if (i > 0)
 585   {
 586     lsocks = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (i + 1));
 587     i = 0;
 588     j = 0;
 589     while (NULL != server_addr[i])
 590     {
 591       seen = 0;
 592       for (k=0;k<i;k++)
 593         if ( (socklen[k] == socklen[i]) &&
 594              (0 == memcmp (server_addr[k], server_addr[i], socklen[i])) )
 595         {
 596           seen = 1;
 597           break;
 598         }
 599       if (0 != seen)
 600       {
 601         /* duplicate address, skip */
 602         i++;
 603         continue;
 604       }
 605       lsocks[j] = open_listen_socket (server_addr[i], socklen[i]);
 606       if (NULL != lsocks[j])
 607         j++;
 608       i++;
 609     }
 610     if (0 == j)
 611     {
 612       if (0 != errno)
 613         LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "bind");
 614       GNUNET_free (lsocks);
 615       lsocks = NULL;
 616     }
 617   }
 618   else
 619   {
 620     lsocks = NULL;
 621   }
 622   return GNUNET_SERVER_create_with_sockets (access, access_cls, lsocks,
 623                                             idle_timeout, require_found);
 624 }
 625
 626
 627 /**
 628  * Set the 'monitor' flag on this client.  Clients which have been
 629  * marked as 'monitors' won't prevent the server from shutting down
 630  * once 'GNUNET_SERVER_stop_listening' has been invoked.  The idea is
 631  * that for "normal" clients we likely want to allow them to process
 632  * their requests; however, monitor-clients are likely to 'never'
 633  * disconnect during shutdown and thus will not be considered when
 634  * determining if the server should continue to exist after
 635  * 'GNUNET_SERVER_destroy' has been called.
 636  *
 637  * @param client the client to set the 'monitor' flag on
 638  */
 639 void
 640 GNUNET_SERVER_client_mark_monitor (struct GNUNET_SERVER_Client *client)
 641 {
 642   client->is_monitor = GNUNET_YES;
 643 }
 644
 645
 646 /**
 647  * Helper function for 'test_monitor_clients' to trigger
 648  * 'GNUNET_SERVER_destroy' after the stack has unwound.
 649  *
 650  * @param cls the 'struct GNUNET_SERVER_Handle' to destroy
 651  * @param tc unused
 652  */
 653 static void
 654 do_destroy (void *cls,
 655             const struct GNUNET_SCHEDULER_TaskContext *tc)
 656 {
 657   struct GNUNET_SERVER_Handle *server = cls;
 658   GNUNET_SERVER_destroy (server);
 659 }
 660
 661
 662 /**
 663  * Check if only 'monitor' clients are left.  If so, destroy the
 664  * server completely.
 665  *
 666  * @param server server to test for full shutdown
 667  */
 668 static void
 669 test_monitor_clients (struct GNUNET_SERVER_Handle *server)
 670 {
 671   struct GNUNET_SERVER_Client *client;
 672
 673   if (GNUNET_YES != server->in_soft_shutdown)
 674     return;
 675   for (client = server->clients_head; NULL != client; client = client->next)
 676     if (GNUNET_NO == client->is_monitor)
 677       return; /* not done yet */
 678   server->in_soft_shutdown = GNUNET_SYSERR;
 679   GNUNET_SCHEDULER_add_continuation (&do_destroy, server,
 680                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 681 }
 682
 683
 684 /**
 685  * Suspend accepting connections from the listen socket temporarily.
 686  *
 687  * @param server server to stop accepting connections.
 688  */
 689 void
 690 GNUNET_SERVER_suspend (struct GNUNET_SERVER_Handle *server)
 691 {
 692   if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
 693   {
 694     GNUNET_SCHEDULER_cancel (server->listen_task);
 695     server->listen_task = GNUNET_SCHEDULER_NO_TASK;
 696   }
 697 }
 698
 699
 700 /**
 701  * Resume accepting connections from the listen socket.
 702  *
 703  * @param server server to stop accepting connections.
 704  */
 705 void
 706 GNUNET_SERVER_resume (struct GNUNET_SERVER_Handle *server)
 707 {
 708   struct GNUNET_NETWORK_FDSet *r;
 709   unsigned int i;
 710
 711   if (NULL == server->listen_sockets)
 712     return;
 713   if (NULL == server->listen_sockets[0])
 714     return; /* nothing to do, no listen sockets! */
 715   if (NULL == server->listen_sockets[1])
 716   {
 717     /* simplified method: no fd set needed; this is then much simpler and
 718        much more efficient */
 719     server->listen_task =
 720       GNUNET_SCHEDULER_add_read_net_with_priority (GNUNET_TIME_UNIT_FOREVER_REL,
 721                                                    GNUNET_SCHEDULER_PRIORITY_HIGH,
 722                                                    server->listen_sockets[0],
 723                                                    &process_listen_socket, server);
 724     return;
 725   }
 726   r = GNUNET_NETWORK_fdset_create ();
 727   i = 0;
 728   while (NULL != server->listen_sockets[i])
 729     GNUNET_NETWORK_fdset_set (r, server->listen_sockets[i++]);
 730   server->listen_task =
 731     GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
 732                                  GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
 733                                  &process_listen_socket, server);
 734   GNUNET_NETWORK_fdset_destroy (r);
 735 }
 736
 737
 738 /**
 739  * Stop the listen socket and get ready to shutdown the server
 740  * once only 'monitor' clients are left.
 741  *
 742  * @param server server to stop listening on
 743  */
 744 void
 745 GNUNET_SERVER_stop_listening (struct GNUNET_SERVER_Handle *server)
 746 {
 747   unsigned int i;
 748
 749   LOG (GNUNET_ERROR_TYPE_DEBUG, "Server in soft shutdown\n");
 750   if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
 751   {
 752     GNUNET_SCHEDULER_cancel (server->listen_task);
 753     server->listen_task = GNUNET_SCHEDULER_NO_TASK;
 754   }
 755   if (NULL != server->listen_sockets)
 756   {
 757     i = 0;
 758     while (NULL != server->listen_sockets[i])
 759       GNUNET_break (GNUNET_OK ==
 760                     GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
 761     GNUNET_free (server->listen_sockets);
 762     server->listen_sockets = NULL;
 763   }
 764   if (GNUNET_NO == server->in_soft_shutdown)
 765     server->in_soft_shutdown = GNUNET_YES;
 766   test_monitor_clients (server);
 767 }
 768
 769
 770 /**
 771  * Free resources held by this server.
 772  *
 773  * @param server server to destroy
 774  */
 775 void
 776 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *server)
 777 {
 778   struct HandlerList *hpos;
 779   struct NotifyList *npos;
 780   unsigned int i;
 781
 782   LOG (GNUNET_ERROR_TYPE_DEBUG, "Server shutting down.\n");
 783   if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
 784   {
 785     GNUNET_SCHEDULER_cancel (server->listen_task);
 786     server->listen_task = GNUNET_SCHEDULER_NO_TASK;
 787   }
 788   if (NULL != server->listen_sockets)
 789   {
 790     i = 0;
 791     while (NULL != server->listen_sockets[i])
 792       GNUNET_break (GNUNET_OK ==
 793                     GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
 794     GNUNET_free (server->listen_sockets);
 795     server->listen_sockets = NULL;
 796   }
 797   while (NULL != server->clients_head)
 798     GNUNET_SERVER_client_disconnect (server->clients_head);
 799   while (NULL != (hpos = server->handlers))
 800   {
 801     server->handlers = hpos->next;
 802     GNUNET_free (hpos);
 803   }
 804   while (NULL != (npos = server->disconnect_notify_list_head))
 805   {
 806     npos->callback (npos->callback_cls, NULL);
 807     GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
 808                                  server->disconnect_notify_list_tail,
 809                                  npos);
 810     GNUNET_free (npos);
 811   }
 812   while (NULL != (npos = server->connect_notify_list_head))
 813   {
 814     npos->callback (npos->callback_cls, NULL);
 815     GNUNET_CONTAINER_DLL_remove (server->connect_notify_list_head,
 816                                  server->connect_notify_list_tail,
 817                                  npos);
 818     GNUNET_free (npos);
 819   }
 820   GNUNET_free (server);
 821 }
 822
 823
 824 /**
 825  * Add additional handlers to an existing server.
 826  *
 827  * @param server the server to add handlers to
 828  * @param handlers array of message handlers for
 829  *        incoming messages; the last entry must
 830  *        have "NULL" for the "callback"; multiple
 831  *        entries for the same type are allowed,
 832  *        they will be called in order of occurence.
 833  *        These handlers can be removed later;
 834  *        the handlers array must exist until removed
 835  *        (or server is destroyed).
 836  */
 837 void
 838 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
 839                             const struct GNUNET_SERVER_MessageHandler *handlers)
 840 {
 841   struct HandlerList *p;
 842
 843   p = GNUNET_new (struct HandlerList);
 844   p->handlers = handlers;
 845   p->next = server->handlers;
 846   server->handlers = p;
 847 }
 848
 849
 850 /**
 851  * Change functions used by the server to tokenize the message stream.
 852  * (very rarely used).
 853  *
 854  * @param server server to modify
 855  * @param create new tokenizer initialization function
 856  * @param destroy new tokenizer destruction function
 857  * @param receive new tokenizer receive function
 858  * @param cls closure for @a create, @a receive, @a destroy
 859  */
 860 void
 861 GNUNET_SERVER_set_callbacks (struct GNUNET_SERVER_Handle *server,
 862                              GNUNET_SERVER_MstCreateCallback create,
 863                              GNUNET_SERVER_MstDestroyCallback destroy,
 864                              GNUNET_SERVER_MstReceiveCallback receive,
 865                              void *cls)
 866 {
 867   server->mst_create = create;
 868   server->mst_destroy = destroy;
 869   server->mst_receive = receive;
 870   server->mst_cls = cls;
 871 }
 872
 873
 874 /**
 875  * Task run to warn about missing calls to #GNUNET_SERVER_receive_done.
 876  *
 877  * @param cls our `struct GNUNET_SERVER_Client *` to process more requests from
 878  * @param tc scheduler context (unused)
 879  */
 880 static void
 881 warn_no_receive_done (void *cls,
 882                       const struct GNUNET_SCHEDULER_TaskContext *tc)
 883 {
 884   struct GNUNET_SERVER_Client *client = cls;
 885
 886   GNUNET_break (0 != client->warn_type); /* type should never be 0 here, as we don't use 0 */
 887   client->warn_task =
 888       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
 889                                     &warn_no_receive_done, client);
 890   if (0 == (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
 891     LOG (GNUNET_ERROR_TYPE_WARNING,
 892          _("Processing code for message of type %u did not call `GNUNET_SERVER_receive_done' after %s\n"),
 893          (unsigned int) client->warn_type,
 894          GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (client->warn_start), GNUNET_YES));
 895 }
 896
 897
 898 /**
 899  * Disable the warning the server issues if a message is not acknowledged
 900  * in a timely fashion.  Use this call if a client is intentionally delayed
 901  * for a while.  Only applies to the current message.
 902  *
 903  * @param client client for which to disable the warning
 904  */
 905 void
 906 GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client *client)
 907 {
 908   if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
 909   {
 910     GNUNET_SCHEDULER_cancel (client->warn_task);
 911     client->warn_task = GNUNET_SCHEDULER_NO_TASK;
 912   }
 913 }
 914
 915
 916 /**
 917  * Inject a message into the server, pretend it came
 918  * from the specified client.  Delivery of the message
 919  * will happen instantly (if a handler is installed;
 920  * otherwise the call does nothing).
 921  *
 922  * @param server the server receiving the message
 923  * @param sender the "pretended" sender of the message
 924  *        can be NULL!
 925  * @param message message to transmit
 926  * @return GNUNET_OK if the message was OK and the
 927  *                   connection can stay open
 928  *         GNUNET_SYSERR if the connection to the
 929  *         client should be shut down
 930  */
 931 int
 932 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
 933                       struct GNUNET_SERVER_Client *sender,
 934                       const struct GNUNET_MessageHeader *message)
 935 {
 936   struct HandlerList *pos;
 937   const struct GNUNET_SERVER_MessageHandler *mh;
 938   unsigned int i;
 939   uint16_t type;
 940   uint16_t size;
 941   int found;
 942
 943   type = ntohs (message->type);
 944   size = ntohs (message->size);
 945   LOG (GNUNET_ERROR_TYPE_DEBUG,
 946        "Server schedules transmission of %u-byte message of type %u to client.\n",
 947        size, type);
 948   found = GNUNET_NO;
 949   for (pos = server->handlers; NULL != pos; pos = pos->next)
 950   {
 951     i = 0;
 952     while (pos->handlers[i].callback != NULL)
 953     {
 954       mh = &pos->handlers[i];
 955       if ((mh->type == type) || (mh->type == GNUNET_MESSAGE_TYPE_ALL))
 956       {
 957         if ((0 != mh->expected_size) && (mh->expected_size != size))
 958         {
 959 #if GNUNET8_NETWORK_IS_DEAD
 960           LOG (GNUNET_ERROR_TYPE_WARNING,
 961                "Expected %u bytes for message of type %u, got %u\n",
 962                mh->expected_size, mh->type, size);
 963           GNUNET_break_op (0);
 964 #else
 965           LOG (GNUNET_ERROR_TYPE_DEBUG,
 966                "Expected %u bytes for message of type %u, got %u\n",
 967                mh->expected_size, mh->type, size);
 968 #endif
 969           return GNUNET_SYSERR;
 970         }
 971         if (NULL != sender)
 972         {
 973           if ( (0 == sender->suspended) &&
 974                (GNUNET_SCHEDULER_NO_TASK == sender->warn_task) )
 975           {
 976             GNUNET_break (0 != type); /* type should never be 0 here, as we don't use 0 */
 977             sender->warn_start = GNUNET_TIME_absolute_get ();
 978             sender->warn_task =
 979                 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
 980                                               &warn_no_receive_done, sender);
 981             sender->warn_type = type;
 982           }
 983           sender->suspended++;
 984         }
 985         mh->callback (mh->callback_cls, sender, message);
 986         found = GNUNET_YES;
 987       }
 988       i++;
 989     }
 990   }
 991   if (GNUNET_NO == found)
 992   {
 993     LOG (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 994          "Received message of unknown type %d\n", type);
 995     if (GNUNET_YES == server->require_found)
 996       return GNUNET_SYSERR;
 997   }
 998   return GNUNET_OK;
 999 }
1000
1001
1002 /**
1003  * We are receiving an incoming message.  Process it.
1004  *
1005  * @param cls our closure (handle for the client)
1006  * @param buf buffer with data received from network
1007  * @param available number of bytes available in buf
1008  * @param addr address of the sender
1009  * @param addrlen length of addr
1010  * @param errCode code indicating errors receiving, 0 for success
1011  */
1012 static void
1013 process_incoming (void *cls, const void *buf, size_t available,
1014                   const struct sockaddr *addr, socklen_t addrlen, int errCode);
1015
1016
1017 /**
1018  * Process messages from the client's message tokenizer until either
1019  * the tokenizer is empty (and then schedule receiving more), or
1020  * until some handler is not immediately done (then wait for restart_processing)
1021  * or shutdown.
1022  *
1023  * @param client the client to process, RC must have already been increased
1024  *        using #GNUNET_SERVER_client_keep and will be decreased by one in this
1025  *        function
1026  * @param ret #GNUNET_NO to start processing from the buffer,
1027  *            #GNUNET_OK if the mst buffer is drained and we should instantly go back to receiving
1028  *            #GNUNET_SYSERR if we should instantly abort due to error in a previous step
1029  */
1030 static void
1031 process_mst (struct GNUNET_SERVER_Client *client, int ret)
1032 {
1033   while ((GNUNET_SYSERR != ret) && (NULL != client->server) &&
1034          (GNUNET_YES != client->shutdown_now) && (0 == client->suspended))
1035   {
1036     if (GNUNET_OK == ret)
1037     {
1038       LOG (GNUNET_ERROR_TYPE_DEBUG,
1039            "Server re-enters receive loop, timeout: %s.\n",
1040            GNUNET_STRINGS_relative_time_to_string (client->idle_timeout, GNUNET_YES));
1041       client->receive_pending = GNUNET_YES;
1042       GNUNET_CONNECTION_receive (client->connection,
1043                                  GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1044                                  client->idle_timeout, &process_incoming,
1045                                  client);
1046       break;
1047     }
1048     LOG (GNUNET_ERROR_TYPE_DEBUG,
1049          "Server processes additional messages instantly.\n");
1050     if (NULL != client->server->mst_receive)
1051       ret =
1052           client->server->mst_receive (client->server->mst_cls, client->mst,
1053                                        client, NULL, 0, GNUNET_NO, GNUNET_YES);
1054     else
1055       ret =
1056           GNUNET_SERVER_mst_receive (client->mst, client, NULL, 0, GNUNET_NO,
1057                                      GNUNET_YES);
1058   }
1059   LOG (GNUNET_ERROR_TYPE_DEBUG,
1060        "Server leaves instant processing loop: ret = %d, server = %p, shutdown = %d, suspended = %u\n",
1061        ret, client->server,
1062        client->shutdown_now,
1063        client->suspended);
1064   if (GNUNET_NO == ret)
1065   {
1066     LOG (GNUNET_ERROR_TYPE_DEBUG,
1067          "Server has more data pending but is suspended.\n");
1068     client->receive_pending = GNUNET_SYSERR;    /* data pending */
1069   }
1070   if ( (GNUNET_SYSERR == ret) ||
1071        (GNUNET_YES == client->shutdown_now) )
1072     GNUNET_SERVER_client_disconnect (client);
1073 }
1074
1075
1076 /**
1077  * We are receiving an incoming message.  Process it.
1078  *
1079  * @param cls our closure (handle for the client)
1080  * @param buf buffer with data received from network
1081  * @param available number of bytes available in buf
1082  * @param addr address of the sender
1083  * @param addrlen length of addr
1084  * @param errCode code indicating errors receiving, 0 for success
1085  */
1086 static void
1087 process_incoming (void *cls, const void *buf, size_t available,
1088                   const struct sockaddr *addr, socklen_t addrlen, int errCode)
1089 {
1090   struct GNUNET_SERVER_Client *client = cls;
1091   struct GNUNET_SERVER_Handle *server = client->server;
1092   struct GNUNET_TIME_Absolute end;
1093   struct GNUNET_TIME_Absolute now;
1094   int ret;
1095
1096   GNUNET_assert (GNUNET_YES == client->receive_pending);
1097   client->receive_pending = GNUNET_NO;
1098   now = GNUNET_TIME_absolute_get ();
1099   end = GNUNET_TIME_absolute_add (client->last_activity, client->idle_timeout);
1100
1101   if ((NULL == buf) && (0 == available) && (NULL == addr) && (0 == errCode) &&
1102       (GNUNET_YES != client->shutdown_now) && (NULL != server) &&
1103       (GNUNET_YES == GNUNET_CONNECTION_check (client->connection)) &&
1104       (end.abs_value_us > now.abs_value_us))
1105   {
1106     /* wait longer, timeout changed (i.e. due to us sending) */
1107     LOG (GNUNET_ERROR_TYPE_DEBUG,
1108          "Receive time out, but no disconnect due to sending (%p)\n",
1109          GNUNET_a2s (addr, addrlen));
1110     client->receive_pending = GNUNET_YES;
1111     GNUNET_CONNECTION_receive (client->connection,
1112                                GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1113                                GNUNET_TIME_absolute_get_remaining (end),
1114                                &process_incoming, client);
1115     return;
1116   }
1117   if ((NULL == buf) || (0 == available) || (0 != errCode) || (NULL == server) ||
1118       (GNUNET_YES == client->shutdown_now) ||
1119       (GNUNET_YES != GNUNET_CONNECTION_check (client->connection)))
1120   {
1121     /* other side closed connection, error connecting, etc. */
1122     GNUNET_SERVER_client_disconnect (client);
1123     return;
1124   }
1125   LOG (GNUNET_ERROR_TYPE_DEBUG, "Server receives %u bytes from `%s'.\n",
1126        (unsigned int) available, GNUNET_a2s (addr, addrlen));
1127   GNUNET_SERVER_client_keep (client);
1128   client->last_activity = now;
1129
1130   if (NULL != server->mst_receive)
1131     ret =
1132         client->server->mst_receive (client->server->mst_cls, client->mst,
1133                                      client, buf, available, GNUNET_NO, GNUNET_YES);
1134   else if (NULL != client->mst)
1135   {
1136     ret =
1137         GNUNET_SERVER_mst_receive (client->mst, client, buf, available, GNUNET_NO,
1138                                    GNUNET_YES);
1139   }
1140   else
1141   {
1142     GNUNET_break (0);
1143     return;
1144   }
1145
1146   process_mst (client, ret);
1147   GNUNET_SERVER_client_drop (client);
1148 }
1149
1150
1151 /**
1152  * Task run to start again receiving from the network
1153  * and process requests.
1154  *
1155  * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
1156  * @param tc scheduler context (unused)
1157  */
1158 static void
1159 restart_processing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1160 {
1161   struct GNUNET_SERVER_Client *client = cls;
1162
1163   GNUNET_assert (GNUNET_YES != client->shutdown_now);
1164   client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1165   if (GNUNET_NO == client->receive_pending)
1166   {
1167     LOG (GNUNET_ERROR_TYPE_DEBUG, "Server begins to read again from client.\n");
1168     client->receive_pending = GNUNET_YES;
1169     GNUNET_CONNECTION_receive (client->connection,
1170                                GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1171                                client->idle_timeout, &process_incoming, client);
1172     return;
1173   }
1174   LOG (GNUNET_ERROR_TYPE_DEBUG,
1175        "Server continues processing messages still in the buffer.\n");
1176   GNUNET_SERVER_client_keep (client);
1177   client->receive_pending = GNUNET_NO;
1178   process_mst (client, GNUNET_NO);
1179   GNUNET_SERVER_client_drop (client);
1180 }
1181
1182
1183 /**
1184  * This function is called whenever our inbound message tokenizer has
1185  * received a complete message.
1186  *
1187  * @param cls closure (struct GNUNET_SERVER_Handle)
1188  * @param client identification of the client (struct GNUNET_SERVER_Client*)
1189  * @param message the actual message
1190  *
1191  * @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
1192  */
1193 static int
1194 client_message_tokenizer_callback (void *cls, void *client,
1195                                    const struct GNUNET_MessageHeader *message)
1196 {
1197   struct GNUNET_SERVER_Handle *server = cls;
1198   struct GNUNET_SERVER_Client *sender = client;
1199   int ret;
1200
1201   LOG (GNUNET_ERROR_TYPE_DEBUG,
1202        "Tokenizer gives server message of type %u from client\n",
1203        ntohs (message->type));
1204   sender->in_process_client_buffer = GNUNET_YES;
1205   ret = GNUNET_SERVER_inject (server, sender, message);
1206   sender->in_process_client_buffer = GNUNET_NO;
1207   if ( (GNUNET_OK != ret) || (GNUNET_YES == sender->shutdown_now) )
1208   {
1209     GNUNET_SERVER_client_disconnect (sender);
1210     return GNUNET_SYSERR;
1211   }
1212   return GNUNET_OK;
1213 }
1214
1215
1216 /**
1217  * Add a TCP socket-based connection to the set of handles managed by
1218  * this server.  Use this function for outgoing (P2P) connections that
1219  * we initiated (and where this server should process incoming
1220  * messages).
1221  *
1222  * @param server the server to use
1223  * @param connection the connection to manage (client must
1224  *        stop using this connection from now on)
1225  * @return the client handle (client should call
1226  *         "client_drop" on the return value eventually)
1227  */
1228 struct GNUNET_SERVER_Client *
1229 GNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server,
1230                               struct GNUNET_CONNECTION_Handle *connection)
1231 {
1232   struct GNUNET_SERVER_Client *client;
1233   struct NotifyList *n;
1234
1235   client = GNUNET_new (struct GNUNET_SERVER_Client);
1236   client->connection = connection;
1237   client->reference_count = 1;
1238   client->server = server;
1239   client->last_activity = GNUNET_TIME_absolute_get ();
1240   client->idle_timeout = server->idle_timeout;
1241   GNUNET_CONTAINER_DLL_insert (server->clients_head,
1242                                server->clients_tail,
1243                                client);
1244   if (NULL != server->mst_create)
1245     client->mst =
1246         server->mst_create (server->mst_cls, client);
1247   else
1248     client->mst =
1249         GNUNET_SERVER_mst_create (&client_message_tokenizer_callback, server);
1250   GNUNET_assert (NULL != client->mst);
1251   for (n = server->connect_notify_list_head; NULL != n; n = n->next)
1252     n->callback (n->callback_cls, client);
1253
1254   client->receive_pending = GNUNET_YES;
1255   GNUNET_CONNECTION_receive (client->connection,
1256                              GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1257                              client->idle_timeout, &process_incoming, client);
1258   return client;
1259 }
1260
1261
1262 /**
1263  * Change the timeout for a particular client.  Decreasing the timeout
1264  * may not go into effect immediately (only after the previous timeout
1265  * times out or activity happens on the socket).
1266  *
1267  * @param client the client to update
1268  * @param timeout new timeout for activities on the socket
1269  */
1270 void
1271 GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client,
1272                                   struct GNUNET_TIME_Relative timeout)
1273 {
1274   client->idle_timeout = timeout;
1275 }
1276
1277
1278 /**
1279  * Notify the server that the given client handle should
1280  * be kept (keeps the connection up if possible, increments
1281  * the internal reference counter).
1282  *
1283  * @param client the client to keep
1284  */
1285 void
1286 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
1287 {
1288   client->reference_count++;
1289 }
1290
1291
1292 /**
1293  * Notify the server that the given client handle is no
1294  * longer required.  Decrements the reference counter.  If
1295  * that counter reaches zero an inactive connection maybe
1296  * closed.
1297  *
1298  * @param client the client to drop
1299  */
1300 void
1301 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1302 {
1303   GNUNET_assert (client->reference_count > 0);
1304   client->reference_count--;
1305   if ((GNUNET_YES == client->shutdown_now) && (0 == client->reference_count))
1306     GNUNET_SERVER_client_disconnect (client);
1307 }
1308
1309
1310 /**
1311  * Obtain the network address of the other party.
1312  *
1313  * @param client the client to get the address for
1314  * @param addr where to store the address
1315  * @param addrlen where to store the length of the address
1316  * @return GNUNET_OK on success
1317  */
1318 int
1319 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1320                                   void **addr, size_t * addrlen)
1321 {
1322   return GNUNET_CONNECTION_get_address (client->connection, addr, addrlen);
1323 }
1324
1325
1326 /**
1327  * Ask the server to notify us whenever a client disconnects.
1328  * This function is called whenever the actual network connection
1329  * is closed; the reference count may be zero or larger than zero
1330  * at this point.
1331  *
1332  * @param server the server manageing the clients
1333  * @param callback function to call on disconnect
1334  * @param callback_cls closure for @a callback
1335  */
1336 void
1337 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1338                                  GNUNET_SERVER_DisconnectCallback callback,
1339                                  void *callback_cls)
1340 {
1341   struct NotifyList *n;
1342
1343   n = GNUNET_new (struct NotifyList);
1344   n->callback = callback;
1345   n->callback_cls = callback_cls;
1346   GNUNET_CONTAINER_DLL_insert (server->disconnect_notify_list_head,
1347                                server->disconnect_notify_list_tail,
1348                                n);
1349 }
1350
1351
1352 /**
1353  * Ask the server to notify us whenever a client connects.
1354  * This function is called whenever the actual network connection
1355  * is opened. If the server is destroyed before this
1356  * notification is explicitly cancelled, the 'callback' will
1357  * once be called with a 'client' argument of NULL to indicate
1358  * that the server itself is now gone (and that the callback
1359  * won't be called anymore and also can no longer be cancelled).
1360  *
1361  * @param server the server manageing the clients
1362  * @param callback function to call on sconnect
1363  * @param callback_cls closure for @a callback
1364  */
1365 void
1366 GNUNET_SERVER_connect_notify (struct GNUNET_SERVER_Handle *server,
1367                               GNUNET_SERVER_ConnectCallback callback,
1368                               void *callback_cls)
1369 {
1370   struct NotifyList *n;
1371
1372   n = GNUNET_new (struct NotifyList);
1373   n->callback = callback;
1374   n->callback_cls = callback_cls;
1375   GNUNET_CONTAINER_DLL_insert (server->connect_notify_list_head,
1376                                server->connect_notify_list_tail,
1377                                n);
1378 }
1379
1380
1381 /**
1382  * Ask the server to stop notifying us whenever a client connects.
1383  *
1384  * @param server the server manageing the clients
1385  * @param callback function to call on connect
1386  * @param callback_cls closure for @a callback
1387  */
1388 void
1389 GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1390                                         GNUNET_SERVER_DisconnectCallback
1391                                         callback, void *callback_cls)
1392 {
1393   struct NotifyList *pos;
1394
1395   for (pos = server->disconnect_notify_list_head; NULL != pos; pos = pos->next)
1396     if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1397       break;
1398   if (NULL == pos)
1399   {
1400     GNUNET_break (0);
1401     return;
1402   }
1403   GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
1404                                server->disconnect_notify_list_tail,
1405                                pos);
1406   GNUNET_free (pos);
1407 }
1408
1409
1410 /**
1411  * Ask the server to stop notifying us whenever a client disconnects.
1412  *
1413  * @param server the server manageing the clients
1414  * @param callback function to call on disconnect
1415  * @param callback_cls closure for @a callback
1416  */
1417 void
1418 GNUNET_SERVER_connect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1419                                      GNUNET_SERVER_ConnectCallback callback,
1420                                      void *callback_cls)
1421 {
1422   struct NotifyList *pos;
1423
1424   for (pos = server->connect_notify_list_head; NULL != pos; pos = pos->next)
1425     if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1426       break;
1427   if (NULL == pos)
1428   {
1429     GNUNET_break (0);
1430     return;
1431   }
1432   GNUNET_CONTAINER_DLL_remove (server->connect_notify_list_head,
1433                                server->connect_notify_list_tail,
1434                                pos);
1435   GNUNET_free (pos);
1436 }
1437
1438
1439 /**
1440  * Destroy the connection that is passed in via @a cls.  Used
1441  * as calling #GNUNET_CONNECTION_destroy from within a function
1442  * that was itself called from within 'process_notify' of
1443  * 'connection.c' is not allowed (see #2329).
1444  *
1445  * @param cls connection to destroy
1446  * @param tc scheduler context (unused)
1447  */
1448 static void
1449 destroy_connection (void *cls,
1450                     const struct GNUNET_SCHEDULER_TaskContext *tc)
1451 {
1452   struct GNUNET_CONNECTION_Handle *connection = cls;
1453
1454   GNUNET_CONNECTION_destroy (connection);
1455 }
1456
1457
1458 /**
1459  * Ask the server to disconnect from the given client.
1460  * This is the same as returning #GNUNET_SYSERR from a message
1461  * handler, except that it allows dropping of a client even
1462  * when not handling a message from that client.
1463  *
1464  * @param client the client to disconnect from
1465  */
1466 void
1467 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1468 {
1469   struct GNUNET_SERVER_Handle *server = client->server;
1470   struct NotifyList *n;
1471
1472   LOG (GNUNET_ERROR_TYPE_DEBUG,
1473        "Client is being disconnected from the server.\n");
1474   if (GNUNET_SCHEDULER_NO_TASK != client->restart_task)
1475   {
1476     GNUNET_SCHEDULER_cancel (client->restart_task);
1477     client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1478   }
1479   if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1480   {
1481     GNUNET_SCHEDULER_cancel (client->warn_task);
1482     client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1483   }
1484   if (GNUNET_YES == client->receive_pending)
1485   {
1486     GNUNET_CONNECTION_receive_cancel (client->connection);
1487     client->receive_pending = GNUNET_NO;
1488   }
1489   client->shutdown_now = GNUNET_YES;
1490   client->reference_count++; /* make sure nobody else clean up client... */
1491   if ( (NULL != client->mst) &&
1492        (NULL != server) )
1493   {
1494     GNUNET_CONTAINER_DLL_remove (server->clients_head,
1495                                  server->clients_tail,
1496                                  client);
1497     if (NULL != server->mst_destroy)
1498       server->mst_destroy (server->mst_cls, client->mst);
1499     else
1500       GNUNET_SERVER_mst_destroy (client->mst);
1501     client->mst = NULL;
1502     for (n = server->disconnect_notify_list_head; NULL != n; n = n->next)
1503       n->callback (n->callback_cls, client);
1504   }
1505   client->reference_count--;
1506   if (client->reference_count > 0)
1507   {
1508     LOG (GNUNET_ERROR_TYPE_DEBUG,
1509          "RC still positive, not destroying everything.\n");
1510     client->server = NULL;
1511     return;
1512   }
1513   if (GNUNET_YES == client->in_process_client_buffer)
1514   {
1515     LOG (GNUNET_ERROR_TYPE_DEBUG,
1516          "Still processing inputs, not destroying everything.\n");
1517     return;
1518   }
1519   if (GNUNET_YES == client->persist)
1520     GNUNET_CONNECTION_persist_ (client->connection);
1521   if (NULL != client->th.cth)
1522     GNUNET_SERVER_notify_transmit_ready_cancel (&client->th);
1523   (void) GNUNET_SCHEDULER_add_now (&destroy_connection,
1524                                    client->connection);
1525   /* need to cancel again, as it might have been re-added
1526      in the meantime (i.e. during callbacks) */
1527   if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1528   {
1529     GNUNET_SCHEDULER_cancel (client->warn_task);
1530     client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1531   }
1532   if (GNUNET_YES == client->receive_pending)
1533   {
1534     GNUNET_CONNECTION_receive_cancel (client->connection);
1535     client->receive_pending = GNUNET_NO;
1536   }
1537   GNUNET_free (client);
1538   /* we might be in soft-shutdown, test if we're done */
1539   if (NULL != server)
1540     test_monitor_clients (server);
1541 }
1542
1543
1544 /**
1545  * Disable the "CORK" feature for communication with the given client,
1546  * forcing the OS to immediately flush the buffer on transmission
1547  * instead of potentially buffering multiple messages.
1548  *
1549  * @param client handle to the client
1550  * @return GNUNET_OK on success
1551  */
1552 int
1553 GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client)
1554 {
1555   return GNUNET_CONNECTION_disable_corking (client->connection);
1556 }
1557
1558
1559 /**
1560  * Wrapper for transmission notification that calls the original
1561  * callback and update the last activity time for our connection.
1562  *
1563  * @param cls the 'struct GNUNET_SERVER_Client'
1564  * @param size number of bytes we can transmit
1565  * @param buf where to copy the message
1566  * @return number of bytes actually transmitted
1567  */
1568 static size_t
1569 transmit_ready_callback_wrapper (void *cls, size_t size, void *buf)
1570 {
1571   struct GNUNET_SERVER_Client *client = cls;
1572   GNUNET_CONNECTION_TransmitReadyNotify callback;
1573
1574   client->th.cth = NULL;
1575   callback = client->th.callback;
1576   client->th.callback = NULL;
1577   client->last_activity = GNUNET_TIME_absolute_get ();
1578   return callback (client->th.callback_cls, size, buf);
1579 }
1580
1581
1582 /**
1583  * Notify us when the server has enough space to transmit
1584  * a message of the given size to the given client.
1585  *
1586  * @param client client to transmit message to
1587  * @param size requested amount of buffer space
1588  * @param timeout after how long should we give up (and call
1589  *        notify with buf NULL and size 0)?
1590  * @param callback function to call when space is available
1591  * @param callback_cls closure for @a callback
1592  * @return non-NULL if the notify callback was queued; can be used
1593  *         to cancel the request using
1594  *         #GNUNET_SERVER_notify_transmit_ready_cancel.
1595  *         NULL if we are already going to notify someone else (busy)
1596  */
1597 struct GNUNET_SERVER_TransmitHandle *
1598 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1599                                      size_t size,
1600                                      struct GNUNET_TIME_Relative timeout,
1601                                      GNUNET_CONNECTION_TransmitReadyNotify
1602                                      callback, void *callback_cls)
1603 {
1604   if (NULL != client->th.callback)
1605     return NULL;
1606   client->th.callback_cls = callback_cls;
1607   client->th.callback = callback;
1608   client->th.cth = GNUNET_CONNECTION_notify_transmit_ready (client->connection, size,
1609                                                             timeout,
1610                                                             &transmit_ready_callback_wrapper,
1611                                                             client);
1612   return &client->th;
1613 }
1614
1615
1616 /**
1617  * Abort transmission request.
1618  *
1619  * @param th request to abort
1620  */
1621 void
1622 GNUNET_SERVER_notify_transmit_ready_cancel (struct GNUNET_SERVER_TransmitHandle *th)
1623 {
1624   GNUNET_CONNECTION_notify_transmit_ready_cancel (th->cth);
1625   th->cth = NULL;
1626   th->callback = NULL;
1627 }
1628
1629
1630 /**
1631  * Set the persistent flag on this client, used to setup client connection
1632  * to only be killed when the service it's connected to is actually dead.
1633  *
1634  * @param client the client to set the persistent flag on
1635  */
1636 void
1637 GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client)
1638 {
1639   client->persist = GNUNET_YES;
1640 }
1641
1642
1643 /**
1644  * Resume receiving from this client, we are done processing the
1645  * current request.  This function must be called from within each
1646  * GNUNET_SERVER_MessageCallback (or its respective continuations).
1647  *
1648  * @param client client we were processing a message of
1649  * @param success #GNUNET_OK to keep the connection open and
1650  *                          continue to receive
1651  *                #GNUNET_NO to close the connection (normal behavior)
1652  *                #GNUNET_SYSERR to close the connection (signal
1653  *                          serious error)
1654  */
1655 void
1656 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client,
1657                             int success)
1658 {
1659   if (NULL == client)
1660     return;
1661   GNUNET_assert (client->suspended > 0);
1662   client->suspended--;
1663   if (GNUNET_OK != success)
1664   {
1665     LOG (GNUNET_ERROR_TYPE_DEBUG,
1666          "GNUNET_SERVER_receive_done called with failure indication\n");
1667     if ( (client->reference_count > 0) || (client->suspended > 0) )
1668       client->shutdown_now = GNUNET_YES;
1669     else
1670       GNUNET_SERVER_client_disconnect (client);
1671     return;
1672   }
1673   if (client->suspended > 0)
1674   {
1675     LOG (GNUNET_ERROR_TYPE_DEBUG,
1676          "GNUNET_SERVER_receive_done called, but more clients pending\n");
1677     return;
1678   }
1679   if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1680   {
1681     GNUNET_SCHEDULER_cancel (client->warn_task);
1682     client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1683   }
1684   if (GNUNET_YES == client->in_process_client_buffer)
1685   {
1686     LOG (GNUNET_ERROR_TYPE_DEBUG,
1687          "GNUNET_SERVER_receive_done called while still in processing loop\n");
1688     return;
1689   }
1690   if ((NULL == client->server) || (GNUNET_YES == client->shutdown_now))
1691   {
1692     GNUNET_SERVER_client_disconnect (client);
1693     return;
1694   }
1695   LOG (GNUNET_ERROR_TYPE_DEBUG,
1696        "GNUNET_SERVER_receive_done causes restart in reading from the socket\n");
1697   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == client->restart_task);
1698   client->restart_task = GNUNET_SCHEDULER_add_now (&restart_processing, client);
1699 }
1700
1701
1702 /* end of server.c */