2 This file is part of GNUnet
3 (C) 2008--2013 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_testbed_service.h
23 * @brief API for writing tests and creating large-scale
24 * emulation testbeds for GNUnet.
25 * @author Christian Grothoff
28 #ifndef GNUNET_TESTBED_SERVICE_H
29 #define GNUNET_TESTBED_SERVICE_H
31 #include "gnunet_util_lib.h"
32 #include "gnunet_testing_lib.h"
37 #if 0 /* keep Emacsens' auto-indent happy */
44 * Opaque handle to a host running experiments managed by the testbed framework.
45 * The master process must be able to SSH to this host without password (via
48 struct GNUNET_TESTBED_Host;
51 * Opaque handle to a peer controlled by the testbed framework. A peer runs
52 * at a particular host.
54 struct GNUNET_TESTBED_Peer;
57 * Opaque handle to an abstract operation to be executed by the testbed framework.
59 struct GNUNET_TESTBED_Operation;
62 * Handle to interact with a GNUnet testbed controller. Each
63 * controller has at least one master handle which is created when the
64 * controller is created; this master handle interacts with the
65 * controller process, destroying it destroys the controller (by
66 * closing stdin of the controller process). Additionally,
67 * controllers can interact with each other (in a P2P fashion); those
68 * links are established via TCP/IP on the controller's service port.
70 struct GNUNET_TESTBED_Controller;
74 * Create a host to run peers and controllers on.
76 * @param hostname name of the host, use "NULL" for localhost
77 * @param username username to use for the login; may be NULL
78 * @param cfg the configuration to use as a template while starting a controller
79 * on this host. Operation queue sizes specific to a host are also
80 * read from this configuration handle
81 * @param port port number to use for ssh; use 0 to let ssh decide
82 * @return handle to the host, NULL on error
84 struct GNUNET_TESTBED_Host *
85 GNUNET_TESTBED_host_create (const char *hostname,
87 const struct GNUNET_CONFIGURATION_Handle *cfg,
93 * Create a host to run peers and controllers on. This function is used
94 * if a peer learns about a host via IPC between controllers (and thus
95 * some higher-level controller has already determined the unique IDs).
97 * @param id global host ID assigned to the host; 0 is
98 * reserved to always mean 'localhost'
99 * @param hostname name of the host, use "NULL" for localhost
100 * @param username username to use for the login; may be NULL
101 * @param cfg the configuration to use as a template while starting a controller
102 * on this host. Operation queue sizes specific to a host are also
103 * read from this configuration handle
104 * @param port port number to use for ssh; use 0 to let ssh decide
105 * @return handle to the host, NULL on error
107 struct GNUNET_TESTBED_Host *
108 GNUNET_TESTBED_host_create_with_id (uint32_t id,
109 const char *hostname,
110 const char *username,
111 const struct GNUNET_CONFIGURATION_Handle
117 * Load a set of hosts from a configuration file.
119 * @param filename file with the host specification
120 * @param cfg the configuration to use as a template while starting a controller
121 * on any of the loaded hosts. Operation queue sizes specific to a host
122 * are also read from this configuration handle
123 * @param hosts set to the hosts found in the file; caller must free this if
124 * number of hosts returned is greater than 0
125 * @return number of hosts returned in 'hosts', 0 on error
128 GNUNET_TESTBED_hosts_load_from_file (const char *filename,
129 const struct GNUNET_CONFIGURATION_Handle
131 struct GNUNET_TESTBED_Host ***hosts);
135 * Loads the set of host allocated by the LoadLeveler Job Scheduler. This
136 * function is only available when compiled with support for LoadLeveler and is
137 * used for running on the SuperMUC
139 * @param cfg the configuration to use as a template while starting a controller
140 * on any of the loaded hosts. Operation queue sizes specific to a host
141 * are also read from this configuration handle
142 * @param hosts set to the hosts found in the file; caller must free this if
143 * number of hosts returned is greater than 0
144 * @return number of hosts returned in 'hosts', 0 on error
147 GNUNET_TESTBED_hosts_load_from_loadleveler (const struct
148 GNUNET_CONFIGURATION_Handle *cfg,
149 struct GNUNET_TESTBED_Host
153 * Destroy a host handle. Must only be called once everything
154 * running on that host has been stopped.
156 * @param host handle to destroy
159 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host);
163 * The handle for whether a host is habitable or not
165 struct GNUNET_TESTBED_HostHabitableCheckHandle;
169 * Callbacks of this type are called by GNUNET_TESTBED_is_host_habitable to
170 * inform whether the given host is habitable or not. The Handle returned by
171 * GNUNET_TESTBED_is_host_habitable() is invalid after this callback is called
173 * @param cls the closure given to GNUNET_TESTBED_is_host_habitable()
174 * @param host the host whose status is being reported; will be NULL if the host
175 * given to GNUNET_TESTBED_is_host_habitable() is NULL
176 * @param status GNUNET_YES if it is habitable; GNUNET_NO if not
178 typedef void (*GNUNET_TESTBED_HostHabitableCallback) (void *cls,
186 * Checks whether a host can be used to start testbed service
188 * @param host the host to check
189 * @param config the configuration handle to lookup the path of the testbed
191 * @param cb the callback to call to inform about habitability of the given host
192 * @param cb_cls the closure for the callback
193 * @return NULL upon any error or a handle which can be passed to
194 * GNUNET_TESTBED_is_host_habitable_cancel()
196 struct GNUNET_TESTBED_HostHabitableCheckHandle *
197 GNUNET_TESTBED_is_host_habitable (const struct GNUNET_TESTBED_Host *host,
198 const struct GNUNET_CONFIGURATION_Handle
200 GNUNET_TESTBED_HostHabitableCallback cb,
205 * Function to cancel a request started using GNUNET_TESTBED_is_host_habitable()
207 * @param handle the habitability check handle
210 GNUNET_TESTBED_is_host_habitable_cancel (struct
211 GNUNET_TESTBED_HostHabitableCheckHandle
215 * Obtain the host's hostname.
217 * @param host handle to the host, NULL means 'localhost'
218 * @return hostname of the host
221 GNUNET_TESTBED_host_get_hostname (const struct GNUNET_TESTBED_Host *host);
225 * Enumeration with (at most 64) possible event types that
226 * can be monitored using the testbed framework.
228 enum GNUNET_TESTBED_EventType
231 * A peer has been started.
233 GNUNET_TESTBED_ET_PEER_START = 0,
236 * A peer has been stopped.
238 GNUNET_TESTBED_ET_PEER_STOP = 1,
241 * A connection between two peers was established.
243 GNUNET_TESTBED_ET_CONNECT = 2,
246 * A connection between two peers was torn down.
248 GNUNET_TESTBED_ET_DISCONNECT = 3,
251 * A requested testbed operation has been completed.
253 GNUNET_TESTBED_ET_OPERATION_FINISHED = 4,
259 * Types of information that can be requested about a peer.
261 enum GNUNET_TESTBED_PeerInformationType
265 * Special value (not valid for requesting information)
266 * that is used in the event struct if a 'generic' pointer
267 * is returned (for other operations not related to this
270 GNUNET_TESTBED_PIT_GENERIC = 0,
273 * What configuration is the peer using? Returns a 'const struct
274 * GNUNET_CONFIGURATION_Handle *'. Valid until
275 * 'GNUNET_TESTNIG_operation_done' is called. However, the
276 * values may be inaccurate if the peer is reconfigured in
279 GNUNET_TESTBED_PIT_CONFIGURATION,
282 * What is the identity of the peer? Returns a
283 * 'const struct GNUNET_PeerIdentity *'. Valid until
284 * 'GNUNET_TESTNIG_operation_done' is called.
286 GNUNET_TESTBED_PIT_IDENTITY
292 * Argument to GNUNET_TESTBED_ControllerCallback with details about
295 struct GNUNET_TESTBED_EventInformation
301 enum GNUNET_TESTBED_EventType type;
304 * Handle for the corresponding operation that generated this event
306 struct GNUNET_TESTBED_Operation *op;
309 * Closure given while creating the above operation
314 * Details about the event.
320 * Details about peer start event.
325 * Handle for the host where the peer
328 struct GNUNET_TESTBED_Host *host;
331 * Handle for the peer that was started.
333 struct GNUNET_TESTBED_Peer *peer;
338 * Details about peer stop event.
344 * Handle for the peer that was started.
346 struct GNUNET_TESTBED_Peer *peer;
351 * Details about connect event.
356 * Handle for one of the connected peers.
358 struct GNUNET_TESTBED_Peer *peer1;
361 * Handle for one of the connected peers.
363 struct GNUNET_TESTBED_Peer *peer2;
368 * Details about disconnect event.
373 * Handle for one of the disconnected peers.
375 struct GNUNET_TESTBED_Peer *peer1;
378 * Handle for one of the disconnected peers.
380 struct GNUNET_TESTBED_Peer *peer2;
385 * Details about an operation finished event.
390 * Error message for the operation, NULL on success.
395 * No result (NULL pointer) or generic result
396 * (whatever the GNUNET_TESTBED_ConnectAdapter returned).
400 } operation_finished;
408 * Signature of the event handler function called by the
409 * respective event controller.
412 * @param event information about the event
414 typedef void (*GNUNET_TESTBED_ControllerCallback)(void *cls,
415 const struct GNUNET_TESTBED_EventInformation *event);
419 * Opaque Handle for Controller process
421 struct GNUNET_TESTBED_ControllerProc;
425 * Callback to signal successfull startup of the controller process
427 * @param cls the closure from GNUNET_TESTBED_controller_start()
428 * @param cfg the configuration with which the controller has been started;
429 * NULL if status is not GNUNET_OK
430 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
431 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
433 typedef void (*GNUNET_TESTBED_ControllerStatusCallback) (void *cls,
434 const struct GNUNET_CONFIGURATION_Handle *cfg,
439 * Starts a controller process at the given host. The given host's configration
440 * is used as a Template configuration to use for the remote controller; the
441 * remote controller will be started with a slightly modified configuration
442 * (port numbers, unix domain sockets and service home values are changed as per
443 * TESTING library on the remote host). The modified configuration replaces the
444 * host's existing configuration before signalling success through the
445 * GNUNET_TESTBED_ControllerStatusCallback()
447 * @param trusted_ip the ip address of the controller which will be set as TRUSTED
448 * HOST(all connections form this ip are permitted by the testbed) when
449 * starting testbed controller at host. This can either be a single ip
450 * address or a network address in CIDR notation.
451 * @param host the host where the controller has to be started. CANNOT be NULL.
452 * @param cb function called when the controller is successfully started or
453 * dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
454 * called if cb is called with GNUNET_SYSERR as status. Will never be
455 * called in the same task as 'GNUNET_TESTBED_controller_start'
456 * (synchronous errors will be signalled by returning NULL). This
457 * parameter cannot be NULL.
458 * @param cls closure for above callbacks
459 * @return the controller process handle, NULL on errors
461 struct GNUNET_TESTBED_ControllerProc *
462 GNUNET_TESTBED_controller_start (const char *trusted_ip,
463 struct GNUNET_TESTBED_Host *host,
464 GNUNET_TESTBED_ControllerStatusCallback cb,
469 * Stop the controller process (also will terminate all peers and controllers
470 * dependent on this controller). This function blocks until the testbed has
471 * been fully terminated (!). The controller status cb from
472 * GNUNET_TESTBED_controller_start() will not be called.
474 * @param cproc the controller process handle
477 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc);
481 * Connect to a controller process. The configuration to use for the connection
482 * is retreived from the given host where a controller is started using
483 * GNUNET_TESTBED_controller_start().
485 * @param host host to run the controller on; This should be the same host if
486 * the controller was previously started with
487 * GNUNET_TESTBED_controller_start()
488 * @param event_mask bit mask with set of events to call 'cc' for;
489 * or-ed values of "1LL" shifted by the
490 * respective 'enum GNUNET_TESTBED_EventType'
491 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
492 * @param cc controller callback to invoke on events
493 * @param cc_cls closure for cc
494 * @return handle to the controller
496 struct GNUNET_TESTBED_Controller *
497 GNUNET_TESTBED_controller_connect (struct GNUNET_TESTBED_Host *host,
499 GNUNET_TESTBED_ControllerCallback cc,
504 * Stop the given controller (also will terminate all peers and
505 * controllers dependent on this controller). This function
506 * blocks until the testbed has been fully terminated (!).
508 * @param c handle to controller to stop
511 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *c);
515 * Opaque handle for host registration
517 struct GNUNET_TESTBED_HostRegistrationHandle;
521 * Callback which will be called to after a host registration succeeded or failed
523 * @param cls the closure
524 * @param emsg the error message; NULL if host registration is successful
526 typedef void (* GNUNET_TESTBED_HostRegistrationCompletion) (void *cls,
531 * Register a host with the controller. This makes the controller aware of the
532 * host. A host should be registered at the controller before starting a
533 * sub-controller on that host using GNUNET_TESTBED_controller_link().
535 * @param controller the controller handle
536 * @param host the host to register
537 * @param cc the completion callback to call to inform the status of
538 * registration. After calling this callback the registration handle
539 * will be invalid. Cannot be NULL
540 * @param cc_cls the closure for the cc
541 * @return handle to the host registration which can be used to cancel the
542 * registration; NULL if another registration handle is present and
545 struct GNUNET_TESTBED_HostRegistrationHandle *
546 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
547 struct GNUNET_TESTBED_Host *host,
548 GNUNET_TESTBED_HostRegistrationCompletion cc,
553 * Cancel the pending registration. Note that the registration message will
554 * already be queued to be sent to the service, cancellation has only the
555 * effect that the registration completion callback for the registration is
556 * never called and from our perspective the host is not registered until the
557 * completion callback is called.
559 * @param handle the registration handle to cancel
562 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
567 * Callback to be called when an operation is completed
569 * @param cls the callback closure from functions generating an operation
570 * @param op the operation that has been finished
571 * @param emsg error message in case the operation has failed; will be NULL if
572 * operation has executed successfully.
574 typedef void (*GNUNET_TESTBED_OperationCompletionCallback) (void *cls,
576 GNUNET_TESTBED_Operation
582 * Create a link from slave controller to delegated controller. Whenever the
583 * master controller is asked to start a peer at the delegated controller the
584 * request will be routed towards slave controller (if a route exists). The
585 * slave controller will then route it to the delegated controller. The
586 * configuration of the delegated controller is given and is used to either
587 * create the delegated controller or to connect to an existing controller. Note
588 * that while starting the delegated controller the configuration will be
589 * modified to accommodate available free ports. the 'is_subordinate' specifies
590 * if the given delegated controller should be started and managed by the slave
591 * controller, or if the delegated controller already has a master and the slave
592 * controller connects to it as a non master controller. The success or failure
593 * of this operation will be signalled through the
594 * GNUNET_TESTBED_ControllerCallback() with an event of type
595 * #GNUNET_TESTBED_ET_OPERATION_FINISHED
597 * @param op_cls the operation closure for the event which is generated to
598 * signal success or failure of this operation
599 * @param master handle to the master controller who creates the association
600 * @param delegated_host requests to which host should be delegated; cannot be NULL
601 * @param slave_host which host is used to run the slave controller; use NULL to
602 * make the master controller connect to the delegated host
603 * @param is_subordinate #GNUNET_YES if the controller at delegated_host should
604 * be started by the slave controller; #GNUNET_NO if the slave
605 * controller has to connect to the already started delegated
606 * controller via TCP/IP
607 * @return the operation handle
609 struct GNUNET_TESTBED_Operation *
610 GNUNET_TESTBED_controller_link (void *op_cls,
611 struct GNUNET_TESTBED_Controller *master,
612 struct GNUNET_TESTBED_Host *delegated_host,
613 struct GNUNET_TESTBED_Host *slave_host,
618 * Function to acquire the configuration of a running slave controller. The
619 * completion of the operation is signalled through the controller_cb from
620 * GNUNET_TESTBED_controller_connect(). If the operation is successful the
621 * handle to the configuration is available in the generic pointer of
622 * operation_finished field of `struct GNUNET_TESTBED_EventInformation`.
624 * @param op_cls the closure for the operation
625 * @param master the handle to master controller
626 * @param slave_host the host where the slave controller is running; the handle
627 * to the slave_host should remain valid until this operation is
628 * cancelled or marked as finished
629 * @return the operation handle; NULL if the slave_host is not registered at
632 struct GNUNET_TESTBED_Operation *
633 GNUNET_TESTBED_get_slave_config (void *op_cls,
634 struct GNUNET_TESTBED_Controller *master,
635 struct GNUNET_TESTBED_Host *slave_host);
639 * Functions of this signature are called when a peer has been successfully
642 * @param cls the closure from GNUNET_TESTBED_peer_create()
643 * @param peer the handle for the created peer; NULL on any error during
645 * @param emsg NULL if peer is not NULL; else MAY contain the error description
647 typedef void (*GNUNET_TESTBED_PeerCreateCallback) (void *cls,
648 struct GNUNET_TESTBED_Peer *peer,
653 * Create the given peer at the specified host using the given
654 * controller. If the given controller is not running on the target
655 * host, it should find or create a controller at the target host and
656 * delegate creating the peer. Explicit delegation paths can be setup
657 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
658 * path exists, a direct link with a subordinate controller is setup
659 * for the first delegated peer to a particular host; the subordinate
660 * controller is then destroyed once the last peer that was delegated
661 * to the remote host is stopped.
663 * Creating the peer only creates the handle to manipulate and further
664 * configure the peer; use #GNUNET_TESTBED_peer_start and
665 * #GNUNET_TESTBED_peer_stop to actually start/stop the peer's
668 * Note that the given configuration will be adjusted by the
669 * controller to avoid port/path conflicts with other peers.
670 * The "final" configuration can be obtained using
671 * #GNUNET_TESTBED_peer_get_information.
673 * @param controller controller process to use
674 * @param host host to run the peer on; cannot be NULL
675 * @param cfg Template configuration to use for the peer. Should exist until
676 * operation is cancelled or GNUNET_TESTBED_operation_done() is called
677 * @param cb the callback to call when the peer has been created
678 * @param cls the closure to the above callback
679 * @return the operation handle
681 struct GNUNET_TESTBED_Operation *
682 GNUNET_TESTBED_peer_create (struct GNUNET_TESTBED_Controller *controller,
683 struct GNUNET_TESTBED_Host *host,
684 const struct GNUNET_CONFIGURATION_Handle *cfg,
685 GNUNET_TESTBED_PeerCreateCallback cb,
690 * Functions of this signature are called when a peer has been successfully
691 * started or stopped.
693 * @param cls the closure from GNUNET_TESTBED_peer_start/stop()
694 * @param emsg NULL on success; otherwise an error description
696 typedef void (*GNUNET_TESTBED_PeerChurnCallback) (void *cls,
701 * Start the given peer.
703 * @param op_cls the closure for this operation; will be set in the event
705 * @param peer peer to start
706 * @param pcc function to call upon completion
707 * @param pcc_cls closure for 'pcc'
708 * @return handle to the operation
710 struct GNUNET_TESTBED_Operation *
711 GNUNET_TESTBED_peer_start (void *op_cls,
712 struct GNUNET_TESTBED_Peer *peer,
713 GNUNET_TESTBED_PeerChurnCallback pcc,
718 * Stop the given peer. The handle remains valid (use
719 * #GNUNET_TESTBED_peer_destroy to fully clean up the
720 * state of the peer).
722 * @param op_cls the closure for this operation; will be set in the event
724 * @param peer peer to stop
725 * @param pcc function to call upon completion
726 * @param pcc_cls closure for 'pcc'
727 * @return handle to the operation
729 struct GNUNET_TESTBED_Operation *
730 GNUNET_TESTBED_peer_stop (void *op_cls,
731 struct GNUNET_TESTBED_Peer *peer,
732 GNUNET_TESTBED_PeerChurnCallback pcc,
737 * Data returned from GNUNET_TESTBED_peer_get_information
739 struct GNUNET_TESTBED_PeerInformation
742 * Peer information type; captures which of the types
743 * in the 'op_result' is actually in use.
745 enum GNUNET_TESTBED_PeerInformationType pit;
748 * The result of the get information operation; Choose according to the pit
753 * The configuration of the peer
755 struct GNUNET_CONFIGURATION_Handle *cfg;
758 * The identity of the peer
760 struct GNUNET_PeerIdentity *id;
766 * Callback to be called when the requested peer information is available
767 * The peer information in the callback is valid until the operation 'op' is canceled.
769 * @param cb_cls the closure from GNUNET_TETSBED_peer_get_information()
770 * @param op the operation this callback corresponds to
771 * @param pinfo the result; will be NULL if the operation has failed
772 * @param emsg error message if the operation has failed; will be NULL if the
773 * operation is successfull
775 typedef void (*GNUNET_TESTBED_PeerInfoCallback) (void *cb_cls,
776 struct GNUNET_TESTBED_Operation
779 GNUNET_TESTBED_PeerInformation
785 * Request information about a peer. The controller callback will not be called
786 * with event type #GNUNET_TESTBED_ET_OPERATION_FINISHED when result for this
787 * operation is available. Instead, the GNUNET_TESTBED_PeerInfoCallback() will
789 * The peer information in the callback is valid until the operation is canceled.
791 * @param peer peer to request information about
792 * @param pit desired information
793 * @param cb the convenience callback to be called when results for this
794 * operation are available
795 * @param cb_cls the closure for @a cb
796 * @return handle to the operation
798 struct GNUNET_TESTBED_Operation *
799 GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
800 enum GNUNET_TESTBED_PeerInformationType
802 GNUNET_TESTBED_PeerInfoCallback cb,
807 * Change peer configuration. Must only be called while the
808 * peer is stopped. Ports and paths cannot be changed this
811 * @param peer peer to change configuration for
812 * @param cfg new configuration (differences to existing
813 * configuration only)
814 * @return handle to the operation
816 struct GNUNET_TESTBED_Operation *
817 GNUNET_TESTBED_peer_update_configuration (struct GNUNET_TESTBED_Peer *peer,
818 const struct GNUNET_CONFIGURATION_Handle *cfg);
822 * Destroy the given peer; the peer should have been
823 * stopped first (if it was started).
825 * @param peer peer to stop
826 * @return handle to the operation
828 struct GNUNET_TESTBED_Operation *
829 GNUNET_TESTBED_peer_destroy (struct GNUNET_TESTBED_Peer *peer);
833 * Start or stop given service at a peer. This should not be called to
834 * start/stop the peer's ARM service. Use GNUNET_TESTBED_peer_start(),
835 * GNUNET_TESTBED_peer_stop() for starting/stopping peer's ARM service. Success
836 * or failure of the generated operation is signalled through the controller
837 * event callback and/or operation completion callback.
839 * @param op_cls the closure for the operation
840 * @param peer the peer whose service is to be started/stopped
841 * @param service_name the name of the service
842 * @param cb the operation completion callback
843 * @param cb_cls the closure for @a cb
844 * @param start 1 to start the service; 0 to stop the service
845 * @return an operation handle; NULL upon error (peer not running)
847 struct GNUNET_TESTBED_Operation *
848 GNUNET_TESTBED_peer_manage_service (void *op_cls,
849 struct GNUNET_TESTBED_Peer *peer,
850 const char *service_name,
851 GNUNET_TESTBED_OperationCompletionCallback cb,
857 * Stops and destroys all peers. Is equivalent of calling
858 * GNUNET_TESTBED_peer_stop() and GNUNET_TESTBED_peer_destroy() on all peers,
859 * except that the peer stop event and operation finished event corresponding to
860 * the respective functions are not generated. This function should be called
861 * when there are no other pending operations. If there are pending operations,
862 * it will return NULL
864 * @param c the controller to send this message to
865 * @param op_cls closure for the operation
866 * @param cb the callback to call when all peers are stopped and destroyed
867 * @param cb_cls the closure for the callback
868 * @return operation handle on success; NULL if any pending operations are
871 struct GNUNET_TESTBED_Operation *
872 GNUNET_TESTBED_shutdown_peers (struct GNUNET_TESTBED_Controller *c,
874 GNUNET_TESTBED_OperationCompletionCallback cb,
880 * Options for peer connections.
882 enum GNUNET_TESTBED_ConnectOption
885 * No option (not valid as an argument).
887 GNUNET_TESTBED_CO_NONE = 0,
890 * Allow or disallow a connection between the specified peers.
891 * Followed by #GNUNET_NO (int) if a connection is disallowed
892 * or #GNUNET_YES if a connection is allowed. Note that the
893 * default (all connections allowed or disallowed) is
894 * specified in the configuration of the controller.
896 GNUNET_TESTBED_CO_ALLOW = 1,
899 * FIXME: add (and implement) options to limit connection to
900 * particular transports, force simulation of particular latencies
901 * or message loss rates, or set bandwidth limitations.
908 * Manipulate the P2P underlay topology by configuring a link
911 * @param op_cls closure argument to give with the operation event
912 * @param p1 first peer
913 * @param p2 second peer
914 * @param co option to change
915 * @param ap option-specific values
916 * @return handle to the operation, NULL if configuring the link at this
917 * time is not allowed
919 struct GNUNET_TESTBED_Operation *
920 GNUNET_TESTBED_underlay_configure_link_va (void *op_cls,
921 struct GNUNET_TESTBED_Peer *p1,
922 struct GNUNET_TESTBED_Peer *p2,
923 enum GNUNET_TESTBED_ConnectOption co,
928 * Manipulate the P2P underlay topology by configuring a link
931 * @param op_cls closure argument to give with the operation event
932 * @param p1 first peer
933 * @param p2 second peer
934 * @param co option to change
935 * @param ... option-specific values
936 * @return handle to the operation, NULL if configuring the link at this
937 * time is not allowed
939 struct GNUNET_TESTBED_Operation *
940 GNUNET_TESTBED_underlay_configure_link (void *op_cls,
941 struct GNUNET_TESTBED_Peer *p1,
942 struct GNUNET_TESTBED_Peer *p2,
943 enum GNUNET_TESTBED_ConnectOption co, ...);
948 * Topologies and topology options supported for testbeds. Options should always
949 * end with GNUNET_TESTBED_TOPOLOGY_OPTION_END
951 enum GNUNET_TESTBED_TopologyOption
954 * A clique (everyone connected to everyone else). No options. If there are N
955 * peers this topology results in (N * (N -1)) connections.
957 GNUNET_TESTBED_TOPOLOGY_CLIQUE,
960 * Small-world network (2d torus plus random links). Followed
961 * by the number of random links to add (unsigned int).
963 GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD,
966 * Small-world network (ring plus random links). Followed
967 * by the number of random links to add (unsigned int).
969 GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING,
972 * Ring topology. No options.
974 GNUNET_TESTBED_TOPOLOGY_RING,
977 * 2-d torus. No options.
979 GNUNET_TESTBED_TOPOLOGY_2D_TORUS,
982 * Random graph. Followed by the number of random links to be established
985 GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI,
988 * Certain percentage of peers are unable to communicate directly
989 * replicating NAT conditions. Followed by the fraction of
990 * NAT'ed peers (float).
992 GNUNET_TESTBED_TOPOLOGY_INTERNAT,
995 * Scale free topology. It is generated according to the method described in
996 * "Emergence of Scaling in Random Networks." Science 286, 509-512, 1999.
998 * This options takes two arguments in the following order: an uint16_t to
999 * determine the maximum number of edges a peer is permitted to have while
1000 * generating scale free topology, a good value for this argument is 70; and
1001 * an uint8_t to determine the number of edges to be established when adding a
1002 * new node to the scale free network, a good value for this argument is 4.
1004 GNUNET_TESTBED_TOPOLOGY_SCALE_FREE,
1007 * Straight line topology. No options.
1009 GNUNET_TESTBED_TOPOLOGY_LINE,
1012 * Read a topology from a given file. Followed by the name of the file (const char *).
1014 GNUNET_TESTBED_TOPOLOGY_FROM_FILE,
1017 * All peers are disconnected. No options.
1019 GNUNET_TESTBED_TOPOLOGY_NONE,
1022 * The options should always end with this
1024 GNUNET_TESTBED_TOPOLOGY_OPTION_END,
1026 /* The following are not topologies but influence how the topology has to be
1027 setup. These options should follow the topology specific options (if
1028 required by the chosen topology). Note that these should be given before
1029 GNUNET_TESTBED_TOPOLOGY_OPTION_END */
1032 * How many times should the failed overlay connect operations be retried
1033 * before giving up. The default if this option is not specified is to retry
1034 * 3 times. This option takes and unsigned integer as a parameter. Use this
1035 * option with parameter 0 to disable retrying of failed overlay connect
1038 GNUNET_TESTBED_TOPOLOGY_RETRY_CNT
1043 * Configure overall network topology to have a particular shape.
1045 * @param op_cls closure argument to give with the operation event
1046 * @param num_peers number of peers in 'peers'
1047 * @param peers array of 'num_peers' with the peers to configure
1048 * @param topo desired underlay topology to use
1049 * @param ap topology-specific options
1050 * @return handle to the operation, NULL if configuring the topology
1051 * is not allowed at this time
1053 struct GNUNET_TESTBED_Operation *
1054 GNUNET_TESTBED_underlay_configure_topology_va (void *op_cls,
1055 unsigned int num_peers,
1056 struct GNUNET_TESTBED_Peer **peers,
1057 enum GNUNET_TESTBED_TopologyOption topo,
1062 * Configure overall network topology to have a particular shape.
1064 * @param op_cls closure argument to give with the operation event
1065 * @param num_peers number of peers in 'peers'
1066 * @param peers array of 'num_peers' with the peers to configure
1067 * @param topo desired underlay topology to use
1068 * @param ... topology-specific options
1069 * @return handle to the operation, NULL if configuring the topology
1070 * is not allowed at this time
1072 struct GNUNET_TESTBED_Operation *
1073 GNUNET_TESTBED_underlay_configure_topology (void *op_cls,
1074 unsigned int num_peers,
1075 struct GNUNET_TESTBED_Peer **peers,
1076 enum GNUNET_TESTBED_TopologyOption topo,
1081 * Both peers must have been started before calling this function.
1082 * This function then obtains a HELLO from @a p1, gives it to @a p2
1083 * and asks @a p2 to connect to @a p1.
1085 * @param op_cls closure argument to give with the operation event
1086 * @param cb the callback to call when this operation has finished
1087 * @param cb_cls the closure for @a cb
1088 * @param p1 first peer
1089 * @param p2 second peer
1090 * @return handle to the operation, NULL if connecting these two
1091 * peers is fundamentally not possible at this time (peers
1092 * not running or underlay disallows)
1094 struct GNUNET_TESTBED_Operation *
1095 GNUNET_TESTBED_overlay_connect (void *op_cls,
1096 GNUNET_TESTBED_OperationCompletionCallback cb,
1098 struct GNUNET_TESTBED_Peer *p1,
1099 struct GNUNET_TESTBED_Peer *p2);
1103 * Callbacks of this type are called when topology configuration is completed
1105 * @param cls the operation closure given to
1106 * GNUNET_TESTBED_overlay_configure_topology_va() and
1107 * GNUNET_TESTBED_overlay_configure() calls
1108 * @param nsuccess the number of successful overlay connects
1109 * @param nfailures the number of overlay connects which failed
1111 typedef void (*GNUNET_TESTBED_TopologyCompletionCallback) (void *cls,
1112 unsigned int nsuccess,
1113 unsigned int nfailures);
1117 * All peers must have been started before calling this function.
1118 * This function then connects the given peers in the P2P overlay
1119 * using the given topology.
1121 * @param op_cls closure argument to give with the peer connect operation events
1122 * generated through this function
1123 * @param num_peers number of peers in 'peers'
1124 * @param peers array of 'num_peers' with the peers to configure
1125 * @param max_connections the maximums number of overlay connections that will
1126 * be made to achieve the given topology
1127 * @param comp_cb the completion callback to call when the topology generation
1129 * @param comp_cb_cls closure for the @a comp_cb
1130 * @param topo desired underlay topology to use
1131 * @param va topology-specific options
1132 * @return handle to the operation, NULL if connecting these
1133 * peers is fundamentally not possible at this time (peers
1134 * not running or underlay disallows) or if num_peers is less than 2
1136 struct GNUNET_TESTBED_Operation *
1137 GNUNET_TESTBED_overlay_configure_topology_va (void *op_cls,
1138 unsigned int num_peers,
1139 struct GNUNET_TESTBED_Peer **peers,
1140 unsigned int *max_connections,
1141 GNUNET_TESTBED_TopologyCompletionCallback
1144 enum GNUNET_TESTBED_TopologyOption topo,
1149 * All peers must have been started before calling this function.
1150 * This function then connects the given peers in the P2P overlay
1151 * using the given topology.
1153 * @param op_cls closure argument to give with the peer connect operation events
1154 * generated through this function
1155 * @param num_peers number of peers in 'peers'
1156 * @param peers array of 'num_peers' with the peers to configure
1157 * @param max_connections the maximums number of overlay connections that will
1158 * be made to achieve the given topology
1159 * @param comp_cb the completion callback to call when the topology generation
1161 * @param comp_cb_cls closure for the above completion callback
1162 * @param topo desired underlay topology to use
1163 * @param ... topology-specific options
1164 * @return handle to the operation, NULL if connecting these
1165 * peers is fundamentally not possible at this time (peers
1166 * not running or underlay disallows) or if num_peers is less than 2
1168 struct GNUNET_TESTBED_Operation *
1169 GNUNET_TESTBED_overlay_configure_topology (void *op_cls,
1170 unsigned int num_peers,
1171 struct GNUNET_TESTBED_Peer **peers,
1172 unsigned int *max_connections,
1173 GNUNET_TESTBED_TopologyCompletionCallback
1176 enum GNUNET_TESTBED_TopologyOption topo,
1181 * Ask the testbed controller to write the current overlay topology to
1182 * a file. Naturally, the file will only contain a snapshot as the
1183 * topology may evolve all the time.
1184 * FIXME: needs continuation!?
1186 * @param controller overlay controller to inspect
1187 * @param filename name of the file the topology should
1191 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller *controller,
1192 const char *filename);
1196 * Adapter function called to establish a connection to
1199 * @param cls closure
1200 * @param cfg configuration of the peer to connect to; will be available until
1201 * GNUNET_TESTBED_operation_done() is called on the operation returned
1202 * from GNUNET_TESTBED_service_connect()
1203 * @return service handle to return in 'op_result', NULL on error
1205 typedef void * (*GNUNET_TESTBED_ConnectAdapter)(void *cls,
1206 const struct GNUNET_CONFIGURATION_Handle *cfg);
1210 * Adapter function called to destroy a connection to
1213 * @param cls closure
1214 * @param op_result service handle returned from the connect adapter
1216 typedef void (*GNUNET_TESTBED_DisconnectAdapter)(void *cls,
1221 * Callback to be called when a service connect operation is completed
1223 * @param cls the callback closure from functions generating an operation
1224 * @param op the operation that has been finished
1225 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
1226 * @param emsg error message in case the operation has failed; will be NULL if
1227 * operation has executed successfully.
1229 typedef void (*GNUNET_TESTBED_ServiceConnectCompletionCallback) (void *cls,
1231 GNUNET_TESTBED_Operation
1240 * Connect to a service offered by the given peer. Will ensure that
1241 * the request is queued to not overwhelm our ability to create and
1242 * maintain connections with other systems. The actual service
1243 * handle is then returned via the 'op_result' member in the event
1244 * callback. The @a ca callback is used to create the connection
1245 * when the time is right; the @a da callback will be used to
1246 * destroy the connection (upon #GNUNET_TESTBED_operation_done).
1247 * #GNUNET_TESTBED_operation_done can be used to abort this
1248 * operation until the event callback has been called.
1250 * @param op_cls closure to pass in operation event // FIXME: didn't we say we'd no longer use the global callback for these? -CG
1251 * @param peer peer that runs the service
1252 * @param service_name name of the service to connect to
1253 * @param cb the callback to call when this operation is ready (that is,
1254 * right after the connect adapter returns)
1255 * @param cb_cls closure for @a cb
1256 * @param ca helper function to establish the connection
1257 * @param da helper function to close the connection
1258 * @param cada_cls closure for @a ca and @a da
1259 * @return handle for the operation
1261 struct GNUNET_TESTBED_Operation *
1262 GNUNET_TESTBED_service_connect (void *op_cls,
1263 struct GNUNET_TESTBED_Peer *peer,
1264 const char *service_name,
1265 GNUNET_TESTBED_ServiceConnectCompletionCallback cb,
1267 GNUNET_TESTBED_ConnectAdapter ca,
1268 GNUNET_TESTBED_DisconnectAdapter da,
1273 * This function is used to signal that the event information (struct
1274 * GNUNET_TESTBED_EventInformation) from an operation has been fully processed
1275 * i.e. if the event callback is ever called for this operation. If the event
1276 * callback for this operation has not yet been called, calling this function
1277 * cancels the operation, frees its resources and ensures the no event is
1278 * generated with respect to this operation. Note that however cancelling an
1279 * operation does NOT guarantee that the operation will be fully undone (or that
1280 * nothing ever happened).
1282 * This function MUST be called for every operation to fully remove the
1283 * operation from the operation queue. After calling this function, if
1284 * operation is completed and its event information is of type
1285 * GNUNET_TESTBED_ET_OPERATION_FINISHED, the 'op_result' becomes invalid (!).
1287 * If the operation is generated from GNUNET_TESTBED_service_connect() then
1288 * calling this function on such as operation calls the disconnect adapter if
1289 * the connect adapter was ever called.
1291 * @param operation operation to signal completion or cancellation
1294 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation);
1298 * Callback function to process statistic values from all peers.
1300 * @param cls closure
1301 * @param peer the peer the statistic belong to
1302 * @param subsystem name of subsystem that created the statistic
1303 * @param name the name of the datum
1304 * @param value the current value
1305 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
1306 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
1308 typedef int (*GNUNET_TESTBED_StatisticsIterator) (void *cls,
1309 const struct GNUNET_TESTBED_Peer *peer,
1310 const char *subsystem,
1317 * Convenience method that iterates over all (running) peers
1318 * and retrieves all statistics from each peer.
1320 * @param num_peers number of peers to iterate over
1321 * @param peers array of peers to iterate over
1322 * @param subsystem limit to the specified subsystem, NULL for all subsystems
1323 * @param name name of the statistic value, NULL for all values
1324 * @param proc processing function for each statistic retrieved
1325 * @param cont continuation to call once call is completed. The completion of this
1326 * operation is *ONLY* signalled through this callback -- no
1327 * GNUNET_TESTBED_ET_OPERATION_FINISHED is generated
1328 * @param cls closure to pass to proc and cont
1329 * @return operation handle to cancel the operation
1331 struct GNUNET_TESTBED_Operation *
1332 GNUNET_TESTBED_get_statistics (unsigned int num_peers,
1333 struct GNUNET_TESTBED_Peer **peers,
1334 const char *subsystem, const char *name,
1335 GNUNET_TESTBED_StatisticsIterator proc,
1336 GNUNET_TESTBED_OperationCompletionCallback cont,
1340 * Handle for testbed run helper funtions
1342 struct GNUNET_TESTBED_RunHandle;
1345 * Signature of a main function for a testcase.
1347 * @param cls closure
1348 * @param h the run handle
1349 * @param num_peers number of peers in 'peers'
1350 * @param peers handle to peers run in the testbed. NULL upon timeout (see
1351 * GNUNET_TESTBED_test_run()).
1352 * @param links_succeeded the number of overlay link connection attempts that
1354 * @param links_failed the number of overlay link connection attempts that
1356 * @see GNUNET_TESTBED_test_run()
1358 typedef void (*GNUNET_TESTBED_TestMaster)(void *cls,
1359 struct GNUNET_TESTBED_RunHandle *h,
1360 unsigned int num_peers,
1361 struct GNUNET_TESTBED_Peer **peers,
1362 unsigned int links_succeeded,
1363 unsigned int links_failed);
1367 * Convenience method for running a testbed with
1368 * a single call. Underlay and overlay topology
1369 * are configured using the "UNDERLAY" and "OVERLAY"
1370 * options in the "[testbed]" section of the configuration\
1371 * (with possible options given in "UNDERLAY_XXX" and/or
1374 * The test_master callback will be called once the testbed setup is finished or
1375 * upon a timeout. This timeout is given through the configuration file by
1376 * setting the option "SETUP_TIMEOUT" in "[TESTBED]" section.
1378 * The testbed is to be terminated using a call to
1379 * "GNUNET_SCHEDULER_shutdown".
1381 * @param host_filename name of the file with the 'hosts', NULL
1382 * to run everything on 'localhost'
1383 * @param cfg configuration to use (for testbed, controller and peers)
1384 * @param num_peers number of peers to start; FIXME: maybe put that ALSO into
1385 * cfg?; should be greater than 0
1386 * @param event_mask bit mask with set of events to call 'cc' for;
1387 * or-ed values of "1LL" shifted by the
1388 * respective 'enum GNUNET_TESTBED_EventType'
1389 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
1390 * @param cc controller callback to invoke on events; This callback is called
1391 * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
1392 * set in the event_mask as this is the only way get access to the
1393 * handle of each peer
1394 * @param cc_cls closure for cc
1395 * @param test_master this callback will be called once the test is ready or
1397 * @param test_master_cls closure for 'test_master'.
1400 GNUNET_TESTBED_run (const char *host_filename,
1401 const struct GNUNET_CONFIGURATION_Handle *cfg,
1402 unsigned int num_peers,
1403 uint64_t event_mask,
1404 GNUNET_TESTBED_ControllerCallback cc,
1406 GNUNET_TESTBED_TestMaster test_master,
1407 void *test_master_cls);
1411 * Convenience method for running a "simple" test on the local system
1412 * with a single call from 'main'. Underlay and overlay topology are
1413 * configured using the "UNDERLAY" and "OVERLAY" options in the
1414 * "[TESTBED]" section of the configuration (with possible options
1415 * given in "UNDERLAY_XXX" and/or "OVERLAY_XXX").
1417 * The test_master callback will be called once the testbed setup is finished or
1418 * upon a timeout. This timeout is given through the configuration file by
1419 * setting the option "SETUP_TIMEOUT" in "[TESTBED]" section.
1421 * The test is to be terminated using a call to
1422 * "GNUNET_SCHEDULER_shutdown". If starting the test fails,
1423 * the program is stopped without 'master' ever being run.
1425 * NOTE: this function should be called from 'main', NOT from
1426 * within a GNUNET_SCHEDULER-loop. This function will initialze
1427 * the scheduler loop, the testbed and then pass control to
1430 * @param testname name of the testcase (to configure logging, etc.)
1431 * @param cfg_filename configuration filename to use
1432 * (for testbed, controller and peers)
1433 * @param num_peers number of peers to start; should be greter than 0
1434 * @param event_mask bit mask with set of events to call 'cc' for;
1435 * or-ed values of "1LL" shifted by the
1436 * respective 'enum GNUNET_TESTBED_EventType'
1437 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
1438 * @param cc controller callback to invoke on events; This callback is called
1439 * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
1440 * set in the event_mask as this is the only way get access to the
1441 * handle of each peer
1442 * @param cc_cls closure for cc
1443 * @param test_master this callback will be called once the test is ready or
1445 * @param test_master_cls closure for 'test_master'.
1446 * @return GNUNET_SYSERR on error, GNUNET_OK on success
1449 GNUNET_TESTBED_test_run (const char *testname,
1450 const char *cfg_filename,
1451 unsigned int num_peers,
1452 uint64_t event_mask,
1453 GNUNET_TESTBED_ControllerCallback cc,
1455 GNUNET_TESTBED_TestMaster test_master,
1456 void *test_master_cls);
1460 * Obtain handle to the master controller from a testbed run. The handle
1461 * returned should not be disconnected.
1463 * @param h the testbed run handle
1464 * @return handle to the master controller
1466 struct GNUNET_TESTBED_Controller *
1467 GNUNET_TESTBED_run_get_controller_handle (struct GNUNET_TESTBED_RunHandle *h);
1470 * Opaque handle for barrier
1472 struct GNUNET_TESTBED_Barrier;
1476 * Status of a barrier
1478 enum GNUNET_TESTBED_BarrierStatus
1481 * Barrier initialised successfully
1483 GNUNET_TESTBED_BARRIERSTATUS_INITIALISED = 1,
1486 * Barrier is crossed
1488 GNUNET_TESTBED_BARRIERSTATUS_CROSSED,
1493 GNUNET_TESTBED_BARRIERSTATUS_ERROR,
1499 * Functions of this type are to be given as callback argument to
1500 * GNUNET_TESTBED_barrier_init(). The callback will be called when status
1501 * information is available for the barrier.
1503 * @param cls the closure given to GNUNET_TESTBED_barrier_init()
1504 * @param name the name of the barrier
1505 * @param barrier the barrier handle
1506 * @param status status of the barrier; GNUNET_OK if the barrier is crossed;
1507 * GNUNET_SYSERR upon error
1508 * @param emsg if the status were to be GNUNET_SYSERR, this parameter has the
1511 typedef void (*GNUNET_TESTBED_barrier_status_cb) (void *cls,
1513 struct GNUNET_TESTBED_Barrier
1515 enum GNUNET_TESTBED_BarrierStatus status,
1520 * Initialise a barrier and call the given callback when the required percentage
1521 * of peers (quorum) reach the barrier.
1523 * @param controller the handle to the controller
1524 * @param name identification name of the barrier
1525 * @param quorum the percentage of peers that is required to reach the barrier.
1526 * Peers signal reaching a barrier by calling
1527 * GNUNET_TESTBED_barrier_reached().
1528 * @param cb the callback to call when the barrier is reached or upon error.
1530 * @param cls closure for the above callback
1531 * @return barrier handle
1533 struct GNUNET_TESTBED_Barrier *
1534 GNUNET_TESTBED_barrier_init (struct GNUNET_TESTBED_Controller *controller,
1536 unsigned int quorum,
1537 GNUNET_TESTBED_barrier_status_cb cb, void *cls);
1543 * @param barrier the barrier handle
1546 GNUNET_TESTBED_barrier_cancel (struct GNUNET_TESTBED_Barrier *barrier);
1550 * Opaque handle for barrier wait
1552 struct GNUNET_TESTBED_BarrierWaitHandle;
1556 * Functions of this type are to be given as acallback argumetn to
1557 * GNUNET_TESTBED_barrier_wait(). The callback will be called when the barrier
1558 * corresponding given in GNUNET_TESTBED_barrier_wait() is crossed or cancelled.
1560 * @param cls closure pointer given to GNUNET_TESTBED_barrier_wait()
1561 * @param name the barrier name
1562 * @param status GNUNET_SYSERR in case of error while waiting for the barrier;
1563 * GNUNET_OK if the barrier is crossed
1565 typedef void (*GNUNET_TESTBED_barrier_wait_cb) (void *cls,
1571 * Wait for a barrier to be crossed. This function should be called by the
1572 * peers which have been started by the testbed. If the peer is not started by
1573 * testbed this function may return error
1575 * @param name the name of the barrier
1576 * @param cb the barrier wait callback
1577 * @param cls the closure for the above callback
1578 * @return barrier wait handle which can be used to cancel the waiting at
1579 * anytime before the callback is called. NULL upon error.
1581 struct GNUNET_TESTBED_BarrierWaitHandle *
1582 GNUNET_TESTBED_barrier_wait (const char *name,
1583 GNUNET_TESTBED_barrier_wait_cb cb,
1588 * Cancel a barrier wait handle. Should not be called in or after the callback
1589 * given to GNUNET_TESTBED_barrier_wait() has been called.
1591 * @param h the barrier wait handle
1594 GNUNET_TESTBED_barrier_wait_cancel (struct GNUNET_TESTBED_BarrierWaitHandle *h);
1597 #if 0 /* keep Emacsens' auto-indent happy */