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      * Forwarded operation
  68      */
  69     OP_FORWARDED,
  70
  71     /**
  72      * Link controllers operation
  73      */
  74     OP_LINK_CONTROLLERS,
  75
  76   };
  77
  78
  79 /**
  80  * Testbed operation structure
  81  */
  82 struct GNUNET_TESTBED_Operation
  83 {
  84   /**
  85    * next pointer for DLL
  86    */
  87   struct GNUNET_TESTBED_Operation *next;
  88
  89   /**
  90    * prev pointer for DLL
  91    */
  92   struct GNUNET_TESTBED_Operation *prev;
  93
  94   /**
  95    * The controller on which this operation operates
  96    */
  97   struct GNUNET_TESTBED_Controller *controller;
  98
  99   /**
 100    * The ID for the operation;
 101    */
 102   uint64_t operation_id;
 103
 104   /**
 105    * The type of operation
 106    */
 107   enum OperationType type;
 108
 109   /**
 110    * Data specific to OperationType
 111    */
 112   void *data;
 113 };
 114
 115
 116 /**
 117  * The message queue for sending messages to the controller service
 118  */
 119 struct MessageQueue;
 120
 121 /**
 122  * Structure for a controller link
 123  */
 124 struct ControllerLink;
 125
 126
 127 /**
 128  * Enumeration of states of OperationContext
 129  */
 130 enum OperationContextState
 131   {
 132     /**
 133      * The initial state where the associated operation has just been created
 134      * and is waiting in the operation queues to be started
 135      */
 136     OPC_STATE_INIT = 0,
 137
 138     /**
 139      * The operation has been started. It may occupy some resources which are to
 140      * be freed if cancelled.
 141      */
 142     OPC_STATE_STARTED,
 143
 144     /**
 145      * The operation has finished. The end results of this operation may occupy
 146      * some resources which are to be freed by operation_done
 147      */
 148     OPC_STATE_FINISHED
 149   };
 150
 151
 152 /**
 153  * Context information for GNUNET_TESTBED_Operation
 154  */
 155 struct OperationContext
 156 {
 157   /**
 158    * next ptr for DLL
 159    */
 160   struct OperationContext *next;
 161
 162   /**
 163    * prev ptr for DLL
 164    */
 165   struct OperationContext *prev;
 166
 167   /**
 168    * The controller to which this operation context belongs to
 169    */
 170   struct GNUNET_TESTBED_Controller *c;
 171
 172   /**
 173    * The operation
 174    */
 175   struct GNUNET_TESTBED_Operation *op;
 176
 177   /**
 178    * Data relevant to the operation
 179    */
 180   void *data;
 181
 182   /**
 183    * The id of the opearation
 184    */
 185   uint64_t id;
 186
 187   /**
 188    * The type of operation
 189    */
 190   enum OperationType type;
 191
 192   /**
 193    * The state of the operation
 194    */
 195   enum OperationContextState state;
 196 };
 197
 198
 199 /**
 200  * Handle to interact with a GNUnet testbed controller.  Each
 201  * controller has at least one master handle which is created when the
 202  * controller is created; this master handle interacts with the
 203  * controller process, destroying it destroys the controller (by
 204  * closing stdin of the controller process).  Additionally,
 205  * controllers can interact with each other (in a P2P fashion); those
 206  * links are established via TCP/IP on the controller's service port.
 207  */
 208 struct GNUNET_TESTBED_Controller
 209 {
 210
 211   /**
 212    * The host where the controller is running
 213    */
 214   struct GNUNET_TESTBED_Host *host;
 215
 216   /**
 217    * The controller callback
 218    */
 219   GNUNET_TESTBED_ControllerCallback cc;
 220
 221   /**
 222    * The closure for controller callback
 223    */
 224   void *cc_cls;
 225
 226   /**
 227    * The configuration to use while connecting to controller
 228    */
 229   struct GNUNET_CONFIGURATION_Handle *cfg;
 230
 231   /**
 232    * The client connection handle to the controller service
 233    */
 234   struct GNUNET_CLIENT_Connection *client;
 235
 236   /**
 237    * The head of the message queue
 238    */
 239   struct MessageQueue *mq_head;
 240
 241   /**
 242    * The tail of the message queue
 243    */
 244   struct MessageQueue *mq_tail;
 245
 246   /**
 247    * The head of the ControllerLink list
 248    */
 249   struct ControllerLink *cl_head;
 250
 251   /**
 252    * The tail of the ControllerLink list
 253    */
 254   struct ControllerLink *cl_tail;
 255
 256   /**
 257    * The client transmit handle
 258    */
 259   struct GNUNET_CLIENT_TransmitHandle *th;
 260
 261   /**
 262    * The host registration handle; NULL if no current registration requests are
 263    * present
 264    */
 265   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 266
 267   /**
 268    * The head of the opeartion context queue
 269    */
 270   struct OperationContext *ocq_head;
 271
 272   /**
 273    * The tail of the operation context queue
 274    */
 275   struct OperationContext *ocq_tail;
 276
 277   /**
 278    * Operation queue for simultaneous peer creations
 279    */
 280   struct OperationQueue *opq_peer_create;
 281
 282   /**
 283    * The operation id counter. use current value and increment
 284    */
 285   uint64_t operation_counter;
 286
 287   /**
 288    * The controller event mask
 289    */
 290   uint64_t event_mask;
 291
 292   /**
 293    * Did we start the receive loop yet?
 294    */
 295   int in_receive;
 296
 297   /**
 298    * Did we create the host for this?
 299    */
 300   int aux_host;
 301 };
 302
 303
 304 /**
 305  * Queues a message in send queue for sending to the service
 306  *
 307  * @param controller the handle to the controller
 308  * @param msg the message to queue
 309  */
 310 void
 311 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
 312                                struct GNUNET_MessageHeader *msg);
 313
 314
 315 /**
 316  * Compresses given configuration using zlib compress
 317  *
 318  * @param config the serialized configuration
 319  * @param size the size of config
 320  * @param xconfig will be set to the compressed configuration (memory is fresly
 321  *          allocated)
 322  * @return the size of the xconfig
 323  */
 324 size_t
 325 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
 326                                  char **xconfig);
 327
 328
 329 /**
 330  * Adds an operation to the queue of operations
 331  *
 332  * @param op the operation to add
 333  */
 334 void
 335 GNUNET_TESTBED_operation_add_ (struct GNUNET_TESTBED_Operation *op);
 336
 337
 338 /**
 339  * Creates a helper initialization message. Only for testing.
 340  *
 341  * @param cname the ip address of the controlling host
 342  * @param cfg the configuration that has to used to start the testbed service
 343  *          thru helper
 344  * @return the initialization message
 345  */
 346 struct GNUNET_TESTBED_HelperInit *
 347 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname,
 348                                         const struct
 349                                         GNUNET_CONFIGURATION_Handle *cfg);
 350
 351
 352 /**
 353  * Sends the given message as an operation. The given callback is called when a
 354  * reply for the operation is available.  Call
 355  * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
 356  * operation context if the cc hasn't been called
 357  *
 358  * @param controller the controller to which the message has to be sent
 359  * @param operation_id the operation id of the message
 360  * @param msg the message to send
 361  * @param cc the callback to call when reply is available
 362  * @param cc_cls the closure for the above callback
 363  * @return the operation context which can be used to cancel the forwarded
 364  *           operation
 365  */
 366 struct OperationContext *
 367 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
 368                                        * controller,
 369                                        uint64_t operation_id,
 370                                        const struct GNUNET_MessageHeader *msg,
 371                                        GNUNET_CLIENT_MessageHandler cc,
 372                                        void *cc_cls);
 373
 374 /**
 375  * Function to cancel an operation created by simply forwarding an operation
 376  * message.
 377  *
 378  * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
 379  */
 380 void
 381 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc);
 382
 383
 384 #endif
 385 /* end of testbed_api.h */