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 regex/gnunet-regex-profiler.c
23 * @brief Regex profiler for testing distributed regex use.
31 #include "gnunet_applications.h"
32 #include "gnunet_util_lib.h"
33 #include "gnunet_mesh_service.h"
34 #include "gnunet_stream_lib.h"
35 #include "gnunet_testbed_service.h"
43 * The testbed operation handle
45 struct GNUNET_TESTBED_Operation *op;
53 * The next pointer for DLL
55 struct DLLOperation *next;
58 * The prev pointer for DLL
60 struct DLLOperation *prev;
65 * Available states during profiling
77 STATE_SLAVES_STARTING,
95 * Destroying peers; we can do this as the controller takes care of stopping a
96 * peer if it is running
98 STATE_PEERS_DESTROYING
103 * An array of hosts loaded from the hostkeys file
105 static struct GNUNET_TESTBED_Host **hosts;
113 * The actual testbed peer handle.
115 struct GNUNET_TESTBED_Peer *peer_handle;
118 * Peer's mesh handle.
120 struct GNUNET_MESH_Handle *mesh_handle;
123 * Host on which the peer is running.
125 struct GNUNET_TESTBED_Host *host_handle;
128 * Testbed operation handle.
130 struct GNUNET_TESTBED_Operation *op_handle;
134 * Array of peer handles used to pass to
135 * GNUNET_TESTBED_overlay_configure_topology
137 struct GNUNET_TESTBED_Peer **peer_handles;
140 * The array of peers; we fill this as the peers are given to us by the testbed
142 static struct Peer *peers;
145 * Host registration handle
147 static struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
150 * Handle to the master controller process
152 struct GNUNET_TESTBED_ControllerProc *mc_proc;
155 * Handle to the master controller
157 struct GNUNET_TESTBED_Controller *mc;
160 * Handle to global configuration
162 struct GNUNET_CONFIGURATION_Handle *cfg;
165 * Head of the operations list
167 struct DLLOperation *dll_op_head;
170 * Tail of the operations list
172 struct DLLOperation *dll_op_tail;
175 * Peer linking - topology operation
177 struct GNUNET_TESTBED_Operation *topology_op;
180 * Abort task identifier
182 static GNUNET_SCHEDULER_TaskIdentifier abort_task;
185 * Host registration task identifier
187 static GNUNET_SCHEDULER_TaskIdentifier register_hosts_task;
190 * Global event mask for all testbed events
195 * The starting time of a profiling step
197 struct GNUNET_TIME_Absolute prof_start_time;
200 * Duration profiling step has taken
202 struct GNUNET_TIME_Relative prof_time;
207 unsigned int peer_id;
210 * Number of peers to be started by the profiler
212 static unsigned int num_peers;
215 * Number of hosts in the hosts array
217 static unsigned int num_hosts;
220 * Number of random links to be established between peers
222 static unsigned int num_links;
225 * Global testing status
230 * current state of profiling
239 * @param tc the task context
242 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
244 struct DLLOperation *dll_op;
247 if (GNUNET_SCHEDULER_NO_TASK != abort_task)
248 GNUNET_SCHEDULER_cancel (abort_task);
249 if (GNUNET_SCHEDULER_NO_TASK != register_hosts_task)
250 GNUNET_SCHEDULER_cancel (register_hosts_task);
251 if (NULL != reg_handle)
252 GNUNET_TESTBED_cancel_registration (reg_handle);
253 if (NULL != topology_op)
254 GNUNET_TESTBED_operation_cancel (topology_op);
255 for (nhost = 0; nhost < num_hosts; nhost++)
256 if (NULL != hosts[nhost])
257 GNUNET_TESTBED_host_destroy (hosts[nhost]);
258 GNUNET_free_non_null (hosts);
259 while (NULL != (dll_op = dll_op_head))
261 GNUNET_TESTBED_operation_cancel (dll_op->op);
262 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
263 GNUNET_free (dll_op);
266 GNUNET_TESTBED_controller_disconnect (mc);
268 GNUNET_TESTBED_controller_stop (mc_proc);
270 GNUNET_CONFIGURATION_destroy (cfg);
272 //FIXME GNUNET_MESH_disconnect (peers[i].mesh_handle);
274 GNUNET_SCHEDULER_shutdown (); /* Stop scheduler to shutdown testbed run */
279 * abort task to run on test timed out
282 * @param tc the task context
285 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
287 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Aborting\n");
288 abort_task = GNUNET_SCHEDULER_NO_TASK;
289 result = GNUNET_SYSERR;
290 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
295 * Method called whenever another peer has added us to a tunnel
296 * the other peer initiated.
297 * Only called (once) upon reception of data with a message type which was
298 * subscribed to in GNUNET_MESH_connect. A call to GNUNET_MESH_tunnel_destroy
299 * causes te tunnel to be ignored and no further notifications are sent about
303 * @param tunnel new handle to the tunnel
304 * @param initiator peer that started the tunnel
305 * @param atsi performance information for the tunnel
306 * @return initial tunnel context for the tunnel
307 * (can be NULL -- that's not an error)
310 mesh_inbound_tunnel_handler (void *cls, struct GNUNET_MESH_Tunnel *tunnel,
311 const struct GNUNET_PeerIdentity *initiator,
312 const struct GNUNET_ATS_Information *atsi)
319 * Function called whenever an inbound tunnel is destroyed. Should clean up
320 * any associated state. This function is NOT called if the client has
321 * explicitly asked for the tunnel to be destroyed using
322 * GNUNET_MESH_tunnel_destroy. It must NOT call GNUNET_MESH_tunnel_destroy on
325 * @param cls closure (set from GNUNET_MESH_connect)
326 * @param tunnel connection to the other end (henceforth invalid)
327 * @param tunnel_ctx place where local state associated
328 * with the tunnel is stored
331 mesh_tunnel_end_handler (void *cls, const struct GNUNET_MESH_Tunnel *tunnel,
339 * Mesh connect callback.
341 * @param cls internal peer id.
342 * @param op operation handle.
343 * @param ca_result connect adapter result.
344 * @param emsg error message.
347 mesh_connect_cb (void *cls, struct GNUNET_TESTBED_Operation *op,
348 void *ca_result, const char *emsg)
350 struct Peer *peer = (struct Peer *) cls;
354 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Mesh connect failed: %s\n", emsg);
358 GNUNET_assert (peer->op_handle == op);
359 GNUNET_assert (peer->mesh_handle == ca_result);
361 GNUNET_TESTBED_operation_done (op);
363 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh connect callback for peer\n");
365 //GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
370 * Mesh connect adapter.
372 * @param cls not used.
373 * @param cfg configuration handle.
378 mesh_ca (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
381 struct Peer *peer = (struct Peer *) cls;
383 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh connect adapter\n");
385 static struct GNUNET_MESH_MessageHandler handlers[] = {
389 static GNUNET_MESH_ApplicationType apptypes[] = {
390 GNUNET_APPLICATION_TYPE_END
394 GNUNET_MESH_connect (cfg, cls, &mesh_inbound_tunnel_handler,
395 &mesh_tunnel_end_handler, handlers, apptypes);
397 return peer->mesh_handle;
402 * Adapter function called to destroy a connection to
406 * @param op_result service handle returned from the connect adapter
409 mesh_da (void *cls, void *op_result)
411 struct Peer *peer = (struct Peer *) cls;
413 GNUNET_assert (peer->mesh_handle == op_result);
415 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh disconnect adapter\n");
420 * Functions of this signature are called when a peer has been successfully
421 * started or stopped.
423 * @param cls the closure from GNUNET_TESTBED_peer_start/stop()
424 * @param emsg NULL on success; otherwise an error description
427 peer_churn_cb (void *cls, const char *emsg)
429 struct DLLOperation *dll_op = cls;
430 struct GNUNET_TESTBED_Operation *op;
431 static unsigned int started_peers;
432 unsigned int peer_cnt;
435 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
436 GNUNET_free (dll_op);
439 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
440 _("An operation has failed while starting peers\n"));
441 GNUNET_TESTBED_operation_done (op);
442 GNUNET_SCHEDULER_cancel (abort_task);
443 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
446 GNUNET_TESTBED_operation_done (op);
447 if (++started_peers == num_peers)
449 prof_time = GNUNET_TIME_absolute_get_duration (prof_start_time);
450 printf ("All peers started successfully in %.2f seconds\n",
451 ((double) prof_time.rel_value) / 1000.00);
455 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
459 peer_handles = GNUNET_malloc (sizeof (struct GNUNET_TESTBED_Peer *) * num_peers);
460 for (peer_cnt = 0; peer_cnt < num_peers; peer_cnt++)
461 peer_handles[peer_cnt] = peers[peer_cnt].peer_handle;
463 state = STATE_PEERS_LINKING;
464 /* Do overlay connect */
465 prof_start_time = GNUNET_TIME_absolute_get ();
467 GNUNET_TESTBED_overlay_configure_topology (NULL, num_peers, peer_handles,
468 GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI,
470 if (NULL == topology_op)
472 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
473 "Cannot create topology, op handle was NULL\n");
481 * Functions of this signature are called when a peer has been successfully
484 * @param cls the closure from GNUNET_TESTBED_peer_create()
485 * @param peer the handle for the created peer; NULL on any error during
487 * @param emsg NULL if peer is not NULL; else MAY contain the error description
490 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
492 struct DLLOperation *dll_op = cls;
493 struct Peer *peer_ptr;
494 static unsigned int created_peers;
495 unsigned int peer_cnt;
499 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
500 _("Creating a peer failed. Error: %s\n"), emsg);
501 GNUNET_TESTBED_operation_done (dll_op->op);
502 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
503 GNUNET_free (dll_op);
504 GNUNET_SCHEDULER_cancel (abort_task);
505 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
509 peer_ptr = dll_op->cls;
510 GNUNET_assert (NULL == peer_ptr->peer_handle);
511 peer_ptr->peer_handle = peer;
512 GNUNET_TESTBED_operation_done (dll_op->op);
513 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
514 GNUNET_free (dll_op);
516 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %i created on host %s\n",
518 GNUNET_TESTBED_host_get_hostname (peer_ptr->host_handle));
520 if (++created_peers == num_peers)
522 prof_time = GNUNET_TIME_absolute_get_duration (prof_start_time);
523 printf ("All peers created successfully in %.2f seconds\n",
524 ((double) prof_time.rel_value) / 1000.00);
525 /* Now peers are to be started */
526 state = STATE_PEERS_STARTING;
527 prof_start_time = GNUNET_TIME_absolute_get ();
528 for (peer_cnt = 0; peer_cnt < num_peers; peer_cnt++)
530 dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
531 dll_op->op = GNUNET_TESTBED_peer_start (dll_op, peers[peer_cnt].peer_handle,
532 &peer_churn_cb, dll_op);
533 GNUNET_CONTAINER_DLL_insert_tail (dll_op_head, dll_op_tail, dll_op);
540 * Controller event callback
543 * @param event the controller event
546 controller_event_cb (void *cls,
547 const struct GNUNET_TESTBED_EventInformation *event)
549 struct DLLOperation *dll_op;
550 struct GNUNET_TESTBED_Operation *op;
554 case STATE_SLAVES_STARTING:
557 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
559 static unsigned int slaves_started;
560 unsigned int peer_cnt;
562 dll_op = event->details.operation_finished.op_cls;
563 GNUNET_CONTAINER_DLL_remove (dll_op_head, dll_op_tail, dll_op);
564 GNUNET_free (dll_op);
565 op = event->details.operation_finished.operation;
566 if (NULL != event->details.operation_finished.emsg)
568 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
569 _("An operation has failed while starting slaves\n"));
570 GNUNET_TESTBED_operation_done (op);
571 GNUNET_SCHEDULER_cancel (abort_task);
572 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
575 GNUNET_TESTBED_operation_done (op);
576 /* Proceed to start peers */
577 if (++slaves_started == num_hosts - 1)
579 printf ("All slaves started successfully\n");
580 state = STATE_PEERS_CREATING;
581 prof_start_time = GNUNET_TIME_absolute_get ();
582 peers = GNUNET_malloc (sizeof (struct Peer) * num_peers);
583 for (peer_cnt = 0; peer_cnt < num_peers; peer_cnt++)
585 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating peer %i on host %s\n",
587 GNUNET_TESTBED_host_get_hostname (hosts[peer_cnt % num_hosts]));
589 peers[peer_cnt].host_handle = hosts[peer_cnt % num_hosts];
591 dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
592 dll_op->cls = &peers[peer_cnt];
593 dll_op->op = GNUNET_TESTBED_peer_create (mc,
594 hosts[peer_cnt % num_hosts],
598 GNUNET_CONTAINER_DLL_insert_tail (dll_op_head, dll_op_tail, dll_op);
607 case STATE_PEERS_STARTING:
610 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
611 /* Control reaches here when peer start fails */
612 case GNUNET_TESTBED_ET_PEER_START:
613 /* we handle peer starts in peer_churn_cb */
619 case STATE_PEERS_LINKING:
622 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
623 /* Control reaches here when a peer linking operation fails */
624 if (NULL != event->details.operation_finished.emsg)
626 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
627 _("An operation has failed while linking\n"));
628 GNUNET_SCHEDULER_cancel (abort_task);
629 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
632 case GNUNET_TESTBED_ET_CONNECT:
634 static unsigned int established_links;
635 unsigned int peer_cnt;
637 if (0 == established_links)
638 printf ("Establishing links\n .");
644 if (++established_links == num_links)
646 prof_time = GNUNET_TIME_absolute_get_duration (prof_start_time);
647 printf ("\n%u links established in %.2f seconds\n",
648 num_links, ((double) prof_time.rel_value) / 1000.00);
650 GNUNET_free (peer_handles);
651 printf ("\nConnecting to mesh service...\n");
652 for (peer_cnt = 0; peer_cnt < num_peers; peer_cnt++)
654 peers[peer_cnt].op_handle = GNUNET_TESTBED_service_connect (NULL,
655 peers[peer_cnt].peer_handle,
677 * Task to register all hosts available in the global host list
680 * @param tc the scheduler task context
683 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
687 * Callback which will be called to after a host registration succeeded or failed
689 * @param cls the closure
690 * @param emsg the error message; NULL if host registration is successful
693 host_registration_completion (void *cls, const char *emsg)
698 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
699 _("Host registration failed for a host. Error: %s\n"), emsg);
700 GNUNET_SCHEDULER_cancel (abort_task);
701 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
704 register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts, NULL);
709 * Task to register all hosts available in the global host list
712 * @param tc the scheduler task context
715 register_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
717 struct DLLOperation *dll_op;
718 static unsigned int reg_host;
721 register_hosts_task = GNUNET_SCHEDULER_NO_TASK;
722 if (reg_host == num_hosts - 1)
724 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
725 "All hosts successfully registered\n");
727 state = STATE_SLAVES_STARTING;
728 for (slave = 1; slave < num_hosts; slave++)
730 dll_op = GNUNET_malloc (sizeof (struct DLLOperation));
731 dll_op->op = GNUNET_TESTBED_controller_link (dll_op,
737 GNUNET_CONTAINER_DLL_insert_tail (dll_op_head, dll_op_tail, dll_op);
741 reg_handle = GNUNET_TESTBED_register_host (mc, hosts[++reg_host],
742 host_registration_completion,
748 * Callback to signal successfull startup of the controller process
750 * @param cls the closure from GNUNET_TESTBED_controller_start()
751 * @param cfg the configuration with which the controller has been started;
752 * NULL if status is not GNUNET_OK
753 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
754 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
757 status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *config, int status)
759 GNUNET_SCHEDULER_cancel (abort_task);
760 if (GNUNET_OK != status)
763 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
767 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
768 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_STOP);
769 event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
770 event_mask |= (1LL << GNUNET_TESTBED_ET_DISCONNECT);
771 event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
772 mc = GNUNET_TESTBED_controller_connect (config, hosts[0], event_mask,
773 &controller_event_cb, NULL);
776 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
777 _("Unable to connect to master controller -- Check config\n"));
778 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
781 register_hosts_task = GNUNET_SCHEDULER_add_now (®ister_hosts, NULL);
782 abort_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
788 * Main function that will be run by the scheduler.
791 * @param args remaining command-line arguments
792 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
793 * @param config configuration
796 run (void *cls, char *const *args, const char *cfgfile,
797 const struct GNUNET_CONFIGURATION_Handle *config)
803 fprintf (stderr, _("No hosts-file specified on command line\n"));
811 num_hosts = GNUNET_TESTBED_hosts_load_from_file (args[0], &hosts);
814 fprintf (stderr, _("No hosts loaded. Need at least one host\n"));
817 for (nhost = 0; nhost < num_hosts; nhost++)
819 if (GNUNET_YES != GNUNET_TESTBED_is_host_habitable (hosts[nhost]))
821 fprintf (stderr, _("Host %s cannot start testbed\n"),
822 GNUNET_TESTBED_host_get_hostname (hosts[nhost]));
826 if (num_hosts != nhost)
828 fprintf (stderr, _("Exiting\n"));
829 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
834 fprintf (stderr, _("No configuration file given. Exiting\n"));
835 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
839 cfg = GNUNET_CONFIGURATION_dup (config);
841 GNUNET_TESTBED_controller_start (GNUNET_TESTBED_host_get_hostname
848 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
849 (GNUNET_TIME_UNIT_SECONDS, 5), &do_abort,
857 * @return 0 on success
860 main (int argc, char *const *argv)
862 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
863 { 'p', "num-peers", "COUNT",
864 gettext_noop ("create COUNT number of peers"),
865 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers },
866 { 'n', "num-links", "COUNT",
867 gettext_noop ("create COUNT number of random links"),
868 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_links },
869 GNUNET_GETOPT_OPTION_END
873 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
876 result = GNUNET_SYSERR;
878 GNUNET_PROGRAM_run (argc, argv, "gnunet-regex-profiler [OPTIONS] hosts-file",
879 _("Profiler for regex/mesh"),
880 options, &run, NULL);
881 if (GNUNET_OK != ret)
883 if (GNUNET_OK != result)