src/include/gnunet_testing_lib.h

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