2 This file is part of GNUnet.
3 (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;
128 * Closure for access.
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 GNUNET_SCHEDULER_TaskIdentifier 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 GNUNET_SCHEDULER_TaskIdentifier restart_task;
252 * Task that warns about missing calls to #GNUNET_SERVER_receive_done.
254 GNUNET_SCHEDULER_TaskIdentifier 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;
400 struct GNUNET_SERVER_Client *client;
403 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
404 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
406 /* ignore shutdown, someone else will take care of it! */
407 GNUNET_SERVER_resume (server);
411 while (NULL != server->listen_sockets[i])
413 if (GNUNET_NETWORK_fdset_isset (tc->read_ready, server->listen_sockets[i]))
416 GNUNET_CONNECTION_create_from_accept (server->access,
418 server->listen_sockets[i]);
421 LOG (GNUNET_ERROR_TYPE_DEBUG,
422 "Server accepted incoming connection.\n");
423 client = GNUNET_SERVER_connect_socket (server, sock);
424 /* decrement reference count, we don't keep "client" alive */
425 GNUNET_SERVER_client_drop (client);
430 /* listen for more! */
431 GNUNET_SERVER_resume (server);
436 * Create and initialize a listen socket for the server.
438 * @param server_addr address to listen on
439 * @param socklen length of @a server_addr
440 * @return NULL on error, otherwise the listen socket
442 static struct GNUNET_NETWORK_Handle *
443 open_listen_socket (const struct sockaddr *server_addr, socklen_t socklen)
445 struct GNUNET_NETWORK_Handle *sock;
449 switch (server_addr->sa_family)
452 port = ntohs (((const struct sockaddr_in *) server_addr)->sin_port);
455 port = ntohs (((const struct sockaddr_in6 *) server_addr)->sin6_port);
465 sock = GNUNET_NETWORK_socket_create (server_addr->sa_family, SOCK_STREAM, 0);
468 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket");
472 /* bind the socket */
473 if (GNUNET_OK != GNUNET_NETWORK_socket_bind (sock, server_addr, socklen))
476 if (EADDRINUSE != errno)
478 /* we don't log 'EADDRINUSE' here since an IPv4 bind may
479 * fail if we already took the port on IPv6; if both IPv4 and
480 * IPv6 binds fail, then our caller will log using the
481 * errno preserved in 'eno' */
482 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "bind");
484 LOG (GNUNET_ERROR_TYPE_ERROR, _("`%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, "listen");
511 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
516 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server starts to listen on port %u.\n",
523 * Create a new server.
525 * @param access function for access control
526 * @param access_cls closure for access
527 * @param lsocks NULL-terminated array of listen sockets
528 * @param idle_timeout after how long should we timeout idle connections?
529 * @param require_found if #GNUNET_YES, connections sending messages of unknown type
531 * @return handle for the new server, NULL on error
532 * (typically, "port" already in use)
534 struct GNUNET_SERVER_Handle *
535 GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access,
537 struct GNUNET_NETWORK_Handle **lsocks,
538 struct GNUNET_TIME_Relative idle_timeout,
541 struct GNUNET_SERVER_Handle *server;
543 server = GNUNET_new (struct GNUNET_SERVER_Handle);
544 server->idle_timeout = idle_timeout;
545 server->listen_sockets = lsocks;
546 server->access = access;
547 server->access_cls = access_cls;
548 server->require_found = require_found;
550 GNUNET_SERVER_resume (server);
556 * Create a new server.
558 * @param access function for access control
559 * @param access_cls closure for access
560 * @param server_addr address to listen on (including port), NULL terminated array
561 * @param socklen length of server_addr
562 * @param idle_timeout after how long should we timeout idle connections?
563 * @param require_found if YES, connections sending messages of unknown type
565 * @return handle for the new server, NULL on error
566 * (typically, "port" already in use)
568 struct GNUNET_SERVER_Handle *
569 GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access, void *access_cls,
570 struct sockaddr *const *server_addr,
571 const socklen_t * socklen,
572 struct GNUNET_TIME_Relative idle_timeout,
575 struct GNUNET_NETWORK_Handle **lsocks;
582 while (NULL != server_addr[i])
586 lsocks = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (i + 1));
589 while (NULL != server_addr[i])
593 if ( (socklen[k] == socklen[i]) &&
594 (0 == memcmp (server_addr[k], server_addr[i], socklen[i])) )
601 /* duplicate address, skip */
605 lsocks[j] = open_listen_socket (server_addr[i], socklen[i]);
606 if (NULL != lsocks[j])
613 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "bind");
614 GNUNET_free (lsocks);
622 return GNUNET_SERVER_create_with_sockets (access, access_cls, lsocks,
623 idle_timeout, require_found);
628 * Set the 'monitor' flag on this client. Clients which have been
629 * marked as 'monitors' won't prevent the server from shutting down
630 * once 'GNUNET_SERVER_stop_listening' has been invoked. The idea is
631 * that for "normal" clients we likely want to allow them to process
632 * their requests; however, monitor-clients are likely to 'never'
633 * disconnect during shutdown and thus will not be considered when
634 * determining if the server should continue to exist after
635 * 'GNUNET_SERVER_destroy' has been called.
637 * @param client the client to set the 'monitor' flag on
640 GNUNET_SERVER_client_mark_monitor (struct GNUNET_SERVER_Client *client)
642 client->is_monitor = GNUNET_YES;
647 * Helper function for 'test_monitor_clients' to trigger
648 * 'GNUNET_SERVER_destroy' after the stack has unwound.
650 * @param cls the 'struct GNUNET_SERVER_Handle' to destroy
654 do_destroy (void *cls,
655 const struct GNUNET_SCHEDULER_TaskContext *tc)
657 struct GNUNET_SERVER_Handle *server = cls;
658 GNUNET_SERVER_destroy (server);
663 * Check if only 'monitor' clients are left. If so, destroy the
666 * @param server server to test for full shutdown
669 test_monitor_clients (struct GNUNET_SERVER_Handle *server)
671 struct GNUNET_SERVER_Client *client;
673 if (GNUNET_YES != server->in_soft_shutdown)
675 for (client = server->clients_head; NULL != client; client = client->next)
676 if (GNUNET_NO == client->is_monitor)
677 return; /* not done yet */
678 server->in_soft_shutdown = GNUNET_SYSERR;
679 GNUNET_SCHEDULER_add_continuation (&do_destroy, server,
680 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
685 * Suspend accepting connections from the listen socket temporarily.
687 * @param server server to stop accepting connections.
690 GNUNET_SERVER_suspend (struct GNUNET_SERVER_Handle *server)
692 if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
694 GNUNET_SCHEDULER_cancel (server->listen_task);
695 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
701 * Resume accepting connections from the listen socket.
703 * @param server server to stop accepting connections.
706 GNUNET_SERVER_resume (struct GNUNET_SERVER_Handle *server)
708 struct GNUNET_NETWORK_FDSet *r;
711 if (NULL == server->listen_sockets)
713 if (NULL == server->listen_sockets[0])
714 return; /* nothing to do, no listen sockets! */
715 if (NULL == server->listen_sockets[1])
717 /* simplified method: no fd set needed; this is then much simpler and
718 much more efficient */
719 server->listen_task =
720 GNUNET_SCHEDULER_add_read_net_with_priority (GNUNET_TIME_UNIT_FOREVER_REL,
721 GNUNET_SCHEDULER_PRIORITY_HIGH,
722 server->listen_sockets[0],
723 &process_listen_socket, server);
726 r = GNUNET_NETWORK_fdset_create ();
728 while (NULL != server->listen_sockets[i])
729 GNUNET_NETWORK_fdset_set (r, server->listen_sockets[i++]);
730 server->listen_task =
731 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
732 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
733 &process_listen_socket, server);
734 GNUNET_NETWORK_fdset_destroy (r);
739 * Stop the listen socket and get ready to shutdown the server
740 * once only 'monitor' clients are left.
742 * @param server server to stop listening on
745 GNUNET_SERVER_stop_listening (struct GNUNET_SERVER_Handle *server)
749 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server in soft shutdown\n");
750 if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
752 GNUNET_SCHEDULER_cancel (server->listen_task);
753 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
755 if (NULL != server->listen_sockets)
758 while (NULL != server->listen_sockets[i])
759 GNUNET_break (GNUNET_OK ==
760 GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
761 GNUNET_free (server->listen_sockets);
762 server->listen_sockets = NULL;
764 if (GNUNET_NO == server->in_soft_shutdown)
765 server->in_soft_shutdown = GNUNET_YES;
766 test_monitor_clients (server);
771 * Free resources held by this server.
773 * @param server server to destroy
776 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *server)
778 struct HandlerList *hpos;
779 struct NotifyList *npos;
782 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server shutting down.\n");
783 if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
785 GNUNET_SCHEDULER_cancel (server->listen_task);
786 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
788 if (NULL != server->listen_sockets)
791 while (NULL != server->listen_sockets[i])
792 GNUNET_break (GNUNET_OK ==
793 GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
794 GNUNET_free (server->listen_sockets);
795 server->listen_sockets = NULL;
797 while (NULL != server->clients_head)
798 GNUNET_SERVER_client_disconnect (server->clients_head);
799 while (NULL != (hpos = server->handlers))
801 server->handlers = hpos->next;
804 while (NULL != (npos = server->disconnect_notify_list_head))
806 npos->callback (npos->callback_cls, NULL);
807 GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
808 server->disconnect_notify_list_tail,
812 while (NULL != (npos = server->connect_notify_list_head))
814 npos->callback (npos->callback_cls, NULL);
815 GNUNET_CONTAINER_DLL_remove (server->connect_notify_list_head,
816 server->connect_notify_list_tail,
820 GNUNET_free (server);
825 * Add additional handlers to an existing server.
827 * @param server the server to add handlers to
828 * @param handlers array of message handlers for
829 * incoming messages; the last entry must
830 * have "NULL" for the "callback"; multiple
831 * entries for the same type are allowed,
832 * they will be called in order of occurence.
833 * These handlers can be removed later;
834 * the handlers array must exist until removed
835 * (or server is destroyed).
838 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
839 const struct GNUNET_SERVER_MessageHandler *handlers)
841 struct HandlerList *p;
843 p = GNUNET_new (struct HandlerList);
844 p->handlers = handlers;
845 p->next = server->handlers;
846 server->handlers = p;
851 * Change functions used by the server to tokenize the message stream.
852 * (very rarely used).
854 * @param server server to modify
855 * @param create new tokenizer initialization function
856 * @param destroy new tokenizer destruction function
857 * @param receive new tokenizer receive function
858 * @param cls closure for @a create, @a receive, @a destroy
861 GNUNET_SERVER_set_callbacks (struct GNUNET_SERVER_Handle *server,
862 GNUNET_SERVER_MstCreateCallback create,
863 GNUNET_SERVER_MstDestroyCallback destroy,
864 GNUNET_SERVER_MstReceiveCallback receive,
867 server->mst_create = create;
868 server->mst_destroy = destroy;
869 server->mst_receive = receive;
870 server->mst_cls = cls;
875 * Task run to warn about missing calls to #GNUNET_SERVER_receive_done.
877 * @param cls our `struct GNUNET_SERVER_Client *` to process more requests from
878 * @param tc scheduler context (unused)
881 warn_no_receive_done (void *cls,
882 const struct GNUNET_SCHEDULER_TaskContext *tc)
884 struct GNUNET_SERVER_Client *client = cls;
886 GNUNET_break (0 != client->warn_type); /* type should never be 0 here, as we don't use 0 */
888 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
889 &warn_no_receive_done, client);
890 if (0 == (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
891 LOG (GNUNET_ERROR_TYPE_WARNING,
892 _("Processing code for message of type %u did not call `GNUNET_SERVER_receive_done' after %s\n"),
893 (unsigned int) client->warn_type,
894 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (client->warn_start), GNUNET_YES));
899 * Disable the warning the server issues if a message is not acknowledged
900 * in a timely fashion. Use this call if a client is intentionally delayed
901 * for a while. Only applies to the current message.
903 * @param client client for which to disable the warning
906 GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client *client)
908 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
910 GNUNET_SCHEDULER_cancel (client->warn_task);
911 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
917 * Inject a message into the server, pretend it came
918 * from the specified client. Delivery of the message
919 * will happen instantly (if a handler is installed;
920 * otherwise the call does nothing).
922 * @param server the server receiving the message
923 * @param sender the "pretended" sender of the message
925 * @param message message to transmit
926 * @return GNUNET_OK if the message was OK and the
927 * connection can stay open
928 * GNUNET_SYSERR if the connection to the
929 * client should be shut down
932 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
933 struct GNUNET_SERVER_Client *sender,
934 const struct GNUNET_MessageHeader *message)
936 struct HandlerList *pos;
937 const struct GNUNET_SERVER_MessageHandler *mh;
943 type = ntohs (message->type);
944 size = ntohs (message->size);
945 LOG (GNUNET_ERROR_TYPE_DEBUG,
946 "Server schedules transmission of %u-byte message of type %u to client.\n",
949 for (pos = server->handlers; NULL != pos; pos = pos->next)
952 while (pos->handlers[i].callback != NULL)
954 mh = &pos->handlers[i];
955 if ((mh->type == type) || (mh->type == GNUNET_MESSAGE_TYPE_ALL))
957 if ((0 != mh->expected_size) && (mh->expected_size != size))
959 #if GNUNET8_NETWORK_IS_DEAD
960 LOG (GNUNET_ERROR_TYPE_WARNING,
961 "Expected %u bytes for message of type %u, got %u\n",
962 mh->expected_size, mh->type, size);
965 LOG (GNUNET_ERROR_TYPE_DEBUG,
966 "Expected %u bytes for message of type %u, got %u\n",
967 mh->expected_size, mh->type, size);
969 return GNUNET_SYSERR;
973 if ( (0 == sender->suspended) &&
974 (GNUNET_SCHEDULER_NO_TASK == sender->warn_task) )
976 GNUNET_break (0 != type); /* type should never be 0 here, as we don't use 0 */
977 sender->warn_start = GNUNET_TIME_absolute_get ();
979 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
980 &warn_no_receive_done, sender);
981 sender->warn_type = type;
985 mh->callback (mh->callback_cls, sender, message);
991 if (GNUNET_NO == found)
993 LOG (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
994 "Received message of unknown type %d\n", type);
995 if (GNUNET_YES == server->require_found)
996 return GNUNET_SYSERR;
1003 * We are receiving an incoming message. Process it.
1005 * @param cls our closure (handle for the client)
1006 * @param buf buffer with data received from network
1007 * @param available number of bytes available in buf
1008 * @param addr address of the sender
1009 * @param addrlen length of addr
1010 * @param errCode code indicating errors receiving, 0 for success
1013 process_incoming (void *cls, const void *buf, size_t available,
1014 const struct sockaddr *addr, socklen_t addrlen, int errCode);
1018 * Process messages from the client's message tokenizer until either
1019 * the tokenizer is empty (and then schedule receiving more), or
1020 * until some handler is not immediately done (then wait for restart_processing)
1023 * @param client the client to process, RC must have already been increased
1024 * using #GNUNET_SERVER_client_keep and will be decreased by one in this
1026 * @param ret #GNUNET_NO to start processing from the buffer,
1027 * #GNUNET_OK if the mst buffer is drained and we should instantly go back to receiving
1028 * #GNUNET_SYSERR if we should instantly abort due to error in a previous step
1031 process_mst (struct GNUNET_SERVER_Client *client, int ret)
1033 while ((GNUNET_SYSERR != ret) && (NULL != client->server) &&
1034 (GNUNET_YES != client->shutdown_now) && (0 == client->suspended))
1036 if (GNUNET_OK == ret)
1038 LOG (GNUNET_ERROR_TYPE_DEBUG,
1039 "Server re-enters receive loop, timeout: %s.\n",
1040 GNUNET_STRINGS_relative_time_to_string (client->idle_timeout, GNUNET_YES));
1041 client->receive_pending = GNUNET_YES;
1042 GNUNET_CONNECTION_receive (client->connection,
1043 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1044 client->idle_timeout, &process_incoming,
1048 LOG (GNUNET_ERROR_TYPE_DEBUG,
1049 "Server processes additional messages instantly.\n");
1050 if (NULL != client->server->mst_receive)
1052 client->server->mst_receive (client->server->mst_cls, client->mst,
1053 client, NULL, 0, GNUNET_NO, GNUNET_YES);
1056 GNUNET_SERVER_mst_receive (client->mst, client, NULL, 0, GNUNET_NO,
1059 LOG (GNUNET_ERROR_TYPE_DEBUG,
1060 "Server leaves instant processing loop: ret = %d, server = %p, shutdown = %d, suspended = %u\n",
1061 ret, client->server,
1062 client->shutdown_now,
1064 if (GNUNET_NO == ret)
1066 LOG (GNUNET_ERROR_TYPE_DEBUG,
1067 "Server has more data pending but is suspended.\n");
1068 client->receive_pending = GNUNET_SYSERR; /* data pending */
1070 if ( (GNUNET_SYSERR == ret) ||
1071 (GNUNET_YES == client->shutdown_now) )
1072 GNUNET_SERVER_client_disconnect (client);
1077 * We are receiving an incoming message. Process it.
1079 * @param cls our closure (handle for the client)
1080 * @param buf buffer with data received from network
1081 * @param available number of bytes available in buf
1082 * @param addr address of the sender
1083 * @param addrlen length of addr
1084 * @param errCode code indicating errors receiving, 0 for success
1087 process_incoming (void *cls, const void *buf, size_t available,
1088 const struct sockaddr *addr, socklen_t addrlen, int errCode)
1090 struct GNUNET_SERVER_Client *client = cls;
1091 struct GNUNET_SERVER_Handle *server = client->server;
1092 struct GNUNET_TIME_Absolute end;
1093 struct GNUNET_TIME_Absolute now;
1096 GNUNET_assert (GNUNET_YES == client->receive_pending);
1097 client->receive_pending = GNUNET_NO;
1098 now = GNUNET_TIME_absolute_get ();
1099 end = GNUNET_TIME_absolute_add (client->last_activity, client->idle_timeout);
1101 if ((NULL == buf) && (0 == available) && (NULL == addr) && (0 == errCode) &&
1102 (GNUNET_YES != client->shutdown_now) && (NULL != server) &&
1103 (GNUNET_YES == GNUNET_CONNECTION_check (client->connection)) &&
1104 (end.abs_value_us > now.abs_value_us))
1106 /* wait longer, timeout changed (i.e. due to us sending) */
1107 LOG (GNUNET_ERROR_TYPE_DEBUG,
1108 "Receive time out, but no disconnect due to sending (%p)\n",
1109 GNUNET_a2s (addr, addrlen));
1110 client->receive_pending = GNUNET_YES;
1111 GNUNET_CONNECTION_receive (client->connection,
1112 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1113 GNUNET_TIME_absolute_get_remaining (end),
1114 &process_incoming, client);
1117 if ((NULL == buf) || (0 == available) || (0 != errCode) || (NULL == server) ||
1118 (GNUNET_YES == client->shutdown_now) ||
1119 (GNUNET_YES != GNUNET_CONNECTION_check (client->connection)))
1121 /* other side closed connection, error connecting, etc. */
1122 GNUNET_SERVER_client_disconnect (client);
1125 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server receives %u bytes from `%s'.\n",
1126 (unsigned int) available, GNUNET_a2s (addr, addrlen));
1127 GNUNET_SERVER_client_keep (client);
1128 client->last_activity = now;
1130 if (NULL != server->mst_receive)
1132 client->server->mst_receive (client->server->mst_cls, client->mst,
1133 client, buf, available, GNUNET_NO, GNUNET_YES);
1134 else if (NULL != client->mst)
1137 GNUNET_SERVER_mst_receive (client->mst, client, buf, available, GNUNET_NO,
1146 process_mst (client, ret);
1147 GNUNET_SERVER_client_drop (client);
1152 * Task run to start again receiving from the network
1153 * and process requests.
1155 * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
1156 * @param tc scheduler context (unused)
1159 restart_processing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1161 struct GNUNET_SERVER_Client *client = cls;
1163 GNUNET_assert (GNUNET_YES != client->shutdown_now);
1164 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1165 if (GNUNET_NO == client->receive_pending)
1167 LOG (GNUNET_ERROR_TYPE_DEBUG, "Server begins to read again from client.\n");
1168 client->receive_pending = GNUNET_YES;
1169 GNUNET_CONNECTION_receive (client->connection,
1170 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1171 client->idle_timeout, &process_incoming, client);
1174 LOG (GNUNET_ERROR_TYPE_DEBUG,
1175 "Server continues processing messages still in the buffer.\n");
1176 GNUNET_SERVER_client_keep (client);
1177 client->receive_pending = GNUNET_NO;
1178 process_mst (client, GNUNET_NO);
1179 GNUNET_SERVER_client_drop (client);
1184 * This function is called whenever our inbound message tokenizer has
1185 * received a complete message.
1187 * @param cls closure (struct GNUNET_SERVER_Handle)
1188 * @param client identification of the client (struct GNUNET_SERVER_Client*)
1189 * @param message the actual message
1191 * @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
1194 client_message_tokenizer_callback (void *cls, void *client,
1195 const struct GNUNET_MessageHeader *message)
1197 struct GNUNET_SERVER_Handle *server = cls;
1198 struct GNUNET_SERVER_Client *sender = client;
1201 LOG (GNUNET_ERROR_TYPE_DEBUG,
1202 "Tokenizer gives server message of type %u from client\n",
1203 ntohs (message->type));
1204 sender->in_process_client_buffer = GNUNET_YES;
1205 ret = GNUNET_SERVER_inject (server, sender, message);
1206 sender->in_process_client_buffer = GNUNET_NO;
1207 if ( (GNUNET_OK != ret) || (GNUNET_YES == sender->shutdown_now) )
1209 GNUNET_SERVER_client_disconnect (sender);
1210 return GNUNET_SYSERR;
1217 * Add a TCP socket-based connection to the set of handles managed by
1218 * this server. Use this function for outgoing (P2P) connections that
1219 * we initiated (and where this server should process incoming
1222 * @param server the server to use
1223 * @param connection the connection to manage (client must
1224 * stop using this connection from now on)
1225 * @return the client handle (client should call
1226 * "client_drop" on the return value eventually)
1228 struct GNUNET_SERVER_Client *
1229 GNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server,
1230 struct GNUNET_CONNECTION_Handle *connection)
1232 struct GNUNET_SERVER_Client *client;
1233 struct NotifyList *n;
1235 client = GNUNET_new (struct GNUNET_SERVER_Client);
1236 client->connection = connection;
1237 client->reference_count = 1;
1238 client->server = server;
1239 client->last_activity = GNUNET_TIME_absolute_get ();
1240 client->idle_timeout = server->idle_timeout;
1241 GNUNET_CONTAINER_DLL_insert (server->clients_head,
1242 server->clients_tail,
1244 if (NULL != server->mst_create)
1246 server->mst_create (server->mst_cls, client);
1249 GNUNET_SERVER_mst_create (&client_message_tokenizer_callback, server);
1250 GNUNET_assert (NULL != client->mst);
1251 for (n = server->connect_notify_list_head; NULL != n; n = n->next)
1252 n->callback (n->callback_cls, client);
1254 client->receive_pending = GNUNET_YES;
1255 GNUNET_CONNECTION_receive (client->connection,
1256 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1257 client->idle_timeout, &process_incoming, client);
1263 * Change the timeout for a particular client. Decreasing the timeout
1264 * may not go into effect immediately (only after the previous timeout
1265 * times out or activity happens on the socket).
1267 * @param client the client to update
1268 * @param timeout new timeout for activities on the socket
1271 GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client,
1272 struct GNUNET_TIME_Relative timeout)
1274 client->idle_timeout = timeout;
1279 * Notify the server that the given client handle should
1280 * be kept (keeps the connection up if possible, increments
1281 * the internal reference counter).
1283 * @param client the client to keep
1286 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
1288 client->reference_count++;
1293 * Notify the server that the given client handle is no
1294 * longer required. Decrements the reference counter. If
1295 * that counter reaches zero an inactive connection maybe
1298 * @param client the client to drop
1301 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1303 GNUNET_assert (client->reference_count > 0);
1304 client->reference_count--;
1305 if ((GNUNET_YES == client->shutdown_now) && (0 == client->reference_count))
1306 GNUNET_SERVER_client_disconnect (client);
1311 * Obtain the network address of the other party.
1313 * @param client the client to get the address for
1314 * @param addr where to store the address
1315 * @param addrlen where to store the length of the address
1316 * @return GNUNET_OK on success
1319 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1320 void **addr, size_t * addrlen)
1322 return GNUNET_CONNECTION_get_address (client->connection, addr, addrlen);
1327 * Ask the server to notify us whenever a client disconnects.
1328 * This function is called whenever the actual network connection
1329 * is closed; the reference count may be zero or larger than zero
1332 * @param server the server manageing the clients
1333 * @param callback function to call on disconnect
1334 * @param callback_cls closure for @a callback
1337 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1338 GNUNET_SERVER_DisconnectCallback callback,
1341 struct NotifyList *n;
1343 n = GNUNET_new (struct NotifyList);
1344 n->callback = callback;
1345 n->callback_cls = callback_cls;
1346 GNUNET_CONTAINER_DLL_insert (server->disconnect_notify_list_head,
1347 server->disconnect_notify_list_tail,
1353 * Ask the server to notify us whenever a client connects.
1354 * This function is called whenever the actual network connection
1355 * is opened. If the server is destroyed before this
1356 * notification is explicitly cancelled, the 'callback' will
1357 * once be called with a 'client' argument of NULL to indicate
1358 * that the server itself is now gone (and that the callback
1359 * won't be called anymore and also can no longer be cancelled).
1361 * @param server the server manageing the clients
1362 * @param callback function to call on sconnect
1363 * @param callback_cls closure for @a callback
1366 GNUNET_SERVER_connect_notify (struct GNUNET_SERVER_Handle *server,
1367 GNUNET_SERVER_ConnectCallback callback,
1370 struct NotifyList *n;
1372 n = GNUNET_new (struct NotifyList);
1373 n->callback = callback;
1374 n->callback_cls = callback_cls;
1375 GNUNET_CONTAINER_DLL_insert (server->connect_notify_list_head,
1376 server->connect_notify_list_tail,
1382 * Ask the server to stop notifying us whenever a client connects.
1384 * @param server the server manageing the clients
1385 * @param callback function to call on connect
1386 * @param callback_cls closure for @a callback
1389 GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1390 GNUNET_SERVER_DisconnectCallback
1391 callback, void *callback_cls)
1393 struct NotifyList *pos;
1395 for (pos = server->disconnect_notify_list_head; NULL != pos; pos = pos->next)
1396 if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1403 GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
1404 server->disconnect_notify_list_tail,
1411 * Ask the server to stop notifying us whenever a client disconnects.
1413 * @param server the server manageing the clients
1414 * @param callback function to call on disconnect
1415 * @param callback_cls closure for @a callback
1418 GNUNET_SERVER_connect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1419 GNUNET_SERVER_ConnectCallback callback,
1422 struct NotifyList *pos;
1424 for (pos = server->connect_notify_list_head; NULL != pos; pos = pos->next)
1425 if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1432 GNUNET_CONTAINER_DLL_remove (server->connect_notify_list_head,
1433 server->connect_notify_list_tail,
1440 * Destroy the connection that is passed in via @a cls. Used
1441 * as calling #GNUNET_CONNECTION_destroy from within a function
1442 * that was itself called from within 'process_notify' of
1443 * 'connection.c' is not allowed (see #2329).
1445 * @param cls connection to destroy
1446 * @param tc scheduler context (unused)
1449 destroy_connection (void *cls,
1450 const struct GNUNET_SCHEDULER_TaskContext *tc)
1452 struct GNUNET_CONNECTION_Handle *connection = cls;
1454 GNUNET_CONNECTION_destroy (connection);
1459 * Ask the server to disconnect from the given client.
1460 * This is the same as returning #GNUNET_SYSERR from a message
1461 * handler, except that it allows dropping of a client even
1462 * when not handling a message from that client.
1464 * @param client the client to disconnect from
1467 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1469 struct GNUNET_SERVER_Handle *server = client->server;
1470 struct NotifyList *n;
1472 LOG (GNUNET_ERROR_TYPE_DEBUG,
1473 "Client is being disconnected from the server.\n");
1474 if (GNUNET_SCHEDULER_NO_TASK != client->restart_task)
1476 GNUNET_SCHEDULER_cancel (client->restart_task);
1477 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1479 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1481 GNUNET_SCHEDULER_cancel (client->warn_task);
1482 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1484 if (GNUNET_YES == client->receive_pending)
1486 GNUNET_CONNECTION_receive_cancel (client->connection);
1487 client->receive_pending = GNUNET_NO;
1489 client->shutdown_now = GNUNET_YES;
1490 client->reference_count++; /* make sure nobody else clean up client... */
1491 if ( (NULL != client->mst) &&
1494 GNUNET_CONTAINER_DLL_remove (server->clients_head,
1495 server->clients_tail,
1497 if (NULL != server->mst_destroy)
1498 server->mst_destroy (server->mst_cls, client->mst);
1500 GNUNET_SERVER_mst_destroy (client->mst);
1502 for (n = server->disconnect_notify_list_head; NULL != n; n = n->next)
1503 n->callback (n->callback_cls, client);
1505 client->reference_count--;
1506 if (client->reference_count > 0)
1508 LOG (GNUNET_ERROR_TYPE_DEBUG,
1509 "RC still positive, not destroying everything.\n");
1510 client->server = NULL;
1513 if (GNUNET_YES == client->in_process_client_buffer)
1515 LOG (GNUNET_ERROR_TYPE_DEBUG,
1516 "Still processing inputs, not destroying everything.\n");
1519 if (GNUNET_YES == client->persist)
1520 GNUNET_CONNECTION_persist_ (client->connection);
1521 if (NULL != client->th.cth)
1522 GNUNET_SERVER_notify_transmit_ready_cancel (&client->th);
1523 (void) GNUNET_SCHEDULER_add_now (&destroy_connection,
1524 client->connection);
1525 /* need to cancel again, as it might have been re-added
1526 in the meantime (i.e. during callbacks) */
1527 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1529 GNUNET_SCHEDULER_cancel (client->warn_task);
1530 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1532 if (GNUNET_YES == client->receive_pending)
1534 GNUNET_CONNECTION_receive_cancel (client->connection);
1535 client->receive_pending = GNUNET_NO;
1537 GNUNET_free (client);
1538 /* we might be in soft-shutdown, test if we're done */
1540 test_monitor_clients (server);
1545 * Disable the "CORK" feature for communication with the given client,
1546 * forcing the OS to immediately flush the buffer on transmission
1547 * instead of potentially buffering multiple messages.
1549 * @param client handle to the client
1550 * @return GNUNET_OK on success
1553 GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client)
1555 return GNUNET_CONNECTION_disable_corking (client->connection);
1560 * Wrapper for transmission notification that calls the original
1561 * callback and update the last activity time for our connection.
1563 * @param cls the 'struct GNUNET_SERVER_Client'
1564 * @param size number of bytes we can transmit
1565 * @param buf where to copy the message
1566 * @return number of bytes actually transmitted
1569 transmit_ready_callback_wrapper (void *cls, size_t size, void *buf)
1571 struct GNUNET_SERVER_Client *client = cls;
1572 GNUNET_CONNECTION_TransmitReadyNotify callback;
1574 client->th.cth = NULL;
1575 callback = client->th.callback;
1576 client->th.callback = NULL;
1577 client->last_activity = GNUNET_TIME_absolute_get ();
1578 return callback (client->th.callback_cls, size, buf);
1583 * Notify us when the server has enough space to transmit
1584 * a message of the given size to the given client.
1586 * @param client client to transmit message to
1587 * @param size requested amount of buffer space
1588 * @param timeout after how long should we give up (and call
1589 * notify with buf NULL and size 0)?
1590 * @param callback function to call when space is available
1591 * @param callback_cls closure for @a callback
1592 * @return non-NULL if the notify callback was queued; can be used
1593 * to cancel the request using
1594 * #GNUNET_SERVER_notify_transmit_ready_cancel.
1595 * NULL if we are already going to notify someone else (busy)
1597 struct GNUNET_SERVER_TransmitHandle *
1598 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1600 struct GNUNET_TIME_Relative timeout,
1601 GNUNET_CONNECTION_TransmitReadyNotify
1602 callback, void *callback_cls)
1604 if (NULL != client->th.callback)
1606 client->th.callback_cls = callback_cls;
1607 client->th.callback = callback;
1608 client->th.cth = GNUNET_CONNECTION_notify_transmit_ready (client->connection, size,
1610 &transmit_ready_callback_wrapper,
1617 * Abort transmission request.
1619 * @param th request to abort
1622 GNUNET_SERVER_notify_transmit_ready_cancel (struct GNUNET_SERVER_TransmitHandle *th)
1624 GNUNET_CONNECTION_notify_transmit_ready_cancel (th->cth);
1626 th->callback = NULL;
1631 * Set the persistent flag on this client, used to setup client connection
1632 * to only be killed when the service it's connected to is actually dead.
1634 * @param client the client to set the persistent flag on
1637 GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client)
1639 client->persist = GNUNET_YES;
1644 * Resume receiving from this client, we are done processing the
1645 * current request. This function must be called from within each
1646 * GNUNET_SERVER_MessageCallback (or its respective continuations).
1648 * @param client client we were processing a message of
1649 * @param success #GNUNET_OK to keep the connection open and
1650 * continue to receive
1651 * #GNUNET_NO to close the connection (normal behavior)
1652 * #GNUNET_SYSERR to close the connection (signal
1656 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client,
1661 GNUNET_assert (client->suspended > 0);
1662 client->suspended--;
1663 if (GNUNET_OK != success)
1665 LOG (GNUNET_ERROR_TYPE_DEBUG,
1666 "GNUNET_SERVER_receive_done called with failure indication\n");
1667 if ( (client->reference_count > 0) || (client->suspended > 0) )
1668 client->shutdown_now = GNUNET_YES;
1670 GNUNET_SERVER_client_disconnect (client);
1673 if (client->suspended > 0)
1675 LOG (GNUNET_ERROR_TYPE_DEBUG,
1676 "GNUNET_SERVER_receive_done called, but more clients pending\n");
1679 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1681 GNUNET_SCHEDULER_cancel (client->warn_task);
1682 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1684 if (GNUNET_YES == client->in_process_client_buffer)
1686 LOG (GNUNET_ERROR_TYPE_DEBUG,
1687 "GNUNET_SERVER_receive_done called while still in processing loop\n");
1690 if ((NULL == client->server) || (GNUNET_YES == client->shutdown_now))
1692 GNUNET_SERVER_client_disconnect (client);
1695 LOG (GNUNET_ERROR_TYPE_DEBUG,
1696 "GNUNET_SERVER_receive_done causes restart in reading from the socket\n");
1697 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == client->restart_task);
1698 client->restart_task = GNUNET_SCHEDULER_add_now (&restart_processing, client);
1702 /* end of server.c */