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 #include "gnunet_testbed_service.h"
  31 #include "testbed.h"
  32 #include "testbed_helper.h"
  33
  34 /**
  35  * Testbed Helper binary name
  36  */
  37 #define HELPER_TESTBED_BINARY "gnunet-helper-testbed"
  38
  39
  40 /**
  41  * Enumeration of operations
  42  */
  43 enum OperationType
  44 {
  45     /**
  46      * Peer create operation
  47      */
  48   OP_PEER_CREATE,
  49
  50     /**
  51      * Peer start operation
  52      */
  53   OP_PEER_START,
  54
  55     /**
  56      * Peer stop operation
  57      */
  58   OP_PEER_STOP,
  59
  60     /**
  61      * Peer destroy operation
  62      */
  63   OP_PEER_DESTROY,
  64
  65     /**
  66      * Get peer information operation
  67      */
  68   OP_PEER_INFO,
  69
  70     /**
  71      * Overlay connection operation
  72      */
  73   OP_OVERLAY_CONNECT,
  74
  75     /**
  76      * Forwarded operation
  77      */
  78   OP_FORWARDED,
  79
  80     /**
  81      * Link controllers operation
  82      */
  83   OP_LINK_CONTROLLERS,
  84
  85   /**
  86    * Get slave config operation
  87    */
  88   OP_GET_SLAVE_CONFIG
  89 };
  90
  91
  92 /**
  93  * The message queue for sending messages to the controller service
  94  */
  95 struct MessageQueue;
  96
  97
  98 /**
  99  * Enumeration of states of OperationContext
 100  */
 101 enum OperationContextState
 102 {
 103     /**
 104      * The initial state where the associated operation has just been created
 105      * and is waiting in the operation queues to be started
 106      */
 107   OPC_STATE_INIT = 0,
 108
 109     /**
 110      * The operation has been started. It may occupy some resources which are to
 111      * be freed if cancelled.
 112      */
 113   OPC_STATE_STARTED,
 114
 115     /**
 116      * The operation has finished. The end results of this operation may occupy
 117      * some resources which are to be freed by operation_done
 118      */
 119   OPC_STATE_FINISHED
 120 };
 121
 122
 123 /**
 124  * Context information for GNUNET_TESTBED_Operation
 125  */
 126 struct OperationContext
 127 {
 128   /**
 129    * next ptr for DLL
 130    */
 131   struct OperationContext *next;
 132
 133   /**
 134    * prev ptr for DLL
 135    */
 136   struct OperationContext *prev;
 137
 138   /**
 139    * The controller to which this operation context belongs to
 140    */
 141   struct GNUNET_TESTBED_Controller *c;
 142
 143   /**
 144    * The operation
 145    */
 146   struct GNUNET_TESTBED_Operation *op;
 147
 148   /**
 149    * The operation closure
 150    */
 151   void *op_cls;
 152
 153   /**
 154    * Data relevant to the operation
 155    */
 156   void *data;
 157
 158   /**
 159    * The id of the opearation
 160    */
 161   uint64_t id;
 162
 163   /**
 164    * The type of operation
 165    */
 166   enum OperationType type;
 167
 168   /**
 169    * The state of the operation
 170    */
 171   enum OperationContextState state;
 172 };
 173
 174
 175 /**
 176  * Handle to interact with a GNUnet testbed controller.  Each
 177  * controller has at least one master handle which is created when the
 178  * controller is created; this master handle interacts with the
 179  * controller process, destroying it destroys the controller (by
 180  * closing stdin of the controller process).  Additionally,
 181  * controllers can interact with each other (in a P2P fashion); those
 182  * links are established via TCP/IP on the controller's service port.
 183  */
 184 struct GNUNET_TESTBED_Controller
 185 {
 186   /**
 187    * The host where the controller is running
 188    */
 189   struct GNUNET_TESTBED_Host *host;
 190
 191   /**
 192    * The controller callback
 193    */
 194   GNUNET_TESTBED_ControllerCallback cc;
 195
 196   /**
 197    * The closure for controller callback
 198    */
 199   void *cc_cls;
 200
 201   /**
 202    * The configuration to use while connecting to controller
 203    */
 204   struct GNUNET_CONFIGURATION_Handle *cfg;
 205
 206   /**
 207    * The client connection handle to the controller service
 208    */
 209   struct GNUNET_CLIENT_Connection *client;
 210
 211   /**
 212    * The head of the message queue
 213    */
 214   struct MessageQueue *mq_head;
 215
 216   /**
 217    * The tail of the message queue
 218    */
 219   struct MessageQueue *mq_tail;
 220
 221   /**
 222    * The client transmit handle
 223    */
 224   struct GNUNET_CLIENT_TransmitHandle *th;
 225
 226   /**
 227    * The host registration handle; NULL if no current registration requests are
 228    * present
 229    */
 230   struct GNUNET_TESTBED_HostRegistrationHandle *rh;
 231
 232   /**
 233    * The head of the opeartion context queue
 234    */
 235   struct OperationContext *ocq_head;
 236
 237   /**
 238    * The tail of the operation context queue
 239    */
 240   struct OperationContext *ocq_tail;
 241
 242   /**
 243    * Operation queue for simultaneous operations
 244    */
 245   struct OperationQueue *opq_parallel_operations;
 246
 247   /**
 248    * Operation queue for simultaneous service connections
 249    */
 250   struct OperationQueue *opq_parallel_service_connections;
 251
 252   /**
 253    * Operation queue for simultaneous topology configuration operations
 254    */
 255   struct OperationQueue *opq_parallel_topology_config_operations;
 256
 257   /**
 258    * The controller event mask
 259    */
 260   uint64_t event_mask;
 261
 262   /**
 263    * Did we start the receive loop yet?
 264    */
 265   int in_receive;
 266
 267   /**
 268    * Did we create the host for this?
 269    */
 270   int aux_host;
 271
 272   /**
 273    * The operation id counter. use current value and increment
 274    */
 275   uint32_t operation_counter;
 276
 277 };
 278
 279
 280 /**
 281  * Queues a message in send queue for sending to the service
 282  *
 283  * @param controller the handle to the controller
 284  * @param msg the message to queue
 285  */
 286 void
 287 GNUNET_TESTBED_queue_message_ (struct GNUNET_TESTBED_Controller *controller,
 288                                struct GNUNET_MessageHeader *msg);
 289
 290
 291 /**
 292  * Compresses given configuration using zlib compress
 293  *
 294  * @param config the serialized configuration
 295  * @param size the size of config
 296  * @param xconfig will be set to the compressed configuration (memory is fresly
 297  *          allocated)
 298  * @return the size of the xconfig
 299  */
 300 size_t
 301 GNUNET_TESTBED_compress_config_ (const char *config, size_t size,
 302                                  char **xconfig);
 303
 304
 305 /**
 306  * Function to serialize and compress using zlib a configuration through a
 307  * configuration handle
 308  *
 309  * @param cfg the configuration
 310  * @param size the size of configuration when serialize.  Will be set on success.
 311  * @param xsize the sizeo of the compressed configuration.  Will be set on success.
 312  * @return the serialized and compressed configuration
 313  */
 314 char *
 315 GNUNET_TESTBED_compress_cfg_ (const struct GNUNET_CONFIGURATION_Handle *cfg,
 316                               size_t *size, size_t *xsize);
 317
 318
 319 /**
 320  * Adds an operation to the queue of operations
 321  *
 322  * @param op the operation to add
 323  */
 324 void
 325 GNUNET_TESTBED_operation_add_ (struct GNUNET_TESTBED_Operation *op);
 326
 327
 328 /**
 329  * Creates a helper initialization message. This function is here because we
 330  * want to use this in testing
 331  *
 332  * @param trusted_ip the ip address of the controller which will be set as TRUSTED
 333  *          HOST(all connections form this ip are permitted by the testbed) when
 334  *          starting testbed controller at host. This can either be a single ip
 335  *          address or a network address in CIDR notation.
 336  * @param hostname the hostname of the destination this message is intended for
 337  * @param cfg the configuration that has to used to start the testbed service
 338  *          thru helper
 339  * @return the initialization message
 340  */
 341 struct GNUNET_TESTBED_HelperInit *
 342 GNUNET_TESTBED_create_helper_init_msg_ (const char *cname, const char *hostname,
 343                                         const struct GNUNET_CONFIGURATION_Handle
 344                                         *cfg);
 345
 346
 347 /**
 348  * Sends the given message as an operation. The given callback is called when a
 349  * reply for the operation is available.  Call
 350  * GNUNET_TESTBED_forward_operation_msg_cancel_() to cleanup the returned
 351  * operation context if the cc hasn't been called
 352  *
 353  * @param controller the controller to which the message has to be sent
 354  * @param operation_id the operation id of the message
 355  * @param msg the message to send
 356  * @param cc the callback to call when reply is available
 357  * @param cc_cls the closure for the above callback
 358  * @return the operation context which can be used to cancel the forwarded
 359  *           operation
 360  */
 361 struct OperationContext *
 362 GNUNET_TESTBED_forward_operation_msg_ (struct GNUNET_TESTBED_Controller
 363                                        *controller, uint64_t operation_id,
 364                                        const struct GNUNET_MessageHeader *msg,
 365                                        GNUNET_CLIENT_MessageHandler cc,
 366                                        void *cc_cls);
 367
 368 /**
 369  * Function to cancel an operation created by simply forwarding an operation
 370  * message.
 371  *
 372  * @param opc the operation context from GNUNET_TESTBED_forward_operation_msg_()
 373  */
 374 void
 375 GNUNET_TESTBED_forward_operation_msg_cancel_ (struct OperationContext *opc);
 376
 377
 378 /**
 379  * Generates configuration by uncompressing configuration in given message. The
 380  * given message should be of the following types:
 381  * GNUNET_MESSAGE_TYPE_TESTBED_PEERCONFIG,
 382  * GNUNET_MESSAGE_TYPE_TESTBED_SLAVECONFIG
 383  *
 384  * @param msg the message containing compressed configuration
 385  * @return handle to the parsed configuration
 386  */
 387 struct GNUNET_CONFIGURATION_Handle *
 388 GNUNET_TESTBED_extract_config_ (const struct GNUNET_MessageHeader *msg);
 389
 390
 391 /**
 392  * Checks the integrity of the OpeationFailureEventMessage and if good returns
 393  * the error message it contains.
 394  *
 395  * @param msg the OperationFailureEventMessage
 396  * @return the error message
 397  */
 398 const char *
 399 GNUNET_TESTBED_parse_error_string_ (const struct
 400                                     GNUNET_TESTBED_OperationFailureEventMessage
 401                                     *msg);
 402
 403
 404 /**
 405  * Function to return the operation id for a controller. The operation id is
 406  * created from the controllers host id and its internal operation counter.
 407  *
 408  * @param controller the handle to the controller whose operation id has to be incremented
 409  * @return the incremented operation id.
 410  */
 411 uint64_t
 412 GNUNET_TESTBED_get_next_op_id (struct GNUNET_TESTBED_Controller *controller);
 413
 414
 415 /**
 416  * Like GNUNET_TESTBED_get_slave_config(), however without the host registration
 417  * check. Another difference is that this function takes the id of the slave
 418  * host.
 419  *
 420  * @param op_cls the closure for the operation
 421  * @param master the handle to master controller
 422  * @param slave_host_id id of the host where the slave controller is running to
 423  *          the slave_host should remain valid until this operation is cancelled
 424  *          or marked as finished
 425  * @return the operation handle;
 426  */
 427 struct GNUNET_TESTBED_Operation *
 428 GNUNET_TESTBED_get_slave_config_ (void *op_cls,
 429                                   struct GNUNET_TESTBED_Controller *master,
 430                                   uint32_t slave_host_id);
 431
 432
 433 /**
 434  * Same as the GNUNET_TESTBED_controller_link_2, but with ids for delegated host
 435  * and slave host
 436  *
 437  * @param op_cls the operation closure for the event which is generated to
 438  *          signal success or failure of this operation
 439  * @param master handle to the master controller who creates the association
 440  * @param delegated_host_id id of the host to which requests should be delegated
 441  * @param slave_host_id id of the host which is used to run the slave controller
 442  * @param sxcfg serialized and compressed configuration
 443  * @param sxcfg_size the size sxcfg
 444  * @param scfg_size the size of uncompressed serialized configuration
 445  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
 446  *          be started by the slave controller; GNUNET_NO if the slave
 447  *          controller has to connect to the already started delegated
 448  *          controller via TCP/IP
 449  * @return the operation handle
 450  */
 451 struct GNUNET_TESTBED_Operation *
 452 GNUNET_TESTBED_controller_link_2_ (void *op_cls,
 453                                    struct GNUNET_TESTBED_Controller *master,
 454                                    uint32_t delegated_host_id,
 455                                    uint32_t slave_host_id, const char *sxcfg,
 456                                    size_t sxcfg_size, size_t scfg_size,
 457                                    int is_subordinate);
 458
 459
 460 /**
 461  * Same as the GNUNET_TESTBED_controller_link, but with ids for delegated host
 462  * and slave host
 463  *
 464  * @param op_cls the operation closure for the event which is generated to
 465  *          signal success or failure of this operation
 466  * @param master handle to the master controller who creates the association
 467  * @param delegated_host_id id of the host to which requests should be
 468  *          delegated; cannot be NULL
 469  * @param slave_host_id id of the host which should connect to controller
 470  *          running on delegated host ; use NULL to make the master controller
 471  *          connect to the delegated host
 472  * @param slave_cfg configuration to use for the slave controller
 473  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
 474  *          be started by the slave controller; GNUNET_NO if the slave
 475  *          controller has to connect to the already started delegated
 476  *          controller via TCP/IP
 477  * @return the operation handle
 478  */
 479 struct GNUNET_TESTBED_Operation *
 480 GNUNET_TESTBED_controller_link_ (void *op_cls,
 481                                  struct GNUNET_TESTBED_Controller *master,
 482                                  uint32_t delegated_host_id,
 483                                  uint32_t slave_host_id,
 484                                  const struct GNUNET_CONFIGURATION_Handle
 485                                  *slave_cfg, int is_subordinate);
 486
 487
 488
 489
 490 #endif
 491 /* end of testbed_api.h */