2 This file is part of GNUnet.
3 Copyright (C) 2008--2013 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file testbed/gnunet-testbed-profiler.c
23 * @brief Profiling driver for the testbed.
24 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
28 #include "gnunet_util_lib.h"
29 #include "gnunet_testbed_service.h"
30 #include "testbed_api_hosts.h"
33 * Generic loggins shorthand
35 #define LOG(kind,...) \
36 GNUNET_log (kind, __VA_ARGS__)
40 * Handle to global configuration
42 struct GNUNET_CONFIGURATION_Handle *cfg;
45 * Peer linking - topology operation
47 struct GNUNET_TESTBED_Operation *topology_op;
50 * Name of the file with the hosts to run the test over (configuration option).
51 * It will be NULL if ENABLE_LL is set
53 static char *hosts_file;
56 * Abort task identifier
58 static struct GNUNET_SCHEDULER_Task *abort_task;
61 * Global event mask for all testbed events
66 * Number of peers to be started by the profiler
68 static unsigned int num_peers;
71 * Number of timeout failures to tolerate
73 static unsigned int num_cont_fails;
76 * Continuous failures during overlay connect operations
78 static unsigned int cont_fails;
81 * Links which are successfully established
83 static unsigned int established_links;
86 * Links which are not successfully established
88 static unsigned int failed_links;
91 * Global testing status
96 * Are we running non interactively
98 static int noninteractive;
107 do_shutdown (void *cls)
109 if (NULL != abort_task)
111 GNUNET_SCHEDULER_cancel (abort_task);
116 GNUNET_CONFIGURATION_destroy (cfg);
123 * abort task to run on test timed out
131 LOG (GNUNET_ERROR_TYPE_WARNING,
133 result = GNUNET_SYSERR;
134 GNUNET_SCHEDULER_shutdown ();
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 if (NULL != abort_task)
179 GNUNET_SCHEDULER_cancel (abort_task);
180 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
185 case GNUNET_TESTBED_ET_CONNECT:
189 if (0 == established_links)
190 printf ("Establishing links. Please wait\n");
203 * Signature of a main function for a testcase.
206 * @param h the run handle
207 * @param num_peers number of peers in 'peers'
208 * @param peers handle to peers run in the testbed
209 * @param links_succeeded the number of overlay link connection attempts that
211 * @param links_failed the number of overlay link
215 struct GNUNET_TESTBED_RunHandle *h,
216 unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers,
217 unsigned int links_succeeded,
218 unsigned int links_failed)
221 fprintf (stdout, "\n");
222 print_overlay_links_summary ();
223 GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
226 GNUNET_SCHEDULER_cancel (abort_task);
230 #if (!ENABLE_SUPERMUC)
231 fprintf (stdout, "Testbed running, waiting for keystroke to shut down\n");
235 fprintf (stdout, "Shutting down. Please wait\n");
237 GNUNET_SCHEDULER_shutdown ();
242 * Main function that will be run by the scheduler.
245 * @param args remaining command-line arguments
246 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
247 * @param config configuration
250 run (void *cls, char *const *args, const char *cfgfile,
251 const struct GNUNET_CONFIGURATION_Handle *config)
255 LOG (GNUNET_ERROR_TYPE_ERROR, _("Exiting as the number of peers is %u\n"),
259 cfg = GNUNET_CONFIGURATION_dup (config);
261 event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
262 event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
263 GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask, controller_event_cb,
264 NULL, &test_run, NULL);
266 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_abort,
274 * @return 0 on success
277 main (int argc, char *const *argv)
279 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
280 {'p', "num-peers", "COUNT",
281 gettext_noop ("create COUNT number of peers"),
282 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers},
283 {'e', "num-errors", "COUNT",
284 gettext_noop ("tolerate COUNT number of continious timeout failures"),
285 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_cont_fails},
286 {'n', "non-interactive", NULL,
287 gettext_noop ("run profiler in non-interactive mode where upon "
288 "testbed setup the profiler does not wait for a "
289 "keystroke but continues to run until a termination "
290 "signal is received"),
291 GNUNET_NO, &GNUNET_GETOPT_set_one, &noninteractive},
293 {'H', "hosts", "FILENAME",
294 gettext_noop ("name of the file with the login information for the testbed"),
295 GNUNET_YES, &GNUNET_GETOPT_set_string, &hosts_file},
297 GNUNET_GETOPT_OPTION_END
299 const char *binaryHelp = "gnunet-testbed-profiler [OPTIONS]";
302 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
304 result = GNUNET_SYSERR;
306 GNUNET_PROGRAM_run (argc, argv, "gnunet-testbed-profiler", binaryHelp,
307 options, &run, NULL);
308 GNUNET_free ((void *) argv);
309 if (GNUNET_OK != ret)
311 if (GNUNET_OK != result)