/*
This file is part of GNUnet.
- (C) 2009, 2012 Christian Grothoff (and other contributing authors)
+ (C) 2009-2013 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
- by the Free Software Foundation; either version 2, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
*/
#include "platform.h"
-#include "gnunet_common.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
int require_found;
/**
- * Set to GNUNET_YES once we are in 'soft' shutdown where we wait for
+ * 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
+ * #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;
GNUNET_CONNECTION_TransmitReadyNotify callback;
/**
- * Closure for 'callback'
+ * Closure for @e callback
*/
void *callback_cls;
GNUNET_SCHEDULER_TaskIdentifier restart_task;
/**
- * Task that warns about missing calls to 'GNUNET_SERVER_receive_done'.
+ * Task that warns about missing calls to #GNUNET_SERVER_receive_done.
*/
GNUNET_SCHEDULER_TaskIdentifier warn_task;
/**
* Transmission handle we return for this client from
- * GNUNET_SERVER_notify_transmit_ready.
+ * #GNUNET_SERVER_notify_transmit_ready.
*/
struct GNUNET_SERVER_TransmitHandle th;
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).
+ * Are we currently trying to receive? (#GNUNET_YES if we are,
+ * #GNUNET_NO if we are not, #GNUNET_SYSERR if data is already
+ * available in MST).
*/
int receive_pending;
/**
* 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)
+ * (see also #GNUNET_SERVICE_start)
*/
int is_monitor;
GNUNET_SERVER_client_get_user_context_ (struct GNUNET_SERVER_Client *client,
size_t size)
{
+ if ((0 == client->user_context_size) &&
+ (NULL == client->user_context))
+ return NULL; /* never set */
GNUNET_assert (size == client->user_context_size);
return client->user_context;
}
* @param ptr pointer to user context
* @param size number of bytes in user context struct (for verification only)
*/
-void
+void
GNUNET_SERVER_client_set_user_context_ (struct GNUNET_SERVER_Client *client,
void *ptr,
size_t size)
{
+ if (NULL == ptr)
+ {
+ client->user_context_size = 0;
+ client->user_context = ptr;
+ return;
+ }
client->user_context_size = size;
client->user_context = ptr;
}
* @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;
server->listen_sockets[i]);
if (NULL != sock)
{
- LOG (GNUNET_ERROR_TYPE_DEBUG, "Server accepted incoming connection.\n");
+ 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);
/**
* Create and initialize a listen socket for the server.
*
- * @param serverAddr address to listen on
- * @param socklen length of address
+ * @param server_addr address to listen on
+ * @param socklen length of @a server_addr
* @return NULL on error, otherwise the listen socket
*/
static struct GNUNET_NETWORK_Handle *
-open_listen_socket (const struct sockaddr *serverAddr, socklen_t socklen)
+open_listen_socket (const struct sockaddr *server_addr, socklen_t socklen)
{
struct GNUNET_NETWORK_Handle *sock;
uint16_t port;
int eno;
- switch (serverAddr->sa_family)
+ switch (server_addr->sa_family)
{
case AF_INET:
- port = ntohs (((const struct sockaddr_in *) serverAddr)->sin_port);
+ port = ntohs (((const struct sockaddr_in *) server_addr)->sin_port);
break;
case AF_INET6:
- port = ntohs (((const struct sockaddr_in6 *) serverAddr)->sin6_port);
+ port = ntohs (((const struct sockaddr_in6 *) server_addr)->sin6_port);
break;
case AF_UNIX:
port = 0;
port = 0;
break;
}
- sock = GNUNET_NETWORK_socket_create (serverAddr->sa_family, SOCK_STREAM, 0);
+ sock = GNUNET_NETWORK_socket_create (server_addr->sa_family, SOCK_STREAM, 0);
if (NULL == sock)
{
LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "socket");
return NULL;
}
/* bind the socket */
- if (GNUNET_OK != GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen, 0))
+ if (GNUNET_OK != GNUNET_NETWORK_socket_bind (sock, server_addr, socklen))
{
eno = errno;
if (EADDRINUSE != errno)
if (0 != port)
LOG (GNUNET_ERROR_TYPE_ERROR, _("`%s' failed for port %d (%s).\n"),
"bind", port,
- (AF_INET == serverAddr->sa_family) ? "IPv4" : "IPv6");
+ (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
eno = 0;
}
else
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)
+ (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
+ else if (AF_UNIX == server_addr->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]));
+ _("`%s' failed for `%s': address already in use\n"),
+ "bind",
+ GNUNET_a2s (server_addr, socklen));
}
}
GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
* @param access_cls closure for access
* @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
+ * @param require_found if #GNUNET_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 *server;
- server = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
+ server = GNUNET_new (struct GNUNET_SERVER_Handle);
server->idle_timeout = idle_timeout;
server->listen_sockets = lsocks;
server->access = access;
*
* @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 server_addr address to listen on (including port), NULL terminated array
+ * @param socklen length of server_addr
* @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
*/
struct GNUNET_SERVER_Handle *
GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access, void *access_cls,
- struct sockaddr *const *serverAddr,
+ struct sockaddr *const *server_addr,
const socklen_t * socklen,
struct GNUNET_TIME_Relative idle_timeout,
int require_found)
int seen;
i = 0;
- while (NULL != serverAddr[i])
+ while (NULL != server_addr[i])
i++;
if (i > 0)
{
lsocks = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (i + 1));
i = 0;
j = 0;
- while (NULL != serverAddr[i])
+ while (NULL != server_addr[i])
{
seen = 0;
for (k=0;k<i;k++)
if ( (socklen[k] == socklen[i]) &&
- (0 == memcmp (serverAddr[k], serverAddr[i], socklen[i])) )
+ (0 == memcmp (server_addr[k], server_addr[i], socklen[i])) )
{
seen = 1;
break;
i++;
continue;
}
- lsocks[j] = open_listen_socket (serverAddr[i], socklen[i]);
+ lsocks[j] = open_listen_socket (server_addr[i], socklen[i]);
if (NULL != lsocks[j])
j++;
i++;
{
struct HandlerList *p;
- p = GNUNET_malloc (sizeof (struct HandlerList));
+ p = GNUNET_new (struct HandlerList);
p->handlers = handlers;
p->next = server->handlers;
server->handlers = p;
* @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'
+ * @param cls closure for @a create, @a receive, @a destroy
*/
void
GNUNET_SERVER_set_callbacks (struct GNUNET_SERVER_Handle *server,
/**
- * Task run to warn about missing calls to 'GNUNET_SERVER_receive_done'.
+ * 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 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)
+warn_no_receive_done (void *cls,
+ const struct GNUNET_SCHEDULER_TaskContext *tc)
{
struct GNUNET_SERVER_Client *client = cls;
(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_start = GNUNET_TIME_absolute_get ();
sender->warn_task =
GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
&warn_no_receive_done, sender);
* or shutdown.
*
* @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
+ * 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
+ * @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_mst (struct GNUNET_SERVER_Client *client, int ret)
if (GNUNET_OK == ret)
{
LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Server re-enters receive loop, timeout: %llu.\n",
- client->idle_timeout.rel_value);
+ "Server re-enters receive loop, timeout: %s.\n",
+ GNUNET_STRINGS_relative_time_to_string (client->idle_timeout, GNUNET_YES));
client->receive_pending = GNUNET_YES;
GNUNET_CONNECTION_receive (client->connection,
GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
}
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);
+ 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))
+ if ( (GNUNET_SYSERR == ret) ||
+ (GNUNET_YES == client->shutdown_now) )
GNUNET_SERVER_client_disconnect (client);
}
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))
+ (end.abs_value_us > now.abs_value_us))
{
/* wait longer, timeout changed (i.e. due to us sending) */
LOG (GNUNET_ERROR_TYPE_DEBUG,
* @param client identification of the client (struct GNUNET_SERVER_Client*)
* @param message the actual message
*
- * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
*/
static int
client_message_tokenizer_callback (void *cls, void *client,
struct GNUNET_SERVER_Client *client;
struct NotifyList *n;
- client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
+ client = GNUNET_new (struct GNUNET_SERVER_Client);
client->connection = connection;
client->reference_count = 1;
client->server = server;
*
* @param server the server manageing the clients
* @param callback function to call on disconnect
- * @param callback_cls closure for callback
+ * @param callback_cls closure for @a callback
*/
void
GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
{
struct NotifyList *n;
- n = GNUNET_malloc (sizeof (struct NotifyList));
+ n = GNUNET_new (struct NotifyList);
n->callback = callback;
n->callback_cls = callback_cls;
GNUNET_CONTAINER_DLL_insert (server->disconnect_notify_list_head,
/**
* Ask the server to notify us whenever a client connects.
* This function is called whenever the actual network connection
- * is opened.
+ * is opened. If the server is destroyed before this
+ * notification is explicitly cancelled, the 'callback' will
+ * once be called with a 'client' argument of NULL to indicate
+ * that the server itself is now gone (and that the callback
+ * won't be called anymore and also can no longer be cancelled).
*
* @param server the server manageing the clients
* @param callback function to call on sconnect
- * @param callback_cls closure for callback
+ * @param callback_cls closure for @a callback
*/
void
GNUNET_SERVER_connect_notify (struct GNUNET_SERVER_Handle *server,
- GNUNET_SERVER_ConnectCallback callback, void *callback_cls)
+ GNUNET_SERVER_ConnectCallback callback,
+ void *callback_cls)
{
struct NotifyList *n;
- n = GNUNET_malloc (sizeof (struct NotifyList));
+ n = GNUNET_new (struct NotifyList);
n->callback = callback;
n->callback_cls = callback_cls;
GNUNET_CONTAINER_DLL_insert (server->connect_notify_list_head,
*
* @param server the server manageing the clients
* @param callback function to call on connect
- * @param callback_cls closure for callback
+ * @param callback_cls closure for @a callback
*/
void
GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
*
* @param server the server manageing the clients
* @param callback function to call on disconnect
- * @param callback_cls closure for callback
+ * @param callback_cls closure for @a callback
*/
void
GNUNET_SERVER_connect_notify_cancel (struct GNUNET_SERVER_Handle *server,
- GNUNET_SERVER_ConnectCallback callback, void *callback_cls)
+ GNUNET_SERVER_ConnectCallback callback,
+ void *callback_cls)
{
struct NotifyList *pos;
/**
- * Destroy the connection that is passed in via 'cls'. Used
- * as calling 'GNUNET_CONNECTION_destroy' from within a function
+ * Destroy the connection that is passed in via @a 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).
*
const struct GNUNET_SCHEDULER_TaskContext *tc)
{
struct GNUNET_CONNECTION_Handle *connection = cls;
-
+
GNUNET_CONNECTION_destroy (connection);
}
/**
* Ask the server to disconnect from the given client.
- * This is the same as returning GNUNET_SYSERR from a message
+ * This is the same as returning #GNUNET_SYSERR from a message
* handler, except that it allows dropping of a client even
* when not handling a message from that client.
*
GNUNET_CONNECTION_receive_cancel (client->connection);
client->receive_pending = GNUNET_NO;
}
- client->shutdown_now = GNUNET_YES;
+ client->shutdown_now = GNUNET_YES;
client->reference_count++; /* make sure nobody else clean up client... */
if ( (NULL != client->mst) &&
(NULL != server) )
* @param timeout after how long should we give up (and call
* notify with buf NULL and size 0)?
* @param callback function to call when space is available
- * @param callback_cls closure for callback
+ * @param callback_cls closure for @a callback
* @return non-NULL if the notify callback was queued; can be used
- * to cancel the request using
- * GNUNET_SERVER_notify_transmit_ready_cancel.
+ * to cancel the request using
+ * #GNUNET_SERVER_notify_transmit_ready_cancel.
* NULL if we are already going to notify someone else (busy)
*/
struct GNUNET_SERVER_TransmitHandle *
* GNUNET_SERVER_MessageCallback (or its respective continuations).
*
* @param client client we were processing a message of
- * @param success GNUNET_OK to keep the connection open and
+ * @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
+ * #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)
+GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client,
+ int success)
{
if (NULL == client)
return;
projects / oweals / gnunet.git / blobdiff