/*
This file is part of GNUnet
- (C) 2012 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2008--2013 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
#ifndef TESTBED_API_H
#define TESTBED_API_H
+#include "gnunet_util_lib.h"
#include "gnunet_testbed_service.h"
#include "testbed.h"
-
+#include "testbed_helper.h"
/**
* Testbed Helper binary name
*/
OP_PEER_INFO,
+ /**
+ * Reconfigure a peer
+ */
+ OP_PEER_RECONFIGURE,
+
/**
* Overlay connection operation
*/
/**
* Get slave config operation
*/
- OP_GET_SLAVE_CONFIG
-};
+ OP_GET_SLAVE_CONFIG,
+ /**
+ * Stop and destroy all peers
+ */
+ OP_SHUTDOWN_PEERS,
-/**
- * The message queue for sending messages to the controller service
- */
-struct MessageQueue;
+ /**
+ * Start/stop service at a peer
+ */
+ OP_MANAGE_SERVICE
+};
-/**
- * Structure for a controller link
- */
-struct ControllerLink;
/**
*/
enum OperationContextState
{
- /**
- * The initial state where the associated operation has just been created
- * and is waiting in the operation queues to be started
- */
+ /**
+ * The initial state where the associated operation has just been created
+ * and is waiting in the operation queues to be started
+ */
OPC_STATE_INIT = 0,
- /**
- * The operation has been started. It may occupy some resources which are to
- * be freed if cancelled.
- */
+ /**
+ * The operation has been started. It may occupy some resources which are to
+ * be freed if cancelled.
+ */
OPC_STATE_STARTED,
- /**
- * The operation has finished. The end results of this operation may occupy
- * some resources which are to be freed by operation_done
- */
+ /**
+ * The operation has finished. The end results of this operation may occupy
+ * some resources which are to be freed by operation_done
+ */
OPC_STATE_FINISHED
};
*/
struct OperationContext
{
- /**
- * next ptr for DLL
- */
- struct OperationContext *next;
-
- /**
- * prev ptr for DLL
- */
- struct OperationContext *prev;
-
/**
* The controller to which this operation context belongs to
*/
};
+/**
+ * Operation empty callback
+ *
+ * @param cls closure
+ */
+typedef void
+(*TESTBED_opcq_empty_cb) (void *cls);
+
+
/**
* Handle to interact with a GNUnet testbed controller. Each
* controller has at least one master handle which is created when the
struct GNUNET_CONFIGURATION_Handle *cfg;
/**
- * The client connection handle to the controller service
+ * The message queue to the controller service
*/
- struct GNUNET_CLIENT_Connection *client;
+ struct GNUNET_MQ_Handle *mq;
/**
- * The head of the message queue
+ * The host registration handle; NULL if no current registration requests are
+ * present
*/
- struct MessageQueue *mq_head;
+ struct GNUNET_TESTBED_HostRegistrationHandle *rh;
/**
- * The tail of the message queue
+ * The map of active operation contexts
*/
- struct MessageQueue *mq_tail;
+ struct GNUNET_CONTAINER_MultiHashMap32 *opc_map;
/**
- * The head of the ControllerLink list
+ * If this callback is not NULL, schedule it as a task when opc_map gets empty
*/
- struct ControllerLink *cl_head;
+ TESTBED_opcq_empty_cb opcq_empty_cb;
/**
- * The tail of the ControllerLink list
+ * Closure for the above task
*/
- struct ControllerLink *cl_tail;
+ void *opcq_empty_cls;
/**
- * The client transmit handle
+ * Operation queue for simultaneous operations
*/
- struct GNUNET_CLIENT_TransmitHandle *th;
+ struct OperationQueue *opq_parallel_operations;
/**
- * The host registration handle; NULL if no current registration requests are
- * present
+ * Operation queue for simultaneous service connections
*/
- struct GNUNET_TESTBED_HostRegistrationHandle *rh;
+ struct OperationQueue *opq_parallel_service_connections;
/**
- * The head of the opeartion context queue
+ * Operation queue for simultaneous topology configuration operations
*/
- struct OperationContext *ocq_head;
+ struct OperationQueue *opq_parallel_topology_config_operations;
/**
- * The tail of the operation context queue
+ * handle for hashtable of barrier handles, values are
+ * of type `struct GNUNET_TESTBED_Barrier`.
*/
- struct OperationContext *ocq_tail;
+ struct GNUNET_CONTAINER_MultiHashMap *barrier_map;
/**
- * Operation queue for simultaneous operations
+ * The controller event mask
*/
- struct OperationQueue *opq_parallel_operations;
+ uint64_t event_mask;
/**
- * Operation queue for simultaneous service connections
+ * The operation id counter. use current value and increment
*/
- struct OperationQueue *opq_parallel_service_connections;
+ uint32_t operation_counter;
+};
+
+
+/**
+ * Handle for barrier
+ */
+struct GNUNET_TESTBED_Barrier
+{
/**
- * Operation queue for simultaneous topology configuration operations
+ * hashcode identifying this barrier in the hashmap
*/
- struct OperationQueue *opq_parallel_topology_config_operations;
+ struct GNUNET_HashCode key;
/**
- * The controller event mask
+ * The controller handle given while initiliasing this barrier
*/
- uint64_t event_mask;
+ struct GNUNET_TESTBED_Controller *c;
/**
- * Did we start the receive loop yet?
+ * The name of the barrier
*/
- int in_receive;
+ char *name;
/**
- * Did we create the host for this?
+ * The continuation callback to call when we have a status update on this
*/
- int aux_host;
+ GNUNET_TESTBED_barrier_status_cb cb;
/**
- * The operation id counter. use current value and increment
+ * the closure for the above callback
*/
- uint32_t operation_counter;
+ void *cls;
+ /**
+ * Should the barrier crossed status message be echoed back to the controller?
+ */
+ int echo;
};
+
/**
* Queues a message in send queue for sending to the service
*
* @param controller the handle to the controller
* @param msg the message to queue
+ * @deprecated
*/
void
GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
struct GNUNET_MessageHeader *msg);
+/**
+ * Inserts the given operation context into the operation context map of the
+ * given controller. Creates the operation context map if one does not exist
+ * for the controller
+ *
+ * @param c the controller
+ * @param opc the operation context to be inserted
+ */
+void
+GNUNET_TESTBED_insert_opc_ (struct GNUNET_TESTBED_Controller *c,
+ struct OperationContext *opc);
+
+
+/**
+ * Removes the given operation context from the operation context map of the
+ * given controller
+ *
+ * @param c the controller
+ * @param opc the operation context to remove
+ */
+void
+GNUNET_TESTBED_remove_opc_ (const struct GNUNET_TESTBED_Controller *c,
+ struct OperationContext *opc);
+
+
/**
* Compresses given configuration using zlib compress
*
* @return the size of the xconfig
*/
size_t
-GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
+GNUNET_TESTBED_compress_config_ (const char *config,
+ size_t size,
char **xconfig);
/**
- * Adds an operation to the queue of operations
+ * Function to serialize and compress using zlib a configuration through a
+ * configuration handle
*
- * @param op the operation to add
+ * @param cfg the configuration
+ * @param size the size of configuration when serialize. Will be set on success.
+ * @param xsize the sizeo of the compressed configuration. Will be set on success.
+ * @return the serialized and compressed configuration
*/
-void
-GNUNET_TESTBED_operation_add_ (struct GNUNET_TESTBED_Operation *op);
+char *
+GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ size_t *size,
+ size_t *xsize);
/**
* @return the initialization message
*/
struct GNUNET_TESTBED_HelperInit *
-GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, const char *hostname,
- const struct GNUNET_CONFIGURATION_Handle
- *cfg);
+GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
+ const char *hostname,
+ const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* operation
*/
struct OperationContext *
-GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
- *controller, uint64_t operation_id,
+GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller *controller,
+ uint64_t operation_id,
const struct GNUNET_MessageHeader *msg,
- GNUNET_CLIENT_MessageHandler cc,
+ GNUNET_MQ_MessageCallback cc,
void *cc_cls);
/**
/**
* Generates configuration by uncompressing configuration in given message. The
* given message should be of the following types:
- * GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
- * GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
+ * #GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
+ * #GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
*
* @param msg the message containing compressed configuration
* @return handle to the parsed configuration
* @return the error message
*/
const char *
-GNUNET_TESTBED_parse_error_string_ (const struct
- GNUNET_TESTBED_OperationFailureEventMessage
- *msg);
+GNUNET_TESTBED_parse_error_string_ (const struct GNUNET_TESTBED_OperationFailureEventMessage *msg);
/**
uint32_t slave_host_id);
+
/**
- * Same as the GNUNET_TESTBED_controller_link_2, but with ids for delegated host
- * and slave host
+ * Initialise a barrier and call the given callback when the required percentage
+ * of peers (quorum) reach the barrier OR upon error.
*
- * @param op_cls the operation closure for the event which is generated to
- * signal success or failure of this operation
- * @param master handle to the master controller who creates the association
- * @param delegated_host_id id of the host to which requests should be delegated
- * @param slave_host_id id of the host which is used to run the slave controller
- * @param sxcfg serialized and compressed configuration
- * @param sxcfg_size the size sxcfg
- * @param scfg_size the size of uncompressed serialized configuration
- * @param is_subordinate GNUNET_YES if the controller at delegated_host should
- * be started by the slave controller; GNUNET_NO if the slave
- * controller has to connect to the already started delegated
- * controller via TCP/IP
- * @return the operation handle
+ * @param controller the handle to the controller
+ * @param name identification name of the barrier
+ * @param quorum the percentage of peers that is required to reach the barrier.
+ * Peers signal reaching a barrier by calling
+ * GNUNET_TESTBED_barrier_reached().
+ * @param cb the callback to call when the barrier is reached or upon error.
+ * Cannot be NULL.
+ * @param cls closure for the above callback
+ * @param echo #GNUNET_YES to echo the barrier crossed status message back to the
+ * controller
+ * @return barrier handle; NULL upon error
*/
-struct GNUNET_TESTBED_Operation *
-GNUNET_TESTBED_controller_link_2_ (void *op_cls,
- struct GNUNET_TESTBED_Controller *master,
- uint32_t delegated_host_id,
- uint32_t slave_host_id, const char *sxcfg,
- size_t sxcfg_size, size_t scfg_size,
- int is_subordinate);
+struct GNUNET_TESTBED_Barrier *
+GNUNET_TESTBED_barrier_init_ (struct GNUNET_TESTBED_Controller *controller,
+ const char *name,
+ unsigned int quorum,
+ GNUNET_TESTBED_barrier_status_cb cb,
+ void *cls,
+ int echo);
/**
- * Same as the GNUNET_TESTBED_controller_link, but with ids for delegated host
- * and slave host
+ * Remove a barrier and it was the last one in the barrier hash map, destroy the
+ * hash map
*
- * @param op_cls the operation closure for the event which is generated to
- * signal success or failure of this operation
- * @param master handle to the master controller who creates the association
- * @param delegated_host_id id of the host to which requests should be
- * delegated; cannot be NULL
- * @param slave_host_id id of the host which should connect to controller
- * running on delegated host ; use NULL to make the master controller
- * connect to the delegated host
- * @param slave_cfg configuration to use for the slave controller
- * @param is_subordinate GNUNET_YES if the controller at delegated_host should
- * be started by the slave controller; GNUNET_NO if the slave
- * controller has to connect to the already started delegated
- * controller via TCP/IP
- * @return the operation handle
+ * @param barrier the barrier to remove
*/
-struct GNUNET_TESTBED_Operation *
-GNUNET_TESTBED_controller_link_ (void *op_cls,
- struct GNUNET_TESTBED_Controller *master,
- uint32_t delegated_host_id,
- uint32_t slave_host_id,
- const struct GNUNET_CONFIGURATION_Handle
- *slave_cfg, int is_subordinate);
-
+void
+GNUNET_TESTBED_barrier_remove_ (struct GNUNET_TESTBED_Barrier *barrier);
projects / oweals / gnunet.git / blobdiff