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