/*
This file is part of GNUnet.
- (C) 2009 Christian Grothoff (and other contributing authors)
+ (C) 2009, 2012 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
* @file util/server.c
* @brief library for building GNUnet network servers
* @author Christian Grothoff
- *
- * TODO:
- * - fix inefficient memmove in message processing
*/
#include "platform.h"
#include "gnunet_common.h"
-#include "gnunet_connection_lib.h"
-#include "gnunet_scheduler_lib.h"
-#include "gnunet_server_lib.h"
-#include "gnunet_time_lib.h"
-#include "gnunet_disk_lib.h"
+#include "gnunet_util_lib.h"
+#include "gnunet_protocols.h"
+
+#define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
+
+#define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
+
+#define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
-#define DEBUG_SERVER GNUNET_NO
/**
* List of arrays of message handlers.
struct NotifyList
{
/**
- * This is a linked list.
+ * This is a doubly linked list.
*/
struct NotifyList *next;
+ /**
+ * This is a doubly linked list.
+ */
+ struct NotifyList *prev;
+
/**
* Function to call.
*/
struct GNUNET_SERVER_Handle
{
/**
- * My scheduler.
+ * List of handlers for incoming messages.
*/
- struct GNUNET_SCHEDULER_Handle *sched;
+ struct HandlerList *handlers;
/**
- * List of handlers for incoming messages.
+ * Head of list of our current clients.
*/
- struct HandlerList *handlers;
+ struct GNUNET_SERVER_Client *clients_head;
+
+ /**
+ * Head of list of our current clients.
+ */
+ struct GNUNET_SERVER_Client *clients_tail;
/**
- * List of our current clients.
+ * Head of linked list of functions to call on disconnects by clients.
*/
- struct GNUNET_SERVER_Client *clients;
+ struct NotifyList *disconnect_notify_list_head;
/**
- * Linked list of functions to call on disconnects by clients.
+ * Tail of linked list of functions to call on disconnects by clients.
*/
- struct NotifyList *disconnect_notify_list;
+ struct NotifyList *disconnect_notify_list_tail;
/**
* Function to call for access control.
*/
void *access_cls;
+ /**
+ * NULL-terminated array of sockets used to listen for new
+ * connections.
+ */
+ struct GNUNET_NETWORK_Handle **listen_sockets;
+
/**
* After how long should an idle connection time
* out (on write).
struct GNUNET_TIME_Relative idle_timeout;
/**
- * maximum write buffer size for accepted sockets
+ * Task scheduled to do the listening.
*/
- size_t maxbuf;
+ GNUNET_SCHEDULER_TaskIdentifier listen_task;
/**
- * Socket used to listen for new connections. Set to
- * "-1" by GNUNET_SERVER_destroy to initiate shutdown.
+ * Alternative function to create a MST instance.
*/
- struct GNUNET_NETWORK_Handle *listen_socket;
+ GNUNET_SERVER_MstCreateCallback mst_create;
/**
- * Task scheduled to do the listening.
+ * Alternative function to destroy a MST instance.
*/
- GNUNET_SCHEDULER_TaskIdentifier listen_task;
+ GNUNET_SERVER_MstDestroyCallback mst_destroy;
+
+ /**
+ * Alternative function to give data to a MST instance.
+ */
+ GNUNET_SERVER_MstReceiveCallback mst_receive;
/**
- * Do we ignore messages of types that we do not
- * understand or do we require that a handler
- * is found (and if not kill the connection)?
+ * Closure for 'mst_'-callbacks.
+ */
+ void *mst_cls;
+
+ /**
+ * Do we ignore messages of types that we do not understand or do we
+ * require that a handler is found (and if not kill the connection)?
*/
int require_found;
+ /**
+ * Set to GNUNET_YES once we are in 'soft' shutdown where we wait for
+ * all non-monitor clients to disconnect before we call
+ * GNUNET_SERVER_destroy. See 'test_monitor_clients'. Set to
+ * GNUNET_SYSERR once the final destroy task has been scheduled
+ * (we cannot run it in the same task).
+ */
+ int in_soft_shutdown;
};
/**
- * @brief handle for a client of the server
+ * Handle server returns for aborting transmission to a client.
*/
-struct GNUNET_SERVER_Client
+struct GNUNET_SERVER_TransmitHandle
{
-
/**
- * Size of the buffer for incoming data. Should be
- * first so we get nice alignment.
+ * Function to call to get the message.
*/
- char incoming_buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE];
+ GNUNET_CONNECTION_TransmitReadyNotify callback;
/**
- * This is a linked list.
+ * Closure for 'callback'
*/
- struct GNUNET_SERVER_Client *next;
+ void *callback_cls;
/**
- * Server that this client belongs to.
+ * Active connection transmission handle.
*/
- struct GNUNET_SERVER_Handle *server;
+ struct GNUNET_CONNECTION_TransmitHandle *cth;
- /**
- * Client closure for callbacks.
- */
- void *client_closure;
+};
+
+
+/**
+ * @brief handle for a client of the server
+ */
+struct GNUNET_SERVER_Client
+{
/**
- * Callback to receive from client.
+ * This is a doubly linked list.
*/
- GNUNET_SERVER_ReceiveCallback receive;
+ struct GNUNET_SERVER_Client *next;
/**
- * Callback to cancel receive from client.
+ * This is a doubly linked list.
*/
- GNUNET_SERVER_ReceiveCancelCallback receive_cancel;
+ struct GNUNET_SERVER_Client *prev;
/**
- * Callback to ask about transmit-ready notification.
+ * Processing of incoming data.
*/
- GNUNET_SERVER_TransmitReadyCallback notify_transmit_ready;
+ void *mst;
- /**
- * Callback to ask about transmit-ready notification.
+ /**
+ * Server that this client belongs to.
*/
- GNUNET_SERVER_TransmitReadyCancelCallback notify_transmit_ready_cancel;
+ struct GNUNET_SERVER_Handle *server;
/**
- * Callback to check if client is still valid.
+ * Client closure for callbacks.
*/
- GNUNET_SERVER_CheckCallback check;
+ struct GNUNET_CONNECTION_Handle *connection;
/**
- * Callback to destroy client.
+ * ID of task used to restart processing.
*/
- GNUNET_SERVER_DestroyCallback destroy;
+ GNUNET_SCHEDULER_TaskIdentifier restart_task;
/**
- * Side-buffer for incoming data used when processing
- * is suspended.
+ * Task that warns about missing calls to 'GNUNET_SERVER_receive_done'.
*/
- char *side_buf;
+ GNUNET_SCHEDULER_TaskIdentifier warn_task;
/**
- * Number of bytes in the side buffer.
+ * Time when the warn task was started.
*/
- size_t side_buf_size;
+ struct GNUNET_TIME_Absolute warn_start;
/**
* Last activity on this socket (used to time it out
struct GNUNET_TIME_Absolute last_activity;
/**
- * How many bytes in the "incoming_buffer" are currently
- * valid? (starting at offset 0).
+ * Transmission handle we return for this client from
+ * GNUNET_SERVER_notify_transmit_ready.
*/
- size_t receive_pos;
+ struct GNUNET_SERVER_TransmitHandle th;
+
+ /**
+ * After how long should an idle connection time
+ * out (on write).
+ */
+ struct GNUNET_TIME_Relative idle_timeout;
/**
* Number of external entities with a reference to
int in_process_client_buffer;
/**
- * We're about to close down this client due to some serious
- * error.
+ * We're about to close down this client.
*/
int shutdown_now;
+ /**
+ * Are we currently trying to receive? (YES if we are, NO if we are not,
+ * SYSERR if data is already available in MST).
+ */
+ int receive_pending;
+
+ /**
+ * Finish pending write when disconnecting?
+ */
+ int finish_pending_write;
+
+ /**
+ * Persist the file handle for this client no matter what happens,
+ * force the OS to close once the process actually dies. Should only
+ * be used in special cases!
+ */
+ int persist;
+
+ /**
+ * Is this client a 'monitor' client that should not be counted
+ * when deciding on destroying the server during soft shutdown?
+ * (see also GNUNET_SERVICE_start)
+ */
+ int is_monitor;
+
+ /**
+ * Type of last message processed (for warn_no_receive_done).
+ */
+ uint16_t warn_type;
};
/**
- * Scheduler says our listen socket is ready.
- * Process it!
+ * Scheduler says our listen socket is ready. Process it!
+ *
+ * @param cls handle to our server for which we are processing the listen
+ * socket
+ * @param tc reason why we are running right now
+ */
+static void
+process_listen_socket (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+
+
+/**
+ * Scheduler says our listen socket is ready. Process it!
+ *
+ * @param cls handle to our server for which we are processing the listen
+ * socket
+ * @param tc reason why we are running right now
*/
static void
-process_listen_socket (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc)
+process_listen_socket (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
struct GNUNET_SERVER_Handle *server = cls;
struct GNUNET_CONNECTION_Handle *sock;
struct GNUNET_SERVER_Client *client;
- struct GNUNET_NETWORK_FDSet *r;
+ unsigned int i;
server->listen_task = GNUNET_SCHEDULER_NO_TASK;
- r = GNUNET_NETWORK_fdset_create ();
- GNUNET_NETWORK_fdset_set (r, server->listen_socket);
if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
+ {
+ /* ignore shutdown, someone else will take care of it! */
+ GNUNET_SERVER_resume (server);
+ return;
+ }
+ i = 0;
+ while (NULL != server->listen_sockets[i])
+ {
+ if (GNUNET_NETWORK_fdset_isset (tc->read_ready, server->listen_sockets[i]))
{
- server->listen_task = GNUNET_SCHEDULER_add_select (server->sched,
- GNUNET_SCHEDULER_PRIORITY_HIGH,
- GNUNET_SCHEDULER_NO_TASK,
- GNUNET_TIME_UNIT_FOREVER_REL,
- r, NULL,
- &process_listen_socket,
- server);
- GNUNET_NETWORK_fdset_destroy (r);
- return; /* ignore shutdown, someone else will take care of it! */
- }
- GNUNET_assert (GNUNET_NETWORK_fdset_isset
- (tc->read_ready, server->listen_socket));
- sock =
- GNUNET_CONNECTION_create_from_accept (tc->sched, server->access,
- server->access_cls,
- server->listen_socket,
- server->maxbuf);
- if (sock != NULL)
- {
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Server accepted incoming connection.\n");
-#endif
- client = GNUNET_SERVER_connect_socket (server, sock);
- /* decrement reference count, we don't keep "client" alive */
- GNUNET_SERVER_client_drop (client);
+ sock =
+ GNUNET_CONNECTION_create_from_accept (server->access,
+ server->access_cls,
+ server->listen_sockets[i]);
+ if (NULL != sock)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Server accepted incoming connection.\n");
+ client = GNUNET_SERVER_connect_socket (server, sock);
+ /* decrement reference count, we don't keep "client" alive */
+ GNUNET_SERVER_client_drop (client);
+ }
}
+ i++;
+ }
/* listen for more! */
- server->listen_task = GNUNET_SCHEDULER_add_select (server->sched,
- GNUNET_SCHEDULER_PRIORITY_HIGH,
- GNUNET_SCHEDULER_NO_TASK,
- GNUNET_TIME_UNIT_FOREVER_REL,
- r, NULL,
- &process_listen_socket,
- server);
- GNUNET_NETWORK_fdset_destroy (r);
+ GNUNET_SERVER_resume (server);
}
/**
* Create and initialize a listen socket for the server.
*
+ * @param serverAddr address to listen on
+ * @param socklen length of address
* @return NULL on error, otherwise the listen socket
*/
static struct GNUNET_NETWORK_Handle *
open_listen_socket (const struct sockaddr *serverAddr, socklen_t socklen)
{
- const static int on = 1;
struct GNUNET_NETWORK_Handle *sock;
uint16_t port;
+ int eno;
switch (serverAddr->sa_family)
- {
- case AF_INET:
- port = ntohs (((const struct sockaddr_in *) serverAddr)->sin_port);
- break;
- case AF_INET6:
- port = ntohs (((const struct sockaddr_in6 *) serverAddr)->sin6_port);
- break;
- default:
- GNUNET_break (0);
- return NULL;
- }
+ {
+ case AF_INET:
+ port = ntohs (((const struct sockaddr_in *) serverAddr)->sin_port);
+ break;
+ case AF_INET6:
+ port = ntohs (((const struct sockaddr_in6 *) serverAddr)->sin6_port);
+ break;
+ case AF_UNIX:
+ port = 0;
+ break;
+ default:
+ GNUNET_break (0);
+ port = 0;
+ break;
+ }
sock = GNUNET_NETWORK_socket_create (serverAddr->sa_family, SOCK_STREAM, 0);
if (NULL == sock)
- {
- GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
- return NULL;
- }
- if (GNUNET_NETWORK_socket_setsockopt
- (sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof (on)) != GNUNET_OK)
- GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
- "setsockopt");
+ {
+ LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket");
+ errno = 0;
+ return NULL;
+ }
/* bind the socket */
- if (GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen) != GNUNET_OK)
+ if (GNUNET_OK != GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen))
+ {
+ eno = errno;
+ if (EADDRINUSE != errno)
{
- GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _
- ("`%s' failed for port %d. Is the service already running?\n"),
- "bind", port);
- GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
- return NULL;
+ /* we don't log 'EADDRINUSE' here since an IPv4 bind may
+ * fail if we already took the port on IPv6; if both IPv4 and
+ * IPv6 binds fail, then our caller will log using the
+ * errno preserved in 'eno' */
+ LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "bind");
+ if (0 != port)
+ LOG (GNUNET_ERROR_TYPE_ERROR, _("`%s' failed for port %d (%s).\n"),
+ "bind", port,
+ (AF_INET == serverAddr->sa_family) ? "IPv4" : "IPv6");
+ eno = 0;
}
- if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
+ else
{
- GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
- GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
- return NULL;
+ if (0 != port)
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ _("`%s' failed for port %d (%s): address already in use\n"),
+ "bind", port,
+ (AF_INET == serverAddr->sa_family) ? "IPv4" : "IPv6");
+ else if (AF_UNIX == serverAddr->sa_family)
+ {
+ const struct sockaddr_un *un = (const struct sockaddr_un *) serverAddr;
+ unsigned int off = 0;
+
+ if ('\0' == un->sun_path[0])
+ off = 1; /* some UNIXPATHs start with 0 */
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ _("`%s' failed for `%.*s': address already in use\n"), "bind",
+ (int) ((sizeof (un->sun_path) - off)),
+ (&un->sun_path[off]));
+ }
}
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Server starts to listen on port %u.\n", port);
-#endif
+ GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
+ errno = eno;
+ return NULL;
+ }
+ if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
+ {
+ LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "listen");
+ GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
+ errno = 0;
+ return NULL;
+ }
+ if (0 != port)
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Server starts to listen on port %u.\n",
+ port);
return sock;
}
/**
* Create a new server.
*
- * @param sched scheduler to use
* @param access function for access control
* @param access_cls closure for access
- * @param serverAddr address to listen on (including port), use NULL
- * for internal server (no listening)
- * @param socklen length of serverAddr
- * @param maxbuf maximum write buffer size for accepted sockets
+ * @param lsocks NULL-terminated array of listen sockets
* @param idle_timeout after how long should we timeout idle connections?
* @param require_found if YES, connections sending messages of unknown type
* will be closed
* (typically, "port" already in use)
*/
struct GNUNET_SERVER_Handle *
-GNUNET_SERVER_create (struct GNUNET_SCHEDULER_Handle *sched,
- GNUNET_CONNECTION_AccessCheck access,
- void *access_cls,
- const struct sockaddr *serverAddr,
- socklen_t socklen,
- size_t maxbuf,
- struct GNUNET_TIME_Relative
- idle_timeout, int require_found)
+GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access,
+ void *access_cls,
+ struct GNUNET_NETWORK_Handle **lsocks,
+ struct GNUNET_TIME_Relative idle_timeout,
+ int require_found)
{
- struct GNUNET_SERVER_Handle *ret;
- struct GNUNET_NETWORK_Handle *lsock;
- struct GNUNET_NETWORK_FDSet *r;
+ struct GNUNET_SERVER_Handle *server;
+
+ server = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
+ server->idle_timeout = idle_timeout;
+ server->listen_sockets = lsocks;
+ server->access = access;
+ server->access_cls = access_cls;
+ server->require_found = require_found;
+ if (NULL != lsocks)
+ GNUNET_SERVER_resume (server);
+ return server;
+}
+
- lsock = NULL;
- if (serverAddr != NULL)
+/**
+ * Create a new server.
+ *
+ * @param access function for access control
+ * @param access_cls closure for access
+ * @param serverAddr address to listen on (including port), NULL terminated array
+ * @param socklen length of serverAddr
+ * @param idle_timeout after how long should we timeout idle connections?
+ * @param require_found if YES, connections sending messages of unknown type
+ * will be closed
+ * @return handle for the new server, NULL on error
+ * (typically, "port" already in use)
+ */
+struct GNUNET_SERVER_Handle *
+GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access, void *access_cls,
+ struct sockaddr *const *serverAddr,
+ const socklen_t * socklen,
+ struct GNUNET_TIME_Relative idle_timeout,
+ int require_found)
+{
+ struct GNUNET_NETWORK_Handle **lsocks;
+ unsigned int i;
+ unsigned int j;
+ unsigned int k;
+ int seen;
+
+ i = 0;
+ while (NULL != serverAddr[i])
+ i++;
+ if (i > 0)
+ {
+ lsocks = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (i + 1));
+ i = 0;
+ j = 0;
+ while (NULL != serverAddr[i])
{
- lsock = open_listen_socket (serverAddr, socklen);
- if (lsock == NULL)
- return NULL;
+ seen = 0;
+ for (k=0;k<i;k++)
+ if ( (socklen[k] == socklen[i]) &&
+ (0 == memcmp (serverAddr[k], serverAddr[i], socklen[i])) )
+ {
+ seen = 1;
+ break;
+ }
+ if (0 != seen)
+ {
+ /* duplicate address, skip */
+ i++;
+ continue;
+ }
+ lsocks[j] = open_listen_socket (serverAddr[i], socklen[i]);
+ if (NULL != lsocks[j])
+ j++;
+ i++;
}
- ret = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
- ret->sched = sched;
- ret->maxbuf = maxbuf;
- ret->idle_timeout = idle_timeout;
- ret->listen_socket = lsock;
- ret->access = access;
- ret->access_cls = access_cls;
- ret->require_found = require_found;
- if (lsock != NULL)
+ if (0 == j)
{
- r = GNUNET_NETWORK_fdset_create ();
- GNUNET_NETWORK_fdset_set (r, ret->listen_socket);
- ret->listen_task = GNUNET_SCHEDULER_add_select (sched,
- GNUNET_SCHEDULER_PRIORITY_HIGH,
- GNUNET_SCHEDULER_NO_TASK,
- GNUNET_TIME_UNIT_FOREVER_REL,
- r, NULL,
- &process_listen_socket,
- ret);
- GNUNET_NETWORK_fdset_destroy (r);
+ if (0 != errno)
+ LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "bind");
+ GNUNET_free (lsocks);
+ lsocks = NULL;
}
- return ret;
+ }
+ else
+ {
+ lsocks = NULL;
+ }
+ return GNUNET_SERVER_create_with_sockets (access, access_cls, lsocks,
+ idle_timeout, require_found);
+}
+
+
+/**
+ * Set the 'monitor' flag on this client. Clients which have been
+ * marked as 'monitors' won't prevent the server from shutting down
+ * once 'GNUNET_SERVER_stop_listening' has been invoked. The idea is
+ * that for "normal" clients we likely want to allow them to process
+ * their requests; however, monitor-clients are likely to 'never'
+ * disconnect during shutdown and thus will not be considered when
+ * determining if the server should continue to exist after
+ * 'GNUNET_SERVER_destroy' has been called.
+ *
+ * @param client the client to set the 'monitor' flag on
+ */
+void
+GNUNET_SERVER_client_mark_monitor (struct GNUNET_SERVER_Client *client)
+{
+ client->is_monitor = GNUNET_YES;
+}
+
+
+/**
+ * Helper function for 'test_monitor_clients' to trigger
+ * 'GNUNET_SERVER_destroy' after the stack has unwound.
+ *
+ * @param cls the 'struct GNUNET_SERVER_Handle' to destroy
+ * @param tc unused
+ */
+static void
+do_destroy (void *cls,
+ const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+ struct GNUNET_SERVER_Handle *server = cls;
+ GNUNET_SERVER_destroy (server);
+}
+
+
+/**
+ * Check if only 'monitor' clients are left. If so, destroy the
+ * server completely.
+ *
+ * @param server server to test for full shutdown
+ */
+static void
+test_monitor_clients (struct GNUNET_SERVER_Handle *server)
+{
+ struct GNUNET_SERVER_Client *client;
+
+ if (GNUNET_YES != server->in_soft_shutdown)
+ return;
+ for (client = server->clients_head; NULL != client; client = client->next)
+ if (GNUNET_NO == client->is_monitor)
+ return; /* not done yet */
+ server->in_soft_shutdown = GNUNET_SYSERR;
+ GNUNET_SCHEDULER_add_continuation (&do_destroy, server,
+ GNUNET_SCHEDULER_REASON_PREREQ_DONE);
+}
+
+
+/**
+ * Suspend accepting connections from the listen socket temporarily.
+ *
+ * @param server server to stop accepting connections.
+ */
+void
+GNUNET_SERVER_suspend (struct GNUNET_SERVER_Handle *server)
+{
+ if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
+ {
+ GNUNET_SCHEDULER_cancel (server->listen_task);
+ server->listen_task = GNUNET_SCHEDULER_NO_TASK;
+ }
+}
+
+
+/**
+ * Resume accepting connections from the listen socket.
+ *
+ * @param server server to stop accepting connections.
+ */
+void
+GNUNET_SERVER_resume (struct GNUNET_SERVER_Handle *server)
+{
+ struct GNUNET_NETWORK_FDSet *r;
+ unsigned int i;
+
+ if (NULL == server->listen_sockets)
+ return;
+ if (NULL == server->listen_sockets[0])
+ return; /* nothing to do, no listen sockets! */
+ if (NULL == server->listen_sockets[1])
+ {
+ /* simplified method: no fd set needed; this is then much simpler and
+ much more efficient */
+ server->listen_task =
+ GNUNET_SCHEDULER_add_read_net_with_priority (GNUNET_TIME_UNIT_FOREVER_REL,
+ GNUNET_SCHEDULER_PRIORITY_HIGH,
+ server->listen_sockets[0],
+ &process_listen_socket, server);
+ return;
+ }
+ r = GNUNET_NETWORK_fdset_create ();
+ i = 0;
+ while (NULL != server->listen_sockets[i])
+ GNUNET_NETWORK_fdset_set (r, server->listen_sockets[i++]);
+ server->listen_task =
+ GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
+ GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
+ &process_listen_socket, server);
+ GNUNET_NETWORK_fdset_destroy (r);
+}
+
+
+/**
+ * Stop the listen socket and get ready to shutdown the server
+ * once only 'monitor' clients are left.
+ *
+ * @param server server to stop listening on
+ */
+void
+GNUNET_SERVER_stop_listening (struct GNUNET_SERVER_Handle *server)
+{
+ unsigned int i;
+
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Server in soft shutdown\n");
+ if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
+ {
+ GNUNET_SCHEDULER_cancel (server->listen_task);
+ server->listen_task = GNUNET_SCHEDULER_NO_TASK;
+ }
+ if (NULL != server->listen_sockets)
+ {
+ i = 0;
+ while (NULL != server->listen_sockets[i])
+ GNUNET_break (GNUNET_OK ==
+ GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
+ GNUNET_free (server->listen_sockets);
+ server->listen_sockets = NULL;
+ }
+ if (GNUNET_NO == server->in_soft_shutdown)
+ server->in_soft_shutdown = GNUNET_YES;
+ test_monitor_clients (server);
}
/**
* Free resources held by this server.
+ *
+ * @param server server to destroy
*/
void
-GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *s)
+GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *server)
{
- struct GNUNET_SERVER_Client *pos;
struct HandlerList *hpos;
struct NotifyList *npos;
+ unsigned int i;
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Server shutting down.\n");
-#endif
- if (GNUNET_SCHEDULER_NO_TASK != s->listen_task)
- {
- GNUNET_SCHEDULER_cancel (s->sched, s->listen_task);
- s->listen_task = GNUNET_SCHEDULER_NO_TASK;
- }
- GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (s->listen_socket));
- s->listen_socket = NULL;
- while (s->clients != NULL)
- {
- pos = s->clients;
- s->clients = pos->next;
- pos->server = NULL;
- }
- while (NULL != (hpos = s->handlers))
- {
- s->handlers = hpos->next;
- GNUNET_free (hpos);
- }
- while (NULL != (npos = s->disconnect_notify_list))
- {
- s->disconnect_notify_list = npos->next;
- GNUNET_free (npos);
- }
- GNUNET_free (s);
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Server shutting down.\n");
+ if (GNUNET_SCHEDULER_NO_TASK != server->listen_task)
+ {
+ GNUNET_SCHEDULER_cancel (server->listen_task);
+ server->listen_task = GNUNET_SCHEDULER_NO_TASK;
+ }
+ if (NULL != server->listen_sockets)
+ {
+ i = 0;
+ while (NULL != server->listen_sockets[i])
+ GNUNET_break (GNUNET_OK ==
+ GNUNET_NETWORK_socket_close (server->listen_sockets[i++]));
+ GNUNET_free (server->listen_sockets);
+ server->listen_sockets = NULL;
+ }
+ while (NULL != server->clients_head)
+ GNUNET_SERVER_client_disconnect (server->clients_head);
+ while (NULL != (hpos = server->handlers))
+ {
+ server->handlers = hpos->next;
+ GNUNET_free (hpos);
+ }
+ while (NULL != (npos = server->disconnect_notify_list_head))
+ {
+ npos->callback (npos->callback_cls, NULL);
+ GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
+ server->disconnect_notify_list_tail,
+ npos);
+ GNUNET_free (npos);
+ }
+ GNUNET_free (server);
}
*/
void
GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
- const struct GNUNET_SERVER_MessageHandler
- *handlers)
+ const struct GNUNET_SERVER_MessageHandler *handlers)
{
struct HandlerList *p;
}
+/**
+ * Change functions used by the server to tokenize the message stream.
+ * (very rarely used).
+ *
+ * @param server server to modify
+ * @param create new tokenizer initialization function
+ * @param destroy new tokenizer destruction function
+ * @param receive new tokenizer receive function
+ * @param cls closure for 'create', 'receive', 'destroy'
+ */
+void
+GNUNET_SERVER_set_callbacks (struct GNUNET_SERVER_Handle *server,
+ GNUNET_SERVER_MstCreateCallback create,
+ GNUNET_SERVER_MstDestroyCallback destroy,
+ GNUNET_SERVER_MstReceiveCallback receive,
+ void *cls)
+{
+ server->mst_create = create;
+ server->mst_destroy = destroy;
+ server->mst_receive = receive;
+ server->mst_cls = cls;
+}
+
+
+/**
+ * Task run to warn about missing calls to 'GNUNET_SERVER_receive_done'.
+ *
+ * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
+ * @param tc scheduler context (unused)
+ */
+static void
+warn_no_receive_done (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+ struct GNUNET_SERVER_Client *client = cls;
+
+ GNUNET_break (0 != client->warn_type); /* type should never be 0 here, as we don't use 0 */
+ client->warn_task =
+ GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
+ &warn_no_receive_done, client);
+ if (0 == (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ _("Processing code for message of type %u did not call `GNUNET_SERVER_receive_done' after %s\n"),
+ (unsigned int) client->warn_type,
+ GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (client->warn_start), GNUNET_YES));
+}
+
+
+/**
+ * Disable the warning the server issues if a message is not acknowledged
+ * in a timely fashion. Use this call if a client is intentionally delayed
+ * for a while. Only applies to the current message.
+ *
+ * @param client client for which to disable the warning
+ */
+void
+GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client *client)
+{
+ if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
+ {
+ GNUNET_SCHEDULER_cancel (client->warn_task);
+ client->warn_task = GNUNET_SCHEDULER_NO_TASK;
+ }
+}
+
+
/**
* Inject a message into the server, pretend it came
* from the specified client. Delivery of the message
type = ntohs (message->type);
size = ntohs (message->size);
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Server schedules transmission of %u-byte message of type %u to client.\n",
- size, type);
-#endif
- pos = server->handlers;
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Server schedules transmission of %u-byte message of type %u to client.\n",
+ size, type);
found = GNUNET_NO;
- while (pos != NULL)
+ for (pos = server->handlers; NULL != pos; pos = pos->next)
+ {
+ i = 0;
+ while (pos->handlers[i].callback != NULL)
{
- i = 0;
- while (pos->handlers[i].callback != NULL)
+ mh = &pos->handlers[i];
+ if ((mh->type == type) || (mh->type == GNUNET_MESSAGE_TYPE_ALL))
+ {
+ if ((0 != mh->expected_size) && (mh->expected_size != size))
{
- mh = &pos->handlers[i];
- if (mh->type == type)
- {
- if ((mh->expected_size != 0) && (mh->expected_size != size))
- {
- GNUNET_break_op (0);
- return GNUNET_SYSERR;
- }
- if (sender != NULL)
- sender->suspended++;
- mh->callback (mh->callback_cls, sender, message);
- found = GNUNET_YES;
- }
- i++;
+#if GNUNET8_NETWORK_IS_DEAD
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ "Expected %u bytes for message of type %u, got %u\n",
+ mh->expected_size, mh->type, size);
+ GNUNET_break_op (0);
+#endif
+ return GNUNET_SYSERR;
}
- pos = pos->next;
- }
- if (found == GNUNET_NO)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
- _("Received message of unknown type %d\n"), type);
- if (server->require_found == GNUNET_YES)
- return GNUNET_SYSERR;
+ if (NULL != sender)
+ {
+ if ( (0 == sender->suspended) &&
+ (GNUNET_SCHEDULER_NO_TASK == sender->warn_task) )
+ {
+ GNUNET_break (0 != type); /* type should never be 0 here, as we don't use 0 */
+ sender->warn_start = GNUNET_TIME_absolute_get ();
+ sender->warn_task =
+ GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
+ &warn_no_receive_done, sender);
+ sender->warn_type = type;
+ }
+ sender->suspended++;
+ }
+ mh->callback (mh->callback_cls, sender, message);
+ found = GNUNET_YES;
+ }
+ i++;
}
+ }
+ if (GNUNET_NO == found)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
+ "Received message of unknown type %d\n", type);
+ if (GNUNET_YES == server->require_found)
+ return GNUNET_SYSERR;
+ }
return GNUNET_OK;
}
/**
- * We're finished with this client and especially its input
- * processing. If the RC is zero, free all resources otherwise wait
- * until RC hits zero to do so.
+ * We are receiving an incoming message. Process it.
+ *
+ * @param cls our closure (handle for the client)
+ * @param buf buffer with data received from network
+ * @param available number of bytes available in buf
+ * @param addr address of the sender
+ * @param addrlen length of addr
+ * @param errCode code indicating errors receiving, 0 for success
*/
static void
-shutdown_incoming_processing (struct GNUNET_SERVER_Client *client)
-{
- struct GNUNET_SERVER_Client *prev;
- struct GNUNET_SERVER_Client *pos;
- struct GNUNET_SERVER_Handle *server;
- struct NotifyList *n;
- unsigned int rc;
-
- rc = client->reference_count;
- if (client->server != NULL)
- {
- server = client->server;
- client->server = NULL;
- prev = NULL;
- pos = server->clients;
- while ((pos != NULL) && (pos != client))
- {
- prev = pos;
- pos = pos->next;
- }
- GNUNET_assert (pos != NULL);
- if (prev == NULL)
- server->clients = pos->next;
- else
- prev->next = pos->next;
- n = server->disconnect_notify_list;
- while (n != NULL)
- {
- n->callback (n->callback_cls, client);
- n = n->next;
- }
- }
- /* wait for RC to hit zero, then free */
- if (rc > 0)
- return;
- client->destroy (client->client_closure);
- GNUNET_free (client);
-}
+process_incoming (void *cls, const void *buf, size_t available,
+ const struct sockaddr *addr, socklen_t addrlen, int errCode);
/**
- * Go over the contents of the client buffer; as long as full messages
- * are available, pass them on for processing. Update the buffer
- * accordingly. Handles fatal errors by shutting down the connection.
+ * Process messages from the client's message tokenizer until either
+ * the tokenizer is empty (and then schedule receiving more), or
+ * until some handler is not immediately done (then wait for restart_processing)
+ * or shutdown.
*
- * @param client identifies which client receive buffer to process
+ * @param client the client to process, RC must have already been increased
+ * using GNUNET_SERVER_client_keep and will be decreased by one in this
+ * function
+ * @param ret GNUNET_NO to start processing from the buffer,
+ * GNUNET_OK if the mst buffer is drained and we should instantly go back to receiving
+ * GNUNET_SYSERR if we should instantly abort due to error in a previous step
*/
static void
-process_client_buffer (struct GNUNET_SERVER_Client *client)
+process_mst (struct GNUNET_SERVER_Client *client, int ret)
{
- struct GNUNET_SERVER_Handle *server;
- const struct GNUNET_MessageHeader *hdr;
- size_t msize;
-
- client->in_process_client_buffer = GNUNET_YES;
- server = client->server;
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Private buffer contains %u bytes; client is %s and we are %s\n",
- client->receive_pos,
- client->suspended ? "suspended" : "up",
- client->shutdown_now ? "in shutdown" : "running");
-#endif
- while ((client->receive_pos >= sizeof (struct GNUNET_MessageHeader)) &&
- (0 == client->suspended) && (GNUNET_YES != client->shutdown_now))
+ while ((GNUNET_SYSERR != ret) && (NULL != client->server) &&
+ (GNUNET_YES != client->shutdown_now) && (0 == client->suspended))
+ {
+ if (GNUNET_OK == ret)
{
- hdr = (const struct GNUNET_MessageHeader *) &client->incoming_buffer;
- msize = ntohs (hdr->size);
- if (msize > client->receive_pos)
- {
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Total message size is %u, we only have %u bytes; need more data\n",
- msize, client->receive_pos);
-#endif
- break;
- }
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Passing %u bytes to callback for processing\n", msize);
-#endif
- if ((msize < sizeof (struct GNUNET_MessageHeader)) ||
- (GNUNET_OK != GNUNET_SERVER_inject (server, client, hdr)))
- {
- client->in_process_client_buffer = GNUNET_NO;
- shutdown_incoming_processing (client);
- return;
- }
- /* FIXME: this is highly inefficient; we should
- try to avoid this if the new base address is
- already nicely aligned. See old handler code... */
- memmove (client->incoming_buffer,
- &client->incoming_buffer[msize], client->receive_pos - msize);
- client->receive_pos -= msize;
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Server re-enters receive loop, timeout: %llu.\n",
+ client->idle_timeout.rel_value);
+ client->receive_pending = GNUNET_YES;
+ GNUNET_CONNECTION_receive (client->connection,
+ GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
+ client->idle_timeout, &process_incoming,
+ client);
+ break;
}
- client->in_process_client_buffer = GNUNET_NO;
- if (GNUNET_YES == client->shutdown_now)
- shutdown_incoming_processing (client);
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Server processes additional messages instantly.\n");
+ if (NULL != client->server->mst_receive)
+ ret =
+ client->server->mst_receive (client->server->mst_cls, client->mst,
+ client, NULL, 0, GNUNET_NO, GNUNET_YES);
+ else
+ ret =
+ GNUNET_SERVER_mst_receive (client->mst, client, NULL, 0, GNUNET_NO,
+ GNUNET_YES);
+ }
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Server leaves instant processing loop: ret = %d, server = %p, shutdown = %d, suspended = %u\n",
+ ret, client->server, client->shutdown_now, client->suspended);
+ if (GNUNET_NO == ret)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Server has more data pending but is suspended.\n");
+ client->receive_pending = GNUNET_SYSERR; /* data pending */
+ }
+ if ((GNUNET_SYSERR == ret) || (GNUNET_YES == client->shutdown_now))
+ GNUNET_SERVER_client_disconnect (client);
}
* @param errCode code indicating errors receiving, 0 for success
*/
static void
-process_incoming (void *cls,
- const void *buf,
- size_t available,
+process_incoming (void *cls, const void *buf, size_t available,
const struct sockaddr *addr, socklen_t addrlen, int errCode)
{
struct GNUNET_SERVER_Client *client = cls;
struct GNUNET_SERVER_Handle *server = client->server;
- const char *cbuf = buf;
- size_t maxcpy;
-
- if ((buf == NULL) ||
- (available == 0) ||
- (errCode != 0) ||
- (server == NULL) ||
- (client->shutdown_now == GNUNET_YES) ||
- (GNUNET_YES != client->check (client->client_closure)))
- {
- /* other side closed connection, error connecting, etc. */
- shutdown_incoming_processing (client);
- return;
- }
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Server receives %u bytes from `%s'.\n",
- available, GNUNET_a2s (addr, addrlen));
-#endif
+ struct GNUNET_TIME_Absolute end;
+ struct GNUNET_TIME_Absolute now;
+ int ret;
+
+ GNUNET_assert (GNUNET_YES == client->receive_pending);
+ client->receive_pending = GNUNET_NO;
+ now = GNUNET_TIME_absolute_get ();
+ end = GNUNET_TIME_absolute_add (client->last_activity, client->idle_timeout);
+
+ if ((NULL == buf) && (0 == available) && (NULL == addr) && (0 == errCode) &&
+ (GNUNET_YES != client->shutdown_now) && (NULL != server) &&
+ (GNUNET_YES == GNUNET_CONNECTION_check (client->connection)) &&
+ (end.abs_value > now.abs_value))
+ {
+ /* wait longer, timeout changed (i.e. due to us sending) */
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Receive time out, but no disconnect due to sending (%p)\n",
+ GNUNET_a2s (addr, addrlen));
+ client->receive_pending = GNUNET_YES;
+ GNUNET_CONNECTION_receive (client->connection,
+ GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
+ GNUNET_TIME_absolute_get_remaining (end),
+ &process_incoming, client);
+ return;
+ }
+ if ((NULL == buf) || (0 == available) || (0 != errCode) || (NULL == server) ||
+ (GNUNET_YES == client->shutdown_now) ||
+ (GNUNET_YES != GNUNET_CONNECTION_check (client->connection)))
+ {
+ /* other side closed connection, error connecting, etc. */
+ GNUNET_SERVER_client_disconnect (client);
+ return;
+ }
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Server receives %u bytes from `%s'.\n",
+ (unsigned int) available, GNUNET_a2s (addr, addrlen));
GNUNET_SERVER_client_keep (client);
- client->last_activity = GNUNET_TIME_absolute_get ();
- /* process data (if available) */
- while (available > 0)
- {
- maxcpy = available;
- if (maxcpy > sizeof (client->incoming_buffer) - client->receive_pos)
- maxcpy = sizeof (client->incoming_buffer) - client->receive_pos;
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Can copy %u bytes to private buffer\n", maxcpy);
-#endif
- memcpy (&client->incoming_buffer[client->receive_pos], cbuf, maxcpy);
- client->receive_pos += maxcpy;
- cbuf += maxcpy;
- available -= maxcpy;
- if (0 < client->suspended)
- {
- if (available > 0)
- {
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Client has suspended processing; copying %u bytes to side buffer to be used later.\n",
- available);
-#endif
- GNUNET_assert (client->side_buf_size == 0);
- GNUNET_assert (client->side_buf == NULL);
- client->side_buf_size = available;
- client->side_buf = GNUNET_malloc (available);
- memcpy (client->side_buf, cbuf, available);
- available = 0;
- }
- break; /* do not run next client iteration! */
- }
-#if DEBUG_SERVER
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Now processing messages in private buffer\n");
-#endif
- process_client_buffer (client);
- }
- GNUNET_assert (available == 0);
- if ((client->suspended == 0) &&
- (GNUNET_YES != client->shutdown_now) && (client->server != NULL))
- {
- /* Finally, keep receiving! */
- client->receive (client->client_closure,
- GNUNET_SERVER_MAX_MESSAGE_SIZE,
- server->idle_timeout, &process_incoming, client);
- }
- if (GNUNET_YES == client->shutdown_now)
- shutdown_incoming_processing (client);
+ client->last_activity = now;
+
+ if (NULL != server->mst_receive)
+ ret =
+ client->server->mst_receive (client->server->mst_cls, client->mst,
+ client, buf, available, GNUNET_NO, GNUNET_YES);
+ else if (NULL != client->mst)
+ {
+ ret =
+ GNUNET_SERVER_mst_receive (client->mst, client, buf, available, GNUNET_NO,
+ GNUNET_YES);
+ }
+ else
+ {
+ GNUNET_break (0);
+ return;
+ }
+
+ process_mst (client, ret);
GNUNET_SERVER_client_drop (client);
}
/**
- * FIXME: document.
+ * Task run to start again receiving from the network
+ * and process requests.
+ *
+ * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
+ * @param tc scheduler context (unused)
*/
static void
restart_processing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
struct GNUNET_SERVER_Client *client = cls;
+ GNUNET_assert (GNUNET_YES != client->shutdown_now);
+ client->restart_task = GNUNET_SCHEDULER_NO_TASK;
+ if (GNUNET_NO == client->receive_pending)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Server begins to read again from client.\n");
+ client->receive_pending = GNUNET_YES;
+ GNUNET_CONNECTION_receive (client->connection,
+ GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
+ client->idle_timeout, &process_incoming, client);
+ return;
+ }
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Server continues processing messages still in the buffer.\n");
GNUNET_SERVER_client_keep (client);
- process_client_buffer (client);
- if (0 == client->suspended)
- client->receive (client->client_closure,
- GNUNET_SERVER_MAX_MESSAGE_SIZE,
- client->server->idle_timeout, &process_incoming, client);
+ client->receive_pending = GNUNET_NO;
+ process_mst (client, GNUNET_NO);
GNUNET_SERVER_client_drop (client);
}
/**
- * Add a client to the set of our clients and
- * start receiving.
- */
-static void
-add_client (struct GNUNET_SERVER_Handle *server,
- struct GNUNET_SERVER_Client *client)
-{
- client->server = server;
- client->last_activity = GNUNET_TIME_absolute_get ();
- client->next = server->clients;
- server->clients = client;
- client->receive (client->client_closure,
- GNUNET_SERVER_MAX_MESSAGE_SIZE,
- server->idle_timeout, &process_incoming, client);
-}
-
-
-/**
- * Create a request for receiving data from a socket.
+ * This function is called whenever our inbound message tokenizer has
+ * received a complete message.
*
- * @param cls identifies the socket to receive from
- * @param max how much data to read at most
- * @param timeout when should this operation time out
- * @param receiver function to call for processing
- * @param receiver_cls closure for receiver
- */
-static void
-sock_receive (void *cls,
- size_t max,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_CONNECTION_Receiver receiver, void *receiver_cls)
-{
- GNUNET_CONNECTION_receive (cls, max, timeout, receiver, receiver_cls);
-}
-
-
-/**
- * Wrapper to cancel receiving from a socket.
- *
- * @param cls handle to the GNUNET_CONNECTION_Handle to cancel
- */
-static void
-sock_receive_cancel (void *cls)
-{
- GNUNET_CONNECTION_receive_cancel (cls);
-}
-
-
-/**
- * FIXME: document.
- */
-static void *
-sock_notify_transmit_ready (void *cls,
- size_t size,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_CONNECTION_TransmitReadyNotify notify,
- void *notify_cls)
-{
- return GNUNET_CONNECTION_notify_transmit_ready (cls, size, timeout, notify,
- notify_cls);
-}
-
-
-/**
- * FIXME: document.
- */
-static void
-sock_notify_transmit_ready_cancel (void *cls, void *h)
-{
- GNUNET_CONNECTION_notify_transmit_ready_cancel (h);
-}
-
-
-/**
- * Check if socket is still valid (no fatal errors have happened so far).
+ * @param cls closure (struct GNUNET_SERVER_Handle)
+ * @param client identification of the client (struct GNUNET_SERVER_Client*)
+ * @param message the actual message
*
- * @param cls the socket
- * @return GNUNET_YES if valid, GNUNET_NO otherwise
+ * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
*/
static int
-sock_check (void *cls)
+client_message_tokenizer_callback (void *cls, void *client,
+ const struct GNUNET_MessageHeader *message)
{
- return GNUNET_CONNECTION_check (cls);
-}
-
-
-/**
- * Destroy this socket (free resources).
- *
- * @param cls the socket
- */
-static void
-sock_destroy (void *cls)
-{
- GNUNET_CONNECTION_destroy (cls);
+ struct GNUNET_SERVER_Handle *server = cls;
+ struct GNUNET_SERVER_Client *sender = client;
+ int ret;
+
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Tokenizer gives server message of type %u from client\n",
+ ntohs (message->type));
+ sender->in_process_client_buffer = GNUNET_YES;
+ ret = GNUNET_SERVER_inject (server, sender, message);
+ sender->in_process_client_buffer = GNUNET_NO;
+ if ( (GNUNET_OK != ret) || (GNUNET_YES == sender->shutdown_now) )
+ {
+ GNUNET_SERVER_client_disconnect (sender);
+ return GNUNET_SYSERR;
+ }
+ return GNUNET_OK;
}
* "client_drop" on the return value eventually)
*/
struct GNUNET_SERVER_Client *
-GNUNET_SERVER_connect_socket (struct
- GNUNET_SERVER_Handle
- *server,
+GNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server,
struct GNUNET_CONNECTION_Handle *connection)
{
struct GNUNET_SERVER_Client *client;
client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
- client->client_closure = connection;
- client->receive = &sock_receive;
- client->receive_cancel = &sock_receive_cancel;
- client->notify_transmit_ready = &sock_notify_transmit_ready;
- client->notify_transmit_ready_cancel = &sock_notify_transmit_ready_cancel;
- client->check = &sock_check;
- client->destroy = &sock_destroy;
+ client->connection = connection;
client->reference_count = 1;
- add_client (server, client);
+ client->server = server;
+ client->last_activity = GNUNET_TIME_absolute_get ();
+ client->idle_timeout = server->idle_timeout;
+ GNUNET_CONTAINER_DLL_insert (server->clients_head,
+ server->clients_tail,
+ client);
+ if (NULL != server->mst_create)
+ client->mst =
+ server->mst_create (server->mst_cls, client);
+ else
+ client->mst =
+ GNUNET_SERVER_mst_create (&client_message_tokenizer_callback, server);
+ GNUNET_assert (NULL != client->mst);
+ client->receive_pending = GNUNET_YES;
+ GNUNET_CONNECTION_receive (client->connection,
+ GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
+ client->idle_timeout, &process_incoming, client);
return client;
}
/**
- * Add an arbitrary connection to the set of handles managed by this
- * server. This can be used if a sending and receiving does not
- * really go over the network (internal transmission) or for servers
- * using UDP.
+ * Change the timeout for a particular client. Decreasing the timeout
+ * may not go into effect immediately (only after the previous timeout
+ * times out or activity happens on the socket).
*
- * @param server the server to use
- * @param chandle opaque handle for the connection
- * @param creceive receive function for the connection
- * @param ccancel cancel receive function for the connection
- * @param cnotify transmit notification function for the connection
- * @param cnotify_cancel transmit notification cancellation function for the connection
- * @param ccheck function to test if the connection is still up
- * @param cdestroy function to close and free the connection
- * @return the client handle (client should call
- * "client_drop" on the return value eventually)
+ * @param client the client to update
+ * @param timeout new timeout for activities on the socket
*/
-struct GNUNET_SERVER_Client *
-GNUNET_SERVER_connect_callback (struct
- GNUNET_SERVER_Handle
- *server,
- void *chandle,
- GNUNET_SERVER_ReceiveCallback
- creceive,
- GNUNET_SERVER_ReceiveCancelCallback
- ccancel,
- GNUNET_SERVER_TransmitReadyCallback
- cnotify,
- GNUNET_SERVER_TransmitReadyCancelCallback
- cnotify_cancel,
- GNUNET_SERVER_CheckCallback
- ccheck,
- GNUNET_SERVER_DestroyCallback cdestroy)
+void
+GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client,
+ struct GNUNET_TIME_Relative timeout)
{
- struct GNUNET_SERVER_Client *client;
-
- client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
- client->client_closure = chandle;
- client->receive = creceive;
- client->receive_cancel = ccancel;
- client->notify_transmit_ready = cnotify;
- client->notify_transmit_ready_cancel = cnotify_cancel;
- client->check = ccheck;
- client->destroy = cdestroy;
- client->reference_count = 1;
- add_client (server, client);
- return client;
+ client->idle_timeout = timeout;
}
{
GNUNET_assert (client->reference_count > 0);
client->reference_count--;
- if ((client->server == NULL) && (client->reference_count == 0))
- shutdown_incoming_processing (client);
+ if ((GNUNET_YES == client->shutdown_now) && (0 == client->reference_count))
+ GNUNET_SERVER_client_disconnect (client);
}
GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
void **addr, size_t * addrlen)
{
- if (client->receive != &sock_receive)
- return GNUNET_SYSERR; /* not a network client */
- return GNUNET_CONNECTION_get_address (client->client_closure,
- addr, addrlen);
+ return GNUNET_CONNECTION_get_address (client->connection, addr, addrlen);
}
n = GNUNET_malloc (sizeof (struct NotifyList));
n->callback = callback;
n->callback_cls = callback_cls;
- n->next = server->disconnect_notify_list;
- server->disconnect_notify_list = n;
+ GNUNET_CONTAINER_DLL_insert (server->disconnect_notify_list_head,
+ server->disconnect_notify_list_tail,
+ n);
+}
+
+
+/**
+ * Ask the server to stop notifying us whenever a client disconnects.
+ *
+ * @param server the server manageing the clients
+ * @param callback function to call on disconnect
+ * @param callback_cls closure for callback
+ */
+void
+GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
+ GNUNET_SERVER_DisconnectCallback
+ callback, void *callback_cls)
+{
+ struct NotifyList *pos;
+
+ for (pos = server->disconnect_notify_list_head; NULL != pos; pos = pos->next)
+ if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
+ break;
+ if (NULL == pos)
+ {
+ GNUNET_break (0);
+ return;
+ }
+ GNUNET_CONTAINER_DLL_remove (server->disconnect_notify_list_head,
+ server->disconnect_notify_list_tail,
+ pos);
+ GNUNET_free (pos);
+}
+
+
+/**
+ * Destroy the connection that is passed in via 'cls'. Used
+ * as calling 'GNUNET_CONNECTION_destroy' from within a function
+ * that was itself called from within 'process_notify' of
+ * 'connection.c' is not allowed (see #2329).
+ *
+ * @param cls connection to destroy
+ * @param tc scheduler context (unused)
+ */
+static void
+destroy_connection (void *cls,
+ const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+ struct GNUNET_CONNECTION_Handle *connection = cls;
+
+ GNUNET_CONNECTION_destroy (connection);
}
void
GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
{
- if (client->server == NULL)
- return; /* already disconnected */
- client->receive_cancel (client->client_closure);
- shutdown_incoming_processing (client);
+ struct GNUNET_SERVER_Handle *server = client->server;
+ struct NotifyList *n;
+
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Client is being disconnected from the server.\n");
+ if (GNUNET_SCHEDULER_NO_TASK != client->restart_task)
+ {
+ GNUNET_SCHEDULER_cancel (client->restart_task);
+ client->restart_task = GNUNET_SCHEDULER_NO_TASK;
+ }
+ if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
+ {
+ GNUNET_SCHEDULER_cancel (client->warn_task);
+ client->warn_task = GNUNET_SCHEDULER_NO_TASK;
+ }
+ if (GNUNET_YES == client->receive_pending)
+ {
+ GNUNET_CONNECTION_receive_cancel (client->connection);
+ client->receive_pending = GNUNET_NO;
+ }
+ client->shutdown_now = GNUNET_YES;
+ client->reference_count++; /* make sure nobody else clean up client... */
+ if ( (NULL != client->mst) &&
+ (NULL != server) )
+ {
+ GNUNET_CONTAINER_DLL_remove (server->clients_head,
+ server->clients_tail,
+ client);
+ if (NULL != server->mst_destroy)
+ server->mst_destroy (server->mst_cls, client->mst);
+ else
+ GNUNET_SERVER_mst_destroy (client->mst);
+ client->mst = NULL;
+ for (n = server->disconnect_notify_list_head; NULL != n; n = n->next)
+ n->callback (n->callback_cls, client);
+ }
+ client->reference_count--;
+ if (client->reference_count > 0)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "RC still positive, not destroying everything.\n");
+ client->server = NULL;
+ return;
+ }
+ if (GNUNET_YES == client->in_process_client_buffer)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Still processing inputs, not destroying everything.\n");
+ return;
+ }
+ if (GNUNET_YES == client->persist)
+ GNUNET_CONNECTION_persist_ (client->connection);
+ if (NULL != client->th.cth)
+ GNUNET_SERVER_notify_transmit_ready_cancel (&client->th);
+ (void) GNUNET_SCHEDULER_add_now (&destroy_connection,
+ client->connection);
+ /* need to cancel again, as it might have been re-added
+ in the meantime (i.e. during callbacks) */
+ if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
+ {
+ GNUNET_SCHEDULER_cancel (client->warn_task);
+ client->warn_task = GNUNET_SCHEDULER_NO_TASK;
+ }
+ if (GNUNET_YES == client->receive_pending)
+ {
+ GNUNET_CONNECTION_receive_cancel (client->connection);
+ client->receive_pending = GNUNET_NO;
+ }
+ GNUNET_free (client);
+ /* we might be in soft-shutdown, test if we're done */
+ if (NULL != server)
+ test_monitor_clients (server);
+}
+
+
+/**
+ * Disable the "CORK" feature for communication with the given client,
+ * forcing the OS to immediately flush the buffer on transmission
+ * instead of potentially buffering multiple messages.
+ *
+ * @param client handle to the client
+ * @return GNUNET_OK on success
+ */
+int
+GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client)
+{
+ return GNUNET_CONNECTION_disable_corking (client->connection);
+}
+
+
+/**
+ * Wrapper for transmission notification that calls the original
+ * callback and update the last activity time for our connection.
+ *
+ * @param cls the 'struct GNUNET_SERVER_Client'
+ * @param size number of bytes we can transmit
+ * @param buf where to copy the message
+ * @return number of bytes actually transmitted
+ */
+static size_t
+transmit_ready_callback_wrapper (void *cls, size_t size, void *buf)
+{
+ struct GNUNET_SERVER_Client *client = cls;
+ GNUNET_CONNECTION_TransmitReadyNotify callback;
+
+ client->th.cth = NULL;
+ callback = client->th.callback;
+ client->th.callback = NULL;
+ client->last_activity = GNUNET_TIME_absolute_get ();
+ return callback (client->th.callback_cls, size, buf);
}
* @param callback_cls closure for callback
* @return non-NULL if the notify callback was queued; can be used
* to cancel the request using
- * GNUNET_CONNECTION_notify_transmit_ready_cancel.
+ * GNUNET_SERVER_notify_transmit_ready_cancel.
* NULL if we are already going to notify someone else (busy)
*/
-struct GNUNET_CONNECTION_TransmitHandle *
+struct GNUNET_SERVER_TransmitHandle *
GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
size_t size,
struct GNUNET_TIME_Relative timeout,
GNUNET_CONNECTION_TransmitReadyNotify
callback, void *callback_cls)
{
- return client->notify_transmit_ready (client->client_closure,
- size,
- timeout, callback, callback_cls);
+ if (NULL != client->th.callback)
+ return NULL;
+ client->th.callback_cls = callback_cls;
+ client->th.callback = callback;
+ client->th.cth = GNUNET_CONNECTION_notify_transmit_ready (client->connection, size,
+ timeout,
+ &transmit_ready_callback_wrapper,
+ client);
+ return &client->th;
+}
+
+
+/**
+ * Abort transmission request.
+ *
+ * @param th request to abort
+ */
+void
+GNUNET_SERVER_notify_transmit_ready_cancel (struct GNUNET_SERVER_TransmitHandle *th)
+{
+ GNUNET_CONNECTION_notify_transmit_ready_cancel (th->cth);
+ th->cth = NULL;
+ th->callback = NULL;
+}
+
+
+/**
+ * Set the persistent flag on this client, used to setup client connection
+ * to only be killed when the service it's connected to is actually dead.
+ *
+ * @param client the client to set the persistent flag on
+ */
+void
+GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client)
+{
+ client->persist = GNUNET_YES;
}
* @param client client we were processing a message of
* @param success GNUNET_OK to keep the connection open and
* continue to receive
+ * GNUNET_NO to close the connection (normal behavior)
* GNUNET_SYSERR to close the connection (signal
* serious error)
*/
void
GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success)
{
- char *sb;
-
- if (client == NULL)
+ if (NULL == client)
return;
GNUNET_assert (client->suspended > 0);
client->suspended--;
- if (success != GNUNET_OK)
- client->shutdown_now = GNUNET_YES;
+ if (GNUNET_OK != success)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "GNUNET_SERVER_receive_done called with failure indication\n");
+ if ( (client->reference_count > 0) || (client->suspended > 0) )
+ client->shutdown_now = GNUNET_YES;
+ else
+ GNUNET_SERVER_client_disconnect (client);
+ return;
+ }
if (client->suspended > 0)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "GNUNET_SERVER_receive_done called, but more clients pending\n");
return;
- if (client->in_process_client_buffer == GNUNET_YES)
+ }
+ if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
+ {
+ GNUNET_SCHEDULER_cancel (client->warn_task);
+ client->warn_task = GNUNET_SCHEDULER_NO_TASK;
+ }
+ if (GNUNET_YES == client->in_process_client_buffer)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "GNUNET_SERVER_receive_done called while still in processing loop\n");
return;
- if (client->side_buf_size > 0)
- {
- /* resume processing from side-buf */
- sb = client->side_buf;
- client->side_buf = NULL;
- /* this will also resume the receive job */
- if (GNUNET_YES != client->shutdown_now)
- process_incoming (client, sb, client->side_buf_size, NULL, 0, 0);
- else
- shutdown_incoming_processing (client);
- /* finally, free the side-buf */
- GNUNET_free (sb);
- return;
- }
- /* resume receive job */
- if (GNUNET_YES != client->shutdown_now)
- {
- GNUNET_SCHEDULER_add_continuation (client->server->sched,
- &restart_processing,
- client,
- GNUNET_SCHEDULER_REASON_PREREQ_DONE);
- return;
- }
- shutdown_incoming_processing (client);
+ }
+ if ((NULL == client->server) || (GNUNET_YES == client->shutdown_now))
+ {
+ GNUNET_SERVER_client_disconnect (client);
+ return;
+ }
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "GNUNET_SERVER_receive_done causes restart in reading from the socket\n");
+ GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == client->restart_task);
+ client->restart_task = GNUNET_SCHEDULER_add_now (&restart_processing, client);
}