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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file testbed/testbed_api_testbed.c
23 * @brief high-level testbed management
24 * @author Christian Grothoff
25 * @author Sree Harsha Totakura
29 #include "gnunet_util_lib.h"
30 #include "gnunet_testbed_service.h"
31 #include "testbed_api.h"
32 #include "testbed_api_peers.h"
33 #include "testbed_api_hosts.h"
34 #include "testbed_api_topology.h"
37 * Generic loggins shorthand
39 #define LOG(kind, ...) \
40 GNUNET_log_from (kind, "testbed-api-testbed", __VA_ARGS__)
43 * Debug logging shortcut
46 LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
49 * The default setup timeout in seconds
51 #define DEFAULT_SETUP_TIMEOUT 300
55 * Configuration section for testbed
57 #define TESTBED_CONFIG_SECTION "testbed"
60 * Option string for the maximum number of edges a peer is permitted to have
61 * while generating scale free topology
63 #define SCALE_FREE_CAP "SCALE_FREE_TOPOLOGY_CAP"
66 * Option string for the number of edges to be established when adding a new
67 * node to the scale free network
69 #define SCALE_FREE_M "SCALE_FREE_TOPOLOGY_M"
72 * Context information for the operation we start
74 struct RunContextOperation
77 * The testbed operation handle
79 struct GNUNET_TESTBED_Operation *op;
82 * Context information for GNUNET_TESTBED_run()
84 struct GNUNET_TESTBED_RunHandle *rc;
94 * States of RunContext
104 * Controllers on given hosts started and linked
114 * The testbed run is ready and the master callback can be called now. At this
115 * time the peers are all started and if a topology is provided in the
116 * configuration the topology would have been attempted
121 /* * Peers are stopped */
123 /* RC_PEERS_STOPPED, */
126 /* * Peers are destroyed */
128 /* RC_PEERS_DESTROYED */
131 * All peers shutdown (stopped and destroyed)
138 * Context for host compability checks
140 struct CompatibilityCheckContext
145 struct GNUNET_TESTBED_RunHandle *rc;
148 * Handle for the compability check
150 struct GNUNET_TESTBED_HostHabitableCheckHandle *h;
153 * Index of the host in the run context's hosts array
162 struct GNUNET_TESTBED_RunHandle
165 * The controller handle
167 struct GNUNET_TESTBED_Controller *c;
170 * The configuration of the controller. This is based on the cfg given to the
171 * function GNUNET_TESTBED_run(). We also use this config as a template while
174 struct GNUNET_CONFIGURATION_Handle *cfg;
177 * Handle to the host on which the controller runs
179 struct GNUNET_TESTBED_Host *h;
182 * The handle to the controller process
184 struct GNUNET_TESTBED_ControllerProc *cproc;
187 * The callback to use as controller callback
189 GNUNET_TESTBED_ControllerCallback cc;
192 * The pointer to the controller callback
197 * The trusted IP string
202 * TestMaster callback to call when testbed initialization is done
204 GNUNET_TESTBED_TestMaster test_master;
207 * The closure for the TestMaster callback
209 void *test_master_cls;
212 * A hashmap for operations started by us
214 struct GNUNET_CONTAINER_MultiHashMap32 *rcop_map;
217 * An array of hosts loaded from the hostkeys file
219 struct GNUNET_TESTBED_Host **hosts;
222 * Array of compatibility check contexts
224 struct CompatibilityCheckContext *hclist;
227 * Array of peers which we create
229 struct GNUNET_TESTBED_Peer **peers;
232 * The topology generation operation. Will be null if no topology is set in
235 struct GNUNET_TESTBED_Operation *topology_operation;
238 * The file containing topology data. Only used if the topology is set to 'FROM_FILE'
243 * Host registration handle
245 struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
248 * Profiling start time
250 struct GNUNET_TIME_Absolute pstart_time;
253 * Host registration task
255 struct GNUNET_SCHEDULER_Task *register_hosts_task;
258 * Task to be run of a timeout
260 struct GNUNET_SCHEDULER_Task *timeout_task;
263 * Task run upon shutdown interrupts
265 struct GNUNET_SCHEDULER_Task *interrupt_task;
268 * The event mask for the controller
273 * State of this context
278 * The topology which has to be achieved with the peers started in this context
280 enum GNUNET_TESTBED_TopologyOption topology;
283 * Have we already shutdown
288 * Number of hosts in the given host file
290 unsigned int num_hosts;
293 * Number of registered hosts. Also used as a counter while checking
294 * habitabillity of hosts
296 unsigned int reg_hosts;
299 * Current peer count for an operation; Set this to 0 and increment for each
300 * successful operation on a peer
302 unsigned int peer_count;
305 * number of peers to start
307 unsigned int num_peers;
310 * Expected overlay connects. Should be zero if no topology is relavant
315 * Number of random links to established
317 unsigned int random_links;
320 * the number of overlay link connection attempts that succeeded
322 unsigned int links_succeeded;
325 * the number of overlay link connection attempts that failed
327 unsigned int links_failed;
332 * Return a 32-bit key from a pointer
334 * @param rcop the pointer
338 rcop_key (void *rcop)
340 return *((uint32_t *) &rcop);
345 * Context information used for finding a pointer in the rcop_map
350 * The operation pointer to look for
352 struct GNUNET_TESTBED_Operation *query;
355 * The Run context operation which has the operation being queried
357 struct RunContextOperation *result;
362 * Iterator for searching over the elements matching a given query
364 * @param cls the SearchContext
365 * @param key the 32-bit key
366 * @param value the RunContextOperation element
367 * @return GNUNET_YES to continue iteration; GNUNET_NO to cancel it
370 search_iterator (void *cls, uint32_t key, void *value)
372 struct RunContextOperation *rcop = value;
373 struct SearchContext *sc = cls;
375 GNUNET_assert (NULL != rcop);
376 if (sc->query == rcop->op)
378 GNUNET_assert (NULL == sc->result);
387 * Initiate a search for the given operation in the rcop_map
389 * @param rc the RunContext whose rcop_map will be searched for the given
391 * @param op the given operation to search for
392 * @return the matching RunContextOperation if found; NULL if not
394 static struct RunContextOperation *
395 search_rcop (struct GNUNET_TESTBED_RunHandle *rc, struct
396 GNUNET_TESTBED_Operation *op)
398 struct SearchContext sc;
403 GNUNET_CONTAINER_multihashmap32_get_multiple (rc->rcop_map,
408 GNUNET_assert (NULL != sc.result);
416 * Insert an RunContextOperation into the rcop_map of the given RunContext
418 * @param rc the RunContext into whose map is to be used for insertion
419 * @param rcop the RunContextOperation to insert
422 insert_rcop (struct GNUNET_TESTBED_RunHandle *rc, struct
423 RunContextOperation *rcop)
425 GNUNET_assert (GNUNET_OK ==
426 GNUNET_CONTAINER_multihashmap32_put (rc->rcop_map,
427 rcop_key (rcop->op), rcop,
428 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
433 * Remove a RunContextOperation from the rcop_map of the given RunContext
435 * @param rc the RunContext from whose map the given RunContextOperaton has to
437 * @param rcop the RunContextOperation
440 remove_rcop (struct GNUNET_TESTBED_RunHandle *rc, struct
441 RunContextOperation *rcop)
443 GNUNET_assert (GNUNET_YES ==
444 GNUNET_CONTAINER_multihashmap32_remove (rc->rcop_map,
451 * Assuming all peers have been destroyed cleanup run handle
453 * @param rc the run context
456 cleanup (struct GNUNET_TESTBED_RunHandle *rc)
460 GNUNET_assert (NULL == rc->register_hosts_task);
461 GNUNET_assert (NULL == rc->reg_handle);
462 GNUNET_assert (NULL == rc->peers);
463 GNUNET_assert (NULL == rc->hclist);
464 GNUNET_assert (RC_PEERS_SHUTDOWN == rc->state);
465 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap32_size (rc->rcop_map));
466 GNUNET_CONTAINER_multihashmap32_destroy (rc->rcop_map);
468 GNUNET_TESTBED_controller_disconnect (rc->c);
469 if (NULL != rc->cproc)
470 GNUNET_TESTBED_controller_stop (rc->cproc);
472 GNUNET_TESTBED_host_destroy (rc->h);
473 for (hid = 0; hid < rc->num_hosts; hid++)
474 GNUNET_TESTBED_host_destroy (rc->hosts[hid]);
475 GNUNET_free_non_null (rc->hosts);
477 GNUNET_CONFIGURATION_destroy (rc->cfg);
478 GNUNET_free_non_null (rc->topo_file);
479 GNUNET_free_non_null (rc->trusted_ip);
485 * Iterator for cleaning up elements from rcop_map
487 * @param cls the RunContext
488 * @param key the 32-bit key
489 * @param value the RunContextOperation element
490 * @return always GNUNET_YES
493 rcop_cleanup_iterator (void *cls, uint32_t key, void *value)
495 struct GNUNET_TESTBED_RunHandle *rc = cls;
496 struct RunContextOperation *rcop = value;
498 GNUNET_assert (rc == rcop->rc);
499 remove_rcop (rc, rcop);
500 GNUNET_TESTBED_operation_done (rcop->op);
507 * Cancels operations and tasks which are assigned to the given run context
509 * @param rc the RunContext
512 rc_cleanup_operations (struct GNUNET_TESTBED_RunHandle *rc)
514 struct CompatibilityCheckContext *hc;
517 if (NULL != rc->hclist)
519 for (nhost = 0; nhost < rc->num_hosts; nhost++)
521 hc = &rc->hclist[nhost];
523 GNUNET_TESTBED_is_host_habitable_cancel (hc->h);
525 GNUNET_free (rc->hclist);
528 /* Stop register hosts task if it is running */
529 if (NULL != rc->register_hosts_task)
531 GNUNET_SCHEDULER_cancel (rc->register_hosts_task);
532 rc->register_hosts_task = NULL;
534 if (NULL != rc->timeout_task)
536 GNUNET_SCHEDULER_cancel (rc->timeout_task);
537 rc->timeout_task = NULL;
539 if (NULL != rc->reg_handle)
541 GNUNET_TESTBED_cancel_registration (rc->reg_handle);
542 rc->reg_handle = NULL;
544 if (NULL != rc->topology_operation)
546 GNUNET_TESTBED_operation_done (rc->topology_operation);
547 rc->topology_operation = NULL;
549 /* cancel any exiting operations */
550 GNUNET_assert (GNUNET_SYSERR !=
551 GNUNET_CONTAINER_multihashmap32_iterate (rc->rcop_map,
552 &rcop_cleanup_iterator,
558 * Cancels the scheduled interrupt task
560 * @param rc the run context
563 cancel_interrupt_task (struct GNUNET_TESTBED_RunHandle *rc)
565 GNUNET_SCHEDULER_cancel (rc->interrupt_task);
566 rc->interrupt_task = NULL;
571 * This callback will be called when all the operations are completed
574 * @param cls run context
577 wait_op_completion (void *cls)
579 struct GNUNET_TESTBED_RunHandle *rc = cls;
580 struct RunContextOperation *rcop;
582 if ((NULL == rc->cproc)
584 || (GNUNET_YES == rc->shutdown))
586 if (NULL != rc->peers)
588 GNUNET_free (rc->peers);
593 if (NULL == rc->peers)
595 rc->shutdown = GNUNET_YES;
596 rcop = GNUNET_new (struct RunContextOperation);
598 rcop->op = GNUNET_TESTBED_shutdown_peers (rc->c, rcop, NULL, NULL);
599 GNUNET_assert (NULL != rcop->op);
600 DEBUG ("Shutting down peers\n");
601 rc->pstart_time = GNUNET_TIME_absolute_get ();
602 insert_rcop (rc, rcop);
606 rc->state = RC_PEERS_SHUTDOWN;
607 cancel_interrupt_task (rc);
613 * Task run upon interrupts (SIGINT, SIGTERM) and upon scheduler shutdown.
615 * @param cls the RunContext which has to be acted upon
618 interrupt (void *cls)
620 struct GNUNET_TESTBED_RunHandle *rc = cls;
621 struct GNUNET_TESTBED_Controller *c = rc->c;
625 rc->interrupt_task = GNUNET_SCHEDULER_add_shutdown (&interrupt, rc);
626 rc_cleanup_operations (rc);
627 if ((GNUNET_NO == rc->shutdown) &&
629 (NULL != c->opc_map) &&
630 (0 != (size = GNUNET_CONTAINER_multihashmap32_size (c->opc_map))))
632 LOG (GNUNET_ERROR_TYPE_WARNING,
633 "Shutdown postponed as there are %u operations currently active\n",
635 c->opcq_empty_cb = &wait_op_completion;
636 c->opcq_empty_cls = rc;
639 wait_op_completion (rc);
644 * Function to return the string representation of the duration between current
645 * time and `pstart_time' in `RunContext'
647 * @param rc the RunContext
648 * @return the representation string; this is NOT reentrant
651 prof_time (struct GNUNET_TESTBED_RunHandle *rc)
653 struct GNUNET_TIME_Relative ptime;
655 ptime = GNUNET_TIME_absolute_get_duration (rc->pstart_time);
656 return GNUNET_STRINGS_relative_time_to_string (ptime, GNUNET_YES);
661 * Task for starting peers
663 * @param cls the RunHandle
666 start_peers_task (void *cls)
668 struct GNUNET_TESTBED_RunHandle *rc = cls;
669 struct RunContextOperation *rcop;
672 DEBUG ("Starting Peers\n");
673 rc->pstart_time = GNUNET_TIME_absolute_get ();
674 for (peer = 0; peer < rc->num_peers; peer++)
676 rcop = GNUNET_new (struct RunContextOperation);
678 rcop->op = GNUNET_TESTBED_peer_start (NULL, rc->peers[peer], NULL, NULL);
679 GNUNET_assert (NULL != rcop->op);
680 rcop->cls = rc->peers[peer];
681 insert_rcop (rc, rcop);
688 * Functions of this signature are called when a peer has been successfully
691 * @param cls the closure from GNUNET_TESTBED_peer_create()
692 * @param peer the handle for the created peer; NULL on any error during
694 * @param emsg NULL if peer is not NULL; else MAY contain the error description
697 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
699 struct RunContextOperation *rcop = cls;
700 struct GNUNET_TESTBED_RunHandle *rc;
702 GNUNET_assert (NULL != rcop);
703 GNUNET_assert (NULL != (rc = rcop->rc));
704 remove_rcop (rc, rcop);
705 GNUNET_TESTBED_operation_done (rcop->op);
710 LOG (GNUNET_ERROR_TYPE_ERROR, "Error while creating a peer: %s\n",
712 GNUNET_SCHEDULER_shutdown ();
715 rc->peers[rc->peer_count] = peer;
717 if (rc->peer_count < rc->num_peers)
719 DEBUG ("%u peers created in %s\n", rc->num_peers, prof_time (rc));
720 rc->state = RC_PEERS_CREATED;
721 GNUNET_SCHEDULER_add_now (&start_peers_task, rc);
726 * call test master callback
728 * @param rc the RunContext
731 call_master (struct GNUNET_TESTBED_RunHandle *rc)
733 GNUNET_SCHEDULER_cancel (rc->timeout_task);
734 rc->timeout_task = NULL;
735 if (NULL != rc->test_master)
736 rc->test_master (rc->test_master_cls, rc, rc->num_peers, rc->peers,
737 rc->links_succeeded, rc->links_failed);
742 * Callbacks of this type are called when topology configuration is completed
744 * @param cls the operation closure given to
745 * GNUNET_TESTBED_overlay_configure_topology_va() and
746 * GNUNET_TESTBED_overlay_configure() calls
747 * @param nsuccess the number of successful overlay connects
748 * @param nfailures the number of overlay connects which failed
751 topology_completion_callback (void *cls, unsigned int nsuccess,
752 unsigned int nfailures)
754 struct GNUNET_TESTBED_RunHandle *rc = cls;
756 DEBUG ("Overlay topology generated in %s\n", prof_time (rc));
757 GNUNET_TESTBED_operation_done (rc->topology_operation);
758 rc->topology_operation = NULL;
759 rc->links_succeeded = nsuccess;
760 rc->links_failed = nfailures;
761 rc->state = RC_READY;
767 * Function to create peers
769 * @param rc the RunContext
772 create_peers (struct GNUNET_TESTBED_RunHandle *rc)
774 struct RunContextOperation *rcop;
777 DEBUG ("Creating peers\n");
778 rc->pstart_time = GNUNET_TIME_absolute_get ();
780 GNUNET_malloc (sizeof(struct GNUNET_TESTBED_Peer *) * rc->num_peers);
781 GNUNET_assert (NULL != rc->c);
783 for (peer = 0; peer < rc->num_peers; peer++)
785 rcop = GNUNET_new (struct RunContextOperation);
788 GNUNET_TESTBED_peer_create (rc->c,
790 rc->num_hosts) ? rc->h : rc->hosts[peer
793 rc->cfg, &peer_create_cb, rcop);
794 GNUNET_assert (NULL != rcop->op);
795 insert_rcop (rc, rcop);
801 * Signature of the event handler function called by the
802 * respective event controller.
805 * @param event information about the event
808 event_cb (void *cls, const struct GNUNET_TESTBED_EventInformation *event)
810 struct GNUNET_TESTBED_RunHandle *rc = cls;
811 struct RunContextOperation *rcop;
813 if (RC_INIT == rc->state)
817 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
818 rcop = event->op_cls;
819 if (NULL != event->details.operation_finished.emsg)
821 LOG (GNUNET_ERROR_TYPE_ERROR, _ (
822 "Linking controllers failed. Exiting"));
823 GNUNET_SCHEDULER_shutdown ();
827 GNUNET_assert (event->op == rcop->op);
828 remove_rcop (rc, rcop);
829 GNUNET_TESTBED_operation_done (rcop->op);
831 if (rc->reg_hosts == rc->num_hosts)
833 rc->state = RC_LINKED;
840 GNUNET_SCHEDULER_shutdown ();
844 if (GNUNET_TESTBED_ET_OPERATION_FINISHED != event->type)
846 if (NULL == (rcop = search_rcop (rc, event->op)))
848 remove_rcop (rc, rcop);
849 GNUNET_TESTBED_operation_done (rcop->op);
851 if ((GNUNET_NO == rc->shutdown)
852 && (NULL != event->details.operation_finished.emsg))
854 LOG (GNUNET_ERROR_TYPE_ERROR, "A operation has failed with error: %s\n",
855 event->details.operation_finished.emsg);
856 GNUNET_SCHEDULER_shutdown ();
859 GNUNET_assert (GNUNET_YES == rc->shutdown);
863 case RC_PEERS_CREATED:
865 rc->state = RC_PEERS_SHUTDOWN;
866 GNUNET_free_non_null (rc->peers);
868 DEBUG ("Peers shut down in %s\n", prof_time (rc));
869 GNUNET_SCHEDULER_shutdown ();
878 if ((0 != (rc->event_mask & (1LL << event->type))) && (NULL != rc->cc))
879 rc->cc (rc->cc_cls, event);
880 if (GNUNET_TESTBED_ET_PEER_START != event->type)
882 if (NULL == (rcop = search_rcop (rc, event->op))) /* Not our operation */
884 remove_rcop (rc, rcop);
885 GNUNET_TESTBED_operation_done (rcop->op);
888 if (rc->peer_count < rc->num_peers)
890 DEBUG ("%u peers started in %s\n", rc->num_peers, prof_time (rc));
891 if (GNUNET_TESTBED_TOPOLOGY_NONE != rc->topology)
893 switch (rc->topology)
895 case GNUNET_TESTBED_TOPOLOGY_NONE:
898 case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
899 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
900 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
901 rc->topology_operation =
902 GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
903 rc->peers, &rc->num_oc,
904 &topology_completion_callback,
908 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
911 case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
912 GNUNET_assert (NULL != rc->topo_file);
913 rc->topology_operation =
914 GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
915 rc->peers, &rc->num_oc,
916 &topology_completion_callback,
920 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
923 case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
925 unsigned long long number;
927 GNUNET_assert (GNUNET_OK ==
928 GNUNET_CONFIGURATION_get_value_number (rc->cfg,
929 TESTBED_CONFIG_SECTION,
932 cap = (unsigned int) number;
933 GNUNET_assert (GNUNET_OK ==
934 GNUNET_CONFIGURATION_get_value_number (rc->cfg,
935 TESTBED_CONFIG_SECTION,
938 rc->topology_operation =
939 GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
940 rc->peers, &rc->num_oc,
942 topology_completion_callback,
946 (unsigned int) number, /* uint8_t */
947 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
952 rc->topology_operation =
953 GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
954 rc->peers, &rc->num_oc,
955 &topology_completion_callback,
958 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
960 if (NULL == rc->topology_operation)
961 LOG (GNUNET_ERROR_TYPE_WARNING,
962 "Not generating a topology. Check number of peers\n");
965 DEBUG ("Creating overlay topology\n");
966 rc->pstart_time = GNUNET_TIME_absolute_get ();
970 rc->state = RC_READY;
976 * Task to register all hosts available in the global host list
978 * @param cls the RunContext
981 register_hosts (void *cls);
985 * Callback which will be called to after a host registration succeeded or failed
987 * @param cls the closure
988 * @param emsg the error message; NULL if host registration is successful
991 host_registration_completion (void *cls, const char *emsg)
993 struct GNUNET_TESTBED_RunHandle *rc = cls;
995 rc->reg_handle = NULL;
998 LOG (GNUNET_ERROR_TYPE_WARNING,
999 _ ("Host registration failed for a host. Error: %s\n"), emsg);
1000 GNUNET_SCHEDULER_shutdown ();
1003 rc->register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts,
1009 * Task to register all hosts available in the global host list
1011 * @param cls RunContext
1014 register_hosts (void *cls)
1016 struct GNUNET_TESTBED_RunHandle *rc = cls;
1017 struct RunContextOperation *rcop;
1020 rc->register_hosts_task = NULL;
1021 if (rc->reg_hosts == rc->num_hosts)
1023 DEBUG ("All hosts successfully registered\n");
1025 for (slave = 0; slave < rc->num_hosts; slave++)
1027 rcop = GNUNET_new (struct RunContextOperation);
1030 GNUNET_TESTBED_controller_link (rcop, rc->c, rc->hosts[slave],
1032 GNUNET_assert (NULL != rcop->op);
1033 insert_rcop (rc, rcop);
1039 GNUNET_TESTBED_register_host (rc->c, rc->hosts[rc->reg_hosts],
1040 host_registration_completion, rc);
1046 * Callback to signal successfull startup of the controller process
1048 * @param cls the closure from GNUNET_TESTBED_controller_start()
1049 * @param cfg the configuration with which the controller has been started;
1050 * NULL if status is not GNUNET_OK
1051 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
1052 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
1055 controller_status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg,
1058 struct GNUNET_TESTBED_RunHandle *rc = cls;
1059 uint64_t event_mask;
1061 if (status != GNUNET_OK)
1064 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1065 _ ("Controller crash detected. Shutting down.\n"));
1066 GNUNET_SCHEDULER_shutdown ();
1069 GNUNET_CONFIGURATION_destroy (rc->cfg);
1070 rc->cfg = GNUNET_CONFIGURATION_dup (cfg);
1071 event_mask = rc->event_mask;
1072 event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
1073 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
1074 if (rc->topology < GNUNET_TESTBED_TOPOLOGY_NONE)
1075 event_mask |= GNUNET_TESTBED_ET_CONNECT;
1077 GNUNET_TESTBED_controller_connect (rc->h, event_mask, &event_cb, rc);
1078 if (0 < rc->num_hosts)
1081 rc->register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts, rc);
1084 rc->state = RC_LINKED;
1090 * Callback function invoked for each interface found.
1092 * @param cls closure
1093 * @param name name of the interface (can be NULL for unknown)
1094 * @param isDefault is this presumably the default interface
1095 * @param addr address of this interface (can be NULL for unknown or unassigned)
1096 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
1097 * @param netmask the network mask (can be NULL for unknown or unassigned))
1098 * @param addrlen length of the address
1099 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
1102 netint_proc (void *cls, const char *name, int isDefault,
1103 const struct sockaddr *addr, const struct sockaddr *broadcast_addr,
1104 const struct sockaddr *netmask, socklen_t addrlen)
1106 struct GNUNET_TESTBED_RunHandle *rc = cls;
1107 char hostip[NI_MAXHOST];
1110 if (sizeof(struct sockaddr_in) != addrlen)
1111 return GNUNET_OK; /* Only consider IPv4 for now */
1113 getnameinfo (addr, addrlen, hostip, NI_MAXHOST, NULL, 0, NI_NUMERICHOST))
1114 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "getnameinfo");
1115 if (NULL == rc->trusted_ip)
1117 rc->trusted_ip = GNUNET_strdup (hostip);
1120 (void) GNUNET_asprintf (&buf, "%s; %s", rc->trusted_ip, hostip);
1121 GNUNET_free (rc->trusted_ip);
1122 rc->trusted_ip = buf;
1128 * Callbacks of this type are called by GNUNET_TESTBED_is_host_habitable to
1129 * inform whether the given host is habitable or not. The Handle returned by
1130 * GNUNET_TESTBED_is_host_habitable() is invalid after this callback is called
1133 * @param host the host whose status is being reported; will be NULL if the host
1134 * given to GNUNET_TESTBED_is_host_habitable() is NULL
1135 * @param status GNUNET_YES if it is habitable; GNUNET_NO if not
1138 host_habitable_cb (void *cls, const struct GNUNET_TESTBED_Host *host,
1141 struct CompatibilityCheckContext *hc = cls;
1142 struct GNUNET_TESTBED_RunHandle *rc;
1143 struct GNUNET_TESTBED_Host **old_hosts;
1146 GNUNET_assert (NULL != (rc = hc->rc));
1148 GNUNET_assert (nhost <= rc->num_hosts);
1149 GNUNET_assert (host == rc->hosts[nhost]);
1151 if (GNUNET_NO == status)
1153 if ((NULL != host) && (NULL != GNUNET_TESTBED_host_get_hostname (host)))
1154 LOG (GNUNET_ERROR_TYPE_ERROR, _ ("Host %s cannot start testbed\n"),
1155 GNUNET_TESTBED_host_get_hostname (host));
1157 LOG (GNUNET_ERROR_TYPE_ERROR,
1158 _ ("Testbed cannot be started on localhost\n"));
1159 GNUNET_SCHEDULER_shutdown ();
1163 if (rc->reg_hosts < rc->num_hosts)
1165 GNUNET_free (rc->hclist);
1167 rc->h = rc->hosts[0];
1169 if (0 < rc->num_hosts)
1171 old_hosts = rc->hosts;
1173 GNUNET_malloc (sizeof(struct GNUNET_TESTBED_Host *) * rc->num_hosts);
1174 GNUNET_memcpy (rc->hosts, &old_hosts[1],
1175 (sizeof(struct GNUNET_TESTBED_Host *) * rc->num_hosts));
1176 GNUNET_free (old_hosts);
1180 GNUNET_free (rc->hosts);
1183 GNUNET_TESTBED_host_resolve_ (rc->h);
1184 for (nhost = 0; nhost < rc->num_hosts; nhost++)
1185 GNUNET_TESTBED_host_resolve_ (rc->hosts[nhost]);
1186 GNUNET_OS_network_interfaces_list (netint_proc, rc);
1187 if (NULL == rc->trusted_ip)
1188 rc->trusted_ip = GNUNET_strdup ("127.0.0.1");
1190 GNUNET_TESTBED_controller_start (rc->trusted_ip, rc->h,
1191 &controller_status_cb, rc);
1192 GNUNET_free (rc->trusted_ip);
1193 rc->trusted_ip = NULL;
1194 if (NULL == rc->cproc)
1196 LOG (GNUNET_ERROR_TYPE_ERROR, _ ("Cannot start the master controller"));
1197 GNUNET_SCHEDULER_shutdown ();
1203 * Task run upon timeout while setting up the testbed
1205 * @param cls the RunContext
1208 timeout_task (void *cls)
1210 struct GNUNET_TESTBED_RunHandle *rc = cls;
1212 rc->timeout_task = NULL;
1213 LOG (GNUNET_ERROR_TYPE_ERROR,
1214 _ ("Shutting down testbed due to timeout while setup.\n"));
1215 GNUNET_SCHEDULER_shutdown ();
1216 if (NULL != rc->test_master)
1217 rc->test_master (rc->test_master_cls, rc, 0, NULL, 0, 0);
1218 rc->test_master = NULL;
1223 * Convenience method for running a testbed with
1224 * a single call. Underlay and overlay topology
1225 * are configured using the "UNDERLAY" and "OVERLAY"
1226 * options in the "[testbed]" section of the configuration\
1227 * (with possible options given in "UNDERLAY_XXX" and/or
1230 * The testbed is to be terminated using a call to
1231 * "GNUNET_SCHEDULER_shutdown".
1233 * @param host_filename name of the file with the 'hosts', NULL
1234 * to run everything on 'localhost'
1235 * @param cfg configuration to use (for testbed, controller and peers)
1236 * @param num_peers number of peers to start; FIXME: maybe put that ALSO into cfg?
1237 * @param event_mask bit mask with set of events to call 'cc' for;
1238 * or-ed values of "1LL" shifted by the
1239 * respective 'enum GNUNET_TESTBED_EventType'
1240 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
1241 * @param cc controller callback to invoke on events; This callback is called
1242 * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
1243 * set in the event_mask as this is the only way get access to the
1244 * handle of each peer
1245 * @param cc_cls closure for cc
1246 * @param test_master this callback will be called once the test is ready
1247 * @param test_master_cls closure for 'test_master'.
1250 GNUNET_TESTBED_run (const char *host_filename,
1251 const struct GNUNET_CONFIGURATION_Handle *cfg,
1252 unsigned int num_peers, uint64_t event_mask,
1253 GNUNET_TESTBED_ControllerCallback cc, void *cc_cls,
1254 GNUNET_TESTBED_TestMaster test_master,
1255 void *test_master_cls)
1257 struct GNUNET_TESTBED_RunHandle *rc;
1259 struct CompatibilityCheckContext *hc;
1260 struct GNUNET_TIME_Relative timeout;
1261 unsigned long long number;
1265 GNUNET_assert (num_peers > 0);
1266 rc = GNUNET_new (struct GNUNET_TESTBED_RunHandle);
1267 rc->cfg = GNUNET_CONFIGURATION_dup (cfg);
1269 rc->num_hosts = GNUNET_TESTBED_hosts_load_from_loadleveler (rc->cfg,
1271 if (0 == rc->num_hosts)
1273 LOG (GNUNET_ERROR_TYPE_WARNING,
1274 _ ("No hosts loaded from LoadLeveler. Need at least one host\n"));
1278 if (NULL != host_filename)
1281 GNUNET_TESTBED_hosts_load_from_file (host_filename, rc->cfg,
1283 if (0 == rc->num_hosts)
1285 LOG (GNUNET_ERROR_TYPE_WARNING,
1286 _ ("No hosts loaded. Need at least one host\n"));
1291 rc->h = GNUNET_TESTBED_host_create (NULL, NULL, rc->cfg, 0);
1293 rc->num_peers = num_peers;
1294 rc->event_mask = event_mask;
1296 rc->cc_cls = cc_cls;
1297 rc->test_master = test_master;
1298 rc->test_master_cls = test_master_cls;
1299 rc->state = RC_INIT;
1300 rc->topology = GNUNET_TESTBED_TOPOLOGY_NONE;
1302 GNUNET_CONFIGURATION_get_value_string (rc->cfg, TESTBED_CONFIG_SECTION,
1303 "OVERLAY_TOPOLOGY", &topology))
1305 if (GNUNET_NO == GNUNET_TESTBED_topology_get_ (&rc->topology, topology))
1307 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
1308 TESTBED_CONFIG_SECTION,
1312 "Specified topology must be supported by testbed"));
1314 GNUNET_free (topology);
1316 switch (rc->topology)
1318 case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
1319 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
1320 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
1322 GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
1323 "OVERLAY_RANDOM_LINKS",
1326 /* OVERLAY option RANDOM & SMALL_WORLD_RING requires OVERLAY_RANDOM_LINKS
1327 * option to be set to the number of random links to be established */
1328 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
1329 TESTBED_CONFIG_SECTION,
1330 "OVERLAY_RANDOM_LINKS");
1333 if (number > UINT32_MAX)
1335 GNUNET_break (0); /* Too big number */
1338 rc->random_links = (unsigned int) number;
1341 case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
1343 GNUNET_CONFIGURATION_get_value_filename (rc->cfg,
1344 TESTBED_CONFIG_SECTION,
1345 "OVERLAY_TOPOLOGY_FILE",
1348 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
1349 TESTBED_CONFIG_SECTION,
1350 "OVERLAY_TOPOLOGY_FILE");
1355 case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
1357 GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
1358 SCALE_FREE_CAP, &number))
1360 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
1361 TESTBED_CONFIG_SECTION,
1365 if (UINT16_MAX < number)
1367 LOG (GNUNET_ERROR_TYPE_ERROR,
1368 _ ("Maximum number of edges a peer can have in a scale free topology"
1369 " cannot be more than %u. Given `%s = %llu'"), UINT16_MAX,
1370 SCALE_FREE_CAP, number);
1374 GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
1375 SCALE_FREE_M, &number))
1377 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
1378 TESTBED_CONFIG_SECTION,
1382 if (UINT8_MAX < number)
1384 LOG (GNUNET_ERROR_TYPE_ERROR,
1385 _ ("The number of edges that can established when adding a new node"
1386 " to scale free topology cannot be more than %u. Given `%s = %llu'"),
1387 UINT8_MAX, SCALE_FREE_M, number);
1392 case GNUNET_TESTBED_TOPOLOGY_OPTION_END:
1398 /* Warn if OVERLAY_RANDOM_LINKS is present that it will be ignored */
1400 GNUNET_CONFIGURATION_have_value (rc->cfg, TESTBED_CONFIG_SECTION,
1401 "OVERLAY_RANDOM_LINKS"))
1402 LOG (GNUNET_ERROR_TYPE_WARNING,
1403 "Ignoring value of `OVERLAY_RANDOM_LINKS' in given configuration\n");
1406 if (0 != rc->num_hosts)
1408 rc->hclist = GNUNET_malloc (sizeof(struct CompatibilityCheckContext)
1410 for (nhost = 0; nhost < rc->num_hosts; nhost++)
1412 hc = &rc->hclist[nhost];
1415 hc->h = GNUNET_TESTBED_is_host_habitable (rc->hosts[nhost], rc->cfg,
1416 &host_habitable_cb, hc);
1420 for (nhost = 0; nhost < rc->num_hosts; nhost++)
1422 hc = &rc->hclist[nhost];
1424 GNUNET_TESTBED_is_host_habitable_cancel (hc->h);
1426 GNUNET_free (rc->hclist);
1434 GNUNET_TESTBED_controller_start ("127.0.0.1", rc->h,
1435 &controller_status_cb, rc);
1436 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg,
1437 TESTBED_CONFIG_SECTION,
1441 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
1442 DEFAULT_SETUP_TIMEOUT);
1444 rc->rcop_map = GNUNET_CONTAINER_multihashmap32_create (256);
1446 GNUNET_SCHEDULER_add_delayed (timeout, &timeout_task, rc);
1447 GNUNET_assert (NULL == rc->interrupt_task);
1448 rc->interrupt_task =
1449 GNUNET_SCHEDULER_add_shutdown (&interrupt,
1455 GNUNET_TESTBED_host_destroy (rc->h);
1456 if (NULL != rc->hosts)
1458 for (hid = 0; hid < rc->num_hosts; hid++)
1459 if (NULL != rc->hosts[hid])
1460 GNUNET_TESTBED_host_destroy (rc->hosts[hid]);
1461 GNUNET_free (rc->hosts);
1463 if (NULL != rc->cfg)
1464 GNUNET_CONFIGURATION_destroy (rc->cfg);
1470 * Obtain handle to the master controller from a testbed run. The handle
1471 * returned should not be disconnected.
1473 * @param h the testbed run handle
1474 * @return handle to the master controller
1476 struct GNUNET_TESTBED_Controller *
1477 GNUNET_TESTBED_run_get_controller_handle (struct GNUNET_TESTBED_RunHandle *h)
1483 /* end of testbed_api_testbed.c */