src/testbed/testbed_api.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2012 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 3, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * @file testbed/testbed_api.h
  23  * @brief Interface for functions internally exported from testbed_api.c
  24  * @author Sree Harsha Totakura
  25  */
  26
  27 #ifndef TESTBED_API_H
  28 #define TESTBED_API_H
  29
  30
  31 /**
  32  * Enumeration of operations
  33  */
  34 enum OperationType
  35   {
  36     /**
  37      * Peer create operation
  38      */
  39     OP_PEER_CREATE,
  40
  41     /**
  42      * Peer start operation
  43      */
  44     OP_PEER_START,
  45
  46     /**
  47      * Peer stop operation
  48      */
  49     OP_PEER_STOP,
  50
  51     /**
  52      * Peer destroy operation
  53      */
  54     OP_PEER_DESTROY,
  55
  56     /**
  57      * Get peer information operation
  58      */
  59     OP_PEER_INFO,
  60
  61     /**
  62      * Overlay connection operation
  63      */
  64     OP_OVERLAY_CONNECT,
  65
  66   };
  67
  68
  69 /**
  70  * Testbed operation structure
  71  */
  72 struct GNUNET_TESTBED_Operation
  73 {
  74   /**
  75    * next pointer for DLL
  76    */
  77   struct GNUNET_TESTBED_Operation *next;
  78
  79   /**
  80    * prev pointer for DLL
  81    */
  82   struct GNUNET_TESTBED_Operation *prev;
  83
  84   /**
  85    * The controller on which this operation operates
  86    */
  87   struct GNUNET_TESTBED_Controller *controller;
  88
  89   /**
  90    * The ID for the operation;
  91    */
  92   uint64_t operation_id;
  93
  94   /**
  95    * The type of operation
  96    */
  97   enum OperationType type;
  98
  99   /**
 100    * Data specific to OperationType
 101    */
 102   void *data;
 103 };
 104
 105
 106 /**
 107  * The message queue for sending messages to the controller service
 108  */
 109 struct MessageQueue;
 110
 111
 112 /**
 113  * Structure for a controller link
 114  */
 115 struct ControllerLink;
 116
 117
 118 /**
 119  * Handle to interact with a GNUnet testbed controller.  Each
 120  * controller has at least one master handle which is created when the
 121  * controller is created; this master handle interacts with the
 122  * controller process, destroying it destroys the controller (by
 123  * closing stdin of the controller process).  Additionally,
 124  * controllers can interact with each other (in a P2P fashion); those
 125  * links are established via TCP/IP on the controller's service port.
 126  */
 127 struct GNUNET_TESTBED_Controller
 128 {
 129
 130   /**
 131    * The host where the controller is running
 132    */
 133   struct GNUNET_TESTBED_Host *host;
 134
 135   /**
 136    * The controller callback
 137    */
 138   GNUNET_TESTBED_ControllerCallback cc;
 139
 140   /**
 141    * The closure for controller callback
 142    */
 143   void *cc_cls;
 144
 145   /**
 146    * The configuration to use while connecting to controller
 147    */
 148   struct GNUNET_CONFIGURATION_Handle *cfg;
 149
 150   /**
 151    * The client connection handle to the controller service
 152    */
 153   struct GNUNET_CLIENT_Connection *client;
 154
 155   /**
 156    * The head of the message queue
 157    */
 158   struct MessageQueue *mq_head;
 159
 160   /**
 161    * The tail of the message queue
 162    */
 163   struct MessageQueue *mq_tail;
 164
 165   /**
 166    * The head of the ControllerLink list
 167    */
 168   struct ControllerLink *cl_head;
 169
 170   /**
 171    * The tail of the ControllerLink list
 172    */
 173   struct ControllerLink *cl_tail;
 174
 175   /**
 176    * The client transmit handle
 177    */
 178   struct GNUNET_CLIENT_TransmitHandle *th;
 179
 180   /**
 181    * The host registration handle; NULL if no current registration requests are
 182    * present
 183    */
 184   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 185
 186   /**
 187    * The head of the operation queue
 188    */
 189   struct GNUNET_TESTBED_Operation *op_head;
 190
 191   /**
 192    * The tail of the operation queue
 193    */
 194   struct GNUNET_TESTBED_Operation *op_tail;
 195
 196   /**
 197    * The operation id counter. use current value and increment
 198    */
 199   uint64_t operation_counter;
 200
 201   /**
 202    * The controller event mask
 203    */
 204   uint64_t event_mask;
 205
 206   /**
 207    * Did we start the receive loop yet?
 208    */
 209   int in_receive;
 210
 211   /**
 212    * Did we create the host for this?
 213    */
 214   int aux_host;
 215 };
 216
 217
 218 /**
 219  * Queues a message in send queue for sending to the service
 220  *
 221  * @param controller the handle to the controller
 222  * @param msg the message to queue
 223  */
 224 void
 225 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
 226                                struct GNUNET_MessageHeader *msg);
 227
 228
 229 /**
 230  * Compresses given configuration using zlib compress
 231  *
 232  * @param config the serialized configuration
 233  * @param size the size of config
 234  * @param xconfig will be set to the compressed configuration (memory is fresly
 235  *          allocated)
 236  * @return the size of the xconfig
 237  */
 238 size_t
 239 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
 240                                  char **xconfig);
 241
 242
 243 /**
 244  * Adds an operation to the queue of operations
 245  *
 246  * @param op the operation to add
 247  */
 248 void
 249 GNUNET_TESTBED_operation_add_ (struct GNUNET_TESTBED_Operation *op);
 250
 251
 252 /**
 253  * Creates a helper initialization message. Only for testing.
 254  *
 255  * @param cname the ip address of the controlling host
 256  * @param cfg the configuration that has to used to start the testbed service
 257  *          thru helper
 258  * @return the initialization message
 259  */
 260 struct GNUNET_TESTBED_HelperInit *
 261 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
 262                                         const struct GNUNET_CONFIGURATION_Handle *cfg);
 263
 264 #endif