src/include/gnunet_testing_lib.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008, 2009 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_testing_lib.h
  23  * @brief convenience API for writing testcases for GNUnet
  24  *        Many testcases need to start and stop gnunetd,
  25  *        and this library is supposed to make that easier
  26  *        for TESTCASES.  Normal programs should always
  27  *        use functions from gnunet_{util,arm}_lib.h.  This API is
  28  *        ONLY for writing testcases!
  29  * @author Christian Grothoff
  30  */
  31
  32 #ifndef GNUNET_TESTING_LIB_H
  33 #define GNUNET_TESTING_LIB_H
  34
  35 #include "gnunet_util_lib.h"
  36 #include "gnunet_statistics_service.h"
  37
  38 #ifdef __cplusplus
  39 extern "C"
  40 {
  41 #if 0                           /* keep Emacsens' auto-indent happy */
  42 }
  43 #endif
  44 #endif
  45
  46 #define HOSTKEYFILESIZE 914
  47
  48 /**
  49  * Handle for a GNUnet daemon (technically a set of
  50  * daemons; the handle is really for the master ARM
  51  * daemon) started by the testing library.
  52  */
  53 struct GNUNET_TESTING_Daemon;
  54
  55 /**
  56  * Linked list of hostnames and ports to use for starting daemons.
  57  */
  58 struct GNUNET_TESTING_Host
  59 {
  60   /**
  61    * Pointer to next item in the list.
  62    */
  63   struct GNUNET_TESTING_Host *next;
  64
  65   /**
  66    * Hostname to connect to.
  67    */
  68   char *hostname;
  69
  70   /**
  71    * Username to use when connecting (may be null).
  72    */
  73   char *username;
  74
  75   /**
  76    * Port to use for SSH connection (used for ssh
  77    * connection forwarding, 0 to let ssh decide)
  78    */
  79   uint16_t port;
  80 };
  81
  82 /**
  83  * Prototype of a function that will be called whenever
  84  * a daemon was started by the testing library.
  85  *
  86  * @param cls closure
  87  * @param id identifier for the daemon, NULL on error
  88  * @param d handle for the daemon
  89  * @param emsg error message (NULL on success)
  90  */
  91 typedef void (*GNUNET_TESTING_NotifyHostkeyCreated) (void *cls,
  92                                                      const struct
  93                                                      GNUNET_PeerIdentity * id,
  94                                                      struct
  95                                                      GNUNET_TESTING_Daemon * d,
  96                                                      const char *emsg);
  97
  98 /**
  99  * Prototype of a function that will be called whenever
 100  * a daemon was started by the testing library.
 101  *
 102  * @param cls closure
 103  * @param id identifier for the daemon, NULL on error
 104  * @param cfg configuration used by this daemon
 105  * @param d handle for the daemon
 106  * @param emsg error message (NULL on success)
 107  */
 108 typedef void (*GNUNET_TESTING_NotifyDaemonRunning) (void *cls,
 109                                                     const struct
 110                                                     GNUNET_PeerIdentity * id,
 111                                                     const struct
 112                                                     GNUNET_CONFIGURATION_Handle
 113                                                     * cfg,
 114                                                     struct GNUNET_TESTING_Daemon
 115                                                     * d, const char *emsg);
 116
 117 /**
 118  * Handle to an entire testbed of GNUnet peers.
 119  */
 120 struct GNUNET_TESTING_Testbed;
 121
 122 /**
 123  * Phases of starting GNUnet on a system.
 124  */
 125 enum GNUNET_TESTING_StartPhase
 126 {
 127   /**
 128    * Copy the configuration file to the target system.
 129    */
 130   SP_COPYING,
 131
 132   /**
 133    * Configuration file has been copied, generate hostkey.
 134    */
 135   SP_COPIED,
 136
 137   /**
 138    * Create the hostkey for the peer.
 139    */
 140   SP_HOSTKEY_CREATE,
 141
 142   /**
 143    * Hostkey generated, wait for topology to be finished.
 144    */
 145   SP_HOSTKEY_CREATED,
 146
 147   /**
 148    * Topology has been created, now start ARM.
 149    */
 150   SP_TOPOLOGY_SETUP,
 151
 152   /**
 153    * ARM has been started, check that it has properly daemonized and
 154    * then try to connect to the CORE service (which should be
 155    * auto-started by ARM).
 156    */
 157   SP_START_ARMING,
 158
 159   /**
 160    * We're waiting for CORE to start.
 161    */
 162   SP_START_CORE,
 163
 164   /**
 165    * CORE is up, now make sure we get the HELLO for this peer.
 166    */
 167   SP_GET_HELLO,
 168
 169   /**
 170    * Core has notified us that we've established a connection to the service.
 171    * The main FSM halts here and waits to be moved to UPDATE or CLEANUP.
 172    */
 173   SP_START_DONE,
 174
 175   /**
 176    * We've been asked to terminate the instance and are now waiting for
 177    * the remote command to stop the gnunet-arm process and delete temporary
 178    * files.
 179    */
 180   SP_SHUTDOWN_START,
 181
 182   /**
 183    * We should shutdown a *single* service via gnunet-arm.  Call the dead_cb
 184    * upon notification from gnunet-arm that the service has been stopped.
 185    */
 186   SP_SERVICE_SHUTDOWN_START,
 187
 188   /**
 189    * We should start a *single* service via gnunet-arm.  Call the daemon cb
 190    * upon notification from gnunet-arm that the service has been started.
 191    */
 192   SP_SERVICE_START,
 193
 194   /**
 195    * We've received a configuration update and are currently waiting for
 196    * the copy process for the update to complete.  Once it is, we will
 197    * return to "SP_START_DONE" (and rely on ARM to restart all affected
 198    * services).
 199    */
 200   SP_CONFIG_UPDATE
 201 };
 202
 203 /**
 204  * Prototype of a function that will be called when a
 205  * particular operation was completed the testing library.
 206  *
 207  * @param cls closure
 208  * @param emsg NULL on success
 209  */
 210 typedef void (*GNUNET_TESTING_NotifyCompletion) (void *cls, const char *emsg);
 211
 212 /**
 213  * Prototype of a function that will be called with the
 214  * number of connections created for a particular topology.
 215  *
 216  * @param cls closure
 217  * @param num_connections the number of connections created
 218  */
 219 typedef void (*GNUNET_TESTING_NotifyConnections) (void *cls,
 220                                                   unsigned int num_connections);
 221
 222 /**
 223  * Handle for a GNUnet daemon (technically a set of
 224  * daemons; the handle is really for the master ARM
 225  * daemon) started by the testing library.
 226  */
 227 struct GNUNET_TESTING_Daemon
 228 {
 229   /**
 230    * Our configuration.
 231    */
 232   struct GNUNET_CONFIGURATION_Handle *cfg;
 233
 234   /**
 235    * At what time to give up starting the peer
 236    */
 237   struct GNUNET_TIME_Absolute max_timeout;
 238
 239   /**
 240    * Host to run GNUnet on.
 241    */
 242   char *hostname;
 243
 244   /**
 245    * Port to use for ssh, NULL to let system choose default.
 246    */
 247   char *ssh_port_str;
 248
 249   /**
 250    * Result of GNUNET_i2s of this peer,
 251    * for printing
 252    */
 253   char *shortname;
 254
 255   /**
 256    * Username we are using.
 257    */
 258   char *username;
 259
 260   /**
 261    * Name of the configuration file
 262    */
 263   char *cfgfile;
 264
 265   /**
 266    * Callback to inform initiator that the peer's
 267    * hostkey has been created.
 268    */
 269   GNUNET_TESTING_NotifyHostkeyCreated hostkey_callback;
 270
 271   /**
 272    * Closure for hostkey creation callback.
 273    */
 274   void *hostkey_cls;
 275
 276   /**
 277    * Function to call when the peer is running.
 278    */
 279   GNUNET_TESTING_NotifyDaemonRunning cb;
 280
 281   /**
 282    * Closure for cb.
 283    */
 284   void *cb_cls;
 285
 286   /**
 287    * Arguments from "daemon_stop" call.
 288    */
 289   GNUNET_TESTING_NotifyCompletion dead_cb;
 290
 291   /**
 292    * Closure for 'dead_cb'.
 293    */
 294   void *dead_cb_cls;
 295
 296   /**
 297    * Arguments from "daemon_stop" call.
 298    */
 299   GNUNET_TESTING_NotifyCompletion update_cb;
 300
 301   /**
 302    * Closure for 'update_cb'.
 303    */
 304   void *update_cb_cls;
 305
 306   /**
 307    * PID of the process that we started last.
 308    */
 309   struct GNUNET_OS_Process *proc;
 310
 311   /**
 312    * Handle to the server.
 313    */
 314   struct GNUNET_CORE_Handle *server;
 315
 316   /**
 317    * Handle to the transport service of this peer
 318    */
 319   struct GNUNET_TRANSPORT_Handle *th;
 320
 321   /**
 322    * Handle for getting HELLOs from transport
 323    */
 324   struct GNUNET_TRANSPORT_GetHelloHandle *ghh;
 325
 326   /**
 327    * HELLO message for this peer
 328    */
 329   struct GNUNET_HELLO_Message *hello;
 330
 331   /**
 332    * Handle to a pipe for reading the hostkey.
 333    */
 334   struct GNUNET_DISK_PipeHandle *pipe_stdout;
 335
 336   /**
 337    * Currently, a single char * pointing to a service
 338    * that has been churned off.
 339    *
 340    * FIXME: make this a linked list of services that have been churned off!!!
 341    */
 342   char *churned_services;
 343
 344   /**
 345    * ID of the current task.
 346    */
 347   GNUNET_SCHEDULER_TaskIdentifier task;
 348
 349   /**
 350    * Identity of this peer (once started).
 351    */
 352   struct GNUNET_PeerIdentity id;
 353
 354   /**
 355    * Flag to indicate that we've already been asked
 356    * to terminate (but could not because some action
 357    * was still pending).
 358    */
 359   int dead;
 360
 361   /**
 362    * GNUNET_YES if the hostkey has been created
 363    * for this peer, GNUNET_NO otherwise.
 364    */
 365   int have_hostkey;
 366
 367   /**
 368    * In which phase are we during the start of
 369    * this process?
 370    */
 371   enum GNUNET_TESTING_StartPhase phase;
 372
 373   /**
 374    * Current position in 'hostkeybuf' (for reading from gnunet-peerinfo)
 375    */
 376   unsigned int hostkeybufpos;
 377
 378   /**
 379    * Set to GNUNET_YES once the peer is up.
 380    */
 381   int running;
 382
 383   /**
 384    * Used to tell shutdown not to remove configuration for the peer
 385    * (if it's going to be restarted later)
 386    */
 387   int churn;
 388
 389   /**
 390    * Output from gnunet-peerinfo is read into this buffer.
 391    */
 392   char hostkeybuf[105];
 393
 394 };
 395
 396
 397 /**
 398  * Handle to a group of GNUnet peers.
 399  */
 400 struct GNUNET_TESTING_PeerGroup;
 401
 402
 403 /**
 404  * Prototype of a function that will be called whenever
 405  * two daemons are connected by the testing library.
 406  *
 407  * @param cls closure
 408  * @param first peer id for first daemon
 409  * @param second peer id for the second daemon
 410  * @param distance distance between the connected peers
 411  * @param first_cfg config for the first daemon
 412  * @param second_cfg config for the second daemon
 413  * @param first_daemon handle for the first daemon
 414  * @param second_daemon handle for the second daemon
 415  * @param emsg error message (NULL on success)
 416  */
 417 typedef void (*GNUNET_TESTING_NotifyConnection) (void *cls,
 418                                                  const struct
 419                                                  GNUNET_PeerIdentity * first,
 420                                                  const struct
 421                                                  GNUNET_PeerIdentity * second,
 422                                                  uint32_t distance,
 423                                                  const struct
 424                                                  GNUNET_CONFIGURATION_Handle *
 425                                                  first_cfg,
 426                                                  const struct
 427                                                  GNUNET_CONFIGURATION_Handle *
 428                                                  second_cfg,
 429                                                  struct GNUNET_TESTING_Daemon *
 430                                                  first_daemon,
 431                                                  struct GNUNET_TESTING_Daemon *
 432                                                  second_daemon,
 433                                                  const char *emsg);
 434
 435
 436 /**
 437  * Prototype of a callback function indicating that two peers
 438  * are currently connected.
 439  *
 440  * @param cls closure
 441  * @param first peer id for first daemon
 442  * @param second peer id for the second daemon
 443  * @param distance distance between the connected peers
 444  * @param emsg error message (NULL on success)
 445  */
 446 typedef void (*GNUNET_TESTING_NotifyTopology) (void *cls,
 447                                                const struct GNUNET_PeerIdentity
 448                                                * first,
 449                                                const struct GNUNET_PeerIdentity
 450                                                * second, const char *emsg);
 451
 452
 453 /**
 454  * Starts a GNUnet daemon.  GNUnet must be installed on the target
 455  * system and available in the PATH.  The machine must furthermore be
 456  * reachable via "ssh" (unless the hostname is "NULL") without the
 457  * need to enter a password.
 458  *
 459  * @param cfg configuration to use
 460  * @param timeout how long to wait starting up peers
 461  * @param pretend GNUNET_YES to set up files but not start peer GNUNET_NO
 462  *                to really start the peer (default)
 463  * @param hostname name of the machine where to run GNUnet
 464  *        (use NULL for localhost).
 465  * @param ssh_username ssh username to use when connecting to hostname
 466  * @param sshport port to pass to ssh process when connecting to hostname
 467  * @param hostkey pointer to a hostkey to be written to disk (instead of being generated)
 468  * @param hostkey_callback function to call once the hostkey has been
 469  *        generated for this peer, but it hasn't yet been started
 470  *        (NULL to start immediately, otherwise waits on GNUNET_TESTING_daemon_continue_start)
 471  * @param hostkey_cls closure for hostkey callback
 472  * @param cb function to call once peer is up, or failed to start
 473  * @param cb_cls closure for cb
 474  * @return handle to the daemon (actual start will be completed asynchronously)
 475  */
 476 struct GNUNET_TESTING_Daemon *
 477 GNUNET_TESTING_daemon_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 478                              struct GNUNET_TIME_Relative timeout, int pretend,
 479                              const char *hostname, const char *ssh_username,
 480                              uint16_t sshport, const char *hostkey,
 481                              GNUNET_TESTING_NotifyHostkeyCreated
 482                              hostkey_callback, void *hostkey_cls,
 483                              GNUNET_TESTING_NotifyDaemonRunning cb,
 484                              void *cb_cls);
 485
 486 /**
 487  * Continues GNUnet daemon startup when user wanted to be notified
 488  * once a hostkey was generated (for creating friends files, blacklists,
 489  * etc.).
 490  *
 491  * @param daemon the daemon to finish starting
 492  */
 493 void
 494 GNUNET_TESTING_daemon_continue_startup (struct GNUNET_TESTING_Daemon *daemon);
 495
 496
 497 /**
 498  * Check whether the given daemon is running.
 499  *
 500  * @param daemon the daemon to check
 501  * @return GNUNET_YES if the daemon is up, GNUNET_NO if the
 502  *         daemon is down, GNUNET_SYSERR on error.
 503  */
 504 int
 505 GNUNET_TESTING_test_daemon_running (struct GNUNET_TESTING_Daemon *daemon);
 506
 507
 508 /**
 509  * Obtain the peer identity of the peer with the given configuration
 510  * handle.  This function reads the private key of the peer, obtains
 511  * the public key and hashes it.
 512  *
 513  * @param cfg configuration of the peer
 514  * @param pid where to store the peer identity
 515  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 516  */
 517 int
 518 GNUNET_TESTING_get_peer_identity (const struct GNUNET_CONFIGURATION_Handle *cfg,
 519                                   struct GNUNET_PeerIdentity *pid);
 520
 521
 522 /**
 523  * Restart (stop and start) a GNUnet daemon.
 524  *
 525  * @param d the daemon that should be restarted
 526  * @param cb function called once the daemon is (re)started
 527  * @param cb_cls closure for cb
 528  */
 529 void
 530 GNUNET_TESTING_daemon_restart (struct GNUNET_TESTING_Daemon *d,
 531                                GNUNET_TESTING_NotifyDaemonRunning cb,
 532                                void *cb_cls);
 533
 534
 535 /**
 536  * Start a peer that has previously been stopped using the daemon_stop
 537  * call (and files weren't deleted and the allow restart flag)
 538  *
 539  * @param daemon the daemon to start (has been previously stopped)
 540  * @param timeout how long to wait for restart
 541  * @param cb the callback for notification when the peer is running
 542  * @param cb_cls closure for the callback
 543  */
 544 void
 545 GNUNET_TESTING_daemon_start_stopped (struct GNUNET_TESTING_Daemon *daemon,
 546                                      struct GNUNET_TIME_Relative timeout,
 547                                      GNUNET_TESTING_NotifyDaemonRunning cb,
 548                                      void *cb_cls);
 549
 550
 551 /**
 552  * Starts a GNUnet daemon's service.
 553  *
 554  * @param d the daemon for which the service should be started
 555  * @param service the name of the service to start
 556  * @param timeout how long to wait for process for startup
 557  * @param cb function called once gnunet-arm returns
 558  * @param cb_cls closure for cb
 559  */
 560 void
 561 GNUNET_TESTING_daemon_start_service (struct GNUNET_TESTING_Daemon *d,
 562                                      const char *service,
 563                                      struct GNUNET_TIME_Relative timeout,
 564                                      GNUNET_TESTING_NotifyDaemonRunning cb,
 565                                      void *cb_cls);
 566
 567
 568 /**
 569  * Starts a GNUnet daemon's service which has been previously turned off.
 570  *
 571  * @param d the daemon for which the service should be started
 572  * @param service the name of the service to start
 573  * @param timeout how long to wait for process for startup
 574  * @param cb function called once gnunet-arm returns
 575  * @param cb_cls closure for cb
 576  */
 577 void
 578 GNUNET_TESTING_daemon_start_stopped_service (struct GNUNET_TESTING_Daemon *d,
 579                                              char *service,
 580                                              struct GNUNET_TIME_Relative
 581                                              timeout,
 582                                              GNUNET_TESTING_NotifyDaemonRunning
 583                                              cb, void *cb_cls);
 584
 585
 586 /**
 587  * Get a certain testing daemon handle.
 588  *
 589  * @param pg handle to the set of running peers
 590  * @param position the number of the peer to return
 591  */
 592 struct GNUNET_TESTING_Daemon *
 593 GNUNET_TESTING_daemon_get (struct GNUNET_TESTING_PeerGroup *pg,
 594                            unsigned int position);
 595
 596
 597 /**
 598  * Get a daemon by peer identity, so callers can
 599  * retrieve the daemon without knowing it's offset.
 600  *
 601  * @param pg the peer group to retrieve the daemon from
 602  * @param peer_id the peer identity of the daemon to retrieve
 603  *
 604  * @return the daemon on success, or NULL if no such peer identity is found
 605  */
 606 struct GNUNET_TESTING_Daemon *
 607 GNUNET_TESTING_daemon_get_by_id (struct GNUNET_TESTING_PeerGroup *pg,
 608                                  const struct GNUNET_PeerIdentity *peer_id);
 609
 610
 611 /**
 612  * Stops a GNUnet daemon.
 613  *
 614  * @param d the daemon that should be stopped
 615  * @param timeout how long to wait for process for shutdown to complete
 616  * @param cb function called once the daemon was stopped
 617  * @param cb_cls closure for cb
 618  * @param delete_files GNUNET_YES to remove files, GNUNET_NO
 619  *        to leave them (i.e. for restarting at a later time,
 620  *        or logfile inspection once finished)
 621  * @param allow_restart GNUNET_YES to restart peer later (using this API)
 622  *        GNUNET_NO to kill off and clean up for good
 623  */
 624 void
 625 GNUNET_TESTING_daemon_stop (struct GNUNET_TESTING_Daemon *d,
 626                             struct GNUNET_TIME_Relative timeout,
 627                             GNUNET_TESTING_NotifyCompletion cb, void *cb_cls,
 628                             int delete_files, int allow_restart);
 629
 630
 631
 632 /**
 633  * Create a new configuration using the given configuration
 634  * as a template; however, each PORT in the existing cfg
 635  * must be renumbered by incrementing "*port".  If we run
 636  * out of "*port" numbers, return NULL.
 637  *
 638  * @param cfg template configuration
 639  * @param off the current peer offset
 640  * @param port port numbers to use, update to reflect
 641  *             port numbers that were used
 642  * @param upnum number to make unix domain socket names unique
 643  * @param hostname hostname of the controlling host, to allow control connections from
 644  * @param fdnum number used to offset the unix domain socket for grouped processes
 645  *              (such as statistics or peerinfo, which can be shared among others)
 646  *
 647  * @return new configuration, NULL on error
 648  */
 649 struct GNUNET_CONFIGURATION_Handle *
 650 GNUNET_TESTING_create_cfg (const struct GNUNET_CONFIGURATION_Handle *cfg, uint32_t off,
 651              uint16_t * port, uint32_t * upnum, const char *hostname,
 652              uint32_t * fdnum);
 653
 654 /**
 655  * Changes the configuration of a GNUnet daemon.
 656  *
 657  * @param d the daemon that should be modified
 658  * @param cfg the new configuration for the daemon
 659  * @param cb function called once the configuration was changed
 660  * @param cb_cls closure for cb
 661  */
 662 void
 663 GNUNET_TESTING_daemon_reconfigure (struct GNUNET_TESTING_Daemon *d,
 664                                    struct GNUNET_CONFIGURATION_Handle *cfg,
 665                                    GNUNET_TESTING_NotifyCompletion cb,
 666                                    void *cb_cls);
 667
 668
 669 /**
 670  * Stops a single service of a GNUnet daemon.  Used like daemon_stop,
 671  * only doesn't stop the entire peer in any case.  If the service
 672  * is not currently running, this call is likely to fail after
 673  * timeout!
 674  *
 675  * @param d the daemon that should be stopped
 676  * @param service the name of the service to stop
 677  * @param timeout how long to wait for process for shutdown to complete
 678  * @param cb function called once the service was stopped
 679  * @param cb_cls closure for cb
 680  */
 681 void
 682 GNUNET_TESTING_daemon_stop_service (struct GNUNET_TESTING_Daemon *d,
 683                                     const char *service,
 684                                     struct GNUNET_TIME_Relative timeout,
 685                                     GNUNET_TESTING_NotifyCompletion cb,
 686                                     void *cb_cls);
 687
 688
 689 /**
 690  * Read a testing hosts file based on a configuration.
 691  * Returns a DLL of hosts (caller must free!) on success
 692  * or NULL on failure.
 693  *
 694  * @param cfg a configuration with a testing section
 695  *
 696  * @return DLL of hosts on success, NULL on failure
 697  */
 698 struct GNUNET_TESTING_Host *
 699 GNUNET_TESTING_hosts_load (const struct GNUNET_CONFIGURATION_Handle *cfg);
 700
 701
 702 /**
 703  * Start count gnunet instances with the same set of transports and
 704  * applications.  The port numbers (any option called "PORT") will be
 705  * adjusted to ensure that no two peers running on the same system
 706  * have the same port(s) in their respective configurations.
 707  *
 708  * @param cfg configuration template to use
 709  * @param total number of daemons to start
 710  * @param max_concurrent_connections for testing, how many peers can
 711 *                                   we connect to simultaneously
 712  * @param max_concurrent_ssh when starting with ssh, how many ssh
 713  *        connections will we allow at once (based on remote hosts allowed!)
 714  * @param timeout total time allowed for peers to start
 715  * @param hostkey_callback function to call on each peers hostkey generation
 716  *        if NULL, peers will be started by this call, if non-null,
 717  *        GNUNET_TESTING_daemons_continue_startup must be called after
 718  *        successful hostkey generation
 719  * @param hostkey_cls closure for hostkey callback
 720  * @param cb function to call on each daemon that was started
 721  * @param cb_cls closure for cb
 722  * @param connect_callback function to call each time two hosts are connected
 723  * @param connect_callback_cls closure for connect_callback
 724  * @param hostnames linked list of host structs to use to start peers on
 725  *                  (NULL to run on localhost only)
 726  *
 727  * @return NULL on error, otherwise handle to control peer group
 728  */
 729 struct GNUNET_TESTING_PeerGroup *
 730 GNUNET_TESTING_daemons_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 731                               unsigned int total,
 732                               unsigned int max_concurrent_connections,
 733                               unsigned int max_concurrent_ssh,
 734                               struct GNUNET_TIME_Relative timeout,
 735                               GNUNET_TESTING_NotifyHostkeyCreated
 736                               hostkey_callback, void *hostkey_cls,
 737                               GNUNET_TESTING_NotifyDaemonRunning cb,
 738                               void *cb_cls,
 739                               GNUNET_TESTING_NotifyConnection connect_callback,
 740                               void *connect_callback_cls,
 741                               const struct GNUNET_TESTING_Host *hostnames);
 742
 743
 744 /**
 745  * Function which continues a peer group starting up
 746  * after successfully generating hostkeys for each peer.
 747  *
 748  * @param pg the peer group to continue starting
 749  */
 750 void
 751 GNUNET_TESTING_daemons_continue_startup (struct GNUNET_TESTING_PeerGroup *pg);
 752
 753
 754 /**
 755  * Handle for an active request to connect two peers.
 756  */
 757 struct GNUNET_TESTING_ConnectContext;
 758
 759
 760 /**
 761  * Establish a connection between two GNUnet daemons.  The daemons
 762  * must both be running and not be stopped until either the
 763  * 'cb' callback is called OR the connection request has been
 764  * explicitly cancelled.
 765  *
 766  * @param d1 handle for the first daemon
 767  * @param d2 handle for the second daemon
 768  * @param timeout how long is the connection attempt
 769  *        allowed to take?
 770  * @param max_connect_attempts how many times should we try to reconnect
 771  *        (within timeout)
 772  * @param send_hello GNUNET_YES to send the HELLO, GNUNET_NO to assume
 773  *                   the HELLO has already been exchanged
 774  * @param cb function to call at the end
 775  * @param cb_cls closure for cb
 776  * @return handle to cancel the request, NULL on error
 777  */
 778 struct GNUNET_TESTING_ConnectContext *
 779 GNUNET_TESTING_daemons_connect (struct GNUNET_TESTING_Daemon *d1,
 780                                 struct GNUNET_TESTING_Daemon *d2,
 781                                 struct GNUNET_TIME_Relative timeout,
 782                                 unsigned int max_connect_attempts,
 783                                 int send_hello,
 784                                 GNUNET_TESTING_NotifyConnection cb,
 785                                 void *cb_cls);
 786
 787
 788
 789 /**
 790  * Cancel an attempt to connect two daemons.
 791  *
 792  * @param cc connect context
 793  */
 794 void
 795 GNUNET_TESTING_daemons_connect_cancel (struct GNUNET_TESTING_ConnectContext
 796                                        *cc);
 797
 798
 799
 800 /**
 801  * Restart all peers in the given group.
 802  *
 803  * @param pg the handle to the peer group
 804  * @param callback function to call on completion (or failure)
 805  * @param callback_cls closure for the callback function
 806  */
 807 void
 808 GNUNET_TESTING_daemons_restart (struct GNUNET_TESTING_PeerGroup *pg,
 809                                 GNUNET_TESTING_NotifyCompletion callback,
 810                                 void *callback_cls);
 811
 812
 813 /**
 814  * Shutdown all peers started in the given group.
 815  *
 816  * @param pg handle to the peer group
 817  * @param timeout how long to wait for shutdown
 818  * @param cb callback to notify upon success or failure
 819  * @param cb_cls closure for cb
 820  */
 821 void
 822 GNUNET_TESTING_daemons_stop (struct GNUNET_TESTING_PeerGroup *pg,
 823                              struct GNUNET_TIME_Relative timeout,
 824                              GNUNET_TESTING_NotifyCompletion cb, void *cb_cls);
 825
 826
 827 /**
 828  * Count the number of running peers.
 829  *
 830  * @param pg handle for the peer group
 831  *
 832  * @return the number of currently running peers in the peer group
 833  */
 834 unsigned int
 835 GNUNET_TESTING_daemons_running (struct GNUNET_TESTING_PeerGroup *pg);
 836
 837
 838 /**
 839  * Simulate churn by stopping some peers (and possibly
 840  * re-starting others if churn is called multiple times).  This
 841  * function can only be used to create leave-join churn (peers "never"
 842  * leave for good).  First "voff" random peers that are currently
 843  * online will be taken offline; then "von" random peers that are then
 844  * offline will be put back online.  No notifications will be
 845  * generated for any of these operations except for the callback upon
 846  * completion.  Note that the implementation is at liberty to keep
 847  * the ARM service itself (but none of the other services or daemons)
 848  * running even though the "peer" is being varied offline.
 849  *
 850  * @param pg handle for the peer group
 851  * @param service the service to churn on/off, NULL for all
 852  * @param voff number of peers that should go offline
 853  * @param von number of peers that should come back online;
 854  *            must be zero on first call (since "testbed_start"
 855  *            always starts all of the peers)
 856  * @param timeout how long to wait for operations to finish before
 857  *        giving up
 858  * @param cb function to call at the end
 859  * @param cb_cls closure for cb
 860  */
 861 void
 862 GNUNET_TESTING_daemons_churn (struct GNUNET_TESTING_PeerGroup *pg,
 863                               char *service, unsigned int voff,
 864                               unsigned int von,
 865                               struct GNUNET_TIME_Relative timeout,
 866                               GNUNET_TESTING_NotifyCompletion cb, void *cb_cls);
 867
 868
 869 /**
 870  * Start a given service for each of the peers in the peer group.
 871  *
 872  * @param pg handle for the peer group
 873  * @param service the service to start
 874  * @param timeout how long to wait for operations to finish before
 875  *        giving up
 876  * @param cb function to call once finished
 877  * @param cb_cls closure for cb
 878  *
 879  */
 880 void
 881 GNUNET_TESTING_daemons_start_service (struct GNUNET_TESTING_PeerGroup *pg,
 882                                       char *service,
 883                                       struct GNUNET_TIME_Relative timeout,
 884                                       GNUNET_TESTING_NotifyCompletion cb,
 885                                       void *cb_cls);
 886
 887
 888 /**
 889  * Callback function to process statistic values.
 890  *
 891  * @param cls closure
 892  * @param peer the peer the statistics belong to
 893  * @param subsystem name of subsystem that created the statistic
 894  * @param name the name of the datum
 895  * @param value the current value
 896  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
 897  * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
 898  */
 899 typedef int (*GNUNET_TESTING_STATISTICS_Iterator) (void *cls,
 900                                                    const struct
 901                                                    GNUNET_PeerIdentity * peer,
 902                                                    const char *subsystem,
 903                                                    const char *name,
 904                                                    uint64_t value,
 905                                                    int is_persistent);
 906
 907
 908 /**
 909  * Iterate over all (running) peers in the peer group, retrieve
 910  * all statistics from each.
 911  *
 912  * @param pg the peergroup to iterate statistics of
 913  * @param cont continuation to call once call is completed(?)
 914  * @param proc processing function for each statistic retrieved
 915  * @param cls closure to pass to proc
 916  */
 917 void
 918 GNUNET_TESTING_get_statistics (struct GNUNET_TESTING_PeerGroup *pg,
 919                                GNUNET_STATISTICS_Callback cont,
 920                                GNUNET_TESTING_STATISTICS_Iterator proc,
 921                                void *cls);
 922
 923
 924 /**
 925  * Topologies supported for testbeds.
 926  */
 927 enum GNUNET_TESTING_Topology
 928 {
 929   /**
 930    * A clique (everyone connected to everyone else).
 931    */
 932   GNUNET_TESTING_TOPOLOGY_CLIQUE,
 933
 934   /**
 935    * Small-world network (2d torus plus random links).
 936    */
 937   GNUNET_TESTING_TOPOLOGY_SMALL_WORLD,
 938
 939   /**
 940    * Small-world network (ring plus random links).
 941    */
 942   GNUNET_TESTING_TOPOLOGY_SMALL_WORLD_RING,
 943
 944   /**
 945    * Ring topology.
 946    */
 947   GNUNET_TESTING_TOPOLOGY_RING,
 948
 949   /**
 950    * 2-d torus.
 951    */
 952   GNUNET_TESTING_TOPOLOGY_2D_TORUS,
 953
 954   /**
 955    * Random graph.
 956    */
 957   GNUNET_TESTING_TOPOLOGY_ERDOS_RENYI,
 958
 959   /**
 960    * Certain percentage of peers are unable to communicate directly
 961    * replicating NAT conditions
 962    */
 963   GNUNET_TESTING_TOPOLOGY_INTERNAT,
 964
 965   /**
 966    * Scale free topology.
 967    */
 968   GNUNET_TESTING_TOPOLOGY_SCALE_FREE,
 969
 970   /**
 971    * Straight line topology.
 972    */
 973   GNUNET_TESTING_TOPOLOGY_LINE,
 974
 975   /**
 976    * All peers are disconnected.
 977    */
 978   GNUNET_TESTING_TOPOLOGY_NONE,
 979
 980   /**
 981    * Read a topology from a given file.
 982    */
 983   GNUNET_TESTING_TOPOLOGY_FROM_FILE
 984 };
 985
 986 /**
 987  * Options for connecting a topology.
 988  */
 989 enum GNUNET_TESTING_TopologyOption
 990 {
 991   /**
 992    * Try to connect all peers specified in the topology.
 993    */
 994   GNUNET_TESTING_TOPOLOGY_OPTION_ALL,
 995
 996   /**
 997    * Choose a random subset of connections to create.
 998    */
 999   GNUNET_TESTING_TOPOLOGY_OPTION_RANDOM,
1000
1001   /**
1002    * Create at least X connections for each peer.
1003    */
1004   GNUNET_TESTING_TOPOLOGY_OPTION_MINIMUM,
1005
1006   /**
1007    * Using a depth first search, create one connection
1008    * per peer.  If any are missed (graph disconnected)
1009    * start over at those peers until all have at least one
1010    * connection.
1011    */
1012   GNUNET_TESTING_TOPOLOGY_OPTION_DFS,
1013
1014   /**
1015    * Find the N closest peers to each allowed peer in the
1016    * topology and make sure a connection to those peers
1017    * exists in the connect topology.
1018    */
1019   GNUNET_TESTING_TOPOLOGY_OPTION_ADD_CLOSEST,
1020
1021   /**
1022    * No options specified.
1023    */
1024   GNUNET_TESTING_TOPOLOGY_OPTION_NONE
1025 };
1026
1027
1028 /**
1029  * Get a topology from a string input.
1030  *
1031  * @param topology where to write the retrieved topology
1032  * @param topology_string The string to attempt to
1033  *        get a configuration value from
1034  * @return GNUNET_YES if topology string matched a
1035  *         known topology, GNUNET_NO if not
1036  */
1037 int
1038 GNUNET_TESTING_topology_get (enum GNUNET_TESTING_Topology *topology,
1039                              const char *topology_string);
1040
1041
1042 /**
1043  * Get connect topology option from string input.
1044  *
1045  * @param topology_option where to write the retrieved topology
1046  * @param topology_string The string to attempt to
1047  *        get a configuration value from
1048  * @return GNUNET_YES if topology string matched a
1049  *         known topology, GNUNET_NO if not
1050  */
1051 int
1052 GNUNET_TESTING_topology_option_get (enum GNUNET_TESTING_TopologyOption
1053                                     *topology_option,
1054                                     const char *topology_string);
1055
1056
1057 /**
1058  * Takes a peer group and creates a topology based on the
1059  * one specified.  Creates a topology means generates friend
1060  * files for the peers so they can only connect to those allowed
1061  * by the topology.  This will only have an effect once peers
1062  * are started if the FRIENDS_ONLY option is set in the base
1063  * config.
1064  *
1065  * Also takes an optional restrict topology which
1066  * disallows direct connections UNLESS they are specified in
1067  * the restricted topology.
1068  *
1069  * A simple example; if the topology option is set to LINE
1070  * peers can ONLY connect in a LINE.  However, if the topology
1071  * option is set to 2D-torus and the restrict option is set to
1072  * line with restrict_transports equal to "tcp udp", then peers
1073  * may connect in a 2D-torus, but will be restricted to tcp and
1074  * udp connections only in a LINE.  Generally it only makes
1075  * sense to do this if restrict_topology is a subset of topology.
1076  *
1077  * For testing peer discovery, etc. it is generally better to
1078  * leave restrict_topology as GNUNET_TESTING_TOPOLOGY_NONE and
1079  * then use the connect_topology function to restrict the initial
1080  * connection set.
1081  *
1082  * @param pg the peer group struct representing the running peers
1083  * @param topology which topology to connect the peers in
1084  * @param restrict_topology allow only direct connections in this topology,
1085  *        based on those listed in restrict_transports, set to
1086  *        GNUNET_TESTING_TOPOLOGY_NONE for no restrictions
1087  * @param restrict_transports space delimited list of transports to blacklist
1088  *                            to create restricted topology, NULL for none
1089  *
1090  * @return the maximum number of connections were all allowed peers
1091  *         connected to each other
1092  */
1093 unsigned int
1094 GNUNET_TESTING_create_topology (struct GNUNET_TESTING_PeerGroup *pg,
1095                                 enum GNUNET_TESTING_Topology topology,
1096                                 enum GNUNET_TESTING_Topology restrict_topology,
1097                                 const char *restrict_transports);
1098
1099
1100 /**
1101  * Iterate over all (running) peers in the peer group, retrieve
1102  * all connections that each currently has.
1103  *
1104  * @param pg the peer group we are concerned with
1105  * @param cb callback for topology information
1106  * @param cls closure for callback
1107  */
1108 void
1109 GNUNET_TESTING_get_topology (struct GNUNET_TESTING_PeerGroup *pg,
1110                              GNUNET_TESTING_NotifyTopology cb, void *cls);
1111
1112
1113 /**
1114  * Stop the connection process temporarily.
1115  *
1116  * @param pg the peer group to stop connecting
1117  */
1118 void
1119 GNUNET_TESTING_stop_connections (struct GNUNET_TESTING_PeerGroup *pg);
1120
1121
1122 /**
1123  * Resume the connection process.
1124  *
1125  * @param pg the peer group to resume connecting
1126  */
1127 void
1128 GNUNET_TESTING_resume_connections (struct GNUNET_TESTING_PeerGroup *pg);
1129
1130
1131 /**
1132  * There are many ways to connect peers that are supported by this function.
1133  * To connect peers in the same topology that was created via the
1134  * GNUNET_TESTING_create_topology, the topology variable must be set to
1135  * GNUNET_TESTING_TOPOLOGY_NONE.  If the topology variable is specified,
1136  * a new instance of that topology will be generated and attempted to be
1137  * connected.  This could result in some connections being impossible,
1138  * because some topologies are non-deterministic.
1139  *
1140  * @param pg the peer group struct representing the running peers
1141  * @param topology which topology to connect the peers in
1142  * @param options options for connecting the topology
1143  * @param option_modifier modifier for options that take a parameter
1144  * @param connect_timeout how long to wait before giving up on connecting
1145  *                        two peers
1146  * @param connect_attempts how many times to attempt to connect two peers
1147  *                         over the connect_timeout duration
1148  * @param notify_callback notification to be called once all connections completed
1149  * @param notify_cls closure for notification callback
1150  *
1151  * @return the number of connections that will be attempted, GNUNET_SYSERR on error
1152  */
1153 int
1154 GNUNET_TESTING_connect_topology (struct GNUNET_TESTING_PeerGroup *pg,
1155                                  enum GNUNET_TESTING_Topology topology,
1156                                  enum GNUNET_TESTING_TopologyOption options,
1157                                  double option_modifier,
1158                                  struct GNUNET_TIME_Relative connect_timeout,
1159                                  unsigned int connect_attempts,
1160                                  GNUNET_TESTING_NotifyCompletion
1161                                  notify_callback, void *notify_cls);
1162
1163
1164 /**
1165  * Start or stop an individual peer from the given group.
1166  *
1167  * @param pg handle to the peer group
1168  * @param offset which peer to start or stop
1169  * @param desired_status GNUNET_YES to have it running, GNUNET_NO to stop it
1170  * @param timeout how long to wait for shutdown
1171  * @param cb function to call at the end
1172  * @param cb_cls closure for cb
1173  */
1174 void
1175 GNUNET_TESTING_daemons_vary (struct GNUNET_TESTING_PeerGroup *pg,
1176                              unsigned int offset, int desired_status,
1177                              struct GNUNET_TIME_Relative timeout,
1178                              GNUNET_TESTING_NotifyCompletion cb, void *cb_cls);
1179
1180
1181 /**
1182  * Start a peer group with a given number of peers.  Notify
1183  * on completion of peer startup and connection based on given
1184  * topological constraints.  Optionally notify on each
1185  * established connection.
1186  *
1187  * @param cfg configuration template to use
1188  * @param total number of daemons to start
1189  * @param timeout total time allowed for peers to start
1190  * @param connect_cb function to call each time two daemons are connected
1191  * @param peergroup_cb function to call once all peers are up and connected
1192  * @param peergroup_cls closure for peergroup callbacks
1193  * @param hostnames linked list of host structs to use to start peers on
1194  *                  (NULL to run on localhost only)
1195  *
1196  * @return NULL on error, otherwise handle to control peer group
1197  */
1198 struct GNUNET_TESTING_PeerGroup *
1199 GNUNET_TESTING_peergroup_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
1200                                 unsigned int total,
1201                                 struct GNUNET_TIME_Relative timeout,
1202                                 GNUNET_TESTING_NotifyConnection connect_cb,
1203                                 GNUNET_TESTING_NotifyCompletion peergroup_cb,
1204                                 void *peergroup_cls,
1205                                 const struct GNUNET_TESTING_Host *hostnames);
1206
1207
1208 /**
1209  * Print current topology to a graphviz readable file.
1210  *
1211  * @param pg a currently running peergroup to print to file
1212  * @param output_filename the file to write the topology to
1213  * @param notify_cb callback to call upon completion or failure
1214  * @param notify_cb_cls closure for notify_cb
1215  *
1216  */
1217 void
1218 GNUNET_TESTING_peergroup_topology_to_file (struct GNUNET_TESTING_PeerGroup *pg,
1219                                            const char *output_filename,
1220                                            GNUNET_TESTING_NotifyCompletion
1221                                            notify_cb, void *notify_cb_cls);
1222
1223
1224 #if 0                           /* keep Emacsens' auto-indent happy */
1225 {
1226 #endif
1227 #ifdef __cplusplus
1228 }
1229 #endif
1230
1231 #endif