2 This file is part of GNUnet.
3 (C) 2009, 2012 Christian Grothoff (and other contributing authors)
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.
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.
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.
23 * @brief library for building GNUnet network servers
24 * @author Christian Grothoff
28 #include "gnunet_common.h"
29 #include "gnunet_util_lib.h"
30 #include "gnunet_protocols.h"
32 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
34 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
36 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
40 * List of arrays of message handlers.
45 * This is a linked list.
47 struct HandlerList *next;
50 * NULL-terminated array of handlers.
52 const struct GNUNET_SERVER_MessageHandler *handlers;
57 * List of arrays of message handlers.
62 * This is a doubly linked list.
64 struct NotifyList *next;
67 * This is a doubly linked list.
69 struct NotifyList *prev;
74 GNUNET_SERVER_DisconnectCallback callback;
77 * Closure for callback.
84 * @brief handle for a server
86 struct GNUNET_SERVER_Handle
89 * List of handlers for incoming messages.
91 struct HandlerList *handlers;
94 * Head of list of our current clients.
96 struct GNUNET_SERVER_Client *clients_head;
99 * Head of list of our current clients.
101 struct GNUNET_SERVER_Client *clients_tail;
104 * Head of linked list of functions to call on disconnects by clients.
106 struct NotifyList *disconnect_notify_list_head;
109 * Tail of linked list of functions to call on disconnects by clients.
111 struct NotifyList *disconnect_notify_list_tail;
114 * Function to call for access control.
116 GNUNET_CONNECTION_AccessCheck access;
119 * Closure for access.
124 * NULL-terminated array of sockets used to listen for new
127 struct GNUNET_NETWORK_Handle **listen_sockets;
130 * After how long should an idle connection time
133 struct GNUNET_TIME_Relative idle_timeout;
136 * Task scheduled to do the listening.
138 GNUNET_SCHEDULER_TaskIdentifier listen_task;
141 * Alternative function to create a MST instance.
143 GNUNET_SERVER_MstCreateCallback mst_create;
146 * Alternative function to destroy a MST instance.
148 GNUNET_SERVER_MstDestroyCallback mst_destroy;
151 * Alternative function to give data to a MST instance.
153 GNUNET_SERVER_MstReceiveCallback mst_receive;
156 * Closure for 'mst_'-callbacks.
161 * Do we ignore messages of types that we do not understand or do we
162 * require that a handler is found (and if not kill the connection)?
167 * Set to GNUNET_YES once we are in 'soft' shutdown where we wait for
168 * all non-monitor clients to disconnect before we call
169 * GNUNET_SERVER_destroy. See 'test_monitor_clients'. Set to
170 * GNUNET_SYSERR once the final destroy task has been scheduled
171 * (we cannot run it in the same task).
173 int in_soft_shutdown;
178 * Handle server returns for aborting transmission to a client.
180 struct GNUNET_SERVER_TransmitHandle
183 * Function to call to get the message.
185 GNUNET_CONNECTION_TransmitReadyNotify callback;
188 * Closure for 'callback'
193 * Active connection transmission handle.
195 struct GNUNET_CONNECTION_TransmitHandle *cth;
201 * @brief handle for a client of the server
203 struct GNUNET_SERVER_Client
207 * This is a doubly linked list.
209 struct GNUNET_SERVER_Client *next;
212 * This is a doubly linked list.
214 struct GNUNET_SERVER_Client *prev;
217 * Processing of incoming data.
222 * Server that this client belongs to.
224 struct GNUNET_SERVER_Handle *server;
227 * Client closure for callbacks.
229 struct GNUNET_CONNECTION_Handle *connection;
232 * ID of task used to restart processing.
234 GNUNET_SCHEDULER_TaskIdentifier restart_task;
237 * Task that warns about missing calls to 'GNUNET_SERVER_receive_done'.
239 GNUNET_SCHEDULER_TaskIdentifier warn_task;
242 * Time when the warn task was started.
244 struct GNUNET_TIME_Absolute warn_start;
247 * Last activity on this socket (used to time it out
248 * if reference_count == 0).
250 struct GNUNET_TIME_Absolute last_activity;
253 * Transmission handle we return for this client from
254 * GNUNET_SERVER_notify_transmit_ready.
256 struct GNUNET_SERVER_TransmitHandle th;
259 * After how long should an idle connection time
262 struct GNUNET_TIME_Relative idle_timeout;
265 * Number of external entities with a reference to
266 * this client object.
268 unsigned int reference_count;
271 * Was processing if incoming messages suspended while
272 * we were still processing data already received?
273 * This is a counter saying how often processing was
274 * suspended (once per handler invoked).
276 unsigned int suspended;
279 * Are we currently in the "process_client_buffer" function (and
280 * will hence restart the receive job on exit if suspended == 0 once
281 * we are done?). If this is set, then "receive_done" will
282 * essentially only decrement suspended; if this is not set, then
283 * "receive_done" may need to restart the receive process (either
284 * from the side-buffer or via select/recv).
286 int in_process_client_buffer;
289 * We're about to close down this client.
294 * Are we currently trying to receive? (YES if we are, NO if we are not,
295 * SYSERR if data is already available in MST).
300 * Finish pending write when disconnecting?
302 int finish_pending_write;
305 * Persist the file handle for this client no matter what happens,
306 * force the OS to close once the process actually dies. Should only
307 * be used in special cases!
312 * Is this client a 'monitor' client that should not be counted
313 * when deciding on destroying the server during soft shutdown?
314 * (see also GNUNET_SERVICE_start)
319 * Type of last message processed (for warn_no_receive_done).
326 * Scheduler says our listen socket is ready. Process it!
328 * @param cls handle to our server for which we are processing the listen
330 * @param tc reason why we are running right now
333 process_listen_socket (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
337 * Add a listen task with the scheduler for this server.
339 * @param server handle to our server for which we are adding the listen
343 schedule_listen_task (struct GNUNET_SERVER_Handle *server)
345 struct GNUNET_NETWORK_FDSet *r;
348 if (NULL == server->listen_sockets[0])
349 return; /* nothing to do, no listen sockets! */
350 if (NULL == server->listen_sockets[1])
352 /* simplified method: no fd set needed; this is then much simpler and
353 much more efficient */
354 server->listen_task =
355 GNUNET_SCHEDULER_add_read_net_with_priority (GNUNET_TIME_UNIT_FOREVER_REL,
356 GNUNET_SCHEDULER_PRIORITY_HIGH,
357 server->listen_sockets[0],
358 &process_listen_socket, server);
361 r = GNUNET_NETWORK_fdset_create ();
363 while (NULL != server->listen_sockets[i])
364 GNUNET_NETWORK_fdset_set (r, server->listen_sockets[i++]);
365 server->listen_task =
366 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
367 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
368 &process_listen_socket, server);
369 GNUNET_NETWORK_fdset_destroy (r);
374 * Scheduler says our listen socket is ready. Process it!
376 * @param cls handle to our server for which we are processing the listen
378 * @param tc reason why we are running right now
381 process_listen_socket (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
383 struct GNUNET_SERVER_Handle *server = cls;
384 struct GNUNET_CONNECTION_Handle *sock;
385 struct GNUNET_SERVER_Client *client;
388 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
389 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
391 /* ignore shutdown, someone else will take care of it! */
392 schedule_listen_task (server);
396 while (NULL != server->listen_sockets[i])
398 if (GNUNET_NETWORK_fdset_isset (tc->read_ready, server->listen_sockets[i]))
401 GNUNET_CONNECTION_create_from_accept (server->access,
403 server->listen_sockets[i]);
406 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server accepted incoming connection.\n");
407 client = GNUNET_SERVER_connect_socket (server, sock);
408 /* decrement reference count, we don't keep "client" alive */
409 GNUNET_SERVER_client_drop (client);
414 /* listen for more! */
415 schedule_listen_task (server);
420 * Create and initialize a listen socket for the server.
422 * @param serverAddr address to listen on
423 * @param socklen length of address
424 * @return NULL on error, otherwise the listen socket
426 static struct GNUNET_NETWORK_Handle *
427 open_listen_socket (const struct sockaddr *serverAddr, socklen_t socklen)
430 struct GNUNET_NETWORK_Handle *sock;
434 switch (serverAddr->sa_family)
437 port = ntohs (((const struct sockaddr_in *) serverAddr)->sin_port);
440 port = ntohs (((const struct sockaddr_in6 *) serverAddr)->sin6_port);
450 sock = GNUNET_NETWORK_socket_create (serverAddr->sa_family, SOCK_STREAM, 0);
453 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket");
459 if (GNUNET_NETWORK_socket_setsockopt
460 (sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof (on)) != GNUNET_OK)
461 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
464 if ((AF_INET6 == serverAddr->sa_family) &&
465 (GNUNET_NETWORK_socket_setsockopt
466 (sock, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof (on)) != GNUNET_OK))
467 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
471 /* bind the socket */
472 if (GNUNET_OK != GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen))
475 if (EADDRINUSE != errno)
477 /* we don't log 'EADDRINUSE' here since an IPv4 bind may
478 * fail if we already took the port on IPv6; if both IPv4 and
479 * IPv6 binds fail, then our caller will log using the
480 * errno preserved in 'eno' */
481 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "bind");
483 LOG (GNUNET_ERROR_TYPE_ERROR, _("`%s' failed for port %d (%s).\n"),
485 (AF_INET == serverAddr->sa_family) ? "IPv4" : "IPv6");
491 LOG (GNUNET_ERROR_TYPE_WARNING,
492 _("`%s' failed for port %d (%s): address already in use\n"),
494 (AF_INET == serverAddr->sa_family) ? "IPv4" : "IPv6");
495 else if (AF_UNIX == serverAddr->sa_family)
496 LOG (GNUNET_ERROR_TYPE_WARNING,
497 _("`%s' failed for `%s': address already in use\n"), "bind",
498 ((const struct sockaddr_un *) serverAddr)->sun_path);
501 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
505 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
507 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "listen");
508 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
513 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server starts to listen on port %u.\n",
520 * Create a new server.
522 * @param access function for access control
523 * @param access_cls closure for access
524 * @param lsocks NULL-terminated array of listen sockets
525 * @param idle_timeout after how long should we timeout idle connections?
526 * @param require_found if YES, connections sending messages of unknown type
528 * @return handle for the new server, NULL on error
529 * (typically, "port" already in use)
531 struct GNUNET_SERVER_Handle *
532 GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access,
534 struct GNUNET_NETWORK_Handle **lsocks,
535 struct GNUNET_TIME_Relative idle_timeout,
538 struct GNUNET_SERVER_Handle *server;
540 server = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
541 server->idle_timeout = idle_timeout;
542 server->listen_sockets = lsocks;
543 server->access = access;
544 server->access_cls = access_cls;
545 server->require_found = require_found;
547 schedule_listen_task (server);
553 * Create a new server.
555 * @param access function for access control
556 * @param access_cls closure for access
557 * @param serverAddr address to listen on (including port), NULL terminated array
558 * @param socklen length of serverAddr
559 * @param idle_timeout after how long should we timeout idle connections?
560 * @param require_found if YES, connections sending messages of unknown type
562 * @return handle for the new server, NULL on error
563 * (typically, "port" already in use)
565 struct GNUNET_SERVER_Handle *
566 GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access, void *access_cls,
567 struct sockaddr *const *serverAddr,
568 const socklen_t * socklen,
569 struct GNUNET_TIME_Relative idle_timeout,
572 struct GNUNET_NETWORK_Handle **lsocks;
579 while (NULL != serverAddr[i])
583 lsocks = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (i + 1));
586 while (NULL != serverAddr[i])
590 if ( (socklen[k] == socklen[i]) &&
591 (0 == memcmp (serverAddr[k], serverAddr[i], socklen[i])) )
598 /* duplicate address, skip */
602 lsocks[j] = open_listen_socket (serverAddr[i], socklen[i]);
603 if (NULL != lsocks[j])
610 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "bind");
611 GNUNET_free (lsocks);
619 return GNUNET_SERVER_create_with_sockets (access, access_cls, lsocks,
620 idle_timeout, require_found);
625 * Set the 'monitor' flag on this client. Clients which have been
626 * marked as 'monitors' won't prevent the server from shutting down
627 * once 'GNUNET_SERVER_stop_listening' has been invoked. The idea is
628 * that for "normal" clients we likely want to allow them to process
629 * their requests; however, monitor-clients are likely to 'never'
630 * disconnect during shutdown and thus will not be considered when
631 * determining if the server should continue to exist after
632 * 'GNUNET_SERVER_destroy' has been called.
634 * @param client the client to set the 'monitor' flag on
637 GNUNET_SERVER_client_mark_monitor (struct GNUNET_SERVER_Client *client)
639 client->is_monitor = GNUNET_YES;
644 * Helper function for 'test_monitor_clients' to trigger
645 * 'GNUNET_SERVER_destroy' after the stack has unwound.
647 * @param cls the 'struct GNUNET_SERVER_Handle' to destroy
651 do_destroy (void *cls,
652 const struct GNUNET_SCHEDULER_TaskContext *tc)
654 struct GNUNET_SERVER_Handle *server = cls;
655 GNUNET_SERVER_destroy (server);
660 * Check if only 'monitor' clients are left. If so, destroy the
663 * @param server server to test for full shutdown
666 test_monitor_clients (struct GNUNET_SERVER_Handle *server)
668 struct GNUNET_SERVER_Client *client;
670 if (GNUNET_YES != server->in_soft_shutdown)
672 for (client = server->clients_head; NULL != client; client = client->next)
673 if (GNUNET_NO == client->is_monitor)
674 return; /* not done yet */
675 server->in_soft_shutdown = GNUNET_SYSERR;
676 GNUNET_SCHEDULER_add_continuation (&do_destroy, server,
677 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
682 * Stop the listen socket and get ready to shutdown the server
683 * once only 'monitor' clients are left.
685 * @param server server to stop listening on
688 GNUNET_SERVER_stop_listening (struct GNUNET_SERVER_Handle *server)
692 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server in soft shutdown\n");
693 if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
695 GNUNET_SCHEDULER_cancel (server->listen_task);
696 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
698 if (NULL != server->listen_sockets)
701 while (NULL != server->listen_sockets[i])
702 GNUNET_break (GNUNET_OK ==
703 GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
704 GNUNET_free (server->listen_sockets);
705 server->listen_sockets = NULL;
707 if (GNUNET_NO == server->in_soft_shutdown)
708 server->in_soft_shutdown = GNUNET_YES;
709 test_monitor_clients (server);
714 * Free resources held by this server.
716 * @param server server to destroy
719 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *server)
721 struct HandlerList *hpos;
722 struct NotifyList *npos;
725 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server shutting down.\n");
726 if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
728 GNUNET_SCHEDULER_cancel (server->listen_task);
729 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
731 if (NULL != server->listen_sockets)
734 while (NULL != server->listen_sockets[i])
735 GNUNET_break (GNUNET_OK ==
736 GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
737 GNUNET_free (server->listen_sockets);
738 server->listen_sockets = NULL;
740 while (NULL != server->clients_head)
741 GNUNET_SERVER_client_disconnect (server->clients_head);
742 while (NULL != (hpos = server->handlers))
744 server->handlers = hpos->next;
747 while (NULL != (npos = server->disconnect_notify_list_head))
749 npos->callback (npos->callback_cls, NULL);
750 GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
751 server->disconnect_notify_list_tail,
755 GNUNET_free (server);
760 * Add additional handlers to an existing server.
762 * @param server the server to add handlers to
763 * @param handlers array of message handlers for
764 * incoming messages; the last entry must
765 * have "NULL" for the "callback"; multiple
766 * entries for the same type are allowed,
767 * they will be called in order of occurence.
768 * These handlers can be removed later;
769 * the handlers array must exist until removed
770 * (or server is destroyed).
773 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
774 const struct GNUNET_SERVER_MessageHandler *handlers)
776 struct HandlerList *p;
778 p = GNUNET_malloc (sizeof (struct HandlerList));
779 p->handlers = handlers;
780 p->next = server->handlers;
781 server->handlers = p;
786 * Change functions used by the server to tokenize the message stream.
787 * (very rarely used).
789 * @param server server to modify
790 * @param create new tokenizer initialization function
791 * @param destroy new tokenizer destruction function
792 * @param receive new tokenizer receive function
793 * @param cls closure for 'create', 'receive', 'destroy'
796 GNUNET_SERVER_set_callbacks (struct GNUNET_SERVER_Handle *server,
797 GNUNET_SERVER_MstCreateCallback create,
798 GNUNET_SERVER_MstDestroyCallback destroy,
799 GNUNET_SERVER_MstReceiveCallback receive,
802 server->mst_create = create;
803 server->mst_destroy = destroy;
804 server->mst_receive = receive;
805 server->mst_cls = cls;
810 * Task run to warn about missing calls to 'GNUNET_SERVER_receive_done'.
812 * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
813 * @param tc scheduler context (unused)
816 warn_no_receive_done (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
818 struct GNUNET_SERVER_Client *client = cls;
820 GNUNET_break (0 != client->warn_type); /* type should never be 0 here, as we don't use 0 */
822 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
823 &warn_no_receive_done, client);
824 if (0 == (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
825 LOG (GNUNET_ERROR_TYPE_WARNING,
827 ("Processing code for message of type %u did not call GNUNET_SERVER_receive_done after %llums\n"),
828 (unsigned int) client->warn_type,
830 GNUNET_TIME_absolute_get_duration (client->warn_start).rel_value);
835 * Disable the warning the server issues if a message is not acknowledged
836 * in a timely fashion. Use this call if a client is intentionally delayed
837 * for a while. Only applies to the current message.
839 * @param client client for which to disable the warning
842 GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client *client)
844 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
846 GNUNET_SCHEDULER_cancel (client->warn_task);
847 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
853 * Inject a message into the server, pretend it came
854 * from the specified client. Delivery of the message
855 * will happen instantly (if a handler is installed;
856 * otherwise the call does nothing).
858 * @param server the server receiving the message
859 * @param sender the "pretended" sender of the message
861 * @param message message to transmit
862 * @return GNUNET_OK if the message was OK and the
863 * connection can stay open
864 * GNUNET_SYSERR if the connection to the
865 * client should be shut down
868 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
869 struct GNUNET_SERVER_Client *sender,
870 const struct GNUNET_MessageHeader *message)
872 struct HandlerList *pos;
873 const struct GNUNET_SERVER_MessageHandler *mh;
879 type = ntohs (message->type);
880 size = ntohs (message->size);
881 LOG (GNUNET_ERROR_TYPE_DEBUG,
882 "Server schedules transmission of %u-byte message of type %u to client.\n",
885 for (pos = server->handlers; NULL != pos; pos = pos->next)
888 while (pos->handlers[i].callback != NULL)
890 mh = &pos->handlers[i];
891 if ((mh->type == type) || (mh->type == GNUNET_MESSAGE_TYPE_ALL))
893 if ((0 != mh->expected_size) && (mh->expected_size != size))
895 #if GNUNET8_NETWORK_IS_DEAD
896 LOG (GNUNET_ERROR_TYPE_WARNING,
897 "Expected %u bytes for message of type %u, got %u\n",
898 mh->expected_size, mh->type, size);
901 return GNUNET_SYSERR;
905 if ( (0 == sender->suspended) &&
906 (GNUNET_SCHEDULER_NO_TASK == sender->warn_task) )
908 GNUNET_break (0 != type); /* type should never be 0 here, as we don't use 0 */
909 sender->warn_start = GNUNET_TIME_absolute_get ();
911 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
912 &warn_no_receive_done, sender);
913 sender->warn_type = type;
917 mh->callback (mh->callback_cls, sender, message);
923 if (GNUNET_NO == found)
925 LOG (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
926 "Received message of unknown type %d\n", type);
927 if (GNUNET_YES == server->require_found)
928 return GNUNET_SYSERR;
935 * We are receiving an incoming message. Process it.
937 * @param cls our closure (handle for the client)
938 * @param buf buffer with data received from network
939 * @param available number of bytes available in buf
940 * @param addr address of the sender
941 * @param addrlen length of addr
942 * @param errCode code indicating errors receiving, 0 for success
945 process_incoming (void *cls, const void *buf, size_t available,
946 const struct sockaddr *addr, socklen_t addrlen, int errCode);
950 * Process messages from the client's message tokenizer until either
951 * the tokenizer is empty (and then schedule receiving more), or
952 * until some handler is not immediately done (then wait for restart_processing)
955 * @param client the client to process, RC must have already been increased
956 * using GNUNET_SERVER_client_keep and will be decreased by one in this
958 * @param ret GNUNET_NO to start processing from the buffer,
959 * GNUNET_OK if the mst buffer is drained and we should instantly go back to receiving
960 * GNUNET_SYSERR if we should instantly abort due to error in a previous step
963 process_mst (struct GNUNET_SERVER_Client *client, int ret)
965 while ((GNUNET_SYSERR != ret) && (NULL != client->server) &&
966 (GNUNET_YES != client->shutdown_now) && (0 == client->suspended))
968 if (GNUNET_OK == ret)
970 LOG (GNUNET_ERROR_TYPE_DEBUG,
971 "Server re-enters receive loop, timeout: %llu.\n",
972 client->idle_timeout.rel_value);
973 client->receive_pending = GNUNET_YES;
974 GNUNET_CONNECTION_receive (client->connection,
975 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
976 client->idle_timeout, &process_incoming,
980 LOG (GNUNET_ERROR_TYPE_DEBUG,
981 "Server processes additional messages instantly.\n");
982 if (NULL != client->server->mst_receive)
984 client->server->mst_receive (client->server->mst_cls, client->mst,
985 client, NULL, 0, GNUNET_NO, GNUNET_YES);
988 GNUNET_SERVER_mst_receive (client->mst, client, NULL, 0, GNUNET_NO,
991 LOG (GNUNET_ERROR_TYPE_DEBUG,
992 "Server leaves instant processing loop: ret = %d, server = %p, shutdown = %d, suspended = %u\n",
993 ret, client->server, client->shutdown_now, client->suspended);
994 if (GNUNET_NO == ret)
996 LOG (GNUNET_ERROR_TYPE_DEBUG,
997 "Server has more data pending but is suspended.\n");
998 client->receive_pending = GNUNET_SYSERR; /* data pending */
1000 if ((GNUNET_SYSERR == ret) || (GNUNET_YES == client->shutdown_now))
1001 GNUNET_SERVER_client_disconnect (client);
1006 * We are receiving an incoming message. Process it.
1008 * @param cls our closure (handle for the client)
1009 * @param buf buffer with data received from network
1010 * @param available number of bytes available in buf
1011 * @param addr address of the sender
1012 * @param addrlen length of addr
1013 * @param errCode code indicating errors receiving, 0 for success
1016 process_incoming (void *cls, const void *buf, size_t available,
1017 const struct sockaddr *addr, socklen_t addrlen, int errCode)
1019 struct GNUNET_SERVER_Client *client = cls;
1020 struct GNUNET_SERVER_Handle *server = client->server;
1021 struct GNUNET_TIME_Absolute end;
1022 struct GNUNET_TIME_Absolute now;
1025 GNUNET_assert (GNUNET_YES == client->receive_pending);
1026 client->receive_pending = GNUNET_NO;
1027 now = GNUNET_TIME_absolute_get ();
1028 end = GNUNET_TIME_absolute_add (client->last_activity, client->idle_timeout);
1030 if ((NULL == buf) && (0 == available) && (NULL == addr) && (0 == errCode) &&
1031 (GNUNET_YES != client->shutdown_now) && (NULL != server) &&
1032 (GNUNET_YES == GNUNET_CONNECTION_check (client->connection)) &&
1033 (end.abs_value > now.abs_value))
1035 /* wait longer, timeout changed (i.e. due to us sending) */
1036 LOG (GNUNET_ERROR_TYPE_DEBUG,
1037 "Receive time out, but no disconnect due to sending (%p)\n",
1038 GNUNET_a2s (addr, addrlen));
1039 client->receive_pending = GNUNET_YES;
1040 GNUNET_CONNECTION_receive (client->connection,
1041 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1042 GNUNET_TIME_absolute_get_remaining (end),
1043 &process_incoming, client);
1046 if ((NULL == buf) || (0 == available) || (0 != errCode) || (NULL == server) ||
1047 (GNUNET_YES == client->shutdown_now) ||
1048 (GNUNET_YES != GNUNET_CONNECTION_check (client->connection)))
1050 /* other side closed connection, error connecting, etc. */
1051 GNUNET_SERVER_client_disconnect (client);
1054 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server receives %u bytes from `%s'.\n",
1055 (unsigned int) available, GNUNET_a2s (addr, addrlen));
1056 GNUNET_SERVER_client_keep (client);
1057 client->last_activity = now;
1059 if (NULL != server->mst_receive)
1061 client->server->mst_receive (client->server->mst_cls, client->mst,
1062 client, buf, available, GNUNET_NO, GNUNET_YES);
1063 else if (NULL != client->mst)
1066 GNUNET_SERVER_mst_receive (client->mst, client, buf, available, GNUNET_NO,
1075 process_mst (client, ret);
1076 GNUNET_SERVER_client_drop (client);
1081 * Task run to start again receiving from the network
1082 * and process requests.
1084 * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
1085 * @param tc scheduler context (unused)
1088 restart_processing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1090 struct GNUNET_SERVER_Client *client = cls;
1092 GNUNET_assert (GNUNET_YES != client->shutdown_now);
1093 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1094 if (GNUNET_NO == client->receive_pending)
1096 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server begins to read again from client.\n");
1097 client->receive_pending = GNUNET_YES;
1098 GNUNET_CONNECTION_receive (client->connection,
1099 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1100 client->idle_timeout, &process_incoming, client);
1103 LOG (GNUNET_ERROR_TYPE_DEBUG,
1104 "Server continues processing messages still in the buffer.\n");
1105 GNUNET_SERVER_client_keep (client);
1106 client->receive_pending = GNUNET_NO;
1107 process_mst (client, GNUNET_NO);
1108 GNUNET_SERVER_client_drop (client);
1113 * This function is called whenever our inbound message tokenizer has
1114 * received a complete message.
1116 * @param cls closure (struct GNUNET_SERVER_Handle)
1117 * @param client identification of the client (struct GNUNET_SERVER_Client*)
1118 * @param message the actual message
1120 * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
1123 client_message_tokenizer_callback (void *cls, void *client,
1124 const struct GNUNET_MessageHeader *message)
1126 struct GNUNET_SERVER_Handle *server = cls;
1127 struct GNUNET_SERVER_Client *sender = client;
1130 LOG (GNUNET_ERROR_TYPE_DEBUG,
1131 "Tokenizer gives server message of type %u from client\n",
1132 ntohs (message->type));
1133 sender->in_process_client_buffer = GNUNET_YES;
1134 ret = GNUNET_SERVER_inject (server, sender, message);
1135 sender->in_process_client_buffer = GNUNET_NO;
1136 if ( (GNUNET_OK != ret) || (GNUNET_YES == sender->shutdown_now) )
1138 GNUNET_SERVER_client_disconnect (sender);
1139 return GNUNET_SYSERR;
1146 * Add a TCP socket-based connection to the set of handles managed by
1147 * this server. Use this function for outgoing (P2P) connections that
1148 * we initiated (and where this server should process incoming
1151 * @param server the server to use
1152 * @param connection the connection to manage (client must
1153 * stop using this connection from now on)
1154 * @return the client handle (client should call
1155 * "client_drop" on the return value eventually)
1157 struct GNUNET_SERVER_Client *
1158 GNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server,
1159 struct GNUNET_CONNECTION_Handle *connection)
1161 struct GNUNET_SERVER_Client *client;
1163 client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
1164 client->connection = connection;
1165 client->reference_count = 1;
1166 client->server = server;
1167 client->last_activity = GNUNET_TIME_absolute_get ();
1168 client->idle_timeout = server->idle_timeout;
1169 GNUNET_CONTAINER_DLL_insert (server->clients_head,
1170 server->clients_tail,
1172 if (NULL != server->mst_create)
1174 server->mst_create (server->mst_cls, client);
1177 GNUNET_SERVER_mst_create (&client_message_tokenizer_callback, server);
1178 GNUNET_assert (NULL != client->mst);
1179 client->receive_pending = GNUNET_YES;
1180 GNUNET_CONNECTION_receive (client->connection,
1181 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1182 client->idle_timeout, &process_incoming, client);
1188 * Change the timeout for a particular client. Decreasing the timeout
1189 * may not go into effect immediately (only after the previous timeout
1190 * times out or activity happens on the socket).
1192 * @param client the client to update
1193 * @param timeout new timeout for activities on the socket
1196 GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client,
1197 struct GNUNET_TIME_Relative timeout)
1199 client->idle_timeout = timeout;
1204 * Notify the server that the given client handle should
1205 * be kept (keeps the connection up if possible, increments
1206 * the internal reference counter).
1208 * @param client the client to keep
1211 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
1213 client->reference_count++;
1218 * Notify the server that the given client handle is no
1219 * longer required. Decrements the reference counter. If
1220 * that counter reaches zero an inactive connection maybe
1223 * @param client the client to drop
1226 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1228 GNUNET_assert (client->reference_count > 0);
1229 client->reference_count--;
1230 if ((GNUNET_YES == client->shutdown_now) && (0 == client->reference_count))
1231 GNUNET_SERVER_client_disconnect (client);
1236 * Obtain the network address of the other party.
1238 * @param client the client to get the address for
1239 * @param addr where to store the address
1240 * @param addrlen where to store the length of the address
1241 * @return GNUNET_OK on success
1244 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1245 void **addr, size_t * addrlen)
1247 return GNUNET_CONNECTION_get_address (client->connection, addr, addrlen);
1252 * Ask the server to notify us whenever a client disconnects.
1253 * This function is called whenever the actual network connection
1254 * is closed; the reference count may be zero or larger than zero
1257 * @param server the server manageing the clients
1258 * @param callback function to call on disconnect
1259 * @param callback_cls closure for callback
1262 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1263 GNUNET_SERVER_DisconnectCallback callback,
1266 struct NotifyList *n;
1268 n = GNUNET_malloc (sizeof (struct NotifyList));
1269 n->callback = callback;
1270 n->callback_cls = callback_cls;
1271 GNUNET_CONTAINER_DLL_insert (server->disconnect_notify_list_head,
1272 server->disconnect_notify_list_tail,
1278 * Ask the server to stop notifying us whenever a client disconnects.
1280 * @param server the server manageing the clients
1281 * @param callback function to call on disconnect
1282 * @param callback_cls closure for callback
1285 GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1286 GNUNET_SERVER_DisconnectCallback
1287 callback, void *callback_cls)
1289 struct NotifyList *pos;
1291 for (pos = server->disconnect_notify_list_head; NULL != pos; pos = pos->next)
1292 if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1299 GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
1300 server->disconnect_notify_list_tail,
1307 * Destroy the connection that is passed in via 'cls'. Used
1308 * as calling 'GNUNET_CONNECTION_destroy' from within a function
1309 * that was itself called from within 'process_notify' of
1310 * 'connection.c' is not allowed (see #2329).
1312 * @param cls connection to destroy
1313 * @param tc scheduler context (unused)
1316 destroy_connection (void *cls,
1317 const struct GNUNET_SCHEDULER_TaskContext *tc)
1319 struct GNUNET_CONNECTION_Handle *connection = cls;
1321 GNUNET_CONNECTION_destroy (connection);
1326 * Ask the server to disconnect from the given client.
1327 * This is the same as returning GNUNET_SYSERR from a message
1328 * handler, except that it allows dropping of a client even
1329 * when not handling a message from that client.
1331 * @param client the client to disconnect from
1334 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1336 struct GNUNET_SERVER_Handle *server = client->server;
1337 struct NotifyList *n;
1339 LOG (GNUNET_ERROR_TYPE_DEBUG,
1340 "Client is being disconnected from the server.\n");
1341 if (GNUNET_SCHEDULER_NO_TASK != client->restart_task)
1343 GNUNET_SCHEDULER_cancel (client->restart_task);
1344 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1346 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1348 GNUNET_SCHEDULER_cancel (client->warn_task);
1349 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1351 if (GNUNET_YES == client->receive_pending)
1353 GNUNET_CONNECTION_receive_cancel (client->connection);
1354 client->receive_pending = GNUNET_NO;
1356 client->shutdown_now = GNUNET_YES;
1357 client->reference_count++; /* make sure nobody else clean up client... */
1358 if ( (NULL != client->mst) &&
1361 GNUNET_CONTAINER_DLL_remove (server->clients_head,
1362 server->clients_tail,
1364 if (NULL != server->mst_destroy)
1365 server->mst_destroy (server->mst_cls, client->mst);
1367 GNUNET_SERVER_mst_destroy (client->mst);
1369 for (n = server->disconnect_notify_list_head; NULL != n; n = n->next)
1370 n->callback (n->callback_cls, client);
1372 client->reference_count--;
1373 if (client->reference_count > 0)
1375 LOG (GNUNET_ERROR_TYPE_DEBUG,
1376 "RC still positive, not destroying everything.\n");
1377 client->server = NULL;
1380 if (GNUNET_YES == client->in_process_client_buffer)
1382 LOG (GNUNET_ERROR_TYPE_DEBUG,
1383 "Still processing inputs, not destroying everything.\n");
1386 if (GNUNET_YES == client->persist)
1387 GNUNET_CONNECTION_persist_ (client->connection);
1388 if (NULL != client->th.cth)
1389 GNUNET_SERVER_notify_transmit_ready_cancel (&client->th);
1390 (void) GNUNET_SCHEDULER_add_now (&destroy_connection,
1391 client->connection);
1392 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == client->warn_task);
1393 GNUNET_assert (GNUNET_NO == client->receive_pending);
1394 GNUNET_free (client);
1395 /* we might be in soft-shutdown, test if we're done */
1397 test_monitor_clients (server);
1402 * Disable the "CORK" feature for communication with the given client,
1403 * forcing the OS to immediately flush the buffer on transmission
1404 * instead of potentially buffering multiple messages.
1406 * @param client handle to the client
1407 * @return GNUNET_OK on success
1410 GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client)
1412 return GNUNET_CONNECTION_disable_corking (client->connection);
1417 * Wrapper for transmission notification that calls the original
1418 * callback and update the last activity time for our connection.
1420 * @param cls the 'struct GNUNET_SERVER_Client'
1421 * @param size number of bytes we can transmit
1422 * @param buf where to copy the message
1423 * @return number of bytes actually transmitted
1426 transmit_ready_callback_wrapper (void *cls, size_t size, void *buf)
1428 struct GNUNET_SERVER_Client *client = cls;
1429 GNUNET_CONNECTION_TransmitReadyNotify callback;
1431 client->th.cth = NULL;
1432 callback = client->th.callback;
1433 client->th.callback = NULL;
1434 client->last_activity = GNUNET_TIME_absolute_get ();
1435 return callback (client->th.callback_cls, size, buf);
1440 * Notify us when the server has enough space to transmit
1441 * a message of the given size to the given client.
1443 * @param client client to transmit message to
1444 * @param size requested amount of buffer space
1445 * @param timeout after how long should we give up (and call
1446 * notify with buf NULL and size 0)?
1447 * @param callback function to call when space is available
1448 * @param callback_cls closure for callback
1449 * @return non-NULL if the notify callback was queued; can be used
1450 * to cancel the request using
1451 * GNUNET_SERVER_notify_transmit_ready_cancel.
1452 * NULL if we are already going to notify someone else (busy)
1454 struct GNUNET_SERVER_TransmitHandle *
1455 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1457 struct GNUNET_TIME_Relative timeout,
1458 GNUNET_CONNECTION_TransmitReadyNotify
1459 callback, void *callback_cls)
1461 if (NULL != client->th.callback)
1463 client->th.callback_cls = callback_cls;
1464 client->th.callback = callback;
1465 client->th.cth = GNUNET_CONNECTION_notify_transmit_ready (client->connection, size,
1467 &transmit_ready_callback_wrapper,
1474 * Abort transmission request.
1476 * @param th request to abort
1479 GNUNET_SERVER_notify_transmit_ready_cancel (struct GNUNET_SERVER_TransmitHandle *th)
1481 GNUNET_CONNECTION_notify_transmit_ready_cancel (th->cth);
1483 th->callback = NULL;
1488 * Set the persistent flag on this client, used to setup client connection
1489 * to only be killed when the service it's connected to is actually dead.
1491 * @param client the client to set the persistent flag on
1494 GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client)
1496 client->persist = GNUNET_YES;
1501 * Resume receiving from this client, we are done processing the
1502 * current request. This function must be called from within each
1503 * GNUNET_SERVER_MessageCallback (or its respective continuations).
1505 * @param client client we were processing a message of
1506 * @param success GNUNET_OK to keep the connection open and
1507 * continue to receive
1508 * GNUNET_NO to close the connection (normal behavior)
1509 * GNUNET_SYSERR to close the connection (signal
1513 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success)
1517 GNUNET_assert (client->suspended > 0);
1518 client->suspended--;
1519 if (GNUNET_OK != success)
1521 LOG (GNUNET_ERROR_TYPE_DEBUG,
1522 "GNUNET_SERVER_receive_done called with failure indication\n");
1523 if ( (client->reference_count > 0) || (client->suspended > 0) )
1524 client->shutdown_now = GNUNET_YES;
1526 GNUNET_SERVER_client_disconnect (client);
1529 if (client->suspended > 0)
1531 LOG (GNUNET_ERROR_TYPE_DEBUG,
1532 "GNUNET_SERVER_receive_done called, but more clients pending\n");
1535 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1537 GNUNET_SCHEDULER_cancel (client->warn_task);
1538 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1540 if (GNUNET_YES == client->in_process_client_buffer)
1542 LOG (GNUNET_ERROR_TYPE_DEBUG,
1543 "GNUNET_SERVER_receive_done called while still in processing loop\n");
1546 if ((NULL == client->server) || (GNUNET_YES == client->shutdown_now))
1548 GNUNET_SERVER_client_disconnect (client);
1551 LOG (GNUNET_ERROR_TYPE_DEBUG,
1552 "GNUNET_SERVER_receive_done causes restart in reading from the socket\n");
1553 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == client->restart_task);
1554 client->restart_task = GNUNET_SCHEDULER_add_now (&restart_processing, client);
1558 /* end of server.c */