- verboser log, faster start
[oweals/gnunet.git] / src / testbed / testbed_api.h
index 06ab6d5044687924ce0be760c211f6cef8607cb5..26b0d5843fa5b06cf3def7de74f0c0a42cfc42d6 100644 (file)
 #include "gnunet_testbed_service.h"
 #include "testbed.h"
 
+
+/**
+ * Testbed Helper binary name
+ */
+#define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
+
+
 /**
  * Enumeration of operations
  */
@@ -75,43 +82,10 @@ enum OperationType
      */
   OP_LINK_CONTROLLERS,
 
-};
-
-
-/**
- * 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
+   * Get slave config operation
    */
-  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;
+  OP_GET_SLAVE_CONFIG
 };
 
 
@@ -176,6 +150,11 @@ struct OperationContext
    */
   struct GNUNET_TESTBED_Operation *op;
 
+  /**
+   * The operation closure
+   */
+  void *op_cls;
+
   /**
    * Data relevant to the operation
    */
@@ -209,7 +188,6 @@ struct OperationContext
  */
 struct GNUNET_TESTBED_Controller
 {
-
   /**
    * The host where the controller is running
    */
@@ -287,9 +265,9 @@ struct GNUNET_TESTBED_Controller
   struct OperationQueue *opq_parallel_service_connections;
 
   /**
-   * The operation id counter. use current value and increment
+   * Operation queue for simultaneous topology configuration operations
    */
-  uint64_t operation_counter;
+  struct OperationQueue *opq_parallel_topology_config_operations;
 
   /**
    * The controller event mask
@@ -305,6 +283,12 @@ struct GNUNET_TESTBED_Controller
    * Did we create the host for this?
    */
   int aux_host;
+
+  /**
+   * The operation id counter. use current value and increment
+   */
+  uint32_t operation_counter;
+
 };
 
 
@@ -343,15 +327,20 @@ GNUNET_TESTBED_operation_add_ (struct GNUNET_TESTBED_Operation *op);
 
 
 /**
- * Creates a helper initialization message. Only for testing.
+ * Creates a helper initialization message. This function is here because we
+ * want to use this in testing
  *
- * @param cname the ip address of the controlling host
+ * @param trusted_ip the ip address of the controller which will be set as TRUSTED
+ *          HOST(all connections form this ip are permitted by the testbed) when
+ *          starting testbed controller at host. This can either be a single ip
+ *          address or a network address in CIDR notation.
+ * @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,
+GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, const char *hostname,
                                         const struct GNUNET_CONFIGURATION_Handle
                                         *cfg);
 
@@ -388,15 +377,116 @@ GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc);
 
 
 /**
- * Generates configuration by parsing Peer configuration information reply message
+ * 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 peer configuration information message
+ * @param msg the message containing compressed configuration
  * @return handle to the parsed configuration
  */
 struct GNUNET_CONFIGURATION_Handle *
-GNUNET_TESTBED_get_config_from_peerinfo_msg_ (const struct
-                                              GNUNET_TESTBED_PeerConfigurationInformationMessage
-                                              *msg);
+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 */