-more datacache integration work
[oweals/gnunet.git] / src / testbed / testbed_api.h
index 45815c057a32cfb6c4b37733b1151ce6cd9426ab..f3edf6b3da2093451d682d6e6171ee68697d8be8 100644 (file)
@@ -1,6 +1,6 @@
 /*
       This file is part of GNUnet
-      (C) 2012 Christian Grothoff (and other contributing authors)
+      Copyright (C) 2008--2013 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
 #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
+ */
+#define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
+
 
 /**
  * Enumeration of operations
@@ -60,6 +68,11 @@ enum OperationType
      */
   OP_PEER_INFO,
 
+  /**
+   * Reconfigure a peer
+   */
+  OP_PEER_RECONFIGURE,
+
     /**
      * Overlay connection operation
      */
@@ -78,45 +91,17 @@ enum OperationType
   /**
    * Get slave config operation
    */
-  OP_GET_SLAVE_CONFIG
-
-};
-
-
-/**
- * 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;
+  OP_GET_SLAVE_CONFIG,
 
   /**
-   * The type of operation
+   * Stop and destroy all peers
    */
-  enum OperationType type;
+  OP_SHUTDOWN_PEERS,
 
   /**
-   * Data specific to OperationType
+   * Start/stop service at a peer
    */
-  void *data;
+  OP_MANAGE_SERVICE
 };
 
 
@@ -125,11 +110,6 @@ struct GNUNET_TESTBED_Operation
  */
 struct MessageQueue;
 
-/**
- * Structure for a controller link
- */
-struct ControllerLink;
-
 
 /**
  * Enumeration of states of OperationContext
@@ -161,16 +141,6 @@ enum OperationContextState
  */
 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
    */
@@ -181,6 +151,11 @@ struct OperationContext
    */
   struct GNUNET_TESTBED_Operation *op;
 
+  /**
+   * The operation closure
+   */
+  void *op_cls;
+
   /**
    * Data relevant to the operation
    */
@@ -203,6 +178,14 @@ struct OperationContext
 };
 
 
+/**
+ * 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
@@ -214,7 +197,6 @@ struct OperationContext
  */
 struct GNUNET_TESTBED_Controller
 {
-
   /**
    * The host where the controller is running
    */
@@ -250,16 +232,6 @@ struct GNUNET_TESTBED_Controller
    */
   struct MessageQueue *mq_tail;
 
-  /**
-   * The head of the ControllerLink list
-   */
-  struct ControllerLink *cl_head;
-
-  /**
-   * The tail of the ControllerLink list
-   */
-  struct ControllerLink *cl_tail;
-
   /**
    * The client transmit handle
    */
@@ -272,14 +244,19 @@ struct GNUNET_TESTBED_Controller
   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 
   /**
-   * The head of the opeartion context queue
+   * The map of active operation contexts
    */
-  struct OperationContext *ocq_head;
+  struct GNUNET_CONTAINER_MultiHashMap32 *opc_map;
 
   /**
-   * The tail of the operation context queue
+   * If this callback is not NULL, schedule it as a task when opc_map gets empty
    */
-  struct OperationContext *ocq_tail;
+  TESTBED_opcq_empty_cb opcq_empty_cb;
+
+  /**
+   * Closure for the above task
+   */
+  void *opcq_empty_cls;
 
   /**
    * Operation queue for simultaneous operations
@@ -296,11 +273,6 @@ struct GNUNET_TESTBED_Controller
    */
   struct OperationQueue *opq_parallel_topology_config_operations;
 
-  /**
-   * The operation id counter. use current value and increment
-   */
-  uint32_t operation_counter;
-
   /**
    * The controller event mask
    */
@@ -312,9 +284,10 @@ struct GNUNET_TESTBED_Controller
   int in_receive;
 
   /**
-   * Did we create the host for this?
+   * The operation id counter. use current value and increment
    */
-  int aux_host;
+  uint32_t operation_counter;
+
 };
 
 
@@ -329,6 +302,31 @@ 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
  *
@@ -344,26 +342,34 @@ GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
 
 
 /**
- * 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);
 
 
 /**
- * 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,
-                                       const char *hostname,
+GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, const char *hostname,
                                         const struct GNUNET_CONFIGURATION_Handle
                                         *cfg);
 
@@ -443,9 +449,9 @@ GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller *controller);
  *
  * @param op_cls the closure for the operation
  * @param master the handle to master controller
- * @param slave_host the host where the slave controller is running; the handle
- *          to the slave_host should remain valid until this operation is
- *          cancelled or marked as finished
+ * @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 *
@@ -453,5 +459,24 @@ GNUNET_TESTBED_get_slave_config_ (void *op_cls,
                                   struct GNUNET_TESTBED_Controller *master,
                                   uint32_t slave_host_id);
 
+
+/**
+ * Handler for GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS messages.  This
+ * function is defined in @file testbed_api_barriers.c
+ *
+ * @param c the controller handle to determine the connection this message
+ *   belongs to
+ * @param msg the barrier status message
+ * @return GNUNET_OK to keep the connection active; GNUNET_SYSERR to tear it
+ *   down signalling an error
+ */
+int
+GNUNET_TESTBED_handle_barrier_status_ (struct GNUNET_TESTBED_Controller *c,
+                                       const struct GNUNET_TESTBED_BarrierStatusMsg
+                                       *msg);
+
+
+
+
 #endif
 /* end of testbed_api.h */