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