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__)
41 * Handle to global configuration
43 struct GNUNET_CONFIGURATION_Handle *cfg;
46 * Peer linking - topology operation
48 struct GNUNET_TESTBED_Operation *topology_op;
51 * Name of the file with the hosts to run the test over (configuration option).
52 * It will be NULL if ENABLE_LL is set
54 static char *hosts_file;
57 * Abort task identifier
59 static GNUNET_SCHEDULER_TaskIdentifier abort_task;
62 * Shutdown task identifier
64 static GNUNET_SCHEDULER_TaskIdentifier shutdown_task;
67 * Global event mask for all testbed events
72 * Number of peers to be started by the profiler
74 static unsigned int num_peers;
77 * Number of timeout failures to tolerate
79 static unsigned int num_cont_fails;
82 * Continuous failures during overlay connect operations
84 static unsigned int cont_fails;
87 * Links which are successfully established
89 static unsigned int established_links;
92 * Links which are not successfully established
94 static unsigned int failed_links;
97 * Global testing status
106 * @param tc the task context
109 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
111 shutdown_task = GNUNET_SCHEDULER_NO_TASK;
112 if (GNUNET_SCHEDULER_NO_TASK != abort_task)
113 GNUNET_SCHEDULER_cancel (abort_task);
115 GNUNET_CONFIGURATION_destroy (cfg);
116 GNUNET_SCHEDULER_shutdown (); /* Stop scheduler to shutdown testbed run */
121 * abort task to run on test timed out
124 * @param tc the task context
127 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
129 LOG (GNUNET_ERROR_TYPE_WARNING, "Aborting\n");
130 abort_task = GNUNET_SCHEDULER_NO_TASK;
131 result = GNUNET_SYSERR;
132 if (GNUNET_SCHEDULER_NO_TASK != shutdown_task)
133 GNUNET_SCHEDULER_cancel (shutdown_task);
134 shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
139 * Function to print summary about how many overlay links we have made and how
143 print_overlay_links_summary ()
145 static int printed_already;
147 if (GNUNET_YES == printed_already)
149 printed_already = GNUNET_YES;
150 printf ("%u links succeeded\n", established_links);
151 printf ("%u links failed due to timeouts\n", failed_links);
156 * Controller event callback
159 * @param event the controller event
162 controller_event_cb (void *cls,
163 const struct GNUNET_TESTBED_EventInformation *event)
167 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
168 /* Control reaches here when a peer linking operation fails */
169 if (NULL != event->details.operation_finished.emsg)
174 if (++cont_fails > num_cont_fails)
176 printf ("\nAborting due to very high failure rate\n");
177 print_overlay_links_summary ();
178 GNUNET_SCHEDULER_cancel (abort_task);
179 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
184 case GNUNET_TESTBED_ET_CONNECT:
188 if (0 == established_links)
189 printf ("Establishing links. Please wait\n");
202 * Signature of a main function for a testcase.
205 * @param num_peers number of peers in 'peers'
206 * @param peers handle to peers run in the testbed
207 * @param links_succeeded the number of overlay link connection attempts that
209 * @param links_failed the number of overlay link
212 test_run (void *cls, unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers,
213 unsigned int links_succeeded,
214 unsigned int links_failed)
217 fprintf (stdout, "\n");
218 print_overlay_links_summary ();
219 fprintf (stdout, "Testbed running, waiting for keystroke to shut down\n");
222 fprintf (stdout, "Shutting down. Please wait\n");
224 shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
229 * Main function that will be run by the scheduler.
232 * @param args remaining command-line arguments
233 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
234 * @param config configuration
237 run (void *cls, char *const *args, const char *cfgfile,
238 const struct GNUNET_CONFIGURATION_Handle *config)
242 LOG (GNUNET_ERROR_TYPE_ERROR, _("Exiting as the number of peers is %u\n"),
246 cfg = GNUNET_CONFIGURATION_dup (config);
248 event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
249 event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
250 GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask, controller_event_cb,
251 NULL, &test_run, NULL);
253 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_abort,
261 * @return 0 on success
264 main (int argc, char *const *argv)
266 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
267 {'p', "num-peers", "COUNT",
268 gettext_noop ("create COUNT number of peers"),
269 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers},
270 {'e', "num-errors", "COUNT",
271 gettext_noop ("tolerate COUNT number of continious timeout failures"),
272 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_cont_fails},
274 {'H', "hosts", "FILENAME",
275 gettext_noop ("name of the file with the login information for the testbed"),
276 GNUNET_YES, &GNUNET_GETOPT_set_string, &hosts_file},
278 GNUNET_GETOPT_OPTION_END
280 const char *binaryHelp = "gnunet-testbed-profiler [OPTIONS]";
283 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
285 result = GNUNET_SYSERR;
287 GNUNET_PROGRAM_run (argc, argv, "gnunet-testbed-profiler", binaryHelp,
288 options, &run, NULL);
289 GNUNET_free ((void *) argv);
290 if (GNUNET_OK != ret)
292 if (GNUNET_OK != result)