2 This file is part of GNUnet
3 Copyright (C) 2008--2013 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @author Christian Grothoff
25 * API for writing tests and creating large-scale emulation testbeds for GNUnet.
27 * @defgroup testbed Testbed service
28 * Writing tests and creating large-scale emulation testbeds for GNUnet.
30 * @see [Documentation](https://gnunet.org/gnunet-testbed-subsystem)
35 #ifndef GNUNET_TESTBED_SERVICE_H
36 #define GNUNET_TESTBED_SERVICE_H
38 #include "gnunet_util_lib.h"
39 #include "gnunet_testing_lib.h"
44 #if 0 /* keep Emacsens' auto-indent happy */
51 * Opaque handle to a host running experiments managed by the testbed framework.
52 * The master process must be able to SSH to this host without password (via
55 struct GNUNET_TESTBED_Host;
58 * Opaque handle to a peer controlled by the testbed framework. A peer runs
59 * at a particular host.
61 struct GNUNET_TESTBED_Peer;
64 * Opaque handle to an abstract operation to be executed by the testbed framework.
66 struct GNUNET_TESTBED_Operation;
69 * Handle to interact with a GNUnet testbed controller. Each
70 * controller has at least one master handle which is created when the
71 * controller is created; this master handle interacts with the
72 * controller process, destroying it destroys the controller (by
73 * closing stdin of the controller process). Additionally,
74 * controllers can interact with each other (in a P2P fashion); those
75 * links are established via TCP/IP on the controller's service port.
77 struct GNUNET_TESTBED_Controller;
81 * Create a host to run peers and controllers on.
83 * @param hostname name of the host, use "NULL" for localhost
84 * @param username username to use for the login; may be NULL
85 * @param cfg the configuration to use as a template while starting a controller
86 * on this host. Operation queue sizes specific to a host are also
87 * read from this configuration handle
88 * @param port port number to use for ssh; use 0 to let ssh decide
89 * @return handle to the host, NULL on error
91 struct GNUNET_TESTBED_Host *
92 GNUNET_TESTBED_host_create (const char *hostname,
94 const struct GNUNET_CONFIGURATION_Handle *cfg,
100 * Create a host to run peers and controllers on. This function is used
101 * if a peer learns about a host via IPC between controllers (and thus
102 * some higher-level controller has already determined the unique IDs).
104 * @param id global host ID assigned to the host; 0 is
105 * reserved to always mean 'localhost'
106 * @param hostname name of the host, use "NULL" for localhost
107 * @param username username to use for the login; may be NULL
108 * @param cfg the configuration to use as a template while starting a controller
109 * on this host. Operation queue sizes specific to a host are also
110 * read from this configuration handle
111 * @param port port number to use for ssh; use 0 to let ssh decide
112 * @return handle to the host, NULL on error
114 struct GNUNET_TESTBED_Host *
115 GNUNET_TESTBED_host_create_with_id (uint32_t id,
116 const char *hostname,
117 const char *username,
118 const struct GNUNET_CONFIGURATION_Handle
124 * Load a set of hosts from a configuration file. The hostfile format is
125 * specified at https://gnunet.org/content/hosts-file-format
127 * @param filename file with the host specification
128 * @param cfg the configuration to use as a template while starting a controller
129 * on any of the loaded hosts. Operation queue sizes specific to a host
130 * are also read from this configuration handle
131 * @param hosts set to the hosts found in the file; caller must free this if
132 * number of hosts returned is greater than 0
133 * @return number of hosts returned in 'hosts', 0 on error
136 GNUNET_TESTBED_hosts_load_from_file (const char *filename,
137 const struct GNUNET_CONFIGURATION_Handle
139 struct GNUNET_TESTBED_Host ***hosts);
143 * Loads the set of host allocated by the LoadLeveler Job Scheduler. This
144 * function is only available when compiled with support for LoadLeveler and is
145 * used for running on the SuperMUC
147 * @param cfg the configuration to use as a template while starting a controller
148 * on any of the loaded hosts. Operation queue sizes specific to a host
149 * are also read from this configuration handle
150 * @param hosts set to the hosts found in the file; caller must free this if
151 * number of hosts returned is greater than 0
152 * @return number of hosts returned in 'hosts', 0 on error
155 GNUNET_TESTBED_hosts_load_from_loadleveler (const struct
156 GNUNET_CONFIGURATION_Handle *cfg,
157 struct GNUNET_TESTBED_Host
161 * Destroy a host handle. Must only be called once everything
162 * running on that host has been stopped.
164 * @param host handle to destroy
167 GNUNET_TESTBED_host_destroy (struct GNUNET_TESTBED_Host *host);
171 * The handle for whether a host is habitable or not
173 struct GNUNET_TESTBED_HostHabitableCheckHandle;
177 * Callbacks of this type are called by GNUNET_TESTBED_is_host_habitable to
178 * inform whether the given host is habitable or not. The Handle returned by
179 * GNUNET_TESTBED_is_host_habitable() is invalid after this callback is called
181 * @param cls the closure given to GNUNET_TESTBED_is_host_habitable()
182 * @param host the host whose status is being reported; will be NULL if the host
183 * given to GNUNET_TESTBED_is_host_habitable() is NULL
184 * @param status GNUNET_YES if it is habitable; GNUNET_NO if not
187 (*GNUNET_TESTBED_HostHabitableCallback) (void *cls,
188 const struct GNUNET_TESTBED_Host *host,
193 * Checks whether a host can be used to start testbed service
195 * @param host the host to check
196 * @param config the configuration handle to lookup the path of the testbed
198 * @param cb the callback to call to inform about habitability of the given host
199 * @param cb_cls the closure for the callback
200 * @return NULL upon any error or a handle which can be passed to
201 * GNUNET_TESTBED_is_host_habitable_cancel()
203 struct GNUNET_TESTBED_HostHabitableCheckHandle *
204 GNUNET_TESTBED_is_host_habitable (const struct GNUNET_TESTBED_Host *host,
205 const struct GNUNET_CONFIGURATION_Handle
207 GNUNET_TESTBED_HostHabitableCallback cb,
212 * Function to cancel a request started using GNUNET_TESTBED_is_host_habitable()
214 * @param handle the habitability check handle
217 GNUNET_TESTBED_is_host_habitable_cancel (struct
218 GNUNET_TESTBED_HostHabitableCheckHandle
222 * Obtain the host's hostname.
224 * @param host handle to the host, NULL means 'localhost'
225 * @return hostname of the host
228 GNUNET_TESTBED_host_get_hostname (const struct GNUNET_TESTBED_Host *host);
232 * Enumeration with (at most 64) possible event types that
233 * can be monitored using the testbed framework.
235 enum GNUNET_TESTBED_EventType
238 * A peer has been started.
240 GNUNET_TESTBED_ET_PEER_START = 0,
243 * A peer has been stopped.
245 GNUNET_TESTBED_ET_PEER_STOP = 1,
248 * A connection between two peers was established.
250 GNUNET_TESTBED_ET_CONNECT = 2,
253 * A connection between two peers was torn down.
255 GNUNET_TESTBED_ET_DISCONNECT = 3,
258 * A requested testbed operation has been completed.
260 GNUNET_TESTBED_ET_OPERATION_FINISHED = 4,
266 * Types of information that can be requested about a peer.
268 enum GNUNET_TESTBED_PeerInformationType
272 * Special value (not valid for requesting information)
273 * that is used in the event struct if a 'generic' pointer
274 * is returned (for other operations not related to this
277 GNUNET_TESTBED_PIT_GENERIC = 0,
280 * What configuration is the peer using? Returns a 'const struct
281 * GNUNET_CONFIGURATION_Handle *'. Valid until
282 * 'GNUNET_TESTNIG_operation_done' is called. However, the
283 * values may be inaccurate if the peer is reconfigured in
286 GNUNET_TESTBED_PIT_CONFIGURATION,
289 * What is the identity of the peer? Returns a
290 * 'const struct GNUNET_PeerIdentity *'. Valid until
291 * 'GNUNET_TESTNIG_operation_done' is called.
293 GNUNET_TESTBED_PIT_IDENTITY
299 * Argument to GNUNET_TESTBED_ControllerCallback with details about
302 struct GNUNET_TESTBED_EventInformation
308 enum GNUNET_TESTBED_EventType type;
311 * Handle for the corresponding operation that generated this event
313 struct GNUNET_TESTBED_Operation *op;
316 * Closure given while creating the above operation
321 * Details about the event.
327 * Details about peer start event.
332 * Handle for the host where the peer
335 struct GNUNET_TESTBED_Host *host;
338 * Handle for the peer that was started.
340 struct GNUNET_TESTBED_Peer *peer;
345 * Details about peer stop event.
351 * Handle for the peer that was started.
353 struct GNUNET_TESTBED_Peer *peer;
358 * Details about connect event.
363 * Handle for one of the connected peers.
365 struct GNUNET_TESTBED_Peer *peer1;
368 * Handle for one of the connected peers.
370 struct GNUNET_TESTBED_Peer *peer2;
375 * Details about disconnect event.
380 * Handle for one of the disconnected peers.
382 struct GNUNET_TESTBED_Peer *peer1;
385 * Handle for one of the disconnected peers.
387 struct GNUNET_TESTBED_Peer *peer2;
392 * Details about an operation finished event.
397 * Error message for the operation, NULL on success.
402 * No result (NULL pointer) or generic result
403 * (whatever the GNUNET_TESTBED_ConnectAdapter returned).
407 } operation_finished;
415 * Signature of the event handler function called by the
416 * respective event controller.
419 * @param event information about the event
422 (*GNUNET_TESTBED_ControllerCallback)(void *cls,
423 const struct GNUNET_TESTBED_EventInformation *event);
427 * Opaque Handle for Controller process
429 struct GNUNET_TESTBED_ControllerProc;
433 * Callback to signal successfull startup of the controller process
435 * @param cls the closure from GNUNET_TESTBED_controller_start()
436 * @param cfg the configuration with which the controller has been started;
437 * NULL if status is not #GNUNET_OK
438 * @param status #GNUNET_OK if the startup is successfull; #GNUNET_SYSERR if not,
439 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
442 (*GNUNET_TESTBED_ControllerStatusCallback) (void *cls,
443 const struct GNUNET_CONFIGURATION_Handle *cfg,
448 * Starts a controller process at the given host. The given host's configration
449 * is used as a Template configuration to use for the remote controller; the
450 * remote controller will be started with a slightly modified configuration
451 * (port numbers, unix domain sockets and service home values are changed as per
452 * TESTING library on the remote host). The modified configuration replaces the
453 * host's existing configuration before signalling success through the
454 * GNUNET_TESTBED_ControllerStatusCallback()
456 * @param trusted_ip the ip address of the controller which will be set as TRUSTED
457 * HOST(all connections form this ip are permitted by the testbed) when
458 * starting testbed controller at host. This can either be a single ip
459 * address or a network address in CIDR notation.
460 * @param host the host where the controller has to be started. CANNOT be NULL.
461 * @param cb function called when the controller is successfully started or
462 * dies unexpectedly; GNUNET_TESTBED_controller_stop shouldn't be
463 * called if cb is called with GNUNET_SYSERR as status. Will never be
464 * called in the same task as 'GNUNET_TESTBED_controller_start'
465 * (synchronous errors will be signalled by returning NULL). This
466 * parameter cannot be NULL.
467 * @param cls closure for above callbacks
468 * @return the controller process handle, NULL on errors
470 struct GNUNET_TESTBED_ControllerProc *
471 GNUNET_TESTBED_controller_start (const char *trusted_ip,
472 struct GNUNET_TESTBED_Host *host,
473 GNUNET_TESTBED_ControllerStatusCallback cb,
478 * Stop the controller process (also will terminate all peers and controllers
479 * dependent on this controller). This function blocks until the testbed has
480 * been fully terminated (!). The controller status cb from
481 * GNUNET_TESTBED_controller_start() will not be called.
483 * @param cproc the controller process handle
486 GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc);
490 * Connect to a controller process. The configuration to use for the connection
491 * is retreived from the given host where a controller is started using
492 * GNUNET_TESTBED_controller_start().
494 * @param host host to run the controller on; This should be the same host if
495 * the controller was previously started with
496 * GNUNET_TESTBED_controller_start()
497 * @param event_mask bit mask with set of events to call 'cc' for;
498 * or-ed values of "1LL" shifted by the
499 * respective 'enum GNUNET_TESTBED_EventType'
500 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...")
501 * @param cc controller callback to invoke on events
502 * @param cc_cls closure for cc
503 * @return handle to the controller
505 struct GNUNET_TESTBED_Controller *
506 GNUNET_TESTBED_controller_connect (struct GNUNET_TESTBED_Host *host,
508 GNUNET_TESTBED_ControllerCallback cc,
513 * Stop the given controller (also will terminate all peers and
514 * controllers dependent on this controller). This function
515 * blocks until the testbed has been fully terminated (!).
517 * @param c handle to controller to stop
520 GNUNET_TESTBED_controller_disconnect (struct GNUNET_TESTBED_Controller *c);
524 * Opaque handle for host registration
526 struct GNUNET_TESTBED_HostRegistrationHandle;
530 * Callback which will be called to after a host registration succeeded or failed
532 * @param cls the closure
533 * @param emsg the error message; NULL if host registration is successful
536 (* GNUNET_TESTBED_HostRegistrationCompletion) (void *cls,
541 * Register a host with the controller. This makes the controller aware of the
542 * host. A host should be registered at the controller before starting a
543 * sub-controller on that host using GNUNET_TESTBED_controller_link().
545 * @param controller the controller handle
546 * @param host the host to register
547 * @param cc the completion callback to call to inform the status of
548 * registration. After calling this callback the registration handle
549 * will be invalid. Cannot be NULL
550 * @param cc_cls the closure for the cc
551 * @return handle to the host registration which can be used to cancel the
552 * registration; NULL if another registration handle is present and
555 struct GNUNET_TESTBED_HostRegistrationHandle *
556 GNUNET_TESTBED_register_host (struct GNUNET_TESTBED_Controller *controller,
557 struct GNUNET_TESTBED_Host *host,
558 GNUNET_TESTBED_HostRegistrationCompletion cc,
563 * Cancel the pending registration. Note that the registration message will
564 * already be queued to be sent to the service, cancellation has only the
565 * effect that the registration completion callback for the registration is
566 * never called and from our perspective the host is not registered until the
567 * completion callback is called.
569 * @param handle the registration handle to cancel
572 GNUNET_TESTBED_cancel_registration (struct GNUNET_TESTBED_HostRegistrationHandle
577 * Callback to be called when an operation is completed
579 * @param cls the callback closure from functions generating an operation
580 * @param op the operation that has been finished
581 * @param emsg error message in case the operation has failed; will be NULL if
582 * operation has executed successfully.
585 (*GNUNET_TESTBED_OperationCompletionCallback) (void *cls,
586 struct GNUNET_TESTBED_Operation *op,
591 * Create a link from slave controller to delegated controller. Whenever the
592 * master controller is asked to start a peer at the delegated controller the
593 * request will be routed towards slave controller (if a route exists). The
594 * slave controller will then route it to the delegated controller. The
595 * configuration of the delegated controller is given and is used to either
596 * create the delegated controller or to connect to an existing controller. Note
597 * that while starting the delegated controller the configuration will be
598 * modified to accommodate available free ports. the 'is_subordinate' specifies
599 * if the given delegated controller should be started and managed by the slave
600 * controller, or if the delegated controller already has a master and the slave
601 * controller connects to it as a non master controller. The success or failure
602 * of this operation will be signalled through the
603 * GNUNET_TESTBED_ControllerCallback() with an event of type
604 * #GNUNET_TESTBED_ET_OPERATION_FINISHED
606 * @param op_cls the operation closure for the event which is generated to
607 * signal success or failure of this operation
608 * @param master handle to the master controller who creates the association
609 * @param delegated_host requests to which host should be delegated; cannot be NULL
610 * @param slave_host which host is used to run the slave controller; use NULL to
611 * make the master controller connect to the delegated host
612 * @param is_subordinate #GNUNET_YES if the controller at delegated_host should
613 * be started by the slave controller; #GNUNET_NO if the slave
614 * controller has to connect to the already started delegated
615 * controller via TCP/IP
616 * @return the operation handle
618 struct GNUNET_TESTBED_Operation *
619 GNUNET_TESTBED_controller_link (void *op_cls,
620 struct GNUNET_TESTBED_Controller *master,
621 struct GNUNET_TESTBED_Host *delegated_host,
622 struct GNUNET_TESTBED_Host *slave_host,
627 * Function to acquire the configuration of a running slave controller. The
628 * completion of the operation is signalled through the controller_cb from
629 * GNUNET_TESTBED_controller_connect(). If the operation is successful the
630 * handle to the configuration is available in the generic pointer of
631 * operation_finished field of `struct GNUNET_TESTBED_EventInformation`.
633 * @param op_cls the closure for the operation
634 * @param master the handle to master controller
635 * @param slave_host the host where the slave controller is running; the handle
636 * to the slave_host should remain valid until this operation is
637 * cancelled or marked as finished
638 * @return the operation handle; NULL if the slave_host is not registered at
641 struct GNUNET_TESTBED_Operation *
642 GNUNET_TESTBED_get_slave_config (void *op_cls,
643 struct GNUNET_TESTBED_Controller *master,
644 struct GNUNET_TESTBED_Host *slave_host);
648 * Functions of this signature are called when a peer has been successfully
651 * @param cls the closure from GNUNET_TESTBED_peer_create()
652 * @param peer the handle for the created peer; NULL on any error during
654 * @param emsg NULL if peer is not NULL; else MAY contain the error description
657 (*GNUNET_TESTBED_PeerCreateCallback) (void *cls,
658 struct GNUNET_TESTBED_Peer *peer,
663 * Create the given peer at the specified host using the given
664 * controller. If the given controller is not running on the target
665 * host, it should find or create a controller at the target host and
666 * delegate creating the peer. Explicit delegation paths can be setup
667 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
668 * path exists, a direct link with a subordinate controller is setup
669 * for the first delegated peer to a particular host; the subordinate
670 * controller is then destroyed once the last peer that was delegated
671 * to the remote host is stopped.
673 * Creating the peer only creates the handle to manipulate and further
674 * configure the peer; use #GNUNET_TESTBED_peer_start and
675 * #GNUNET_TESTBED_peer_stop to actually start/stop the peer's
678 * Note that the given configuration will be adjusted by the
679 * controller to avoid port/path conflicts with other peers.
680 * The "final" configuration can be obtained using
681 * #GNUNET_TESTBED_peer_get_information.
683 * @param controller controller process to use
684 * @param host host to run the peer on; cannot be NULL
685 * @param cfg Template configuration to use for the peer. Should exist until
686 * operation is cancelled or GNUNET_TESTBED_operation_done() is called
687 * @param cb the callback to call when the peer has been created
688 * @param cls the closure to the above callback
689 * @return the operation handle
691 struct GNUNET_TESTBED_Operation *
692 GNUNET_TESTBED_peer_create (struct GNUNET_TESTBED_Controller *controller,
693 struct GNUNET_TESTBED_Host *host,
694 const struct GNUNET_CONFIGURATION_Handle *cfg,
695 GNUNET_TESTBED_PeerCreateCallback cb,
700 * Functions of this signature are called when a peer has been successfully
701 * started or stopped.
703 * @param cls the closure from GNUNET_TESTBED_peer_start/stop()
704 * @param emsg NULL on success; otherwise an error description
707 (*GNUNET_TESTBED_PeerChurnCallback) (void *cls,
712 * Start the given peer.
714 * @param op_cls the closure for this operation; will be set in the event
716 * @param peer peer to start
717 * @param pcc function to call upon completion
718 * @param pcc_cls closure for 'pcc'
719 * @return handle to the operation
721 struct GNUNET_TESTBED_Operation *
722 GNUNET_TESTBED_peer_start (void *op_cls,
723 struct GNUNET_TESTBED_Peer *peer,
724 GNUNET_TESTBED_PeerChurnCallback pcc,
729 * Stop the given peer. The handle remains valid (use
730 * #GNUNET_TESTBED_peer_destroy to fully clean up the
731 * state of the peer).
733 * @param op_cls the closure for this operation; will be set in the event
735 * @param peer peer to stop
736 * @param pcc function to call upon completion
737 * @param pcc_cls closure for 'pcc'
738 * @return handle to the operation
740 struct GNUNET_TESTBED_Operation *
741 GNUNET_TESTBED_peer_stop (void *op_cls,
742 struct GNUNET_TESTBED_Peer *peer,
743 GNUNET_TESTBED_PeerChurnCallback pcc,
748 * Data returned from GNUNET_TESTBED_peer_get_information
750 struct GNUNET_TESTBED_PeerInformation
753 * Peer information type; captures which of the types
754 * in the 'op_result' is actually in use.
756 enum GNUNET_TESTBED_PeerInformationType pit;
759 * The result of the get information operation; Choose according to the pit
764 * The configuration of the peer
766 struct GNUNET_CONFIGURATION_Handle *cfg;
769 * The identity of the peer
771 struct GNUNET_PeerIdentity *id;
777 * Callback to be called when the requested peer information is available
778 * The peer information in the callback is valid until the operation 'op' is canceled.
780 * @param cb_cls the closure from GNUNET_TETSBED_peer_get_information()
781 * @param op the operation this callback corresponds to
782 * @param pinfo the result; will be NULL if the operation has failed
783 * @param emsg error message if the operation has failed; will be NULL if the
784 * operation is successfull
787 (*GNUNET_TESTBED_PeerInfoCallback) (void *cb_cls,
788 struct GNUNET_TESTBED_Operation *op,
789 const struct GNUNET_TESTBED_PeerInformation *pinfo,
794 * Request information about a peer. The controller callback will not be called
795 * with event type #GNUNET_TESTBED_ET_OPERATION_FINISHED when result for this
796 * operation is available. Instead, the GNUNET_TESTBED_PeerInfoCallback() will
798 * The peer information in the callback is valid until the operation is canceled.
800 * @param peer peer to request information about
801 * @param pit desired information
802 * @param cb the convenience callback to be called when results for this
803 * operation are available
804 * @param cb_cls the closure for @a cb
805 * @return handle to the operation
807 struct GNUNET_TESTBED_Operation *
808 GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
809 enum GNUNET_TESTBED_PeerInformationType
811 GNUNET_TESTBED_PeerInfoCallback cb,
816 * Change @a peer configuration. Ports and paths cannot be changed this
819 * @param peer peer to change configuration for
820 * @param cfg new configuration
821 * @return handle to the operation
823 struct GNUNET_TESTBED_Operation *
824 GNUNET_TESTBED_peer_update_configuration (struct GNUNET_TESTBED_Peer *peer,
825 const struct GNUNET_CONFIGURATION_Handle *cfg);
829 * Destroy the given peer; the peer should have been
830 * stopped first (if it was started).
832 * @param peer peer to stop
833 * @return handle to the operation
835 struct GNUNET_TESTBED_Operation *
836 GNUNET_TESTBED_peer_destroy (struct GNUNET_TESTBED_Peer *peer);
840 * Start or stop given service at a peer. This should not be called to
841 * start/stop the peer's ARM service. Use GNUNET_TESTBED_peer_start(),
842 * GNUNET_TESTBED_peer_stop() for starting/stopping peer's ARM service. Success
843 * or failure of the generated operation is signalled through the controller
844 * event callback and/or operation completion callback.
846 * @param op_cls the closure for the operation
847 * @param peer the peer whose service is to be started/stopped
848 * @param service_name the name of the service
849 * @param cb the operation completion callback
850 * @param cb_cls the closure for @a cb
851 * @param start 1 to start the service; 0 to stop the service
852 * @return an operation handle; NULL upon error (peer not running)
854 struct GNUNET_TESTBED_Operation *
855 GNUNET_TESTBED_peer_manage_service (void *op_cls,
856 struct GNUNET_TESTBED_Peer *peer,
857 const char *service_name,
858 GNUNET_TESTBED_OperationCompletionCallback cb,
864 * Stops and destroys all peers. Is equivalent of calling
865 * GNUNET_TESTBED_peer_stop() and GNUNET_TESTBED_peer_destroy() on all peers,
866 * except that the peer stop event and operation finished event corresponding to
867 * the respective functions are not generated. This function should be called
868 * when there are no other pending operations. If there are pending operations,
869 * it will return NULL
871 * @param c the controller to send this message to
872 * @param op_cls closure for the operation
873 * @param cb the callback to call when all peers are stopped and destroyed
874 * @param cb_cls the closure for the callback
875 * @return operation handle on success; NULL if any pending operations are
878 struct GNUNET_TESTBED_Operation *
879 GNUNET_TESTBED_shutdown_peers (struct GNUNET_TESTBED_Controller *c,
881 GNUNET_TESTBED_OperationCompletionCallback cb,
887 * Options for peer connections.
889 enum GNUNET_TESTBED_ConnectOption
892 * No option (not valid as an argument).
894 GNUNET_TESTBED_CO_NONE = 0,
897 * Allow or disallow a connection between the specified peers.
898 * Followed by #GNUNET_NO (int) if a connection is disallowed
899 * or #GNUNET_YES if a connection is allowed. Note that the
900 * default (all connections allowed or disallowed) is
901 * specified in the configuration of the controller.
903 GNUNET_TESTBED_CO_ALLOW = 1,
906 * FIXME: add (and implement) options to limit connection to
907 * particular transports, force simulation of particular latencies
908 * or message loss rates, or set bandwidth limitations.
915 * Manipulate the P2P underlay topology by configuring a link
918 * @param op_cls closure argument to give with the operation event
919 * @param p1 first peer
920 * @param p2 second peer
921 * @param co option to change
922 * @param ap option-specific values
923 * @return handle to the operation, NULL if configuring the link at this
924 * time is not allowed
926 struct GNUNET_TESTBED_Operation *
927 GNUNET_TESTBED_underlay_configure_link_va (void *op_cls,
928 struct GNUNET_TESTBED_Peer *p1,
929 struct GNUNET_TESTBED_Peer *p2,
930 enum GNUNET_TESTBED_ConnectOption co,
935 * Manipulate the P2P underlay topology by configuring a link
938 * @param op_cls closure argument to give with the operation event
939 * @param p1 first peer
940 * @param p2 second peer
941 * @param co option to change
942 * @param ... option-specific values
943 * @return handle to the operation, NULL if configuring the link at this
944 * time is not allowed
946 struct GNUNET_TESTBED_Operation *
947 GNUNET_TESTBED_underlay_configure_link (void *op_cls,
948 struct GNUNET_TESTBED_Peer *p1,
949 struct GNUNET_TESTBED_Peer *p2,
950 enum GNUNET_TESTBED_ConnectOption co, ...);
955 * Topologies and topology options supported for testbeds. Options should always
956 * end with #GNUNET_TESTBED_TOPOLOGY_OPTION_END
958 enum GNUNET_TESTBED_TopologyOption
961 * A clique (everyone connected to everyone else). No options. If there are N
962 * peers this topology results in (N * (N -1)) connections.
964 GNUNET_TESTBED_TOPOLOGY_CLIQUE,
967 * Small-world network (2d torus plus random links). Followed
968 * by the number of random links to add (unsigned int).
970 GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD,
973 * Small-world network (ring plus random links). Followed
974 * by the number of random links to add (unsigned int).
976 GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING,
979 * Ring topology. No options.
981 GNUNET_TESTBED_TOPOLOGY_RING,
984 * Star topology. No options.
986 GNUNET_TESTBED_TOPOLOGY_STAR,
989 * 2-d torus. No options.
991 GNUNET_TESTBED_TOPOLOGY_2D_TORUS,
994 * Random graph. Followed by the number of random links to be established
997 GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI,
1000 * Certain percentage of peers are unable to communicate directly
1001 * replicating NAT conditions. Followed by the fraction of
1002 * NAT'ed peers (float).
1004 GNUNET_TESTBED_TOPOLOGY_INTERNAT,
1007 * Scale free topology. It is generated according to the method described in
1008 * "Emergence of Scaling in Random Networks." Science 286, 509-512, 1999.
1010 * This options takes two arguments in the following order: an uint16_t to
1011 * determine the maximum number of edges a peer is permitted to have while
1012 * generating scale free topology, a good value for this argument is 70; and
1013 * an uint8_t to determine the number of edges to be established when adding a
1014 * new node to the scale free network, a good value for this argument is 4.
1016 GNUNET_TESTBED_TOPOLOGY_SCALE_FREE,
1019 * Straight line topology. No options.
1021 GNUNET_TESTBED_TOPOLOGY_LINE,
1024 * Read a topology from a given file. Followed by the name of the file (const char *).
1026 GNUNET_TESTBED_TOPOLOGY_FROM_FILE,
1029 * All peers are disconnected. No options.
1031 GNUNET_TESTBED_TOPOLOGY_NONE,
1034 * The options should always end with this
1036 GNUNET_TESTBED_TOPOLOGY_OPTION_END,
1038 /* The following are not topologies but influence how the topology has to be
1039 setup. These options should follow the topology specific options (if
1040 required by the chosen topology). Note that these should be given before
1041 GNUNET_TESTBED_TOPOLOGY_OPTION_END */
1044 * How many times should the failed overlay connect operations be retried
1045 * before giving up. The default if this option is not specified is to retry
1046 * 3 times. This option takes and unsigned integer as a parameter. Use this
1047 * option with parameter 0 to disable retrying of failed overlay connect
1050 GNUNET_TESTBED_TOPOLOGY_RETRY_CNT
1055 * Configure overall network topology to have a particular shape.
1057 * @param op_cls closure argument to give with the operation event
1058 * @param num_peers number of peers in 'peers'
1059 * @param peers array of 'num_peers' with the peers to configure
1060 * @param topo desired underlay topology to use
1061 * @param ap topology-specific options
1062 * @return handle to the operation, NULL if configuring the topology
1063 * is not allowed at this time
1065 struct GNUNET_TESTBED_Operation *
1066 GNUNET_TESTBED_underlay_configure_topology_va (void *op_cls,
1067 unsigned int num_peers,
1068 struct GNUNET_TESTBED_Peer **peers,
1069 enum GNUNET_TESTBED_TopologyOption topo,
1074 * Configure overall network topology to have a particular shape.
1076 * @param op_cls closure argument to give with the operation event
1077 * @param num_peers number of peers in 'peers'
1078 * @param peers array of 'num_peers' with the peers to configure
1079 * @param topo desired underlay topology to use
1080 * @param ... topology-specific options
1081 * @return handle to the operation, NULL if configuring the topology
1082 * is not allowed at this time
1084 struct GNUNET_TESTBED_Operation *
1085 GNUNET_TESTBED_underlay_configure_topology (void *op_cls,
1086 unsigned int num_peers,
1087 struct GNUNET_TESTBED_Peer **peers,
1088 enum GNUNET_TESTBED_TopologyOption topo,
1093 * Both peers must have been started before calling this function.
1094 * This function then obtains a HELLO from @a p1, gives it to @a p2
1095 * and asks @a p2 to connect to @a p1.
1097 * @param op_cls closure argument to give with the operation event
1098 * @param cb the callback to call when this operation has finished
1099 * @param cb_cls the closure for @a cb
1100 * @param p1 first peer
1101 * @param p2 second peer
1102 * @return handle to the operation, NULL if connecting these two
1103 * peers is fundamentally not possible at this time (peers
1104 * not running or underlay disallows)
1106 struct GNUNET_TESTBED_Operation *
1107 GNUNET_TESTBED_overlay_connect (void *op_cls,
1108 GNUNET_TESTBED_OperationCompletionCallback cb,
1110 struct GNUNET_TESTBED_Peer *p1,
1111 struct GNUNET_TESTBED_Peer *p2);
1115 * Callbacks of this type are called when topology configuration is completed
1117 * @param cls the operation closure given to
1118 * GNUNET_TESTBED_overlay_configure_topology_va() and
1119 * GNUNET_TESTBED_overlay_configure() calls
1120 * @param nsuccess the number of successful overlay connects
1121 * @param nfailures the number of overlay connects which failed
1123 typedef void (*GNUNET_TESTBED_TopologyCompletionCallback) (void *cls,
1124 unsigned int nsuccess,
1125 unsigned int nfailures);
1129 * All peers must have been started before calling this function.
1130 * This function then connects the given peers in the P2P overlay
1131 * using the given topology.
1133 * @param op_cls closure argument to give with the peer connect operation events
1134 * generated through this function
1135 * @param num_peers number of peers in 'peers'
1136 * @param peers array of 'num_peers' with the peers to configure
1137 * @param max_connections the maximums number of overlay connections that will
1138 * be made to achieve the given topology
1139 * @param comp_cb the completion callback to call when the topology generation
1141 * @param comp_cb_cls closure for the @a comp_cb
1142 * @param topo desired underlay topology to use
1143 * @param va topology-specific options
1144 * @return handle to the operation, NULL if connecting these
1145 * peers is fundamentally not possible at this time (peers
1146 * not running or underlay disallows) or if num_peers is less than 2
1148 struct GNUNET_TESTBED_Operation *
1149 GNUNET_TESTBED_overlay_configure_topology_va (void *op_cls,
1150 unsigned int num_peers,
1151 struct GNUNET_TESTBED_Peer **peers,
1152 unsigned int *max_connections,
1153 GNUNET_TESTBED_TopologyCompletionCallback
1156 enum GNUNET_TESTBED_TopologyOption topo,
1161 * All peers must have been started before calling this function.
1162 * This function then connects the given peers in the P2P overlay
1163 * using the given topology.
1165 * @param op_cls closure argument to give with the peer connect operation events
1166 * generated through this function
1167 * @param num_peers number of peers in 'peers'
1168 * @param peers array of 'num_peers' with the peers to configure
1169 * @param max_connections the maximums number of overlay connections that will
1170 * be made to achieve the given topology
1171 * @param comp_cb the completion callback to call when the topology generation
1173 * @param comp_cb_cls closure for the above completion callback
1174 * @param topo desired underlay topology to use
1175 * @param ... topology-specific options
1176 * @return handle to the operation, NULL if connecting these
1177 * peers is fundamentally not possible at this time (peers
1178 * not running or underlay disallows) or if num_peers is less than 2
1180 struct GNUNET_TESTBED_Operation *
1181 GNUNET_TESTBED_overlay_configure_topology (void *op_cls,
1182 unsigned int num_peers,
1183 struct GNUNET_TESTBED_Peer **peers,
1184 unsigned int *max_connections,
1185 GNUNET_TESTBED_TopologyCompletionCallback
1188 enum GNUNET_TESTBED_TopologyOption topo,
1193 * Ask the testbed controller to write the current overlay topology to
1194 * a file. Naturally, the file will only contain a snapshot as the
1195 * topology may evolve all the time.
1196 * FIXME: needs continuation!?
1198 * @param controller overlay controller to inspect
1199 * @param filename name of the file the topology should
1203 GNUNET_TESTBED_overlay_write_topology_to_file (struct GNUNET_TESTBED_Controller *controller,
1204 const char *filename);
1208 * Adapter function called to establish a connection to
1211 * @param cls closure
1212 * @param cfg configuration of the peer to connect to; will be available until
1213 * GNUNET_TESTBED_operation_done() is called on the operation returned
1214 * from GNUNET_TESTBED_service_connect()
1215 * @return service handle to return in 'op_result', NULL on error
1218 (*GNUNET_TESTBED_ConnectAdapter)(void *cls,
1219 const struct GNUNET_CONFIGURATION_Handle *cfg);
1223 * Adapter function called to destroy a connection to
1226 * @param cls closure
1227 * @param op_result service handle returned from the connect adapter
1230 (*GNUNET_TESTBED_DisconnectAdapter)(void *cls,
1235 * Callback to be called when a service connect operation is completed
1237 * @param cls the callback closure from functions generating an operation
1238 * @param op the operation that has been finished
1239 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
1240 * @param emsg error message in case the operation has failed; will be NULL if
1241 * operation has executed successfully.
1244 (*GNUNET_TESTBED_ServiceConnectCompletionCallback) (void *cls,
1245 struct GNUNET_TESTBED_Operation *op,
1251 * Connect to a service offered by the given peer. Will ensure that
1252 * the request is queued to not overwhelm our ability to create and
1253 * maintain connections with other systems. The actual service
1254 * handle is then returned via the 'op_result' member in the event
1255 * callback. The @a ca callback is used to create the connection
1256 * when the time is right; the @a da callback will be used to
1257 * destroy the connection (upon #GNUNET_TESTBED_operation_done).
1258 * #GNUNET_TESTBED_operation_done can be used to abort this
1259 * operation until the event callback has been called.
1261 * @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
1262 * @param peer peer that runs the service
1263 * @param service_name name of the service to connect to
1264 * @param cb the callback to call when this operation is ready (that is,
1265 * right after the connect adapter returns)
1266 * @param cb_cls closure for @a cb
1267 * @param ca helper function to establish the connection
1268 * @param da helper function to close the connection
1269 * @param cada_cls closure for @a ca and @a da
1270 * @return handle for the operation
1272 struct GNUNET_TESTBED_Operation *
1273 GNUNET_TESTBED_service_connect (void *op_cls,
1274 struct GNUNET_TESTBED_Peer *peer,
1275 const char *service_name,
1276 GNUNET_TESTBED_ServiceConnectCompletionCallback cb,
1278 GNUNET_TESTBED_ConnectAdapter ca,
1279 GNUNET_TESTBED_DisconnectAdapter da,
1284 * This function is used to signal that the event information (struct
1285 * GNUNET_TESTBED_EventInformation) from an operation has been fully processed
1286 * i.e. if the event callback is ever called for this operation. If the event
1287 * callback for this operation has not yet been called, calling this function
1288 * cancels the operation, frees its resources and ensures the no event is
1289 * generated with respect to this operation. Note that however cancelling an
1290 * operation does NOT guarantee that the operation will be fully undone (or that
1291 * nothing ever happened).
1293 * This function MUST be called for every operation to fully remove the
1294 * operation from the operation queue. After calling this function, if
1295 * operation is completed and its event information is of type
1296 * GNUNET_TESTBED_ET_OPERATION_FINISHED, the 'op_result' becomes invalid (!).
1298 * If the operation is generated from GNUNET_TESTBED_service_connect() then
1299 * calling this function on such as operation calls the disconnect adapter if
1300 * the connect adapter was ever called.
1302 * @param operation operation to signal completion or cancellation
1305 GNUNET_TESTBED_operation_done (struct GNUNET_TESTBED_Operation *operation);
1309 * Callback function to process statistic values from all peers.
1311 * @param cls closure
1312 * @param peer the peer the statistic belong to
1313 * @param subsystem name of subsystem that created the statistic
1314 * @param name the name of the datum
1315 * @param value the current value
1316 * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
1317 * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
1320 (*GNUNET_TESTBED_StatisticsIterator) (void *cls,
1321 const struct GNUNET_TESTBED_Peer *peer,
1322 const char *subsystem,
1329 * Convenience method that iterates over all (running) peers
1330 * and retrieves all statistics from each peer.
1332 * @param num_peers number of peers to iterate over
1333 * @param peers array of peers to iterate over
1334 * @param subsystem limit to the specified subsystem, NULL for all subsystems
1335 * @param name name of the statistic value, NULL for all values
1336 * @param proc processing function for each statistic retrieved
1337 * @param cont continuation to call once call is completed. The completion of this
1338 * operation is *ONLY* signalled through this callback -- no
1339 * GNUNET_TESTBED_ET_OPERATION_FINISHED is generated
1340 * @param cls closure to pass to proc and cont
1341 * @return operation handle to cancel the operation
1343 struct GNUNET_TESTBED_Operation *
1344 GNUNET_TESTBED_get_statistics (unsigned int num_peers,
1345 struct GNUNET_TESTBED_Peer **peers,
1346 const char *subsystem, const char *name,
1347 GNUNET_TESTBED_StatisticsIterator proc,
1348 GNUNET_TESTBED_OperationCompletionCallback cont,
1353 * Return the index of the peer inside of the total peer array,
1354 * aka. the peer's "unique ID".
1356 * @param peer Peer handle.
1358 * @return The peer's unique ID.
1361 GNUNET_TESTBED_get_index (const struct GNUNET_TESTBED_Peer *peer);
1365 * Handle for testbed run helper funtions
1367 struct GNUNET_TESTBED_RunHandle;
1371 * Signature of a main function for a testcase.
1373 * @param cls closure
1374 * @param h the run handle
1375 * @param num_peers number of peers in 'peers'
1376 * @param peers handle to peers run in the testbed. NULL upon timeout (see
1377 * GNUNET_TESTBED_test_run()).
1378 * @param links_succeeded the number of overlay link connection attempts that
1380 * @param links_failed the number of overlay link connection attempts that
1382 * @see GNUNET_TESTBED_test_run()
1385 (*GNUNET_TESTBED_TestMaster)(void *cls,
1386 struct GNUNET_TESTBED_RunHandle *h,
1387 unsigned int num_peers,
1388 struct GNUNET_TESTBED_Peer **peers,
1389 unsigned int links_succeeded,
1390 unsigned int links_failed);
1394 * Convenience method for running a testbed with
1395 * a single call. Underlay and overlay topology
1396 * are configured using the "UNDERLAY" and "OVERLAY"
1397 * options in the "[testbed]" section of the configuration\
1398 * (with possible options given in "UNDERLAY_XXX" and/or
1401 * The test_master callback will be called once the testbed setup is finished or
1402 * upon a timeout. This timeout is given through the configuration file by
1403 * setting the option "SETUP_TIMEOUT" in "[TESTBED]" section.
1405 * The testbed is to be terminated using a call to
1406 * "GNUNET_SCHEDULER_shutdown".
1408 * @param host_filename name of the file with the 'hosts', NULL
1409 * to run everything on 'localhost'
1410 * @param cfg configuration to use (for testbed, controller and peers)
1411 * @param num_peers number of peers to start; FIXME: maybe put that ALSO into
1412 * cfg?; should be greater than 0
1413 * @param event_mask bit mask with set of events to call 'cc' for;
1414 * or-ed values of "1LL" shifted by the
1415 * respective 'enum GNUNET_TESTBED_EventType'
1416 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
1417 * @param cc controller callback to invoke on events; This callback is called
1418 * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
1419 * set in the event_mask as this is the only way get access to the
1420 * handle of each peer
1421 * @param cc_cls closure for cc
1422 * @param test_master this callback will be called once the test is ready or
1424 * @param test_master_cls closure for 'test_master'.
1427 GNUNET_TESTBED_run (const char *host_filename,
1428 const struct GNUNET_CONFIGURATION_Handle *cfg,
1429 unsigned int num_peers,
1430 uint64_t event_mask,
1431 GNUNET_TESTBED_ControllerCallback cc,
1433 GNUNET_TESTBED_TestMaster test_master,
1434 void *test_master_cls);
1438 * Convenience method for running a "simple" test on the local system
1439 * with a single call from 'main'. Underlay and overlay topology are
1440 * configured using the "UNDERLAY" and "OVERLAY" options in the
1441 * "[TESTBED]" section of the configuration (with possible options
1442 * given in "UNDERLAY_XXX" and/or "OVERLAY_XXX").
1444 * The test_master callback will be called once the testbed setup is finished or
1445 * upon a timeout. This timeout is given through the configuration file by
1446 * setting the option "SETUP_TIMEOUT" in "[TESTBED]" section.
1448 * The test is to be terminated using a call to
1449 * "GNUNET_SCHEDULER_shutdown". If starting the test fails,
1450 * the program is stopped without 'master' ever being run.
1452 * NOTE: this function should be called from 'main', NOT from
1453 * within a GNUNET_SCHEDULER-loop. This function will initialze
1454 * the scheduler loop, the testbed and then pass control to
1457 * @param testname name of the testcase (to configure logging, etc.)
1458 * @param cfg_filename configuration filename to use
1459 * (for testbed, controller and peers)
1460 * @param num_peers number of peers to start; should be greter than 0
1461 * @param event_mask bit mask with set of events to call 'cc' for;
1462 * or-ed values of "1LL" shifted by the
1463 * respective 'enum GNUNET_TESTBED_EventType'
1464 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
1465 * @param cc controller callback to invoke on events; This callback is called
1466 * for all peer start events even if #GNUNET_TESTBED_ET_PEER_START isn't
1467 * set in the event_mask as this is the only way get access to the
1468 * handle of each peer
1469 * @param cc_cls closure for @a cc
1470 * @param test_master this callback will be called once the test is ready or
1472 * @param test_master_cls closure for @a test_master.
1473 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
1476 GNUNET_TESTBED_test_run (const char *testname,
1477 const char *cfg_filename,
1478 unsigned int num_peers,
1479 uint64_t event_mask,
1480 GNUNET_TESTBED_ControllerCallback cc,
1482 GNUNET_TESTBED_TestMaster test_master,
1483 void *test_master_cls);
1487 * Obtain handle to the master controller from a testbed run. The handle
1488 * returned should not be disconnected.
1490 * @param h the testbed run handle
1491 * @return handle to the master controller
1493 struct GNUNET_TESTBED_Controller *
1494 GNUNET_TESTBED_run_get_controller_handle (struct GNUNET_TESTBED_RunHandle *h);
1497 * Opaque handle for barrier
1499 struct GNUNET_TESTBED_Barrier;
1503 * Status of a barrier
1505 enum GNUNET_TESTBED_BarrierStatus
1508 * Barrier initialised successfully
1510 GNUNET_TESTBED_BARRIERSTATUS_INITIALISED = 1,
1513 * Barrier is crossed
1515 GNUNET_TESTBED_BARRIERSTATUS_CROSSED,
1520 GNUNET_TESTBED_BARRIERSTATUS_ERROR,
1526 * Functions of this type are to be given as callback argument to
1527 * GNUNET_TESTBED_barrier_init(). The callback will be called when status
1528 * information is available for the barrier.
1530 * @param cls the closure given to GNUNET_TESTBED_barrier_init()
1531 * @param name the name of the barrier
1532 * @param barrier the barrier handle
1533 * @param status status of the barrier; #GNUNET_OK if the barrier is crossed;
1534 * #GNUNET_SYSERR upon error
1535 * @param emsg if the status were to be #GNUNET_SYSERR, this parameter has the
1539 (*GNUNET_TESTBED_barrier_status_cb) (void *cls,
1541 struct GNUNET_TESTBED_Barrier *barrier,
1542 enum GNUNET_TESTBED_BarrierStatus status,
1547 * Initialise a barrier and call the given callback when the required percentage
1548 * of peers (quorum) reach the barrier.
1550 * @param controller the handle to the controller
1551 * @param name identification name of the barrier
1552 * @param quorum the percentage of peers that is required to reach the barrier.
1553 * Peers signal reaching a barrier by calling
1554 * GNUNET_TESTBED_barrier_reached().
1555 * @param cb the callback to call when the barrier is reached or upon error.
1557 * @param cb_cls closure for @a cb
1558 * @return barrier handle
1560 struct GNUNET_TESTBED_Barrier *
1561 GNUNET_TESTBED_barrier_init (struct GNUNET_TESTBED_Controller *controller,
1563 unsigned int quorum,
1564 GNUNET_TESTBED_barrier_status_cb cb,
1571 * @param barrier the barrier handle
1574 GNUNET_TESTBED_barrier_cancel (struct GNUNET_TESTBED_Barrier *barrier);
1578 * Opaque handle for barrier wait
1580 struct GNUNET_TESTBED_BarrierWaitHandle;
1584 * Functions of this type are to be given as acallback argumetn to
1585 * GNUNET_TESTBED_barrier_wait(). The callback will be called when the barrier
1586 * corresponding given in GNUNET_TESTBED_barrier_wait() is crossed or cancelled.
1588 * @param cls closure pointer given to GNUNET_TESTBED_barrier_wait()
1589 * @param name the barrier name
1590 * @param status #GNUNET_SYSERR in case of error while waiting for the barrier;
1591 * #GNUNET_OK if the barrier is crossed
1594 (*GNUNET_TESTBED_barrier_wait_cb) (void *cls,
1600 * Wait for a barrier to be crossed. This function should be called by the
1601 * peers which have been started by the testbed. If the peer is not started by
1602 * testbed this function may return error
1604 * @param name the name of the barrier
1605 * @param cb the barrier wait callback
1606 * @param cls the closure for the above callback
1607 * @return barrier wait handle which can be used to cancel the waiting at
1608 * anytime before the callback is called. NULL upon error.
1610 struct GNUNET_TESTBED_BarrierWaitHandle *
1611 GNUNET_TESTBED_barrier_wait (const char *name,
1612 GNUNET_TESTBED_barrier_wait_cb cb,
1617 * Cancel a barrier wait handle. Should not be called in or after the callback
1618 * given to GNUNET_TESTBED_barrier_wait() has been called.
1620 * @param h the barrier wait handle
1623 GNUNET_TESTBED_barrier_wait_cancel (struct GNUNET_TESTBED_BarrierWaitHandle *h);
1627 * Model for configuring underlay links of a peer
1630 struct GNUNET_TESTBED_UnderlayLinkModel;
1634 * The type of GNUNET_TESTBED_UnderlayLinkModel
1637 enum GNUNET_TESTBED_UnderlayLinkModelType
1640 * The model is based on white listing of peers to which underlay connections
1641 * are permitted. Underlay connections to all other peers will not be
1644 GNUNET_TESTBED_UNDERLAYLINKMODELTYPE_BLACKLIST,
1647 * The model is based on black listing of peers to which underlay connections
1648 * are not permitted. Underlay connections to all other peers will be
1651 GNUNET_TESTBED_UNDERLAYLINKMODELTYPE_WHITELIST
1656 * Create a GNUNET_TESTBED_UnderlayLinkModel for the given peer. A peer can
1657 * have ONLY ONE model and it can be either a blacklist or whitelist based one.
1660 * @param peer the peer for which the model has to be created
1661 * @param type the type of the model
1664 struct GNUNET_TESTBED_UnderlayLinkModel *
1665 GNUNET_TESTBED_underlaylinkmodel_create (struct GNUNET_TESTBED_Peer *peer,
1666 enum GNUNET_TESTBED_UnderlayLinkModelType type);
1670 * Add a peer to the given model. Underlay connections to the given peer will
1671 * be permitted if the model is whitelist based; otherwise they will not be
1675 * @param model the model
1676 * @param peer the peer to add
1679 GNUNET_TESTBED_underlaylinkmodel_add_peer (struct GNUNET_TESTBED_UnderlayLinkModel *model,
1680 struct GNUNET_TESTBED_Peer *peer);
1684 * Set the metrics for a link to the given peer in the underlay model. The link
1685 * SHOULD be permittable according to the given model.
1688 * @param model the model
1689 * @param peer the other end peer of the link
1690 * @param latency latency of the link in microseconds
1691 * @param loss data loss of the link expressed as a percentage
1692 * @param bandwidth bandwidth of the link in kilobytes per second [kB/s]
1695 GNUNET_TESTBED_underlaylinkmodel_set_link (struct GNUNET_TESTBED_UnderlayLinkModel *model,
1696 struct GNUNET_TESTBED_Peer *peer,
1699 uint32_t bandwidth);
1703 * Commit the model. The model is freed in this function(!).
1706 * @param model the model to commit
1709 GNUNET_TESTBED_underlaylinkmodel_commit (struct GNUNET_TESTBED_UnderlayLinkModel *model);
1713 * Free the resources of the model. Use this function only if the model has not
1714 * be committed and has to be unallocated. The peer can then have another model
1718 * @param model the model to unallocate
1721 GNUNET_TESTBED_underlaylinkmodel_free (struct GNUNET_TESTBED_UnderlayLinkModel *model);
1724 #if 0 /* keep Emacsens' auto-indent happy */
1735 /** @} */ /* end of group */