src/include/gnunet_testbed_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008--2013 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 include/gnunet_testbed_service.h
  23  * @brief API for writing tests and creating large-scale
  24  *        emulation testbeds for GNUnet.
  25  * @author Christian Grothoff
  26  */
  27
  28 #ifndef GNUNET_TESTBED_SERVICE_H
  29 #define GNUNET_TESTBED_SERVICE_H
  30
  31 #include "gnunet_util_lib.h"
  32 #include "gnunet_testing_lib.h"
  33
  34 #ifdef __cplusplus
  35 extern "C"
  36 {
  37 #if 0                           /* keep Emacsens' auto-indent happy */
  38 }
  39 #endif
  40 #endif
  41
  42
  43 /**
  44  * Opaque handle to a host running experiments managed by the testbed framework.
  45  * The master process must be able to SSH to this host without password (via
  46  * ssh-agent).
  47  */
  48 struct GNUNET_TESTBED_Host;
  49
  50 /**
  51  * Opaque handle to a peer controlled by the testbed framework.  A peer runs
  52  * at a particular host.
  53  */
  54 struct GNUNET_TESTBED_Peer;
  55
  56 /**
  57  * Opaque handle to an abstract operation to be executed by the testbed framework.
  58  */
  59 struct GNUNET_TESTBED_Operation;
  60
  61 /**
  62  * Handle to interact with a GNUnet testbed controller.  Each
  63  * controller has at least one master handle which is created when the
  64  * controller is created; this master handle interacts with the
  65  * controller process, destroying it destroys the controller (by
  66  * closing stdin of the controller process).  Additionally,
  67  * controllers can interact with each other (in a P2P fashion); those
  68  * links are established via TCP/IP on the controller's service port.
  69  */
  70 struct GNUNET_TESTBED_Controller;
  71
  72
  73 /**
  74  * Create a host to run peers and controllers on.
  75  *
  76  * @param hostname name of the host, use "NULL" for localhost
  77  * @param username username to use for the login; may be NULL
  78  * @param cfg the configuration to use as a template while starting a controller
  79  *          on this host.  Operation queue sizes specific to a host are also
  80  *          read from this configuration handle
  81  * @param port port number to use for ssh; use 0 to let ssh decide
  82  * @return handle to the host, NULL on error
  83  */
  84 struct GNUNET_TESTBED_Host *
  85 GNUNET_TESTBED_host_create (const char *hostname,
  86                             const char *username,
  87                             const struct GNUNET_CONFIGURATION_Handle *cfg,
  88                             uint16_t port);
  89
  90
  91
  92 /**
  93  * Create a host to run peers and controllers on.  This function is used
  94  * if a peer learns about a host via IPC between controllers (and thus
  95  * some higher-level controller has already determined the unique IDs).
  96  *
  97  * @param id global host ID assigned to the host; 0 is
  98  *        reserved to always mean 'localhost'
  99  * @param hostname name of the host, use "NULL" for localhost
 100  * @param username username to use for the login; may be NULL
 101  * @param cfg the configuration to use as a template while starting a controller
 102  *          on this host.  Operation queue sizes specific to a host are also
 103  *          read from this configuration handle
 104  * @param port port number to use for ssh; use 0 to let ssh decide
 105  * @return handle to the host, NULL on error
 106  */
 107 struct GNUNET_TESTBED_Host *
 108 GNUNET_TESTBED_host_create_with_id (uint32_t id,
 109                                     const char *hostname,
 110                                     const char *username,
 111                                     const struct GNUNET_CONFIGURATION_Handle
 112                                     *cfg,
 113                                     uint16_t port);
 114
 115
 116 /**
 117  * Load a set of hosts from a configuration file.
 118  *
 119  * @param filename file with the host specification
 120  * @param cfg the configuration to use as a template while starting a controller
 121  *          on any of the loaded hosts.  Operation queue sizes specific to a host
 122  *          are also read from this configuration handle
 123  * @param hosts set to the hosts found in the file; caller must free this if
 124  *          number of hosts returned is greater than 0
 125  * @return number of hosts returned in 'hosts', 0 on error
 126  */
 127 unsigned int
 128 GNUNET_TESTBED_hosts_load_from_file (const char *filename,
 129                                      const struct GNUNET_CONFIGURATION_Handle
 130                                      *cfg,
 131                                      struct GNUNET_TESTBED_Host ***hosts);
 132
 133
 134 /**
 135  * Loads the set of host allocated by the LoadLeveler Job Scheduler.  This
 136  * function is only available when compiled with support for LoadLeveler and is
 137  * used for running on the SuperMUC
 138  *
 139  * @param cfg the configuration to use as a template while starting a controller
 140  *          on any of the loaded hosts.  Operation queue sizes specific to a host
 141  *          are also read from this configuration handle
 142  * @param hosts set to the hosts found in the file; caller must free this if
 143  *          number of hosts returned is greater than 0
 144  * @return number of hosts returned in 'hosts', 0 on error
 145  */
 146 unsigned int
 147 GNUNET_TESTBED_hosts_load_from_loadleveler (const struct
 148                                             GNUNET_CONFIGURATION_Handle *cfg,
 149                                             struct GNUNET_TESTBED_Host
 150                                             ***hosts);
 151
 152 /**
 153  * Destroy a host handle.  Must only be called once everything
 154  * running on that host has been stopped.
 155  *
 156  * @param host handle to destroy
 157  */
 158 void
 159 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host);
 160
 161
 162 /**
 163  * The handle for whether a host is habitable or not
 164  */
 165 struct GNUNET_TESTBED_HostHabitableCheckHandle;
 166
 167
 168 /**
 169  * Callbacks of this type are called by GNUNET_TESTBED_is_host_habitable to
 170  * inform whether the given host is habitable or not. The Handle returned by
 171  * GNUNET_TESTBED_is_host_habitable() is invalid after this callback is called
 172  *
 173  * @param cls the closure given to GNUNET_TESTBED_is_host_habitable()
 174  * @param host the host whose status is being reported; will be NULL if the host
 175  *          given to GNUNET_TESTBED_is_host_habitable() is NULL
 176  * @param status GNUNET_YES if it is habitable; GNUNET_NO if not
 177  */
 178 typedef void (*GNUNET_TESTBED_HostHabitableCallback) (void *cls,
 179                                                       const struct
 180                                                       GNUNET_TESTBED_Host
 181                                                       *host,
 182                                                       int status);
 183
 184
 185 /**
 186  * Checks whether a host can be used to start testbed service
 187  *
 188  * @param host the host to check
 189  * @param config the configuration handle to lookup the path of the testbed
 190  *          helper
 191  * @param cb the callback to call to inform about habitability of the given host
 192  * @param cb_cls the closure for the callback
 193  * @return NULL upon any error or a handle which can be passed to
 194  *           GNUNET_TESTBED_is_host_habitable_cancel()
 195  */
 196 struct GNUNET_TESTBED_HostHabitableCheckHandle *
 197 GNUNET_TESTBED_is_host_habitable (const struct GNUNET_TESTBED_Host *host,
 198                                   const struct GNUNET_CONFIGURATION_Handle
 199                                   *config,
 200                                   GNUNET_TESTBED_HostHabitableCallback cb,
 201                                   void *cb_cls);
 202
 203
 204 /**
 205  * Function to cancel a request started using GNUNET_TESTBED_is_host_habitable()
 206  *
 207  * @param handle the habitability check handle
 208  */
 209 void
 210 GNUNET_TESTBED_is_host_habitable_cancel (struct
 211                                          GNUNET_TESTBED_HostHabitableCheckHandle
 212                                          *handle);
 213
 214 /**
 215  * Obtain the host's hostname.
 216  *
 217  * @param host handle to the host, NULL means 'localhost'
 218  * @return hostname of the host
 219  */
 220 const char *
 221 GNUNET_TESTBED_host_get_hostname (const struct GNUNET_TESTBED_Host *host);
 222
 223
 224 /**
 225  * Enumeration with (at most 64) possible event types that
 226  * can be monitored using the testbed framework.
 227  */
 228 enum GNUNET_TESTBED_EventType
 229 {
 230   /**
 231    * A peer has been started.
 232    */
 233   GNUNET_TESTBED_ET_PEER_START = 0,
 234
 235   /**
 236    * A peer has been stopped.
 237    */
 238   GNUNET_TESTBED_ET_PEER_STOP = 1,
 239
 240   /**
 241    * A connection between two peers was established.
 242    */
 243   GNUNET_TESTBED_ET_CONNECT = 2,
 244
 245   /**
 246    * A connection between two peers was torn down.
 247    */
 248   GNUNET_TESTBED_ET_DISCONNECT = 3,
 249
 250   /**
 251    * A requested testbed operation has been completed.
 252    */
 253   GNUNET_TESTBED_ET_OPERATION_FINISHED = 4,
 254
 255 };
 256
 257
 258 /**
 259  * Types of information that can be requested about a peer.
 260  */
 261 enum GNUNET_TESTBED_PeerInformationType
 262 {
 263
 264   /**
 265    * Special value (not valid for requesting information)
 266    * that is used in the event struct if a 'generic' pointer
 267    * is returned (for other operations not related to this
 268    * enumeration).
 269    */
 270   GNUNET_TESTBED_PIT_GENERIC = 0,
 271
 272   /**
 273    * What configuration is the peer using?  Returns a 'const struct
 274    * GNUNET_CONFIGURATION_Handle *'.  Valid until
 275    * 'GNUNET_TESTNIG_operation_done' is called.  However, the
 276    * values may be inaccurate if the peer is reconfigured in
 277    * the meantime.
 278    */
 279   GNUNET_TESTBED_PIT_CONFIGURATION,
 280
 281   /**
 282    * What is the identity of the peer?  Returns a
 283    * 'const struct GNUNET_PeerIdentity *'.  Valid until
 284    * 'GNUNET_TESTNIG_operation_done' is called.
 285    */
 286   GNUNET_TESTBED_PIT_IDENTITY
 287
 288 };
 289
 290
 291 /**
 292  * Argument to GNUNET_TESTBED_ControllerCallback with details about
 293  * the event.
 294  */
 295 struct GNUNET_TESTBED_EventInformation
 296 {
 297
 298   /**
 299    * Type of the event.
 300    */
 301   enum GNUNET_TESTBED_EventType type;
 302
 303   /**
 304    * Handle for the corresponding operation that generated this event
 305    */
 306   struct GNUNET_TESTBED_Operation *op;
 307
 308   /**
 309    * Closure given while creating the above operation
 310    */
 311   void *op_cls;
 312
 313   /**
 314    * Details about the event.
 315    */
 316   union
 317   {
 318
 319     /**
 320      * Details about peer start event.
 321      */
 322     struct
 323     {
 324       /**
 325        * Handle for the host where the peer
 326        * was started.
 327        */
 328       struct GNUNET_TESTBED_Host *host;
 329
 330       /**
 331        * Handle for the peer that was started.
 332        */
 333       struct GNUNET_TESTBED_Peer *peer;
 334
 335     } peer_start;
 336
 337     /**
 338      * Details about peer stop event.
 339      */
 340     struct
 341     {
 342
 343       /**
 344        * Handle for the peer that was started.
 345        */
 346       struct GNUNET_TESTBED_Peer *peer;
 347
 348     } peer_stop;
 349
 350     /**
 351      * Details about connect event.
 352      */
 353     struct
 354     {
 355       /**
 356        * Handle for one of the connected peers.
 357        */
 358       struct GNUNET_TESTBED_Peer *peer1;
 359
 360       /**
 361        * Handle for one of the connected peers.
 362        */
 363       struct GNUNET_TESTBED_Peer *peer2;
 364
 365     } peer_connect;
 366
 367     /**
 368      * Details about disconnect event.
 369      */
 370     struct
 371     {
 372       /**
 373        * Handle for one of the disconnected peers.
 374        */
 375       struct GNUNET_TESTBED_Peer *peer1;
 376
 377       /**
 378        * Handle for one of the disconnected peers.
 379        */
 380       struct GNUNET_TESTBED_Peer *peer2;
 381
 382     } peer_disconnect;
 383
 384     /**
 385      * Details about an operation finished event.
 386      */
 387     struct
 388     {
 389       /**
 390        * Error message for the operation, NULL on success.
 391        */
 392       const char *emsg;
 393
 394       /**
 395        * No result (NULL pointer) or generic result
 396        * (whatever the GNUNET_TESTBED_ConnectAdapter returned).
 397        */
 398       void *generic;
 399
 400     } operation_finished;
 401
 402   } details;
 403
 404 };
 405
 406
 407 /**
 408  * Signature of the event handler function called by the
 409  * respective event controller.
 410  *
 411  * @param cls closure
 412  * @param event information about the event
 413  */
 414 typedef void (*GNUNET_TESTBED_ControllerCallback)(void *cls,
 415                                                   const struct GNUNET_TESTBED_EventInformation *event);
 416
 417
 418 /**
 419  * Opaque Handle for Controller process
 420  */
 421 struct GNUNET_TESTBED_ControllerProc;
 422
 423
 424 /**
 425  * Callback to signal successfull startup of the controller process
 426  *
 427  * @param cls the closure from GNUNET_TESTBED_controller_start()
 428  * @param cfg the configuration with which the controller has been started;
 429  *          NULL if status is not GNUNET_OK
 430  * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
 431  *          GNUNET_TESTBED_controller_stop() shouldn't be called in this case
 432  */
 433 typedef void (*GNUNET_TESTBED_ControllerStatusCallback) (void *cls,
 434                                                         const struct GNUNET_CONFIGURATION_Handle *cfg,
 435                                                         int status);
 436
 437
 438 /**
 439  * Starts a controller process at the given host.  The given host's configration
 440  * is used as a Template configuration to use for the remote controller; the
 441  * remote controller will be started with a slightly modified configuration
 442  * (port numbers, unix domain sockets and service home values are changed as per
 443  * TESTING library on the remote host).  The modified configuration replaces the
 444  * host's existing configuration before signalling success through the
 445  * GNUNET_TESTBED_ControllerStatusCallback()
 446  *
 447  * @param trusted_ip the ip address of the controller which will be set as TRUSTED
 448  *          HOST(all connections form this ip are permitted by the testbed) when
 449  *          starting testbed controller at host. This can either be a single ip
 450  *          address or a network address in CIDR notation.
 451  * @param host the host where the controller has to be started.  CANNOT be NULL.
 452  * @param cb function called when the controller is successfully started or
 453  *          dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
 454  *          called if cb is called with GNUNET_SYSERR as status. Will never be
 455  *          called in the same task as 'GNUNET_TESTBED_controller_start'
 456  *          (synchronous errors will be signalled by returning NULL). This
 457  *          parameter cannot be NULL.
 458  * @param cls closure for above callbacks
 459  * @return the controller process handle, NULL on errors
 460  */
 461 struct GNUNET_TESTBED_ControllerProc *
 462 GNUNET_TESTBED_controller_start (const char *trusted_ip,
 463                                  struct GNUNET_TESTBED_Host *host,
 464                                  GNUNET_TESTBED_ControllerStatusCallback cb,
 465                                  void *cls);
 466
 467
 468 /**
 469  * Stop the controller process (also will terminate all peers and controllers
 470  * dependent on this controller).  This function blocks until the testbed has
 471  * been fully terminated (!). The controller status cb from
 472  * GNUNET_TESTBED_controller_start() will not be called.
 473  *
 474  * @param cproc the controller process handle
 475  */
 476 void
 477 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc);
 478
 479
 480 /**
 481  * Connect to a controller process.  The configuration to use for the connection
 482  * is retreived from the given host where a controller is started using
 483  * GNUNET_TESTBED_controller_start().
 484  *
 485  * @param host host to run the controller on; This should be the same host if
 486  *          the controller was previously started with
 487  *          GNUNET_TESTBED_controller_start()
 488  * @param event_mask bit mask with set of events to call 'cc' for;
 489  *                   or-ed values of "1LL" shifted by the
 490  *                   respective 'enum GNUNET_TESTBED_EventType'
 491  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
 492  * @param cc controller callback to invoke on events
 493  * @param cc_cls closure for cc
 494  * @return handle to the controller
 495  */
 496 struct GNUNET_TESTBED_Controller *
 497 GNUNET_TESTBED_controller_connect (struct GNUNET_TESTBED_Host *host,
 498                                    uint64_t event_mask,
 499                                    GNUNET_TESTBED_ControllerCallback cc,
 500                                    void *cc_cls);
 501
 502
 503 /**
 504  * Stop the given controller (also will terminate all peers and
 505  * controllers dependent on this controller).  This function
 506  * blocks until the testbed has been fully terminated (!).
 507  *
 508  * @param c handle to controller to stop
 509  */
 510 void
 511 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *c);
 512
 513
 514 /**
 515  * Opaque handle for host registration
 516  */
 517 struct GNUNET_TESTBED_HostRegistrationHandle;
 518
 519
 520 /**
 521  * Callback which will be called to after a host registration succeeded or failed
 522  *
 523  * @param cls the closure
 524  * @param emsg the error message; NULL if host registration is successful
 525  */
 526 typedef void (* GNUNET_TESTBED_HostRegistrationCompletion) (void *cls,
 527                                                             const char *emsg);
 528
 529
 530 /**
 531  * Register a host with the controller. This makes the controller aware of the
 532  * host. A host should be registered at the controller before starting a
 533  * sub-controller on that host using GNUNET_TESTBED_controller_link().
 534  *
 535  * @param controller the controller handle
 536  * @param host the host to register
 537  * @param cc the completion callback to call to inform the status of
 538  *          registration. After calling this callback the registration handle
 539  *          will be invalid. Cannot be NULL
 540  * @param cc_cls the closure for the cc
 541  * @return handle to the host registration which can be used to cancel the
 542  *           registration; NULL if another registration handle is present and
 543  *           is not cancelled
 544  */
 545 struct GNUNET_TESTBED_HostRegistrationHandle *
 546 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
 547                               struct GNUNET_TESTBED_Host *host,
 548                               GNUNET_TESTBED_HostRegistrationCompletion cc,
 549                               void *cc_cls);
 550
 551
 552 /**
 553  * Cancel the pending registration. Note that the registration message will
 554  * already be queued to be sent to the service, cancellation has only the
 555  * effect that the registration completion callback for the registration is
 556  * never called and from our perspective the host is not registered until the
 557  * completion callback is called.
 558  *
 559  * @param handle the registration handle to cancel
 560  */
 561 void
 562 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
 563                                     *handle);
 564
 565
 566 /**
 567  * Callback to be called when an operation is completed
 568  *
 569  * @param cls the callback closure from functions generating an operation
 570  * @param op the operation that has been finished
 571  * @param emsg error message in case the operation has failed; will be NULL if
 572  *          operation has executed successfully.
 573  */
 574 typedef void (*GNUNET_TESTBED_OperationCompletionCallback) (void *cls,
 575                                                             struct
 576                                                             GNUNET_TESTBED_Operation
 577                                                             *op,
 578                                                             const char *emsg);
 579
 580
 581 /**
 582  * Create a link from slave controller to delegated controller. Whenever the
 583  * master controller is asked to start a peer at the delegated controller the
 584  * request will be routed towards slave controller (if a route exists). The
 585  * slave controller will then route it to the delegated controller. The
 586  * configuration of the delegated controller is given and is used to either
 587  * create the delegated controller or to connect to an existing controller. Note
 588  * that while starting the delegated controller the configuration will be
 589  * modified to accommodate available free ports.  the 'is_subordinate' specifies
 590  * if the given delegated controller should be started and managed by the slave
 591  * controller, or if the delegated controller already has a master and the slave
 592  * controller connects to it as a non master controller. The success or failure
 593  * of this operation will be signalled through the
 594  * GNUNET_TESTBED_ControllerCallback() with an event of type
 595  * GNUNET_TESTBED_ET_OPERATION_FINISHED
 596  *
 597  * @param op_cls the operation closure for the event which is generated to
 598  *          signal success or failure of this operation
 599  * @param master handle to the master controller who creates the association
 600  * @param delegated_host requests to which host should be delegated; cannot be NULL
 601  * @param slave_host which host is used to run the slave controller; use NULL to
 602  *          make the master controller connect to the delegated host
 603  * @param is_subordinate GNUNET_YES if the controller at delegated_host should
 604  *          be started by the slave controller; GNUNET_NO if the slave
 605  *          controller has to connect to the already started delegated
 606  *          controller via TCP/IP
 607  * @return the operation handle
 608  */
 609 struct GNUNET_TESTBED_Operation *
 610 GNUNET_TESTBED_controller_link (void *op_cls,
 611                                 struct GNUNET_TESTBED_Controller *master,
 612                                 struct GNUNET_TESTBED_Host *delegated_host,
 613                                 struct GNUNET_TESTBED_Host *slave_host,
 614                                 int is_subordinate);
 615
 616
 617 /**
 618  * Function to acquire the configuration of a running slave controller. The
 619  * completion of the operation is signalled through the controller_cb from
 620  * GNUNET_TESTBED_controller_connect(). If the operation is successful the
 621  * handle to the configuration is available in the generic pointer of
 622  * operation_finished field of struct GNUNET_TESTBED_EventInformation.
 623  *
 624  * @param op_cls the closure for the operation
 625  * @param master the handle to master controller
 626  * @param slave_host the host where the slave controller is running; the handle
 627  *          to the slave_host should remain valid until this operation is
 628  *          cancelled or marked as finished
 629  * @return the operation handle; NULL if the slave_host is not registered at
 630  *           master
 631  */
 632 struct GNUNET_TESTBED_Operation *
 633 GNUNET_TESTBED_get_slave_config (void *op_cls,
 634                                  struct GNUNET_TESTBED_Controller *master,
 635                                  struct GNUNET_TESTBED_Host *slave_host);
 636
 637
 638 /**
 639  * Functions of this signature are called when a peer has been successfully
 640  * created
 641  *
 642  * @param cls the closure from GNUNET_TESTBED_peer_create()
 643  * @param peer the handle for the created peer; NULL on any error during
 644  *          creation
 645  * @param emsg NULL if peer is not NULL; else MAY contain the error description
 646  */
 647 typedef void (*GNUNET_TESTBED_PeerCreateCallback) (void *cls,
 648                                                    struct GNUNET_TESTBED_Peer *peer,
 649                                                    const char *emsg);
 650
 651
 652 /**
 653  * Create the given peer at the specified host using the given
 654  * controller.  If the given controller is not running on the target
 655  * host, it should find or create a controller at the target host and
 656  * delegate creating the peer.  Explicit delegation paths can be setup
 657  * using 'GNUNET_TESTBED_controller_link'.  If no explicit delegation
 658  * path exists, a direct link with a subordinate controller is setup
 659  * for the first delegated peer to a particular host; the subordinate
 660  * controller is then destroyed once the last peer that was delegated
 661  * to the remote host is stopped.
 662  *
 663  * Creating the peer only creates the handle to manipulate and further
 664  * configure the peer; use "GNUNET_TESTBED_peer_start" and
 665  * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
 666  * processes.
 667  *
 668  * Note that the given configuration will be adjusted by the
 669  * controller to avoid port/path conflicts with other peers.
 670  * The "final" configuration can be obtained using
 671  * 'GNUNET_TESTBED_peer_get_information'.
 672  *
 673  * @param controller controller process to use
 674  * @param host host to run the peer on; cannot be NULL
 675  * @param cfg Template configuration to use for the peer. Should exist until
 676  *          operation is cancelled or GNUNET_TESTBED_operation_done() is called
 677  * @param cb the callback to call when the peer has been created
 678  * @param cls the closure to the above callback
 679  * @return the operation handle
 680  */
 681 struct GNUNET_TESTBED_Operation *
 682 GNUNET_TESTBED_peer_create (struct GNUNET_TESTBED_Controller *controller,
 683                             struct GNUNET_TESTBED_Host *host,
 684                             const struct GNUNET_CONFIGURATION_Handle *cfg,
 685                             GNUNET_TESTBED_PeerCreateCallback cb,
 686                             void *cls);
 687
 688
 689 /**
 690  * Functions of this signature are called when a peer has been successfully
 691  * started or stopped.
 692  *
 693  * @param cls the closure from GNUNET_TESTBED_peer_start/stop()
 694  * @param emsg NULL on success; otherwise an error description
 695  */
 696 typedef void (*GNUNET_TESTBED_PeerChurnCallback) (void *cls,
 697                                                   const char *emsg);
 698
 699
 700 /**
 701  * Start the given peer.
 702  *
 703  * @param op_cls the closure for this operation; will be set in the event
 704  *          information
 705  * @param peer peer to start
 706  * @param pcc function to call upon completion
 707  * @param pcc_cls closure for 'pcc'
 708  * @return handle to the operation
 709  */
 710 struct GNUNET_TESTBED_Operation *
 711 GNUNET_TESTBED_peer_start (void *op_cls,
 712                            struct GNUNET_TESTBED_Peer *peer,
 713                            GNUNET_TESTBED_PeerChurnCallback pcc,
 714                            void *pcc_cls);
 715
 716
 717 /**
 718  * Stop the given peer.  The handle remains valid (use
 719  * "GNUNET_TESTBED_peer_destroy" to fully clean up the
 720  * state of the peer).
 721  *
 722  * @param op_cls the closure for this operation; will be set in the event
 723  *          information
 724  * @param peer peer to stop
 725  * @param pcc function to call upon completion
 726  * @param pcc_cls closure for 'pcc'
 727  * @return handle to the operation
 728  */
 729 struct GNUNET_TESTBED_Operation *
 730 GNUNET_TESTBED_peer_stop (void *op_cls,
 731                           struct GNUNET_TESTBED_Peer *peer,
 732                           GNUNET_TESTBED_PeerChurnCallback pcc,
 733                           void *pcc_cls);
 734
 735
 736 /**
 737  * Data returned from GNUNET_TESTBED_peer_get_information
 738  */
 739 struct GNUNET_TESTBED_PeerInformation
 740 {
 741   /**
 742    * Peer information type; captures which of the types
 743    * in the 'op_result' is actually in use.
 744    */
 745   enum GNUNET_TESTBED_PeerInformationType pit;
 746
 747   /**
 748    * The result of the get information operation; Choose according to the pit
 749    */
 750   union
 751   {
 752     /**
 753      * The configuration of the peer
 754      */
 755     struct GNUNET_CONFIGURATION_Handle *cfg;
 756
 757     /**
 758      * The identity of the peer
 759      */
 760     struct GNUNET_PeerIdentity *id;
 761   } result;
 762 };
 763
 764
 765 /**
 766  * Callback to be called when the requested peer information is available
 767  * The peer information in the callback is valid until the operation 'op' is canceled.
 768  *
 769  * @param cb_cls the closure from GNUNET_TETSBED_peer_get_information()
 770  * @param op the operation this callback corresponds to
 771  * @param pinfo the result; will be NULL if the operation has failed
 772  * @param emsg error message if the operation has failed; will be NULL if the
 773  *          operation is successfull
 774  */
 775 typedef void (*GNUNET_TESTBED_PeerInfoCallback) (void *cb_cls,
 776                                                  struct GNUNET_TESTBED_Operation
 777                                                  *op,
 778                                                  const struct
 779                                                  GNUNET_TESTBED_PeerInformation
 780                                                  *pinfo,
 781                                                  const char *emsg);
 782
 783
 784 /**
 785  * Request information about a peer. The controller callback will not be called
 786  * with event type GNUNET_TESTBED_ET_OPERATION_FINISHED when result for this
 787  * operation is available. Instead, the GNUNET_TESTBED_PeerInfoCallback() will
 788  * be called.
 789  * The peer information in the callback is valid until the operation is canceled.
 790  *
 791  * @param peer peer to request information about
 792  * @param pit desired information
 793  * @param cb the convenience callback to be called when results for this
 794  *          operation are available
 795  * @param cb_cls the closure for the above callback
 796  * @return handle to the operation
 797  */
 798 struct GNUNET_TESTBED_Operation *
 799 GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
 800                                      enum GNUNET_TESTBED_PeerInformationType
 801                                      pit,
 802                                      GNUNET_TESTBED_PeerInfoCallback cb,
 803                                      void *cb_cls);
 804
 805
 806 /**
 807  * Change peer configuration.  Must only be called while the
 808  * peer is stopped.  Ports and paths cannot be changed this
 809  * way.
 810  *
 811  * @param peer peer to change configuration for
 812  * @param cfg new configuration (differences to existing
 813  *            configuration only)
 814  * @return handle to the operation
 815  */
 816 struct GNUNET_TESTBED_Operation *
 817 GNUNET_TESTBED_peer_update_configuration (struct GNUNET_TESTBED_Peer *peer,
 818                                           const struct GNUNET_CONFIGURATION_Handle *cfg);
 819
 820
 821 /**
 822  * Destroy the given peer; the peer should have been
 823  * stopped first (if it was started).
 824  *
 825  * @param peer peer to stop
 826  * @return handle to the operation
 827  */
 828 struct GNUNET_TESTBED_Operation *
 829 GNUNET_TESTBED_peer_destroy (struct GNUNET_TESTBED_Peer *peer);
 830
 831
 832 /**
 833  * Start or stop given service at a peer.  This should not be called to
 834  * start/stop the peer's ARM service.  Use GNUNET_TESTBED_peer_start(),
 835  * GNUNET_TESTBED_peer_stop() for starting/stopping peer's ARM service.  Success
 836  * or failure of the generated operation is signalled through the controller
 837  * event callback and/or operation completion callback.
 838  *
 839  * @param op_cls the closure for the operation
 840  * @param peer the peer whose service is to be started/stopped
 841  * @param service_name the name of the service
 842  * @param cb the operation completion callback
 843  * @param cb_cls the closure for the operation completion callback
 844  * @param start 1 to start the service; 0 to stop the service
 845  * @return an operation handle; NULL upon error (peer not running)
 846  */
 847 struct GNUNET_TESTBED_Operation *
 848 GNUNET_TESTBED_peer_manage_service (void *op_cls,
 849                                     struct GNUNET_TESTBED_Peer *peer,
 850                                     const char *service_name,
 851                                     GNUNET_TESTBED_OperationCompletionCallback cb,
 852                                     void *cb_cls,
 853                                     unsigned int start);
 854
 855
 856 /**
 857  * Stops and destroys all peers.  Is equivalent of calling
 858  * GNUNET_TESTBED_peer_stop() and GNUNET_TESTBED_peer_destroy() on all peers,
 859  * except that the peer stop event and operation finished event corresponding to
 860  * the respective functions are not generated.  This function should be called
 861  * when there are no other pending operations.  If there are pending operations,
 862  * it will return NULL
 863  *
 864  * @param c the controller to send this message to
 865  * @param op_cls closure for the operation
 866  * @param cb the callback to call when all peers are stopped and destroyed
 867  * @param cb_cls the closure for the callback
 868  * @return operation handle on success; NULL if any pending operations are
 869  *           present
 870  */
 871 struct GNUNET_TESTBED_Operation *
 872 GNUNET_TESTBED_shutdown_peers (struct GNUNET_TESTBED_Controller *c,
 873                                void *op_cls,
 874                                GNUNET_TESTBED_OperationCompletionCallback cb,
 875                                void *cb_cls);
 876
 877
 878
 879 /**
 880  * Options for peer connections.
 881  */
 882 enum GNUNET_TESTBED_ConnectOption
 883 {
 884   /**
 885    * No option (not valid as an argument).
 886    */
 887   GNUNET_TESTBED_CO_NONE = 0,
 888
 889   /**
 890    * Allow or disallow a connection between the specified peers.
 891    * Followed by GNUNET_NO (int) if a connection is disallowed
 892    * or GNUNET_YES if a connection is allowed.  Note that the
 893    * default (all connections allowed or disallowed) is
 894    * specified in the configuration of the controller.
 895    */
 896   GNUNET_TESTBED_CO_ALLOW = 1,
 897
 898   /**
 899    * FIXME: add (and implement) options to limit connection to
 900    * particular transports, force simulation of particular latencies
 901    * or message loss rates, or set bandwidth limitations.
 902    */
 903
 904 };
 905
 906
 907 /**
 908  * Manipulate the P2P underlay topology by configuring a link
 909  * between two peers.
 910  *
 911  * @param op_cls closure argument to give with the operation event
 912  * @param p1 first peer
 913  * @param p2 second peer
 914  * @param co option to change
 915  * @param ap option-specific values
 916  * @return handle to the operation, NULL if configuring the link at this
 917  *         time is not allowed
 918  */
 919 struct GNUNET_TESTBED_Operation *
 920 GNUNET_TESTBED_underlay_configure_link_va (void *op_cls,
 921                                            struct GNUNET_TESTBED_Peer *p1,
 922                                            struct GNUNET_TESTBED_Peer *p2,
 923                                            enum GNUNET_TESTBED_ConnectOption co,
 924                                            va_list ap);
 925
 926
 927 /**
 928  * Manipulate the P2P underlay topology by configuring a link
 929  * between two peers.
 930  *
 931  * @param op_cls closure argument to give with the operation event
 932  * @param p1 first peer
 933  * @param p2 second peer
 934  * @param co option to change
 935  * @param ... option-specific values
 936  * @return handle to the operation, NULL if configuring the link at this
 937  *         time is not allowed
 938  */
 939 struct GNUNET_TESTBED_Operation *
 940 GNUNET_TESTBED_underlay_configure_link (void *op_cls,
 941                                         struct GNUNET_TESTBED_Peer *p1,
 942                                         struct GNUNET_TESTBED_Peer *p2,
 943                                         enum GNUNET_TESTBED_ConnectOption co, ...);
 944
 945
 946
 947 /**
 948  * Topologies and topology options supported for testbeds. Options should always
 949  * end with GNUNET_TESTBED_TOPOLOGY_OPTION_END
 950  */
 951 enum GNUNET_TESTBED_TopologyOption
 952 {
 953   /**
 954    * A clique (everyone connected to everyone else).  No options. If there are N
 955    * peers this topology results in (N * (N -1)) connections.
 956    */
 957   GNUNET_TESTBED_TOPOLOGY_CLIQUE,
 958
 959   /**
 960    * Small-world network (2d torus plus random links).  Followed
 961    * by the number of random links to add (unsigned int).
 962    */
 963   GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD,
 964
 965   /**
 966    * Small-world network (ring plus random links).  Followed
 967    * by the number of random links to add (unsigned int).
 968    */
 969   GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING,
 970
 971   /**
 972    * Ring topology.  No options.
 973    */
 974   GNUNET_TESTBED_TOPOLOGY_RING,
 975
 976   /**
 977    * 2-d torus.  No options.
 978    */
 979   GNUNET_TESTBED_TOPOLOGY_2D_TORUS,
 980
 981   /**
 982    * Random graph.  Followed by the number of random links to be established
 983    * (unsigned int)
 984    */
 985   GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI,
 986
 987   /**
 988    * Certain percentage of peers are unable to communicate directly
 989    * replicating NAT conditions.  Followed by the fraction of
 990    * NAT'ed peers (float).
 991    */
 992   GNUNET_TESTBED_TOPOLOGY_INTERNAT,
 993
 994   /**
 995    * Scale free topology.  It is generated according to the method described in
 996    * "Emergence of Scaling in Random Networks." Science 286, 509-512, 1999.
 997    *
 998    * This options takes two arguments in the following order: an uint16_t to
 999    * determine the maximum number of edges a peer is permitted to have while
1000    * generating scale free topology, a good value for this argument is 70; and
1001    * an uint8_t to determine the number of edges to be established when adding a
1002    * new node to the scale free network, a good value for this argument is 4.
1003    */
1004   GNUNET_TESTBED_TOPOLOGY_SCALE_FREE,
1005
1006   /**
1007    * Straight line topology.  No options.
1008    */
1009   GNUNET_TESTBED_TOPOLOGY_LINE,
1010
1011   /**
1012    * Read a topology from a given file.  Followed by the name of the file (const char *).
1013    */
1014   GNUNET_TESTBED_TOPOLOGY_FROM_FILE,
1015
1016   /**
1017    * All peers are disconnected.  No options.
1018    */
1019   GNUNET_TESTBED_TOPOLOGY_NONE,
1020
1021   /**
1022    * The options should always end with this
1023    */
1024   GNUNET_TESTBED_TOPOLOGY_OPTION_END,
1025
1026   /* The following are not topologies but influence how the topology has to be
1027      setup. These options should follow the topology specific options (if
1028      required by the chosen topology). Note that these should be given before
1029      GNUNET_TESTBED_TOPOLOGY_OPTION_END */
1030
1031   /**
1032    * How many times should the failed overlay connect operations be retried
1033    * before giving up.  The default if this option is not specified is to retry
1034    * 3 times.  This option takes and unsigned integer as a parameter.  Use this
1035    * option with parameter 0 to disable retrying of failed overlay connect
1036    * operations.
1037    */
1038   GNUNET_TESTBED_TOPOLOGY_RETRY_CNT
1039 };
1040
1041
1042 /**
1043  * Configure overall network topology to have a particular shape.
1044  *
1045  * @param op_cls closure argument to give with the operation event
1046  * @param num_peers number of peers in 'peers'
1047  * @param peers array of 'num_peers' with the peers to configure
1048  * @param topo desired underlay topology to use
1049  * @param ap topology-specific options
1050  * @return handle to the operation, NULL if configuring the topology
1051  *         is not allowed at this time
1052  */
1053 struct GNUNET_TESTBED_Operation *
1054 GNUNET_TESTBED_underlay_configure_topology_va (void *op_cls,
1055                                                unsigned int num_peers,
1056                                                struct GNUNET_TESTBED_Peer **peers,
1057                                                enum GNUNET_TESTBED_TopologyOption topo,
1058                                                va_list ap);
1059
1060
1061 /**
1062  * Configure overall network topology to have a particular shape.
1063  *
1064  * @param op_cls closure argument to give with the operation event
1065  * @param num_peers number of peers in 'peers'
1066  * @param peers array of 'num_peers' with the peers to configure
1067  * @param topo desired underlay topology to use
1068  * @param ... topology-specific options
1069  * @return handle to the operation, NULL if configuring the topology
1070  *         is not allowed at this time
1071  */
1072 struct GNUNET_TESTBED_Operation *
1073 GNUNET_TESTBED_underlay_configure_topology (void *op_cls,
1074                                             unsigned int num_peers,
1075                                             struct GNUNET_TESTBED_Peer **peers,
1076                                             enum GNUNET_TESTBED_TopologyOption topo,
1077                                             ...);
1078
1079
1080 /**
1081  * Both peers must have been started before calling this function.
1082  * This function then obtains a HELLO from 'p1', gives it to 'p2'
1083  * and asks 'p2' to connect to 'p1'.
1084  *
1085  * @param op_cls closure argument to give with the operation event
1086  * @param cb the callback to call when this operation has finished
1087  * @param cb_cls the closure for the above callback
1088  * @param p1 first peer
1089  * @param p2 second peer
1090  * @return handle to the operation, NULL if connecting these two
1091  *         peers is fundamentally not possible at this time (peers
1092  *         not running or underlay disallows)
1093  */
1094 struct GNUNET_TESTBED_Operation *
1095 GNUNET_TESTBED_overlay_connect (void *op_cls,
1096                                 GNUNET_TESTBED_OperationCompletionCallback cb,
1097                                 void *cb_cls,
1098                                 struct GNUNET_TESTBED_Peer *p1,
1099                                 struct GNUNET_TESTBED_Peer *p2);
1100
1101
1102 /**
1103  * Callbacks of this type are called when topology configuration is completed
1104  *
1105  * @param cls the operation closure given to
1106  *          GNUNET_TESTBED_overlay_configure_topology_va() and
1107  *          GNUNET_TESTBED_overlay_configure() calls
1108  * @param nsuccess the number of successful overlay connects
1109  * @param nfailures the number of overlay connects which failed
1110  */
1111 typedef void (*GNUNET_TESTBED_TopologyCompletionCallback) (void *cls,
1112                                                           unsigned int nsuccess,
1113                                                           unsigned int nfailures);
1114
1115
1116 /**
1117  * All peers must have been started before calling this function.
1118  * This function then connects the given peers in the P2P overlay
1119  * using the given topology.
1120  *
1121  * @param op_cls closure argument to give with the peer connect operation events
1122  *          generated through this function
1123  * @param num_peers number of peers in 'peers'
1124  * @param peers array of 'num_peers' with the peers to configure
1125  * @param max_connections the maximums number of overlay connections that will
1126  *          be made to achieve the given topology
1127  * @param comp_cb the completion callback to call when the topology generation
1128  *          is completed
1129  * @param comp_cb_cls closure for the above completion callback
1130  * @param topo desired underlay topology to use
1131  * @param va topology-specific options
1132  * @return handle to the operation, NULL if connecting these
1133  *         peers is fundamentally not possible at this time (peers
1134  *         not running or underlay disallows) or if num_peers is less than 2
1135  */
1136 struct GNUNET_TESTBED_Operation *
1137 GNUNET_TESTBED_overlay_configure_topology_va (void *op_cls,
1138                                               unsigned int num_peers,
1139                                               struct GNUNET_TESTBED_Peer **peers,
1140                                               unsigned int *max_connections,
1141                                               GNUNET_TESTBED_TopologyCompletionCallback
1142                                               comp_cb,
1143                                               void *comp_cb_cls,
1144                                               enum GNUNET_TESTBED_TopologyOption topo,
1145                                               va_list va);
1146
1147
1148 /**
1149  * All peers must have been started before calling this function.
1150  * This function then connects the given peers in the P2P overlay
1151  * using the given topology.
1152  *
1153  * @param op_cls closure argument to give with the peer connect operation events
1154  *          generated through this function
1155  * @param num_peers number of peers in 'peers'
1156  * @param peers array of 'num_peers' with the peers to configure
1157  * @param max_connections the maximums number of overlay connections that will
1158  *          be made to achieve the given topology
1159  * @param comp_cb the completion callback to call when the topology generation
1160  *          is completed
1161  * @param comp_cb_cls closure for the above completion callback
1162  * @param topo desired underlay topology to use
1163  * @param ... topology-specific options
1164  * @return handle to the operation, NULL if connecting these
1165  *         peers is fundamentally not possible at this time (peers
1166  *         not running or underlay disallows) or if num_peers is less than 2
1167  */
1168 struct GNUNET_TESTBED_Operation *
1169 GNUNET_TESTBED_overlay_configure_topology (void *op_cls,
1170                                            unsigned int num_peers,
1171                                            struct GNUNET_TESTBED_Peer **peers,
1172                                            unsigned int *max_connections,
1173                                            GNUNET_TESTBED_TopologyCompletionCallback
1174                                            comp_cb,
1175                                            void *comp_cb_cls,
1176                                            enum GNUNET_TESTBED_TopologyOption topo,
1177                                            ...);
1178
1179
1180 /**
1181  * Ask the testbed controller to write the current overlay topology to
1182  * a file.  Naturally, the file will only contain a snapshot as the
1183  * topology may evolve all the time.
1184  * FIXME: needs continuation!?
1185  *
1186  * @param controller overlay controller to inspect
1187  * @param filename name of the file the topology should
1188  *        be written to.
1189  */
1190 void
1191 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller *controller,
1192                                                const char *filename);
1193
1194
1195 /**
1196  * Adapter function called to establish a connection to
1197  * a service.
1198  *
1199  * @param cls closure
1200  * @param cfg configuration of the peer to connect to; will be available until
1201  *          GNUNET_TESTBED_operation_done() is called on the operation returned
1202  *          from GNUNET_TESTBED_service_connect()
1203  * @return service handle to return in 'op_result', NULL on error
1204  */
1205 typedef void * (*GNUNET_TESTBED_ConnectAdapter)(void *cls,
1206                                                 const struct GNUNET_CONFIGURATION_Handle *cfg);
1207
1208
1209 /**
1210  * Adapter function called to destroy a connection to
1211  * a service.
1212  *
1213  * @param cls closure
1214  * @param op_result service handle returned from the connect adapter
1215  */
1216 typedef void (*GNUNET_TESTBED_DisconnectAdapter)(void *cls,
1217                                                  void *op_result);
1218
1219
1220 /**
1221  * Callback to be called when a service connect operation is completed
1222  *
1223  * @param cls the callback closure from functions generating an operation
1224  * @param op the operation that has been finished
1225  * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
1226  * @param emsg error message in case the operation has failed; will be NULL if
1227  *          operation has executed successfully.
1228  */
1229 typedef void (*GNUNET_TESTBED_ServiceConnectCompletionCallback) (void *cls,
1230                                                                  struct
1231                                                                  GNUNET_TESTBED_Operation
1232                                                                  *op,
1233                                                                  void
1234                                                                  *ca_result,
1235                                                                  const char
1236                                                                  *emsg );
1237
1238
1239 /**
1240  * Connect to a service offered by the given peer.  Will ensure that
1241  * the request is queued to not overwhelm our ability to create and
1242  * maintain connections with other systems.  The actual service
1243  * handle is then returned via the 'op_result' member in the event
1244  * callback.  The 'ca' callback is used to create the connection
1245  * when the time is right; the 'da' callback will be used to
1246  * destroy the connection (upon 'GNUNET_TESTBED_operation_done').
1247  * 'GNUNET_TESTBED_operation_done' can be used to abort this
1248  * operation until the event callback has been called.
1249  *
1250  * @param op_cls closure to pass in operation event // FIXME: didn't we say we'd no longer use the global callback for these? -CG
1251  * @param peer peer that runs the service
1252  * @param service_name name of the service to connect to
1253  * @param cb the callback to call when this operation finishes
1254  * @param cb_cls closure for the above callback
1255  * @param ca helper function to establish the connection
1256  * @param da helper function to close the connection
1257  * @param cada_cls closure for ca and da
1258  * @return handle for the operation
1259  */
1260 struct GNUNET_TESTBED_Operation *
1261 GNUNET_TESTBED_service_connect (void *op_cls,
1262                                 struct GNUNET_TESTBED_Peer *peer,
1263                                 const char *service_name,
1264                                 GNUNET_TESTBED_ServiceConnectCompletionCallback cb,
1265                                 void *cb_cls,
1266                                 GNUNET_TESTBED_ConnectAdapter ca,
1267                                 GNUNET_TESTBED_DisconnectAdapter da,
1268                                 void *cada_cls);
1269
1270
1271 /**
1272  * This function is used to signal that the event information (struct
1273  * GNUNET_TESTBED_EventInformation) from an operation has been fully processed
1274  * i.e. if the event callback is ever called for this operation. If the event
1275  * callback for this operation has not yet been called, calling this function
1276  * cancels the operation, frees its resources and ensures the no event is
1277  * generated with respect to this operation. Note that however cancelling an
1278  * operation does NOT guarantee that the operation will be fully undone (or that
1279  * nothing ever happened).
1280  *
1281  * This function MUST be called for every operation to fully remove the
1282  * operation from the operation queue.  After calling this function, if
1283  * operation is completed and its event information is of type
1284  * GNUNET_TESTBED_ET_OPERATION_FINISHED, the 'op_result' becomes invalid (!).
1285
1286  * If the operation is generated from GNUNET_TESTBED_service_connect() then
1287  * calling this function on such as operation calls the disconnect adapter if
1288  * the connect adapter was ever called.
1289  *
1290  * @param operation operation to signal completion or cancellation
1291  */
1292 void
1293 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation);
1294
1295
1296 /**
1297  * Callback function to process statistic values from all peers.
1298  *
1299  * @param cls closure
1300  * @param peer the peer the statistic belong to
1301  * @param subsystem name of subsystem that created the statistic
1302  * @param name the name of the datum
1303  * @param value the current value
1304  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
1305  * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
1306  */
1307 typedef int (*GNUNET_TESTBED_StatisticsIterator) (void *cls,
1308                                                   const struct GNUNET_TESTBED_Peer *peer,
1309                                                   const char *subsystem,
1310                                                   const char *name,
1311                                                   uint64_t value,
1312                                                   int is_persistent);
1313
1314
1315 /**
1316  * Convenience method that iterates over all (running) peers
1317  * and retrieves all statistics from each peer.
1318  *
1319  * @param num_peers number of peers to iterate over
1320  * @param peers array of peers to iterate over
1321  * @param subsystem limit to the specified subsystem, NULL for all subsystems
1322  * @param name name of the statistic value, NULL for all values
1323  * @param proc processing function for each statistic retrieved
1324  * @param cont continuation to call once call is completed.  The completion of this
1325  *          operation is *ONLY* signalled through this callback -- no
1326  *          GNUNET_TESTBED_ET_OPERATION_FINISHED is generated
1327  * @param cls closure to pass to proc and cont
1328  * @return operation handle to cancel the operation
1329  */
1330 struct GNUNET_TESTBED_Operation *
1331 GNUNET_TESTBED_get_statistics (unsigned int num_peers,
1332                                struct GNUNET_TESTBED_Peer **peers,
1333                                const char *subsystem, const char *name,
1334                                GNUNET_TESTBED_StatisticsIterator proc,
1335                                GNUNET_TESTBED_OperationCompletionCallback cont,
1336                                void *cls);
1337
1338 /**
1339  * Handle for testbed run helper funtions
1340  */
1341 struct GNUNET_TESTBED_RunHandle;
1342
1343 /**
1344  * Signature of a main function for a testcase.
1345  *
1346  * @param cls closure
1347  * @param h the run handle
1348  * @param num_peers number of peers in 'peers'
1349  * @param peers handle to peers run in the testbed.  NULL upon timeout (see
1350  *          GNUNET_TESTBED_test_run()).
1351  * @param links_succeeded the number of overlay link connection attempts that
1352  *          succeeded
1353  * @param links_failed the number of overlay link connection attempts that
1354  *          failed
1355  * @see GNUNET_TESTBED_test_run()
1356  */
1357 typedef void (*GNUNET_TESTBED_TestMaster)(void *cls,
1358                                           struct GNUNET_TESTBED_RunHandle *h,
1359                                           unsigned int num_peers,
1360                                           struct GNUNET_TESTBED_Peer **peers,
1361                                           unsigned int links_succeeded,
1362                                           unsigned int links_failed);
1363
1364
1365 /**
1366  * Convenience method for running a testbed with
1367  * a single call.  Underlay and overlay topology
1368  * are configured using the "UNDERLAY" and "OVERLAY"
1369  * options in the "[testbed]" section of the configuration\
1370  * (with possible options given in "UNDERLAY_XXX" and/or
1371  * "OVERLAY_XXX").
1372  *
1373  * The test_master callback will be called once the testbed setup is finished or
1374  * upon a timeout.  This timeout is given through the configuration file by
1375  * setting the option "SETUP_TIMEOUT" in "[TESTBED]" section.
1376  *
1377  * The testbed is to be terminated using a call to
1378  * "GNUNET_SCHEDULER_shutdown".
1379  *
1380  * @param host_filename name of the file with the 'hosts', NULL
1381  *        to run everything on 'localhost'
1382  * @param cfg configuration to use (for testbed, controller and peers)
1383  * @param num_peers number of peers to start; FIXME: maybe put that ALSO into
1384  *        cfg?; should be greater than 0
1385  * @param event_mask bit mask with set of events to call 'cc' for;
1386  *                   or-ed values of "1LL" shifted by the
1387  *                   respective 'enum GNUNET_TESTBED_EventType'
1388  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
1389  * @param cc controller callback to invoke on events; This callback is called
1390  *        for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
1391  *        set in the event_mask as this is the only way get access to the
1392  *        handle of each peer
1393  * @param cc_cls closure for cc
1394  * @param test_master this callback will be called once the test is ready or
1395  *          upon timeout
1396  * @param test_master_cls closure for 'test_master'.
1397  */
1398 void
1399 GNUNET_TESTBED_run (const char *host_filename,
1400                     const struct GNUNET_CONFIGURATION_Handle *cfg,
1401                     unsigned int num_peers,
1402                     uint64_t event_mask,
1403                     GNUNET_TESTBED_ControllerCallback cc,
1404                     void *cc_cls,
1405                     GNUNET_TESTBED_TestMaster test_master,
1406                     void *test_master_cls);
1407
1408
1409 /**
1410  * Convenience method for running a "simple" test on the local system
1411  * with a single call from 'main'.  Underlay and overlay topology are
1412  * configured using the "UNDERLAY" and "OVERLAY" options in the
1413  * "[TESTBED]" section of the configuration (with possible options
1414  * given in "UNDERLAY_XXX" and/or "OVERLAY_XXX").
1415  *
1416  * The test_master callback will be called once the testbed setup is finished or
1417  * upon a timeout.  This timeout is given through the configuration file by
1418  * setting the option "SETUP_TIMEOUT" in "[TESTBED]" section.
1419  *
1420  * The test is to be terminated using a call to
1421  * "GNUNET_SCHEDULER_shutdown".  If starting the test fails,
1422  * the program is stopped without 'master' ever being run.
1423  *
1424  * NOTE: this function should be called from 'main', NOT from
1425  * within a GNUNET_SCHEDULER-loop.  This function will initialze
1426  * the scheduler loop, the testbed and then pass control to
1427  * 'master'.
1428  *
1429  * @param testname name of the testcase (to configure logging, etc.)
1430  * @param cfg_filename configuration filename to use
1431  *              (for testbed, controller and peers)
1432  * @param num_peers number of peers to start; should be greter than 0
1433  * @param event_mask bit mask with set of events to call 'cc' for;
1434  *                   or-ed values of "1LL" shifted by the
1435  *                   respective 'enum GNUNET_TESTBED_EventType'
1436  *                   (i.e.  "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
1437  * @param cc controller callback to invoke on events; This callback is called
1438  *        for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
1439  *        set in the event_mask as this is the only way get access to the
1440  *        handle of each peer
1441  * @param cc_cls closure for cc
1442  * @param test_master this callback will be called once the test is ready or
1443  *          upon timeout
1444  * @param test_master_cls closure for 'test_master'.
1445  * @return GNUNET_SYSERR on error, GNUNET_OK on success
1446  */
1447 int
1448 GNUNET_TESTBED_test_run (const char *testname,
1449                          const char *cfg_filename,
1450                          unsigned int num_peers,
1451                          uint64_t event_mask,
1452                          GNUNET_TESTBED_ControllerCallback cc,
1453                          void *cc_cls,
1454                          GNUNET_TESTBED_TestMaster test_master,
1455                          void *test_master_cls);
1456
1457
1458 /**
1459  * Obtain handle to the master controller from a testbed run.  The handle
1460  * returned should not be disconnected.
1461  *
1462  * @param h the testbed run handle
1463  * @return handle to the master controller
1464  */
1465 struct GNUNET_TESTBED_Controller *
1466 GNUNET_TESTBED_run_get_controller_handle (struct GNUNET_TESTBED_RunHandle *h);
1467
1468 /**
1469  * Opaque handle for barrier
1470  */
1471 struct GNUNET_TESTBED_Barrier;
1472
1473
1474 /**
1475  * Status of a barrier
1476  */
1477 enum GNUNET_TESTBED_BarrierStatus
1478 {
1479   /**
1480    * Barrier initialised successfully
1481    */
1482   BARRIER_STATUS_INITIALISED = 1,
1483
1484   /**
1485    * Barrier is crossed
1486    */
1487   BARRIER_STATUS_CROSSED,
1488
1489   /**
1490    * Error status
1491    */
1492   BARRIER_STATUS_ERROR,
1493
1494 };
1495
1496
1497 /**
1498  * Functions of this type are to be given as callback argument to
1499  * GNUNET_TESTBED_barrier_init().  The callback will be called when status
1500  * information is available for the barrier.
1501  *
1502  * @param cls the closure given to GNUNET_TESTBED_barrier_init()
1503  * @param name the name of the barrier
1504  * @param barrier the barrier handle
1505  * @param status status of the barrier; GNUNET_OK if the barrier is crossed;
1506  *   GNUNET_SYSERR upon error
1507  * @param emsg if the status were to be GNUNET_SYSERR, this parameter has the
1508  *   error messsage
1509  */
1510 typedef void (*GNUNET_TESTBED_barrier_status_cb) (void *cls,
1511                                                   const char *name,
1512                                                   struct GNUNET_TESTBED_Barrier
1513                                                   *barrier,
1514                                                   enum GNUNET_TESTBED_BarrierStatus status,
1515                                                   const char *emsg);
1516
1517
1518 /**
1519  * Initialise a barrier and call the given callback when the required percentage
1520  * of peers (quorum) reach the barrier.
1521  *
1522  * @param controller the handle to the controller
1523  * @param name identification name of the barrier
1524  * @param quorum the percentage of peers that is required to reach the barrier.
1525  *   Peers signal reaching a barrier by calling
1526  *   GNUNET_TESTBED_barrier_reached().
1527  * @param cb the callback to call when the barrier is reached or upon error.
1528  *   Cannot be NULL.
1529  * @param cls closure for the above callback
1530  * @return barrier handle
1531  */
1532 struct GNUNET_TESTBED_Barrier *
1533 GNUNET_TESTBED_barrier_init (struct GNUNET_TESTBED_Controller *controller,
1534                              const char *name,
1535                              unsigned int quorum,
1536                              GNUNET_TESTBED_barrier_status_cb cb, void *cls);
1537
1538
1539 /**
1540  * Cancel a barrier.
1541  *
1542  * @param barrier the barrier handle
1543  */
1544 void
1545 GNUNET_TESTBED_barrier_cancel (struct GNUNET_TESTBED_Barrier *barrier);
1546
1547
1548 /**
1549  * Opaque handle for barrier wait
1550  */
1551 struct GNUNET_TESTBED_BarrierWaitHandle;
1552
1553
1554 /**
1555  * Functions of this type are to be given as acallback argumetn to
1556  * GNUNET_TESTBED_barrier_wait().  The callback will be called when the barrier
1557  * corresponding given in GNUNET_TESTBED_barrier_wait() is crossed or cancelled.
1558  *
1559  * @param cls closure pointer given to GNUNET_TESTBED_barrier_wait()
1560  * @param name the barrier name
1561  * @param status GNUNET_SYSERR in case of error while waiting for the barrier;
1562  *   GNUNET_OK if the barrier is crossed
1563  */
1564 typedef void (*GNUNET_TESTBED_barrier_wait_cb) (void *cls,
1565                                                 const char *name,
1566                                                 int status);
1567
1568
1569 /**
1570  * Wait for a barrier to be crossed.  This function should be called by the
1571  * peers which have been started by the testbed.  If the peer is not started by
1572  * testbed this function may return error
1573  *
1574  * @param name the name of the barrier
1575  * @param cb the barrier wait callback
1576  * @param cls the closure for the above callback
1577  * @return barrier wait handle which can be used to cancel the waiting at
1578  *   anytime before the callback is called.  NULL upon error.
1579  */
1580 struct GNUNET_TESTBED_BarrierWaitHandle *
1581 GNUNET_TESTBED_barrier_wait (const char *name,
1582                              GNUNET_TESTBED_barrier_wait_cb cb,
1583                              void *cls);
1584
1585
1586 /**
1587  * Cancel a barrier wait handle.  Should not be called in or after the callback
1588  * given to GNUNET_TESTBED_barrier_wait() has been called.
1589  *
1590  * @param h the barrier wait handle
1591  */
1592 void
1593 GNUNET_TESTBED_barrier_wait_cancel (struct GNUNET_TESTBED_BarrierWaitHandle *h);
1594
1595
1596 #if 0                           /* keep Emacsens' auto-indent happy */
1597 {
1598 #endif
1599
1600
1601 #ifdef __cplusplus
1602 }
1603 #endif
1604
1605 #endif