2 This file is part of GNUnet.
3 (C) 2009 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_connection_lib.h"
30 #include "gnunet_scheduler_lib.h"
31 #include "gnunet_server_lib.h"
32 #include "gnunet_time_lib.h"
33 #include "gnunet_disk_lib.h"
34 #include "gnunet_protocols.h"
36 #define DEBUG_SERVER GNUNET_NO
39 * List of arrays of message handlers.
44 * This is a linked list.
46 struct HandlerList *next;
49 * NULL-terminated array of handlers.
51 const struct GNUNET_SERVER_MessageHandler *handlers;
56 * List of arrays of message handlers.
61 * This is a linked list.
63 struct NotifyList *next;
68 GNUNET_SERVER_DisconnectCallback callback;
71 * Closure for callback.
78 * @brief handle for a server
80 struct GNUNET_SERVER_Handle
83 * List of handlers for incoming messages.
85 struct HandlerList *handlers;
88 * List of our current clients.
90 struct GNUNET_SERVER_Client *clients;
93 * Linked list of functions to call on disconnects by clients.
95 struct NotifyList *disconnect_notify_list;
98 * Function to call for access control.
100 GNUNET_CONNECTION_AccessCheck access;
103 * Closure for access.
108 * NULL-terminated array of sockets used to listen for new
111 struct GNUNET_NETWORK_Handle **listen_sockets;
114 * After how long should an idle connection time
117 struct GNUNET_TIME_Relative idle_timeout;
120 * Task scheduled to do the listening.
122 GNUNET_SCHEDULER_TaskIdentifier listen_task;
125 * Do we ignore messages of types that we do not understand or do we
126 * require that a handler is found (and if not kill the connection)?
131 * Should all of the clients of this server continue to process
132 * connections as usual even if we get a shutdown request? (the
133 * listen socket always ignores shutdown).
135 int clients_ignore_shutdown;
141 * @brief handle for a client of the server
143 struct GNUNET_SERVER_Client
147 * This is a linked list.
149 struct GNUNET_SERVER_Client *next;
152 * Processing of incoming data.
154 struct GNUNET_SERVER_MessageStreamTokenizer *mst;
157 * Server that this client belongs to.
159 struct GNUNET_SERVER_Handle *server;
162 * Client closure for callbacks.
164 struct GNUNET_CONNECTION_Handle *connection;
167 * ID of task used to restart processing.
169 GNUNET_SCHEDULER_TaskIdentifier restart_task;
172 * Task that warns about missing calls to 'GNUNET_SERVER_receive_done'.
174 GNUNET_SCHEDULER_TaskIdentifier warn_task;
177 * Time when the warn task was started.
179 struct GNUNET_TIME_Absolute warn_start;
182 * Last activity on this socket (used to time it out
183 * if reference_count == 0).
185 struct GNUNET_TIME_Absolute last_activity;
190 GNUNET_CONNECTION_TransmitReadyNotify callback;
198 * After how long should an idle connection time
201 struct GNUNET_TIME_Relative idle_timeout;
204 * Number of external entities with a reference to
205 * this client object.
207 unsigned int reference_count;
210 * Was processing if incoming messages suspended while
211 * we were still processing data already received?
212 * This is a counter saying how often processing was
213 * suspended (once per handler invoked).
215 unsigned int suspended;
218 * Are we currently in the "process_client_buffer" function (and
219 * will hence restart the receive job on exit if suspended == 0 once
220 * we are done?). If this is set, then "receive_done" will
221 * essentially only decrement suspended; if this is not set, then
222 * "receive_done" may need to restart the receive process (either
223 * from the side-buffer or via select/recv).
225 int in_process_client_buffer;
228 * We're about to close down this client due to some serious
234 * Are we currently trying to receive? (YES if we are, NO if we are not,
235 * SYSERR if data is already available in MST).
240 * Persist the file handle for this client no matter what happens,
241 * force the OS to close once the process actually dies. Should only
242 * be used in special cases!
247 * Type of last message processed (for warn_no_receive_done).
254 * Scheduler says our listen socket is ready. Process it!
256 * @param cls handle to our server for which we are processing the listen
258 * @param tc reason why we are running right now
261 process_listen_socket (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
263 struct GNUNET_SERVER_Handle *server = cls;
264 struct GNUNET_CONNECTION_Handle *sock;
265 struct GNUNET_SERVER_Client *client;
266 struct GNUNET_NETWORK_FDSet *r;
269 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
270 r = GNUNET_NETWORK_fdset_create ();
272 while (NULL != server->listen_sockets[i])
273 GNUNET_NETWORK_fdset_set (r, server->listen_sockets[i++]);
274 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
276 /* ignore shutdown, someone else will take care of it! */
277 server->listen_task =
278 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
279 GNUNET_SCHEDULER_NO_TASK,
280 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
281 &process_listen_socket, server);
282 GNUNET_NETWORK_fdset_destroy (r);
286 while (NULL != server->listen_sockets[i])
288 if (GNUNET_NETWORK_fdset_isset (tc->read_ready, server->listen_sockets[i]))
291 GNUNET_CONNECTION_create_from_accept (server->access,
293 server->listen_sockets[i]);
297 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
298 "Server accepted incoming connection.\n");
300 client = GNUNET_SERVER_connect_socket (server, sock);
301 GNUNET_CONNECTION_ignore_shutdown (sock,
302 server->clients_ignore_shutdown);
303 /* decrement reference count, we don't keep "client" alive */
304 GNUNET_SERVER_client_drop (client);
309 /* listen for more! */
310 server->listen_task =
311 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
312 GNUNET_SCHEDULER_NO_TASK,
313 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
314 &process_listen_socket, server);
315 GNUNET_NETWORK_fdset_destroy (r);
320 * Create and initialize a listen socket for the server.
322 * @param serverAddr address to listen on
323 * @param socklen length of address
324 * @return NULL on error, otherwise the listen socket
326 static struct GNUNET_NETWORK_Handle *
327 open_listen_socket (const struct sockaddr *serverAddr, socklen_t socklen)
329 const static int on = 1;
330 struct GNUNET_NETWORK_Handle *sock;
334 switch (serverAddr->sa_family)
337 port = ntohs (((const struct sockaddr_in *) serverAddr)->sin_port);
340 port = ntohs (((const struct sockaddr_in6 *) serverAddr)->sin6_port);
350 sock = GNUNET_NETWORK_socket_create (serverAddr->sa_family, SOCK_STREAM, 0);
353 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
359 if (GNUNET_NETWORK_socket_setsockopt
360 (sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof (on)) != GNUNET_OK)
361 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
364 if ((serverAddr->sa_family == AF_INET6) &&
365 (GNUNET_NETWORK_socket_setsockopt
366 (sock, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof (on)) != GNUNET_OK))
367 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
371 /* bind the socket */
372 if (GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen) != GNUNET_OK)
375 if (errno != EADDRINUSE)
377 /* we don't log 'EADDRINUSE' here since an IPv4 bind may
378 * fail if we already took the port on IPv6; if both IPv4 and
379 * IPv6 binds fail, then our caller will log using the
380 * errno preserved in 'eno' */
381 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
383 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
384 _("`%s' failed for port %d (%s).\n"), "bind", port,
385 (serverAddr->sa_family == AF_INET) ? "IPv4" : "IPv6");
391 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
392 _("`%s' failed for port %d (%s): address already in use\n"),
394 (serverAddr->sa_family == AF_INET) ? "IPv4" : "IPv6");
395 else if (serverAddr->sa_family == AF_UNIX)
396 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
397 _("`%s' failed for `%s': address already in use\n"), "bind",
398 ((const struct sockaddr_un *) serverAddr)->sun_path);
401 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
405 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
407 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
408 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
414 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
415 "Server starts to listen on port %u.\n", port);
422 * Create a new server.
424 * @param access function for access control
425 * @param access_cls closure for access
426 * @param lsocks NULL-terminated array of listen sockets
427 * @param idle_timeout after how long should we timeout idle connections?
428 * @param require_found if YES, connections sending messages of unknown type
430 * @return handle for the new server, NULL on error
431 * (typically, "port" already in use)
433 struct GNUNET_SERVER_Handle *
434 GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access,
436 struct GNUNET_NETWORK_Handle **lsocks,
437 struct GNUNET_TIME_Relative idle_timeout,
440 struct GNUNET_SERVER_Handle *ret;
441 struct GNUNET_NETWORK_FDSet *r;
444 ret = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
445 ret->idle_timeout = idle_timeout;
446 ret->listen_sockets = lsocks;
447 ret->access = access;
448 ret->access_cls = access_cls;
449 ret->require_found = require_found;
452 r = GNUNET_NETWORK_fdset_create ();
454 while (NULL != ret->listen_sockets[i])
455 GNUNET_NETWORK_fdset_set (r, ret->listen_sockets[i++]);
457 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
458 GNUNET_SCHEDULER_NO_TASK,
459 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
460 &process_listen_socket, ret);
461 GNUNET_NETWORK_fdset_destroy (r);
468 * Create a new server.
470 * @param access function for access control
471 * @param access_cls closure for access
472 * @param serverAddr address to listen on (including port), NULL terminated array
473 * @param socklen length of serverAddr
474 * @param idle_timeout after how long should we timeout idle connections?
475 * @param require_found if YES, connections sending messages of unknown type
477 * @return handle for the new server, NULL on error
478 * (typically, "port" already in use)
480 struct GNUNET_SERVER_Handle *
481 GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access, void *access_cls,
482 struct sockaddr *const *serverAddr,
483 const socklen_t * socklen,
484 struct GNUNET_TIME_Relative idle_timeout,
487 struct GNUNET_NETWORK_Handle **lsocks;
492 while (serverAddr[i] != NULL)
496 lsocks = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (i + 1));
499 while (serverAddr[i] != NULL)
501 lsocks[j] = open_listen_socket (serverAddr[i], socklen[i]);
502 if (lsocks[j] != NULL)
509 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
510 GNUNET_free (lsocks);
518 return GNUNET_SERVER_create_with_sockets (access, access_cls, lsocks,
519 idle_timeout, require_found);
524 * Free resources held by this server.
526 * @param s server to destroy
529 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *s)
531 struct HandlerList *hpos;
532 struct NotifyList *npos;
536 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Server shutting down.\n");
538 if (GNUNET_SCHEDULER_NO_TASK != s->listen_task)
540 GNUNET_SCHEDULER_cancel (s->listen_task);
541 s->listen_task = GNUNET_SCHEDULER_NO_TASK;
543 if (s->listen_sockets != NULL)
546 while (s->listen_sockets[i] != NULL)
547 GNUNET_break (GNUNET_OK ==
548 GNUNET_NETWORK_socket_close (s->listen_sockets[i++]));
549 GNUNET_free (s->listen_sockets);
550 s->listen_sockets = NULL;
552 while (s->clients != NULL)
553 GNUNET_SERVER_client_disconnect (s->clients);
554 while (NULL != (hpos = s->handlers))
556 s->handlers = hpos->next;
559 while (NULL != (npos = s->disconnect_notify_list))
561 npos->callback (npos->callback_cls, NULL);
562 s->disconnect_notify_list = npos->next;
570 * Add additional handlers to an existing server.
572 * @param server the server to add handlers to
573 * @param handlers array of message handlers for
574 * incoming messages; the last entry must
575 * have "NULL" for the "callback"; multiple
576 * entries for the same type are allowed,
577 * they will be called in order of occurence.
578 * These handlers can be removed later;
579 * the handlers array must exist until removed
580 * (or server is destroyed).
583 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
584 const struct GNUNET_SERVER_MessageHandler *handlers)
586 struct HandlerList *p;
588 p = GNUNET_malloc (sizeof (struct HandlerList));
589 p->handlers = handlers;
590 p->next = server->handlers;
591 server->handlers = p;
596 * Task run to warn about missing calls to 'GNUNET_SERVER_receive_done'.
598 * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
599 * @param tc scheduler context (unused)
602 warn_no_receive_done (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
604 struct GNUNET_SERVER_Client *client = cls;
607 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
608 &warn_no_receive_done, client);
609 if (0 == (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
610 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
612 ("Processing code for message of type %u did not call GNUNET_SERVER_receive_done after %llums\n"),
613 (unsigned int) client->warn_type,
615 GNUNET_TIME_absolute_get_duration
616 (client->warn_start).rel_value);
621 * Disable the warning the server issues if a message is not acknowledged
622 * in a timely fashion. Use this call if a client is intentionally delayed
623 * for a while. Only applies to the current message.
625 * @param client client for which to disable the warning
628 GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client *client)
630 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
632 GNUNET_SCHEDULER_cancel (client->warn_task);
633 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
639 * Inject a message into the server, pretend it came
640 * from the specified client. Delivery of the message
641 * will happen instantly (if a handler is installed;
642 * otherwise the call does nothing).
644 * @param server the server receiving the message
645 * @param sender the "pretended" sender of the message
647 * @param message message to transmit
648 * @return GNUNET_OK if the message was OK and the
649 * connection can stay open
650 * GNUNET_SYSERR if the connection to the
651 * client should be shut down
654 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
655 struct GNUNET_SERVER_Client *sender,
656 const struct GNUNET_MessageHeader *message)
658 struct HandlerList *pos;
659 const struct GNUNET_SERVER_MessageHandler *mh;
665 type = ntohs (message->type);
666 size = ntohs (message->size);
669 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
670 "Server schedules transmission of %u-byte message of type %u to client.\n",
673 pos = server->handlers;
678 while (pos->handlers[i].callback != NULL)
680 mh = &pos->handlers[i];
681 if ((mh->type == type) || (mh->type == GNUNET_MESSAGE_TYPE_ALL))
683 if ((mh->expected_size != 0) && (mh->expected_size != size))
685 #if GNUNET8_NETWORK_IS_DEAD
686 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
687 "Expected %u bytes for message of type %u, got %u\n",
688 mh->expected_size, mh->type, size);
691 return GNUNET_SYSERR;
695 if (0 == sender->suspended)
697 sender->warn_start = GNUNET_TIME_absolute_get ();
699 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
700 &warn_no_receive_done, sender);
701 sender->warn_type = type;
705 mh->callback (mh->callback_cls, sender, message);
712 if (found == GNUNET_NO)
714 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
715 "Received message of unknown type %d\n", type);
716 if (server->require_found == GNUNET_YES)
717 return GNUNET_SYSERR;
724 * We are receiving an incoming message. Process it.
726 * @param cls our closure (handle for the client)
727 * @param buf buffer with data received from network
728 * @param available number of bytes available in buf
729 * @param addr address of the sender
730 * @param addrlen length of addr
731 * @param errCode code indicating errors receiving, 0 for success
734 process_incoming (void *cls, const void *buf, size_t available,
735 const struct sockaddr *addr, socklen_t addrlen, int errCode);
739 * Process messages from the client's message tokenizer until either
740 * the tokenizer is empty (and then schedule receiving more), or
741 * until some handler is not immediately done (then wait for restart_processing)
744 * @param client the client to process, RC must have already been increased
745 * using GNUNET_SERVER_client_keep and will be decreased by one in this
747 * @param ret GNUNET_NO to start processing from the buffer,
748 * GNUNET_OK if the mst buffer is drained and we should instantly go back to receiving
749 * GNUNET_SYSERR if we should instantly abort due to error in a previous step
752 process_mst (struct GNUNET_SERVER_Client *client, int ret)
754 while ((ret != GNUNET_SYSERR) && (client->server != NULL) &&
755 (GNUNET_YES != client->shutdown_now) && (0 == client->suspended))
757 if (ret == GNUNET_OK)
759 client->receive_pending = GNUNET_YES;
761 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
762 "Server re-enters receive loop, timeout: %llu.\n",
763 client->idle_timeout.rel_value);
765 GNUNET_CONNECTION_receive (client->connection,
766 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
767 client->idle_timeout, &process_incoming,
772 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
773 "Server processes additional messages instantly.\n");
776 GNUNET_SERVER_mst_receive (client->mst, client, NULL, 0, GNUNET_NO,
780 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
781 "Server leaves instant processing loop: ret = %d, server = %p, shutdown = %d, suspended = %u\n",
782 ret, client->server, client->shutdown_now, client->suspended);
785 if (ret == GNUNET_NO)
788 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
789 "Server has more data pending but is suspended.\n");
791 client->receive_pending = GNUNET_SYSERR; /* data pending */
793 if ((ret == GNUNET_SYSERR) || (GNUNET_YES == client->shutdown_now))
794 GNUNET_SERVER_client_disconnect (client);
795 GNUNET_SERVER_client_drop (client);
800 * We are receiving an incoming message. Process it.
802 * @param cls our closure (handle for the client)
803 * @param buf buffer with data received from network
804 * @param available number of bytes available in buf
805 * @param addr address of the sender
806 * @param addrlen length of addr
807 * @param errCode code indicating errors receiving, 0 for success
810 process_incoming (void *cls, const void *buf, size_t available,
811 const struct sockaddr *addr, socklen_t addrlen, int errCode)
813 struct GNUNET_SERVER_Client *client = cls;
814 struct GNUNET_SERVER_Handle *server = client->server;
815 struct GNUNET_TIME_Absolute end;
816 struct GNUNET_TIME_Absolute now;
819 GNUNET_assert (client->receive_pending == GNUNET_YES);
820 client->receive_pending = GNUNET_NO;
821 now = GNUNET_TIME_absolute_get ();
822 end = GNUNET_TIME_absolute_add (client->last_activity, client->idle_timeout);
824 if ((buf == NULL) && (available == 0) && (addr == NULL) && (errCode == 0) &&
825 (client->shutdown_now != GNUNET_YES) && (server != NULL) &&
826 (GNUNET_YES == GNUNET_CONNECTION_check (client->connection)) &&
827 (end.abs_value > now.abs_value))
829 /* wait longer, timeout changed (i.e. due to us sending) */
831 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
832 "Receive time out, but no disconnect due to sending (%p)\n",
833 GNUNET_a2s (addr, addrlen));
835 client->receive_pending = GNUNET_YES;
836 GNUNET_CONNECTION_receive (client->connection,
837 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
838 GNUNET_TIME_absolute_get_remaining (end),
839 &process_incoming, client);
842 if ((buf == NULL) || (available == 0) || (errCode != 0) || (server == NULL) ||
843 (client->shutdown_now == GNUNET_YES) ||
844 (GNUNET_YES != GNUNET_CONNECTION_check (client->connection)))
846 /* other side closed connection, error connecting, etc. */
847 GNUNET_SERVER_client_disconnect (client);
851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Server receives %u bytes from `%s'.\n",
852 (unsigned int) available, GNUNET_a2s (addr, addrlen));
854 GNUNET_SERVER_client_keep (client);
855 client->last_activity = now;
857 GNUNET_SERVER_mst_receive (client->mst, client, buf, available, GNUNET_NO,
859 process_mst (client, ret);
864 * Task run to start again receiving from the network
865 * and process requests.
867 * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
868 * @param tc scheduler context (unused)
871 restart_processing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
873 struct GNUNET_SERVER_Client *client = cls;
874 struct GNUNET_SERVER_Handle *server = client->server;
876 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
877 if ((0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN)) &&
878 (GNUNET_NO == server->clients_ignore_shutdown))
880 GNUNET_SERVER_client_disconnect (client);
883 if (client->receive_pending == GNUNET_NO)
886 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
887 "Server begins to read again from client.\n");
889 client->receive_pending = GNUNET_YES;
890 GNUNET_CONNECTION_receive (client->connection,
891 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
892 client->idle_timeout, &process_incoming, client);
896 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
897 "Server continues processing messages still in the buffer.\n");
899 GNUNET_SERVER_client_keep (client);
900 client->receive_pending = GNUNET_NO;
901 process_mst (client, GNUNET_NO);
906 * This function is called whenever our inbound message tokenizer has
907 * received a complete message.
909 * @param cls closure (struct GNUNET_SERVER_Handle)
910 * @param client identification of the client (struct GNUNET_SERVER_Client*)
911 * @param message the actual message
914 client_message_tokenizer_callback (void *cls, void *client,
915 const struct GNUNET_MessageHeader *message)
917 struct GNUNET_SERVER_Handle *server = cls;
918 struct GNUNET_SERVER_Client *sender = client;
923 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
924 "Tokenizer gives server message of type %u from client\n",
925 ntohs (message->type));
927 sender->in_process_client_buffer = GNUNET_YES;
928 ret = GNUNET_SERVER_inject (server, sender, message);
929 sender->in_process_client_buffer = GNUNET_NO;
930 if (GNUNET_OK != ret)
931 GNUNET_SERVER_client_disconnect (sender);
936 * Add a TCP socket-based connection to the set of handles managed by
937 * this server. Use this function for outgoing (P2P) connections that
938 * we initiated (and where this server should process incoming
941 * @param server the server to use
942 * @param connection the connection to manage (client must
943 * stop using this connection from now on)
944 * @return the client handle (client should call
945 * "client_drop" on the return value eventually)
947 struct GNUNET_SERVER_Client *
948 GNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server,
949 struct GNUNET_CONNECTION_Handle *connection)
951 struct GNUNET_SERVER_Client *client;
953 client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
954 client->connection = connection;
956 GNUNET_SERVER_mst_create (&client_message_tokenizer_callback, server);
957 client->reference_count = 1;
958 client->server = server;
959 client->last_activity = GNUNET_TIME_absolute_get ();
960 client->next = server->clients;
961 client->idle_timeout = server->idle_timeout;
962 server->clients = client;
963 client->receive_pending = GNUNET_YES;
964 client->callback = NULL;
965 client->callback_cls = NULL;
966 GNUNET_CONNECTION_receive (client->connection,
967 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
968 client->idle_timeout, &process_incoming, client);
974 * Change the timeout for a particular client. Decreasing the timeout
975 * may not go into effect immediately (only after the previous timeout
976 * times out or activity happens on the socket).
978 * @param client the client to update
979 * @param timeout new timeout for activities on the socket
982 GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client,
983 struct GNUNET_TIME_Relative timeout)
985 client->idle_timeout = timeout;
990 * Notify the server that the given client handle should
991 * be kept (keeps the connection up if possible, increments
992 * the internal reference counter).
994 * @param client the client to keep
997 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
999 client->reference_count++;
1004 * Notify the server that the given client handle is no
1005 * longer required. Decrements the reference counter. If
1006 * that counter reaches zero an inactive connection maybe
1009 * @param client the client to drop
1012 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1014 GNUNET_assert (client->reference_count > 0);
1015 client->reference_count--;
1016 if ((client->shutdown_now == GNUNET_YES) && (client->reference_count == 0))
1017 GNUNET_SERVER_client_disconnect (client);
1022 * Obtain the network address of the other party.
1024 * @param client the client to get the address for
1025 * @param addr where to store the address
1026 * @param addrlen where to store the length of the address
1027 * @return GNUNET_OK on success
1030 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1031 void **addr, size_t * addrlen)
1033 return GNUNET_CONNECTION_get_address (client->connection, addr, addrlen);
1038 * Ask the server to notify us whenever a client disconnects.
1039 * This function is called whenever the actual network connection
1040 * is closed; the reference count may be zero or larger than zero
1043 * @param server the server manageing the clients
1044 * @param callback function to call on disconnect
1045 * @param callback_cls closure for callback
1048 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1049 GNUNET_SERVER_DisconnectCallback callback,
1052 struct NotifyList *n;
1054 n = GNUNET_malloc (sizeof (struct NotifyList));
1055 n->callback = callback;
1056 n->callback_cls = callback_cls;
1057 n->next = server->disconnect_notify_list;
1058 server->disconnect_notify_list = n;
1063 * Ask the server to stop notifying us whenever a client disconnects.
1065 * @param server the server manageing the clients
1066 * @param callback function to call on disconnect
1067 * @param callback_cls closure for callback
1070 GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1071 GNUNET_SERVER_DisconnectCallback
1072 callback, void *callback_cls)
1074 struct NotifyList *pos;
1075 struct NotifyList *prev;
1078 pos = server->disconnect_notify_list;
1081 if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1092 server->disconnect_notify_list = pos->next;
1094 prev->next = pos->next;
1100 * Ask the server to disconnect from the given client.
1101 * This is the same as returning GNUNET_SYSERR from a message
1102 * handler, except that it allows dropping of a client even
1103 * when not handling a message from that client.
1105 * @param client the client to disconnect from
1108 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1110 struct GNUNET_SERVER_Client *prev;
1111 struct GNUNET_SERVER_Client *pos;
1112 struct GNUNET_SERVER_Handle *server;
1113 struct NotifyList *n;
1117 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1118 "Client is being disconnected from the server.\n");
1120 if (client->restart_task != GNUNET_SCHEDULER_NO_TASK)
1122 GNUNET_SCHEDULER_cancel (client->restart_task);
1123 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1125 if (client->warn_task != GNUNET_SCHEDULER_NO_TASK)
1127 GNUNET_SCHEDULER_cancel (client->warn_task);
1128 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1130 if (GNUNET_YES == client->receive_pending)
1132 GNUNET_CONNECTION_receive_cancel (client->connection);
1133 client->receive_pending = GNUNET_NO;
1136 rc = client->reference_count;
1137 if (client->server != NULL)
1139 server = client->server;
1140 client->server = NULL;
1141 client->shutdown_now = GNUNET_YES;
1143 pos = server->clients;
1144 while ((pos != NULL) && (pos != client))
1149 GNUNET_assert (pos != NULL);
1151 server->clients = pos->next;
1153 prev->next = pos->next;
1154 if (client->restart_task != GNUNET_SCHEDULER_NO_TASK)
1156 GNUNET_SCHEDULER_cancel (client->restart_task);
1157 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1159 if (client->warn_task != GNUNET_SCHEDULER_NO_TASK)
1161 GNUNET_SCHEDULER_cancel (client->warn_task);
1162 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1164 n = server->disconnect_notify_list;
1167 n->callback (n->callback_cls, client);
1174 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1175 "RC still positive, not destroying everything.\n");
1179 if (client->in_process_client_buffer == GNUNET_YES)
1182 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1183 "Still processing inputs, not destroying everything.\n");
1188 if (client->persist == GNUNET_YES)
1189 GNUNET_CONNECTION_persist_ (client->connection);
1190 GNUNET_CONNECTION_destroy (client->connection, GNUNET_NO);
1191 GNUNET_SERVER_mst_destroy (client->mst);
1192 GNUNET_free (client);
1197 * Disable the "CORK" feature for communication with the given client,
1198 * forcing the OS to immediately flush the buffer on transmission
1199 * instead of potentially buffering multiple messages.
1201 * @param client handle to the client
1202 * @return GNUNET_OK on success
1205 GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client)
1207 return GNUNET_CONNECTION_disable_corking (client->connection);
1212 * Wrapper for transmission notification that calls the original
1213 * callback and update the last activity time for our connection.
1215 * @param cls the 'struct GNUNET_SERVER_Client'
1216 * @param size number of bytes we can transmit
1217 * @param buf where to copy the message
1218 * @return number of bytes actually transmitted
1221 transmit_ready_callback_wrapper (void *cls, size_t size, void *buf)
1223 struct GNUNET_SERVER_Client *client = cls;
1226 ret = client->callback (client->callback_cls, size, buf);
1228 client->last_activity = GNUNET_TIME_absolute_get ();
1234 * Notify us when the server has enough space to transmit
1235 * a message of the given size to the given client.
1237 * @param client client to transmit message to
1238 * @param size requested amount of buffer space
1239 * @param timeout after how long should we give up (and call
1240 * notify with buf NULL and size 0)?
1241 * @param callback function to call when space is available
1242 * @param callback_cls closure for callback
1243 * @return non-NULL if the notify callback was queued; can be used
1244 * to cancel the request using
1245 * GNUNET_CONNECTION_notify_transmit_ready_cancel.
1246 * NULL if we are already going to notify someone else (busy)
1248 struct GNUNET_CONNECTION_TransmitHandle *
1249 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1251 struct GNUNET_TIME_Relative timeout,
1252 GNUNET_CONNECTION_TransmitReadyNotify
1253 callback, void *callback_cls)
1255 client->callback_cls = callback_cls;
1256 client->callback = callback;
1257 return GNUNET_CONNECTION_notify_transmit_ready (client->connection, size,
1259 &transmit_ready_callback_wrapper,
1265 * Set the persistent flag on this client, used to setup client connection
1266 * to only be killed when the service it's connected to is actually dead.
1268 * @param client the client to set the persistent flag on
1271 GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client)
1273 client->persist = GNUNET_YES;
1278 * Resume receiving from this client, we are done processing the
1279 * current request. This function must be called from within each
1280 * GNUNET_SERVER_MessageCallback (or its respective continuations).
1282 * @param client client we were processing a message of
1283 * @param success GNUNET_OK to keep the connection open and
1284 * continue to receive
1285 * GNUNET_NO to close the connection (normal behavior)
1286 * GNUNET_SYSERR to close the connection (signal
1290 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success)
1294 GNUNET_assert (client->suspended > 0);
1295 client->suspended--;
1296 if (success != GNUNET_OK)
1299 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1300 "GNUNET_SERVER_receive_done called with failure indication\n");
1302 GNUNET_SERVER_client_disconnect (client);
1305 if (client->suspended > 0)
1308 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1309 "GNUNET_SERVER_receive_done called, but more clients pending\n");
1313 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1315 GNUNET_SCHEDULER_cancel (client->warn_task);
1316 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1318 if (client->in_process_client_buffer == GNUNET_YES)
1321 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1322 "GNUNET_SERVER_receive_done called while still in processing loop\n");
1326 if (client->server == NULL)
1328 GNUNET_SERVER_client_disconnect (client);
1332 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1333 "GNUNET_SERVER_receive_done causes restart in reading from the socket\n");
1335 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == client->restart_task);
1336 client->restart_task = GNUNET_SCHEDULER_add_now (&restart_processing, client);
1341 * Configure this server's connections to continue handling client
1342 * requests as usual even after we get a shutdown signal. The change
1343 * only applies to clients that connect to the server from the outside
1344 * using TCP after this call. Clients managed previously or those
1345 * added using GNUNET_SERVER_connect_socket and
1346 * GNUNET_SERVER_connect_callback are not affected by this option.
1348 * @param h server handle
1349 * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
1352 GNUNET_SERVER_ignore_shutdown (struct GNUNET_SERVER_Handle *h, int do_ignore)
1354 h->clients_ignore_shutdown = do_ignore;
1357 /* end of server.c */