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).
252 * unique identifier to distinguish between clients
259 * Scheduler says our listen socket is ready. Process it!
261 * @param cls handle to our server for which we are processing the listen
263 * @param tc reason why we are running right now
266 process_listen_socket (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
268 struct GNUNET_SERVER_Handle *server = cls;
269 struct GNUNET_CONNECTION_Handle *sock;
270 struct GNUNET_SERVER_Client *client;
271 struct GNUNET_NETWORK_FDSet *r;
274 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
275 r = GNUNET_NETWORK_fdset_create ();
277 while (NULL != server->listen_sockets[i])
278 GNUNET_NETWORK_fdset_set (r, server->listen_sockets[i++]);
279 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
281 /* ignore shutdown, someone else will take care of it! */
282 server->listen_task =
283 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
284 GNUNET_SCHEDULER_NO_TASK,
285 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
286 &process_listen_socket, server);
287 GNUNET_NETWORK_fdset_destroy (r);
291 while (NULL != server->listen_sockets[i])
293 if (GNUNET_NETWORK_fdset_isset (tc->read_ready, server->listen_sockets[i]))
296 GNUNET_CONNECTION_create_from_accept (server->access,
298 server->listen_sockets[i]);
302 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
303 "Server accepted incoming connection.\n");
305 client = GNUNET_SERVER_connect_socket (server, sock);
306 GNUNET_CONNECTION_ignore_shutdown (sock,
307 server->clients_ignore_shutdown);
308 /* decrement reference count, we don't keep "client" alive */
309 GNUNET_SERVER_client_drop (client);
314 /* listen for more! */
315 server->listen_task =
316 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
317 GNUNET_SCHEDULER_NO_TASK,
318 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
319 &process_listen_socket, server);
320 GNUNET_NETWORK_fdset_destroy (r);
325 * Create and initialize a listen socket for the server.
327 * @param serverAddr address to listen on
328 * @param socklen length of address
329 * @return NULL on error, otherwise the listen socket
331 static struct GNUNET_NETWORK_Handle *
332 open_listen_socket (const struct sockaddr *serverAddr, socklen_t socklen)
334 const static int on = 1;
335 struct GNUNET_NETWORK_Handle *sock;
339 switch (serverAddr->sa_family)
342 port = ntohs (((const struct sockaddr_in *) serverAddr)->sin_port);
345 port = ntohs (((const struct sockaddr_in6 *) serverAddr)->sin6_port);
355 sock = GNUNET_NETWORK_socket_create (serverAddr->sa_family, SOCK_STREAM, 0);
358 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
364 if (GNUNET_NETWORK_socket_setsockopt
365 (sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof (on)) != GNUNET_OK)
366 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
369 if ((serverAddr->sa_family == AF_INET6) &&
370 (GNUNET_NETWORK_socket_setsockopt
371 (sock, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof (on)) != GNUNET_OK))
372 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
376 /* bind the socket */
377 if (GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen) != GNUNET_OK)
380 if (errno != EADDRINUSE)
382 /* we don't log 'EADDRINUSE' here since an IPv4 bind may
383 * fail if we already took the port on IPv6; if both IPv4 and
384 * IPv6 binds fail, then our caller will log using the
385 * errno preserved in 'eno' */
386 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
388 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
389 _("`%s' failed for port %d (%s).\n"), "bind", port,
390 (serverAddr->sa_family == AF_INET) ? "IPv4" : "IPv6");
396 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
397 _("`%s' failed for port %d (%s): address already in use\n"),
399 (serverAddr->sa_family == AF_INET) ? "IPv4" : "IPv6");
400 else if (serverAddr->sa_family == AF_UNIX)
401 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
402 _("`%s' failed for `%s': address already in use\n"), "bind",
403 ((const struct sockaddr_un *) serverAddr)->sun_path);
406 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
410 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
412 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
413 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
419 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
420 "Server starts to listen on port %u.\n", port);
427 * Create a new server.
429 * @param access function for access control
430 * @param access_cls closure for access
431 * @param lsocks NULL-terminated array of listen sockets
432 * @param idle_timeout after how long should we timeout idle connections?
433 * @param require_found if YES, connections sending messages of unknown type
435 * @return handle for the new server, NULL on error
436 * (typically, "port" already in use)
438 struct GNUNET_SERVER_Handle *
439 GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access,
441 struct GNUNET_NETWORK_Handle **lsocks,
442 struct GNUNET_TIME_Relative idle_timeout,
445 struct GNUNET_SERVER_Handle *ret;
446 struct GNUNET_NETWORK_FDSet *r;
449 ret = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
450 ret->idle_timeout = idle_timeout;
451 ret->listen_sockets = lsocks;
452 ret->access = access;
453 ret->access_cls = access_cls;
454 ret->require_found = require_found;
457 r = GNUNET_NETWORK_fdset_create ();
459 while (NULL != ret->listen_sockets[i])
460 GNUNET_NETWORK_fdset_set (r, ret->listen_sockets[i++]);
462 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
463 GNUNET_SCHEDULER_NO_TASK,
464 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
465 &process_listen_socket, ret);
466 GNUNET_NETWORK_fdset_destroy (r);
473 * Create a new server.
475 * @param access function for access control
476 * @param access_cls closure for access
477 * @param serverAddr address to listen on (including port), NULL terminated array
478 * @param socklen length of serverAddr
479 * @param idle_timeout after how long should we timeout idle connections?
480 * @param require_found if YES, connections sending messages of unknown type
482 * @return handle for the new server, NULL on error
483 * (typically, "port" already in use)
485 struct GNUNET_SERVER_Handle *
486 GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access, void *access_cls,
487 struct sockaddr *const *serverAddr,
488 const socklen_t * socklen,
489 struct GNUNET_TIME_Relative idle_timeout,
492 struct GNUNET_NETWORK_Handle **lsocks;
497 while (serverAddr[i] != NULL)
501 lsocks = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (i + 1));
504 while (serverAddr[i] != NULL)
506 lsocks[j] = open_listen_socket (serverAddr[i], socklen[i]);
507 if (lsocks[j] != NULL)
514 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
515 GNUNET_free (lsocks);
523 return GNUNET_SERVER_create_with_sockets (access, access_cls, lsocks,
524 idle_timeout, require_found);
529 * Free resources held by this server.
531 * @param s server to destroy
534 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *s)
536 struct HandlerList *hpos;
537 struct NotifyList *npos;
541 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Server shutting down.\n");
543 if (GNUNET_SCHEDULER_NO_TASK != s->listen_task)
545 GNUNET_SCHEDULER_cancel (s->listen_task);
546 s->listen_task = GNUNET_SCHEDULER_NO_TASK;
548 if (s->listen_sockets != NULL)
551 while (s->listen_sockets[i] != NULL)
552 GNUNET_break (GNUNET_OK ==
553 GNUNET_NETWORK_socket_close (s->listen_sockets[i++]));
554 GNUNET_free (s->listen_sockets);
555 s->listen_sockets = NULL;
557 while (s->clients != NULL)
558 GNUNET_SERVER_client_disconnect (s->clients);
559 while (NULL != (hpos = s->handlers))
561 s->handlers = hpos->next;
564 while (NULL != (npos = s->disconnect_notify_list))
566 npos->callback (npos->callback_cls, NULL);
567 s->disconnect_notify_list = npos->next;
575 * Add additional handlers to an existing server.
577 * @param server the server to add handlers to
578 * @param handlers array of message handlers for
579 * incoming messages; the last entry must
580 * have "NULL" for the "callback"; multiple
581 * entries for the same type are allowed,
582 * they will be called in order of occurence.
583 * These handlers can be removed later;
584 * the handlers array must exist until removed
585 * (or server is destroyed).
588 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
589 const struct GNUNET_SERVER_MessageHandler *handlers)
591 struct HandlerList *p;
593 p = GNUNET_malloc (sizeof (struct HandlerList));
594 p->handlers = handlers;
595 p->next = server->handlers;
596 server->handlers = p;
601 * Task run to warn about missing calls to 'GNUNET_SERVER_receive_done'.
603 * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
604 * @param tc scheduler context (unused)
607 warn_no_receive_done (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
609 struct GNUNET_SERVER_Client *client = cls;
612 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
613 &warn_no_receive_done, client);
614 if (0 == (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
615 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
617 ("Processing code for message of type %u did not call GNUNET_SERVER_receive_done after %llums\n"),
618 (unsigned int) client->warn_type,
620 GNUNET_TIME_absolute_get_duration
621 (client->warn_start).rel_value);
626 * Disable the warning the server issues if a message is not acknowledged
627 * in a timely fashion. Use this call if a client is intentionally delayed
628 * for a while. Only applies to the current message.
630 * @param client client for which to disable the warning
633 GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client *client)
635 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
637 GNUNET_SCHEDULER_cancel (client->warn_task);
638 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
644 * Inject a message into the server, pretend it came
645 * from the specified client. Delivery of the message
646 * will happen instantly (if a handler is installed;
647 * otherwise the call does nothing).
649 * @param server the server receiving the message
650 * @param sender the "pretended" sender of the message
652 * @param message message to transmit
653 * @return GNUNET_OK if the message was OK and the
654 * connection can stay open
655 * GNUNET_SYSERR if the connection to the
656 * client should be shut down
659 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
660 struct GNUNET_SERVER_Client *sender,
661 const struct GNUNET_MessageHeader *message)
663 struct HandlerList *pos;
664 const struct GNUNET_SERVER_MessageHandler *mh;
670 type = ntohs (message->type);
671 size = ntohs (message->size);
674 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
675 "Server schedules transmission of %u-byte message of type %u to client.\n",
678 pos = server->handlers;
683 while (pos->handlers[i].callback != NULL)
685 mh = &pos->handlers[i];
686 if ((mh->type == type) || (mh->type == GNUNET_MESSAGE_TYPE_ALL))
688 if ((mh->expected_size != 0) && (mh->expected_size != size))
690 #if GNUNET8_NETWORK_IS_DEAD
691 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
692 "Expected %u bytes for message of type %u, got %u\n",
693 mh->expected_size, mh->type, size);
696 return GNUNET_SYSERR;
700 if (0 == sender->suspended)
702 sender->warn_start = GNUNET_TIME_absolute_get ();
704 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
705 &warn_no_receive_done, sender);
706 sender->warn_type = type;
710 mh->callback (mh->callback_cls, sender, message);
717 if (found == GNUNET_NO)
719 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
720 "Received message of unknown type %d\n", type);
721 if (server->require_found == GNUNET_YES)
722 return GNUNET_SYSERR;
729 * We are receiving an incoming message. Process it.
731 * @param cls our closure (handle for the client)
732 * @param buf buffer with data received from network
733 * @param available number of bytes available in buf
734 * @param addr address of the sender
735 * @param addrlen length of addr
736 * @param errCode code indicating errors receiving, 0 for success
739 process_incoming (void *cls, const void *buf, size_t available,
740 const struct sockaddr *addr, socklen_t addrlen, int errCode);
744 * Process messages from the client's message tokenizer until either
745 * the tokenizer is empty (and then schedule receiving more), or
746 * until some handler is not immediately done (then wait for restart_processing)
749 * @param client the client to process, RC must have already been increased
750 * using GNUNET_SERVER_client_keep and will be decreased by one in this
752 * @param ret GNUNET_NO to start processing from the buffer,
753 * GNUNET_OK if the mst buffer is drained and we should instantly go back to receiving
754 * GNUNET_SYSERR if we should instantly abort due to error in a previous step
757 process_mst (struct GNUNET_SERVER_Client *client, int ret)
759 while ((ret != GNUNET_SYSERR) && (client->server != NULL) &&
760 (GNUNET_YES != client->shutdown_now) && (0 == client->suspended))
762 if (ret == GNUNET_OK)
764 client->receive_pending = GNUNET_YES;
766 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
767 "Server re-enters receive loop, timeout: %llu.\n",
768 client->idle_timeout.rel_value);
770 GNUNET_CONNECTION_receive (client->connection,
771 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
772 client->idle_timeout, &process_incoming,
777 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
778 "Server processes additional messages instantly.\n");
781 GNUNET_SERVER_mst_receive (client->mst, client, NULL, 0, GNUNET_NO,
785 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
786 "Server leaves instant processing loop: ret = %d, server = %p, shutdown = %d, suspended = %u\n",
787 ret, client->server, client->shutdown_now, client->suspended);
790 if (ret == GNUNET_NO)
793 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
794 "Server has more data pending but is suspended.\n");
796 client->receive_pending = GNUNET_SYSERR; /* data pending */
798 if ((ret == GNUNET_SYSERR) || (GNUNET_YES == client->shutdown_now))
799 GNUNET_SERVER_client_disconnect (client);
800 GNUNET_SERVER_client_drop (client);
805 * We are receiving an incoming message. Process it.
807 * @param cls our closure (handle for the client)
808 * @param buf buffer with data received from network
809 * @param available number of bytes available in buf
810 * @param addr address of the sender
811 * @param addrlen length of addr
812 * @param errCode code indicating errors receiving, 0 for success
815 process_incoming (void *cls, const void *buf, size_t available,
816 const struct sockaddr *addr, socklen_t addrlen, int errCode)
818 struct GNUNET_SERVER_Client *client = cls;
819 struct GNUNET_SERVER_Handle *server = client->server;
820 struct GNUNET_TIME_Absolute end;
821 struct GNUNET_TIME_Absolute now;
824 GNUNET_assert (client->receive_pending == GNUNET_YES);
825 client->receive_pending = GNUNET_NO;
826 now = GNUNET_TIME_absolute_get ();
827 end = GNUNET_TIME_absolute_add (client->last_activity, client->idle_timeout);
829 if ((buf == NULL) && (available == 0) && (addr == NULL) && (errCode == 0) &&
830 (client->shutdown_now != GNUNET_YES) && (server != NULL) &&
831 (GNUNET_YES == GNUNET_CONNECTION_check (client->connection)) &&
832 (end.abs_value > now.abs_value))
834 /* wait longer, timeout changed (i.e. due to us sending) */
836 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
837 "Receive time out, but no disconnect due to sending (%p)\n",
838 GNUNET_a2s (addr, addrlen));
840 client->receive_pending = GNUNET_YES;
841 GNUNET_CONNECTION_receive (client->connection,
842 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
843 GNUNET_TIME_absolute_get_remaining (end),
844 &process_incoming, client);
847 if ((buf == NULL) || (available == 0) || (errCode != 0) || (server == NULL) ||
848 (client->shutdown_now == GNUNET_YES) ||
849 (GNUNET_YES != GNUNET_CONNECTION_check (client->connection)))
851 /* other side closed connection, error connecting, etc. */
852 GNUNET_SERVER_client_disconnect (client);
856 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Server receives %u bytes from `%s'.\n",
857 (unsigned int) available, GNUNET_a2s (addr, addrlen));
859 GNUNET_SERVER_client_keep (client);
860 client->last_activity = now;
862 GNUNET_SERVER_mst_receive (client->mst, client, buf, available, GNUNET_NO,
864 process_mst (client, ret);
869 * Task run to start again receiving from the network
870 * and process requests.
872 * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
873 * @param tc scheduler context (unused)
876 restart_processing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
878 struct GNUNET_SERVER_Client *client = cls;
879 struct GNUNET_SERVER_Handle *server = client->server;
881 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
882 if ((0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN)) &&
883 (GNUNET_NO == server->clients_ignore_shutdown))
885 GNUNET_SERVER_client_disconnect (client);
888 if (client->receive_pending == GNUNET_NO)
891 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
892 "Server begins to read again from client.\n");
894 client->receive_pending = GNUNET_YES;
895 GNUNET_CONNECTION_receive (client->connection,
896 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
897 client->idle_timeout, &process_incoming, client);
901 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
902 "Server continues processing messages still in the buffer.\n");
904 GNUNET_SERVER_client_keep (client);
905 client->receive_pending = GNUNET_NO;
906 process_mst (client, GNUNET_NO);
911 * This function is called whenever our inbound message tokenizer has
912 * received a complete message.
914 * @param cls closure (struct GNUNET_SERVER_Handle)
915 * @param client identification of the client (struct GNUNET_SERVER_Client*)
916 * @param message the actual message
919 client_message_tokenizer_callback (void *cls, void *client,
920 const struct GNUNET_MessageHeader *message)
922 struct GNUNET_SERVER_Handle *server = cls;
923 struct GNUNET_SERVER_Client *sender = client;
928 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
929 "Tokenizer gives server message of type %u from client\n",
930 ntohs (message->type));
932 sender->in_process_client_buffer = GNUNET_YES;
933 ret = GNUNET_SERVER_inject (server, sender, message);
934 sender->in_process_client_buffer = GNUNET_NO;
935 if (GNUNET_OK != ret)
936 GNUNET_SERVER_client_disconnect (sender);
941 * Get a unique identifier for each GNUNET_SERVER_Client
948 GNUNET_assert (id < ULONG_LONG_MAX);
953 * Add a TCP socket-based connection to the set of handles managed by
954 * this server. Use this function for outgoing (P2P) connections that
955 * we initiated (and where this server should process incoming
958 * @param server the server to use
959 * @param connection the connection to manage (client must
960 * stop using this connection from now on)
961 * @return the client handle (client should call
962 * "client_drop" on the return value eventually)
964 struct GNUNET_SERVER_Client *
965 GNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server,
966 struct GNUNET_CONNECTION_Handle *connection)
968 struct GNUNET_SERVER_Client *client;
970 client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
971 client->connection = connection;
973 GNUNET_SERVER_mst_create (&client_message_tokenizer_callback, server);
974 client->reference_count = 1;
975 client->server = server;
976 client->last_activity = GNUNET_TIME_absolute_get ();
977 client->next = server->clients;
978 client->idle_timeout = server->idle_timeout;
979 server->clients = client;
980 client->receive_pending = GNUNET_YES;
981 client->callback = NULL;
982 client->callback_cls = NULL;
983 client->id = get_client_id ();
984 GNUNET_CONNECTION_receive (client->connection,
985 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
986 client->idle_timeout, &process_incoming, client);
992 * Change the timeout for a particular client. Decreasing the timeout
993 * may not go into effect immediately (only after the previous timeout
994 * times out or activity happens on the socket).
996 * @param client the client to update
997 * @param timeout new timeout for activities on the socket
1000 GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client,
1001 struct GNUNET_TIME_Relative timeout)
1003 client->idle_timeout = timeout;
1008 * Notify the server that the given client handle should
1009 * be kept (keeps the connection up if possible, increments
1010 * the internal reference counter).
1012 * @param client the client to keep
1015 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
1017 client->reference_count++;
1022 * Notify the server that the given client handle is no
1023 * longer required. Decrements the reference counter. If
1024 * that counter reaches zero an inactive connection maybe
1027 * @param client the client to drop
1030 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1032 GNUNET_assert (client->reference_count > 0);
1033 client->reference_count--;
1034 if ((client->shutdown_now == GNUNET_YES) && (client->reference_count == 0))
1035 GNUNET_SERVER_client_disconnect (client);
1040 * Obtain the network address of the other party.
1042 * @param client the client to get the address for
1043 * @param addr where to store the address
1044 * @param addrlen where to store the length of the address
1045 * @return GNUNET_OK on success
1048 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1049 void **addr, size_t * addrlen)
1051 return GNUNET_CONNECTION_get_address (client->connection, addr, addrlen);
1056 * Ask the server to notify us whenever a client disconnects.
1057 * This function is called whenever the actual network connection
1058 * is closed; the reference count may be zero or larger than zero
1061 * @param server the server manageing the clients
1062 * @param callback function to call on disconnect
1063 * @param callback_cls closure for callback
1066 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1067 GNUNET_SERVER_DisconnectCallback callback,
1070 struct NotifyList *n;
1072 n = GNUNET_malloc (sizeof (struct NotifyList));
1073 n->callback = callback;
1074 n->callback_cls = callback_cls;
1075 n->next = server->disconnect_notify_list;
1076 server->disconnect_notify_list = n;
1081 * Ask the server to stop notifying us whenever a client disconnects.
1083 * @param server the server manageing the clients
1084 * @param callback function to call on disconnect
1085 * @param callback_cls closure for callback
1088 GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1089 GNUNET_SERVER_DisconnectCallback
1090 callback, void *callback_cls)
1092 struct NotifyList *pos;
1093 struct NotifyList *prev;
1096 pos = server->disconnect_notify_list;
1099 if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1110 server->disconnect_notify_list = pos->next;
1112 prev->next = pos->next;
1118 * Ask the server to disconnect from the given client.
1119 * This is the same as returning GNUNET_SYSERR from a message
1120 * handler, except that it allows dropping of a client even
1121 * when not handling a message from that client.
1123 * @param client the client to disconnect from
1126 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1128 struct GNUNET_SERVER_Client *prev;
1129 struct GNUNET_SERVER_Client *pos;
1130 struct GNUNET_SERVER_Handle *server;
1131 struct NotifyList *n;
1135 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1136 "Client is being disconnected from the server.\n");
1138 if (client->restart_task != GNUNET_SCHEDULER_NO_TASK)
1140 GNUNET_SCHEDULER_cancel (client->restart_task);
1141 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1143 if (client->warn_task != GNUNET_SCHEDULER_NO_TASK)
1145 GNUNET_SCHEDULER_cancel (client->warn_task);
1146 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1148 if (GNUNET_YES == client->receive_pending)
1150 GNUNET_CONNECTION_receive_cancel (client->connection);
1151 client->receive_pending = GNUNET_NO;
1154 rc = client->reference_count;
1155 if (client->server != NULL)
1157 server = client->server;
1158 client->server = NULL;
1159 client->shutdown_now = GNUNET_YES;
1161 pos = server->clients;
1162 while ((pos != NULL) && (pos != client))
1167 GNUNET_assert (pos != NULL);
1169 server->clients = pos->next;
1171 prev->next = pos->next;
1172 if (client->restart_task != GNUNET_SCHEDULER_NO_TASK)
1174 GNUNET_SCHEDULER_cancel (client->restart_task);
1175 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1177 if (client->warn_task != GNUNET_SCHEDULER_NO_TASK)
1179 GNUNET_SCHEDULER_cancel (client->warn_task);
1180 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1182 n = server->disconnect_notify_list;
1185 n->callback (n->callback_cls, client);
1192 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1193 "RC still positive, not destroying everything.\n");
1197 if (client->in_process_client_buffer == GNUNET_YES)
1200 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1201 "Still processing inputs, not destroying everything.\n");
1206 if (client->persist == GNUNET_YES)
1207 GNUNET_CONNECTION_persist_ (client->connection);
1208 GNUNET_CONNECTION_destroy (client->connection, GNUNET_NO);
1209 GNUNET_SERVER_mst_destroy (client->mst);
1210 GNUNET_free (client);
1215 * Disable the "CORK" feature for communication with the given client,
1216 * forcing the OS to immediately flush the buffer on transmission
1217 * instead of potentially buffering multiple messages.
1219 * @param client handle to the client
1220 * @return GNUNET_OK on success
1223 GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client)
1225 return GNUNET_CONNECTION_disable_corking (client->connection);
1230 * Wrapper for transmission notification that calls the original
1231 * callback and update the last activity time for our connection.
1233 * @param cls the 'struct GNUNET_SERVER_Client'
1234 * @param size number of bytes we can transmit
1235 * @param buf where to copy the message
1236 * @return number of bytes actually transmitted
1239 transmit_ready_callback_wrapper (void *cls, size_t size, void *buf)
1241 struct GNUNET_SERVER_Client *client = cls;
1244 ret = client->callback (client->callback_cls, size, buf);
1246 client->last_activity = GNUNET_TIME_absolute_get ();
1252 * Notify us when the server has enough space to transmit
1253 * a message of the given size to the given client.
1255 * @param client client to transmit message to
1256 * @param size requested amount of buffer space
1257 * @param timeout after how long should we give up (and call
1258 * notify with buf NULL and size 0)?
1259 * @param callback function to call when space is available
1260 * @param callback_cls closure for callback
1261 * @return non-NULL if the notify callback was queued; can be used
1262 * to cancel the request using
1263 * GNUNET_CONNECTION_notify_transmit_ready_cancel.
1264 * NULL if we are already going to notify someone else (busy)
1266 struct GNUNET_CONNECTION_TransmitHandle *
1267 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1269 struct GNUNET_TIME_Relative timeout,
1270 GNUNET_CONNECTION_TransmitReadyNotify
1271 callback, void *callback_cls)
1273 client->callback_cls = callback_cls;
1274 client->callback = callback;
1275 return GNUNET_CONNECTION_notify_transmit_ready (client->connection, size,
1277 &transmit_ready_callback_wrapper,
1283 * Set the persistent flag on this client, used to setup client connection
1284 * to only be killed when the service it's connected to is actually dead.
1286 * @param client the client to set the persistent flag on
1289 GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client)
1291 client->persist = GNUNET_YES;
1296 * Retrieve the unique id from the opaque defined GNUNET_SERVER_Client
1298 * @param client the client
1299 * @return the unique id
1302 GNUNET_SERVER_client_get_id (struct GNUNET_SERVER_Client *client)
1308 * Resume receiving from this client, we are done processing the
1309 * current request. This function must be called from within each
1310 * GNUNET_SERVER_MessageCallback (or its respective continuations).
1312 * @param client client we were processing a message of
1313 * @param success GNUNET_OK to keep the connection open and
1314 * continue to receive
1315 * GNUNET_NO to close the connection (normal behavior)
1316 * GNUNET_SYSERR to close the connection (signal
1320 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success)
1324 GNUNET_assert (client->suspended > 0);
1325 client->suspended--;
1326 if (success != GNUNET_OK)
1329 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1330 "GNUNET_SERVER_receive_done called with failure indication\n");
1332 GNUNET_SERVER_client_disconnect (client);
1335 if (client->suspended > 0)
1338 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1339 "GNUNET_SERVER_receive_done called, but more clients pending\n");
1343 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1345 GNUNET_SCHEDULER_cancel (client->warn_task);
1346 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1348 if (client->in_process_client_buffer == GNUNET_YES)
1351 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1352 "GNUNET_SERVER_receive_done called while still in processing loop\n");
1356 if (client->server == NULL)
1358 GNUNET_SERVER_client_disconnect (client);
1362 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1363 "GNUNET_SERVER_receive_done causes restart in reading from the socket\n");
1365 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == client->restart_task);
1366 client->restart_task = GNUNET_SCHEDULER_add_now (&restart_processing, client);
1371 * Configure this server's connections to continue handling client
1372 * requests as usual even after we get a shutdown signal. The change
1373 * only applies to clients that connect to the server from the outside
1374 * using TCP after this call. Clients managed previously or those
1375 * added using GNUNET_SERVER_connect_socket and
1376 * GNUNET_SERVER_connect_callback are not affected by this option.
1378 * @param h server handle
1379 * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
1382 GNUNET_SERVER_ignore_shutdown (struct GNUNET_SERVER_Handle *h, int do_ignore)
1384 h->clients_ignore_shutdown = do_ignore;
1387 /* end of server.c */