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_testbed_service.h"
30 #include "testbed_api_hosts.h"
33 * Generic loggins shorthand
35 #define LOG(kind,...) \
36 GNUNET_log_from (kind, "testbed-api-testbed", __VA_ARGS__)
44 * The testbed operation handle
46 struct GNUNET_TESTBED_Operation *op;
54 * The next pointer for DLL
56 struct DLLOperation *next;
59 * The prev pointer for DLL
61 struct DLLOperation *prev;
66 * Availanle states during profiling
78 STATE_SLAVES_STARTING,
88 * An array of hosts loaded from the hostkeys file
90 static struct GNUNET_TESTBED_Host **hosts;
93 * The array of peers; we fill this as the peers are given to us by the testbed
95 static struct GNUNET_TESTBED_Peer **peers;
98 /* * Operation handle */
100 /* static struct GNUNET_TESTBED_Operation *op; */
103 * Host registration handle
105 static struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
108 * Handle to the master controller process
110 struct GNUNET_TESTBED_ControllerProc *mc_proc;
113 * Handle to the master controller
115 struct GNUNET_TESTBED_Controller *mc;
118 * Handle to global configuration
120 struct GNUNET_CONFIGURATION_Handle *cfg;
123 * Head of the operations list
125 struct DLLOperation *dll_op_head;
128 * Tail of the operations list
130 struct DLLOperation *dll_op_tail;
133 * Abort task identifier
135 static GNUNET_SCHEDULER_TaskIdentifier abort_task;
138 * Host registration task identifier
140 static GNUNET_SCHEDULER_TaskIdentifier register_hosts_task;
143 * Global event mask for all testbed events
148 * The starting time of a profiling step
150 struct GNUNET_TIME_Absolute prof_start_time;
153 * Duration profiling step has taken
155 struct GNUNET_TIME_Relative prof_time;
160 unsigned int peer_id;
163 * Number of peers to be started by the profiler
165 static unsigned int num_peers;
168 * Number of hosts in the hosts array
170 static unsigned int num_hosts;
173 * Global testing status
178 * current state of profiling
187 * @param tc the task context
190 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
192 struct DLLOperation *dll_op;
194 unsigned int peer_cnt;
196 if (GNUNET_SCHEDULER_NO_TASK != abort_task)
197 GNUNET_SCHEDULER_cancel (abort_task);
198 if (GNUNET_SCHEDULER_NO_TASK != register_hosts_task)
199 GNUNET_SCHEDULER_cancel (register_hosts_task);
202 for (peer_cnt = 0; peer_cnt < num_peers; peer_cnt++)
203 if (NULL != peers[peer_cnt])
204 GNUNET_TESTBED_peer_destroy (peers[peer_cnt]);
207 if (NULL != reg_handle)
208 GNUNET_TESTBED_cancel_registration (reg_handle);
209 for (nhost = 0; nhost < num_hosts; nhost++)
210 if (NULL != hosts[nhost])
211 GNUNET_TESTBED_host_destroy (hosts[nhost]);
212 GNUNET_free_non_null (hosts);
213 while (NULL != (dll_op = dll_op_head))
215 GNUNET_TESTBED_operation_cancel (dll_op->op);
216 GNUNET_free_non_null (dll_op->cls);
217 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
218 GNUNET_free (dll_op);
221 GNUNET_TESTBED_controller_disconnect (mc);
223 GNUNET_TESTBED_controller_stop (mc_proc);
225 GNUNET_CONFIGURATION_destroy (cfg);
226 GNUNET_SCHEDULER_shutdown (); /* Stop scheduler to shutdown testbed run */
231 * abort task to run on test timed out
234 * @param tc the task context
237 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
239 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Aborting\n");
240 abort_task = GNUNET_SCHEDULER_NO_TASK;
241 result = GNUNET_SYSERR;
242 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
247 * Functions of this signature are called when a peer has been successfully
250 * @param cls the closure from GNUNET_TESTBED_peer_create()
251 * @param peer the handle for the created peer; NULL on any error during
253 * @param emsg NULL if peer is not NULL; else MAY contain the error description
256 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
258 struct DLLOperation *dll_op = cls;
259 struct GNUNET_TESTBED_Peer **peer_ptr;
260 static unsigned int created_peers;
264 LOG (GNUNET_ERROR_TYPE_WARNING,
265 _("Creating a peer failed. Error: %s\n"), emsg);
266 GNUNET_TESTBED_operation_done (dll_op->op);
267 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
268 GNUNET_free (dll_op);
269 GNUNET_SCHEDULER_cancel (abort_task);
270 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
273 peer_ptr = dll_op->cls;
274 GNUNET_assert (NULL == *peer_ptr);
276 GNUNET_TESTBED_operation_done (dll_op->op);
277 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
278 GNUNET_free (dll_op);
279 if (++created_peers == num_peers)
281 prof_time = GNUNET_TIME_absolute_get_duration (prof_start_time);
282 printf ("All peers created successfully in %.2f seconds\n",
283 ((double) prof_time.rel_value) / 1000.00);
284 /* Now peers are to be started */
290 * Controller event callback
293 * @param event the controller event
296 controller_event_cb (void *cls,
297 const struct GNUNET_TESTBED_EventInformation *event)
299 struct DLLOperation *dll_op;
300 struct GNUNET_TESTBED_Operation *op;
304 case STATE_SLAVES_STARTING:
307 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
309 static unsigned int slaves_started;
310 unsigned int peer_cnt;
312 dll_op = event->details.operation_finished.op_cls;
313 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
314 GNUNET_free (dll_op);
315 op = event->details.operation_finished.operation;
316 if (NULL != event->details.operation_finished.emsg)
318 LOG (GNUNET_ERROR_TYPE_WARNING,
319 _("An operation has failed while starting slaves\n"));
320 GNUNET_TESTBED_operation_done (op);
321 GNUNET_SCHEDULER_cancel (abort_task);
322 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
325 GNUNET_TESTBED_operation_done (op);
326 /* Proceed to start peers */
327 if (++slaves_started == num_hosts - 1)
329 printf ("All slaves started successfully\n");
330 state = STATE_PEERS_CREATING;
331 prof_start_time = GNUNET_TIME_absolute_get ();
332 peers = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Peer *)
334 for (peer_cnt = 0; peer_cnt < num_peers; peer_cnt++)
336 dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
337 dll_op->cls = &peers[peer_cnt];
338 dll_op->op = GNUNET_TESTBED_peer_create (mc,
340 [peer_cnt % num_peers],
344 GNUNET_CONTAINER_DLL_insert_tail (dll_op_head, dll_op_tail, dll_op);
360 * Task to register all hosts available in the global host list
363 * @param tc the scheduler task context
366 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
370 * Callback which will be called to after a host registration succeeded or failed
372 * @param cls the closure
373 * @param emsg the error message; NULL if host registration is successful
376 host_registration_completion (void *cls, const char *emsg)
381 LOG (GNUNET_ERROR_TYPE_WARNING,
382 _("Host registration failed for a host. Error: %s\n"), emsg);
383 GNUNET_SCHEDULER_cancel (abort_task);
384 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
387 register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts, NULL);
392 * Task to register all hosts available in the global host list
395 * @param tc the scheduler task context
398 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
400 struct DLLOperation *dll_op;
401 static unsigned int reg_host;
404 register_hosts_task = GNUNET_SCHEDULER_NO_TASK;
405 if (reg_host == num_hosts - 1)
407 LOG (GNUNET_ERROR_TYPE_DEBUG,
408 "All hosts successfully registered\n");
410 state = STATE_SLAVES_STARTING;
411 for (slave = 1; slave < num_hosts; slave++)
413 dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
414 dll_op->op = GNUNET_TESTBED_controller_link (dll_op,
420 GNUNET_CONTAINER_DLL_insert_tail (dll_op_head, dll_op_tail, dll_op);
424 reg_handle = GNUNET_TESTBED_register_host (mc, hosts[++reg_host],
425 host_registration_completion,
431 * Callback to signal successfull startup of the controller process
433 * @param cls the closure from GNUNET_TESTBED_controller_start()
434 * @param cfg the configuration with which the controller has been started;
435 * NULL if status is not GNUNET_OK
436 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
437 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
440 status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *config, int status)
442 GNUNET_SCHEDULER_cancel (abort_task);
443 if (GNUNET_OK != status)
446 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
450 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
451 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_STOP);
452 event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
453 event_mask |= (1LL << GNUNET_TESTBED_ET_DISCONNECT);
454 event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
455 mc = GNUNET_TESTBED_controller_connect (config, hosts[0], event_mask,
456 &controller_event_cb, NULL);
459 LOG (GNUNET_ERROR_TYPE_WARNING,
460 _("Unable to connect to master controller -- Check config\n"));
461 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
464 register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts, NULL);
465 abort_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
471 * Main function that will be run by the scheduler.
474 * @param args remaining command-line arguments
475 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
476 * @param cfg configuration
479 run (void *cls, char *const *args, const char *cfgfile,
480 const struct GNUNET_CONFIGURATION_Handle *config)
486 fprintf (stderr, _("No hosts-file specified on command line\n"));
494 num_hosts = GNUNET_TESTBED_hosts_load_from_file (args[0], &hosts);
497 fprintf (stderr, _("No hosts loaded. Need atleast one host\n"));
500 for (nhost = 0; nhost < num_hosts; nhost++)
502 if (GNUNET_YES != GNUNET_TESTBED_is_host_habitable (hosts[nhost]))
504 fprintf (stderr, _("Host %s cannot start testbed\n"),
505 GNUNET_TESTBED_host_get_hostname_ (hosts[nhost]));
509 if (num_hosts != nhost)
511 fprintf (stderr, _("Exiting\n"));
512 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
515 cfg = GNUNET_CONFIGURATION_dup (config);
517 GNUNET_TESTBED_controller_start (GNUNET_TESTBED_host_get_hostname_
524 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
525 (GNUNET_TIME_UNIT_SECONDS, 5), &do_abort,
533 * @return 0 on success
536 main (int argc, char *const *argv)
538 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
539 { 'n', "num-peers", "COUNT",
540 gettext_noop ("create COUNT number of peers"),
541 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers },
542 { 'n', "num-peers", "COUNT",
543 gettext_noop ("create COUNT number of peers"),
544 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers },
545 GNUNET_GETOPT_OPTION_END
549 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
552 result = GNUNET_SYSERR;
554 GNUNET_PROGRAM_run (argc, argv, "gnunet-testbed-profiler [OPTIONS] hosts-file",
555 _("Profiler for testbed"),
556 options, &run, NULL);
557 if (GNUNET_OK != ret)
559 if (GNUNET_OK != result)