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