/*
- This file is part of GNUnet
- (C) 2008--2012 Christian Grothoff (and other contributing authors)
+ This file is part of GNUnet
+ (C) 2008--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
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published
+ by the Free Software Foundation; either version 3, or (at your
+ option) any later version.
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ GNUnet is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
- */
+ You should have received a copy of the GNU General Public License
+ along with GNUnet; see the file COPYING. If not, write to the
+ Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ Boston, MA 02111-1307, USA.
+*/
/**
* @file testbed/testbed_api_testbed.c
* @brief high-level testbed management
* @author Christian Grothoff
+ * @author Sree Harsha Totakura
*/
+
#include "platform.h"
#include "gnunet_testbed_service.h"
+#include "testbed_api_peers.h"
+/**
+ * Generic loggins shorthand
+ */
+#define LOG(kind,...) \
+ GNUNET_log_from (kind, "testbed-api-testbed", __VA_ARGS__)
/**
* Opaque handle to an abstract operation to be executed by the testing framework.
};
+/**
+ * DLL of operations
+ */
+struct DLLOperation
+{
+ /**
+ * The testbed operation handle
+ */
+ struct GNUNET_TESTBED_Operation *op;
+
+ /**
+ * Context information for GNUNET_TESTBED_run()
+ */
+ struct RunContext *rc;
+
+ /**
+ * Closure
+ */
+ void *cls;
+
+ /**
+ * The next pointer for DLL
+ */
+ struct DLLOperation *next;
+
+ /**
+ * The prev pointer for DLL
+ */
+ struct DLLOperation *prev;
+};
+
+
+/**
+ * States of RunContext
+ */
+enum State
+{
+ /**
+ * Initial state
+ */
+ RC_INIT = 0,
+
+ /**
+ * Peers have been started
+ */
+ RC_PEERS_STARTED,
+
+ /**
+ * Peers are stopped
+ */
+ RC_PEERS_STOPPED,
+
+ /**
+ * Peers are destroyed
+ */
+ RC_PEERS_DESTROYED
+};
+
+
+/**
+ * Testbed Run Handle
+ */
+struct RunContext
+{
+ /**
+ * The controller handle
+ */
+ struct GNUNET_TESTBED_Controller *c;
+
+ /**
+ * Handle to the host on which the controller runs
+ */
+ struct GNUNET_TESTBED_Host *h;
+
+ /**
+ * The handle to the controller process
+ */
+ struct GNUNET_TESTBED_ControllerProc *cproc;
+
+ /**
+ * The callback to use as controller callback
+ */
+ GNUNET_TESTBED_ControllerCallback cc;
+
+ /**
+ * The pointer to the controller callback
+ */
+ void *cc_cls;
+
+ /**
+ * Master task to call when testbed initialization is done
+ */
+ GNUNET_SCHEDULER_Task master;
+
+ /**
+ * The closure for the master task
+ */
+ void *master_cls;
+
+ /**
+ * The head element of DLL operations
+ */
+ struct DLLOperation *dll_op_head;
+
+ /**
+ * The tail element of DLL operations
+ */
+ struct DLLOperation *dll_op_tail;
+
+ /**
+ * Array of peers which we create
+ */
+ struct GNUNET_TESTBED_Peer **peers;
+
+ /**
+ * The event mask for the controller
+ */
+ uint64_t event_mask;
+
+ /**
+ * State of this context
+ */
+ enum State state;
+
+ /**
+ * Current peer count for an operation; Set this to 0 and increment for each
+ * successful operation on a peer
+ */
+ unsigned int peer_count;
+
+ /**
+ * number of peers to start
+ */
+ unsigned int num_peers;
+
+};
+
+
+/**
+ * Task for starting peers
+ *
+ * @param cls the RunHandle
+ * @param tc the task context from scheduler
+ */
+static void
+start_peers_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+ struct RunContext *rc = cls;
+ struct DLLOperation *dll_op;
+ unsigned int peer;
+
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Starting Peers\n");
+ for (peer = 0; peer < rc->num_peers; peer++)
+ {
+ dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
+ dll_op->op = GNUNET_TESTBED_peer_start (rc->peers[peer], NULL, NULL);
+ dll_op->cls = rc->peers[peer];
+ GNUNET_CONTAINER_DLL_insert_tail (rc->dll_op_head, rc->dll_op_tail, dll_op);
+ }
+ rc->peer_count = 0;
+}
+
+
+/**
+ * Functions of this signature are called when a peer has been successfully
+ * created
+ *
+ * @param cls the closure from GNUNET_TESTBED_peer_create()
+ * @param peer the handle for the created peer; NULL on any error during
+ * creation
+ * @param emsg NULL if peer is not NULL; else MAY contain the error description
+ */
+static void
+peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
+{
+ struct DLLOperation *dll_op = cls;
+ struct RunContext *rc;
+
+ GNUNET_assert (NULL != dll_op);
+ rc = dll_op->rc;
+ GNUNET_assert (NULL != rc);
+ GNUNET_CONTAINER_DLL_remove (rc->dll_op_head, rc->dll_op_tail, dll_op);
+ GNUNET_TESTBED_operation_done (dll_op->op);
+ GNUNET_free (dll_op);
+ if (NULL == peer)
+ {
+ if (NULL != emsg)
+ LOG (GNUNET_ERROR_TYPE_WARNING, "Error while creating a peer: %s\n",
+ emsg);
+ /* FIXME: GNUNET_TESTBED_shutdown_run()? */
+ return;
+ }
+ rc->peers[rc->peer_count] = peer;
+ rc->peer_count++;
+ if (rc->peer_count < rc->num_peers)
+ return;
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Required peers created successfully\n");
+ GNUNET_SCHEDULER_add_now (&start_peers_task, rc);
+}
+
+
+/**
+ * Assuming all peers have been destroyed cleanup run handle
+ *
+ * @param cls the run handle
+ * @param tc the task context from scheduler
+ */
+static void
+cleanup_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+ struct RunContext *rc = cls;
+ struct DLLOperation *dll_op;
+
+ GNUNET_assert (NULL == rc->peers);
+ GNUNET_assert (RC_PEERS_DESTROYED == rc->state);
+ if (NULL != rc->c)
+ GNUNET_TESTBED_controller_disconnect (rc->c);
+ if (NULL != rc->cproc)
+ GNUNET_TESTBED_controller_stop (rc->cproc);
+ if (NULL != rc->h)
+ GNUNET_TESTBED_host_destroy (rc->h);
+ if (NULL != rc->dll_op_head)
+ {
+ LOG (GNUNET_ERROR_TYPE_WARNING,
+ _("Some operations are still pending. Cancelling them\n"));
+ while (NULL != (dll_op = rc->dll_op_head))
+ {
+ GNUNET_TESTBED_operation_cancel (dll_op->op);
+ GNUNET_CONTAINER_DLL_remove (rc->dll_op_head, rc->dll_op_tail, dll_op);
+ GNUNET_free (dll_op);
+ }
+ }
+ GNUNET_free (rc);
+}
+
+
+/**
+ * Signature of the event handler function called by the
+ * respective event controller.
+ *
+ * @param cls closure
+ * @param event information about the event
+ */
+static void
+event_cb (void *cls, const struct GNUNET_TESTBED_EventInformation *event)
+{
+ struct RunContext *rc = cls;
+ struct DLLOperation *dll_op;
+ unsigned int peer_id;
+
+
+ if ((RC_INIT != rc->state) &&
+ ((GNUNET_TESTBED_ET_OPERATION_FINISHED == event->type) ||
+ (GNUNET_TESTBED_ET_PEER_STOP == event->type)))
+ {
+ for (dll_op = rc->dll_op_head; NULL != dll_op; dll_op = dll_op->next)
+ {
+ if ((GNUNET_TESTBED_ET_OPERATION_FINISHED == event->type) &&
+ (event->details.operation_finished.operation == dll_op->op))
+ break;
+ if ((GNUNET_TESTBED_ET_PEER_STOP == event->type) &&
+ (event->details.peer_stop.peer == dll_op->cls))
+ break;
+ }
+ if (NULL == dll_op)
+ goto call_cc;
+ GNUNET_CONTAINER_DLL_remove (rc->dll_op_head, rc->dll_op_tail, dll_op);
+ GNUNET_TESTBED_operation_done (dll_op->op);
+ GNUNET_free (dll_op);
+ rc->peer_count++;
+ if (rc->peer_count < rc->num_peers)
+ return;
+ switch (rc->state)
+ {
+ case RC_PEERS_STARTED:
+ rc->state = RC_PEERS_STOPPED;
+ rc->peer_count = 0;
+ for (peer_id = 0; peer_id < rc->num_peers; peer_id++)
+ {
+ dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
+ dll_op->op = GNUNET_TESTBED_peer_destroy (rc->peers[peer_id]);
+ GNUNET_CONTAINER_DLL_insert_tail (rc->dll_op_head, rc->dll_op_tail,
+ dll_op);
+ }
+ break;
+ case RC_PEERS_STOPPED:
+ rc->state = RC_PEERS_DESTROYED;
+ GNUNET_free (rc->peers);
+ rc->peers = NULL;
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "All peers successfully destroyed\n");
+ GNUNET_SCHEDULER_add_now (&cleanup_task, rc);
+ break;
+ default:
+ GNUNET_assert (0);
+ }
+ return;
+ }
+
+call_cc:
+ if ((0 != (rc->event_mask && (1LL << event->type))) && (NULL != rc->cc))
+ rc->cc (rc->cc_cls, event);
+ if (GNUNET_TESTBED_ET_PEER_START != event->type)
+ return;
+ for (dll_op = rc->dll_op_head; NULL != dll_op; dll_op = dll_op->next)
+ if ((NULL != dll_op->cls) &&
+ (event->details.peer_start.peer == dll_op->cls))
+ break;
+ GNUNET_assert (NULL != dll_op);
+ GNUNET_CONTAINER_DLL_remove (rc->dll_op_head, rc->dll_op_tail, dll_op);
+ GNUNET_TESTBED_operation_done (dll_op->op);
+ GNUNET_free (dll_op);
+ rc->peer_count++;
+ if (rc->peer_count < rc->num_peers)
+ return;
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Peers started successfully\n");
+ rc->state = RC_PEERS_STARTED;
+ if (NULL != rc->master)
+ GNUNET_SCHEDULER_add_continuation (rc->master, rc->master_cls,
+ GNUNET_SCHEDULER_REASON_PREREQ_DONE);
+}
+
+
+
+/**
+ * Callback to signal successfull startup of the controller process
+ *
+ * @param cls the closure from GNUNET_TESTBED_controller_start()
+ * @param cfg the configuration with which the controller has been started;
+ * NULL if status is not GNUNET_OK
+ * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
+ * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
+ */
+static void
+controller_status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg,
+ int status)
+{
+ struct RunContext *rc = cls;
+ struct DLLOperation *dll_op;
+ uint64_t event_mask;
+ unsigned int peer;
+
+ if (status != GNUNET_OK)
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Testbed startup failed\n");
+ return;
+ }
+ event_mask = rc->event_mask;
+ event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_STOP);
+ event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
+ rc->c =
+ GNUNET_TESTBED_controller_connect (cfg, rc->h, event_mask, &event_cb, rc);
+ rc->peers =
+ GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Peer *) * rc->num_peers);
+ GNUNET_assert (NULL != rc->c);
+ rc->peer_count = 0;
+ for (peer = 0; peer < rc->num_peers; peer++)
+ {
+ dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
+ dll_op->rc = rc;
+ dll_op->op =
+ GNUNET_TESTBED_peer_create (rc->c, rc->h, cfg, peer_create_cb, dll_op);
+ GNUNET_CONTAINER_DLL_insert_tail (rc->dll_op_head, rc->dll_op_tail, dll_op);
+ }
+}
+
+
+/**
+ * Stops the testbed run and releases any used resources
+ *
+ * @param cls the tesbed run handle
+ * @param tc the task context from scheduler
+ */
+void
+shutdown_run_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+ struct RunContext *rc = cls;
+ struct DLLOperation *dll_op;
+ unsigned int peer;
+
+ if (NULL != rc->c)
+ {
+ if (NULL != rc->peers)
+ {
+ rc->peer_count = 0;
+ /* Check if some peers are stopped */
+ for (peer = 0; peer < rc->num_peers; peer++)
+ {
+ if (PS_STOPPED != rc->peers[peer]->state)
+ break;
+ }
+ if (peer == rc->num_peers)
+ {
+ /* All peers are stopped */
+ rc->state = RC_PEERS_STOPPED;
+ for (peer = 0; peer < rc->num_peers; peer++)
+ {
+ dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
+ dll_op->op = GNUNET_TESTBED_peer_destroy (rc->peers[peer]);
+ GNUNET_CONTAINER_DLL_insert_tail (rc->dll_op_head, rc->dll_op_tail,
+ dll_op);
+ }
+ return;
+ }
+ /* Some peers are stopped */
+ for (peer = 0; peer < rc->num_peers; peer++)
+ {
+ if (PS_STARTED != rc->peers[peer]->state)
+ {
+ rc->peer_count++;
+ continue;
+ }
+ dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
+ dll_op->op = GNUNET_TESTBED_peer_stop (rc->peers[peer], NULL, NULL);
+ dll_op->cls = rc->peers[peer];
+ GNUNET_CONTAINER_DLL_insert_tail (rc->dll_op_head, rc->dll_op_tail,
+ dll_op);
+ }
+ if (rc->peer_count != rc->num_peers)
+ return;
+ }
+ }
+ rc->state = RC_PEERS_DESTROYED; /* No peers are present so we consider the
+ * state where all peers are destroyed */
+ GNUNET_SCHEDULER_add_now (&cleanup_task, rc);
+}
+
+
+/**
+ * Convenience method for running a testbed with
+ * a single call. Underlay and overlay topology
+ * are configured using the "UNDERLAY" and "OVERLAY"
+ * options in the "[testbed]" section of the configuration\
+ * (with possible options given in "UNDERLAY_XXX" and/or
+ * "OVERLAY_XXX").
+ *
+ * The testbed is to be terminated using a call to
+ * "GNUNET_SCHEDULER_shutdown".
+ *
+ * @param host_filename name of the file with the 'hosts', NULL
+ * to run everything on 'localhost'
+ * @param cfg configuration to use (for testbed, controller and peers)
+ * @param num_peers number of peers to start; FIXME: maybe put that ALSO into cfg?
+ * @param event_mask bit mask with set of events to call 'cc' for;
+ * or-ed values of "1LL" shifted by the
+ * respective 'enum GNUNET_TESTBED_EventType'
+ * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
+ * @param cc controller callback to invoke on events; This callback is called
+ * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
+ * set in the event_mask as this is the only way get access to the
+ * handle of each peer
+ * @param cc_cls closure for cc
+ * @param master task to run once the testbed is ready
+ * @param master_cls
+ */
+void
+GNUNET_TESTBED_run (const char *host_filename,
+ const struct GNUNET_CONFIGURATION_Handle *cfg,
+ unsigned int num_peers, uint64_t event_mask,
+ GNUNET_TESTBED_ControllerCallback cc, void *cc_cls,
+ GNUNET_SCHEDULER_Task master, void *master_cls)
+{
+ struct RunContext *rc;
+
+ GNUNET_break (NULL == host_filename); /* Currently we do not support host
+ * files */
+ GNUNET_assert (NULL != cc);
+ GNUNET_assert (num_peers > 0);
+ host_filename = NULL;
+ rc = GNUNET_malloc (sizeof (struct RunContext));
+ rc->h = GNUNET_TESTBED_host_create (NULL, NULL, 0);
+ GNUNET_assert (NULL != rc->h);
+ rc->cproc =
+ GNUNET_TESTBED_controller_start ("127.0.0.1", rc->h, cfg,
+ &controller_status_cb, rc);
+ GNUNET_assert (NULL != rc->cproc);
+ rc->num_peers = num_peers;
+ rc->event_mask = event_mask;
+ rc->event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
+ rc->cc = cc;
+ rc->cc_cls = cc_cls;
+ rc->master = master;
+ rc->master_cls = master_cls;
+ rc->state = RC_INIT;
+ GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
+ &shutdown_run_task, rc);
+}
+
+
/**
* Configure and run a testbed using the given
* master controller on 'num_hosts' starting
*/
struct GNUNET_TESTBED_Testbed *
GNUNET_TESTBED_create_va (struct GNUNET_TESTBED_Controller *controller,
- unsigned int num_hosts,
- struct GNUNET_TESTBED_Host **hosts,
- unsigned int num_peers,
- const struct GNUNET_CONFIGURATION_Handle *peer_cfg,
- enum GNUNET_TESTBED_TopologyOption underlay_topology,
- va_list va)
+ unsigned int num_hosts,
+ struct GNUNET_TESTBED_Host **hosts,
+ unsigned int num_peers,
+ const struct GNUNET_CONFIGURATION_Handle *peer_cfg,
+ enum GNUNET_TESTBED_TopologyOption underlay_topology,
+ va_list va)
{
GNUNET_break (0);
return NULL;
*/
struct GNUNET_TESTBED_Testbed *
GNUNET_TESTBED_create (struct GNUNET_TESTBED_Controller *controller,
- unsigned int num_hosts,
- struct GNUNET_TESTBED_Host **hosts,
- unsigned int num_peers,
- const struct GNUNET_CONFIGURATION_Handle *peer_cfg,
- enum GNUNET_TESTBED_TopologyOption underlay_topology,
- ...)
+ unsigned int num_hosts,
+ struct GNUNET_TESTBED_Host **hosts,
+ unsigned int num_peers,
+ const struct GNUNET_CONFIGURATION_Handle *peer_cfg,
+ enum GNUNET_TESTBED_TopologyOption underlay_topology,
+ ...)
{
GNUNET_break (0);
return NULL;
}
-
-/**
- * Convenience method for running a testbed with
- * a single call. Underlay and overlay topology
- * are configured using the "UNDERLAY" and "OVERLAY"
- * options in the "[testbed]" section of the configuration\
- * (with possible options given in "UNDERLAY_XXX" and/or
- * "OVERLAY_XXX").
- *
- * The testbed is to be terminated using a call to
- * "GNUNET_SCHEDULER_shutdown".
- *
- * @param host_filename name of the file with the 'hosts', NULL
- * to run everything on 'localhost'
- * @param cfg configuration to use (for testbed, controller and peers)
- * @param num_peers number of peers to start; FIXME: maybe put that ALSO into cfg?
- * @param event_mask bit mask with set of events to call 'cc' for;
- * or-ed values of "1LL" shifted by the
- * respective 'enum GNUNET_TESTBED_EventType'
- * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
- * @param cc controller callback to invoke on events
- * @param cc_cls closure for cc
- * @param master task to run once the testbed is ready
- * @param master_cls closure for 'task'.
- */
-void
-GNUNET_TESTBED_run (const char *host_filename,
- const struct GNUNET_CONFIGURATION_Handle *cfg,
- unsigned int num_peers,
- uint64_t event_mask,
- GNUNET_TESTBED_ControllerCallback cc,
- void *cc_cls,
- GNUNET_SCHEDULER_Task master,
- void *master_cls)
-{
- GNUNET_break (0);
-}
-
-
-
/* end of testbed_api_testbed.c */
projects / oweals / gnunet.git / blobdiff