2 This file is part of GNUnet
3 (C) 2008, 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
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
32 #ifndef GNUNET_TESTING_LIB_H
33 #define GNUNET_TESTING_LIB_H
35 #include "gnunet_util_lib.h"
36 #include "gnunet_statistics_service.h"
41 #if 0 /* keep Emacsens' auto-indent happy */
46 #define HOSTKEYFILESIZE 914
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.
53 struct GNUNET_TESTING_Daemon;
56 * Linked list of hostnames and ports to use for starting daemons.
58 struct GNUNET_TESTING_Host
61 * Pointer to next item in the list.
63 struct GNUNET_TESTING_Host *next;
66 * Hostname to connect to.
71 * Username to use when connecting (may be null).
76 * Port to use for SSH connection (used for ssh
77 * connection forwarding, 0 to let ssh decide)
83 * Prototype of a function that will be called whenever
84 * a daemon was started by the testing library.
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)
91 typedef void (*GNUNET_TESTING_NotifyHostkeyCreated) (void *cls,
93 GNUNET_PeerIdentity * id,
95 GNUNET_TESTING_Daemon * d,
99 * Prototype of a function that will be called whenever
100 * a daemon was started by the testing library.
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)
108 typedef void (*GNUNET_TESTING_NotifyDaemonRunning) (void *cls,
110 GNUNET_PeerIdentity * id,
112 GNUNET_CONFIGURATION_Handle
114 struct GNUNET_TESTING_Daemon
115 * d, const char *emsg);
118 * Handle to an entire testbed of GNUnet peers.
120 struct GNUNET_TESTING_Testbed;
123 * Phases of starting GNUnet on a system.
125 enum GNUNET_TESTING_StartPhase
128 * Copy the configuration file to the target system.
133 * Configuration file has been copied, generate hostkey.
138 * Create the hostkey for the peer.
143 * Hostkey generated, wait for topology to be finished.
148 * Topology has been created, now start ARM.
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).
160 * We're waiting for CORE to start.
165 * CORE is up, now make sure we get the HELLO for this peer.
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.
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
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.
186 SP_SERVICE_SHUTDOWN_START,
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.
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
204 * Prototype of a function that will be called when a
205 * particular operation was completed the testing library.
208 * @param emsg NULL on success
210 typedef void (*GNUNET_TESTING_NotifyCompletion) (void *cls, const char *emsg);
213 * Prototype of a function that will be called with the
214 * number of connections created for a particular topology.
217 * @param num_connections the number of connections created
219 typedef void (*GNUNET_TESTING_NotifyConnections) (void *cls,
220 unsigned int num_connections);
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.
227 struct GNUNET_TESTING_Daemon
232 struct GNUNET_CONFIGURATION_Handle *cfg;
235 * At what time to give up starting the peer
237 struct GNUNET_TIME_Absolute max_timeout;
240 * Host to run GNUnet on.
245 * Port to use for ssh, NULL to let system choose default.
250 * Result of GNUNET_i2s of this peer,
256 * Username we are using.
261 * Name of the configuration file
266 * Callback to inform initiator that the peer's
267 * hostkey has been created.
269 GNUNET_TESTING_NotifyHostkeyCreated hostkey_callback;
272 * Closure for hostkey creation callback.
277 * Function to call when the peer is running.
279 GNUNET_TESTING_NotifyDaemonRunning cb;
287 * Arguments from "daemon_stop" call.
289 GNUNET_TESTING_NotifyCompletion dead_cb;
292 * Closure for 'dead_cb'.
297 * Arguments from "daemon_stop" call.
299 GNUNET_TESTING_NotifyCompletion update_cb;
302 * Closure for 'update_cb'.
307 * PID of the process that we started last.
309 struct GNUNET_OS_Process *proc;
312 * Handle to the server.
314 struct GNUNET_CORE_Handle *server;
317 * Handle to the transport service of this peer
319 struct GNUNET_TRANSPORT_Handle *th;
322 * Handle for getting HELLOs from transport
324 struct GNUNET_TRANSPORT_GetHelloHandle *ghh;
327 * HELLO message for this peer
329 struct GNUNET_HELLO_Message *hello;
332 * Handle to a pipe for reading the hostkey.
334 struct GNUNET_DISK_PipeHandle *pipe_stdout;
337 * Currently, a single char * pointing to a service
338 * that has been churned off.
340 * FIXME: make this a linked list of services that have been churned off!!!
342 char *churned_services;
345 * ID of the current task.
347 GNUNET_SCHEDULER_TaskIdentifier task;
350 * Identity of this peer (once started).
352 struct GNUNET_PeerIdentity id;
355 * Flag to indicate that we've already been asked
356 * to terminate (but could not because some action
357 * was still pending).
362 * GNUNET_YES if the hostkey has been created
363 * for this peer, GNUNET_NO otherwise.
368 * In which phase are we during the start of
371 enum GNUNET_TESTING_StartPhase phase;
374 * Current position in 'hostkeybuf' (for reading from gnunet-peerinfo)
376 unsigned int hostkeybufpos;
379 * Set to GNUNET_YES once the peer is up.
384 * Used to tell shutdown not to remove configuration for the peer
385 * (if it's going to be restarted later)
390 * Output from gnunet-peerinfo is read into this buffer.
392 char hostkeybuf[105];
398 * Handle to a group of GNUnet peers.
400 struct GNUNET_TESTING_PeerGroup;
404 * Prototype of a function that will be called whenever
405 * two daemons are connected by the testing library.
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)
417 typedef void (*GNUNET_TESTING_NotifyConnection) (void *cls,
419 GNUNET_PeerIdentity * first,
421 GNUNET_PeerIdentity * second,
424 GNUNET_CONFIGURATION_Handle *
427 GNUNET_CONFIGURATION_Handle *
429 struct GNUNET_TESTING_Daemon *
431 struct GNUNET_TESTING_Daemon *
437 * Prototype of a callback function indicating that two peers
438 * are currently connected.
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)
446 typedef void (*GNUNET_TESTING_NotifyTopology) (void *cls,
447 const struct GNUNET_PeerIdentity
449 const struct GNUNET_PeerIdentity
450 * second, const char *emsg);
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.
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)
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,
487 * Continues GNUnet daemon startup when user wanted to be notified
488 * once a hostkey was generated (for creating friends files, blacklists,
491 * @param daemon the daemon to finish starting
494 GNUNET_TESTING_daemon_continue_startup (struct GNUNET_TESTING_Daemon *daemon);
498 * Check whether the given daemon is running.
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.
505 GNUNET_TESTING_test_daemon_running (struct GNUNET_TESTING_Daemon *daemon);
509 * Restart (stop and start) a GNUnet daemon.
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
516 GNUNET_TESTING_daemon_restart (struct GNUNET_TESTING_Daemon *d,
517 GNUNET_TESTING_NotifyDaemonRunning cb,
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)
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
531 GNUNET_TESTING_daemon_start_stopped (struct GNUNET_TESTING_Daemon *daemon,
532 struct GNUNET_TIME_Relative timeout,
533 GNUNET_TESTING_NotifyDaemonRunning cb,
538 * Starts a GNUnet daemon's service.
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
547 GNUNET_TESTING_daemon_start_service (struct GNUNET_TESTING_Daemon *d,
549 struct GNUNET_TIME_Relative timeout,
550 GNUNET_TESTING_NotifyDaemonRunning cb,
555 * Starts a GNUnet daemon's service which has been previously turned off.
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
564 GNUNET_TESTING_daemon_start_stopped_service (struct GNUNET_TESTING_Daemon *d,
566 struct GNUNET_TIME_Relative
568 GNUNET_TESTING_NotifyDaemonRunning
573 * Get a certain testing daemon handle.
575 * @param pg handle to the set of running peers
576 * @param position the number of the peer to return
578 struct GNUNET_TESTING_Daemon *
579 GNUNET_TESTING_daemon_get (struct GNUNET_TESTING_PeerGroup *pg,
580 unsigned int position);
584 * Get a daemon by peer identity, so callers can
585 * retrieve the daemon without knowing it's offset.
587 * @param pg the peer group to retrieve the daemon from
588 * @param peer_id the peer identity of the daemon to retrieve
590 * @return the daemon on success, or NULL if no such peer identity is found
592 struct GNUNET_TESTING_Daemon *
593 GNUNET_TESTING_daemon_get_by_id (struct GNUNET_TESTING_PeerGroup *pg,
594 const struct GNUNET_PeerIdentity *peer_id);
598 * Stops a GNUnet daemon.
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
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);
619 * Create a new configuration using the given configuration
620 * as a template; however, each PORT in the existing cfg
621 * must be renumbered by incrementing "*port". If we run
622 * out of "*port" numbers, return NULL.
624 * @param cfg template configuration
625 * @param off the current peer offset
626 * @param port port numbers to use, update to reflect
627 * port numbers that were used
628 * @param upnum number to make unix domain socket names unique
629 * @param hostname hostname of the controlling host, to allow control connections from
630 * @param fdnum number used to offset the unix domain socket for grouped processes
631 * (such as statistics or peerinfo, which can be shared among others)
633 * @return new configuration, NULL on error
635 struct GNUNET_CONFIGURATION_Handle *
636 GNUNET_TESTING_create_cfg (const struct GNUNET_CONFIGURATION_Handle *cfg, uint32_t off,
637 uint16_t * port, uint32_t * upnum, const char *hostname,
641 * Changes the configuration of a GNUnet daemon.
643 * @param d the daemon that should be modified
644 * @param cfg the new configuration for the daemon
645 * @param cb function called once the configuration was changed
646 * @param cb_cls closure for cb
649 GNUNET_TESTING_daemon_reconfigure (struct GNUNET_TESTING_Daemon *d,
650 struct GNUNET_CONFIGURATION_Handle *cfg,
651 GNUNET_TESTING_NotifyCompletion cb,
656 * Stops a single service of a GNUnet daemon. Used like daemon_stop,
657 * only doesn't stop the entire peer in any case. If the service
658 * is not currently running, this call is likely to fail after
661 * @param d the daemon that should be stopped
662 * @param service the name of the service to stop
663 * @param timeout how long to wait for process for shutdown to complete
664 * @param cb function called once the service was stopped
665 * @param cb_cls closure for cb
668 GNUNET_TESTING_daemon_stop_service (struct GNUNET_TESTING_Daemon *d,
670 struct GNUNET_TIME_Relative timeout,
671 GNUNET_TESTING_NotifyCompletion cb,
676 * Read a testing hosts file based on a configuration.
677 * Returns a DLL of hosts (caller must free!) on success
678 * or NULL on failure.
680 * @param cfg a configuration with a testing section
682 * @return DLL of hosts on success, NULL on failure
684 struct GNUNET_TESTING_Host *
685 GNUNET_TESTING_hosts_load (const struct GNUNET_CONFIGURATION_Handle *cfg);
689 * Start count gnunet instances with the same set of transports and
690 * applications. The port numbers (any option called "PORT") will be
691 * adjusted to ensure that no two peers running on the same system
692 * have the same port(s) in their respective configurations.
694 * @param cfg configuration template to use
695 * @param total number of daemons to start
696 * @param max_concurrent_connections for testing, how many peers can
697 * we connect to simultaneously
698 * @param max_concurrent_ssh when starting with ssh, how many ssh
699 * connections will we allow at once (based on remote hosts allowed!)
700 * @param timeout total time allowed for peers to start
701 * @param hostkey_callback function to call on each peers hostkey generation
702 * if NULL, peers will be started by this call, if non-null,
703 * GNUNET_TESTING_daemons_continue_startup must be called after
704 * successful hostkey generation
705 * @param hostkey_cls closure for hostkey callback
706 * @param cb function to call on each daemon that was started
707 * @param cb_cls closure for cb
708 * @param connect_callback function to call each time two hosts are connected
709 * @param connect_callback_cls closure for connect_callback
710 * @param hostnames linked list of host structs to use to start peers on
711 * (NULL to run on localhost only)
713 * @return NULL on error, otherwise handle to control peer group
715 struct GNUNET_TESTING_PeerGroup *
716 GNUNET_TESTING_daemons_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
718 unsigned int max_concurrent_connections,
719 unsigned int max_concurrent_ssh,
720 struct GNUNET_TIME_Relative timeout,
721 GNUNET_TESTING_NotifyHostkeyCreated
722 hostkey_callback, void *hostkey_cls,
723 GNUNET_TESTING_NotifyDaemonRunning cb,
725 GNUNET_TESTING_NotifyConnection connect_callback,
726 void *connect_callback_cls,
727 const struct GNUNET_TESTING_Host *hostnames);
731 * Function which continues a peer group starting up
732 * after successfully generating hostkeys for each peer.
734 * @param pg the peer group to continue starting
737 GNUNET_TESTING_daemons_continue_startup (struct GNUNET_TESTING_PeerGroup *pg);
741 * Handle for an active request to connect two peers.
743 struct GNUNET_TESTING_ConnectContext;
747 * Establish a connection between two GNUnet daemons. The daemons
748 * must both be running and not be stopped until either the
749 * 'cb' callback is called OR the connection request has been
750 * explicitly cancelled.
752 * @param d1 handle for the first daemon
753 * @param d2 handle for the second daemon
754 * @param timeout how long is the connection attempt
756 * @param max_connect_attempts how many times should we try to reconnect
758 * @param send_hello GNUNET_YES to send the HELLO, GNUNET_NO to assume
759 * the HELLO has already been exchanged
760 * @param cb function to call at the end
761 * @param cb_cls closure for cb
762 * @return handle to cancel the request, NULL on error
764 struct GNUNET_TESTING_ConnectContext *
765 GNUNET_TESTING_daemons_connect (struct GNUNET_TESTING_Daemon *d1,
766 struct GNUNET_TESTING_Daemon *d2,
767 struct GNUNET_TIME_Relative timeout,
768 unsigned int max_connect_attempts,
770 GNUNET_TESTING_NotifyConnection cb,
776 * Cancel an attempt to connect two daemons.
778 * @param cc connect context
781 GNUNET_TESTING_daemons_connect_cancel (struct GNUNET_TESTING_ConnectContext
787 * Restart all peers in the given group.
789 * @param pg the handle to the peer group
790 * @param callback function to call on completion (or failure)
791 * @param callback_cls closure for the callback function
794 GNUNET_TESTING_daemons_restart (struct GNUNET_TESTING_PeerGroup *pg,
795 GNUNET_TESTING_NotifyCompletion callback,
800 * Shutdown all peers started in the given group.
802 * @param pg handle to the peer group
803 * @param timeout how long to wait for shutdown
804 * @param cb callback to notify upon success or failure
805 * @param cb_cls closure for cb
808 GNUNET_TESTING_daemons_stop (struct GNUNET_TESTING_PeerGroup *pg,
809 struct GNUNET_TIME_Relative timeout,
810 GNUNET_TESTING_NotifyCompletion cb, void *cb_cls);
814 * Count the number of running peers.
816 * @param pg handle for the peer group
818 * @return the number of currently running peers in the peer group
821 GNUNET_TESTING_daemons_running (struct GNUNET_TESTING_PeerGroup *pg);
825 * Simulate churn by stopping some peers (and possibly
826 * re-starting others if churn is called multiple times). This
827 * function can only be used to create leave-join churn (peers "never"
828 * leave for good). First "voff" random peers that are currently
829 * online will be taken offline; then "von" random peers that are then
830 * offline will be put back online. No notifications will be
831 * generated for any of these operations except for the callback upon
832 * completion. Note that the implementation is at liberty to keep
833 * the ARM service itself (but none of the other services or daemons)
834 * running even though the "peer" is being varied offline.
836 * @param pg handle for the peer group
837 * @param service the service to churn on/off, NULL for all
838 * @param voff number of peers that should go offline
839 * @param von number of peers that should come back online;
840 * must be zero on first call (since "testbed_start"
841 * always starts all of the peers)
842 * @param timeout how long to wait for operations to finish before
844 * @param cb function to call at the end
845 * @param cb_cls closure for cb
848 GNUNET_TESTING_daemons_churn (struct GNUNET_TESTING_PeerGroup *pg,
849 char *service, unsigned int voff,
851 struct GNUNET_TIME_Relative timeout,
852 GNUNET_TESTING_NotifyCompletion cb, void *cb_cls);
856 * Start a given service for each of the peers in the peer group.
858 * @param pg handle for the peer group
859 * @param service the service to start
860 * @param timeout how long to wait for operations to finish before
862 * @param cb function to call once finished
863 * @param cb_cls closure for cb
867 GNUNET_TESTING_daemons_start_service (struct GNUNET_TESTING_PeerGroup *pg,
869 struct GNUNET_TIME_Relative timeout,
870 GNUNET_TESTING_NotifyCompletion cb,
875 * Callback function to process statistic values.
878 * @param peer the peer the statistics belong to
879 * @param subsystem name of subsystem that created the statistic
880 * @param name the name of the datum
881 * @param value the current value
882 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
883 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
885 typedef int (*GNUNET_TESTING_STATISTICS_Iterator) (void *cls,
887 GNUNET_PeerIdentity * peer,
888 const char *subsystem,
895 * Iterate over all (running) peers in the peer group, retrieve
896 * all statistics from each.
898 * @param pg the peergroup to iterate statistics of
899 * @param cont continuation to call once call is completed(?)
900 * @param proc processing function for each statistic retrieved
901 * @param cls closure to pass to proc
904 GNUNET_TESTING_get_statistics (struct GNUNET_TESTING_PeerGroup *pg,
905 GNUNET_STATISTICS_Callback cont,
906 GNUNET_TESTING_STATISTICS_Iterator proc,
911 * Topologies supported for testbeds.
913 enum GNUNET_TESTING_Topology
916 * A clique (everyone connected to everyone else).
918 GNUNET_TESTING_TOPOLOGY_CLIQUE,
921 * Small-world network (2d torus plus random links).
923 GNUNET_TESTING_TOPOLOGY_SMALL_WORLD,
926 * Small-world network (ring plus random links).
928 GNUNET_TESTING_TOPOLOGY_SMALL_WORLD_RING,
933 GNUNET_TESTING_TOPOLOGY_RING,
938 GNUNET_TESTING_TOPOLOGY_2D_TORUS,
943 GNUNET_TESTING_TOPOLOGY_ERDOS_RENYI,
946 * Certain percentage of peers are unable to communicate directly
947 * replicating NAT conditions
949 GNUNET_TESTING_TOPOLOGY_INTERNAT,
952 * Scale free topology.
954 GNUNET_TESTING_TOPOLOGY_SCALE_FREE,
957 * Straight line topology.
959 GNUNET_TESTING_TOPOLOGY_LINE,
962 * All peers are disconnected.
964 GNUNET_TESTING_TOPOLOGY_NONE,
967 * Read a topology from a given file.
969 GNUNET_TESTING_TOPOLOGY_FROM_FILE
973 * Options for connecting a topology.
975 enum GNUNET_TESTING_TopologyOption
978 * Try to connect all peers specified in the topology.
980 GNUNET_TESTING_TOPOLOGY_OPTION_ALL,
983 * Choose a random subset of connections to create.
985 GNUNET_TESTING_TOPOLOGY_OPTION_RANDOM,
988 * Create at least X connections for each peer.
990 GNUNET_TESTING_TOPOLOGY_OPTION_MINIMUM,
993 * Using a depth first search, create one connection
994 * per peer. If any are missed (graph disconnected)
995 * start over at those peers until all have at least one
998 GNUNET_TESTING_TOPOLOGY_OPTION_DFS,
1001 * Find the N closest peers to each allowed peer in the
1002 * topology and make sure a connection to those peers
1003 * exists in the connect topology.
1005 GNUNET_TESTING_TOPOLOGY_OPTION_ADD_CLOSEST,
1008 * No options specified.
1010 GNUNET_TESTING_TOPOLOGY_OPTION_NONE
1015 * Get a topology from a string input.
1017 * @param topology where to write the retrieved topology
1018 * @param topology_string The string to attempt to
1019 * get a configuration value from
1020 * @return GNUNET_YES if topology string matched a
1021 * known topology, GNUNET_NO if not
1024 GNUNET_TESTING_topology_get (enum GNUNET_TESTING_Topology *topology,
1025 const char *topology_string);
1029 * Get connect topology option from string input.
1031 * @param topology_option where to write the retrieved topology
1032 * @param topology_string The string to attempt to
1033 * get a configuration value from
1034 * @return GNUNET_YES if topology string matched a
1035 * known topology, GNUNET_NO if not
1038 GNUNET_TESTING_topology_option_get (enum GNUNET_TESTING_TopologyOption
1040 const char *topology_string);
1044 * Takes a peer group and creates a topology based on the
1045 * one specified. Creates a topology means generates friend
1046 * files for the peers so they can only connect to those allowed
1047 * by the topology. This will only have an effect once peers
1048 * are started if the FRIENDS_ONLY option is set in the base
1051 * Also takes an optional restrict topology which
1052 * disallows direct connections UNLESS they are specified in
1053 * the restricted topology.
1055 * A simple example; if the topology option is set to LINE
1056 * peers can ONLY connect in a LINE. However, if the topology
1057 * option is set to 2D-torus and the restrict option is set to
1058 * line with restrict_transports equal to "tcp udp", then peers
1059 * may connect in a 2D-torus, but will be restricted to tcp and
1060 * udp connections only in a LINE. Generally it only makes
1061 * sense to do this if restrict_topology is a subset of topology.
1063 * For testing peer discovery, etc. it is generally better to
1064 * leave restrict_topology as GNUNET_TESTING_TOPOLOGY_NONE and
1065 * then use the connect_topology function to restrict the initial
1068 * @param pg the peer group struct representing the running peers
1069 * @param topology which topology to connect the peers in
1070 * @param restrict_topology allow only direct connections in this topology,
1071 * based on those listed in restrict_transports, set to
1072 * GNUNET_TESTING_TOPOLOGY_NONE for no restrictions
1073 * @param restrict_transports space delimited list of transports to blacklist
1074 * to create restricted topology, NULL for none
1076 * @return the maximum number of connections were all allowed peers
1077 * connected to each other
1080 GNUNET_TESTING_create_topology (struct GNUNET_TESTING_PeerGroup *pg,
1081 enum GNUNET_TESTING_Topology topology,
1082 enum GNUNET_TESTING_Topology restrict_topology,
1083 const char *restrict_transports);
1087 * Iterate over all (running) peers in the peer group, retrieve
1088 * all connections that each currently has.
1090 * @param pg the peer group we are concerned with
1091 * @param cb callback for topology information
1092 * @param cls closure for callback
1095 GNUNET_TESTING_get_topology (struct GNUNET_TESTING_PeerGroup *pg,
1096 GNUNET_TESTING_NotifyTopology cb, void *cls);
1100 * Stop the connection process temporarily.
1102 * @param pg the peer group to stop connecting
1105 GNUNET_TESTING_stop_connections (struct GNUNET_TESTING_PeerGroup *pg);
1109 * Resume the connection process.
1111 * @param pg the peer group to resume connecting
1114 GNUNET_TESTING_resume_connections (struct GNUNET_TESTING_PeerGroup *pg);
1118 * There are many ways to connect peers that are supported by this function.
1119 * To connect peers in the same topology that was created via the
1120 * GNUNET_TESTING_create_topology, the topology variable must be set to
1121 * GNUNET_TESTING_TOPOLOGY_NONE. If the topology variable is specified,
1122 * a new instance of that topology will be generated and attempted to be
1123 * connected. This could result in some connections being impossible,
1124 * because some topologies are non-deterministic.
1126 * @param pg the peer group struct representing the running peers
1127 * @param topology which topology to connect the peers in
1128 * @param options options for connecting the topology
1129 * @param option_modifier modifier for options that take a parameter
1130 * @param connect_timeout how long to wait before giving up on connecting
1132 * @param connect_attempts how many times to attempt to connect two peers
1133 * over the connect_timeout duration
1134 * @param notify_callback notification to be called once all connections completed
1135 * @param notify_cls closure for notification callback
1137 * @return the number of connections that will be attempted, GNUNET_SYSERR on error
1140 GNUNET_TESTING_connect_topology (struct GNUNET_TESTING_PeerGroup *pg,
1141 enum GNUNET_TESTING_Topology topology,
1142 enum GNUNET_TESTING_TopologyOption options,
1143 double option_modifier,
1144 struct GNUNET_TIME_Relative connect_timeout,
1145 unsigned int connect_attempts,
1146 GNUNET_TESTING_NotifyCompletion
1147 notify_callback, void *notify_cls);
1151 * Start or stop an individual peer from the given group.
1153 * @param pg handle to the peer group
1154 * @param offset which peer to start or stop
1155 * @param desired_status GNUNET_YES to have it running, GNUNET_NO to stop it
1156 * @param timeout how long to wait for shutdown
1157 * @param cb function to call at the end
1158 * @param cb_cls closure for cb
1161 GNUNET_TESTING_daemons_vary (struct GNUNET_TESTING_PeerGroup *pg,
1162 unsigned int offset, int desired_status,
1163 struct GNUNET_TIME_Relative timeout,
1164 GNUNET_TESTING_NotifyCompletion cb, void *cb_cls);
1168 * Start a peer group with a given number of peers. Notify
1169 * on completion of peer startup and connection based on given
1170 * topological constraints. Optionally notify on each
1171 * established connection.
1173 * @param cfg configuration template to use
1174 * @param total number of daemons to start
1175 * @param timeout total time allowed for peers to start
1176 * @param connect_cb function to call each time two daemons are connected
1177 * @param peergroup_cb function to call once all peers are up and connected
1178 * @param peergroup_cls closure for peergroup callbacks
1179 * @param hostnames linked list of host structs to use to start peers on
1180 * (NULL to run on localhost only)
1182 * @return NULL on error, otherwise handle to control peer group
1184 struct GNUNET_TESTING_PeerGroup *
1185 GNUNET_TESTING_peergroup_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
1187 struct GNUNET_TIME_Relative timeout,
1188 GNUNET_TESTING_NotifyConnection connect_cb,
1189 GNUNET_TESTING_NotifyCompletion peergroup_cb,
1190 void *peergroup_cls,
1191 const struct GNUNET_TESTING_Host *hostnames);
1195 * Print current topology to a graphviz readable file.
1197 * @param pg a currently running peergroup to print to file
1198 * @param output_filename the file to write the topology to
1199 * @param notify_cb callback to call upon completion or failure
1200 * @param notify_cb_cls closure for notify_cb
1204 GNUNET_TESTING_peergroup_topology_to_file (struct GNUNET_TESTING_PeerGroup *pg,
1205 const char *output_filename,
1206 GNUNET_TESTING_NotifyCompletion
1207 notify_cb, void *notify_cb_cls);
1210 #if 0 /* keep Emacsens' auto-indent happy */