/*
This file is part of GNUnet
- (C) 2012 Christian Grothoff (and other contributing authors)
+ (C) 2008--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
* gnunet-service-testbed. This binary also receives configuration
* from the remove controller which is put in a temporary location
* with ports and paths fixed so that gnunet-service-testbed runs
- * without any hurdles. This binary also kills the testbed service
- * should the connection from the remote controller is dropped
+ * without any hurdles.
+ *
+ * This helper monitors for three termination events. They are: (1)The
+ * stdin of the helper is closed for reading; (2)the helper received
+ * SIGTERM/SIGINT; (3)the testbed crashed. In case of events 1 and 2
+ * the helper kills the testbed service. When testbed crashed (event
+ * 3), the helper should send a SIGTERM to its own process group; this
+ * behaviour will help terminate any child processes (peers) testbed
+ * has started and prevents them from leaking and running forever.
+ *
* @author Sree Harsha Totakura <sreeharsha@totakura.in>
*/
#include "platform.h"
#include "gnunet_util_lib.h"
-#include "gnunet_testing_lib-new.h"
+#include "gnunet_testing_lib.h"
#include "gnunet_testbed_service.h"
#include "testbed_helper.h"
#include "testbed_api.h"
LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
+/**
+ * We need pipe control only on WINDOWS
+ */
+#if WINDOWS
+#define PIPE_CONTROL GNUNET_YES
+#else
+#define PIPE_CONTROL GNUNET_NO
+#endif
+
+
/**
* Context for a single write on a chunk of memory
*/
*/
static struct GNUNET_OS_Process *testbed;
+/**
+ * Pipe used to communicate shutdown via signal.
+ */
+static struct GNUNET_DISK_PipeHandle *sigpipe;
+
/**
* Task identifier for the read task
*/
static GNUNET_SCHEDULER_TaskIdentifier write_task_id;
/**
- * Are we done reading messages from stdin?
+ * Task to kill the child
*/
-static int done_reading;
+static GNUNET_SCHEDULER_TaskIdentifier child_death_task_id;
/**
- * Result to return in case we fail
+ * shutdown task id
*/
-static int status;
+static GNUNET_SCHEDULER_TaskIdentifier shutdown_task_id;
+/**
+ * Are we done reading messages from stdin?
+ */
+static int done_reading;
/**
- * Are we shutting down
+ * Result to return in case we fail
*/
-static int in_shutdown;
+static int status;
/**
- * Task to shutting down nicely
+ * Task to shut down cleanly
*
* @param cls NULL
* @param tc the task context
shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
LOG_DEBUG ("Shutting down\n");
- in_shutdown = GNUNET_YES;
+ shutdown_task_id = GNUNET_SCHEDULER_NO_TASK;
+ if (NULL != testbed)
+ {
+ LOG_DEBUG ("Killing testbed\n");
+ GNUNET_break (0 == GNUNET_OS_process_kill (testbed, GNUNET_TERM_SIG));
+ }
if (GNUNET_SCHEDULER_NO_TASK != read_task_id)
{
GNUNET_SCHEDULER_cancel (read_task_id);
GNUNET_SCHEDULER_cancel (write_task_id);
write_task_id = GNUNET_SCHEDULER_NO_TASK;
}
+ if (GNUNET_SCHEDULER_NO_TASK != child_death_task_id)
+ {
+ GNUNET_SCHEDULER_cancel (child_death_task_id);
+ child_death_task_id = GNUNET_SCHEDULER_NO_TASK;
+ }
if (NULL != stdin_fd)
(void) GNUNET_DISK_file_close (stdin_fd);
if (NULL != stdout_fd)
tokenizer = NULL;
if (NULL != testbed)
{
- LOG_DEBUG ("Killing testbed\n");
- GNUNET_break (0 == GNUNET_OS_process_kill (testbed, SIGTERM));
- GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (testbed));
+ GNUNET_break (GNUNET_OK == GNUNET_OS_process_wait (testbed));
GNUNET_OS_process_destroy (testbed);
testbed = NULL;
}
}
+/**
+ * Scheduler shutdown task to be run now.
+ */
+static void
+shutdown_now (void)
+{
+ if (GNUNET_SCHEDULER_NO_TASK != shutdown_task_id)
+ GNUNET_SCHEDULER_cancel (shutdown_task_id);
+ shutdown_task_id = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
+}
+
+
/**
* Task to write to the standard out
*
bytes_wrote =
GNUNET_DISK_file_write (stdout_fd, wc->data + wc->pos,
wc->length - wc->pos);
- GNUNET_assert (GNUNET_SYSERR != bytes_wrote);
+ if (GNUNET_SYSERR == bytes_wrote)
+ {
+ LOG (GNUNET_ERROR_TYPE_WARNING, "Cannot reply back configuration\n");
+ GNUNET_free (wc->data);
+ GNUNET_free (wc);
+ return;
+ }
wc->pos += bytes_wrote;
if (wc->pos == wc->length)
{
}
+/**
+ * Task triggered whenever we receive a SIGCHLD (child
+ * process died).
+ *
+ * @param cls closure, NULL if we need to self-restart
+ * @param tc context
+ */
+static void
+child_death_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+ const struct GNUNET_DISK_FileHandle *pr;
+ char c[16];
+ enum GNUNET_OS_ProcessStatusType type;
+ unsigned long code;
+ int ret;
+
+ pr = GNUNET_DISK_pipe_handle (sigpipe, GNUNET_DISK_PIPE_END_READ);
+ child_death_task_id = GNUNET_SCHEDULER_NO_TASK;
+ if (0 == (tc->reason & GNUNET_SCHEDULER_REASON_READ_READY))
+ {
+ child_death_task_id =
+ GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
+ pr, &child_death_task, NULL);
+ return;
+ }
+ /* consume the signal */
+ GNUNET_break (0 < GNUNET_DISK_file_read (pr, &c, sizeof (c)));
+ LOG_DEBUG ("Got SIGCHLD\n");
+ if (NULL == testbed)
+ {
+ GNUNET_break (0);
+ return;
+ }
+ GNUNET_break (GNUNET_SYSERR !=
+ (ret = GNUNET_OS_process_status (testbed, &type, &code)));
+ if (GNUNET_NO != ret)
+ {
+ GNUNET_OS_process_destroy (testbed);
+ testbed = NULL;
+ /* Send SIGTERM to our process group */
+ if (0 != PLIBC_KILL (0, GNUNET_TERM_SIG))
+ {
+ GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "signal");
+ shutdown_now (); /* Couldn't send the signal, we shutdown frowning */
+ }
+ return;
+ }
+ LOG_DEBUG ("Child hasn't died. Resuming to monitor its status\n");
+ child_death_task_id =
+ GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
+ pr, &child_death_task, NULL);
+}
+
+
/**
* Functions with this signature are called whenever a
* complete message is received by the tokenizer.
struct GNUNET_TESTBED_HelperReply *reply;
struct GNUNET_CONFIGURATION_Handle *cfg;
struct WriteContext *wc;
- char *controller;
+ char *binary;
+ char *trusted_ip;
+ char *hostname;
char *config;
char *xconfig;
+ char *evstr;
+ char *str;
size_t config_size;
uLongf ul_config_size;
size_t xconfig_size;
- uint16_t cname_size;
+ uint16_t trusted_ip_size;
+ uint16_t hostname_size;
+ uint16_t msize;
- if ((sizeof (struct GNUNET_TESTBED_HelperInit) >= ntohs (message->size)) ||
+ msize = ntohs (message->size);
+ if ((sizeof (struct GNUNET_TESTBED_HelperInit) >= msize) ||
(GNUNET_MESSAGE_TYPE_TESTBED_HELPER_INIT != ntohs (message->type)))
{
LOG (GNUNET_ERROR_TYPE_WARNING, "Received unexpected message -- exiting\n");
goto error;
}
msg = (const struct GNUNET_TESTBED_HelperInit *) message;
- cname_size = ntohs (msg->cname_size);
- controller = (char *) &msg[1];
- if ('\0' != controller[cname_size])
+ trusted_ip_size = ntohs (msg->trusted_ip_size);
+ trusted_ip = (char *) &msg[1];
+ if ('\0' != trusted_ip[trusted_ip_size])
{
- LOG (GNUNET_ERROR_TYPE_WARNING,
- "Controller name cannot be empty -- exiting\n");
+ LOG (GNUNET_ERROR_TYPE_WARNING, "Trusted IP cannot be empty -- exiting\n");
+ goto error;
+ }
+ hostname_size = ntohs (msg->hostname_size);
+ if ((sizeof (struct GNUNET_TESTBED_HelperInit) + trusted_ip_size + 1 +
+ hostname_size) >= msize)
+ {
+ GNUNET_break (0);
+ LOG (GNUNET_ERROR_TYPE_WARNING, "Received unexpected message -- exiting\n");
goto error;
}
ul_config_size = (uLongf) ntohs (msg->config_size);
config = GNUNET_malloc (ul_config_size);
xconfig_size =
- ntohs (message->size) - (cname_size + 1 +
+ ntohs (message->size) - (trusted_ip_size + 1 +
sizeof (struct GNUNET_TESTBED_HelperInit));
if (Z_OK !=
uncompress ((Bytef *) config, &ul_config_size,
- (const Bytef *) (controller + cname_size + 1),
- (uLongf) xconfig_size))
+ (const Bytef *) (trusted_ip + trusted_ip_size + 1 +
+ hostname_size), (uLongf) xconfig_size))
{
LOG (GNUNET_ERROR_TYPE_WARNING,
"Error while uncompressing config -- exiting\n");
goto error;
}
GNUNET_free (config);
- test_system = GNUNET_TESTING_system_create ("testbed-helper", controller);
+ hostname = NULL;
+ if (0 != hostname_size)
+ {
+ hostname = GNUNET_malloc (hostname_size + 1);
+ (void) strncpy (hostname, ((char *) &msg[1]) + trusted_ip_size + 1,
+ hostname_size);
+ hostname[hostname_size] = '\0';
+ }
+ /* unset GNUNET_TESTING_PREFIX if present as it is more relevant for testbed */
+ evstr = getenv (GNUNET_TESTING_PREFIX);
+ if (NULL != evstr)
+ {
+#if WINDOWS
+ GNUNET_break (0 == putenv (GNUNET_TESTING_PREFIX "="));
+#else
+ GNUNET_break (0 == unsetenv (GNUNET_TESTING_PREFIX));
+#endif
+ }
+ test_system =
+ GNUNET_TESTING_system_create ("testbed-helper", trusted_ip, hostname,
+ NULL);
+ if (NULL != evstr)
+ {
+ GNUNET_assert (0 < GNUNET_asprintf (&str,
+ GNUNET_TESTING_PREFIX "=%s", evstr));
+ putenv (str);
+ /* do not free str will be consumed by putenv */
+ GNUNET_free (evstr);
+ }
+ GNUNET_free_non_null (hostname);
+ hostname = NULL;
GNUNET_assert (NULL != test_system);
GNUNET_assert (GNUNET_OK ==
GNUNET_TESTING_configuration_create (test_system, cfg));
goto error;
}
LOG_DEBUG ("Staring testbed with config: %s\n", config);
+ binary = GNUNET_OS_get_libexec_binary_path ("gnunet-service-testbed");
+ /* expose testbed configuration through env variable */
+ GNUNET_assert (0 < GNUNET_asprintf (&evstr, "%s=%s", ENV_TESTBED_CONFIG, config));
+ GNUNET_assert (0 == putenv (evstr)); /* Do NOT free evstr; it is consumed by putenv */
testbed =
- GNUNET_OS_start_process (GNUNET_YES,
+ GNUNET_OS_start_process (PIPE_CONTROL,
GNUNET_OS_INHERIT_STD_ERR /*verbose? */ , NULL,
- NULL, "gnunet-service-testbed",
- "gnunet-service-testbed", "-c", config, NULL);
+ NULL, binary, "gnunet-service-testbed", "-c",
+ config, NULL);
+ GNUNET_free (binary);
GNUNET_free (config);
if (NULL == testbed)
{
LOG (GNUNET_ERROR_TYPE_WARNING,
- "Error staring gnunet-service-testbed -- exiting\n");
+ "Error starting gnunet-service-testbed -- exiting\n");
GNUNET_CONFIGURATION_destroy (cfg);
goto error;
}
write_task_id =
GNUNET_SCHEDULER_add_write_file (GNUNET_TIME_UNIT_FOREVER_REL, stdout_fd,
&write_task, wc);
+ child_death_task_id =
+ GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
+ GNUNET_DISK_pipe_handle (sigpipe,
+ GNUNET_DISK_PIPE_END_READ),
+ &child_death_task, NULL);
return GNUNET_OK;
error:
status = GNUNET_SYSERR;
- GNUNET_SCHEDULER_shutdown ();
+ shutdown_now ();
return GNUNET_SYSERR;
}
sread = GNUNET_DISK_file_read (stdin_fd, buf, sizeof (buf));
if ((GNUNET_SYSERR == sread) || (0 == sread))
{
- GNUNET_SCHEDULER_shutdown ();
+ LOG_DEBUG ("STDIN closed\n");
+ shutdown_now ();
return;
}
if (GNUNET_YES == done_reading)
{
/* didn't expect any more data! */
- GNUNET_SCHEDULER_shutdown ();
+ GNUNET_break_op (0);
+ shutdown_now ();
return;
}
LOG_DEBUG ("Read %u bytes\n", sread);
GNUNET_NO))
{
GNUNET_break (0);
- GNUNET_SCHEDULER_shutdown ();
+ shutdown_now ();
return;
}
read_task_id = /* No timeout while reading */
read_task_id =
GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL, stdin_fd,
&read_task, NULL);
- GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
- NULL);
+ shutdown_task_id =
+ GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
+ NULL);
}
static void
sighandler_child_death ()
{
- if ((NULL != testbed) && (GNUNET_NO == in_shutdown))
- {
- LOG_DEBUG ("Child died\n");
- GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (testbed));
- GNUNET_OS_process_destroy (testbed);
- testbed = NULL;
- GNUNET_SCHEDULER_shutdown (); /* We are done too! */
- }
+ static char c;
+ int old_errno; /* back-up errno */
+
+ old_errno = errno;
+ GNUNET_break (1 ==
+ GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
+ (sigpipe, GNUNET_DISK_PIPE_END_WRITE),
+ &c, sizeof (c)));
+ errno = old_errno;
}
int ret;
status = GNUNET_OK;
- in_shutdown = GNUNET_NO;
+ if (NULL == (sigpipe = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO,
+ GNUNET_NO, GNUNET_NO)))
+ {
+ GNUNET_break (0);
+ return 1;
+ }
shc_chld =
GNUNET_SIGNAL_handler_install (GNUNET_SIGCHLD, &sighandler_child_death);
ret =
&run, NULL);
GNUNET_SIGNAL_handler_uninstall (shc_chld);
shc_chld = NULL;
+ GNUNET_DISK_pipe_close (sigpipe);
if (GNUNET_OK != ret)
return 1;
return (GNUNET_OK == status) ? 0 : 1;