2 This file is part of GNUnet.
3 (C) 2011, 2012 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/gnunet-testbed-profiler.c
23 * @brief Profiling driver for the testbed.
24 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
28 #include "gnunet_common.h"
29 #include "gnunet_util_lib.h"
30 #include "gnunet_testbed_service.h"
31 #include "testbed_api_hosts.h"
34 * Generic loggins shorthand
36 #define LOG(kind,...) \
37 GNUNET_log (kind, __VA_ARGS__)
46 * The testbed operation handle
48 struct GNUNET_TESTBED_Operation *op;
56 * The next pointer for DLL
58 struct DLLOperation *next;
61 * The prev pointer for DLL
63 struct DLLOperation *prev;
68 * Availanle states during profiling
80 STATE_SLAVES_STARTING,
98 * Destroying peers; we can do this as the controller takes care of stopping a
99 * peer if it is running
101 STATE_PEERS_DESTROYING
106 * An array of hosts loaded from the hostkeys file
108 static struct GNUNET_TESTBED_Host **hosts;
111 * The array of peers; we fill this as the peers are given to us by the testbed
113 static struct GNUNET_TESTBED_Peer **peers;
116 /* * Operation handle */
118 /* static struct GNUNET_TESTBED_Operation *op; */
121 * Host registration handle
123 static struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
126 * Handle to the master controller process
128 struct GNUNET_TESTBED_ControllerProc *mc_proc;
131 * Handle to the master controller
133 struct GNUNET_TESTBED_Controller *mc;
136 * Handle to global configuration
138 struct GNUNET_CONFIGURATION_Handle *cfg;
141 * Head of the operations list
143 struct DLLOperation *dll_op_head;
146 * Tail of the operations list
148 struct DLLOperation *dll_op_tail;
151 * Peer linking - topology operation
153 struct GNUNET_TESTBED_Operation *topology_op;
156 * The handle for whether a host is habitable or not
158 struct GNUNET_TESTBED_HostHabitableCheckHandle **hc_handles;
161 * Abort task identifier
163 static GNUNET_SCHEDULER_TaskIdentifier abort_task;
166 * Shutdown task identifier
168 static GNUNET_SCHEDULER_TaskIdentifier shutdown_task;
171 * Host registration task identifier
173 static GNUNET_SCHEDULER_TaskIdentifier register_hosts_task;
176 * Global event mask for all testbed events
181 * The starting time of a profiling step
183 struct GNUNET_TIME_Absolute prof_start_time;
186 * Duration profiling step has taken
188 struct GNUNET_TIME_Relative prof_time;
193 unsigned int peer_id;
196 * Number of peers to be started by the profiler
198 static unsigned int num_peers;
201 * Number of hosts in the hosts array
203 static unsigned int num_hosts;
206 * Number of random links to be established between peers
208 static unsigned int num_links;
211 * Number of timeout failures to tolerate
213 static unsigned int num_cont_fails;
216 * Continuous failures during overlay connect operations
218 static unsigned int cont_fails;
221 * Links which are successfully established
223 static unsigned int established_links;
226 * Links which are not successfully established
228 static unsigned int failed_links;
231 * Global testing status
236 * current state of profiling
241 * The topology we want to acheive
243 enum GNUNET_TESTBED_TopologyOption topology;
250 * @param tc the task context
253 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
255 struct DLLOperation *dll_op;
258 shutdown_task = GNUNET_SCHEDULER_NO_TASK;
259 if (GNUNET_SCHEDULER_NO_TASK != abort_task)
260 GNUNET_SCHEDULER_cancel (abort_task);
261 if (NULL != hc_handles)
263 for (nhost = 0; nhost < num_hosts; nhost++)
264 if (NULL != hc_handles[nhost])
265 GNUNET_TESTBED_is_host_habitable_cancel (hc_handles[nhost]);
266 GNUNET_free (hc_handles);
269 if (GNUNET_SCHEDULER_NO_TASK != register_hosts_task)
270 GNUNET_SCHEDULER_cancel (register_hosts_task);
271 if (NULL != reg_handle)
272 GNUNET_TESTBED_cancel_registration (reg_handle);
273 if (NULL != topology_op)
274 GNUNET_TESTBED_operation_done (topology_op);
275 for (nhost = 0; nhost < num_hosts; nhost++)
276 if (NULL != hosts[nhost])
277 GNUNET_TESTBED_host_destroy (hosts[nhost]);
278 GNUNET_free_non_null (hosts);
279 while (NULL != (dll_op = dll_op_head))
281 GNUNET_TESTBED_operation_done (dll_op->op);
282 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
283 GNUNET_free (dll_op);
286 GNUNET_TESTBED_controller_disconnect (mc);
288 GNUNET_TESTBED_controller_stop (mc_proc);
290 GNUNET_CONFIGURATION_destroy (cfg);
291 GNUNET_SCHEDULER_shutdown (); /* Stop scheduler to shutdown testbed run */
296 * abort task to run on test timed out
299 * @param tc the task context
302 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
304 LOG (GNUNET_ERROR_TYPE_WARNING, "Aborting\n");
305 abort_task = GNUNET_SCHEDULER_NO_TASK;
306 result = GNUNET_SYSERR;
307 if (GNUNET_SCHEDULER_NO_TASK != shutdown_task)
308 GNUNET_SCHEDULER_cancel (shutdown_task);
309 shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
314 * Functions of this signature are called when a peer has been successfully
315 * started or stopped.
317 * @param cls the closure from GNUNET_TESTBED_peer_start/stop()
318 * @param emsg NULL on success; otherwise an error description
321 peer_churn_cb (void *cls, const char *emsg)
323 struct DLLOperation *dll_op = cls;
324 struct GNUNET_TESTBED_Operation *op;
325 static unsigned int started_peers;
328 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
329 GNUNET_free (dll_op);
332 LOG (GNUNET_ERROR_TYPE_WARNING,
333 _("An operation has failed while starting peers\n"));
334 GNUNET_TESTBED_operation_done (op);
335 GNUNET_SCHEDULER_cancel (abort_task);
336 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
339 GNUNET_TESTBED_operation_done (op);
340 if (++started_peers == num_peers)
342 prof_time = GNUNET_TIME_absolute_get_duration (prof_start_time);
343 printf ("%u peers started successfully in %.2f seconds\n",
344 num_peers, ((double) prof_time.rel_value) / 1000.00);
347 if ((0 == num_links) && (topology == GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI))
349 fprintf (stdout, "Testbed running, waiting for keystroke to shut down\n");
351 shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
354 state = STATE_PEERS_LINKING;
355 /* Do overlay connect */
356 prof_start_time = GNUNET_TIME_absolute_get ();
359 case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
361 GNUNET_TESTBED_overlay_configure_topology (NULL, num_peers, peers, NULL,
364 GNUNET_TESTBED_TOPOLOGY_DISABLE_AUTO_RETRY,
365 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
367 case GNUNET_TESTBED_TOPOLOGY_CLIQUE:
369 GNUNET_TESTBED_overlay_configure_topology (NULL, num_peers, peers, NULL,
371 GNUNET_TESTBED_TOPOLOGY_DISABLE_AUTO_RETRY,
372 GNUNET_TESTBED_TOPOLOGY_OPTION_END);
373 num_links = num_peers * (num_peers - 1);
383 * Functions of this signature are called when a peer has been successfully
386 * @param cls the closure from GNUNET_TESTBED_peer_create()
387 * @param peer the handle for the created peer; NULL on any error during
389 * @param emsg NULL if peer is not NULL; else MAY contain the error description
392 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
394 struct DLLOperation *dll_op = cls;
395 struct GNUNET_TESTBED_Peer **peer_ptr;
396 static unsigned int created_peers;
397 unsigned int peer_cnt;
401 LOG (GNUNET_ERROR_TYPE_WARNING,
402 _("Creating a peer failed. Error: %s\n"), emsg);
403 GNUNET_TESTBED_operation_done (dll_op->op);
404 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
405 GNUNET_free (dll_op);
406 GNUNET_SCHEDULER_cancel (abort_task);
407 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
410 peer_ptr = dll_op->cls;
411 GNUNET_assert (NULL == *peer_ptr);
413 GNUNET_TESTBED_operation_done (dll_op->op);
414 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
415 GNUNET_free (dll_op);
416 if (++created_peers == num_peers)
418 prof_time = GNUNET_TIME_absolute_get_duration (prof_start_time);
419 printf ("%u peers created successfully in %.2f seconds\n",
420 num_peers, ((double) prof_time.rel_value) / 1000.00);
422 /* Now peers are to be started */
423 state = STATE_PEERS_STARTING;
424 prof_start_time = GNUNET_TIME_absolute_get ();
425 for (peer_cnt = 0; peer_cnt < num_peers; peer_cnt++)
427 dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
428 dll_op->op = GNUNET_TESTBED_peer_start (dll_op, peers[peer_cnt],
429 &peer_churn_cb, dll_op);
430 GNUNET_CONTAINER_DLL_insert_tail (dll_op_head, dll_op_tail, dll_op);
437 * Function to print summary about how many overlay links we have made and how
441 print_overlay_links_summary ()
443 prof_time = GNUNET_TIME_absolute_get_duration (prof_start_time);
444 printf ("\n%u links established in %.2f seconds\n",
445 established_links, ((double) prof_time.rel_value) / 1000.00);
446 printf ("%u links failed due to timeouts\n", failed_links);
451 * Function to start peers
456 struct DLLOperation *dll_op;
457 unsigned int peer_cnt;
459 state = STATE_PEERS_CREATING;
460 prof_start_time = GNUNET_TIME_absolute_get ();
461 peers = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Peer *)
463 for (peer_cnt = 0; peer_cnt < num_peers; peer_cnt++)
465 dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
466 dll_op->cls = &peers[peer_cnt];
467 dll_op->op = GNUNET_TESTBED_peer_create (mc,
469 [peer_cnt % num_hosts],
473 GNUNET_CONTAINER_DLL_insert_tail (dll_op_head, dll_op_tail, dll_op);
479 * Controller event callback
482 * @param event the controller event
485 controller_event_cb (void *cls,
486 const struct GNUNET_TESTBED_EventInformation *event)
488 struct DLLOperation *dll_op;
489 struct GNUNET_TESTBED_Operation *op;
493 case STATE_SLAVES_STARTING:
496 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
498 static unsigned int slaves_started;
500 dll_op = event->details.operation_finished.op_cls;
501 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
502 GNUNET_free (dll_op);
503 op = event->details.operation_finished.operation;
504 if (NULL != event->details.operation_finished.emsg)
506 LOG (GNUNET_ERROR_TYPE_WARNING,
507 _("An operation has failed while starting slaves\n"));
508 GNUNET_TESTBED_operation_done (op);
509 GNUNET_SCHEDULER_cancel (abort_task);
510 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
513 GNUNET_TESTBED_operation_done (op);
514 /* Proceed to start peers */
515 if (++slaves_started == num_hosts - 1)
517 printf ("%u controllers started successfully\n", num_hosts);
527 case STATE_PEERS_STARTING:
530 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
531 /* Control reaches here when peer start fails */
532 case GNUNET_TESTBED_ET_PEER_START:
533 /* we handle peer starts in peer_churn_cb */
539 case STATE_PEERS_LINKING:
542 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
543 /* Control reaches here when a peer linking operation fails */
544 if (NULL != event->details.operation_finished.emsg)
549 if (++cont_fails > num_cont_fails)
551 printf ("\nAborting due to very high failure rate");
552 print_overlay_links_summary ();
553 GNUNET_SCHEDULER_cancel (abort_task);
554 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
559 case GNUNET_TESTBED_ET_CONNECT:
563 if (0 == established_links)
564 printf ("Establishing links. Please wait\n");
573 if ((established_links + failed_links) == num_links)
575 print_overlay_links_summary ();
577 fprintf (stdout, "Testbed running, waiting for keystroke to shut down\n");
579 shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
589 * Task to register all hosts available in the global host list
592 * @param tc the scheduler task context
595 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
599 * Callback which will be called to after a host registration succeeded or failed
601 * @param cls the closure
602 * @param emsg the error message; NULL if host registration is successful
605 host_registration_completion (void *cls, const char *emsg)
610 LOG (GNUNET_ERROR_TYPE_WARNING,
611 _("Host registration failed for a host. Error: %s\n"), emsg);
612 GNUNET_SCHEDULER_cancel (abort_task);
613 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
616 register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts, NULL);
621 * Task to register all hosts available in the global host list
624 * @param tc the scheduler task context
627 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
629 struct DLLOperation *dll_op;
630 static unsigned int reg_host;
633 register_hosts_task = GNUNET_SCHEDULER_NO_TASK;
634 if (reg_host == num_hosts - 1)
636 LOG (GNUNET_ERROR_TYPE_DEBUG,
637 "All hosts successfully registered\n");
639 state = STATE_SLAVES_STARTING;
640 for (slave = 1; slave < num_hosts; slave++)
642 dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
643 dll_op->op = GNUNET_TESTBED_controller_link (dll_op,
649 GNUNET_CONTAINER_DLL_insert_tail (dll_op_head, dll_op_tail, dll_op);
653 reg_handle = GNUNET_TESTBED_register_host (mc, hosts[++reg_host],
654 host_registration_completion,
660 * Callback to signal successfull startup of the controller process
662 * @param cls the closure from GNUNET_TESTBED_controller_start()
663 * @param config the configuration with which the controller has been started;
664 * NULL if status is not GNUNET_OK
665 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
666 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
669 status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *config, int status)
671 if (GNUNET_SCHEDULER_NO_TASK != abort_task)
672 GNUNET_SCHEDULER_cancel (abort_task);
673 if (GNUNET_OK != status)
676 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
680 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
681 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_STOP);
682 event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
683 event_mask |= (1LL << GNUNET_TESTBED_ET_DISCONNECT);
684 event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
685 mc = GNUNET_TESTBED_controller_connect (config, hosts[0], event_mask,
686 &controller_event_cb, NULL);
689 LOG (GNUNET_ERROR_TYPE_WARNING,
690 _("Unable to connect to master controller -- Check config\n"));
691 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
695 register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts, NULL);
698 abort_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
704 * Callbacks of this type are called by GNUNET_TESTBED_is_host_habitable to
705 * inform whether the given host is habitable or not. The Handle returned by
706 * GNUNET_TESTBED_is_host_habitable() is invalid after this callback is called
709 * @param host the host whose status is being reported; will be NULL if the host
710 * given to GNUNET_TESTBED_is_host_habitable() is NULL
711 * @param status GNUNET_YES if it is habitable; GNUNET_NO if not
714 host_habitable_cb (void *cls, const struct GNUNET_TESTBED_Host *host, int status)
716 struct GNUNET_TESTBED_HostHabitableCheckHandle **hc_handle = cls;
717 static unsigned int hosts_checked;
720 if (GNUNET_NO == status)
722 if ((NULL != host) && (NULL != GNUNET_TESTBED_host_get_hostname (host)))
723 LOG (GNUNET_ERROR_TYPE_ERROR, _("Host %s cannot start testbed\n"),
724 GNUNET_TESTBED_host_get_hostname (host));
726 LOG (GNUNET_ERROR_TYPE_ERROR, _("Testbed cannot be started on localhost\n"));
727 GNUNET_SCHEDULER_cancel (abort_task);
728 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
732 printf (_("\rChecked %u hosts"), hosts_checked);
734 if (hosts_checked < num_hosts)
736 printf (_("\nAll hosts can start testbed. Creating peers\n"));
737 GNUNET_free (hc_handles);
740 GNUNET_TESTBED_controller_start (GNUNET_TESTBED_host_get_hostname
750 * Main function that will be run by the scheduler.
753 * @param args remaining command-line arguments
754 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
755 * @param config configuration
758 run (void *cls, char *const *args, const char *cfgfile,
759 const struct GNUNET_CONFIGURATION_Handle *config)
765 fprintf (stderr, _("No hosts-file specified on command line\n"));
773 num_hosts = GNUNET_TESTBED_hosts_load_from_file (args[0], &hosts);
776 fprintf (stderr, _("No hosts loaded. Need at least one host\n"));
779 printf (_("Checking whether given hosts can start testbed. Please wait\n"));
780 hc_handles = GNUNET_malloc (sizeof (struct
781 GNUNET_TESTBED_HostHabitableCheckHandle *)
783 for (nhost = 0; nhost < num_hosts; nhost++)
785 if (NULL == (hc_handles[nhost] = GNUNET_TESTBED_is_host_habitable (hosts[nhost], config,
787 &hc_handles[nhost])))
790 for (nhost = 0; nhost < num_hosts; nhost++)
791 if (NULL != hc_handles[nhost])
792 GNUNET_TESTBED_is_host_habitable_cancel (hc_handles[nhost]);
793 GNUNET_free (hc_handles);
798 if (num_hosts != nhost)
800 fprintf (stderr, _("Exiting\n"));
801 shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
804 cfg = GNUNET_CONFIGURATION_dup (config);
806 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
807 (GNUNET_TIME_UNIT_SECONDS, 5), &do_abort,
813 * Set an option of type 'char *' from the command line.
814 * A pointer to this function should be passed as part of the
815 * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
816 * of this type. It should be followed by a pointer to a value of
819 * @param ctx command line processing context
820 * @param scls additional closure (will point to the 'char *',
821 * which will be allocated)
822 * @param option name of the option
823 * @param value actual value of the option (a string)
824 * @return GNUNET_OK to continue procesing; GNUNET_SYSERR to signal error
827 set_topology (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
828 void *scls, const char *option, const char *value)
830 enum GNUNET_TESTBED_TopologyOption *val = scls;
832 if (0 == strncasecmp ("CLIQUE", value, strlen ("CLIQUE")))
834 *val = GNUNET_TESTBED_TOPOLOGY_CLIQUE;
837 if (0 == strncasecmp ("RANDOM", value, strlen ("RANDOM")))
839 *val = GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI;
842 FPRINTF (stderr, "%s", _("Only `CLIQUE' and `RANDOM' are permitted.\n"));
843 return GNUNET_SYSERR;
850 * @return 0 on success
853 main (int argc, char *const *argv)
855 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
856 { 'p', "num-peers", "COUNT",
857 gettext_noop ("create COUNT number of peers"),
858 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers },
859 { 'n', "num-links", "COUNT",
860 gettext_noop ("create COUNT number of random links"),
861 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_links },
862 { 'e', "num-errors", "COUNT",
863 gettext_noop ("tolerate COUNT number of continious timeout failures"),
864 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_cont_fails },
865 { 't', "topology", "TOPOLOGY",
866 gettext_noop ("Try to acheive TOPOLOGY. This options takes either CLIQUE "
867 "or RANDOM. For CLIQUE the parameter -n is ignored. The "
868 "default is to acheive a random graph topology."),
869 GNUNET_YES, &set_topology, &topology },
870 GNUNET_GETOPT_OPTION_END
874 topology = GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI;
875 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
878 result = GNUNET_SYSERR;
880 GNUNET_PROGRAM_run (argc, argv, "gnunet-testbed-profiler [OPTIONS] hosts-file",
881 _("Profiler for testbed"),
882 options, &run, NULL);
883 GNUNET_free ((void*) argv);
884 if (GNUNET_OK != ret)
886 if (GNUNET_OK != result)