/*
This file is part of GNUnet
- (C) 2008, 2009 Christian Grothoff (and other contributing authors)
+ (C) 2008, 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 testing/testing.c
* @brief convenience API for writing testcases for GNUnet
- * Many testcases need to start and stop gnunetd,
+ * Many testcases need to start and stop a peer/service
* and this library is supposed to make that easier
* for TESTCASES. Normal programs should always
* use functions from gnunet_{util,arm}_lib.h. This API is
- * ONLY for writing testcases!
+ * ONLY for writing testcases (or internal use of the testbed).
* @author Christian Grothoff
*
*/
#include "platform.h"
+#include "gnunet_util_lib.h"
#include "gnunet_arm_service.h"
-#include "gnunet_core_service.h"
-#include "gnunet_constants.h"
#include "gnunet_testing_lib.h"
-#include "gnunet_transport_service.h"
-#include "gnunet_hello_lib.h"
-#define DEBUG_TESTING GNUNET_NO
-#define DEBUG_TESTING_RECONNECT GNUNET_NO
-
-/**
- * How long do we wait after starting gnunet-service-arm
- * for the core service to be alive?
- */
-#define ARM_START_WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
-
-/**
- * How many times are we willing to try to wait for "scp" or
- * "gnunet-service-arm" to complete (waitpid) before giving up?
- */
-#define MAX_EXEC_WAIT_RUNS 250
-
-static struct GNUNET_CORE_MessageHandler no_handlers[] = { {NULL, 0, 0} };
-
-/**
- * Receive the HELLO from one peer, give it to the other
- * and ask them to connect.
- *
- * @param cls "struct ConnectContext"
- * @param message HELLO message of peer
- */
-static void
-process_hello (void *cls, const struct GNUNET_MessageHeader *message)
-{
- struct GNUNET_TESTING_Daemon *daemon = cls;
- int msize;
- if (daemon == NULL)
- return;
-
- if (daemon->server != NULL)
- {
- GNUNET_CORE_disconnect(daemon->server);
- daemon->server = NULL;
- }
-
- GNUNET_assert (message != NULL);
- msize = ntohs(message->size);
- if (msize < 1)
- {
- return;
- }
- if (daemon->th != NULL)
- {
- GNUNET_TRANSPORT_get_hello_cancel(daemon->th, &process_hello, daemon);
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Received `%s' from transport service of `%4s'\n",
- "HELLO", GNUNET_i2s (&daemon->id));
-#endif
-
-
-
- {
- GNUNET_free_non_null(daemon->hello);
- daemon->hello = GNUNET_malloc(msize);
- memcpy(daemon->hello, message, msize);
-
- if (daemon->th != NULL)
- {
- GNUNET_TRANSPORT_disconnect(daemon->th);
- daemon->th = NULL;
- }
- }
-
-}
-
-/**
- * Function called after GNUNET_CORE_connect has succeeded
- * (or failed for good). Note that the private key of the
- * peer is intentionally not exposed here; if you need it,
- * your process should try to read the private key file
- * directly (which should work if you are authorized...).
- *
- * @param cls closure
- * @param server handle to the server, NULL if we failed
- * @param my_identity ID of this peer, NULL if we failed
- * @param publicKey public key of this peer, NULL if we failed
- */
-static void
-testing_init (void *cls,
- struct GNUNET_CORE_Handle *server,
- const struct GNUNET_PeerIdentity *my_identity,
- const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
-{
- struct GNUNET_TESTING_Daemon *d = cls;
- GNUNET_TESTING_NotifyDaemonRunning cb;
-
- GNUNET_assert (d->phase == SP_START_CORE);
- d->phase = SP_START_DONE;
- cb = d->cb;
- d->cb = NULL;
- if (server == NULL)
- {
- d->server = NULL;
- if (GNUNET_YES == d->dead)
- GNUNET_TESTING_daemon_stop (d, GNUNET_TIME_absolute_get_remaining(d->max_timeout), d->dead_cb, d->dead_cb_cls, GNUNET_YES, GNUNET_NO);
- else if (NULL != cb)
- cb (d->cb_cls, NULL, d->cfg, d,
- _("Failed to connect to core service\n"));
- return;
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Successfully started peer `%4s'.\n", GNUNET_i2s (my_identity));
-#endif
- d->id = *my_identity;
- d->shortname = strdup (GNUNET_i2s (my_identity));
- d->server = server;
- d->running = GNUNET_YES;
- if (GNUNET_YES == d->dead)
- GNUNET_TESTING_daemon_stop (d, GNUNET_TIME_absolute_get_remaining(d->max_timeout), d->dead_cb, d->dead_cb_cls, GNUNET_YES, GNUNET_NO);
- else if (NULL != cb)
- cb (d->cb_cls, my_identity, d->cfg, d, NULL);
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Successfully started peer `%4s'.\n", GNUNET_i2s (my_identity));
-#endif
-
-
- d->th = GNUNET_TRANSPORT_connect (d->sched,
- d->cfg,
- &d->id,
- d, NULL, NULL, NULL);
- if (d->th == NULL)
- {
- if (GNUNET_YES == d->dead)
- GNUNET_TESTING_daemon_stop (d, GNUNET_TIME_absolute_get_remaining(d->max_timeout), d->dead_cb, d->dead_cb_cls, GNUNET_YES, GNUNET_NO);
- else if (NULL != d->cb)
- d->cb (d->cb_cls, &d->id, d->cfg, d,
- _("Failed to connect to transport service!\n"));
- return;
- }
-
- GNUNET_TRANSPORT_get_hello (d->th, &process_hello, d);
-}
+#define LOG(kind,...) \
+ GNUNET_log_from (kind, "testing-api", __VA_ARGS__)
/**
- * Finite-state machine for starting GNUnet.
- *
- * @param cls our "struct GNUNET_TESTING_Daemon"
- * @param tc unused
+ * We need pipe control only on WINDOWS
*/
-static void
-start_fsm (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc)
-{
- struct GNUNET_TESTING_Daemon *d = cls;
- GNUNET_TESTING_NotifyDaemonRunning cb;
- enum GNUNET_OS_ProcessStatusType type;
- unsigned long code;
- char *dst;
- int bytes_read;
-
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Peer FSM is in phase %u.\n", d->phase);
+#if WINDOWS
+#define PIPE_CONTROL GNUNET_YES
+#else
+#define PIPE_CONTROL GNUNET_NO
#endif
- d->task = GNUNET_SCHEDULER_NO_TASK;
- switch (d->phase)
- {
- case SP_COPYING:
- /* confirm copying complete */
- if (GNUNET_OK != GNUNET_OS_process_status (d->proc, &type, &code))
- {
- if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0)
- {
- cb = d->cb;
- d->cb = NULL;
- if (NULL != cb)
- cb (d->cb_cls,
- NULL,
- d->cfg, d, _("`scp' does not seem to terminate (timeout copying config).\n"));
- return;
- }
- /* wait some more */
- d->task
- = GNUNET_SCHEDULER_add_delayed (d->sched,
- GNUNET_CONSTANTS_EXEC_WAIT,
- &start_fsm, d);
- return;
- }
- if ((type != GNUNET_OS_PROCESS_EXITED) || (code != 0))
- {
- cb = d->cb;
- d->cb = NULL;
- if (NULL != cb)
- cb (d->cb_cls,
- NULL, d->cfg, d, _("`scp' did not complete cleanly.\n"));
- return;
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Successfully copied configuration file.\n");
-#endif
- d->phase = SP_COPIED;
- /* fall-through */
- case SP_COPIED:
- /* Start create hostkey process */
- d->pipe_stdout = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_YES);
- if (d->pipe_stdout == NULL)
- {
- cb = d->cb;
- d->cb = NULL;
- if (NULL != cb)
- cb (d->cb_cls,
- NULL,
- d->cfg,
- d,
- (NULL == d->hostname)
- ? _("Failed to create pipe for `gnunet-peerinfo' process.\n")
- : _("Failed to create pipe for `ssh' process.\n"));
- return;
- }
- if (NULL == d->hostname)
- {
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Starting `%s', with command `%s %s %s %s'.\n",
- "gnunet-peerinfo", "gnunet-peerinfo", "-c", d->cfgfile,
- "-sq");
-#endif
- d->proc = GNUNET_OS_start_process (NULL, d->pipe_stdout, "gnunet-peerinfo",
- "gnunet-peerinfo",
- "-c", d->cfgfile,
- "-sq", NULL);
- GNUNET_DISK_pipe_close_end(d->pipe_stdout, GNUNET_DISK_PIPE_END_WRITE);
- }
- else
- {
- if (d->username != NULL)
- GNUNET_asprintf (&dst, "%s@%s", d->username, d->hostname);
- else
- dst = GNUNET_strdup (d->hostname);
-
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Starting `%s', with command `%s %s %s %s %s %s'.\n",
- "gnunet-peerinfo", "ssh", dst, "gnunet-peerinfo", "-c", d->cfgfile,
- "-sq");
-#endif
- if (d->ssh_port_str == NULL)
- {
- d->proc = GNUNET_OS_start_process (NULL, d->pipe_stdout, "ssh",
- "ssh",
-#if !DEBUG_TESTING
- "-q",
-#endif
- dst,
- "gnunet-peerinfo",
- "-c", d->cfgfile, "-sq", NULL);
- }
- else
- {
- d->proc = GNUNET_OS_start_process (NULL, d->pipe_stdout, "ssh",
- "ssh", "-p", d->ssh_port_str,
-#if !DEBUG_TESTING
- "-q",
-#endif
- dst,
- "gnunet-peerinfo",
- "-c", d->cfgfile, "-sq", NULL);
- }
- GNUNET_DISK_pipe_close_end(d->pipe_stdout, GNUNET_DISK_PIPE_END_WRITE);
- GNUNET_free (dst);
- }
- if (NULL == d->proc)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _("Could not start `%s' process to create hostkey.\n"),
- (NULL == d->hostname) ? "gnunet-peerinfo" : "ssh");
- cb = d->cb;
- d->cb = NULL;
- if (NULL != cb)
- cb (d->cb_cls,
- NULL,
- d->cfg,
- d,
- (NULL == d->hostname)
- ? _("Failed to start `gnunet-peerinfo' process.\n")
- : _("Failed to start `ssh' process.\n"));
- GNUNET_DISK_pipe_close(d->pipe_stdout);
- return;
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Started `%s', waiting for hostkey.\n",
- "gnunet-peerinfo");
-#endif
- d->phase = SP_HOSTKEY_CREATE;
- d->task
- = GNUNET_SCHEDULER_add_read_file (d->sched,
- GNUNET_TIME_absolute_get_remaining(d->max_timeout),
- GNUNET_DISK_pipe_handle(d->pipe_stdout,
- GNUNET_DISK_PIPE_END_READ),
- &start_fsm,
- d);
- break;
- case SP_HOSTKEY_CREATE:
- bytes_read = GNUNET_DISK_file_read(GNUNET_DISK_pipe_handle(d->pipe_stdout,
- GNUNET_DISK_PIPE_END_READ),
- &d->hostkeybuf[d->hostkeybufpos],
- sizeof(d->hostkeybuf) - d->hostkeybufpos);
- if (bytes_read > 0)
- d->hostkeybufpos += bytes_read;
-
- if ( (d->hostkeybufpos < 104) &&
- (bytes_read > 0) )
- {
- /* keep reading */
- d->task
- = GNUNET_SCHEDULER_add_read_file (d->sched,
- GNUNET_TIME_absolute_get_remaining(d->max_timeout),
- GNUNET_DISK_pipe_handle(d->pipe_stdout,
- GNUNET_DISK_PIPE_END_READ),
- &start_fsm,
- d);
- return;
- }
- d->hostkeybuf[103] = '\0';
- if ( (bytes_read < 0) ||
- (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (d->hostkeybuf,
- &d->id.hashPubKey)) )
- {
- /* error */
- if (bytes_read < 0)
- GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
- _("Error reading from gnunet-peerinfo: %s\n"),
- STRERROR (errno));
- else
- GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
- _("Malformed output from gnunet-peerinfo!\n"));
- cb = d->cb;
- d->cb = NULL;
- GNUNET_DISK_pipe_close(d->pipe_stdout);
- d->pipe_stdout = NULL;
- (void) GNUNET_OS_process_kill (d->proc, SIGKILL);
- GNUNET_break (GNUNET_OK == GNUNET_OS_process_wait (d->proc));
- GNUNET_OS_process_close (d->proc);
- d->proc = NULL;
- if (NULL != cb)
- cb (d->cb_cls,
- NULL,
- d->cfg,
- d,
- _("`Failed to get hostkey!\n"));
- return;
- }
- GNUNET_DISK_pipe_close(d->pipe_stdout);
- d->pipe_stdout = NULL;
- (void) GNUNET_OS_process_kill (d->proc, SIGKILL);
- GNUNET_break (GNUNET_OK == GNUNET_OS_process_wait (d->proc));
- GNUNET_OS_process_close (d->proc);
- d->proc = NULL;
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Successfully got hostkey!\n");
-#endif
- if (d->hostkey_callback != NULL)
- {
- d->hostkey_callback(d->hostkey_cls, &d->id, d, NULL);
- d->phase = SP_HOSTKEY_CREATED;
- }
- else
- {
- d->phase = SP_TOPOLOGY_SETUP;
- }
- /* Fall through */
- case SP_HOSTKEY_CREATED:
- /* wait for topology finished */
- if ((GNUNET_YES == d->dead) || (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0))
- {
- cb = d->cb;
- d->cb = NULL;
- if (NULL != cb)
- cb (d->cb_cls,
- NULL,
- d->cfg,
- d,
- _("`Failed while waiting for topology setup!\n"));
- return;
- }
-
- d->task
- = GNUNET_SCHEDULER_add_delayed (d->sched,
- GNUNET_CONSTANTS_EXEC_WAIT,
- &start_fsm, d);
- break;
- case SP_TOPOLOGY_SETUP:
- /* start GNUnet on remote host */
- if (NULL == d->hostname)
- {
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Starting `%s', with command `%s %s %s %s %s %s'.\n",
- "gnunet-arm", "gnunet-arm", "-c", d->cfgfile,
- "-L", "DEBUG",
- "-s");
-#endif
- d->proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-arm",
- "gnunet-arm",
- "-c", d->cfgfile,
-#if DEBUG_TESTING
- "-L", "DEBUG",
-#endif
- "-s", "-q", NULL);
- }
- else
- {
- if (d->username != NULL)
- GNUNET_asprintf (&dst, "%s@%s", d->username, d->hostname);
- else
- dst = GNUNET_strdup (d->hostname);
-
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Starting `%s', with command `%s %s %s %s %s %s %s %s'.\n",
- "gnunet-arm", "ssh", dst, "gnunet-arm", "-c", d->cfgfile,
- "-L", "DEBUG", "-s", "-q");
-#endif
- if (d->ssh_port_str == NULL)
- {
- d->proc = GNUNET_OS_start_process (NULL, NULL, "ssh",
- "ssh",
-#if !DEBUG_TESTING
- "-q",
-#endif
- dst,
- "gnunet-arm",
-#if DEBUG_TESTING
- "-L", "DEBUG",
-#endif
- "-c", d->cfgfile, "-s", "-q", NULL);
- }
- else
- {
-
- d->proc = GNUNET_OS_start_process (NULL, NULL, "ssh",
- "ssh", "-p", d->ssh_port_str,
-#if !DEBUG_TESTING
- "-q",
-#endif
- dst,
- "gnunet-arm",
-#if DEBUG_TESTING
- "-L", "DEBUG",
-#endif
- "-c", d->cfgfile, "-s", "-q", NULL);
- }
- GNUNET_free (dst);
- }
- if (NULL == d->proc)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _("Could not start `%s' process to start GNUnet.\n"),
- (NULL == d->hostname) ? "gnunet-arm" : "ssh");
- cb = d->cb;
- d->cb = NULL;
- if (NULL != cb)
- cb (d->cb_cls,
- NULL,
- d->cfg,
- d,
- (NULL == d->hostname)
- ? _("Failed to start `gnunet-arm' process.\n")
- : _("Failed to start `ssh' process.\n"));
- return;
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Started `%s', waiting for `%s' to be up.\n",
- "gnunet-arm", "gnunet-service-core");
-#endif
- d->phase = SP_START_ARMING;
- d->task
- = GNUNET_SCHEDULER_add_delayed (d->sched,
- GNUNET_CONSTANTS_EXEC_WAIT,
- &start_fsm, d);
- break;
- case SP_START_ARMING:
- if (GNUNET_OK != GNUNET_OS_process_status (d->proc, &type, &code))
- {
- if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0)
- {
- cb = d->cb;
- d->cb = NULL;
- if (NULL != cb)
- cb (d->cb_cls,
- NULL,
- d->cfg,
- d,
- (NULL == d->hostname)
- ? _("`gnunet-arm' does not seem to terminate.\n")
- : _("`ssh' does not seem to terminate.\n"));
- return;
- }
- /* wait some more */
- d->task
- = GNUNET_SCHEDULER_add_delayed (d->sched,
- GNUNET_CONSTANTS_EXEC_WAIT,
- &start_fsm, d);
- return;
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Successfully started `%s'.\n", "gnunet-arm");
-#endif
- d->phase = SP_START_CORE;
- d->server = GNUNET_CORE_connect (d->sched,
- d->cfg,
- ARM_START_WAIT,
- d,
- &testing_init,
- NULL, NULL, NULL,
- NULL, GNUNET_NO,
- NULL, GNUNET_NO, no_handlers);
- break;
- case SP_START_CORE:
- GNUNET_break (0);
- break;
- case SP_START_DONE:
- GNUNET_break (0);
- break;
- case SP_SHUTDOWN_START:
- /* confirm copying complete */
- if (GNUNET_OK != GNUNET_OS_process_status (d->proc, &type, &code))
- {
- if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0)
- {
- if (NULL != d->dead_cb)
- d->dead_cb (d->dead_cb_cls,
- _("either `gnunet-arm' or `ssh' does not seem to terminate.\n"));
- if (d->th != NULL)
- {
- GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
- GNUNET_TRANSPORT_disconnect(d->th);
- d->th = NULL;
- }
- GNUNET_CONFIGURATION_destroy (d->cfg);
- GNUNET_free (d->cfgfile);
- GNUNET_free_non_null(d->hello);
- GNUNET_free_non_null (d->hostname);
- GNUNET_free_non_null (d->username);
- GNUNET_free_non_null (d->shortname);
- GNUNET_free (d);
- return;
- }
- /* wait some more */
- d->task
- = GNUNET_SCHEDULER_add_delayed (d->sched,
- GNUNET_CONSTANTS_EXEC_WAIT,
- &start_fsm, d);
- return;
- }
- if ((type != GNUNET_OS_PROCESS_EXITED) || (code != 0))
- {
- if (NULL != d->dead_cb)
- d->dead_cb (d->dead_cb_cls,
- _("shutdown (either `gnunet-arm' or `ssh') did not complete cleanly.\n"));
- if (d->th != NULL)
- {
- GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
- GNUNET_TRANSPORT_disconnect(d->th);
- d->th = NULL;
- }
- GNUNET_CONFIGURATION_destroy (d->cfg);
- GNUNET_free (d->cfgfile);
- GNUNET_free_non_null(d->hello);
- GNUNET_free_non_null (d->hostname);
- GNUNET_free_non_null (d->username);
- GNUNET_free_non_null (d->shortname);
- GNUNET_free (d);
- return;
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer shutdown complete.\n");
-#endif
- if (d->th != NULL)
- {
- GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
- GNUNET_TRANSPORT_disconnect(d->th);
- d->th = NULL;
- }
- /* state clean up and notifications */
- if (d->churn == GNUNET_NO)
- {
- GNUNET_CONFIGURATION_destroy (d->cfg);
- GNUNET_free (d->cfgfile);
- GNUNET_free_non_null (d->hostname);
- GNUNET_free_non_null (d->username);
- }
-
- GNUNET_free_non_null(d->hello);
- d->hello = NULL;
- GNUNET_free_non_null (d->shortname);
- d->shortname = NULL;
- if (NULL != d->dead_cb)
- d->dead_cb (d->dead_cb_cls, NULL);
-
- if (d->churn == GNUNET_NO)
- GNUNET_free (d);
-
- break;
- case SP_CONFIG_UPDATE:
- /* confirm copying complete */
- if (GNUNET_OK != GNUNET_OS_process_status (d->proc, &type, &code))
- {
- if (GNUNET_TIME_absolute_get_remaining(d->max_timeout).rel_value == 0) /* FIXME: config update should take timeout parameter! */
- {
- cb = d->cb;
- d->cb = NULL;
- if (NULL != cb)
- cb (d->cb_cls,
- NULL,
- d->cfg, d, _("`scp' does not seem to terminate.\n"));
- return;
- }
- /* wait some more */
- d->task
- = GNUNET_SCHEDULER_add_delayed (d->sched,
- GNUNET_CONSTANTS_EXEC_WAIT,
- &start_fsm, d);
- return;
- }
- if ((type != GNUNET_OS_PROCESS_EXITED) || (code != 0))
- {
- if (NULL != d->update_cb)
- d->update_cb (d->update_cb_cls,
- _("`scp' did not complete cleanly.\n"));
- return;
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Successfully copied configuration file.\n");
-#endif
- if (NULL != d->update_cb)
- d->update_cb (d->update_cb_cls, NULL);
- d->phase = SP_START_DONE;
- break;
- }
-}
/**
- * Continues GNUnet daemon startup when user wanted to be notified
- * once a hostkey was generated (for creating friends files, blacklists,
- * etc.).
- *
- * @param daemon the daemon to finish starting
+ * Lowest port used for GNUnet testing. Should be high enough to not
+ * conflict with other applications running on the hosts but be low
+ * enough to not conflict with client-ports (typically starting around
+ * 32k).
*/
-void
-GNUNET_TESTING_daemon_continue_startup(struct GNUNET_TESTING_Daemon *daemon)
-{
- GNUNET_assert(daemon->phase == SP_HOSTKEY_CREATED);
- daemon->phase = SP_TOPOLOGY_SETUP;
-}
+#define LOW_PORT 12000
/**
- * Check whether the given daemon is running.
- *
- * @param daemon the daemon to check
- *
- * @return GNUNET_YES if the daemon is up, GNUNET_NO if the
- * daemon is down, GNUNET_SYSERR on error.
+ * Highest port used for GNUnet testing. Should be low enough to not
+ * conflict with the port range for "local" ports (client apps; see
+ * /proc/sys/net/ipv4/ip_local_port_range on Linux for example).
*/
-int
-GNUNET_TESTING_daemon_running (struct GNUNET_TESTING_Daemon *daemon)
-{
- if (daemon == NULL)
- return GNUNET_SYSERR;
-
- if (daemon->running == GNUNET_YES)
- return GNUNET_YES;
- return GNUNET_NO;
-}
+#define HIGH_PORT 56000
-/**
- * Start a peer that has previously been stopped using the daemon_stop
- * call (and files weren't deleted and the allow restart flag)
- *
- * @param daemon the daemon to start (has been previously stopped)
- * @param timeout how long to wait for restart
- * @param cb the callback for notification when the peer is running
- * @param cb_cls closure for the callback
- */
-void
-GNUNET_TESTING_daemon_start_stopped (struct GNUNET_TESTING_Daemon *daemon,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_TESTING_NotifyDaemonRunning cb,
- void *cb_cls)
+struct SharedServiceInstance
{
- if (daemon->running == GNUNET_YES)
- {
- cb(cb_cls, &daemon->id, daemon->cfg, daemon, "Daemon already running, can't restart!");
- return;
- }
+ struct SharedService *ss;
- daemon->cb = cb;
- daemon->cb_cls = cb_cls;
- daemon->phase = SP_TOPOLOGY_SETUP;
- daemon->max_timeout = GNUNET_TIME_relative_to_absolute(timeout);
+ char *cfg_fn;
- GNUNET_SCHEDULER_add_continuation (daemon->sched,
- &start_fsm,
- daemon,
- GNUNET_SCHEDULER_REASON_PREREQ_DONE);
-}
+ struct GNUNET_OS_Process *proc;
-/**
- * Starts a GNUnet daemon. GNUnet must be installed on the target
- * system and available in the PATH. The machine must furthermore be
- * reachable via "ssh" (unless the hostname is "NULL") without the
- * need to enter a password.
- *
- * @param sched scheduler to use
- * @param cfg configuration to use
- * @param timeout how long to wait starting up peers
- * @param hostname name of the machine where to run GNUnet
- * (use NULL for localhost).
- * @param ssh_username ssh username to use when connecting to hostname
- * @param sshport port to pass to ssh process when connecting to hostname
- * @param hostkey_callback function to call once the hostkey has been
- * generated for this peer, but it hasn't yet been started
- * (NULL to start immediately, otherwise waits on GNUNET_TESTING_daemon_continue_start)
- * @param hostkey_cls closure for hostkey callback
- * @param cb function to call once peer is up, or failed to start
- * @param cb_cls closure for cb
- * @return handle to the daemon (actual start will be completed asynchronously)
- */
-struct GNUNET_TESTING_Daemon *
-GNUNET_TESTING_daemon_start (struct GNUNET_SCHEDULER_Handle *sched,
- const struct GNUNET_CONFIGURATION_Handle *cfg,
- struct GNUNET_TIME_Relative timeout,
- const char *hostname,
- const char *ssh_username,
- uint16_t sshport,
- GNUNET_TESTING_NotifyHostkeyCreated hostkey_callback,
- void *hostkey_cls,
- GNUNET_TESTING_NotifyDaemonRunning cb,
- void *cb_cls)
-{
- struct GNUNET_TESTING_Daemon *ret;
- char *arg;
- char *username;
-
- ret = GNUNET_malloc (sizeof (struct GNUNET_TESTING_Daemon));
- ret->sched = sched;
- ret->hostname = (hostname == NULL) ? NULL : GNUNET_strdup (hostname);
- if (sshport != 0)
- {
- GNUNET_asprintf(&ret->ssh_port_str, "%d", sshport);
- }
- else
- ret->ssh_port_str = NULL;
- ret->cfgfile = GNUNET_DISK_mktemp ("gnunet-testing-config");
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Setting up peer with configuration file `%s'.\n",
- ret->cfgfile);
-#endif
- if (NULL == ret->cfgfile)
- {
- GNUNET_free_non_null (ret->hostname);
- GNUNET_free (ret);
- return NULL;
- }
- ret->hostkey_callback = hostkey_callback;
- ret->hostkey_cls = hostkey_cls;
- ret->cb = cb;
- ret->cb_cls = cb_cls;
- ret->max_timeout = GNUNET_TIME_relative_to_absolute(timeout);
- ret->cfg = GNUNET_CONFIGURATION_dup (cfg);
- GNUNET_CONFIGURATION_set_value_string (ret->cfg,
- "PATHS",
- "DEFAULTCONFIG", ret->cfgfile);
- /* 1) write configuration to temporary file */
- if (GNUNET_OK != GNUNET_CONFIGURATION_write (ret->cfg, ret->cfgfile))
- {
- if (0 != UNLINK (ret->cfgfile))
- GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
- "unlink", ret->cfgfile);
- GNUNET_CONFIGURATION_destroy (ret->cfg);
- GNUNET_free_non_null (ret->hostname);
- GNUNET_free (ret->cfgfile);
- GNUNET_free (ret);
- return NULL;
- }
- if (ssh_username != NULL)
- username = GNUNET_strdup(ssh_username);
- if ((ssh_username == NULL) && (GNUNET_OK !=
- GNUNET_CONFIGURATION_get_value_string (cfg,
- "TESTING",
- "USERNAME", &username)))
- {
- if (NULL != getenv ("USER"))
- username = GNUNET_strdup (getenv ("USER"));
- else
- username = NULL;
- }
- ret->username = username;
+ char *unix_sock;
- /* 2) copy file to remote host */
- if (NULL != hostname)
- {
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Copying configuration file to host `%s'.\n", hostname);
-#endif
- ret->phase = SP_COPYING;
- if (NULL != username)
- GNUNET_asprintf (&arg, "%s@%s:%s", username, hostname, ret->cfgfile);
- else
- GNUNET_asprintf (&arg, "%s:%s", hostname, ret->cfgfile);
-
- if (ret->ssh_port_str == NULL)
- {
- ret->proc = GNUNET_OS_start_process (NULL, NULL, "scp",
- "scp",
-#if !DEBUG_TESTING
- "-q",
-#endif
- ret->cfgfile, arg, NULL);
- }
- else
- {
- ret->proc = GNUNET_OS_start_process (NULL, NULL, "scp",
- "scp", "-P", ret->ssh_port_str,
-#if !DEBUG_TESTING
- "-q",
-#endif
- ret->cfgfile, arg, NULL);
- }
- GNUNET_free (arg);
- if (NULL == ret->proc)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _
- ("Could not start `%s' process to copy configuration file.\n"),
- "scp");
- if (0 != UNLINK (ret->cfgfile))
- GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
- "unlink", ret->cfgfile);
- GNUNET_CONFIGURATION_destroy (ret->cfg);
- GNUNET_free_non_null (ret->hostname);
- GNUNET_free_non_null (ret->username);
- GNUNET_free (ret->cfgfile);
- GNUNET_free (ret);
- return NULL;
- }
- ret->task
- = GNUNET_SCHEDULER_add_delayed (sched,
- GNUNET_CONSTANTS_EXEC_WAIT,
- &start_fsm, ret);
- return ret;
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "No need to copy configuration file since we are running locally.\n");
-#endif
- ret->phase = SP_COPIED;
- GNUNET_SCHEDULER_add_continuation (sched,
- &start_fsm,
- ret,
- GNUNET_SCHEDULER_REASON_PREREQ_DONE);
- return ret;
-}
+ char *port_str;
+ unsigned int n_refs;
+};
-/**
- * Restart (stop and start) a GNUnet daemon.
- *
- * @param d the daemon that should be restarted
- * @param cb function called once the daemon is (re)started
- * @param cb_cls closure for cb
- */
-void
-GNUNET_TESTING_daemon_restart (struct GNUNET_TESTING_Daemon *d,
- GNUNET_TESTING_NotifyDaemonRunning cb, void *cb_cls)
+struct SharedService
{
- char *arg;
- char *del_arg;
-
- del_arg = NULL;
- if (NULL != d->cb)
- {
- d->dead = GNUNET_YES;
- return;
- }
-
- d->cb = cb;
- d->cb_cls = cb_cls;
-
- if (d->phase == SP_CONFIG_UPDATE)
- {
- GNUNET_SCHEDULER_cancel (d->sched, d->task);
- d->phase = SP_START_DONE;
- }
- if (d->server != NULL)
- {
- GNUNET_CORE_disconnect (d->server);
- d->server = NULL;
- }
-
- if (d->th != NULL)
- {
- GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
- GNUNET_TRANSPORT_disconnect(d->th);
- d->th = NULL;
- }
- /* state clean up and notifications */
- GNUNET_free_non_null(d->hello);
-
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- _("Terminating peer `%4s'\n"), GNUNET_i2s (&d->id));
-#endif
+ char *sname;
- d->phase = SP_START_ARMING;
+ struct SharedServiceInstance **instances;
- /* Check if this is a local or remote process */
- if (NULL != d->hostname)
- {
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Stopping gnunet-arm with config `%s' on host `%s'.\n", d->cfgfile, d->hostname);
-#endif
-
- if (d->username != NULL)
- GNUNET_asprintf (&arg, "%s@%s", d->username, d->hostname);
- else
- arg = GNUNET_strdup (d->hostname);
-
- d->proc = GNUNET_OS_start_process (NULL, NULL, "ssh", "ssh",
-#if !DEBUG_TESTING
- "-q",
-#endif
- arg, "gnunet-arm",
-#if DEBUG_TESTING
- "-L", "DEBUG",
-#endif
- "-c", d->cfgfile, "-e", "-r", NULL);
- /* Use -r to restart arm and all services */
+ struct GNUNET_CONFIGURATION_Handle *cfg;
- GNUNET_free (arg);
- }
- else
- {
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Stopping gnunet-arm with config `%s' locally.\n", d->cfgfile);
-#endif
- d->proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-arm",
- "gnunet-arm",
-#if DEBUG_TESTING
- "-L", "DEBUG",
-#endif
- "-c", d->cfgfile, "-e", "-r", NULL);
- }
+ unsigned int n_peers;
- GNUNET_free_non_null(del_arg);
- d->task
- = GNUNET_SCHEDULER_add_delayed (d->sched,
- GNUNET_CONSTANTS_EXEC_WAIT,
- &start_fsm, d);
+ unsigned int share;
-}
+ unsigned int n_instances;
+};
/**
- * Stops a GNUnet daemon.
- *
- * @param d the daemon that should be stopped
- * @param timeout how long to wait for process for shutdown to complete
- * @param cb function called once the daemon was stopped
- * @param cb_cls closure for cb
- * @param delete_files GNUNET_YES to remove files, GNUNET_NO
- * to leave them
- * @param allow_restart GNUNET_YES to restart peer later (using this API)
- * GNUNET_NO to kill off and clean up for good
+ * Handle for a system on which GNUnet peers are executed;
+ * a system is used for reserving unique paths and ports.
*/
-void
-GNUNET_TESTING_daemon_stop (struct GNUNET_TESTING_Daemon *d,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_TESTING_NotifyCompletion cb, void *cb_cls,
- int delete_files,
- int allow_restart)
+struct GNUNET_TESTING_System
{
- char *arg;
- char *del_arg;
- d->dead_cb = cb;
- d->dead_cb_cls = cb_cls;
-
- if (NULL != d->cb)
- {
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- _("Setting d->dead on peer `%4s'\n"), GNUNET_i2s (&d->id));
-#endif
- d->dead = GNUNET_YES;
- return;
- }
+ /**
+ * Prefix (i.e. "/tmp/gnunet-testing/") we prepend to each
+ * GNUNET_HOME.
+ */
+ char *tmppath;
- if ((d->running == GNUNET_NO) && (d->churn == GNUNET_YES)) /* Peer has already been stopped in churn context! */
- {
- /* Free what was left from churning! */
- GNUNET_assert(d->cfg != NULL);
- GNUNET_CONFIGURATION_destroy (d->cfg);
- if (delete_files == GNUNET_YES)
- {
- if (0 != UNLINK(d->cfgfile))
- {
- GNUNET_log_strerror(GNUNET_ERROR_TYPE_WARNING, "unlink");
- }
- }
- GNUNET_free (d->cfgfile);
- GNUNET_free_non_null (d->hostname);
- GNUNET_free_non_null (d->username);
- if (NULL != d->dead_cb)
- d->dead_cb (d->dead_cb_cls, NULL);
- GNUNET_free(d);
- return;
- }
+ /**
+ * The trusted ip. Can either be a single ip address or a network address in
+ * CIDR notation.
+ */
+ char *trusted_ip;
- del_arg = NULL;
- if (delete_files == GNUNET_YES)
- {
- GNUNET_asprintf(&del_arg, "-d");
- }
+ /**
+ * our hostname
+ */
+ char *hostname;
- if (d->phase == SP_CONFIG_UPDATE)
- {
- GNUNET_SCHEDULER_cancel (d->sched, d->task);
- d->phase = SP_START_DONE;
- }
- if (d->server != NULL)
- {
- GNUNET_CORE_disconnect (d->server);
- d->server = NULL;
- }
- /* shutdown ARM process (will terminate others) */
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- _("Terminating peer `%4s'\n"), GNUNET_i2s (&d->id));
-#endif
- d->phase = SP_SHUTDOWN_START;
- d->running = GNUNET_NO;
- if (allow_restart == GNUNET_YES)
- d->churn = GNUNET_YES;
- if (d->th != NULL)
- {
- GNUNET_TRANSPORT_get_hello_cancel(d->th, &process_hello, d);
- GNUNET_TRANSPORT_disconnect(d->th);
- d->th = NULL;
- }
- /* Check if this is a local or remote process */
- if (NULL != d->hostname)
- {
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Stopping gnunet-arm with config `%s' on host `%s'.\n", d->cfgfile, d->hostname);
-#endif
+ /**
+ * Hostkeys data, contains "GNUNET_TESTING_HOSTKEYFILESIZE * total_hostkeys" bytes.
+ */
+ char *hostkeys_data;
- if (d->username != NULL)
- GNUNET_asprintf (&arg, "%s@%s", d->username, d->hostname);
- else
- arg = GNUNET_strdup (d->hostname);
+ /**
+ * memory map for 'hostkeys_data'.
+ */
+ struct GNUNET_DISK_MapHandle *map;
- d->proc = GNUNET_OS_start_process (NULL, NULL, "ssh", "ssh",
-#if !DEBUG_TESTING
- "-q",
-#endif
- arg, "gnunet-arm",
-#if DEBUG_TESTING
- "-L", "DEBUG",
-#endif
- "-c", d->cfgfile, "-e", "-q", del_arg, NULL);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Stopping gnunet-arm with command ssh %s gnunet-arm -c %s -e -q %s\n", arg, "gnunet-arm", d->cfgfile, del_arg);
- /* Use -e to end arm, and -d to remove temp files */
- GNUNET_free (arg);
- }
- else
- {
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Stopping gnunet-arm with config `%s' locally.\n", d->cfgfile);
-#endif
- d->proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-arm",
- "gnunet-arm",
-#if DEBUG_TESTING
- "-L", "DEBUG",
-#endif
- "-c", d->cfgfile, "-e", "-q", del_arg, NULL);
- }
+ struct SharedService **shared_services;
- GNUNET_free_non_null(del_arg);
- d->max_timeout = GNUNET_TIME_relative_to_absolute(timeout);
- d->task
- = GNUNET_SCHEDULER_add_now (d->sched,
- &start_fsm, d);
-}
+ unsigned int n_shared_services;
+ /**
+ * Bitmap where each port that has already been reserved for some GNUnet peer
+ * is recorded. Note that we make no distinction between TCP and UDP ports
+ * and test if a port is already in use before assigning it to a peer/service.
+ * If we detect that a port is already in use, we also mark it in this bitmap.
+ * So all the bits that are zero merely indicate ports that MIGHT be available
+ * for peers.
+ */
+ uint32_t reserved_ports[65536 / 32];
-/**
- * Changes the configuration of a GNUnet daemon.
- *
- * @param d the daemon that should be modified
- * @param cfg the new configuration for the daemon
- * @param cb function called once the configuration was changed
- * @param cb_cls closure for cb
- */
-void
-GNUNET_TESTING_daemon_reconfigure (struct GNUNET_TESTING_Daemon *d,
- struct GNUNET_CONFIGURATION_Handle *cfg,
- GNUNET_TESTING_NotifyCompletion cb,
- void *cb_cls)
-{
- char *arg;
+ /**
+ * Counter we use to make service home paths unique on this system;
+ * the full path consists of the tmppath and this number. Each
+ * UNIXPATH for a peer is also modified to include the respective
+ * path counter to ensure uniqueness. This field is incremented
+ * by one for each configured peer. Even if peers are destroyed,
+ * we never re-use path counters.
+ */
+ uint32_t path_counter;
- if (d->phase != SP_START_DONE)
- {
- if (NULL != cb)
- cb (cb_cls,
- _
- ("Peer not yet running, can not change configuration at this point."));
- return;
- }
+ /**
+ * The number of hostkeys
+ */
+ uint32_t total_hostkeys;
- /* 1) write configuration to temporary file */
- if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg, d->cfgfile))
- {
- if (NULL != cb)
- cb (cb_cls, _("Failed to write new configuration to disk."));
- return;
- }
+ /**
+ * Lowest port we are allowed to use.
+ */
+ uint16_t lowport;
- /* 2) copy file to remote host (if necessary) */
- if (NULL == d->hostname)
- {
- /* signal success */
- if (NULL != cb)
- cb (cb_cls, NULL);
- return;
- }
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Copying updated configuration file to remote host `%s'.\n",
- d->hostname);
-#endif
- d->phase = SP_CONFIG_UPDATE;
- if (NULL != d->username)
- GNUNET_asprintf (&arg, "%s@%s:%s", d->username, d->hostname, d->cfgfile);
- else
- GNUNET_asprintf (&arg, "%s:%s", d->hostname, d->cfgfile);
- d->proc = GNUNET_OS_start_process (NULL, NULL, "scp", "scp",
-#if !DEBUG_TESTING
- "-q",
-#endif
- d->cfgfile, arg, NULL);
- GNUNET_free (arg);
- if (NULL == d->proc)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _
- ("Could not start `%s' process to copy configuration file.\n"),
- "scp");
- if (NULL != cb)
- cb (cb_cls, _("Failed to copy new configuration to remote machine."));
- d->phase = SP_START_DONE;
- return;
- }
- d->update_cb = cb;
- d->update_cb_cls = cb_cls;
- d->task
- = GNUNET_SCHEDULER_add_delayed (d->sched,
- GNUNET_CONSTANTS_EXEC_WAIT,
- &start_fsm, d);
-}
+ /**
+ * Highest port we are allowed to use.
+ */
+ uint16_t highport;
+};
/**
- * Data kept for each pair of peers that we try
- * to connect.
+ * Handle for a GNUnet peer controlled by testing.
*/
-struct ConnectContext
+struct GNUNET_TESTING_Peer
{
/**
- * Testing handle to the first daemon.
+ * The TESTING system associated with this peer
*/
- struct GNUNET_TESTING_Daemon *d1;
+ struct GNUNET_TESTING_System *system;
/**
- * Handle to core of first daemon (to check connect)
+ * Path to the configuration file for this peer.
*/
- struct GNUNET_CORE_Handle * d1core;
+ char *cfgfile;
/**
- * Testing handle to the second daemon.
+ * Binary to be executed during 'GNUNET_TESTING_peer_start'.
+ * Typically 'gnunet-service-arm' (but can be set to a
+ * specific service by 'GNUNET_TESTING_service_run' if
+ * necessary).
*/
- struct GNUNET_TESTING_Daemon *d2;
+ char *main_binary;
+ char *args;
/**
- * Handler for the request to core to connect to this peer.
+ * Handle to the running binary of the service, NULL if the
+ * peer/service is currently not running.
*/
- struct GNUNET_CORE_PeerRequestHandle *connect_request_handle;
+ struct GNUNET_OS_Process *main_process;
/**
- * Transport handle to the second daemon.
+ * The handle to the peer's ARM service
*/
- struct GNUNET_TRANSPORT_Handle *d2th;
+ struct GNUNET_ARM_Handle *ah;
/**
- * Function to call once we are done (or have timed out).
+ * Handle to ARM monitoring
*/
- GNUNET_TESTING_NotifyConnection cb;
+ struct GNUNET_ARM_MonitorHandle *mh;
/**
- * Closure for "nb".
+ * The config of the peer
*/
- void *cb_cls;
-
- /**
- * When should this operation be complete (or we must trigger
- * a timeout).
- */
- struct GNUNET_TIME_Absolute timeout;
+ struct GNUNET_CONFIGURATION_Handle *cfg;
/**
- * The relative timeout from whence this connect attempt was
- * started. Allows for reconnect attempts.
+ * The callback to call asynchronously when a peer is stopped
*/
- struct GNUNET_TIME_Relative relative_timeout;
+ GNUNET_TESTING_PeerStopCallback cb;
/**
- * Maximum number of connect attempts, will retry connection
- * this number of times on failures.
+ * The closure for the above callback
*/
- unsigned int max_connect_attempts;
+ void *cb_cls;
/**
- * Hello timeout task
+ * The cached identity of this peer. Will be populated on call to
+ * GNUNET_TESTING_peer_get_identity()
*/
- GNUNET_SCHEDULER_TaskIdentifier hello_send_task;
+ struct GNUNET_PeerIdentity *id;
- /**
- * Connect timeout task
- */
- GNUNET_SCHEDULER_TaskIdentifier timeout_task;
+ struct SharedServiceInstance **ss_instances;
/**
- * When should this operation be complete (or we must trigger
- * a timeout).
+ * Array of ports currently allocated to this peer. These ports will be
+ * released upon peer destroy and can be used by other peers which are
+ * configured after.
*/
- struct GNUNET_TIME_Relative timeout_hello;
+ uint16_t *ports;
/**
- * Was the connection attempt successful?
+ * The number of ports in the above array
*/
- int connected;
+ unsigned int nports;
/**
- * The distance between the two connected peers
+ * The keynumber of this peer's hostkey
*/
- uint32_t distance;
+ uint32_t key_number;
};
-/** Forward declaration **/
-static void
-reattempt_daemons_connect(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+/**
+ * Testing includes a number of pre-created hostkeys for faster peer
+ * startup. This function loads such keys into memory from a file.
+ *
+ * @param system the testing system handle
+ * @return GNUNET_OK on success; GNUNET_SYSERR on error
+ */
+static int
+hostkeys_load (struct GNUNET_TESTING_System *system)
+{
+ uint64_t fs;
+ char *data_dir;
+ char *filename;
+ struct GNUNET_DISK_FileHandle *fd;
+
+ GNUNET_assert (NULL == system->hostkeys_data);
+ data_dir = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
+ GNUNET_asprintf (&filename, "%s/testing_hostkeys.ecc", data_dir);
+ GNUNET_free (data_dir);
+
+ if (GNUNET_YES != GNUNET_DISK_file_test (filename))
+ {
+ LOG (GNUNET_ERROR_TYPE_ERROR,
+ _("Hostkeys file not found: %s\n"), filename);
+ GNUNET_free (filename);
+ return GNUNET_SYSERR;
+ }
+ /* Check hostkey file size, read entire thing into memory */
+ if (GNUNET_OK !=
+ GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
+ fs = 0;
+ if (0 == fs)
+ {
+ GNUNET_free (filename);
+ return GNUNET_SYSERR; /* File is empty */
+ }
+ if (0 != (fs % GNUNET_TESTING_HOSTKEYFILESIZE))
+ {
+ LOG (GNUNET_ERROR_TYPE_ERROR,
+ _("Incorrect hostkey file format: %s\n"), filename);
+ GNUNET_free (filename);
+ return GNUNET_SYSERR;
+ }
+ fd = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READ,
+ GNUNET_DISK_PERM_NONE);
+ if (NULL == fd)
+ {
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", filename);
+ GNUNET_free (filename);
+ return GNUNET_SYSERR;
+ }
+ GNUNET_free (filename);
+ system->hostkeys_data = GNUNET_DISK_file_map (fd,
+ &system->map,
+ GNUNET_DISK_MAP_TYPE_READ,
+ fs);
+ GNUNET_DISK_file_close (fd);
+ if (NULL == system->hostkeys_data)
+ return GNUNET_SYSERR;
+ system->total_hostkeys = fs / GNUNET_TESTING_HOSTKEYFILESIZE;
+ return GNUNET_OK;
+}
/**
- * Notify callback about success or failure of the attempt
- * to connect the two peers
+ * Function to remove the loaded hostkeys
*
- * @param cls our "struct ConnectContext" (freed)
- * @param tc reason tells us if we succeeded or failed
+ * @param system the testing system handle
*/
static void
-notify_connect_result (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc)
+hostkeys_unload (struct GNUNET_TESTING_System *system)
{
- struct ConnectContext *ctx = cls;
- struct GNUNET_TIME_Relative remaining;
+ GNUNET_break (NULL != system->hostkeys_data);
+ system->hostkeys_data = NULL;
+ GNUNET_DISK_file_unmap (system->map);
+ system->map = NULL;
+ system->hostkeys_data = NULL;
+ system->total_hostkeys = 0;
+}
- ctx->timeout_task = GNUNET_SCHEDULER_NO_TASK;
- if (ctx->hello_send_task != GNUNET_SCHEDULER_NO_TASK)
- {
- GNUNET_SCHEDULER_cancel(ctx->d1->sched, ctx->hello_send_task);
- ctx->hello_send_task = GNUNET_SCHEDULER_NO_TASK;
- }
- if (ctx->connect_request_handle != NULL)
- {
- GNUNET_CORE_peer_request_connect_cancel (ctx->connect_request_handle);
- ctx->connect_request_handle = NULL;
- }
- if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
- {
- if (ctx->d2th != NULL)
- GNUNET_TRANSPORT_disconnect (ctx->d2th);
- ctx->d2th = NULL;
- if (ctx->d1core != NULL)
- GNUNET_CORE_disconnect (ctx->d1core);
-#if CONNECT_CORE2
- if (ctx->d2core != NULL)
- GNUNET_CORE_disconnect (ctx->d2core);
- ctx->d2core = NULL;
-#endif
- ctx->d1core = NULL;
+/**
+ * Function to iterate over options.
+ *
+ * @param cls closure
+ * @param section name of the section
+ * @param option name of the option
+ * @param value value of the option
+ */
+static void
+cfg_copy_iterator (void *cls, const char *section,
+ const char *option, const char *value)
+{
+ struct GNUNET_CONFIGURATION_Handle *cfg2 = cls;
- GNUNET_free (ctx);
- return;
+ GNUNET_CONFIGURATION_set_value_string (cfg2, section, option, value);
+}
+
+
+/**
+ * Create a system handle. There must only be one system
+ * handle per operating system.
+ *
+ * @param testdir only the directory name without any path. This is used for
+ * all service homes; the directory will be created in a temporary
+ * location depending on the underlying OS. This variable will be
+ * overridden with the value of the environmental variable
+ * GNUNET_TESTING_PREFIX, if it exists.
+ * @param trusted_ip the ip address which will be set as TRUSTED HOST in all
+ * service configurations generated to allow control connections from
+ * this ip. This can either be a single ip address or a network address
+ * in CIDR notation.
+ * @param hostname the hostname of the system we are using for testing; NULL for
+ * localhost
+ * @param shared_services NULL terminated array describing services that are to
+ * be shared among peers
+ * @param lowport lowest port number this system is allowed to allocate (inclusive)
+ * @param highport highest port number this system is allowed to allocate (exclusive)
+ * @return handle to this system, NULL on error
+ */
+struct GNUNET_TESTING_System *
+GNUNET_TESTING_system_create_with_portrange (const char *testdir,
+ const char *trusted_ip,
+ const char *hostname,
+ const struct
+ GNUNET_TESTING_SharedService *
+ shared_services,
+ uint16_t lowport,
+ uint16_t highport)
+{
+ struct GNUNET_TESTING_System *system;
+ struct GNUNET_TESTING_SharedService tss;
+ struct SharedService *ss;
+ unsigned int cnt;
+
+ GNUNET_assert (NULL != testdir);
+ system = GNUNET_new (struct GNUNET_TESTING_System);
+ if (NULL == (system->tmppath = getenv (GNUNET_TESTING_PREFIX)))
+ system->tmppath = GNUNET_DISK_mkdtemp (testdir);
+ else
+ system->tmppath = GNUNET_strdup (system->tmppath);
+ system->lowport = lowport;
+ system->highport = highport;
+ if (NULL == system->tmppath)
+ {
+ GNUNET_free (system);
+ return NULL;
+ }
+ if (NULL != trusted_ip)
+ system->trusted_ip = GNUNET_strdup (trusted_ip);
+ if (NULL != hostname)
+ system->hostname = GNUNET_strdup (hostname);
+ if (GNUNET_OK != hostkeys_load (system))
+ {
+ GNUNET_TESTING_system_destroy (system, GNUNET_YES);
+ return NULL;
+ }
+ if (NULL == shared_services)
+ return system;
+ for (cnt = 0; NULL != shared_services[cnt].service; cnt++)
+ {
+ tss = shared_services[cnt];
+ ss = GNUNET_new (struct SharedService);
+ ss->sname = GNUNET_strdup (tss.service);
+ ss->cfg = GNUNET_CONFIGURATION_create ();
+ GNUNET_CONFIGURATION_iterate_section_values (tss.cfg, ss->sname,
+ &cfg_copy_iterator, ss->cfg);
+ GNUNET_CONFIGURATION_iterate_section_values (tss.cfg, "TESTING",
+ &cfg_copy_iterator, ss->cfg);
+ GNUNET_CONFIGURATION_iterate_section_values (tss.cfg, "PATHS",
+ &cfg_copy_iterator, ss->cfg);
+ ss->share = tss.share;
+ GNUNET_array_append (system->shared_services, system->n_shared_services,
+ ss);
+ }
+ return system;
+}
+
+
+/**
+ * Create a system handle. There must only be one system handle per operating
+ * system. Uses a default range for allowed ports. Ports are still tested for
+ * availability.
+ *
+ * @param testdir only the directory name without any path. This is used for all
+ * service homes; the directory will be created in a temporary location
+ * depending on the underlying OS. This variable will be
+ * overridden with the value of the environmental variable
+ * GNUNET_TESTING_PREFIX, if it exists.
+ * @param trusted_ip the ip address which will be set as TRUSTED HOST in all
+ * service configurations generated to allow control connections from
+ * this ip. This can either be a single ip address or a network address
+ * in CIDR notation.
+ * @param hostname the hostname of the system we are using for testing; NULL for
+ * localhost
+ * @param shared_services NULL terminated array describing services that are to
+ * be shared among peers
+ * @return handle to this system, NULL on error
+ */
+struct GNUNET_TESTING_System *
+GNUNET_TESTING_system_create (const char *testdir,
+ const char *trusted_ip,
+ const char *hostname,
+ const struct GNUNET_TESTING_SharedService *
+ shared_services)
+{
+ return GNUNET_TESTING_system_create_with_portrange (testdir,
+ trusted_ip,
+ hostname,
+ shared_services,
+ LOW_PORT,
+ HIGH_PORT);
+}
+
+static void
+cleanup_shared_service_instance (struct SharedServiceInstance *i)
+{
+ if (NULL != i->cfg_fn)
+ {
+ (void) unlink (i->cfg_fn);
+ GNUNET_free (i->cfg_fn);
+ }
+ GNUNET_free_non_null (i->unix_sock);
+ GNUNET_free_non_null (i->port_str);
+ GNUNET_break (NULL == i->proc);
+ GNUNET_break (0 == i->n_refs);
+ GNUNET_free (i);
+}
+
+static int
+start_shared_service_instance (struct SharedServiceInstance *i)
+{
+ char *binary;
+ char *libexec_binary;
+
+ GNUNET_assert (NULL == i->proc);
+ GNUNET_assert (NULL != i->cfg_fn);
+ (void) GNUNET_asprintf (&binary, "gnunet-service-%s", i->ss->sname);
+ libexec_binary = GNUNET_OS_get_libexec_binary_path (binary);
+ GNUNET_free (binary);
+ i->proc = GNUNET_OS_start_process (PIPE_CONTROL,
+ GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
+ NULL, NULL, NULL,
+ libexec_binary,
+ libexec_binary,
+ "-c",
+ i->cfg_fn,
+ NULL);
+ GNUNET_free (libexec_binary);
+ if (NULL == i->proc)
+ return GNUNET_SYSERR;
+ return GNUNET_OK;
+}
+
+
+static void
+stop_shared_service_instance (struct SharedServiceInstance *i)
+{
+ GNUNET_break (0 == i->n_refs);
+ if (0 != GNUNET_OS_process_kill (i->proc, GNUNET_TERM_SIG))
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ "Killing shared service instance (%s) failed\n", i->ss->sname);
+ (void) GNUNET_OS_process_wait (i->proc);
+ GNUNET_OS_process_destroy (i->proc);
+ i->proc = NULL;
+}
+
+
+/**
+ * Free system resources.
+ *
+ * @param system system to be freed
+ * @param remove_paths should the 'testdir' and all subdirectories
+ * be removed (clean up on shutdown)?
+ */
+void
+GNUNET_TESTING_system_destroy (struct GNUNET_TESTING_System *system,
+ int remove_paths)
+{
+ struct SharedService *ss;
+ struct SharedServiceInstance *i;
+ unsigned int ss_cnt;
+ unsigned int i_cnt;
+
+ if (NULL != system->hostkeys_data)
+ hostkeys_unload (system);
+ for (ss_cnt = 0; ss_cnt < system->n_shared_services; ss_cnt++)
+ {
+ ss = system->shared_services[ss_cnt];
+ for (i_cnt = 0; i_cnt < ss->n_instances; i_cnt++)
+ {
+ i = ss->instances[i_cnt];
+ if (NULL != i->proc)
+ stop_shared_service_instance (i);
+ cleanup_shared_service_instance (i);
+ }
+ GNUNET_free_non_null (ss->instances);
+ GNUNET_CONFIGURATION_destroy (ss->cfg);
+ GNUNET_free (ss->sname);
+ GNUNET_free (ss);
+ }
+ GNUNET_free_non_null (system->shared_services);
+ if (GNUNET_YES == remove_paths)
+ GNUNET_DISK_directory_remove (system->tmppath);
+ GNUNET_free (system->tmppath);
+ GNUNET_free_non_null (system->trusted_ip);
+ GNUNET_free_non_null (system->hostname);
+ GNUNET_free (system);
+}
+
+
+/**
+ * Reserve a TCP or UDP port for a peer.
+ *
+ * @param system system to use for reservation tracking
+ * @return 0 if no free port was available
+ */
+uint16_t
+GNUNET_TESTING_reserve_port (struct GNUNET_TESTING_System *system)
+{
+ struct GNUNET_NETWORK_Handle *socket;
+ struct addrinfo hint;
+ struct addrinfo *ret;
+ struct addrinfo *ai;
+ uint32_t *port_buckets;
+ char *open_port_str;
+ int bind_status;
+ uint32_t xor_image;
+ uint16_t index;
+ uint16_t open_port;
+ uint16_t pos;
+
+ /*
+ FIXME: Instead of using getaddrinfo we should try to determine the port
+ status by the following heurestics.
+
+ On systems which support both IPv4 and IPv6, only ports open on both
+ address families are considered open.
+ On system with either IPv4 or IPv6. A port is considered open if it's
+ open in the respective address family
+ */
+ hint.ai_family = AF_UNSPEC; /* IPv4 and IPv6 */
+ hint.ai_socktype = 0;
+ hint.ai_protocol = 0;
+ hint.ai_addrlen = 0;
+ hint.ai_addr = NULL;
+ hint.ai_canonname = NULL;
+ hint.ai_next = NULL;
+ hint.ai_flags = AI_PASSIVE | AI_NUMERICSERV; /* Wild card address */
+ port_buckets = system->reserved_ports;
+ for (index = (system->lowport / 32) + 1; index < (system->highport / 32); index++)
+ {
+ xor_image = (UINT32_MAX ^ port_buckets[index]);
+ if (0 == xor_image) /* Ports in the bucket are full */
+ continue;
+ pos = system->lowport % 32;
+ while (pos < 32)
+ {
+ if (0 == ((xor_image >> pos) & 1U))
+ {
+ pos++;
+ continue;
+ }
+ open_port = (index * 32) + pos;
+ if (open_port >= system->highport)
+ return 0;
+ GNUNET_asprintf (&open_port_str, "%u", (unsigned int) open_port);
+ ret = NULL;
+ GNUNET_assert (0 == getaddrinfo (NULL, open_port_str, &hint, &ret));
+ GNUNET_free (open_port_str);
+ bind_status = GNUNET_NO;
+ for (ai = ret; NULL != ai; ai = ai->ai_next)
+ {
+ socket = GNUNET_NETWORK_socket_create (ai->ai_family, SOCK_STREAM, 0);
+ if (NULL == socket)
+ continue;
+ bind_status = GNUNET_NETWORK_socket_bind (socket,
+ ai->ai_addr,
+ ai->ai_addrlen);
+ GNUNET_NETWORK_socket_close (socket);
+ if (GNUNET_OK != bind_status)
+ break;
+ socket = GNUNET_NETWORK_socket_create (ai->ai_family, SOCK_DGRAM, 0);
+ if (NULL == socket)
+ continue;
+ bind_status = GNUNET_NETWORK_socket_bind (socket,
+ ai->ai_addr,
+ ai->ai_addrlen);
+ GNUNET_NETWORK_socket_close (socket);
+ if (GNUNET_OK != bind_status)
+ break;
+ }
+ port_buckets[index] |= (1U << pos); /* Set the port bit */
+ freeaddrinfo (ret);
+ if (GNUNET_OK == bind_status)
+ {
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Found a free port %u\n", (unsigned int) open_port);
+ return open_port;
+ }
+ pos++;
}
+ }
+ return 0;
+}
+
+
+/**
+ * Release reservation of a TCP or UDP port for a peer
+ * (used during GNUNET_TESTING_peer_destroy).
+ *
+ * @param system system to use for reservation tracking
+ * @param port reserved port to release
+ */
+void
+GNUNET_TESTING_release_port (struct GNUNET_TESTING_System *system,
+ uint16_t port)
+{
+ uint32_t *port_buckets;
+ uint16_t bucket;
+ uint16_t pos;
+
+ port_buckets = system->reserved_ports;
+ bucket = port / 32;
+ pos = port % 32;
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Releasing port %u\n", port);
+ if (0 == (port_buckets[bucket] & (1U << pos)))
+ {
+ GNUNET_break(0); /* Port was not reserved by us using reserve_port() */
+ return;
+ }
+ port_buckets[bucket] &= ~(1U << pos);
+}
+
+
+/**
+ * Testing includes a number of pre-created hostkeys for
+ * faster peer startup. This function can be used to
+ * access the n-th key of those pre-created hostkeys; note
+ * that these keys are ONLY useful for testing and not
+ * secure as the private keys are part of the public
+ * GNUnet source code.
+ *
+ * This is primarily a helper function used internally
+ * by #GNUNET_TESTING_peer_configure.
+ *
+ * @param system the testing system handle
+ * @param key_number desired pre-created hostkey to obtain
+ * @param id set to the peer's identity (hash of the public
+ * key; if NULL, GNUNET_SYSERR is returned immediately
+ * @return NULL on error (not enough keys)
+ */
+struct GNUNET_CRYPTO_EddsaPrivateKey *
+GNUNET_TESTING_hostkey_get (const struct GNUNET_TESTING_System *system,
+ uint32_t key_number,
+ struct GNUNET_PeerIdentity *id)
+{
+ struct GNUNET_CRYPTO_EddsaPrivateKey *private_key;
+
+ if ((NULL == id) || (NULL == system->hostkeys_data))
+ return NULL;
+ if (key_number >= system->total_hostkeys)
+ {
+ LOG (GNUNET_ERROR_TYPE_ERROR,
+ _("Key number %u does not exist\n"), key_number);
+ return NULL;
+ }
+ private_key = GNUNET_new (struct GNUNET_CRYPTO_EddsaPrivateKey);
+ memcpy (private_key,
+ system->hostkeys_data +
+ (key_number * GNUNET_TESTING_HOSTKEYFILESIZE),
+ GNUNET_TESTING_HOSTKEYFILESIZE);
+ GNUNET_CRYPTO_eddsa_key_get_public (private_key,
+ &id->public_key);
+ return private_key;
+}
+
+
+/**
+ * Structure for holding data to build new configurations from a configuration
+ * template
+ */
+struct UpdateContext
+{
+ /**
+ * The system for which we are building configurations
+ */
+ struct GNUNET_TESTING_System *system;
+
+ /**
+ * The configuration we are building
+ */
+ struct GNUNET_CONFIGURATION_Handle *cfg;
+
+ /**
+ * The customized service home path for this peer
+ */
+ char *gnunet_home;
+
+ /**
+ * Array of ports currently allocated to this peer. These ports will be
+ * released upon peer destroy and can be used by other peers which are
+ * configured after.
+ */
+ uint16_t *ports;
+
+ /**
+ * The number of ports in the above array
+ */
+ unsigned int nports;
+
+ /**
+ * build status - to signal error while building a configuration
+ */
+ int status;
+};
- remaining = GNUNET_TIME_absolute_get_remaining(ctx->timeout);
- if (ctx->connected == GNUNET_YES)
+/**
+ * Function to iterate over options. Copies
+ * the options to the target configuration,
+ * updating PORT values as needed.
+ *
+ * @param cls the UpdateContext
+ * @param section name of the section
+ * @param option name of the option
+ * @param value value of the option
+ */
+static void
+update_config (void *cls, const char *section, const char *option,
+ const char *value)
+{
+ struct UpdateContext *uc = cls;
+ unsigned int ival;
+ char cval[12];
+ char uval[128];
+ char *single_variable;
+ char *per_host_variable;
+ unsigned long long num_per_host;
+ uint16_t new_port;
+
+ if (GNUNET_OK != uc->status)
+ return;
+ if (! ((0 == strcmp (option, "PORT"))
+ || (0 == strcmp (option, "UNIXPATH"))
+ || (0 == strcmp (option, "HOSTNAME"))))
+ return;
+ GNUNET_asprintf (&single_variable, "single_%s_per_host", section);
+ GNUNET_asprintf (&per_host_variable, "num_%s_per_host", section);
+ if ((0 == strcmp (option, "PORT")) && (1 == SSCANF (value, "%u", &ival)))
+ {
+ if ((ival != 0) &&
+ (GNUNET_YES !=
+ GNUNET_CONFIGURATION_get_value_yesno (uc->cfg, "testing",
+ single_variable)))
{
- if (ctx->cb != NULL)
- {
- ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, ctx->distance, ctx->d1->cfg,
- ctx->d2->cfg, ctx->d1, ctx->d2, NULL);
- }
+ new_port = GNUNET_TESTING_reserve_port (uc->system);
+ if (0 == new_port)
+ {
+ uc->status = GNUNET_SYSERR;
+ GNUNET_free (single_variable);
+ GNUNET_free (per_host_variable);
+ return;
+ }
+ GNUNET_snprintf (cval, sizeof (cval), "%u", new_port);
+ value = cval;
+ GNUNET_array_append (uc->ports, uc->nports, new_port);
}
- else if (remaining.rel_value > 0)
+ else if ((ival != 0) &&
+ (GNUNET_YES ==
+ GNUNET_CONFIGURATION_get_value_yesno (uc->cfg, "testing",
+ single_variable)) &&
+ GNUNET_CONFIGURATION_get_value_number (uc->cfg, "testing",
+ per_host_variable,
+ &num_per_host))
{
- if (ctx->d1core != NULL)
- {
- GNUNET_CORE_disconnect(ctx->d1core);
- ctx->d1core = NULL;
- }
-#if CONNECT_CORE2
- if (ctx->d2core != NULL)
- {
- GNUNET_CORE_disconnect(ctx->d2core);
- ctx->d2core = NULL;
- }
-#endif
+ /* GNUNET_snprintf (cval, sizeof (cval), "%u", */
+ /* ival + ctx->fdnum % num_per_host); */
+ /* value = cval; */
+ GNUNET_break (0); /* FIXME */
+ }
+ }
+ if (0 == strcmp (option, "UNIXPATH"))
+ {
+ if (GNUNET_YES !=
+ GNUNET_CONFIGURATION_get_value_yesno (uc->cfg, "testing",
+ single_variable))
+ {
+ GNUNET_snprintf (uval, sizeof (uval), "%s/%s.sock",
+ uc->gnunet_home, section);
+ value = uval;
+ }
+ else if ((GNUNET_YES ==
+ GNUNET_CONFIGURATION_get_value_number (uc->cfg, "testing",
+ per_host_variable,
+ &num_per_host)) &&
+ (num_per_host > 0))
+ {
+ GNUNET_break(0); /* FIXME */
+ }
+ }
+ if (0 == strcmp (option, "HOSTNAME"))
+ {
+ value = (NULL == uc->system->hostname) ? "localhost" : uc->system->hostname;
+ }
+ GNUNET_free (single_variable);
+ GNUNET_free (per_host_variable);
+ GNUNET_CONFIGURATION_set_value_string (uc->cfg, section, option, value);
+}
+
- if (ctx->d2th != NULL)
- {
- GNUNET_TRANSPORT_disconnect(ctx->d2th);
- ctx->d2th = NULL;
- }
- GNUNET_SCHEDULER_add_now(ctx->d1->sched, &reattempt_daemons_connect, ctx);
- return;
+/**
+ * Section iterator to set ACCEPT_FROM/ACCEPT_FROM6 to include the address of
+ * 'trusted_hosts' in all sections
+ *
+ * @param cls the UpdateContext
+ * @param section name of the section
+ */
+static void
+update_config_sections (void *cls,
+ const char *section)
+{
+ struct UpdateContext *uc = cls;
+ char **ikeys;
+ char *val;
+ char *ptr;
+ char *orig_allowed_hosts;
+ char *allowed_hosts;
+ char *ACCEPT_FROM_key;
+ uint16_t ikeys_cnt;
+ uint16_t key;
+
+ ikeys_cnt = 0;
+ val = NULL;
+ /* Ignore certain options from sections. See
+ https://gnunet.org/bugs/view.php?id=2476 */
+ if (GNUNET_YES == GNUNET_CONFIGURATION_have_value (uc->cfg, section,
+ "TESTING_IGNORE_KEYS"))
+ {
+ GNUNET_assert
+ (GNUNET_YES ==
+ GNUNET_CONFIGURATION_get_value_string (uc->cfg, section,
+ "TESTING_IGNORE_KEYS", &val));
+ ptr = val;
+ for (ikeys_cnt = 0; NULL != (ptr = strstr (ptr, ";")); ikeys_cnt++)
+ ptr++;
+ if (0 == ikeys_cnt)
+ GNUNET_break (0);
+ else
+ {
+ ikeys = GNUNET_malloc ((sizeof (char *)) * ikeys_cnt);
+ ptr = val;
+ for (key = 0; key < ikeys_cnt; key++)
+ {
+ ikeys[key] = ptr;
+ ptr = strstr (ptr, ";");
+ *ptr = '\0';
+ ptr++;
+ }
+ }
+ }
+ if (0 != ikeys_cnt)
+ {
+ for (key = 0; key < ikeys_cnt; key++)
+ {
+ if (NULL != strstr (ikeys[key], "ADVERTISED_PORT"))
+ break;
+ }
+ if ((key == ikeys_cnt) &&
+ (GNUNET_YES == GNUNET_CONFIGURATION_have_value (uc->cfg, section,
+ "ADVERTISED_PORT")))
+ {
+ if (GNUNET_OK ==
+ GNUNET_CONFIGURATION_get_value_string (uc->cfg, section, "PORT", &ptr))
+ {
+ GNUNET_CONFIGURATION_set_value_string (uc->cfg, section,
+ "ADVERTISED_PORT", ptr);
+ GNUNET_free (ptr);
+ }
}
+ for (key = 0; key < ikeys_cnt; key++)
+ {
+ if (NULL != strstr (ikeys[key], "ACCEPT_FROM"))
+ {
+ GNUNET_free (ikeys);
+ GNUNET_free (val);
+ return;
+ }
+ }
+ GNUNET_free (ikeys);
+ }
+ GNUNET_free_non_null (val);
+ ACCEPT_FROM_key = "ACCEPT_FROM";
+ if ((NULL != uc->system->trusted_ip) &&
+ (NULL != strstr (uc->system->trusted_ip, ":"))) /* IPv6 in use */
+ ACCEPT_FROM_key = "ACCEPT_FROM6";
+ if (GNUNET_OK !=
+ GNUNET_CONFIGURATION_get_value_string (uc->cfg, section, ACCEPT_FROM_key,
+ &orig_allowed_hosts))
+ {
+ orig_allowed_hosts = GNUNET_strdup ("127.0.0.1;");
+ }
+ if (NULL == uc->system->trusted_ip)
+ allowed_hosts = GNUNET_strdup (orig_allowed_hosts);
else
+ GNUNET_asprintf (&allowed_hosts, "%s%s;", orig_allowed_hosts,
+ uc->system->trusted_ip);
+ GNUNET_free (orig_allowed_hosts);
+ GNUNET_CONFIGURATION_set_value_string (uc->cfg, section, ACCEPT_FROM_key,
+ allowed_hosts);
+ GNUNET_free (allowed_hosts);
+}
+
+static struct SharedServiceInstance *
+associate_shared_service (struct GNUNET_TESTING_System *system,
+ struct SharedService *ss,
+ struct GNUNET_CONFIGURATION_Handle *cfg)
+{
+ struct SharedServiceInstance *i;
+ struct GNUNET_CONFIGURATION_Handle *temp;
+ char *gnunet_home;
+ uint32_t port;
+
+ ss->n_peers++;
+ if ( ((0 == ss->share) && (NULL == ss->instances))
+ ||
+ ( (0 != ss->share)
+ && (ss->n_instances < ((ss->n_peers + ss->share - 1) / ss->share)) ) )
+ {
+ i = GNUNET_new (struct SharedServiceInstance);
+ i->ss = ss;
+ (void) GNUNET_asprintf (&gnunet_home, "%s/shared/%s/%u",
+ system->tmppath, ss->sname, ss->n_instances);
+ (void) GNUNET_asprintf (&i->unix_sock, "%s/sock", gnunet_home);
+ port = GNUNET_TESTING_reserve_port (system);
+ if (0 == port)
+ {
+ GNUNET_free (gnunet_home);
+ cleanup_shared_service_instance (i);
+ return NULL;
+ }
+ GNUNET_array_append (ss->instances, ss->n_instances, i);
+ temp = GNUNET_CONFIGURATION_dup (ss->cfg);
+ (void) GNUNET_asprintf (&i->port_str, "%u", port);
+ (void) GNUNET_asprintf (&i->cfg_fn, "%s/config", gnunet_home);
+ GNUNET_CONFIGURATION_set_value_string (temp, "PATHS", "GNUNET_HOME",
+ gnunet_home);
+ GNUNET_free (gnunet_home);
+ GNUNET_CONFIGURATION_set_value_string (temp, ss->sname, "UNIXPATH",
+ i->unix_sock);
+ GNUNET_CONFIGURATION_set_value_string (temp, ss->sname, "PORT",
+ i->port_str);
+ if (GNUNET_SYSERR == GNUNET_CONFIGURATION_write (temp, i->cfg_fn))
{
- if (ctx->cb != NULL)
- {
- ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, 0, ctx->d1->cfg,
- ctx->d2->cfg, ctx->d1, ctx->d2,
- _("Peers failed to connect"));
- }
+ GNUNET_CONFIGURATION_destroy (temp);
+ cleanup_shared_service_instance (i);
+ return NULL;
}
+ GNUNET_CONFIGURATION_destroy (temp);
+ }
+ else
+ {
+ GNUNET_assert (NULL != ss->instances);
+ GNUNET_assert (0 < ss->n_instances);
+ i = ss->instances[ss->n_instances - 1];
+ }
+ GNUNET_CONFIGURATION_iterate_section_values(ss->cfg, ss->sname,
+ &cfg_copy_iterator, cfg);
+ GNUNET_CONFIGURATION_set_value_string (cfg, ss->sname, "UNIXPATH",
+ i->unix_sock);
+ GNUNET_CONFIGURATION_set_value_string (cfg, ss->sname, "PORT", i->port_str);
+ return i;
+}
- GNUNET_TRANSPORT_disconnect (ctx->d2th);
- ctx->d2th = NULL;
- GNUNET_CORE_disconnect (ctx->d1core);
- ctx->d1core = NULL;
- GNUNET_free (ctx);
+
+/**
+ * Create a new configuration using the given configuration as a template;
+ * ports and paths will be modified to select available ports on the local
+ * system. The default configuration will be available in PATHS section under
+ * the option DEFAULTCONFIG after the call. GNUNET_HOME is also set in PATHS
+ * section to the temporary directory specific to this configuration. If we run
+ * out of "*port" numbers, return #GNUNET_SYSERR.
+ *
+ * This is primarily a helper function used internally
+ * by 'GNUNET_TESTING_peer_configure'.
+ *
+ * @param system system to use to coordinate resource usage
+ * @param cfg template configuration to update
+ * @param ports array with port numbers used in the created configuration.
+ * Will be updated upon successful return. Can be NULL
+ * @param nports the size of the `ports' array. Will be updated.
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error - the configuration will
+ * be incomplete and should not be used there upon
+ */
+static int
+GNUNET_TESTING_configuration_create_ (struct GNUNET_TESTING_System *system,
+ struct GNUNET_CONFIGURATION_Handle *cfg,
+ uint16_t **ports,
+ unsigned int *nports)
+{
+ struct UpdateContext uc;
+ char *default_config;
+
+ uc.system = system;
+ uc.cfg = cfg;
+ uc.status = GNUNET_OK;
+ uc.ports = NULL;
+ uc.nports = 0;
+ GNUNET_asprintf (&uc.gnunet_home, "%s/%u", system->tmppath,
+ system->path_counter++);
+ GNUNET_asprintf (&default_config, "%s/config", uc.gnunet_home);
+ GNUNET_CONFIGURATION_set_value_string (cfg, "PATHS", "DEFAULTCONFIG",
+ default_config);
+ GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG",
+ default_config);
+ GNUNET_free (default_config);
+ GNUNET_CONFIGURATION_set_value_string (cfg, "PATHS", "GNUNET_HOME",
+ uc.gnunet_home);
+ /* make PORTs and UNIXPATHs unique */
+ GNUNET_CONFIGURATION_iterate (cfg, &update_config, &uc);
+ /* allow connections to services from system trusted_ip host */
+ GNUNET_CONFIGURATION_iterate_sections (cfg, &update_config_sections, &uc);
+ /* enable loopback-based connections between peers */
+ GNUNET_CONFIGURATION_set_value_string (cfg,
+ "nat",
+ "USE_LOCALADDR", "YES");
+ GNUNET_free (uc.gnunet_home);
+ if ((NULL != ports) && (NULL != nports))
+ {
+ *ports = uc.ports;
+ *nports = uc.nports;
+ }
+ else
+ GNUNET_free_non_null (uc.ports);
+ return uc.status;
}
/**
- * Success, connection is up. Signal client our success.
+ * Create a new configuration using the given configuration as a template;
+ * ports and paths will be modified to select available ports on the local
+ * system. The default configuration will be available in PATHS section under
+ * the option DEFAULTCONFIG after the call. GNUNET_HOME is also set in PATHS
+ * section to the temporary directory specific to this configuration. If we run
+ * out of "*port" numbers, return SYSERR.
*
- * @param cls our "struct ConnectContext"
- * @param peer identity of the peer that has connected
- * @param latency the round trip latency of the connection to this peer
- * @param distance distance the transport level distance to this peer
+ * This is primarily a helper function used internally
+ * by 'GNUNET_TESTING_peer_configure'.
*
+ * @param system system to use to coordinate resource usage
+ * @param cfg template configuration to update
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error - the configuration will
+ * be incomplete and should not be used there upon
*/
-static void
-connect_notify (void *cls, const struct GNUNET_PeerIdentity * peer, struct GNUNET_TIME_Relative latency,
- uint32_t distance)
+int
+GNUNET_TESTING_configuration_create (struct GNUNET_TESTING_System *system,
+ struct GNUNET_CONFIGURATION_Handle *cfg)
{
- struct ConnectContext *ctx = cls;
+ return GNUNET_TESTING_configuration_create_ (system, cfg, NULL, NULL);
+}
- if (memcmp(&ctx->d2->id, peer, sizeof(struct GNUNET_PeerIdentity)) == 0)
+
+/**
+ * Configure a GNUnet peer. GNUnet must be installed on the local
+ * system and available in the PATH.
+ *
+ * @param system system to use to coordinate resource usage
+ * @param cfg configuration to use; will be UPDATED (to reflect needed
+ * changes in port numbers and paths)
+ * @param key_number number of the hostkey to use for the peer
+ * @param id identifier for the daemon, will be set, can be NULL
+ * @param emsg set to freshly allocated error message (set to NULL on success),
+ * can be NULL
+ * @return handle to the peer, NULL on error
+ */
+struct GNUNET_TESTING_Peer *
+GNUNET_TESTING_peer_configure (struct GNUNET_TESTING_System *system,
+ struct GNUNET_CONFIGURATION_Handle *cfg,
+ uint32_t key_number,
+ struct GNUNET_PeerIdentity *id,
+ char **emsg)
+{
+ struct GNUNET_TESTING_Peer *peer;
+ struct GNUNET_DISK_FileHandle *fd;
+ char *hostkey_filename;
+ char *config_filename;
+ char *libexec_binary;
+ char *emsg_;
+ struct GNUNET_CRYPTO_EddsaPrivateKey *pk;
+ uint16_t *ports;
+ struct SharedService *ss;
+ struct SharedServiceInstance **ss_instances;
+ unsigned int cnt;
+ unsigned int nports;
+
+ ports = NULL;
+ nports = 0;
+ ss_instances = NULL;
+ if (NULL != emsg)
+ *emsg = NULL;
+ if (key_number >= system->total_hostkeys)
+ {
+ GNUNET_asprintf (&emsg_,
+ _("You attempted to create a testbed with more than %u hosts. Please precompute more hostkeys first.\n"),
+ (unsigned int) system->total_hostkeys);
+ goto err_ret;
+ }
+ pk = NULL;
+ if ((NULL != id) &&
+ (NULL == (pk = GNUNET_TESTING_hostkey_get (system, key_number, id))))
+ {
+ GNUNET_asprintf (&emsg_,
+ _("Failed to initialize hostkey for peer %u\n"),
+ (unsigned int) key_number);
+ goto err_ret;
+ }
+ if (NULL != pk)
+ GNUNET_free (pk);
+ if (GNUNET_NO ==
+ GNUNET_CONFIGURATION_have_value (cfg, "PEER", "PRIVATE_KEY"))
+ {
+ GNUNET_asprintf (&emsg_,
+ _("PRIVATE_KEY option in PEER section missing in configuration\n"));
+ goto err_ret;
+ }
+ /* Remove sections for shared services */
+ for (cnt = 0; cnt < system->n_shared_services; cnt++)
+ {
+ ss = system->shared_services[cnt];
+ GNUNET_CONFIGURATION_remove_section (cfg, ss->sname);
+ }
+ if (GNUNET_OK != GNUNET_TESTING_configuration_create_ (system, cfg,
+ &ports, &nports))
+ {
+ GNUNET_asprintf (&emsg_,
+ _("Failed to create configuration for peer "
+ "(not enough free ports?)\n"));
+ goto err_ret;
+ }
+ GNUNET_assert (GNUNET_OK ==
+ GNUNET_CONFIGURATION_get_value_filename (cfg, "PEER",
+ "PRIVATE_KEY",
+ &hostkey_filename));
+ fd = GNUNET_DISK_file_open (hostkey_filename,
+ GNUNET_DISK_OPEN_CREATE | GNUNET_DISK_OPEN_WRITE,
+ GNUNET_DISK_PERM_USER_READ
+ | GNUNET_DISK_PERM_USER_WRITE);
+ if (NULL == fd)
+ {
+ GNUNET_asprintf (&emsg_, _("Cannot open hostkey file `%s': %s\n"),
+ hostkey_filename, STRERROR (errno));
+ GNUNET_free (hostkey_filename);
+ goto err_ret;
+ }
+ GNUNET_free (hostkey_filename);
+ if (GNUNET_TESTING_HOSTKEYFILESIZE !=
+ GNUNET_DISK_file_write (fd, system->hostkeys_data
+ + (key_number * GNUNET_TESTING_HOSTKEYFILESIZE),
+ GNUNET_TESTING_HOSTKEYFILESIZE))
+ {
+ GNUNET_asprintf (&emsg_,
+ _("Failed to write hostkey file for peer %u: %s\n"),
+ (unsigned int) key_number,
+ STRERROR (errno));
+ GNUNET_DISK_file_close (fd);
+ goto err_ret;
+ }
+ GNUNET_DISK_file_close (fd);
+ ss_instances = GNUNET_malloc (sizeof (struct SharedServiceInstance *)
+ * system->n_shared_services);
+ for (cnt=0; cnt < system->n_shared_services; cnt++)
+ {
+ ss = system->shared_services[cnt];
+ ss_instances[cnt] = associate_shared_service (system, ss, cfg);
+ if (NULL == ss_instances[cnt])
{
- ctx->connected = GNUNET_YES;
- ctx->distance = distance;
- GNUNET_SCHEDULER_cancel(ctx->d1->sched, ctx->timeout_task);
- ctx->timeout_task = GNUNET_SCHEDULER_add_now (ctx->d1->sched,
- ¬ify_connect_result,
- ctx);
+ emsg_ = GNUNET_strdup ("FIXME");
+ goto err_ret;
}
+ }
+ GNUNET_assert (GNUNET_OK ==
+ GNUNET_CONFIGURATION_get_value_filename
+ (cfg, "PATHS", "DEFAULTCONFIG", &config_filename));
+ if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg, config_filename))
+ {
+ GNUNET_asprintf (&emsg_,
+ _("Failed to write configuration file `%s' for peer %u: %s\n"),
+ config_filename,
+ (unsigned int) key_number,
+ STRERROR (errno));
+ GNUNET_free (config_filename);
+ goto err_ret;
+ }
+ peer = GNUNET_new (struct GNUNET_TESTING_Peer);
+ peer->ss_instances = ss_instances;
+ peer->cfgfile = config_filename; /* Free in peer_destroy */
+ peer->cfg = GNUNET_CONFIGURATION_dup (cfg);
+ libexec_binary = GNUNET_OS_get_libexec_binary_path ("gnunet-service-arm");
+ if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string(cfg, "arm", "PREFIX", &peer->main_binary))
+ {
+ /* No prefix */
+ GNUNET_asprintf(&peer->main_binary, "%s", libexec_binary);
+ peer->args = strdup ("");
+ }
+ else
+ {
+ peer->args = strdup (libexec_binary);
+ }
+ peer->system = system;
+ peer->key_number = key_number;
+ GNUNET_free (libexec_binary);
+ peer->ports = ports; /* Free in peer_destroy */
+ peer->nports = nports;
+ return peer;
+
+ err_ret:
+ GNUNET_free_non_null (ss_instances);
+ GNUNET_free_non_null (ports);
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "%s", emsg_);
+ if (NULL != emsg)
+ *emsg = emsg_;
+ else
+ GNUNET_free (emsg_);
+ return NULL;
+}
+
+/**
+ * Obtain the peer identity from a peer handle.
+ *
+ * @param peer peer handle for which we want the peer's identity
+ * @param id identifier for the daemon, will be set
+ */
+void
+GNUNET_TESTING_peer_get_identity (struct GNUNET_TESTING_Peer *peer,
+ struct GNUNET_PeerIdentity *id)
+{
+ if (NULL != peer->id)
+ {
+ memcpy (id, peer->id, sizeof (struct GNUNET_PeerIdentity));
+ return;
+ }
+ peer->id = GNUNET_new (struct GNUNET_PeerIdentity);
+ GNUNET_free (GNUNET_TESTING_hostkey_get (peer->system,
+ peer->key_number,
+ peer->id));
+ memcpy (id, peer->id, sizeof (struct GNUNET_PeerIdentity));
}
-#if CONNECT_CORE2
+
/**
- * Success, connection is up. Signal client our success.
+ * Start the peer.
*
- * @param cls our "struct ConnectContext"
- * @param peer identity of the peer that has connected
- * @param latency the round trip latency of the connection to this peer
- * @param distance distance the transport level distance to this peer
+ * @param peer peer to start
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error (i.e. peer already running)
+ */
+int
+GNUNET_TESTING_peer_start (struct GNUNET_TESTING_Peer *peer)
+{
+ struct SharedServiceInstance *i;
+ unsigned int cnt;
+
+ if (NULL != peer->main_process)
+ {
+ GNUNET_break (0);
+ return GNUNET_SYSERR;
+ }
+ GNUNET_assert (NULL != peer->cfgfile);
+ for (cnt = 0; cnt < peer->system->n_shared_services; cnt++)
+ {
+ i = peer->ss_instances[cnt];
+ if ((0 == i->n_refs)
+ && (GNUNET_SYSERR == start_shared_service_instance (i)) )
+ return GNUNET_SYSERR;
+ i->n_refs++;
+ }
+ peer->main_binary = GNUNET_CONFIGURATION_expand_dollar (peer->cfg, peer->main_binary);
+ peer->main_process = GNUNET_OS_start_process_s (PIPE_CONTROL,
+ GNUNET_OS_INHERIT_STD_OUT_AND_ERR,
+ NULL,
+ peer->main_binary,
+ peer->args,
+ "-c",
+ peer->cfgfile,
+ NULL);
+ if (NULL == peer->main_process)
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ _("Failed to start `%s': %s\n"),
+ peer->main_binary,
+ STRERROR (errno));
+ return GNUNET_SYSERR;
+ }
+ return GNUNET_OK;
+}
+
+
+/**
+ * Start a service at a peer using its ARM service
*
+ * @param peer the peer whose service has to be started
+ * @param service_name name of the service to start
+ * @param timeout how long should the ARM API try to send the request to start
+ * the service
+ * @param cont the callback to call with result and status from ARM API
+ * @param cont_cls the closure for the above callback
+ * @return GNUNET_OK upon successfully queuing the service start request;
+ * GNUNET_SYSERR upon error
*/
-static void
-connect_notify_core2 (void *cls, const struct GNUNET_PeerIdentity * peer, struct GNUNET_TIME_Relative latency,
- uint32_t distance)
+int
+GNUNET_TESTING_peer_service_start (struct GNUNET_TESTING_Peer *peer,
+ const char *service_name,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_ARM_ResultCallback cont,
+ void *cont_cls)
{
- struct ConnectContext *ctx = cls;
+ if (NULL == peer->ah)
+ return GNUNET_SYSERR;
+ GNUNET_ARM_request_service_start (peer->ah,
+ service_name,
+ GNUNET_OS_INHERIT_STD_ALL,
+ timeout,
+ cont, cont_cls);
+ return GNUNET_OK;
+}
- if (memcmp(&ctx->d2->id, peer, sizeof(struct GNUNET_PeerIdentity)) == 0)
- {
- ctx->connected = GNUNET_YES;
- ctx->distance = distance;
- GNUNET_SCHEDULER_cancel(ctx->d1->sched, ctx->timeout_task);
- ctx->timeout_task = GNUNET_SCHEDULER_add_now (ctx->d1->sched,
- ¬ify_connect_result,
- ctx);
- }
+/**
+ * Stop a service at a peer using its ARM service
+ *
+ * @param peer the peer whose service has to be stopped
+ * @param service_name name of the service to stop
+ * @param timeout how long should the ARM API try to send the request to stop
+ * the service
+ * @param cont the callback to call with result and status from ARM API
+ * @param cont_cls the closure for the above callback
+ * @return GNUNET_OK upon successfully queuing the service stop request;
+ * GNUNET_SYSERR upon error
+ */
+int
+GNUNET_TESTING_peer_service_stop (struct GNUNET_TESTING_Peer *peer,
+ const char *service_name,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_ARM_ResultCallback cont,
+ void *cont_cls)
+{
+ if (NULL == peer->ah)
+ return GNUNET_SYSERR;
+ GNUNET_ARM_request_service_stop (peer->ah,
+ service_name,
+ timeout,
+ cont, cont_cls);
+ return GNUNET_OK;
+}
+
+
+/**
+ * Sends SIGTERM to the peer's main process
+ *
+ * @param peer the handle to the peer
+ * @return GNUNET_OK if successful; GNUNET_SYSERR if the main process is NULL
+ * or upon any error while sending SIGTERM
+ */
+int
+GNUNET_TESTING_peer_kill (struct GNUNET_TESTING_Peer *peer)
+{
+ struct SharedServiceInstance *i;
+ unsigned int cnt;
+
+ if (NULL == peer->main_process)
+ {
+ GNUNET_break (0);
+ return GNUNET_SYSERR;
+ }
+ if (0 != GNUNET_OS_process_kill (peer->main_process, GNUNET_TERM_SIG))
+ return GNUNET_SYSERR;
+ for (cnt = 0; cnt < peer->system->n_shared_services; cnt++)
+ {
+ i = peer->ss_instances[cnt];
+ GNUNET_assert (0 != i->n_refs);
+ i->n_refs--;
+ if (0 == i->n_refs)
+ stop_shared_service_instance (i);
+ }
+ return GNUNET_OK;
}
-#endif
+
/**
- * Task called once a core connect request has been transmitted.
+ * Waits for a peer to terminate. The peer's main process will also be destroyed.
*
- * @param cls struct ConnectContext
- * @param tc context information (why was this task triggered now)
+ * @param peer the handle to the peer
+ * @return GNUNET_OK if successful; GNUNET_SYSERR if the main process is NULL
+ * or upon any error while waiting
*/
-void core_connect_request_cont (void *cls,
- const struct
- GNUNET_SCHEDULER_TaskContext * tc)
+int
+GNUNET_TESTING_peer_wait (struct GNUNET_TESTING_Peer *peer)
{
- struct ConnectContext *ctx = cls;
+ int ret;
- if (tc->reason == GNUNET_SCHEDULER_REASON_PREREQ_DONE)
- ctx->connect_request_handle = NULL;
- return;
+ if (NULL == peer->main_process)
+ {
+ GNUNET_break (0);
+ return GNUNET_SYSERR;
+ }
+ ret = GNUNET_OS_process_wait (peer->main_process);
+ GNUNET_OS_process_destroy (peer->main_process);
+ peer->main_process = NULL;
+ return ret;
+}
+
+
+/**
+ * Stop the peer.
+ *
+ * @param peer peer to stop
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ */
+int
+GNUNET_TESTING_peer_stop (struct GNUNET_TESTING_Peer *peer)
+{
+ if (GNUNET_SYSERR == GNUNET_TESTING_peer_kill (peer))
+ return GNUNET_SYSERR;
+ if (GNUNET_SYSERR == GNUNET_TESTING_peer_wait (peer))
+ return GNUNET_SYSERR;
+ return GNUNET_OK;
}
+
+/**
+ * Function called whenever we connect to or disconnect from ARM.
+ *
+ * @param cls closure
+ * @param connected GNUNET_YES if connected, GNUNET_NO if disconnected,
+ * GNUNET_SYSERR on error.
+ */
static void
-send_hello(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+disconn_status (void *cls,
+ int connected)
{
- struct ConnectContext *ctx = cls;
- struct GNUNET_MessageHeader *hello;
- ctx->hello_send_task = GNUNET_SCHEDULER_NO_TASK;
- if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
+ struct GNUNET_TESTING_Peer *peer = cls;
+
+ if (GNUNET_SYSERR == connected)
+ {
+ peer->cb (peer->cb_cls, peer, connected);
return;
- if ((ctx->d1->hello != NULL) && (NULL != GNUNET_HELLO_get_header(ctx->d1->hello)))
- {
- hello = GNUNET_HELLO_get_header(ctx->d1->hello);
- GNUNET_assert(hello != NULL);
- GNUNET_TRANSPORT_offer_hello (ctx->d2th, hello);
-
- ctx->connect_request_handle = GNUNET_CORE_peer_request_connect (ctx->d1->sched,
- ctx->d2->cfg,
- GNUNET_TIME_relative_divide(ctx->relative_timeout,
- ctx->max_connect_attempts + 1),
- &ctx->d1->id,
- &core_connect_request_cont,
- ctx);
- GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Sending connect request to core for peer %s\n", GNUNET_i2s(&ctx->d1->id));
- ctx->timeout_hello = GNUNET_TIME_relative_add(ctx->timeout_hello,
- GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS,
- 500));
- }
- ctx->hello_send_task = GNUNET_SCHEDULER_add_delayed(ctx->d1->sched,
- ctx->timeout_hello,
- &send_hello, ctx);
+ }
+ if (GNUNET_YES == connected)
+ {
+ GNUNET_break (GNUNET_OK == GNUNET_TESTING_peer_kill (peer));
+ return;
+ }
+ GNUNET_break (GNUNET_OK == GNUNET_TESTING_peer_wait (peer));
+ GNUNET_ARM_disconnect_and_free (peer->ah);
+ peer->ah = NULL;
+ peer->cb (peer->cb_cls, peer, GNUNET_YES);
}
+
/**
- * Establish a connection between two GNUnet daemons.
+ * Stop a peer asynchronously using ARM API. Peer's shutdown is signaled
+ * through the GNUNET_TESTING_PeerStopCallback().
*
- * @param d1 handle for the first daemon
- * @param d2 handle for the second daemon
- * @param timeout how long is the connection attempt
- * allowed to take?
- * @param max_connect_attempts how many times should we try to reconnect
- * (within timeout)
- * @param cb function to call at the end
- * @param cb_cls closure for cb
+ * @param peer the peer to stop
+ * @param cb the callback to signal peer shutdown
+ * @param cb_cls closure for the above callback
+ * @return GNUNET_OK upon successfully giving the request to the ARM API (this
+ * does not mean that the peer is successfully stopped); GNUNET_SYSERR
+ * upon any error.
*/
-void
-GNUNET_TESTING_daemons_connect (struct GNUNET_TESTING_Daemon *d1,
- struct GNUNET_TESTING_Daemon *d2,
- struct GNUNET_TIME_Relative timeout,
- unsigned int max_connect_attempts,
- GNUNET_TESTING_NotifyConnection cb,
+int
+GNUNET_TESTING_peer_stop_async (struct GNUNET_TESTING_Peer *peer,
+ GNUNET_TESTING_PeerStopCallback cb,
void *cb_cls)
{
- struct ConnectContext *ctx;
+ if (NULL == peer->main_process)
+ return GNUNET_SYSERR;
+ peer->ah = GNUNET_ARM_connect (peer->cfg, &disconn_status, peer);
+ if (NULL == peer->ah)
+ return GNUNET_SYSERR;
+ peer->cb = cb;
+ peer->cb_cls = cb_cls;
+ return GNUNET_OK;
+}
- if ((d1->running == GNUNET_NO) || (d2->running == GNUNET_NO))
- {
- if (NULL != cb)
- cb (cb_cls, &d1->id, &d2->id, 0, d1->cfg, d2->cfg, d1, d2,
- _("Peers are not fully running yet, can not connect!\n"));
- return;
- }
- ctx = GNUNET_malloc (sizeof (struct ConnectContext));
- ctx->d1 = d1;
- ctx->d2 = d2;
- ctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
- ctx->timeout_hello = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 500);
- ctx->relative_timeout = timeout;
- ctx->cb = cb;
- ctx->cb_cls = cb_cls;
- ctx->max_connect_attempts = max_connect_attempts;
- ctx->connected = GNUNET_NO;
-#if DEBUG_TESTING
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Asked to connect peer %s to peer %s\n",
- d1->shortname, d2->shortname);
-#endif
- ctx->d1core = GNUNET_CORE_connect (d1->sched,
- d1->cfg,
- timeout,
- ctx,
- NULL,
- &connect_notify, NULL, NULL,
- NULL, GNUNET_NO,
- NULL, GNUNET_NO, no_handlers);
- if (ctx->d1core == NULL)
- {
- GNUNET_free (ctx);
- if (NULL != cb)
- cb (cb_cls, &d1->id, &d2->id, 0, d1->cfg, d2->cfg, d1, d2,
- _("Failed to connect to core service of first peer!\n"));
- return;
- }
+/**
+ * Cancel a previous asynchronous peer stop request.
+ * GNUNET_TESTING_peer_stop_async() should have been called before on the given
+ * peer. It is an error to call this function if the peer stop callback was
+ * already called
+ *
+ * @param peer the peer on which GNUNET_TESTING_peer_stop_async() was called
+ * before.
+ */
+void
+GNUNET_TESTING_peer_stop_async_cancel (struct GNUNET_TESTING_Peer *peer)
+{
+ GNUNET_assert (NULL != peer->ah);
+ GNUNET_ARM_disconnect_and_free (peer->ah);
+ peer->ah = NULL;
+}
-#if CONNECT_CORE2
- ctx->d2core = GNUNET_CORE_connect (d2->sched,
- d2->cfg,
- timeout,
- ctx,
- NULL,
- NULL, NULL, NULL,
- NULL, GNUNET_NO,
- NULL, GNUNET_NO, no_handlers);
- if (ctx->d2core == NULL)
- {
- GNUNET_free (ctx);
- if (NULL != cb)
- cb (cb_cls, &d1->id, &d2->id, 0, d1->cfg, d2->cfg, d1, d2,
- _("Failed to connect to core service of second peer!\n"));
- return;
- }
-#endif
-#if DEBUG_TESTING > 2
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Asked to connect peer %s to peer %s\n",
- d1->shortname, d2->shortname);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Connecting to transport service of peer %s\n", d2->shortname);
+/**
+ * Destroy the peer. Releases resources locked during peer configuration.
+ * If the peer is still running, it will be stopped AND a warning will be
+ * printed (users of the API should stop the peer explicitly first).
+ *
+ * @param peer peer to destroy
+ */
+void
+GNUNET_TESTING_peer_destroy (struct GNUNET_TESTING_Peer *peer)
+{
+ unsigned int cnt;
+
+ if (NULL != peer->main_process)
+ GNUNET_TESTING_peer_stop (peer);
+ if (NULL != peer->ah)
+ GNUNET_ARM_disconnect_and_free (peer->ah);
+ if (NULL != peer->mh)
+ GNUNET_ARM_monitor_disconnect_and_free (peer->mh);
+ GNUNET_free (peer->cfgfile);
+ if (NULL != peer->cfg)
+ GNUNET_CONFIGURATION_destroy (peer->cfg);
+ GNUNET_free (peer->main_binary);
+ GNUNET_free (peer->args);
+ GNUNET_free_non_null (peer->id);
+ GNUNET_free_non_null (peer->ss_instances);
+ if (NULL != peer->ports)
+ {
+ for (cnt = 0; cnt < peer->nports; cnt++)
+ GNUNET_TESTING_release_port (peer->system, peer->ports[cnt]);
+ GNUNET_free (peer->ports);
+ }
+ GNUNET_free (peer);
+}
-#endif
- ctx->d2th = GNUNET_TRANSPORT_connect (d2->sched,
- d2->cfg,
- &d2->id,
- d2, NULL, NULL, NULL);
- if (ctx->d2th == NULL)
- {
- GNUNET_CORE_disconnect(ctx->d1core);
- GNUNET_free (ctx);
- if (NULL != cb)
- cb (cb_cls, &d1->id, &d2->id, 0, d1->cfg, d2->cfg, d1, d2,
- _("Failed to connect to transport service!\n"));
- return;
- }
+/**
+ * Start a single peer and run a test using the testing library.
+ * Starts a peer using the given configuration and then invokes the
+ * given callback. This function ALSO initializes the scheduler loop
+ * and should thus be called directly from "main". The testcase
+ * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
+ *
+ * @param testdir only the directory name without any path. This is used for
+ * all service homes; the directory will be created in a temporary
+ * location depending on the underlying OS
+ * @param cfgfilename name of the configuration file to use;
+ * use NULL to only run with defaults
+ * @param tm main function of the testcase
+ * @param tm_cls closure for 'tm'
+ * @return 0 on success, 1 on error
+ */
+int
+GNUNET_TESTING_peer_run (const char *testdir,
+ const char *cfgfilename,
+ GNUNET_TESTING_TestMain tm,
+ void *tm_cls)
+{
+ return GNUNET_TESTING_service_run (testdir, "arm",
+ cfgfilename, tm, tm_cls);
+}
- ctx->timeout_task = GNUNET_SCHEDULER_add_delayed (d1->sched,
- GNUNET_TIME_relative_divide(ctx->relative_timeout,
- ctx->max_connect_attempts),
- ¬ify_connect_result, ctx);
- ctx->hello_send_task = GNUNET_SCHEDULER_add_now(ctx->d1->sched, &send_hello, ctx);
-}
+/**
+ * Structure for holding service data
+ */
+struct ServiceContext
+{
+ /**
+ * The configuration of the peer in which the service is run
+ */
+ const struct GNUNET_CONFIGURATION_Handle *cfg;
+ /**
+ * Callback to signal service startup
+ */
+ GNUNET_TESTING_TestMain tm;
+
+ /**
+ * The peer in which the service is run.
+ */
+ struct GNUNET_TESTING_Peer *peer;
+
+ /**
+ * Closure for the above callback
+ */
+ void *tm_cls;
+};
+
+
+/**
+ * Callback to be called when SCHEDULER has been started
+ *
+ * @param cls the ServiceContext
+ * @param tc the TaskContext
+ */
static void
-reattempt_daemons_connect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+service_run_main (void *cls,
+ const struct GNUNET_SCHEDULER_TaskContext *tc)
{
+ struct ServiceContext *sc = cls;
- struct ConnectContext *ctx = cls;
- if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
- {
- return;
- }
-#if DEBUG_TESTING_RECONNECT
- GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "re-attempting connect of peer %s to peer %s\n",
- ctx->d1->shortname, ctx->d2->shortname);
-#endif
+ sc->tm (sc->tm_cls, sc->cfg, sc->peer);
+}
- GNUNET_assert(ctx->d1core == NULL);
-
- ctx->d1core = GNUNET_CORE_connect (ctx->d1->sched,
- ctx->d1->cfg,
- GNUNET_TIME_absolute_get_remaining(ctx->timeout),
- ctx,
- NULL,
- &connect_notify, NULL, NULL,
- NULL, GNUNET_NO,
- NULL, GNUNET_NO, no_handlers);
- if (ctx->d1core == NULL)
- {
- if (NULL != ctx->cb)
- ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, 0, ctx->d1->cfg, ctx->d2->cfg, ctx->d1, ctx->d2,
- _("Failed to connect to core service of first peer!\n"));
- GNUNET_free (ctx);
- return;
- }
- ctx->d2th = GNUNET_TRANSPORT_connect (ctx->d2->sched,
- ctx->d2->cfg,
- &ctx->d2->id,
- ctx->d2, NULL, NULL, NULL);
- if (ctx->d2th == NULL)
- {
- GNUNET_CORE_disconnect(ctx->d1core);
- GNUNET_free (ctx);
- if (NULL != ctx->cb)
- ctx->cb (ctx->cb_cls, &ctx->d1->id, &ctx->d2->id, 0, ctx->d1->cfg, ctx->d2->cfg, ctx->d1, ctx->d2,
- _("Failed to connect to transport service!\n"));
- return;
- }
+/**
+ * Start a single service (no ARM, except of course if the given
+ * service name is 'arm') and run a test using the testing library.
+ * Starts a service using the given configuration and then invokes the
+ * given callback. This function ALSO initializes the scheduler loop
+ * and should thus be called directly from "main". The testcase
+ * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
+ *
+ * This function is useful if the testcase is for a single service
+ * and if that service doesn't itself depend on other services.
+ *
+ * @param testdir only the directory name without any path. This is used for
+ * all service homes; the directory will be created in a temporary
+ * location depending on the underlying OS
+ * @param service_name name of the service to run
+ * @param cfgfilename name of the configuration file to use;
+ * use NULL to only run with defaults
+ * @param tm main function of the testcase
+ * @param tm_cls closure for 'tm'
+ * @return 0 on success, 1 on error
+ */
+int
+GNUNET_TESTING_service_run (const char *testdir,
+ const char *service_name,
+ const char *cfgfilename,
+ GNUNET_TESTING_TestMain tm,
+ void *tm_cls)
+{
+ struct ServiceContext sc;
+ struct GNUNET_TESTING_System *system;
+ struct GNUNET_TESTING_Peer *peer;
+ struct GNUNET_CONFIGURATION_Handle *cfg;
+ char *binary;
+ char *libexec_binary;
+
+ GNUNET_log_setup (testdir, "WARNING", NULL);
+ system = GNUNET_TESTING_system_create (testdir, "127.0.0.1", NULL, NULL);
+ if (NULL == system)
+ return 1;
+ cfg = GNUNET_CONFIGURATION_create ();
+ if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfgfilename))
+ {
+ LOG (GNUNET_ERROR_TYPE_ERROR,
+ _("Failed to load configuration from %s\n"), cfgfilename);
+ GNUNET_CONFIGURATION_destroy (cfg);
+ GNUNET_TESTING_system_destroy (system, GNUNET_YES);
+ return 1;
+ }
+ peer = GNUNET_TESTING_peer_configure (system, cfg, 0, NULL, NULL);
+ if (NULL == peer)
+ {
+ GNUNET_CONFIGURATION_destroy (cfg);
+ hostkeys_unload (system);
+ GNUNET_TESTING_system_destroy (system, GNUNET_YES);
+ return 1;
+ }
+ GNUNET_free (peer->main_binary);
+ GNUNET_free (peer->args);
+ GNUNET_asprintf (&binary, "gnunet-service-%s", service_name);
+ libexec_binary = GNUNET_OS_get_libexec_binary_path (binary);
+ if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string(cfg, service_name, "PREFIX", &peer->main_binary))
+ {
+ /* No prefix */
+ GNUNET_asprintf(&peer->main_binary, "%s", libexec_binary);
+ peer->args = strdup ("");
+ }
+ else
+ peer->args = strdup (libexec_binary);
+
+ GNUNET_free (libexec_binary);
+ GNUNET_free (binary);
+ if (GNUNET_OK != GNUNET_TESTING_peer_start (peer))
+ {
+ GNUNET_TESTING_peer_destroy (peer);
+ GNUNET_CONFIGURATION_destroy (cfg);
+ GNUNET_TESTING_system_destroy (system, GNUNET_YES);
+ return 1;
+ }
+ sc.cfg = cfg;
+ sc.tm = tm;
+ sc.tm_cls = tm_cls;
+ sc.peer = peer;
+ GNUNET_SCHEDULER_run (&service_run_main, &sc); /* Scheduler loop */
+ if ((NULL != peer->main_process) &&
+ (GNUNET_OK != GNUNET_TESTING_peer_stop (peer)))
+ {
+ GNUNET_TESTING_peer_destroy (peer);
+ GNUNET_CONFIGURATION_destroy (cfg);
+ GNUNET_TESTING_system_destroy (system, GNUNET_YES);
+ return 1;
+ }
+ GNUNET_TESTING_peer_destroy (peer);
+ GNUNET_CONFIGURATION_destroy (cfg);
+ GNUNET_TESTING_system_destroy (system, GNUNET_YES);
+ return 0;
+}
- ctx->timeout_task = GNUNET_SCHEDULER_add_delayed (ctx->d1->sched,
- GNUNET_TIME_relative_divide(ctx->relative_timeout, ctx->max_connect_attempts),
- ¬ify_connect_result, ctx);
- ctx->hello_send_task = GNUNET_SCHEDULER_add_now(ctx->d1->sched, &send_hello, ctx);
+/**
+ * Sometimes we use the binary name to determine which specific
+ * test to run. In those cases, the string after the last "_"
+ * in 'argv[0]' specifies a string that determines the configuration
+ * file or plugin to use.
+ *
+ * This function returns the respective substring, taking care
+ * of issues such as binaries ending in '.exe' on W32.
+ *
+ * @param argv0 the name of the binary
+ * @return string between the last '_' and the '.exe' (or the end of the string),
+ * NULL if argv0 has no '_'
+ */
+char *
+GNUNET_TESTING_get_testname_from_underscore (const char *argv0)
+{
+ size_t slen = strlen (argv0) + 1;
+ char sbuf[slen];
+ char *ret;
+ char *dot;
+
+ memcpy (sbuf, argv0, slen);
+ ret = strrchr (sbuf, '_');
+ if (NULL == ret)
+ return NULL;
+ ret++; /* skip underscore */
+ dot = strchr (ret, '.');
+ if (NULL != dot)
+ *dot = '\0';
+ return GNUNET_strdup (ret);
}
+
/* end of testing.c */