2 This file is part of GNUnet.
3 Copyright (C) 2009-2013 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 3, 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_util_lib.h"
29 #include "gnunet_protocols.h"
31 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
33 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
35 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
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 doubly linked list.
63 struct NotifyList *next;
66 * This is a doubly linked list.
68 struct NotifyList *prev;
73 GNUNET_SERVER_DisconnectCallback callback;
76 * Closure for callback.
83 * @brief handle for a server
85 struct GNUNET_SERVER_Handle
88 * List of handlers for incoming messages.
90 struct HandlerList *handlers;
93 * Head of list of our current clients.
95 struct GNUNET_SERVER_Client *clients_head;
98 * Head of list of our current clients.
100 struct GNUNET_SERVER_Client *clients_tail;
103 * Head of linked list of functions to call on disconnects by clients.
105 struct NotifyList *disconnect_notify_list_head;
108 * Tail of linked list of functions to call on disconnects by clients.
110 struct NotifyList *disconnect_notify_list_tail;
113 * Head of linked list of functions to call on connects by clients.
115 struct NotifyList *connect_notify_list_head;
118 * Tail of linked list of functions to call on connects by clients.
120 struct NotifyList *connect_notify_list_tail;
123 * Function to call for access control.
125 GNUNET_CONNECTION_AccessCheck access_cb;
128 * Closure for @e access_cb.
133 * NULL-terminated array of sockets used to listen for new
136 struct GNUNET_NETWORK_Handle **listen_sockets;
139 * After how long should an idle connection time
142 struct GNUNET_TIME_Relative idle_timeout;
145 * Task scheduled to do the listening.
147 struct GNUNET_SCHEDULER_Task * listen_task;
150 * Alternative function to create a MST instance.
152 GNUNET_SERVER_MstCreateCallback mst_create;
155 * Alternative function to destroy a MST instance.
157 GNUNET_SERVER_MstDestroyCallback mst_destroy;
160 * Alternative function to give data to a MST instance.
162 GNUNET_SERVER_MstReceiveCallback mst_receive;
165 * Closure for 'mst_'-callbacks.
170 * Do we ignore messages of types that we do not understand or do we
171 * require that a handler is found (and if not kill the connection)?
176 * Set to #GNUNET_YES once we are in 'soft' shutdown where we wait for
177 * all non-monitor clients to disconnect before we call
178 * #GNUNET_SERVER_destroy. See test_monitor_clients(). Set to
179 * #GNUNET_SYSERR once the final destroy task has been scheduled
180 * (we cannot run it in the same task).
182 int in_soft_shutdown;
187 * Handle server returns for aborting transmission to a client.
189 struct GNUNET_SERVER_TransmitHandle
192 * Function to call to get the message.
194 GNUNET_CONNECTION_TransmitReadyNotify callback;
197 * Closure for @e callback
202 * Active connection transmission handle.
204 struct GNUNET_CONNECTION_TransmitHandle *cth;
210 * @brief handle for a client of the server
212 struct GNUNET_SERVER_Client
216 * This is a doubly linked list.
218 struct GNUNET_SERVER_Client *next;
221 * This is a doubly linked list.
223 struct GNUNET_SERVER_Client *prev;
226 * Processing of incoming data.
231 * Server that this client belongs to.
233 struct GNUNET_SERVER_Handle *server;
236 * Client closure for callbacks.
238 struct GNUNET_CONNECTION_Handle *connection;
241 * User context value, manipulated using
242 * 'GNUNET_SERVER_client_{get/set}_user_context' functions.
247 * ID of task used to restart processing.
249 struct GNUNET_SCHEDULER_Task * restart_task;
252 * Task that warns about missing calls to #GNUNET_SERVER_receive_done.
254 struct GNUNET_SCHEDULER_Task * warn_task;
257 * Time when the warn task was started.
259 struct GNUNET_TIME_Absolute warn_start;
262 * Last activity on this socket (used to time it out
263 * if reference_count == 0).
265 struct GNUNET_TIME_Absolute last_activity;
268 * Transmission handle we return for this client from
269 * #GNUNET_SERVER_notify_transmit_ready.
271 struct GNUNET_SERVER_TransmitHandle th;
274 * After how long should an idle connection time
277 struct GNUNET_TIME_Relative idle_timeout;
280 * Number of external entities with a reference to
281 * this client object.
283 unsigned int reference_count;
286 * Was processing if incoming messages suspended while
287 * we were still processing data already received?
288 * This is a counter saying how often processing was
289 * suspended (once per handler invoked).
291 unsigned int suspended;
294 * Last size given when user context was initialized; used for
297 size_t user_context_size;
300 * Are we currently in the "process_client_buffer" function (and
301 * will hence restart the receive job on exit if suspended == 0 once
302 * we are done?). If this is set, then "receive_done" will
303 * essentially only decrement suspended; if this is not set, then
304 * "receive_done" may need to restart the receive process (either
305 * from the side-buffer or via select/recv).
307 int in_process_client_buffer;
310 * We're about to close down this client.
315 * Are we currently trying to receive? (#GNUNET_YES if we are,
316 * #GNUNET_NO if we are not, #GNUNET_SYSERR if data is already
322 * Persist the file handle for this client no matter what happens,
323 * force the OS to close once the process actually dies. Should only
324 * be used in special cases!
329 * Is this client a 'monitor' client that should not be counted
330 * when deciding on destroying the server during soft shutdown?
331 * (see also #GNUNET_SERVICE_start)
336 * Type of last message processed (for warn_no_receive_done).
344 * Return user context associated with the given client.
345 * Note: you should probably use the macro (call without the underscore).
347 * @param client client to query
348 * @param size number of bytes in user context struct (for verification only)
349 * @return pointer to user context
352 GNUNET_SERVER_client_get_user_context_ (struct GNUNET_SERVER_Client *client,
355 if ((0 == client->user_context_size) &&
356 (NULL == client->user_context))
357 return NULL; /* never set */
358 GNUNET_assert (size == client->user_context_size);
359 return client->user_context;
364 * Set user context to be associated with the given client.
365 * Note: you should probably use the macro (call without the underscore).
367 * @param client client to query
368 * @param ptr pointer to user context
369 * @param size number of bytes in user context struct (for verification only)
372 GNUNET_SERVER_client_set_user_context_ (struct GNUNET_SERVER_Client *client,
378 client->user_context_size = 0;
379 client->user_context = ptr;
382 client->user_context_size = size;
383 client->user_context = ptr;
388 * Scheduler says our listen socket is ready. Process it!
390 * @param cls handle to our server for which we are processing the listen
392 * @param tc reason why we are running right now
395 process_listen_socket (void *cls,
396 const struct GNUNET_SCHEDULER_TaskContext *tc)
398 struct GNUNET_SERVER_Handle *server = cls;
399 struct GNUNET_CONNECTION_Handle *sock;
402 server->listen_task = NULL;
403 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
405 /* ignore shutdown, someone else will take care of it! */
406 GNUNET_SERVER_resume (server);
409 for (i = 0; NULL != server->listen_sockets[i]; i++)
411 if (GNUNET_NETWORK_fdset_isset (tc->read_ready,
412 server->listen_sockets[i]))
415 GNUNET_CONNECTION_create_from_accept (server->access_cb,
416 server->access_cb_cls,
417 server->listen_sockets[i]);
420 LOG (GNUNET_ERROR_TYPE_DEBUG,
421 "Server accepted incoming connection.\n");
422 (void) GNUNET_SERVER_connect_socket (server,
427 /* listen for more! */
428 GNUNET_SERVER_resume (server);
433 * Create and initialize a listen socket for the server.
435 * @param server_addr address to listen on
436 * @param socklen length of @a server_addr
437 * @return NULL on error, otherwise the listen socket
439 static struct GNUNET_NETWORK_Handle *
440 open_listen_socket (const struct sockaddr *server_addr, socklen_t socklen)
442 struct GNUNET_NETWORK_Handle *sock;
446 switch (server_addr->sa_family)
449 port = ntohs (((const struct sockaddr_in *) server_addr)->sin_port);
452 port = ntohs (((const struct sockaddr_in6 *) server_addr)->sin6_port);
462 sock = GNUNET_NETWORK_socket_create (server_addr->sa_family, SOCK_STREAM, 0);
465 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket");
469 /* bind the socket */
470 if (GNUNET_OK != GNUNET_NETWORK_socket_bind (sock, server_addr, socklen))
473 if (EADDRINUSE != errno)
475 /* we don't log 'EADDRINUSE' here since an IPv4 bind may
476 * fail if we already took the port on IPv6; if both IPv4 and
477 * IPv6 binds fail, then our caller will log using the
478 * errno preserved in 'eno' */
479 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
482 LOG (GNUNET_ERROR_TYPE_ERROR,
483 _("`%s' failed for port %d (%s).\n"),
486 (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
492 LOG (GNUNET_ERROR_TYPE_WARNING,
493 _("`%s' failed for port %d (%s): address already in use\n"),
495 (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
496 else if (AF_UNIX == server_addr->sa_family)
498 LOG (GNUNET_ERROR_TYPE_WARNING,
499 _("`%s' failed for `%s': address already in use\n"),
501 GNUNET_a2s (server_addr, socklen));
504 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
508 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
510 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
512 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
517 LOG (GNUNET_ERROR_TYPE_DEBUG,
518 "Server starts to listen on port %u.\n",
525 * Create a new server.
527 * @param access_cb function for access control
528 * @param access_cb_cls closure for @a access_cb
529 * @param lsocks NULL-terminated array of listen sockets
530 * @param idle_timeout after how long should we timeout idle connections?
531 * @param require_found if #GNUNET_YES, connections sending messages of unknown type
533 * @return handle for the new server, NULL on error
534 * (typically, "port" already in use)
536 struct GNUNET_SERVER_Handle *
537 GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access_cb,
539 struct GNUNET_NETWORK_Handle **lsocks,
540 struct GNUNET_TIME_Relative idle_timeout,
543 struct GNUNET_SERVER_Handle *server;
545 server = GNUNET_new (struct GNUNET_SERVER_Handle);
546 server->idle_timeout = idle_timeout;
547 server->listen_sockets = lsocks;
548 server->access_cb = access_cb;
549 server->access_cb_cls = access_cb_cls;
550 server->require_found = require_found;
552 GNUNET_SERVER_resume (server);
558 * Create a new server.
560 * @param access_cb function for access control
561 * @param access_cb_cls closure for @a access_cb
562 * @param server_addr address to listen on (including port), NULL terminated array
563 * @param socklen length of server_addr
564 * @param idle_timeout after how long should we timeout idle connections?
565 * @param require_found if YES, connections sending messages of unknown type
567 * @return handle for the new server, NULL on error
568 * (typically, "port" already in use)
570 struct GNUNET_SERVER_Handle *
571 GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access_cb,
573 struct sockaddr *const *server_addr,
574 const socklen_t * socklen,
575 struct GNUNET_TIME_Relative idle_timeout,
578 struct GNUNET_NETWORK_Handle **lsocks;
585 while (NULL != server_addr[i])
589 lsocks = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (i + 1));
592 while (NULL != server_addr[i])
596 if ( (socklen[k] == socklen[i]) &&
597 (0 == memcmp (server_addr[k], server_addr[i], socklen[i])) )
604 /* duplicate address, skip */
608 lsocks[j] = open_listen_socket (server_addr[i], socklen[i]);
609 if (NULL != lsocks[j])
616 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "bind");
617 GNUNET_free (lsocks);
625 return GNUNET_SERVER_create_with_sockets (access_cb,
634 * Set the 'monitor' flag on this client. Clients which have been
635 * marked as 'monitors' won't prevent the server from shutting down
636 * once '#GNUNET_SERVER_stop_listening()' has been invoked. The idea is
637 * that for "normal" clients we likely want to allow them to process
638 * their requests; however, monitor-clients are likely to 'never'
639 * disconnect during shutdown and thus will not be considered when
640 * determining if the server should continue to exist after
641 * #GNUNET_SERVER_destroy() has been called.
643 * @param client the client to set the 'monitor' flag on
646 GNUNET_SERVER_client_mark_monitor (struct GNUNET_SERVER_Client *client)
648 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
649 "Marking client as monitor!\n");
650 client->is_monitor = GNUNET_YES;
655 * Helper function for #test_monitor_clients() to trigger
656 * #GNUNET_SERVER_destroy() after the stack has unwound.
658 * @param cls the 'struct GNUNET_SERVER_Handle' to destroy
662 do_destroy (void *cls,
663 const struct GNUNET_SCHEDULER_TaskContext *tc)
665 struct GNUNET_SERVER_Handle *server = cls;
667 GNUNET_SERVER_destroy (server);
672 * Check if only 'monitor' clients are left. If so, destroy the
675 * @param server server to test for full shutdown
678 test_monitor_clients (struct GNUNET_SERVER_Handle *server)
680 struct GNUNET_SERVER_Client *client;
682 if (GNUNET_YES != server->in_soft_shutdown)
684 for (client = server->clients_head; NULL != client; client = client->next)
685 if (GNUNET_NO == client->is_monitor)
686 return; /* not done yet */
687 server->in_soft_shutdown = GNUNET_SYSERR;
688 GNUNET_SCHEDULER_add_now (&do_destroy, server);
693 * Suspend accepting connections from the listen socket temporarily.
695 * @param server server to stop accepting connections.
698 GNUNET_SERVER_suspend (struct GNUNET_SERVER_Handle *server)
700 if (NULL != server->listen_task)
702 GNUNET_SCHEDULER_cancel (server->listen_task);
703 server->listen_task = NULL;
709 * Resume accepting connections from the listen socket.
711 * @param server server to stop accepting connections.
714 GNUNET_SERVER_resume (struct GNUNET_SERVER_Handle *server)
716 struct GNUNET_NETWORK_FDSet *r;
719 if (NULL == server->listen_sockets)
721 if (NULL == server->listen_sockets[0])
722 return; /* nothing to do, no listen sockets! */
723 if (NULL == server->listen_sockets[1])
725 /* simplified method: no fd set needed; this is then much simpler and
726 much more efficient */
727 server->listen_task =
728 GNUNET_SCHEDULER_add_read_net_with_priority (GNUNET_TIME_UNIT_FOREVER_REL,
729 GNUNET_SCHEDULER_PRIORITY_HIGH,
730 server->listen_sockets[0],
731 &process_listen_socket, server);
734 r = GNUNET_NETWORK_fdset_create ();
736 while (NULL != server->listen_sockets[i])
737 GNUNET_NETWORK_fdset_set (r, server->listen_sockets[i++]);
738 server->listen_task =
739 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
740 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
741 &process_listen_socket, server);
742 GNUNET_NETWORK_fdset_destroy (r);
747 * Stop the listen socket and get ready to shutdown the server
748 * once only 'monitor' clients are left.
750 * @param server server to stop listening on
753 GNUNET_SERVER_stop_listening (struct GNUNET_SERVER_Handle *server)
757 LOG (GNUNET_ERROR_TYPE_DEBUG,
758 "Server in soft shutdown\n");
759 if (NULL != server->listen_task)
761 GNUNET_SCHEDULER_cancel (server->listen_task);
762 server->listen_task = NULL;
764 if (NULL != server->listen_sockets)
767 while (NULL != server->listen_sockets[i])
768 GNUNET_break (GNUNET_OK ==
769 GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
770 GNUNET_free (server->listen_sockets);
771 server->listen_sockets = NULL;
773 if (GNUNET_NO == server->in_soft_shutdown)
774 server->in_soft_shutdown = GNUNET_YES;
775 test_monitor_clients (server);
780 * Free resources held by this server.
782 * @param server server to destroy
785 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *server)
787 struct HandlerList *hpos;
788 struct NotifyList *npos;
791 LOG (GNUNET_ERROR_TYPE_DEBUG,
792 "Server shutting down.\n");
793 if (NULL != server->listen_task)
795 GNUNET_SCHEDULER_cancel (server->listen_task);
796 server->listen_task = NULL;
798 if (NULL != server->listen_sockets)
801 while (NULL != server->listen_sockets[i])
802 GNUNET_break (GNUNET_OK ==
803 GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
804 GNUNET_free (server->listen_sockets);
805 server->listen_sockets = NULL;
807 while (NULL != server->clients_head)
808 GNUNET_SERVER_client_disconnect (server->clients_head);
809 while (NULL != (hpos = server->handlers))
811 server->handlers = hpos->next;
814 while (NULL != (npos = server->disconnect_notify_list_head))
816 npos->callback (npos->callback_cls, NULL);
817 GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
818 server->disconnect_notify_list_tail,
822 while (NULL != (npos = server->connect_notify_list_head))
824 npos->callback (npos->callback_cls, NULL);
825 GNUNET_CONTAINER_DLL_remove (server->connect_notify_list_head,
826 server->connect_notify_list_tail,
830 GNUNET_free (server);
835 * Add additional handlers to an existing server.
837 * @param server the server to add handlers to
838 * @param handlers array of message handlers for
839 * incoming messages; the last entry must
840 * have "NULL" for the "callback"; multiple
841 * entries for the same type are allowed,
842 * they will be called in order of occurence.
843 * These handlers can be removed later;
844 * the handlers array must exist until removed
845 * (or server is destroyed).
848 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
849 const struct GNUNET_SERVER_MessageHandler *handlers)
851 struct HandlerList *p;
853 p = GNUNET_new (struct HandlerList);
854 p->handlers = handlers;
855 p->next = server->handlers;
856 server->handlers = p;
861 * Change functions used by the server to tokenize the message stream.
862 * (very rarely used).
864 * @param server server to modify
865 * @param create new tokenizer initialization function
866 * @param destroy new tokenizer destruction function
867 * @param receive new tokenizer receive function
868 * @param cls closure for @a create, @a receive, @a destroy
871 GNUNET_SERVER_set_callbacks (struct GNUNET_SERVER_Handle *server,
872 GNUNET_SERVER_MstCreateCallback create,
873 GNUNET_SERVER_MstDestroyCallback destroy,
874 GNUNET_SERVER_MstReceiveCallback receive,
877 server->mst_create = create;
878 server->mst_destroy = destroy;
879 server->mst_receive = receive;
880 server->mst_cls = cls;
885 * Task run to warn about missing calls to #GNUNET_SERVER_receive_done.
887 * @param cls our `struct GNUNET_SERVER_Client *` to process more requests from
888 * @param tc scheduler context (unused)
891 warn_no_receive_done (void *cls,
892 const struct GNUNET_SCHEDULER_TaskContext *tc)
894 struct GNUNET_SERVER_Client *client = cls;
896 GNUNET_break (0 != client->warn_type); /* type should never be 0 here, as we don't use 0 */
898 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
899 &warn_no_receive_done, client);
900 if (0 == (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
901 LOG (GNUNET_ERROR_TYPE_WARNING,
902 _("Processing code for message of type %u did not call `GNUNET_SERVER_receive_done' after %s\n"),
903 (unsigned int) client->warn_type,
904 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (client->warn_start), GNUNET_YES));
909 * Disable the warning the server issues if a message is not acknowledged
910 * in a timely fashion. Use this call if a client is intentionally delayed
911 * for a while. Only applies to the current message.
913 * @param client client for which to disable the warning
916 GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client *client)
918 if (NULL != client->warn_task)
920 GNUNET_SCHEDULER_cancel (client->warn_task);
921 client->warn_task = NULL;
927 * Inject a message into the server, pretend it came
928 * from the specified client. Delivery of the message
929 * will happen instantly (if a handler is installed;
930 * otherwise the call does nothing).
932 * @param server the server receiving the message
933 * @param sender the "pretended" sender of the message
935 * @param message message to transmit
936 * @return #GNUNET_OK if the message was OK and the
937 * connection can stay open
938 * #GNUNET_SYSERR if the connection to the
939 * client should be shut down
942 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
943 struct GNUNET_SERVER_Client *sender,
944 const struct GNUNET_MessageHeader *message)
946 struct HandlerList *pos;
947 const struct GNUNET_SERVER_MessageHandler *mh;
953 type = ntohs (message->type);
954 size = ntohs (message->size);
955 LOG (GNUNET_ERROR_TYPE_DEBUG,
956 "Server schedules transmission of %u-byte message of type %u to client.\n",
959 for (pos = server->handlers; NULL != pos; pos = pos->next)
962 while (pos->handlers[i].callback != NULL)
964 mh = &pos->handlers[i];
965 if ((mh->type == type) || (mh->type == GNUNET_MESSAGE_TYPE_ALL))
967 if ((0 != mh->expected_size) && (mh->expected_size != size))
969 #if GNUNET8_NETWORK_IS_DEAD
970 LOG (GNUNET_ERROR_TYPE_WARNING,
971 "Expected %u bytes for message of type %u, got %u\n",
972 mh->expected_size, mh->type, size);
975 LOG (GNUNET_ERROR_TYPE_DEBUG,
976 "Expected %u bytes for message of type %u, got %u\n",
977 mh->expected_size, mh->type, size);
979 return GNUNET_SYSERR;
983 if ( (0 == sender->suspended) &&
984 (NULL == sender->warn_task) )
986 GNUNET_break (0 != type); /* type should never be 0 here, as we don't use 0 */
987 sender->warn_start = GNUNET_TIME_absolute_get ();
989 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
990 &warn_no_receive_done, sender);
991 sender->warn_type = type;
995 mh->callback (mh->callback_cls, sender, message);
1001 if (GNUNET_NO == found)
1003 LOG (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1004 "Received message of unknown type %d\n", type);
1005 if (GNUNET_YES == server->require_found)
1006 return GNUNET_SYSERR;
1013 * We are receiving an incoming message. Process it.
1015 * @param cls our closure (handle for the client)
1016 * @param buf buffer with data received from network
1017 * @param available number of bytes available in buf
1018 * @param addr address of the sender
1019 * @param addrlen length of @a addr
1020 * @param errCode code indicating errors receiving, 0 for success
1023 process_incoming (void *cls,
1026 const struct sockaddr *addr,
1032 * Process messages from the client's message tokenizer until either
1033 * the tokenizer is empty (and then schedule receiving more), or
1034 * until some handler is not immediately done (then wait for restart_processing)
1037 * @param client the client to process, RC must have already been increased
1038 * using #GNUNET_SERVER_client_keep and will be decreased by one in this
1040 * @param ret #GNUNET_NO to start processing from the buffer,
1041 * #GNUNET_OK if the mst buffer is drained and we should instantly go back to receiving
1042 * #GNUNET_SYSERR if we should instantly abort due to error in a previous step
1045 process_mst (struct GNUNET_SERVER_Client *client,
1048 while ((GNUNET_SYSERR != ret) && (NULL != client->server) &&
1049 (GNUNET_YES != client->shutdown_now) && (0 == client->suspended))
1051 if (GNUNET_OK == ret)
1053 LOG (GNUNET_ERROR_TYPE_DEBUG,
1054 "Server re-enters receive loop, timeout: %s.\n",
1055 GNUNET_STRINGS_relative_time_to_string (client->idle_timeout, GNUNET_YES));
1056 client->receive_pending = GNUNET_YES;
1057 GNUNET_CONNECTION_receive (client->connection,
1058 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1059 client->idle_timeout,
1064 LOG (GNUNET_ERROR_TYPE_DEBUG,
1065 "Server processes additional messages instantly.\n");
1066 if (NULL != client->server->mst_receive)
1068 client->server->mst_receive (client->server->mst_cls, client->mst,
1069 client, NULL, 0, GNUNET_NO, GNUNET_YES);
1072 GNUNET_SERVER_mst_receive (client->mst, client, NULL, 0, GNUNET_NO,
1075 LOG (GNUNET_ERROR_TYPE_DEBUG,
1076 "Server leaves instant processing loop: ret = %d, server = %p, shutdown = %d, suspended = %u\n",
1077 ret, client->server,
1078 client->shutdown_now,
1080 if (GNUNET_NO == ret)
1082 LOG (GNUNET_ERROR_TYPE_DEBUG,
1083 "Server has more data pending but is suspended.\n");
1084 client->receive_pending = GNUNET_SYSERR; /* data pending */
1086 if ( (GNUNET_SYSERR == ret) ||
1087 (GNUNET_YES == client->shutdown_now) )
1088 GNUNET_SERVER_client_disconnect (client);
1093 * We are receiving an incoming message. Process it.
1095 * @param cls our closure (handle for the client)
1096 * @param buf buffer with data received from network
1097 * @param available number of bytes available in buf
1098 * @param addr address of the sender
1099 * @param addrlen length of @a addr
1100 * @param errCode code indicating errors receiving, 0 for success
1103 process_incoming (void *cls,
1106 const struct sockaddr *addr,
1110 struct GNUNET_SERVER_Client *client = cls;
1111 struct GNUNET_SERVER_Handle *server = client->server;
1112 struct GNUNET_TIME_Absolute end;
1113 struct GNUNET_TIME_Absolute now;
1116 GNUNET_assert (GNUNET_YES == client->receive_pending);
1117 client->receive_pending = GNUNET_NO;
1118 now = GNUNET_TIME_absolute_get ();
1119 end = GNUNET_TIME_absolute_add (client->last_activity,
1120 client->idle_timeout);
1122 if ( (NULL == buf) &&
1126 (GNUNET_YES != client->shutdown_now) &&
1128 (GNUNET_YES == GNUNET_CONNECTION_check (client->connection)) &&
1129 (end.abs_value_us > now.abs_value_us) )
1131 /* wait longer, timeout changed (i.e. due to us sending) */
1132 LOG (GNUNET_ERROR_TYPE_DEBUG,
1133 "Receive time out, but no disconnect due to sending (%p)\n",
1135 client->receive_pending = GNUNET_YES;
1136 GNUNET_CONNECTION_receive (client->connection,
1137 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1138 GNUNET_TIME_absolute_get_remaining (end),
1139 &process_incoming, client);
1142 if ( (NULL == buf) ||
1146 (GNUNET_YES == client->shutdown_now) ||
1147 (GNUNET_YES != GNUNET_CONNECTION_check (client->connection)) )
1149 /* other side closed connection, error connecting, etc. */
1150 LOG (GNUNET_ERROR_TYPE_DEBUG,
1151 "Failed to connect or other side closed connection (%p)\n",
1153 GNUNET_SERVER_client_disconnect (client);
1156 LOG (GNUNET_ERROR_TYPE_DEBUG,
1157 "Server receives %u bytes from `%s'.\n",
1158 (unsigned int) available,
1159 GNUNET_a2s (addr, addrlen));
1160 GNUNET_SERVER_client_keep (client);
1161 client->last_activity = now;
1163 if (NULL != server->mst_receive)
1165 ret = client->server->mst_receive (client->server->mst_cls,
1173 else if (NULL != client->mst)
1176 GNUNET_SERVER_mst_receive (client->mst,
1188 process_mst (client,
1190 GNUNET_SERVER_client_drop (client);
1195 * Task run to start again receiving from the network
1196 * and process requests.
1198 * @param cls our `struct GNUNET_SERVER_Client *` to process more requests from
1199 * @param tc scheduler context (unused)
1202 restart_processing (void *cls,
1203 const struct GNUNET_SCHEDULER_TaskContext *tc)
1205 struct GNUNET_SERVER_Client *client = cls;
1207 GNUNET_assert (GNUNET_YES != client->shutdown_now);
1208 client->restart_task = NULL;
1209 if (GNUNET_NO == client->receive_pending)
1211 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server begins to read again from client.\n");
1212 client->receive_pending = GNUNET_YES;
1213 GNUNET_CONNECTION_receive (client->connection,
1214 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1215 client->idle_timeout,
1220 LOG (GNUNET_ERROR_TYPE_DEBUG,
1221 "Server continues processing messages still in the buffer.\n");
1222 GNUNET_SERVER_client_keep (client);
1223 client->receive_pending = GNUNET_NO;
1224 process_mst (client,
1226 GNUNET_SERVER_client_drop (client);
1231 * This function is called whenever our inbound message tokenizer has
1232 * received a complete message.
1234 * @param cls closure (struct GNUNET_SERVER_Handle)
1235 * @param client identification of the client (`struct GNUNET_SERVER_Client *`)
1236 * @param message the actual message
1238 * @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
1241 client_message_tokenizer_callback (void *cls,
1243 const struct GNUNET_MessageHeader *message)
1245 struct GNUNET_SERVER_Handle *server = cls;
1246 struct GNUNET_SERVER_Client *sender = client;
1249 LOG (GNUNET_ERROR_TYPE_DEBUG,
1250 "Tokenizer gives server message of type %u from client\n",
1251 ntohs (message->type));
1252 sender->in_process_client_buffer = GNUNET_YES;
1253 ret = GNUNET_SERVER_inject (server, sender, message);
1254 sender->in_process_client_buffer = GNUNET_NO;
1255 if ( (GNUNET_OK != ret) || (GNUNET_YES == sender->shutdown_now) )
1257 GNUNET_SERVER_client_disconnect (sender);
1258 return GNUNET_SYSERR;
1265 * Add a TCP socket-based connection to the set of handles managed by
1266 * this server. Use this function for outgoing (P2P) connections that
1267 * we initiated (and where this server should process incoming
1270 * @param server the server to use
1271 * @param connection the connection to manage (client must
1272 * stop using this connection from now on)
1273 * @return the client handle
1275 struct GNUNET_SERVER_Client *
1276 GNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server,
1277 struct GNUNET_CONNECTION_Handle *connection)
1279 struct GNUNET_SERVER_Client *client;
1280 struct NotifyList *n;
1282 client = GNUNET_new (struct GNUNET_SERVER_Client);
1283 client->connection = connection;
1284 client->server = server;
1285 client->last_activity = GNUNET_TIME_absolute_get ();
1286 client->idle_timeout = server->idle_timeout;
1287 GNUNET_CONTAINER_DLL_insert (server->clients_head,
1288 server->clients_tail,
1290 if (NULL != server->mst_create)
1292 server->mst_create (server->mst_cls, client);
1295 GNUNET_SERVER_mst_create (&client_message_tokenizer_callback,
1297 GNUNET_assert (NULL != client->mst);
1298 for (n = server->connect_notify_list_head; NULL != n; n = n->next)
1299 n->callback (n->callback_cls, client);
1300 client->receive_pending = GNUNET_YES;
1301 GNUNET_CONNECTION_receive (client->connection,
1302 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1303 client->idle_timeout,
1311 * Change the timeout for a particular client. Decreasing the timeout
1312 * may not go into effect immediately (only after the previous timeout
1313 * times out or activity happens on the socket).
1315 * @param client the client to update
1316 * @param timeout new timeout for activities on the socket
1319 GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client,
1320 struct GNUNET_TIME_Relative timeout)
1322 client->idle_timeout = timeout;
1327 * Notify the server that the given client handle should
1328 * be kept (keeps the connection up if possible, increments
1329 * the internal reference counter).
1331 * @param client the client to keep
1334 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
1336 client->reference_count++;
1341 * Notify the server that the given client handle is no
1342 * longer required. Decrements the reference counter. If
1343 * that counter reaches zero an inactive connection maybe
1346 * @param client the client to drop
1349 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1351 GNUNET_assert (client->reference_count > 0);
1352 client->reference_count--;
1353 if ((GNUNET_YES == client->shutdown_now) && (0 == client->reference_count))
1354 GNUNET_SERVER_client_disconnect (client);
1359 * Obtain the network address of the other party.
1361 * @param client the client to get the address for
1362 * @param addr where to store the address
1363 * @param addrlen where to store the length of the @a addr
1364 * @return #GNUNET_OK on success
1367 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1368 void **addr, size_t * addrlen)
1370 return GNUNET_CONNECTION_get_address (client->connection, addr, addrlen);
1375 * Ask the server to notify us whenever a client disconnects.
1376 * This function is called whenever the actual network connection
1377 * is closed; the reference count may be zero or larger than zero
1380 * @param server the server manageing the clients
1381 * @param callback function to call on disconnect
1382 * @param callback_cls closure for @a callback
1385 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1386 GNUNET_SERVER_DisconnectCallback callback,
1389 struct NotifyList *n;
1391 n = GNUNET_new (struct NotifyList);
1392 n->callback = callback;
1393 n->callback_cls = callback_cls;
1394 GNUNET_CONTAINER_DLL_insert (server->disconnect_notify_list_head,
1395 server->disconnect_notify_list_tail,
1401 * Ask the server to notify us whenever a client connects.
1402 * This function is called whenever the actual network connection
1403 * is opened. If the server is destroyed before this
1404 * notification is explicitly cancelled, the 'callback' will
1405 * once be called with a 'client' argument of NULL to indicate
1406 * that the server itself is now gone (and that the callback
1407 * won't be called anymore and also can no longer be cancelled).
1409 * @param server the server manageing the clients
1410 * @param callback function to call on sconnect
1411 * @param callback_cls closure for @a callback
1414 GNUNET_SERVER_connect_notify (struct GNUNET_SERVER_Handle *server,
1415 GNUNET_SERVER_ConnectCallback callback,
1418 struct NotifyList *n;
1419 struct GNUNET_SERVER_Client *client;
1421 n = GNUNET_new (struct NotifyList);
1422 n->callback = callback;
1423 n->callback_cls = callback_cls;
1424 GNUNET_CONTAINER_DLL_insert (server->connect_notify_list_head,
1425 server->connect_notify_list_tail,
1427 for (client = server->clients_head; NULL != client; client = client->next)
1428 callback (callback_cls, client);
1433 * Ask the server to stop notifying us whenever a client connects.
1435 * @param server the server manageing the clients
1436 * @param callback function to call on connect
1437 * @param callback_cls closure for @a callback
1440 GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1441 GNUNET_SERVER_DisconnectCallback callback,
1444 struct NotifyList *pos;
1446 for (pos = server->disconnect_notify_list_head; NULL != pos; pos = pos->next)
1447 if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1454 GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
1455 server->disconnect_notify_list_tail,
1462 * Ask the server to stop notifying us whenever a client disconnects.
1464 * @param server the server manageing the clients
1465 * @param callback function to call on disconnect
1466 * @param callback_cls closure for @a callback
1469 GNUNET_SERVER_connect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1470 GNUNET_SERVER_ConnectCallback callback,
1473 struct NotifyList *pos;
1475 for (pos = server->connect_notify_list_head; NULL != pos; pos = pos->next)
1476 if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1483 GNUNET_CONTAINER_DLL_remove (server->connect_notify_list_head,
1484 server->connect_notify_list_tail,
1491 * Destroy the connection that is passed in via @a cls. Used
1492 * as calling #GNUNET_CONNECTION_destroy from within a function
1493 * that was itself called from within process_notify() of
1494 * 'connection.c' is not allowed (see #2329).
1496 * @param cls connection to destroy
1497 * @param tc scheduler context (unused)
1500 destroy_connection (void *cls,
1501 const struct GNUNET_SCHEDULER_TaskContext *tc)
1503 struct GNUNET_CONNECTION_Handle *connection = cls;
1505 GNUNET_CONNECTION_destroy (connection);
1510 * Ask the server to disconnect from the given client.
1511 * This is the same as returning #GNUNET_SYSERR from a message
1512 * handler, except that it allows dropping of a client even
1513 * when not handling a message from that client.
1515 * @param client the client to disconnect from
1518 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1520 struct GNUNET_SERVER_Handle *server = client->server;
1521 struct NotifyList *n;
1523 LOG (GNUNET_ERROR_TYPE_DEBUG,
1524 "Client is being disconnected from the server.\n");
1525 if (NULL != client->restart_task)
1527 GNUNET_SCHEDULER_cancel (client->restart_task);
1528 client->restart_task = NULL;
1530 if (NULL != client->warn_task)
1532 GNUNET_SCHEDULER_cancel (client->warn_task);
1533 client->warn_task = NULL;
1535 if (GNUNET_YES == client->receive_pending)
1537 GNUNET_CONNECTION_receive_cancel (client->connection);
1538 client->receive_pending = GNUNET_NO;
1540 client->shutdown_now = GNUNET_YES;
1541 client->reference_count++; /* make sure nobody else clean up client... */
1542 if ( (NULL != client->mst) &&
1545 GNUNET_CONTAINER_DLL_remove (server->clients_head,
1546 server->clients_tail,
1548 if (NULL != server->mst_destroy)
1549 server->mst_destroy (server->mst_cls,
1552 GNUNET_SERVER_mst_destroy (client->mst);
1554 for (n = server->disconnect_notify_list_head; NULL != n; n = n->next)
1555 n->callback (n->callback_cls,
1558 client->reference_count--;
1559 if (client->reference_count > 0)
1561 LOG (GNUNET_ERROR_TYPE_DEBUG,
1562 "RC of %p still positive, not destroying everything.\n",
1564 client->server = NULL;
1567 if (GNUNET_YES == client->in_process_client_buffer)
1569 LOG (GNUNET_ERROR_TYPE_DEBUG,
1570 "Still processing inputs of %p, not destroying everything.\n",
1574 LOG (GNUNET_ERROR_TYPE_DEBUG,
1575 "RC of %p now zero, destroying everything.\n",
1577 if (GNUNET_YES == client->persist)
1578 GNUNET_CONNECTION_persist_ (client->connection);
1579 if (NULL != client->th.cth)
1580 GNUNET_SERVER_notify_transmit_ready_cancel (&client->th);
1581 (void) GNUNET_SCHEDULER_add_now (&destroy_connection,
1582 client->connection);
1583 /* need to cancel again, as it might have been re-added
1584 in the meantime (i.e. during callbacks) */
1585 if (NULL != client->warn_task)
1587 GNUNET_SCHEDULER_cancel (client->warn_task);
1588 client->warn_task = NULL;
1590 if (GNUNET_YES == client->receive_pending)
1592 GNUNET_CONNECTION_receive_cancel (client->connection);
1593 client->receive_pending = GNUNET_NO;
1595 GNUNET_free (client);
1596 /* we might be in soft-shutdown, test if we're done */
1598 test_monitor_clients (server);
1603 * Disable the "CORK" feature for communication with the given client,
1604 * forcing the OS to immediately flush the buffer on transmission
1605 * instead of potentially buffering multiple messages.
1607 * @param client handle to the client
1608 * @return #GNUNET_OK on success
1611 GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client)
1613 return GNUNET_CONNECTION_disable_corking (client->connection);
1618 * Wrapper for transmission notification that calls the original
1619 * callback and update the last activity time for our connection.
1621 * @param cls the `struct GNUNET_SERVER_Client *`
1622 * @param size number of bytes we can transmit
1623 * @param buf where to copy the message
1624 * @return number of bytes actually transmitted
1627 transmit_ready_callback_wrapper (void *cls, size_t size, void *buf)
1629 struct GNUNET_SERVER_Client *client = cls;
1630 GNUNET_CONNECTION_TransmitReadyNotify callback;
1632 client->th.cth = NULL;
1633 callback = client->th.callback;
1634 client->th.callback = NULL;
1635 client->last_activity = GNUNET_TIME_absolute_get ();
1636 return callback (client->th.callback_cls, size, buf);
1641 * Notify us when the server has enough space to transmit
1642 * a message of the given size to the given client.
1644 * @param client client to transmit message to
1645 * @param size requested amount of buffer space
1646 * @param timeout after how long should we give up (and call
1647 * notify with buf NULL and size 0)?
1648 * @param callback function to call when space is available
1649 * @param callback_cls closure for @a callback
1650 * @return non-NULL if the notify callback was queued; can be used
1651 * to cancel the request using
1652 * #GNUNET_SERVER_notify_transmit_ready_cancel().
1653 * NULL if we are already going to notify someone else (busy)
1655 struct GNUNET_SERVER_TransmitHandle *
1656 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1658 struct GNUNET_TIME_Relative timeout,
1659 GNUNET_CONNECTION_TransmitReadyNotify
1660 callback, void *callback_cls)
1662 if (NULL != client->th.callback)
1664 client->th.callback_cls = callback_cls;
1665 client->th.callback = callback;
1666 client->th.cth = GNUNET_CONNECTION_notify_transmit_ready (client->connection, size,
1668 &transmit_ready_callback_wrapper,
1675 * Abort transmission request.
1677 * @param th request to abort
1680 GNUNET_SERVER_notify_transmit_ready_cancel (struct GNUNET_SERVER_TransmitHandle *th)
1682 GNUNET_CONNECTION_notify_transmit_ready_cancel (th->cth);
1684 th->callback = NULL;
1689 * Set the persistent flag on this client, used to setup client connection
1690 * to only be killed when the service it's connected to is actually dead.
1692 * @param client the client to set the persistent flag on
1695 GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client)
1697 client->persist = GNUNET_YES;
1702 * Resume receiving from this client, we are done processing the
1703 * current request. This function must be called from within each
1704 * GNUNET_SERVER_MessageCallback (or its respective continuations).
1706 * @param client client we were processing a message of
1707 * @param success #GNUNET_OK to keep the connection open and
1708 * continue to receive
1709 * #GNUNET_NO to close the connection (normal behavior)
1710 * #GNUNET_SYSERR to close the connection (signal
1714 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client,
1719 GNUNET_assert (client->suspended > 0);
1720 client->suspended--;
1721 if (GNUNET_OK != success)
1723 LOG (GNUNET_ERROR_TYPE_DEBUG,
1724 "GNUNET_SERVER_receive_done called with failure indication\n");
1725 if ( (client->reference_count > 0) || (client->suspended > 0) )
1726 client->shutdown_now = GNUNET_YES;
1728 GNUNET_SERVER_client_disconnect (client);
1731 if (client->suspended > 0)
1733 LOG (GNUNET_ERROR_TYPE_DEBUG,
1734 "GNUNET_SERVER_receive_done called, but more clients pending\n");
1737 if (NULL != client->warn_task)
1739 GNUNET_SCHEDULER_cancel (client->warn_task);
1740 client->warn_task = NULL;
1742 if (GNUNET_YES == client->in_process_client_buffer)
1744 LOG (GNUNET_ERROR_TYPE_DEBUG,
1745 "GNUNET_SERVER_receive_done called while still in processing loop\n");
1748 if ((NULL == client->server) || (GNUNET_YES == client->shutdown_now))
1750 GNUNET_SERVER_client_disconnect (client);
1753 LOG (GNUNET_ERROR_TYPE_DEBUG,
1754 "GNUNET_SERVER_receive_done causes restart in reading from the socket\n");
1755 GNUNET_assert (NULL == client->restart_task);
1756 client->restart_task = GNUNET_SCHEDULER_add_now (&restart_processing, client);
1760 /* end of server.c */