topology option support for GNUNET_TESTBED_run() via configuration

[oweals/gnunet.git] / src / testbed / testbed_api.h

diff --git a/src/testbed/testbed_api.h b/src/testbed/testbed_api.h
index 020d951a2648af5cd0bdf0f24bf2cd2ff257abe1..f492133e2113f2a19bd18293ace58b76ee2ec270 100644 (file)
--- a/src/testbed/testbed_api.h
+++ b/src/testbed/testbed_api.h
@@ -30,6 +30,13 @@
 #include "gnunet_testbed_service.h"
 #include "testbed.h"
 
+
+/**
+ * Testbed Helper binary name
+ */
+#define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
+
+
 /**
  * Enumeration of operations
  */
@@ -83,43 +90,6 @@ enum OperationType
 };
 
 
-/**
- * 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;
-
-  /**
-   * The ID for the operation;
-   */
-  uint64_t operation_id;
-
-  /**
-   * The type of operation
-   */
-  enum OperationType type;
-
-  /**
-   * Data specific to OperationType
-   */
-  void *data;
-};
-
-
 /**
  * The message queue for sending messages to the controller service
  */
@@ -181,6 +151,11 @@ struct OperationContext
    */
   struct GNUNET_TESTBED_Operation *op;
 
+  /**
+   * The operation closure
+   */
+  void *op_cls;
+
   /**
    * Data relevant to the operation
    */
@@ -296,10 +271,15 @@ struct GNUNET_TESTBED_Controller
    */
   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
@@ -424,5 +404,90 @@ 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 */