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 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;
95 * States of RunContext
105 * Controllers on given hosts started and linked
115 * The testbed run is ready and the master callback can be called now. At this
116 * time the peers are all started and if a topology is provided in the
117 * configuration the topology would have been attempted
122 /* * Peers are stopped */
124 /* RC_PEERS_STOPPED, */
127 /* * Peers are destroyed */
129 /* RC_PEERS_DESTROYED */
132 * All peers shutdown (stopped and destroyed)
139 * Context for host compability checks
141 struct CompatibilityCheckContext
146 struct GNUNET_TESTBED_RunHandle *rc;
149 * Handle for the compability check
151 struct GNUNET_TESTBED_HostHabitableCheckHandle *h;
154 * Index of the host in the run context's hosts array
163 struct GNUNET_TESTBED_RunHandle
166 * The controller handle
168 struct GNUNET_TESTBED_Controller *c;
171 * The configuration of the controller. This is based on the cfg given to the
172 * function GNUNET_TESTBED_run(). We also use this config as a template while
175 struct GNUNET_CONFIGURATION_Handle *cfg;
178 * Handle to the host on which the controller runs
180 struct GNUNET_TESTBED_Host *h;
183 * The handle to the controller process
185 struct GNUNET_TESTBED_ControllerProc *cproc;
188 * The callback to use as controller callback
190 GNUNET_TESTBED_ControllerCallback cc;
193 * The pointer to the controller callback
198 * The trusted IP string
203 * TestMaster callback to call when testbed initialization is done
205 GNUNET_TESTBED_TestMaster test_master;
208 * The closure for the TestMaster callback
210 void *test_master_cls;
213 * A hashmap for operations started by us
215 struct GNUNET_CONTAINER_MultiHashMap32 *rcop_map;
218 * An array of hosts loaded from the hostkeys file
220 struct GNUNET_TESTBED_Host **hosts;
223 * Array of compatibility check contexts
225 struct CompatibilityCheckContext *hclist;
228 * Array of peers which we create
230 struct GNUNET_TESTBED_Peer **peers;
233 * The topology generation operation. Will be null if no topology is set in
236 struct GNUNET_TESTBED_Operation *topology_operation;
239 * The file containing topology data. Only used if the topology is set to 'FROM_FILE'
244 * Host registration handle
246 struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
249 * Profiling start time
251 struct GNUNET_TIME_Absolute pstart_time;
254 * Host registration task
256 GNUNET_SCHEDULER_TaskIdentifier register_hosts_task;
259 * Task to be run of a timeout
261 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
264 * Task run upon shutdown interrupts
266 GNUNET_SCHEDULER_TaskIdentifier interrupt_task;
269 * The event mask for the controller
274 * State of this context
279 * The topology which has to be achieved with the peers started in this context
281 enum GNUNET_TESTBED_TopologyOption topology;
284 * Have we already shutdown
289 * Number of hosts in the given host file
291 unsigned int num_hosts;
294 * Number of registered hosts. Also used as a counter while checking
295 * habitabillity of hosts
297 unsigned int reg_hosts;
300 * Current peer count for an operation; Set this to 0 and increment for each
301 * successful operation on a peer
303 unsigned int peer_count;
306 * number of peers to start
308 unsigned int num_peers;
311 * Expected overlay connects. Should be zero if no topology is relavant
316 * Number of random links to established
318 unsigned int random_links;
321 * the number of overlay link connection attempts that succeeded
323 unsigned int links_succeeded;
326 * the number of overlay link connection attempts that failed
328 unsigned int links_failed;
334 * Return a 32-bit key from a pointer
336 * @param rcop the pointer
340 rcop_key (void *rcop)
342 return * ((uint32_t *) &rcop);
347 * Context information used for finding a pointer in the rcop_map
352 * The operation pointer to look for
354 struct GNUNET_TESTBED_Operation *query;
357 * The Run context operation which has the operation being queried
359 struct RunContextOperation *result;
364 * Iterator for searching over the elements matching a given query
366 * @param cls the SearchContext
367 * @param key the 32-bit key
368 * @param value the RunContextOperation element
369 * @return GNUNET_YES to continue iteration; GNUNET_NO to cancel it
372 search_iterator (void *cls, uint32_t key, void *value)
374 struct RunContextOperation *rcop = value;
375 struct SearchContext *sc = cls;
377 GNUNET_assert (NULL != rcop);
378 if (sc->query == rcop->op)
380 GNUNET_assert (NULL == sc->result);
389 * Initiate a search for the given operation in the rcop_map
391 * @param rc the RunContext whose rcop_map will be searched for the given
393 * @param op the given operation to search for
394 * @return the matching RunContextOperation if found; NULL if not
396 static struct RunContextOperation *
397 search_rcop (struct GNUNET_TESTBED_RunHandle *rc, struct GNUNET_TESTBED_Operation *op)
399 struct SearchContext sc;
404 GNUNET_CONTAINER_multihashmap32_get_multiple (rc->rcop_map,
409 GNUNET_assert (NULL != sc.result);
417 * Insert an RunContextOperation into the rcop_map of the given RunContext
419 * @param rc the RunContext into whose map is to be used for insertion
420 * @param rcop the RunContextOperation to insert
423 insert_rcop (struct GNUNET_TESTBED_RunHandle *rc, struct 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 RunContextOperation *rcop)
442 GNUNET_assert (GNUNET_YES ==
443 GNUNET_CONTAINER_multihashmap32_remove (rc->rcop_map,
449 * Assuming all peers have been destroyed cleanup run handle
451 * @param cls the run handle
456 struct GNUNET_TESTBED_RunHandle *rc = cls;
459 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == rc->register_hosts_task);
460 GNUNET_assert (NULL == rc->reg_handle);
461 GNUNET_assert (NULL == rc->peers);
462 GNUNET_assert (NULL == rc->hclist);
463 GNUNET_assert (RC_PEERS_SHUTDOWN == rc->state);
464 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap32_size (rc->rcop_map));
465 GNUNET_CONTAINER_multihashmap32_destroy (rc->rcop_map);
467 GNUNET_TESTBED_controller_disconnect (rc->c);
468 if (NULL != rc->cproc)
469 GNUNET_TESTBED_controller_stop (rc->cproc);
471 GNUNET_TESTBED_host_destroy (rc->h);
472 for (hid = 0; hid < rc->num_hosts; hid++)
473 GNUNET_TESTBED_host_destroy (rc->hosts[hid]);
474 GNUNET_free_non_null (rc->hosts);
476 GNUNET_CONFIGURATION_destroy (rc->cfg);
477 GNUNET_free_non_null (rc->topo_file);
478 GNUNET_free_non_null (rc->trusted_ip);
484 * Iterator for cleaning up elements from rcop_map
486 * @param cls the RunContext
487 * @param key the 32-bit key
488 * @param value the RunContextOperation element
489 * @return always GNUNET_YES
492 rcop_cleanup_iterator (void *cls, uint32_t key, void *value)
494 struct GNUNET_TESTBED_RunHandle *rc = cls;
495 struct RunContextOperation *rcop = value;
497 GNUNET_assert (rc == rcop->rc);
498 remove_rcop (rc, rcop);
499 GNUNET_TESTBED_operation_done (rcop->op);
506 * Cancels operations and tasks which are assigned to the given run context
508 * @param rc the RunContext
511 rc_cleanup_operations (struct GNUNET_TESTBED_RunHandle *rc)
513 struct CompatibilityCheckContext *hc;
516 if (NULL != rc->hclist)
518 for (nhost = 0; nhost < rc->num_hosts; nhost++)
520 hc = &rc->hclist[nhost];
522 GNUNET_TESTBED_is_host_habitable_cancel (hc->h);
524 GNUNET_free (rc->hclist);
527 /* Stop register hosts task if it is running */
528 if (GNUNET_SCHEDULER_NO_TASK != rc->register_hosts_task)
530 GNUNET_SCHEDULER_cancel (rc->register_hosts_task);
531 rc->register_hosts_task = GNUNET_SCHEDULER_NO_TASK;
533 if (GNUNET_SCHEDULER_NO_TASK != rc->timeout_task)
535 GNUNET_SCHEDULER_cancel (rc->timeout_task);
536 rc->timeout_task = GNUNET_SCHEDULER_NO_TASK;
538 if (NULL != rc->reg_handle)
540 GNUNET_TESTBED_cancel_registration (rc->reg_handle);
541 rc->reg_handle = NULL;
543 if (NULL != rc->topology_operation)
545 GNUNET_TESTBED_operation_done (rc->topology_operation);
546 rc->topology_operation = NULL;
548 /* cancel any exiting operations */
549 GNUNET_assert (GNUNET_SYSERR !=
550 GNUNET_CONTAINER_multihashmap32_iterate (rc->rcop_map,
551 &rcop_cleanup_iterator,
557 * Cancels the scheduled interrupt task
559 * @param rc the run context
562 cancel_interrupt_task (struct GNUNET_TESTBED_RunHandle *rc)
564 GNUNET_SCHEDULER_cancel (rc->interrupt_task);
565 rc->interrupt_task = GNUNET_SCHEDULER_NO_TASK;
570 * This callback will be called when all the operations are completed
573 * @param cls run context
576 wait_op_completion (void *cls)
578 struct GNUNET_TESTBED_RunHandle *rc = cls;
579 struct RunContextOperation *rcop;
581 if ( (NULL == rc->cproc)
583 || (GNUNET_YES == rc->shutdown) )
585 if (NULL != rc->peers)
587 GNUNET_free (rc->peers);
592 if (NULL == rc->peers)
594 rc->shutdown = GNUNET_YES;
595 rcop = GNUNET_new (struct RunContextOperation);
597 rcop->op = GNUNET_TESTBED_shutdown_peers (rc->c, rcop, NULL, NULL);
598 GNUNET_assert (NULL != rcop->op);
599 DEBUG ("Shutting down peers\n");
600 rc->pstart_time = GNUNET_TIME_absolute_get ();
601 insert_rcop (rc, rcop);
605 rc->state = RC_PEERS_SHUTDOWN;
606 cancel_interrupt_task (rc);
612 * Task run upon interrupts (SIGINT, SIGTERM) and upon scheduler shutdown.
614 * @param cls the RunContext which has to be acted upon
615 * @param tc the scheduler task context
618 interrupt (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
620 struct GNUNET_TESTBED_RunHandle *rc = cls;
621 struct GNUNET_TESTBED_Controller *c = rc->c;
625 rc->interrupt_task = GNUNET_SCHEDULER_add_delayed
626 (GNUNET_TIME_UNIT_FOREVER_REL, &interrupt, rc);
627 rc_cleanup_operations (rc);
628 if ( (GNUNET_NO == rc->shutdown)
630 && (0 != (size = GNUNET_CONTAINER_multihashmap32_size (c->opc_map))))
632 LOG (GNUNET_ERROR_TYPE_WARNING, "Shutdown postponed as there are "
633 "%u operations currently active\n", size);
634 c->opcq_empty_cb = &wait_op_completion;
635 c->opcq_empty_cls = rc;
638 wait_op_completion (rc);
643 * Function to return the string representation of the duration between current
644 * time and `pstart_time' in `RunContext'
646 * @param rc the RunContext
647 * @return the representation string; this is NOT reentrant
650 prof_time (struct GNUNET_TESTBED_RunHandle *rc)
652 struct GNUNET_TIME_Relative ptime;
654 ptime = GNUNET_TIME_absolute_get_duration (rc->pstart_time);
655 return GNUNET_STRINGS_relative_time_to_string (ptime, GNUNET_YES);
660 * Task for starting peers
662 * @param cls the RunHandle
663 * @param tc the task context from scheduler
666 start_peers_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
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 = GNUNET_SCHEDULER_NO_TASK;
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 %
792 rc->cfg, &peer_create_cb, rcop);
793 GNUNET_assert (NULL != rcop->op);
794 insert_rcop (rc, rcop);
800 * Signature of the event handler function called by the
801 * respective event controller.
804 * @param event information about the event
807 event_cb (void *cls, const struct GNUNET_TESTBED_EventInformation *event)
809 struct GNUNET_TESTBED_RunHandle *rc = cls;
810 struct RunContextOperation *rcop;
812 if (RC_INIT == rc->state)
816 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
817 rcop = event->op_cls;
818 if (NULL != event->details.operation_finished.emsg)
820 LOG (GNUNET_ERROR_TYPE_ERROR, _("Linking controllers failed. Exiting"));
821 GNUNET_SCHEDULER_shutdown ();
825 GNUNET_assert (event->op == rcop->op);
826 remove_rcop (rc, rcop);
827 GNUNET_TESTBED_operation_done (rcop->op);
829 if (rc->reg_hosts == rc->num_hosts)
831 rc->state = RC_LINKED;
837 GNUNET_SCHEDULER_shutdown ();
841 if (GNUNET_TESTBED_ET_OPERATION_FINISHED != event->type)
843 if (NULL == (rcop = search_rcop (rc, event->op)))
845 remove_rcop (rc, rcop);
846 GNUNET_TESTBED_operation_done (rcop->op);
848 if ( (GNUNET_NO == rc->shutdown)
849 && (NULL != event->details.operation_finished.emsg) )
851 LOG (GNUNET_ERROR_TYPE_ERROR, "A operation has failed with error: %s\n",
852 event->details.operation_finished.emsg);
853 GNUNET_SCHEDULER_shutdown ();
856 GNUNET_assert (GNUNET_YES == rc->shutdown);
860 case RC_PEERS_CREATED:
862 rc->state = RC_PEERS_SHUTDOWN;
863 GNUNET_free_non_null (rc->peers);
865 DEBUG ("Peers shut down in %s\n", prof_time (rc));
866 GNUNET_SCHEDULER_shutdown ();
874 if ((0 != (rc->event_mask & (1LL << event->type))) && (NULL != rc->cc))
875 rc->cc (rc->cc_cls, event);
876 if (GNUNET_TESTBED_ET_PEER_START != event->type)
878 if (NULL == (rcop = search_rcop (rc, event->op))) /* Not our operation */
880 remove_rcop (rc, rcop);
881 GNUNET_TESTBED_operation_done (rcop->op);
884 if (rc->peer_count < rc->num_peers)
886 DEBUG ("%u peers started in %s\n", rc->num_peers, prof_time (rc));
887 if (GNUNET_TESTBED_TOPOLOGY_NONE != rc->topology)
889 switch (rc->topology)
891 case GNUNET_TESTBED_TOPOLOGY_NONE:
893 case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
894 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
895 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
896 rc->topology_operation =
897 GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
898 rc->peers, &rc->num_oc,
899 &topology_completion_callback,
903 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
905 case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
906 GNUNET_assert (NULL != rc->topo_file);
907 rc->topology_operation =
908 GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
909 rc->peers, &rc->num_oc,
910 &topology_completion_callback,
914 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
916 case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
918 unsigned long long number;
920 GNUNET_assert (GNUNET_OK ==
921 GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
924 cap = (unsigned int) number;
925 GNUNET_assert (GNUNET_OK ==
926 GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
929 rc->topology_operation =
930 GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
931 rc->peers, &rc->num_oc,
932 &topology_completion_callback,
936 (unsigned int) number, /* uint8_t */
937 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
941 rc->topology_operation =
942 GNUNET_TESTBED_overlay_configure_topology (NULL, rc->num_peers,
943 rc->peers, &rc->num_oc,
944 &topology_completion_callback,
947 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
949 if (NULL == rc->topology_operation)
950 LOG (GNUNET_ERROR_TYPE_WARNING,
951 "Not generating a topology. Check number of peers\n");
954 DEBUG ("Creating overlay topology\n");
955 rc->pstart_time = GNUNET_TIME_absolute_get ();
959 rc->state = RC_READY;
965 * Task to register all hosts available in the global host list
967 * @param cls the RunContext
968 * @param tc the scheduler task context
971 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
975 * Callback which will be called to after a host registration succeeded or failed
977 * @param cls the closure
978 * @param emsg the error message; NULL if host registration is successful
981 host_registration_completion (void *cls, const char *emsg)
983 struct GNUNET_TESTBED_RunHandle *rc = cls;
985 rc->reg_handle = NULL;
988 LOG (GNUNET_ERROR_TYPE_WARNING,
989 _("Host registration failed for a host. Error: %s\n"), emsg);
990 GNUNET_SCHEDULER_shutdown ();
993 rc->register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts, rc);
998 * Task to register all hosts available in the global host list
1000 * @param cls RunContext
1001 * @param tc the scheduler task context
1004 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1006 struct GNUNET_TESTBED_RunHandle *rc = cls;
1007 struct RunContextOperation *rcop;
1010 rc->register_hosts_task = GNUNET_SCHEDULER_NO_TASK;
1011 if (rc->reg_hosts == rc->num_hosts)
1013 DEBUG ("All hosts successfully registered\n");
1015 for (slave = 0; slave < rc->num_hosts; slave++)
1017 rcop = GNUNET_new (struct RunContextOperation);
1020 GNUNET_TESTBED_controller_link (rcop, rc->c, rc->hosts[slave],
1022 GNUNET_assert (NULL != rcop->op);
1023 insert_rcop (rc, rcop);
1029 GNUNET_TESTBED_register_host (rc->c, rc->hosts[rc->reg_hosts],
1030 host_registration_completion, rc);
1036 * Callback to signal successfull startup of the controller process
1038 * @param cls the closure from GNUNET_TESTBED_controller_start()
1039 * @param cfg the configuration with which the controller has been started;
1040 * NULL if status is not GNUNET_OK
1041 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
1042 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
1045 controller_status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg,
1048 struct GNUNET_TESTBED_RunHandle *rc = cls;
1049 uint64_t event_mask;
1051 if (status != GNUNET_OK)
1054 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1055 _("Controller crash detected. Shutting down.\n"));
1056 GNUNET_SCHEDULER_shutdown ();
1059 GNUNET_CONFIGURATION_destroy (rc->cfg);
1060 rc->cfg = GNUNET_CONFIGURATION_dup (cfg);
1061 event_mask = rc->event_mask;
1062 event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
1063 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
1064 if (rc->topology < GNUNET_TESTBED_TOPOLOGY_NONE)
1065 event_mask |= GNUNET_TESTBED_ET_CONNECT;
1067 GNUNET_TESTBED_controller_connect (rc->h, event_mask, &event_cb, rc);
1068 if (0 < rc->num_hosts)
1071 rc->register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts, rc);
1074 rc->state = RC_LINKED;
1080 * Callback function invoked for each interface found.
1082 * @param cls closure
1083 * @param name name of the interface (can be NULL for unknown)
1084 * @param isDefault is this presumably the default interface
1085 * @param addr address of this interface (can be NULL for unknown or unassigned)
1086 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
1087 * @param netmask the network mask (can be NULL for unknown or unassigned))
1088 * @param addrlen length of the address
1089 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
1092 netint_proc (void *cls, const char *name, int isDefault,
1093 const struct sockaddr *addr, const struct sockaddr *broadcast_addr,
1094 const struct sockaddr *netmask, socklen_t addrlen)
1096 struct GNUNET_TESTBED_RunHandle *rc = cls;
1097 char hostip[NI_MAXHOST];
1100 if (sizeof (struct sockaddr_in) != addrlen)
1101 return GNUNET_OK; /* Only consider IPv4 for now */
1103 getnameinfo (addr, addrlen, hostip, NI_MAXHOST, NULL, 0, NI_NUMERICHOST))
1104 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "getnameinfo");
1105 if (NULL == rc->trusted_ip)
1107 rc->trusted_ip = GNUNET_strdup (hostip);
1110 (void) GNUNET_asprintf (&buf, "%s; %s", rc->trusted_ip, hostip);
1111 GNUNET_free (rc->trusted_ip);
1112 rc->trusted_ip = buf;
1118 * Callbacks of this type are called by GNUNET_TESTBED_is_host_habitable to
1119 * inform whether the given host is habitable or not. The Handle returned by
1120 * GNUNET_TESTBED_is_host_habitable() is invalid after this callback is called
1123 * @param host the host whose status is being reported; will be NULL if the host
1124 * given to GNUNET_TESTBED_is_host_habitable() is NULL
1125 * @param status GNUNET_YES if it is habitable; GNUNET_NO if not
1128 host_habitable_cb (void *cls, const struct GNUNET_TESTBED_Host *host,
1131 struct CompatibilityCheckContext *hc = cls;
1132 struct GNUNET_TESTBED_RunHandle *rc;
1133 struct GNUNET_TESTBED_Host **old_hosts;
1136 GNUNET_assert (NULL != (rc = hc->rc));
1138 GNUNET_assert (nhost <= rc->num_hosts);
1139 GNUNET_assert (host == rc->hosts[nhost]);
1141 if (GNUNET_NO == status)
1143 if ((NULL != host) && (NULL != GNUNET_TESTBED_host_get_hostname (host)))
1144 LOG (GNUNET_ERROR_TYPE_ERROR, _("Host %s cannot start testbed\n"),
1145 GNUNET_TESTBED_host_get_hostname (host));
1147 LOG (GNUNET_ERROR_TYPE_ERROR,
1148 _("Testbed cannot be started on localhost\n"));
1149 GNUNET_SCHEDULER_shutdown ();
1153 if (rc->reg_hosts < rc->num_hosts)
1155 GNUNET_free (rc->hclist);
1157 rc->h = rc->hosts[0];
1159 if (0 < rc->num_hosts)
1161 old_hosts = rc->hosts;
1163 GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Host *) * rc->num_hosts);
1164 memcpy (rc->hosts, &old_hosts[1],
1165 (sizeof (struct GNUNET_TESTBED_Host *) * rc->num_hosts));
1166 GNUNET_free (old_hosts);
1170 GNUNET_free (rc->hosts);
1173 GNUNET_TESTBED_host_resolve_ (rc->h);
1174 for (nhost = 0; nhost < rc->num_hosts; nhost++)
1175 GNUNET_TESTBED_host_resolve_ (rc->hosts[nhost]);
1176 GNUNET_OS_network_interfaces_list (netint_proc, rc);
1177 if (NULL == rc->trusted_ip)
1178 rc->trusted_ip = GNUNET_strdup ("127.0.0.1");
1180 GNUNET_TESTBED_controller_start (rc->trusted_ip, rc->h,
1181 &controller_status_cb, rc);
1182 GNUNET_free (rc->trusted_ip);
1183 rc->trusted_ip = NULL;
1184 if (NULL == rc->cproc)
1186 LOG (GNUNET_ERROR_TYPE_ERROR, _("Cannot start the master controller"));
1187 GNUNET_SCHEDULER_shutdown ();
1193 * Task run upon timeout while setting up the testbed
1195 * @param cls the RunContext
1196 * @param tc the task context
1199 timeout_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1201 struct GNUNET_TESTBED_RunHandle *rc = cls;
1203 rc->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1204 LOG (GNUNET_ERROR_TYPE_ERROR, _("Shutting down testbed due to timeout while setup.\n"));
1205 GNUNET_SCHEDULER_shutdown ();
1206 if (NULL != rc->test_master)
1207 rc->test_master (rc->test_master_cls, rc, 0, NULL, 0, 0);
1208 rc->test_master = NULL;
1213 * Convenience method for running a testbed with
1214 * a single call. Underlay and overlay topology
1215 * are configured using the "UNDERLAY" and "OVERLAY"
1216 * options in the "[testbed]" section of the configuration\
1217 * (with possible options given in "UNDERLAY_XXX" and/or
1220 * The testbed is to be terminated using a call to
1221 * "GNUNET_SCHEDULER_shutdown".
1223 * @param host_filename name of the file with the 'hosts', NULL
1224 * to run everything on 'localhost'
1225 * @param cfg configuration to use (for testbed, controller and peers)
1226 * @param num_peers number of peers to start; FIXME: maybe put that ALSO into cfg?
1227 * @param event_mask bit mask with set of events to call 'cc' for;
1228 * or-ed values of "1LL" shifted by the
1229 * respective 'enum GNUNET_TESTBED_EventType'
1230 * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...")
1231 * @param cc controller callback to invoke on events; This callback is called
1232 * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't
1233 * set in the event_mask as this is the only way get access to the
1234 * handle of each peer
1235 * @param cc_cls closure for cc
1236 * @param test_master this callback will be called once the test is ready
1237 * @param test_master_cls closure for 'test_master'.
1240 GNUNET_TESTBED_run (const char *host_filename,
1241 const struct GNUNET_CONFIGURATION_Handle *cfg,
1242 unsigned int num_peers, uint64_t event_mask,
1243 GNUNET_TESTBED_ControllerCallback cc, void *cc_cls,
1244 GNUNET_TESTBED_TestMaster test_master,
1245 void *test_master_cls)
1247 struct GNUNET_TESTBED_RunHandle *rc;
1249 struct CompatibilityCheckContext *hc;
1250 struct GNUNET_TIME_Relative timeout;
1251 unsigned long long number;
1255 GNUNET_assert (num_peers > 0);
1256 rc = GNUNET_new (struct GNUNET_TESTBED_RunHandle);
1257 rc->cfg = GNUNET_CONFIGURATION_dup (cfg);
1259 rc->num_hosts = GNUNET_TESTBED_hosts_load_from_loadleveler (rc->cfg,
1261 if (0 == rc->num_hosts)
1263 LOG (GNUNET_ERROR_TYPE_WARNING,
1264 _("No hosts loaded from LoadLeveler. Need at least one host\n"));
1268 if (NULL != host_filename)
1271 GNUNET_TESTBED_hosts_load_from_file (host_filename, rc->cfg,
1273 if (0 == rc->num_hosts)
1275 LOG (GNUNET_ERROR_TYPE_WARNING,
1276 _("No hosts loaded. Need at least one host\n"));
1281 rc->h = GNUNET_TESTBED_host_create (NULL, NULL, rc->cfg, 0);
1283 rc->num_peers = num_peers;
1284 rc->event_mask = event_mask;
1286 rc->cc_cls = cc_cls;
1287 rc->test_master = test_master;
1288 rc->test_master_cls = test_master_cls;
1289 rc->state = RC_INIT;
1290 rc->topology = GNUNET_TESTBED_TOPOLOGY_NONE;
1292 GNUNET_CONFIGURATION_get_value_string (rc->cfg, TESTBED_CONFIG_SECTION,
1293 "OVERLAY_TOPOLOGY", &topology))
1295 if (GNUNET_NO == GNUNET_TESTBED_topology_get_ (&rc->topology, topology))
1297 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
1300 ("Specified topology must be supported by testbed"));
1302 GNUNET_free (topology);
1304 switch (rc->topology)
1306 case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
1307 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
1308 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
1310 GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
1311 "OVERLAY_RANDOM_LINKS",
1314 /* OVERLAY option RANDOM & SMALL_WORLD_RING requires OVERLAY_RANDOM_LINKS
1315 * option to be set to the number of random links to be established */
1316 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
1317 "OVERLAY_RANDOM_LINKS");
1320 if (number > UINT32_MAX)
1322 GNUNET_break (0); /* Too big number */
1325 rc->random_links = (unsigned int) number;
1327 case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
1329 GNUNET_CONFIGURATION_get_value_filename (rc->cfg, TESTBED_CONFIG_SECTION,
1330 "OVERLAY_TOPOLOGY_FILE",
1333 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
1334 "OVERLAY_TOPOLOGY_FILE");
1338 case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
1340 GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
1341 SCALE_FREE_CAP, &number))
1343 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
1347 if (UINT16_MAX < number)
1349 LOG (GNUNET_ERROR_TYPE_ERROR,
1350 _("Maximum number of edges a peer can have in a scale free topology"
1351 " cannot be more than %u. Given `%s = %llu'"), UINT16_MAX,
1352 SCALE_FREE_CAP, number);
1356 GNUNET_CONFIGURATION_get_value_number (rc->cfg, TESTBED_CONFIG_SECTION,
1357 SCALE_FREE_M, &number))
1359 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, TESTBED_CONFIG_SECTION,
1363 if (UINT8_MAX < number)
1365 LOG (GNUNET_ERROR_TYPE_ERROR,
1366 _("The number of edges that can established when adding a new node"
1367 " to scale free topology cannot be more than %u. Given `%s = %llu'"),
1368 UINT8_MAX, SCALE_FREE_M, number);
1374 /* Warn if OVERLAY_RANDOM_LINKS is present that it will be ignored */
1376 GNUNET_CONFIGURATION_have_value (rc->cfg, TESTBED_CONFIG_SECTION,
1377 "OVERLAY_RANDOM_LINKS"))
1378 LOG (GNUNET_ERROR_TYPE_WARNING,
1379 "Ignoring value of `OVERLAY_RANDOM_LINKS' in given configuration\n");
1382 if (0 != rc->num_hosts)
1384 rc->hclist = GNUNET_malloc (sizeof (struct CompatibilityCheckContext)
1386 for (nhost = 0; nhost < rc->num_hosts; nhost++)
1388 hc = &rc->hclist[nhost];
1391 hc->h = GNUNET_TESTBED_is_host_habitable (rc->hosts[nhost], rc->cfg,
1392 &host_habitable_cb, hc);
1396 for (nhost = 0; nhost < rc->num_hosts; nhost++)
1398 hc = &rc->hclist[nhost];
1400 GNUNET_TESTBED_is_host_habitable_cancel (hc->h);
1402 GNUNET_free (rc->hclist);
1410 GNUNET_TESTBED_controller_start ("127.0.0.1", rc->h,
1411 &controller_status_cb, rc);
1412 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, TESTBED_CONFIG_SECTION,
1416 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
1417 DEFAULT_SETUP_TIMEOUT);
1419 rc->rcop_map = GNUNET_CONTAINER_multihashmap32_create (256);
1421 GNUNET_SCHEDULER_add_delayed (timeout, &timeout_task, rc);
1422 rc->interrupt_task =
1423 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &interrupt,
1429 GNUNET_TESTBED_host_destroy (rc->h);
1430 if (NULL != rc->hosts)
1432 for (hid = 0; hid < rc->num_hosts; hid++)
1433 if (NULL != rc->hosts[hid])
1434 GNUNET_TESTBED_host_destroy (rc->hosts[hid]);
1435 GNUNET_free (rc->hosts);
1437 if (NULL != rc->cfg)
1438 GNUNET_CONFIGURATION_destroy (rc->cfg);
1444 * Obtain handle to the master controller from a testbed run. The handle
1445 * returned should not be disconnected.
1447 * @param h the testbed run handle
1448 * @return handle to the master controller
1450 struct GNUNET_TESTBED_Controller *
1451 GNUNET_TESTBED_run_get_controller_handle (struct GNUNET_TESTBED_RunHandle *h)
1457 /* end of testbed_api_testbed.c */