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