#define TESTBED_API_H
#include "gnunet_testbed_service.h"
+#include "testbed.h"
+
+
+/**
+ * Testbed Helper binary name
+ */
+#define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
+
/**
* Enumeration of operations
*/
enum OperationType
- {
+{
/**
* Peer create operation
*/
- OP_PEER_CREATE,
-
+ OP_PEER_CREATE,
+
/**
* Peer start operation
*/
- OP_PEER_START,
+ OP_PEER_START,
/**
* Peer stop operation
*/
- OP_PEER_STOP,
+ OP_PEER_STOP,
/**
* Peer destroy operation
*/
- OP_PEER_DESTROY,
+ OP_PEER_DESTROY,
/**
* Get peer information operation
*/
- OP_PEER_INFO,
+ OP_PEER_INFO,
/**
* Overlay connection operation
*/
- OP_OVERLAY_CONNECT,
+ OP_OVERLAY_CONNECT,
/**
* Forwarded operation
*/
- OP_FORWARDED,
+ OP_FORWARDED,
/**
* Link controllers operation
*/
- OP_LINK_CONTROLLERS,
-
- /**
- * Service connect operation
- */
- OP_SERVICE_CONNECT
-
- };
-
-
-/**
- * Testbed operation structure
- */
-struct GNUNET_TESTBED_Operation
-{
- /**
- * next pointer for DLL
- */
- struct GNUNET_TESTBED_Operation *next;
-
- /**
- * prev pointer for DLL
- */
- struct GNUNET_TESTBED_Operation *prev;
-
- /**
- * The controller on which this operation operates
- */
- struct GNUNET_TESTBED_Controller *controller;
+ OP_LINK_CONTROLLERS,
/**
- * The ID for the operation;
+ * Get slave config operation
*/
- uint64_t operation_id;
-
- /**
- * The type of operation
- */
- enum OperationType type;
+ OP_GET_SLAVE_CONFIG
- /**
- * Data specific to OperationType
- */
- void *data;
};
* Enumeration of states of OperationContext
*/
enum OperationContextState
- {
+{
/**
* 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,
-
+ OPC_STATE_INIT = 0,
+
/**
* The operation has been started. It may occupy some resources which are to
* be freed if cancelled.
*/
- OPC_STATE_STARTED,
+ 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
*/
- OPC_STATE_FINISHED
- };
+ OPC_STATE_FINISHED
+};
/**
*/
struct GNUNET_TESTBED_Operation *op;
+ /**
+ * The operation closure
+ */
+ void *op_cls;
+
/**
* Data relevant to the operation
*/
* The client connection handle to the controller service
*/
struct GNUNET_CLIENT_Connection *client;
-
+
/**
* The head of the message queue
*/
/**
* The host registration handle; NULL if no current registration requests are
- * present
+ * present
*/
struct GNUNET_TESTBED_HostRegistrationHandle *rh;
*/
struct OperationQueue *opq_parallel_service_connections;
+ /**
+ * Operation queue for simultaneous topology configuration operations
+ */
+ struct OperationQueue *opq_parallel_topology_config_operations;
+
+ /**
+ * Operation queue for simultaneous overlay connect operations
+ */
+ struct OperationQueue *opq_parallel_overlay_connect_operations;
+
/**
* The operation id counter. use current value and increment
*/
- uint64_t operation_counter;
-
+ uint32_t operation_counter;
+
/**
* The controller event mask
*/
*/
void
GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
- struct GNUNET_MessageHeader *msg);
+ struct GNUNET_MessageHeader *msg);
/**
* @param config the serialized configuration
* @param size the size of config
* @param xconfig will be set to the compressed configuration (memory is fresly
- * allocated)
+ * allocated)
* @return the size of the xconfig
*/
size_t
GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
- char **xconfig);
+ char **xconfig);
/**
* Creates a helper initialization message. Only for testing.
*
* @param cname the ip address of the controlling host
+ * @param hostname the hostname of the destination this message is intended for
* @param cfg the configuration that has to used to start the testbed service
* thru helper
* @return the initialization message
*/
struct GNUNET_TESTBED_HelperInit *
GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
- const struct
- GNUNET_CONFIGURATION_Handle *cfg);
+ const char *hostname,
+ const struct GNUNET_CONFIGURATION_Handle
+ *cfg);
/**
* @param cc the callback to call when reply is available
* @param cc_cls the closure for the above callback
* @return the operation context which can be used to cancel the forwarded
- * operation
+ * operation
*/
struct OperationContext *
GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
- * controller,
- uint64_t operation_id,
+ *controller, uint64_t operation_id,
const struct GNUNET_MessageHeader *msg,
GNUNET_CLIENT_MessageHandler cc,
void *cc_cls);
GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc);
+/**
+ * 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
+ *
+ * @param msg the message containing compressed configuration
+ * @return handle to the parsed configuration
+ */
+struct GNUNET_CONFIGURATION_Handle *
+GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg);
+
+
+/**
+ * Checks the integrity of the OpeationFailureEventMessage and if good returns
+ * the error message it contains.
+ *
+ * @param msg the OperationFailureEventMessage
+ * @return the error message
+ */
+const char *
+GNUNET_TESTBED_parse_error_string_ (const struct
+ GNUNET_TESTBED_OperationFailureEventMessage
+ *msg);
+
+
+/**
+ * Function to return the operation id for a controller. The operation id is
+ * created from the controllers host id and its internal operation counter.
+ *
+ * @param controller the handle to the controller whose operation id has to be incremented
+ * @return the incremented operation id.
+ */
+uint64_t
+GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller *controller);
+
+
+/**
+ * Like GNUNET_TESTBED_get_slave_config(), however without the host registration
+ * check. Another difference is that this function takes the id of the slave
+ * host.
+ *
+ * @param op_cls the closure for the operation
+ * @param master the handle to master controller
+ * @param slave_host_id id of the host where the slave controller is running to
+ * the slave_host should remain valid until this operation is cancelled
+ * or marked as finished
+ * @return the operation handle;
+ */
+struct GNUNET_TESTBED_Operation *
+GNUNET_TESTBED_get_slave_config_ (void *op_cls,
+ struct GNUNET_TESTBED_Controller *master,
+ uint32_t slave_host_id);
+
+
+/**
+ * Same as the GNUNET_TESTBED_controller_link_2, but with ids for delegated host
+ * and slave host
+ *
+ * @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
+ */
+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);
+
+
+/**
+ * Same as the GNUNET_TESTBED_controller_link, but with ids for delegated host
+ * and slave host
+ *
+ * @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
+ */
+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);
+
#endif
/* end of testbed_api.h */
projects / oweals / gnunet.git / blobdiff