/*
This file is part of GNUnet.
- (C) 2009 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2016 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
* @file arm/test_exponential_backoff.c
* @brief testcase for gnunet-service-arm.c
+ * @author Christian Grothoff
*/
#include "platform.h"
#include "gnunet_arm_service.h"
-#include "gnunet_client_lib.h"
-#include "gnunet_configuration_lib.h"
-#include "gnunet_program_lib.h"
+#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
-#define VERBOSE GNUNET_NO
-#define START_ARM GNUNET_YES
+#define LOG(...) GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
+
#define LOG_BACKOFF GNUNET_NO
+
#define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
+
#define SERVICE_TEST_TIMEOUT GNUNET_TIME_UNIT_FOREVER_REL
+
#define FIVE_MILLISECONDS GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 5)
+#define SERVICE "do-nothing"
+
+#define BINARY "mockup-service"
+
+#define CFGFILENAME "test_arm_api_data2.conf"
+
+
static const struct GNUNET_CONFIGURATION_Handle *cfg;
+
static struct GNUNET_ARM_Handle *arm;
+
+static struct GNUNET_ARM_MonitorHandle *mon;
+
+static struct GNUNET_SCHEDULER_Task *kt;
+
static int ok = 1;
+static int phase = 0;
+
static int trialCount;
+
static struct GNUNET_TIME_Absolute startedWaitingAt;
+
struct GNUNET_TIME_Relative waitedFor;
+struct GNUNET_TIME_Relative waitedFor_prev;
+
#if LOG_BACKOFF
static FILE *killLogFilePtr;
+
static char *killLogFileName;
#endif
/**
* Connection to the service that is being shutdown.
*/
- struct GNUNET_CLIENT_Connection *sock;
-
- /**
- * Time allowed for shutdown to happen.
- */
- struct GNUNET_TIME_Absolute timeout;
+ struct GNUNET_MQ_Handle *mq;
/**
* Task set up to cancel the shutdown request on timeout.
*/
- GNUNET_SCHEDULER_TaskIdentifier cancel_task;
+ struct GNUNET_SCHEDULER_Task *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;
+static void
+kill_task (void *cbData);
-};
/**
- * 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.
+ * Shutting down took too long, cancel receive and return error.
*
* @param cls closure
- * @param msg NULL, indicating socket closure.
*/
static void
-service_shutdown_handler (void *cls, const struct GNUNET_MessageHeader *msg)
+service_shutdown_timeout (void *cls)
{
- 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->cancel_task);
- GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
- GNUNET_free (shutdown_ctx);
- }
- else if ((msg == NULL) && (shutdown_ctx->confirmed == GNUNET_YES))
- {
-#if VERBOSE
- 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->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 VERBOSE
- 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 */
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Service shutdown refused!\n");
- if (shutdown_ctx->cont != NULL)
- shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_YES);
-
- GNUNET_SCHEDULER_cancel (shutdown_ctx->cancel_task);
- GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
- GNUNET_free (shutdown_ctx);
- break;
- }
- }
+ GNUNET_assert (0);
}
+
/**
- * Shutting down took too long, cancel receive and return error.
+ * Generic error handler, called with the appropriate error code and
+ * the same closure specified at the creation of the message queue.
+ * Not every message queue implementation supports an error handler.
*
- * @param cls closure
- * @param tc context information (why was this task triggered now)
+ * @param cls closure with the `struct ShutdownContext *`
+ * @param error error code
*/
-void
-service_shutdown_cancel (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc)
+static void
+mq_error_handler (void *cls,
+ enum GNUNET_MQ_Error error)
{
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_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Service shutdown complete (MQ error).\n");
+ GNUNET_SCHEDULER_cancel (shutdown_ctx->cancel_task);
+ GNUNET_MQ_destroy (shutdown_ctx->mq);
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)
+static void
+kill_task (void *cbData)
{
+ struct ShutdownContext *shutdown_ctx
+ = GNUNET_new (struct ShutdownContext);
+ struct GNUNET_MQ_Envelope *env;
struct GNUNET_MessageHeader *msg;
- struct ShutdownContext *shutdown_ctx = cls;
+ struct GNUNET_MQ_MessageHandler handlers[] = {
+ GNUNET_MQ_handler_end ()
+ };
- if (size < sizeof (struct GNUNET_MessageHeader))
+ kt = NULL;
+ if (trialCount == 13)
{
- 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);
+ LOG ("Saw enough kills, asking ARM to stop mock service for good\n");
+ GNUNET_ARM_request_service_stop (arm,
+ SERVICE,
+ NULL,
+ NULL);
+ ok = 0;
+ trialCount++;
GNUNET_free (shutdown_ctx);
- return 0; /* client disconnected */
+ return;
}
-
- GNUNET_CLIENT_receive (shutdown_ctx->sock, &service_shutdown_handler,
- shutdown_ctx, GNUNET_TIME_UNIT_FOREVER_REL);
- shutdown_ctx->cancel_task =
- GNUNET_SCHEDULER_add_delayed (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 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_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->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_NO, &write_shutdown,
- shutdown_ctx);
-}
-
-
-static void
-arm_notify_stop (void *cls, int success)
-{
- GNUNET_assert (success == GNUNET_NO);
-#if START_ARM
- GNUNET_ARM_stop_service (arm, "arm", TIMEOUT, NULL, NULL);
-#endif
+ shutdown_ctx->mq = GNUNET_CLIENT_connect (cfg,
+ SERVICE,
+ handlers,
+ &mq_error_handler,
+ shutdown_ctx);
+ GNUNET_assert (NULL != shutdown_ctx->mq);
+ trialCount++;
+ LOG ("Sending a shutdown request to the mock service\n");
+ env = GNUNET_MQ_msg (msg,
+ GNUNET_MESSAGE_TYPE_ARM_STOP); /* FIXME: abuse of message type */
+ GNUNET_MQ_send (shutdown_ctx->mq,
+ env);
+ shutdown_ctx->cancel_task
+ = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
+ &service_shutdown_timeout,
+ shutdown_ctx);
}
-static void kill_task (void *cbData,
- const struct GNUNET_SCHEDULER_TaskContext *tc);
-
-
static void
-do_nothing_notify (void *cls, int success)
+trigger_disconnect (void *cls)
{
- GNUNET_assert (success == GNUNET_YES);
- ok = 1;
- GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &kill_task, NULL);
+ GNUNET_ARM_disconnect (arm);
+ GNUNET_ARM_monitor_stop (mon);
+ if (NULL != kt)
+ {
+ GNUNET_SCHEDULER_cancel (kt);
+ kt = NULL;
+ }
}
static void
-arm_notify (void *cls, int success)
+arm_stop_cb (void *cls,
+ enum GNUNET_ARM_RequestStatus status,
+ enum GNUNET_ARM_Result result)
{
- GNUNET_assert (success == GNUNET_YES);
- GNUNET_ARM_start_service (arm, "do-nothing", TIMEOUT, &do_nothing_notify,
- NULL);
+ GNUNET_break (status == GNUNET_ARM_REQUEST_SENT_OK);
+ GNUNET_break (result == GNUNET_ARM_RESULT_STOPPED);
+ LOG ("ARM service stopped\n");
+ GNUNET_SCHEDULER_shutdown ();
}
-static void kill_task (void *cbData,
- const struct GNUNET_SCHEDULER_TaskContext *tc);
-
-
static void
-do_nothing_restarted_notify_task (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc)
+srv_status (void *cls,
+ const char *service,
+ enum GNUNET_ARM_ServiceStatus status)
{
- static char a;
-
- trialCount++;
-
-#if LOG_BACKOFF
- if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
+ if (status == GNUNET_ARM_SERVICE_MONITORING_STARTED)
{
- fprintf (killLogFilePtr, "%d.Reason is shutdown!\n", trialCount);
+ LOG ("ARM monitor started, starting mock service\n");
+ phase++;
+ GNUNET_ARM_request_service_start (arm,
+ SERVICE,
+ GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
+ NULL,
+ NULL);
+ return;
}
- else if ((tc->reason & GNUNET_SCHEDULER_REASON_TIMEOUT) != 0)
+ if (0 != strcasecmp (service, SERVICE))
+ return; /* not what we care about */
+ if (phase == 1)
{
- fprintf (killLogFilePtr, "%d.Reason is timeout!\n", trialCount);
+ GNUNET_break (status == GNUNET_ARM_SERVICE_STARTING);
+ GNUNET_break (phase == 1);
+ LOG ("do-nothing is starting\n");
+ phase++;
+ ok = 1;
+ GNUNET_assert (NULL == kt);
+ startedWaitingAt = GNUNET_TIME_absolute_get ();
+ kt = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
+ &kill_task,
+ NULL);
}
- else if ((tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE) != 0)
+ else if (phase == 2)
{
- fprintf (killLogFilePtr, "%d.Service is running!\n", trialCount);
+ /* We passively monitor ARM for status updates. ARM should tell us
+ * when do-nothing dies (no need to run a service upness test ourselves).
+ */
+ if (status == GNUNET_ARM_SERVICE_STARTING)
+ {
+ waitedFor = GNUNET_TIME_absolute_get_duration (startedWaitingAt);
+ LOG ("Waited for: %s\n",
+ GNUNET_STRINGS_relative_time_to_string (waitedFor,
+ GNUNET_YES));
+
+ LOG ("do-nothing is starting, killing it...\n");
+ GNUNET_assert (NULL == kt);
+ kt = GNUNET_SCHEDULER_add_now (&kill_task, &ok);
+ }
+ else if ((status == GNUNET_ARM_SERVICE_STOPPED) && (trialCount == 14))
+ {
+ phase++;
+ LOG ("do-nothing stopped working %u times, we are done here\n",
+ (unsigned int) trialCount);
+ GNUNET_ARM_request_service_stop (arm,
+ "arm",
+ &arm_stop_cb,
+ NULL);
+ }
}
-#endif
- GNUNET_SCHEDULER_add_now (&kill_task, &a);
}
static void
-do_test (void *cbData, const struct GNUNET_SCHEDULER_TaskContext *tc)
+arm_start_cb (void *cls,
+ enum GNUNET_ARM_RequestStatus status,
+ enum GNUNET_ARM_Result result)
{
- GNUNET_CLIENT_service_test ("do-nothing", cfg, TIMEOUT,
- &do_nothing_restarted_notify_task, NULL);
+ GNUNET_break (status == GNUNET_ARM_REQUEST_SENT_OK);
+ GNUNET_break (result == GNUNET_ARM_RESULT_STARTING);
+ GNUNET_break (phase == 0);
+ LOG ("Sent 'START' request for arm to ARM %s\n",
+ (status == GNUNET_ARM_REQUEST_SENT_OK) ? "successfully" : "unsuccessfully");
}
static void
-shutdown_cont (void *cls, int reason)
-{
- trialCount++;
- startedWaitingAt = GNUNET_TIME_absolute_get ();
- GNUNET_SCHEDULER_add_delayed (waitedFor, &do_test, NULL);
-}
-
-
-static void
-kill_task (void *cbData, const struct GNUNET_SCHEDULER_TaskContext *tc)
+task (void *cls,
+ char *const *args,
+ const char *cfgfile,
+ const struct GNUNET_CONFIGURATION_Handle *c)
{
- static struct GNUNET_CLIENT_Connection *doNothingConnection = NULL;
-
- if (NULL != cbData)
- {
- waitedFor = GNUNET_TIME_absolute_get_duration (startedWaitingAt);
-
-#if LOG_BACKOFF
- fprintf (killLogFilePtr, "Waited for: %llu ms\n",
- (unsigned long long) waitedFor.rel_value);
-#endif
- }
- else
+ cfg = c;
+ arm = GNUNET_ARM_connect (cfg, NULL, NULL);
+ if (NULL == arm)
{
- waitedFor.rel_value = 0;
+ GNUNET_break (0);
+ return;
}
- /* Connect to the doNothing task */
- doNothingConnection = GNUNET_CLIENT_connect ("do-nothing", cfg);
- GNUNET_assert (doNothingConnection != NULL);
- if (trialCount == 12)
+ mon = GNUNET_ARM_monitor_start (cfg,
+ &srv_status,
+ NULL);
+ if (NULL == mon)
{
- GNUNET_CLIENT_disconnect (doNothingConnection, GNUNET_NO);
- GNUNET_ARM_stop_service (arm, "do-nothing", TIMEOUT, &arm_notify_stop,
- NULL);
- ok = 0;
+ GNUNET_break (0);
+ GNUNET_ARM_disconnect (arm);
+ arm = NULL;
return;
}
- /* Use the created connection to kill the doNothingTask */
- arm_service_shutdown (doNothingConnection, TIMEOUT, &shutdown_cont, NULL);
+ GNUNET_ARM_request_service_start (arm,
+ "arm",
+ GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
+ &arm_start_cb,
+ NULL);
+ GNUNET_SCHEDULER_add_shutdown (&trigger_disconnect,
+ NULL);
}
-static void
-task (void *cls, char *const *args, const char *cfgfile,
- const struct GNUNET_CONFIGURATION_Handle *c)
-{
- cfg = c;
-
- arm = GNUNET_ARM_connect (cfg, NULL);
-#if START_ARM
- GNUNET_ARM_start_service (arm, "arm", GNUNET_TIME_UNIT_ZERO, &arm_notify,
- NULL);
-#else
- arm_do_nothing (NULL, GNUNET_YES);
-#endif
-}
-
static int
check ()
{
char *const argv[] = {
- "test-arm-api",
- "-c", "test_arm_api_data.conf",
-#if VERBOSE
- "-L", "DEBUG",
-#endif
+ "test-exponential-backoff",
+ "-c", CFGFILENAME,
NULL
};
struct GNUNET_GETOPT_CommandLineOption options[] = {
/* Running ARM and running the do_nothing task */
GNUNET_assert (GNUNET_OK ==
- GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
- argv, "test-exponential-backoff", "nohelp",
- options, &task, NULL));
-
-
+ GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
+ argv,
+ "test-exponential-backoff",
+ "nohelp",
+ options,
+ &task,
+ NULL));
return ok;
}
+
+#ifndef PATH_MAX
+/**
+ * Assumed maximum path length (for the log file name).
+ */
+#define PATH_MAX 4096
+#endif
+
+
static int
init ()
{
-#if LOG_BACKOFF
- killLogFileName = GNUNET_DISK_mktemp ("exponential-backoff-waiting.log");
- if (NULL == (killLogFilePtr = FOPEN (killLogFileName, "w")))
+ struct GNUNET_CONFIGURATION_Handle *cfg;
+ char pwd[PATH_MAX];
+ char *binary;
+
+ cfg = GNUNET_CONFIGURATION_create ();
+ if (GNUNET_OK != GNUNET_CONFIGURATION_parse (cfg,
+ "test_arm_api_data.conf"))
+ return GNUNET_SYSERR;
+ if (NULL == getcwd (pwd, PATH_MAX))
+ return GNUNET_SYSERR;
+ GNUNET_assert (0 < GNUNET_asprintf (&binary,
+ "%s/%s",
+ pwd,
+ BINARY));
+ GNUNET_CONFIGURATION_set_value_string (cfg,
+ SERVICE,
+ "BINARY",
+ binary);
+ GNUNET_free (binary);
+ if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg,
+ CFGFILENAME))
{
- GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fopen",
- killLogFileName);
- GNUNET_free (killLogFileName);
+ GNUNET_CONFIGURATION_destroy (cfg);
return GNUNET_SYSERR;
}
+ GNUNET_CONFIGURATION_destroy (cfg);
+
+#if LOG_BACKOFF
+ killLogFileName = GNUNET_DISK_mktemp ("exponential-backoff-waiting.log");
+ if (NULL == (killLogFilePtr = FOPEN (killLogFileName,
+ "w")))
+ {
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
+ "fopen",
+ killLogFileName);
+ GNUNET_free (killLogFileName);
+ return GNUNET_SYSERR;
+ }
#endif
return GNUNET_OK;
}
GNUNET_assert (0 == fclose (killLogFilePtr));
GNUNET_free (killLogFileName);
#endif
+ (void) unlink (CFGFILENAME);
}
int ret;
GNUNET_log_setup ("test-exponential-backoff",
-#if VERBOSE
- "DEBUG",
-#else
- "WARNING",
-#endif
- NULL);
+ "WARNING",
+ NULL);
- init ();
+ if (GNUNET_OK != init ())
+ return 1;
ret = check ();
houseKeep ();
return ret;
projects / oweals / gnunet.git / blobdiff