/*
This file is part of GNUnet.
- (C) 2009 Christian Grothoff (and other contributing authors)
+ (C) 2009, 2010 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 "arm.h"
-/**
- * How long are we willing to wait for a service operation during the multi-operation
- * request processing?
- */
-#define MULTI_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
-
-
/**
* Handle for interacting with ARM.
- */
+ */
struct GNUNET_ARM_Handle
{
};
+/**
+ * Context for handling the shutdown of a service.
+ */
+struct ShutdownContext
+{
+ /**
+ * Scheduler to be used to call continuation
+ */
+ struct GNUNET_SCHEDULER_Handle *sched;
+ /**
+ * Connection to the service that is being shutdown.
+ */
+ struct GNUNET_CLIENT_Connection *sock;
+
+ /**
+ * Time allowed for shutdown to happen.
+ */
+ struct GNUNET_TIME_Absolute timeout;
+
+ /**
+ * Task set up to cancel the shutdown request on timeout.
+ */
+ GNUNET_SCHEDULER_TaskIdentifier cancel_task;
+
+ /**
+ * Task to call once shutdown complete
+ */
+ GNUNET_CLIENT_ShutdownTask cont;
+
+ /**
+ * Closure for shutdown continuation
+ */
+ void *cont_cls;
+
+ /**
+ * We received a confirmation that the service will shut down.
+ */
+ int confirmed;
+
+};
+
+/**
+ * Handler receiving response to service shutdown requests.
+ * First call with NULL: service misbehaving, or something.
+ * First call with GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN_ACK:
+ * - service will shutdown
+ * Second call with NULL:
+ * - service has now really shut down.
+ *
+ * @param cls closure
+ * @param msg NULL, indicating socket closure.
+ */
+static void
+service_shutdown_handler (void *cls, const struct GNUNET_MessageHeader *msg)
+{
+ struct ShutdownContext *shutdown_ctx = cls;
+
+ if ((msg == NULL) && (shutdown_ctx->confirmed != GNUNET_YES))
+ {
+ /* Means the other side closed the connection and never confirmed a shutdown */
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+ "Service handle shutdown before ACK!\n");
+ if (shutdown_ctx->cont != NULL)
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
+ GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
+ }
+ else if ((msg == NULL) && (shutdown_ctx->confirmed == GNUNET_YES))
+ {
+#if DEBUG_ARM
+ GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
+ "Service shutdown complete.\n");
+#endif
+ if (shutdown_ctx->cont != NULL)
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_NO);
+
+ GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
+ }
+ else
+ {
+ GNUNET_assert(ntohs(msg->size) == sizeof(struct GNUNET_MessageHeader));
+ switch (ntohs(msg->type))
+ {
+ case GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN_ACK:
+#if DEBUG_ARM
+ GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
+ "Received confirmation for service shutdown.\n");
+#endif
+ shutdown_ctx->confirmed = GNUNET_YES;
+ GNUNET_CLIENT_receive (shutdown_ctx->sock,
+ &service_shutdown_handler,
+ shutdown_ctx,
+ GNUNET_TIME_UNIT_FOREVER_REL);
+ break;
+ default: /* Fall through */
+#if DEBUG_ARM
+ GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
+ "Service shutdown refused!\n");
+#endif
+ if (shutdown_ctx->cont != NULL)
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_YES);
+
+ GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
+ break;
+ }
+ }
+}
+
+/**
+ * Shutting down took too long, cancel receive and return error.
+ *
+ * @param cls closure
+ * @param tc context information (why was this task triggered now)
+ */
+void service_shutdown_cancel (void *cls,
+ const struct GNUNET_SCHEDULER_TaskContext * tc)
+{
+ struct ShutdownContext *shutdown_ctx = cls;
+ GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "service_shutdown_cancel called!\n");
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
+}
+
+
+/**
+ * If possible, write a shutdown message to the target
+ * buffer and destroy the client connection.
+ *
+ * @param cls the "struct GNUNET_CLIENT_Connection" to destroy
+ * @param size number of bytes available in buf
+ * @param buf NULL on error, otherwise target buffer
+ * @return number of bytes written to buf
+ */
+static size_t
+write_shutdown (void *cls, size_t size, void *buf)
+{
+ struct GNUNET_MessageHeader *msg;
+ struct ShutdownContext *shutdown_ctx = cls;
+
+ if (size < sizeof (struct GNUNET_MessageHeader))
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+ _("Failed to transmit shutdown request to client.\n"));
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
+ return 0; /* client disconnected */
+ }
+
+ GNUNET_CLIENT_receive (shutdown_ctx->sock,
+ &service_shutdown_handler, shutdown_ctx,
+ GNUNET_TIME_UNIT_FOREVER_REL);
+ shutdown_ctx->cancel_task = GNUNET_SCHEDULER_add_delayed (shutdown_ctx->sched,
+ GNUNET_TIME_absolute_get_remaining(shutdown_ctx->timeout),
+ &service_shutdown_cancel,
+ shutdown_ctx);
+ msg = (struct GNUNET_MessageHeader *) buf;
+ msg->type = htons (GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN);
+ msg->size = htons (sizeof (struct GNUNET_MessageHeader));
+ return sizeof (struct GNUNET_MessageHeader);
+}
+
+
+/**
+ * Request that the service should shutdown.
+ * Afterwards, the connection will automatically be
+ * disconnected. Hence the "sock" should not
+ * be used by the caller after this call
+ * (calling this function frees "sock" after a while).
+ *
+ * @param sched the scheduler to use for calling shutdown continuation
+ * @param sock the socket connected to the service
+ * @param timeout how long to wait before giving up on transmission
+ * @param cont continuation to call once the service is really down
+ * @param cont_cls closure for continuation
+ *
+ */
+static void
+arm_service_shutdown (struct GNUNET_SCHEDULER_Handle *sched,
+ struct GNUNET_CLIENT_Connection *sock,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_CLIENT_ShutdownTask cont,
+ void *cont_cls)
+{
+ struct ShutdownContext *shutdown_ctx;
+ shutdown_ctx = GNUNET_malloc(sizeof(struct ShutdownContext));
+ shutdown_ctx->sched = sched;
+ shutdown_ctx->cont = cont;
+ shutdown_ctx->cont_cls = cont_cls;
+ shutdown_ctx->sock = sock;
+ shutdown_ctx->timeout = GNUNET_TIME_relative_to_absolute(timeout);
+ GNUNET_CLIENT_notify_transmit_ready (sock,
+ sizeof (struct
+ GNUNET_MessageHeader),
+ timeout,
+ GNUNET_YES,
+ &write_shutdown, shutdown_ctx);
+}
+
+
/**
* Setup a context for communicating with ARM. Note that this
* can be done even if the ARM service is not yet running.
const char *service)
{
struct GNUNET_ARM_Handle *ret;
- struct GNUNET_CLIENT_Connection *client;
- client = GNUNET_CLIENT_connect (sched, "arm", cfg);
- if (client == NULL)
- return NULL;
- GNUNET_CLIENT_ignore_shutdown (client, GNUNET_YES);
ret = GNUNET_malloc (sizeof (struct GNUNET_ARM_Handle));
ret->cfg = GNUNET_CONFIGURATION_dup (cfg);
ret->sched = sched;
- ret->client = client;
return ret;
}
GNUNET_ARM_disconnect (struct GNUNET_ARM_Handle *h)
{
if (h->client != NULL)
- GNUNET_CLIENT_disconnect (h->client);
+ GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
GNUNET_CONFIGURATION_destroy (h->cfg);
GNUNET_free (h);
}
+struct ARM_ShutdownContext
+{
+ /**
+ * Callback to call once shutdown complete.
+ */
+ GNUNET_ARM_Callback cb;
+
+ /**
+ * Closure for callback.
+ */
+ void *cb_cls;
+};
+
+
/**
* Internal state for a request with ARM.
};
+#include "do_start_process.c"
+
/**
* A client specifically requested starting of ARM itself.
pid_t pid;
char *binary;
char *config;
+ char *loprefix;
+ char *lopostfix;
if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE))
{
"gnunet-service-arm");
#endif
/* FIXME: should we check that HOSTNAME for 'arm' is localhost? */
- /* start service */
+
+ if (GNUNET_OK !=
+ GNUNET_CONFIGURATION_get_value_string (pos->h->cfg,
+ "arm", "PREFIX", &loprefix))
+ loprefix = GNUNET_strdup ("");
+ if (GNUNET_OK !=
+ GNUNET_CONFIGURATION_get_value_string (pos->h->cfg,
+ "arm", "OPTIONS", &lopostfix))
+ lopostfix = GNUNET_strdup ("");
if (GNUNET_OK !=
GNUNET_CONFIGURATION_get_value_string (pos->h->cfg,
"arm",
if (pos->callback != NULL)
pos->callback (pos->cls, GNUNET_SYSERR);
GNUNET_free (pos);
+ GNUNET_free (loprefix);
+ GNUNET_free (lopostfix);
return;
}
if (GNUNET_OK !=
pos->callback (pos->cls, GNUNET_SYSERR);
GNUNET_free (binary);
GNUNET_free (pos);
+ GNUNET_free (loprefix);
+ GNUNET_free (lopostfix);
return;
}
- pid = GNUNET_OS_start_process (binary, binary, "-d", "-c", config,
+ if ((GNUNET_YES == GNUNET_CONFIGURATION_have_value (pos->h->cfg,
+ "TESTING",
+ "WEAKRANDOM")) &&
+ (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno (pos->h->cfg,
+ "TESTING",
+ "WEAKRANDOM")) &&
+ (GNUNET_NO == GNUNET_CONFIGURATION_have_value (pos->h->cfg,
+ "TESTING",
+ "HOSTFILE")) /* Means we are ONLY running locally */
+ )
+ {
+ /* we're clearly running a test, don't daemonize */
+ pid = do_start_process (NULL,
+ loprefix,
+ binary,
+ "-c", config,
#if DEBUG_ARM
- "-L", "DEBUG",
+ "-L", "DEBUG",
#endif
- NULL);
+ /* no daemonization! */
+ lopostfix,
+ NULL);
+ }
+ else
+ {
+ pid = do_start_process (NULL,
+ loprefix,
+ binary,
+ "-c", config,
+#if DEBUG_ARM
+ "-L", "DEBUG",
+#endif
+ "-d",
+ lopostfix,
+ NULL);
+ }
GNUNET_free (binary);
GNUNET_free (config);
+ GNUNET_free (loprefix);
+ GNUNET_free (lopostfix);
if (pid == -1)
{
if (pos->callback != NULL)
* Process a response from ARM to a request for a change in service
* status.
*
- * @param cls the request context
+ * @param cls the request context
* @param msg the response
*/
static void
{
GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
_("Error receiving response to `%s' request from ARM for service `%s'\n"),
- (sc->type == GNUNET_MESSAGE_TYPE_ARM_START)
+ (sc->type == GNUNET_MESSAGE_TYPE_ARM_START)
? "START"
: "STOP",
(const char*) &sc[1]);
- GNUNET_CLIENT_disconnect (sc->h->client);
- sc->h->client = GNUNET_CLIENT_connect (sc->h->sched,
- "arm",
+ GNUNET_CLIENT_disconnect (sc->h->client, GNUNET_NO);
+ sc->h->client = GNUNET_CLIENT_connect (sc->h->sched,
+ "arm",
sc->h->cfg);
GNUNET_assert (NULL != sc->h->client);
GNUNET_CLIENT_ignore_shutdown (sc->h->client, GNUNET_YES);
}
#if DEBUG_ARM
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Received response from ARM for service `%s': %u\n",
+ "Received response from ARM for service `%s': %u\n",
(const char*) &sc[1],
ntohs(msg->type));
#endif
* @param timeout how long to wait before failing for good
* @param cb callback to invoke when service is ready
* @param cb_cls closure for callback
- * @param type type of the request
+ * @param type type of the request
*/
static void
change_service (struct GNUNET_ARM_Handle *h,
struct GNUNET_MessageHeader *msg;
slen = strlen (service_name) + 1;
- if (slen + sizeof (struct GNUNET_MessageHeader) >
- GNUNET_SERVER_MAX_MESSAGE_SIZE)
+ if (slen + sizeof (struct GNUNET_MessageHeader) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
{
GNUNET_break (0);
if (cb != NULL)
}
#if DEBUG_ARM
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- (type == GNUNET_MESSAGE_TYPE_ARM_START)
- ? _("Requesting start of service `%s'.\n")
+ (type == GNUNET_MESSAGE_TYPE_ARM_START)
+ ? _("Requesting start of service `%s'.\n")
: _("Requesting termination of service `%s'.\n"),
service_name);
#endif
GNUNET_YES,
&handle_response,
sctx))
- {
+ {
GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
(type == GNUNET_MESSAGE_TYPE_ARM_START)
? _("Error while trying to transmit request to start `%s' to ARM\n")
GNUNET_ARM_Callback cb, void *cb_cls)
{
struct RequestContext *sctx;
+ struct GNUNET_CLIENT_Connection *client;
size_t slen;
-
- GNUNET_log (GNUNET_ERROR_TYPE_INFO,
- _("Asked to starting service `%s' within %llu ms\n"), service_name,
+#if DEBUG_ARM
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ _("Asked to start service `%s' within %llu ms\n"), service_name,
(unsigned long long) timeout.value);
+#endif
if (0 == strcasecmp ("arm", service_name))
{
slen = strlen ("arm") + 1;
h->cfg, timeout, &arm_service_report, sctx);
return;
}
+ if (h->client == NULL)
+ {
+ client = GNUNET_CLIENT_connect (h->sched, "arm", h->cfg);
+ if (client == NULL)
+ {
+ cb (cb_cls, GNUNET_SYSERR);
+ return;
+ }
+ GNUNET_CLIENT_ignore_shutdown (client, GNUNET_YES);
+ h->client = client;
+ }
change_service (h, service_name, timeout, cb, cb_cls, GNUNET_MESSAGE_TYPE_ARM_START);
}
+/**
+ * Callback from the arm stop service call, indicates that the arm service
+ * is well and truly dead, won't die, or an error occurred.
+ *
+ * @param cls closure for the callback
+ * @param reason reason for callback, GNUNET_NO if arm is shutdown
+ * GNUNET_YES if arm remains running, and GNUNET_SYSERR on error
+ */
+void arm_shutdown_callback (void *cls,
+ int reason)
+{
+ struct ARM_ShutdownContext *arm_shutdown_ctx = cls;
+
+ if (arm_shutdown_ctx->cb != NULL)
+ arm_shutdown_ctx->cb (arm_shutdown_ctx->cb_cls, reason);
+
+ GNUNET_free(arm_shutdown_ctx);
+}
+
/**
* Stop a service.
*/
void
GNUNET_ARM_stop_service (struct GNUNET_ARM_Handle *h,
- const char *service_name,
+ const char *service_name,
struct GNUNET_TIME_Relative timeout,
GNUNET_ARM_Callback cb, void *cb_cls)
{
+ struct ARM_ShutdownContext *arm_shutdown_ctx;
+ struct GNUNET_CLIENT_Connection *client;
+
GNUNET_log (GNUNET_ERROR_TYPE_INFO,
_("Stopping service `%s' within %llu ms\n"), service_name,
(unsigned long long) timeout.value);
+ if (h->client == NULL)
+ {
+ client = GNUNET_CLIENT_connect (h->sched, "arm", h->cfg);
+ if (client == NULL)
+ {
+ cb (cb_cls, GNUNET_SYSERR);
+ return;
+ }
+ GNUNET_CLIENT_ignore_shutdown (client, GNUNET_YES);
+ h->client = client;
+ }
if (0 == strcasecmp ("arm", service_name))
{
- GNUNET_CLIENT_service_shutdown (h->client);
+ arm_shutdown_ctx = GNUNET_malloc(sizeof(struct ARM_ShutdownContext));
+ arm_shutdown_ctx->cb = cb;
+ arm_shutdown_ctx->cb_cls = cb_cls;
+ arm_service_shutdown (h->sched, h->client, timeout, &arm_shutdown_callback, arm_shutdown_ctx);
h->client = NULL;
- if (cb != NULL)
- cb (cb_cls, GNUNET_NO);
return;
}
change_service (h, service_name, timeout, cb, cb_cls, GNUNET_MESSAGE_TYPE_ARM_STOP);
}
-/**
- * Function to call for each service.
- *
- * @param h handle to ARM
- * @param service_name name of the service
- * @param timeout how long to wait before failing for good
- * @param cb callback to invoke when service is ready
- * @param cb_cls closure for callback
- */
-typedef void (*ServiceOperation) (struct GNUNET_ARM_Handle *h,
- const char *service_name,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_ARM_Callback cb, void *cb_cls);
-
-
-/**
- * Context for starting or stopping multiple services.
- */
-struct MultiContext
-{
- /**
- * NULL-terminated array of services to start or stop.
- */
- char **services;
-
- /**
- * Our handle to ARM.
- */
- struct GNUNET_ARM_Handle *h;
-
- /**
- * Identifies the operation (start or stop).
- */
- ServiceOperation op;
-
- /**
- * Current position in "services".
- */
- unsigned int pos;
-};
-
-
-/**
- * Run the operation for the next service in the multi-service
- * request.
- *
- * @param cls the "struct MultiContext" that is being processed
- * @param success status of the previous operation (ignored)
- */
-static void
-next_operation (void *cls,
- int success)
-{
- struct MultiContext *mc = cls;
- char *pos;
-
- if (NULL == (pos = mc->services[mc->pos]))
- {
- GNUNET_free (mc->services);
- GNUNET_ARM_disconnect (mc->h);
- GNUNET_free (mc);
- return;
- }
- mc->pos++;
- mc->op (mc->h, pos, MULTI_TIMEOUT, &next_operation, mc);
- GNUNET_free (pos);
-}
-
-
-/**
- * Run a multi-service request.
- *
- * @param cfg configuration to use (needed to contact ARM;
- * the ARM service may internally use a different
- * configuration to determine how to start the service).
- * @param sched scheduler to use
- * @param op the operation to perform for each service
- * @param va NULL-terminated list of services
- */
-static void
-run_multi_request (const struct GNUNET_CONFIGURATION_Handle *cfg,
- struct GNUNET_SCHEDULER_Handle *sched,
- ServiceOperation op,
- va_list va)
-{
- va_list cp;
- unsigned int total;
- struct MultiContext *mc;
- struct GNUNET_ARM_Handle *h;
- const char *c;
-
- h = GNUNET_ARM_connect (cfg, sched, NULL);
- if (NULL == h)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
- _("Error while trying to transmit to ARM service\n"));
- return;
- }
- total = 1;
- va_copy (cp, va);
- while (NULL != (va_arg (cp, const char*))) total++;
- va_end (cp);
- mc = GNUNET_malloc (sizeof(struct MultiContext));
- mc->services = GNUNET_malloc (total * sizeof (char*));
- mc->h = h;
- mc->op = op;
- total = 0;
- va_copy (cp, va);
- while (NULL != (c = va_arg (cp, const char*)))
- mc->services[total++] = GNUNET_strdup (c);
- va_end (cp);
- next_operation (mc, GNUNET_YES);
-}
-
-
-/**
- * Start multiple services in the specified order. Convenience
- * function. Works asynchronously, failures are not reported.
- *
- * @param cfg configuration to use (needed to contact ARM;
- * the ARM service may internally use a different
- * configuration to determine how to start the service).
- * @param sched scheduler to use
- * @param ... NULL-terminated list of service names (const char*)
- */
-void
-GNUNET_ARM_start_services (const struct GNUNET_CONFIGURATION_Handle *cfg,
- struct GNUNET_SCHEDULER_Handle *sched,
- ...)
-{
- va_list ap;
-
- va_start (ap, sched);
- run_multi_request (cfg, sched, &GNUNET_ARM_start_service, ap);
- va_end (ap);
-}
-
-
-/**
- * Stop multiple services in the specified order. Convenience
- * function. Works asynchronously, failures are not reported.
- *
- * @param cfg configuration to use (needed to contact ARM;
- * the ARM service may internally use a different
- * configuration to determine how to start the service).
- * @param sched scheduler to use
- * @param ... NULL-terminated list of service names (const char*)
- */
-void
-GNUNET_ARM_stop_services (const struct GNUNET_CONFIGURATION_Handle *cfg,
- struct GNUNET_SCHEDULER_Handle *sched,
- ...)
-{
- va_list ap;
-
- va_start (ap, sched);
- run_multi_request (cfg, sched, &GNUNET_ARM_stop_service, ap);
- va_end (ap);
-}
-
-
/* end of arm_api.c */
projects / oweals / gnunet.git / blobdiff