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    * HELLO message for this peer
 323    */
 324   struct GNUNET_HELLO_Message *hello;
 325
 326   /**
 327    * Handle to a pipe for reading the hostkey.
 328    */
 329   struct GNUNET_DISK_PipeHandle *pipe_stdout;
 330
 331   /**
 332    * Currently, a single char * pointing to a service
 333    * that has been churned off.
 334    *
 335    * FIXME: make this a linked list of services that have been churned off!!!
 336    */
 337   char *churned_services;
 338
 339   /**
 340    * ID of the current task.
 341    */
 342   GNUNET_SCHEDULER_TaskIdentifier task;
 343
 344   /**
 345    * Identity of this peer (once started).
 346    */
 347   struct GNUNET_PeerIdentity id;
 348
 349   /**
 350    * Flag to indicate that we've already been asked
 351    * to terminate (but could not because some action
 352    * was still pending).
 353    */
 354   int dead;
 355
 356   /**
 357    * GNUNET_YES if the hostkey has been created
 358    * for this peer, GNUNET_NO otherwise.
 359    */
 360   int have_hostkey;
 361
 362   /**
 363    * In which phase are we during the start of
 364    * this process?
 365    */
 366   enum GNUNET_TESTING_StartPhase phase;
 367
 368   /**
 369    * Current position in 'hostkeybuf' (for reading from gnunet-peerinfo)
 370    */
 371   unsigned int hostkeybufpos;
 372
 373   /**
 374    * Set to GNUNET_YES once the peer is up.
 375    */
 376   int running;
 377
 378   /**
 379    * Used to tell shutdown not to remove configuration for the peer
 380    * (if it's going to be restarted later)
 381    */
 382   int churn;
 383
 384   /**
 385    * Output from gnunet-peerinfo is read into this buffer.
 386    */
 387   char hostkeybuf[105];
 388
 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 /**
 572  * Get a daemon by peer identity, so callers can
 573  * retrieve the daemon without knowing it's offset.
 574  *
 575  * @param pg the peer group to retrieve the daemon from
 576  * @param peer_id the peer identity of the daemon to retrieve
 577  *
 578  * @return the daemon on success, or NULL if no such peer identity is found
 579  */
 580 struct GNUNET_TESTING_Daemon *
 581 GNUNET_TESTING_daemon_get_by_id (struct GNUNET_TESTING_PeerGroup *pg,
 582                                  struct GNUNET_PeerIdentity *peer_id);
 583
 584
 585 /**
 586  * Stops a GNUnet daemon.
 587  *
 588  * @param d the daemon that should be stopped
 589  * @param timeout how long to wait for process for shutdown to complete
 590  * @param cb function called once the daemon was stopped
 591  * @param cb_cls closure for cb
 592  * @param delete_files GNUNET_YES to remove files, GNUNET_NO
 593  *        to leave them (i.e. for restarting at a later time,
 594  *        or logfile inspection once finished)
 595  * @param allow_restart GNUNET_YES to restart peer later (using this API)
 596  *        GNUNET_NO to kill off and clean up for good
 597  */
 598 void
 599 GNUNET_TESTING_daemon_stop (struct GNUNET_TESTING_Daemon *d,
 600                             struct GNUNET_TIME_Relative timeout,
 601                             GNUNET_TESTING_NotifyCompletion cb, void *cb_cls,
 602                             int delete_files, int allow_restart);
 603
 604
 605 /**
 606  * Changes the configuration of a GNUnet daemon.
 607  *
 608  * @param d the daemon that should be modified
 609  * @param cfg the new configuration for the daemon
 610  * @param cb function called once the configuration was changed
 611  * @param cb_cls closure for cb
 612  */
 613 void
 614 GNUNET_TESTING_daemon_reconfigure (struct GNUNET_TESTING_Daemon *d,
 615                                    struct GNUNET_CONFIGURATION_Handle *cfg,
 616                                    GNUNET_TESTING_NotifyCompletion cb,
 617                                    void *cb_cls);
 618
 619
 620 /**
 621  * Stops a single service of a GNUnet daemon.  Used like daemon_stop,
 622  * only doesn't stop the entire peer in any case.  If the service
 623  * is not currently running, this call is likely to fail after
 624  * timeout!
 625  *
 626  * @param d the daemon that should be stopped
 627  * @param service the name of the service to stop
 628  * @param timeout how long to wait for process for shutdown to complete
 629  * @param cb function called once the service was stopped
 630  * @param cb_cls closure for cb
 631  */
 632 void
 633 GNUNET_TESTING_daemon_stop_service (struct GNUNET_TESTING_Daemon *d,
 634                                     char *service,
 635                                     struct GNUNET_TIME_Relative timeout,
 636                                     GNUNET_TESTING_NotifyCompletion cb,
 637                                     void *cb_cls);
 638
 639
 640 /**
 641  * Read a testing hosts file based on a configuration.
 642  * Returns a DLL of hosts (caller must free!) on success
 643  * or NULL on failure.
 644  *
 645  * @param cfg a configuration with a testing section
 646  *
 647  * @return DLL of hosts on success, NULL on failure
 648  */
 649 struct GNUNET_TESTING_Host *
 650 GNUNET_TESTING_hosts_load (const struct GNUNET_CONFIGURATION_Handle *cfg);
 651
 652
 653 /**
 654  * Start count gnunet instances with the same set of transports and
 655  * applications.  The port numbers (any option called "PORT") will be
 656  * adjusted to ensure that no two peers running on the same system
 657  * have the same port(s) in their respective configurations.
 658  *
 659  * @param cfg configuration template to use
 660  * @param total number of daemons to start
 661  * @param max_concurrent_connections for testing, how many peers can
 662 *                                   we connect to simultaneously
 663  * @param max_concurrent_ssh when starting with ssh, how many ssh
 664  *        connections will we allow at once (based on remote hosts allowed!)
 665  * @param timeout total time allowed for peers to start
 666  * @param hostkey_callback function to call on each peers hostkey generation
 667  *        if NULL, peers will be started by this call, if non-null,
 668  *        GNUNET_TESTING_daemons_continue_startup must be called after
 669  *        successful hostkey generation
 670  * @param hostkey_cls closure for hostkey callback
 671  * @param cb function to call on each daemon that was started
 672  * @param cb_cls closure for cb
 673  * @param connect_callback function to call each time two hosts are connected
 674  * @param connect_callback_cls closure for connect_callback
 675  * @param hostnames linked list of host structs to use to start peers on
 676  *                  (NULL to run on localhost only)
 677  *
 678  * @return NULL on error, otherwise handle to control peer group
 679  */
 680 struct GNUNET_TESTING_PeerGroup *
 681 GNUNET_TESTING_daemons_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 682                               unsigned int total,
 683                               unsigned int max_concurrent_connections,
 684                               unsigned int max_concurrent_ssh,
 685                               struct GNUNET_TIME_Relative timeout,
 686                               GNUNET_TESTING_NotifyHostkeyCreated
 687                               hostkey_callback, void *hostkey_cls,
 688                               GNUNET_TESTING_NotifyDaemonRunning cb,
 689                               void *cb_cls,
 690                               GNUNET_TESTING_NotifyConnection connect_callback,
 691                               void *connect_callback_cls,
 692                               const struct GNUNET_TESTING_Host *hostnames);
 693
 694
 695 /**
 696  * Function which continues a peer group starting up
 697  * after successfully generating hostkeys for each peer.
 698  *
 699  * @param pg the peer group to continue starting
 700  */
 701 void
 702 GNUNET_TESTING_daemons_continue_startup (struct GNUNET_TESTING_PeerGroup *pg);
 703
 704
 705 /**
 706  * Establish a connection between two GNUnet daemons.
 707  *
 708  * @param d1 handle for the first daemon
 709  * @param d2 handle for the second daemon
 710  * @param timeout how long is the connection attempt
 711  *        allowed to take?
 712  * @param max_connect_attempts how many times should we try to reconnect
 713  *        (within timeout)
 714  * @param send_hello GNUNET_YES to send the HELLO, GNUNET_NO to assume
 715  *                   the HELLO has already been exchanged
 716  * @param cb function to call at the end
 717  * @param cb_cls closure for cb
 718  */
 719 struct GNUNET_TESTING_ConnectContext *
 720 GNUNET_TESTING_daemons_connect (struct GNUNET_TESTING_Daemon *d1,
 721                                 struct GNUNET_TESTING_Daemon *d2,
 722                                 struct GNUNET_TIME_Relative timeout,
 723                                 unsigned int max_connect_attempts,
 724                                 int send_hello,
 725                                 GNUNET_TESTING_NotifyConnection cb,
 726                                 void *cb_cls);
 727
 728
 729 /**
 730  * Cancel an attempt to connect two daemons.
 731  *
 732  * @param cc connect context
 733  */
 734 void
 735 GNUNET_TESTING_daemons_connect_cancel (struct GNUNET_TESTING_ConnectContext *cc);
 736
 737
 738 /**
 739  * Restart all peers in the given group.
 740  *
 741  * @param pg the handle to the peer group
 742  * @param callback function to call on completion (or failure)
 743  * @param callback_cls closure for the callback function
 744  */
 745 void
 746 GNUNET_TESTING_daemons_restart (struct GNUNET_TESTING_PeerGroup *pg,
 747                                 GNUNET_TESTING_NotifyCompletion callback,
 748                                 void *callback_cls);
 749
 750
 751 /**
 752  * Shutdown all peers started in the given group.
 753  *
 754  * @param pg handle to the peer group
 755  * @param timeout how long to wait for shutdown
 756  * @param cb callback to notify upon success or failure
 757  * @param cb_cls closure for cb
 758  */
 759 void
 760 GNUNET_TESTING_daemons_stop (struct GNUNET_TESTING_PeerGroup *pg,
 761                              struct GNUNET_TIME_Relative timeout,
 762                              GNUNET_TESTING_NotifyCompletion cb, void *cb_cls);
 763
 764
 765 /**
 766  * Count the number of running peers.
 767  *
 768  * @param pg handle for the peer group
 769  *
 770  * @return the number of currently running peers in the peer group
 771  */
 772 unsigned int
 773 GNUNET_TESTING_daemons_running (struct GNUNET_TESTING_PeerGroup *pg);
 774
 775
 776 /**
 777  * Simulate churn by stopping some peers (and possibly
 778  * re-starting others if churn is called multiple times).  This
 779  * function can only be used to create leave-join churn (peers "never"
 780  * leave for good).  First "voff" random peers that are currently
 781  * online will be taken offline; then "von" random peers that are then
 782  * offline will be put back online.  No notifications will be
 783  * generated for any of these operations except for the callback upon
 784  * completion.  Note that the implementation is at liberty to keep
 785  * the ARM service itself (but none of the other services or daemons)
 786  * running even though the "peer" is being varied offline.
 787  *
 788  * @param pg handle for the peer group
 789  * @param service the service to churn on/off, NULL for all
 790  * @param voff number of peers that should go offline
 791  * @param von number of peers that should come back online;
 792  *            must be zero on first call (since "testbed_start"
 793  *            always starts all of the peers)
 794  * @param timeout how long to wait for operations to finish before
 795  *        giving up
 796  * @param cb function to call at the end
 797  * @param cb_cls closure for cb
 798  */
 799 void
 800 GNUNET_TESTING_daemons_churn (struct GNUNET_TESTING_PeerGroup *pg,
 801                               char *service, unsigned int voff,
 802                               unsigned int von,
 803                               struct GNUNET_TIME_Relative timeout,
 804                               GNUNET_TESTING_NotifyCompletion cb, void *cb_cls);
 805
 806
 807 /**
 808  * Start a given service for each of the peers in the peer group.
 809  *
 810  * @param pg handle for the peer group
 811  * @param service the service to start
 812  * @param timeout how long to wait for operations to finish before
 813  *        giving up
 814  * @param cb function to call once finished
 815  * @param cb_cls closure for cb
 816  *
 817  */
 818 void
 819 GNUNET_TESTING_daemons_start_service (struct GNUNET_TESTING_PeerGroup *pg,
 820                                       char *service,
 821                                       struct GNUNET_TIME_Relative timeout,
 822                                       GNUNET_TESTING_NotifyCompletion cb,
 823                                       void *cb_cls);
 824
 825
 826 /**
 827  * Callback function to process statistic values.
 828  *
 829  * @param cls closure
 830  * @param peer the peer the statistics belong to
 831  * @param subsystem name of subsystem that created the statistic
 832  * @param name the name of the datum
 833  * @param value the current value
 834  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
 835  * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
 836  */
 837 typedef int (*GNUNET_TESTING_STATISTICS_Iterator) (void *cls,
 838                                                    const struct
 839                                                    GNUNET_PeerIdentity * peer,
 840                                                    const char *subsystem,
 841                                                    const char *name,
 842                                                    uint64_t value,
 843                                                    int is_persistent);
 844
 845
 846 /**
 847  * Iterate over all (running) peers in the peer group, retrieve
 848  * all statistics from each.
 849  *
 850  * @param pg the peergroup to iterate statistics of
 851  * @param cont continuation to call once call is completed(?)
 852  * @param proc processing function for each statistic retrieved
 853  * @param cls closure to pass to proc
 854  */
 855 void
 856 GNUNET_TESTING_get_statistics (struct GNUNET_TESTING_PeerGroup *pg,
 857                                GNUNET_STATISTICS_Callback cont,
 858                                GNUNET_TESTING_STATISTICS_Iterator proc,
 859                                void *cls);
 860
 861
 862 /**
 863  * Topologies supported for testbeds.
 864  */
 865 enum GNUNET_TESTING_Topology
 866 {
 867   /**
 868    * A clique (everyone connected to everyone else).
 869    */
 870   GNUNET_TESTING_TOPOLOGY_CLIQUE,
 871
 872   /**
 873    * Small-world network (2d torus plus random links).
 874    */
 875   GNUNET_TESTING_TOPOLOGY_SMALL_WORLD,
 876
 877   /**
 878    * Small-world network (ring plus random links).
 879    */
 880   GNUNET_TESTING_TOPOLOGY_SMALL_WORLD_RING,
 881
 882   /**
 883    * Ring topology.
 884    */
 885   GNUNET_TESTING_TOPOLOGY_RING,
 886
 887   /**
 888    * 2-d torus.
 889    */
 890   GNUNET_TESTING_TOPOLOGY_2D_TORUS,
 891
 892   /**
 893    * Random graph.
 894    */
 895   GNUNET_TESTING_TOPOLOGY_ERDOS_RENYI,
 896
 897   /**
 898    * Certain percentage of peers are unable to communicate directly
 899    * replicating NAT conditions
 900    */
 901   GNUNET_TESTING_TOPOLOGY_INTERNAT,
 902
 903   /**
 904    * Scale free topology.
 905    */
 906   GNUNET_TESTING_TOPOLOGY_SCALE_FREE,
 907
 908   /**
 909    * Straight line topology.
 910    */
 911   GNUNET_TESTING_TOPOLOGY_LINE,
 912
 913   /**
 914    * All peers are disconnected.
 915    */
 916   GNUNET_TESTING_TOPOLOGY_NONE,
 917
 918   /**
 919    * Read a topology from a given file.
 920    */
 921   GNUNET_TESTING_TOPOLOGY_FROM_FILE
 922 };
 923
 924 /**
 925  * Options for connecting a topology.
 926  */
 927 enum GNUNET_TESTING_TopologyOption
 928 {
 929   /**
 930    * Try to connect all peers specified in the topology.
 931    */
 932   GNUNET_TESTING_TOPOLOGY_OPTION_ALL,
 933
 934   /**
 935    * Choose a random subset of connections to create.
 936    */
 937   GNUNET_TESTING_TOPOLOGY_OPTION_RANDOM,
 938
 939   /**
 940    * Create at least X connections for each peer.
 941    */
 942   GNUNET_TESTING_TOPOLOGY_OPTION_MINIMUM,
 943
 944   /**
 945    * Using a depth first search, create one connection
 946    * per peer.  If any are missed (graph disconnected)
 947    * start over at those peers until all have at least one
 948    * connection.
 949    */
 950   GNUNET_TESTING_TOPOLOGY_OPTION_DFS,
 951
 952   /**
 953    * Find the N closest peers to each allowed peer in the
 954    * topology and make sure a connection to those peers
 955    * exists in the connect topology.
 956    */
 957   GNUNET_TESTING_TOPOLOGY_OPTION_ADD_CLOSEST,
 958
 959   /**
 960    * No options specified.
 961    */
 962   GNUNET_TESTING_TOPOLOGY_OPTION_NONE
 963 };
 964
 965
 966 /**
 967  * Get a topology from a string input.
 968  *
 969  * @param topology where to write the retrieved topology
 970  * @param topology_string The string to attempt to
 971  *        get a configuration value from
 972  * @return GNUNET_YES if topology string matched a
 973  *         known topology, GNUNET_NO if not
 974  */
 975 int
 976 GNUNET_TESTING_topology_get (enum GNUNET_TESTING_Topology *topology,
 977                              const char *topology_string);
 978
 979
 980 /**
 981  * Get connect topology option from string input.
 982  *
 983  * @param topology_option where to write the retrieved topology
 984  * @param topology_string The string to attempt to
 985  *        get a configuration value from
 986  * @return GNUNET_YES if topology string matched a
 987  *         known topology, GNUNET_NO if not
 988  */
 989 int
 990 GNUNET_TESTING_topology_option_get (enum GNUNET_TESTING_TopologyOption
 991                                     *topology_option,
 992                                     const char *topology_string);
 993
 994
 995 /**
 996  * Takes a peer group and creates a topology based on the
 997  * one specified.  Creates a topology means generates friend
 998  * files for the peers so they can only connect to those allowed
 999  * by the topology.  This will only have an effect once peers
1000  * are started if the FRIENDS_ONLY option is set in the base
1001  * config.
1002  *
1003  * Also takes an optional restrict topology which
1004  * disallows direct connections UNLESS they are specified in
1005  * the restricted topology.
1006  *
1007  * A simple example; if the topology option is set to LINE
1008  * peers can ONLY connect in a LINE.  However, if the topology
1009  * option is set to 2D-torus and the restrict option is set to
1010  * line with restrict_transports equal to "tcp udp", then peers
1011  * may connect in a 2D-torus, but will be restricted to tcp and
1012  * udp connections only in a LINE.  Generally it only makes
1013  * sense to do this if restrict_topology is a subset of topology.
1014  *
1015  * For testing peer discovery, etc. it is generally better to
1016  * leave restrict_topology as GNUNET_TESTING_TOPOLOGY_NONE and
1017  * then use the connect_topology function to restrict the initial
1018  * connection set.
1019  *
1020  * @param pg the peer group struct representing the running peers
1021  * @param topology which topology to connect the peers in
1022  * @param restrict_topology allow only direct connections in this topology,
1023  *        based on those listed in restrict_transports, set to
1024  *        GNUNET_TESTING_TOPOLOGY_NONE for no restrictions
1025  * @param restrict_transports space delimited list of transports to blacklist
1026  *                            to create restricted topology, NULL for none
1027  *
1028  * @return the maximum number of connections were all allowed peers
1029  *         connected to each other
1030  */
1031 unsigned int
1032 GNUNET_TESTING_create_topology (struct GNUNET_TESTING_PeerGroup *pg,
1033                                 enum GNUNET_TESTING_Topology topology,
1034                                 enum GNUNET_TESTING_Topology restrict_topology,
1035                                 const char *restrict_transports);
1036
1037
1038 /**
1039  * Iterate over all (running) peers in the peer group, retrieve
1040  * all connections that each currently has.
1041  *
1042  * @param pg the peer group we are concerned with
1043  * @param cb callback for topology information
1044  * @param cls closure for callback
1045  */
1046 void
1047 GNUNET_TESTING_get_topology (struct GNUNET_TESTING_PeerGroup *pg,
1048                              GNUNET_TESTING_NotifyTopology cb, void *cls);
1049
1050
1051 /**
1052  * Stop the connection process temporarily.
1053  *
1054  * @param pg the peer group to stop connecting
1055  */
1056 void
1057 GNUNET_TESTING_stop_connections (struct GNUNET_TESTING_PeerGroup *pg);
1058
1059
1060 /**
1061  * Resume the connection process.
1062  *
1063  * @param pg the peer group to resume connecting
1064  */
1065 void
1066 GNUNET_TESTING_resume_connections (struct GNUNET_TESTING_PeerGroup *pg);
1067
1068
1069 /**
1070  * There are many ways to connect peers that are supported by this function.
1071  * To connect peers in the same topology that was created via the
1072  * GNUNET_TESTING_create_topology, the topology variable must be set to
1073  * GNUNET_TESTING_TOPOLOGY_NONE.  If the topology variable is specified,
1074  * a new instance of that topology will be generated and attempted to be
1075  * connected.  This could result in some connections being impossible,
1076  * because some topologies are non-deterministic.
1077  *
1078  * @param pg the peer group struct representing the running peers
1079  * @param topology which topology to connect the peers in
1080  * @param options options for connecting the topology
1081  * @param option_modifier modifier for options that take a parameter
1082  * @param connect_timeout how long to wait before giving up on connecting
1083  *                        two peers
1084  * @param connect_attempts how many times to attempt to connect two peers
1085  *                         over the connect_timeout duration
1086  * @param notify_callback notification to be called once all connections completed
1087  * @param notify_cls closure for notification callback
1088  *
1089  * @return the number of connections that will be attempted, GNUNET_SYSERR on error
1090  */
1091 int
1092 GNUNET_TESTING_connect_topology (struct GNUNET_TESTING_PeerGroup *pg,
1093                                  enum GNUNET_TESTING_Topology topology,
1094                                  enum GNUNET_TESTING_TopologyOption options,
1095                                  double option_modifier,
1096                                  struct GNUNET_TIME_Relative connect_timeout,
1097                                  unsigned int connect_attempts,
1098                                  GNUNET_TESTING_NotifyCompletion
1099                                  notify_callback, void *notify_cls);
1100
1101
1102 /**
1103  * Start or stop an individual peer from the given group.
1104  *
1105  * @param pg handle to the peer group
1106  * @param offset which peer to start or stop
1107  * @param desired_status GNUNET_YES to have it running, GNUNET_NO to stop it
1108  * @param timeout how long to wait for shutdown
1109  * @param cb function to call at the end
1110  * @param cb_cls closure for cb
1111  */
1112 void
1113 GNUNET_TESTING_daemons_vary (struct GNUNET_TESTING_PeerGroup *pg,
1114                              unsigned int offset, int desired_status,
1115                              struct GNUNET_TIME_Relative timeout,
1116                              GNUNET_TESTING_NotifyCompletion cb, void *cb_cls);
1117
1118
1119 /**
1120  * Start a peer group with a given number of peers.  Notify
1121  * on completion of peer startup and connection based on given
1122  * topological constraints.  Optionally notify on each
1123  * established connection.
1124  *
1125  * @param cfg configuration template to use
1126  * @param total number of daemons to start
1127  * @param timeout total time allowed for peers to start
1128  * @param connect_cb function to call each time two daemons are connected
1129  * @param peergroup_cb function to call once all peers are up and connected
1130  * @param peergroup_cls closure for peergroup callbacks
1131  * @param hostnames linked list of host structs to use to start peers on
1132  *                  (NULL to run on localhost only)
1133  *
1134  * @return NULL on error, otherwise handle to control peer group
1135  */
1136 struct GNUNET_TESTING_PeerGroup *
1137 GNUNET_TESTING_peergroup_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
1138                                 unsigned int total,
1139                                 struct GNUNET_TIME_Relative timeout,
1140                                 GNUNET_TESTING_NotifyConnection connect_cb,
1141                                 GNUNET_TESTING_NotifyCompletion peergroup_cb,
1142                                 void *peergroup_cls,
1143                                 const struct GNUNET_TESTING_Host *hostnames);
1144
1145
1146 /**
1147  * Print current topology to a graphviz readable file.
1148  *
1149  * @param pg a currently running peergroup to print to file
1150  * @param output_filename the file to write the topology to
1151  * @param notify_cb callback to call upon completion or failure
1152  * @param notify_cb_cls closure for notify_cb
1153  *
1154  */
1155 void
1156 GNUNET_TESTING_peergroup_topology_to_file (struct GNUNET_TESTING_PeerGroup *pg,
1157                                            const char *output_filename,
1158                                            GNUNET_TESTING_NotifyCompletion
1159                                            notify_cb, void *notify_cb_cls);
1160
1161
1162 #if 0                           /* keep Emacsens' auto-indent happy */
1163 {
1164 #endif
1165 #ifdef __cplusplus
1166 }
1167 #endif
1168
1169 #endif