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.
21 * @file nse/gnunet-nse-profiler.c
23 * @brief Profiling driver for the network size estimation service.
24 * Generally, the profiler starts a given number of peers,
25 * then churns some off, waits a certain amount of time, then
26 * churns again, and repeats.
27 * @author Christian Grothoff
28 * @author Nathan Evans
29 * @author Sree Harsha Totakura
33 #include "gnunet_testbed_service.h"
34 #include "gnunet_nse_service.h"
37 * Generic loggins shorthand
39 #define LOG(kind,...) \
40 GNUNET_log (kind, __VA_ARGS__)
43 * Debug logging shorthand
45 #define LOG_DEBUG(...) \
46 LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
50 * Information we track for a peer in the testbed.
55 * Prev reference in DLL.
60 * Next reference in DLL.
65 * Handle with testbed.
67 struct GNUNET_TESTBED_Peer *daemon;
70 * Testbed operation to connect to NSE service.
72 struct GNUNET_TESTBED_Operation *nse_op;
78 * Context for the stats task?
84 * How many messages have peers received during the test.
86 unsigned long long total_nse_received_messages;
89 * How many messages have peers send during the test (should be == received).
91 unsigned long long total_nse_transmitted_messages;
94 * How many messages have travelled an edge in both directions.
96 unsigned long long total_nse_cross;
99 * How many extra messages per edge (corrections) have been received.
101 unsigned long long total_nse_extra;
104 * How many messages have been discarded.
106 unsigned long long total_discarded;
111 * Operation map entry
118 struct OpListEntry *next;
123 struct OpListEntry *prev;
126 * The testbed operation
128 struct GNUNET_TESTBED_Operation *op;
134 * Head of DLL of peers we monitor closely.
136 static struct NSEPeer *peer_head;
139 * Tail of DLL of peers we monitor closely.
141 static struct NSEPeer *peer_tail;
144 * Return value from 'main' (0 == success)
149 * Be verbose (configuration option)
154 * Name of the file with the hosts to run the test over (configuration option)
156 static char *hosts_file;
159 * Maximum number of peers in the test.
161 static unsigned int num_peers;
164 * Total number of rounds to execute.
166 static unsigned int num_rounds;
169 * Current round we are in.
171 static unsigned int current_round;
174 * Array of size 'num_rounds' with the requested number of peers in the given round.
176 static unsigned int *num_peers_in_round;
179 * How many peers are running right now?
181 static unsigned int peers_running;
184 * Specification for the numbers of peers to have in each round.
186 static char *num_peer_spec;
189 * Handles to all of the running peers.
191 static struct GNUNET_TESTBED_Peer **daemons;
194 * Global configuration file
196 static struct GNUNET_CONFIGURATION_Handle *testing_cfg;
201 static GNUNET_SCHEDULER_TaskIdentifier shutdown_task_id;
204 * Maximum number of connections to NSE services.
206 static unsigned int connection_limit;
209 * Total number of connections in the whole network.
211 static unsigned int total_connections;
214 * File to report results to.
216 static struct GNUNET_DISK_FileHandle *output_file;
219 * Filename to log results to.
221 static char *output_filename;
224 * File to log connection info, statistics to.
226 static struct GNUNET_DISK_FileHandle *data_file;
229 * Filename to log connection info, statistics to.
231 static char *data_filename;
234 * How long to wait before triggering next round?
237 static struct GNUNET_TIME_Relative wait_time = { 60 * 1000 };
240 * DLL head for operation list
242 static struct OpListEntry *oplist_head;
245 * DLL tail for operation list
247 static struct OpListEntry *oplist_tail;
250 * The get stats operation
252 static struct GNUNET_TESTBED_Operation *get_stats_op;
255 * Are we shutting down
257 static int shutting_down;
261 * Clean up all of the monitoring connections to NSE and
262 * STATISTICS that we keep to selected peers.
265 close_monitor_connections ()
268 struct OpListEntry *oplist_entry;
270 while (NULL != (pos = peer_head))
272 if (NULL != pos->nse_op)
273 GNUNET_TESTBED_operation_done (pos->nse_op);
274 GNUNET_CONTAINER_DLL_remove (peer_head, peer_tail, pos);
277 while (NULL != (oplist_entry = oplist_head))
279 GNUNET_CONTAINER_DLL_remove (oplist_head, oplist_tail, oplist_entry);
280 GNUNET_TESTBED_operation_done (oplist_entry->op);
281 GNUNET_free (oplist_entry);
287 * Task run on shutdown; cleans up everything.
293 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
295 shutdown_task_id = GNUNET_SCHEDULER_NO_TASK;
296 if (GNUNET_YES == shutting_down)
298 shutting_down = GNUNET_YES;
299 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Ending test.\n");
300 close_monitor_connections ();
301 if (NULL != get_stats_op)
303 GNUNET_TESTBED_operation_done (get_stats_op);
306 if (NULL != data_file)
308 GNUNET_DISK_file_close (data_file);
311 if (NULL != output_file)
313 GNUNET_DISK_file_close (output_file);
316 if (NULL != testing_cfg)
317 GNUNET_CONFIGURATION_destroy (testing_cfg);
323 * Schedules shutdown task to be run now
328 if (GNUNET_SCHEDULER_NO_TASK != shutdown_task_id)
329 GNUNET_SCHEDULER_cancel (shutdown_task_id);
330 shutdown_task_id = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
335 * Callback to call when network size estimate is updated.
337 * @param cls closure with the 'struct NSEPeer' providing the update
338 * @param timestamp server timestamp
339 * @param estimate the value of the current network size estimate
340 * @param std_dev standard deviation (rounded down to nearest integer)
341 * of the size estimation values seen
344 handle_estimate (void *cls,
345 struct GNUNET_TIME_Absolute timestamp,
346 double estimate, double std_dev)
348 struct NSEPeer *peer = cls;
349 char output_buffer[512];
352 if (NULL == output_file)
355 "Received network size estimate from peer %p. Size: %f std.dev. %f\n",
356 peer, estimate, std_dev);
359 size = GNUNET_snprintf (output_buffer,
360 sizeof (output_buffer),
361 "%p %llu %llu %f %f %f\n",
364 GNUNET_NSE_log_estimate_to_n (estimate), estimate,
366 if (size != GNUNET_DISK_file_write (output_file, output_buffer, size))
367 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
368 "Unable to write to file!\n");
373 * Adapter function called to establish a connection to
376 * @param cls closure (the 'struct NSEPeer')
377 * @param cfg configuration of the peer to connect to; will be available until
378 * GNUNET_TESTBED_operation_done() is called on the operation returned
379 * from GNUNET_TESTBED_service_connect()
380 * @return service handle to return in 'op_result', NULL on error
383 nse_connect_adapter (void *cls,
384 const struct GNUNET_CONFIGURATION_Handle *cfg)
386 struct NSEPeer *current_peer = cls;
388 return GNUNET_NSE_connect (cfg, &handle_estimate, current_peer);
393 * Adapter function called to destroy a connection to
397 * @param op_result service handle returned from the connect adapter
400 nse_disconnect_adapter (void *cls,
403 GNUNET_NSE_disconnect (op_result);
408 * Task run to connect to the NSE and statistics services to a subset of
409 * all of the running peers.
412 connect_nse_service ()
414 struct NSEPeer *current_peer;
416 unsigned int connections;
418 if (0 == connection_limit)
420 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to nse service of peers\n");
422 for (i = 0; i < num_peers_in_round[current_round]; i++)
424 if ((num_peers_in_round[current_round] > connection_limit) &&
425 (0 != (i % (num_peers_in_round[current_round] / connection_limit))))
427 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
428 "nse-profiler: connecting to nse service of peer %d\n", i);
429 current_peer = GNUNET_malloc (sizeof (struct NSEPeer));
430 current_peer->daemon = daemons[i];
432 = GNUNET_TESTBED_service_connect (NULL,
433 current_peer->daemon,
436 &nse_connect_adapter,
437 &nse_disconnect_adapter,
439 GNUNET_CONTAINER_DLL_insert (peer_head, peer_tail, current_peer);
440 if (++connections == connection_limit)
447 * Task that starts/stops peers to move to the next round.
449 * @param cls NULL, unused
450 * @param tc scheduler context (unused)
453 next_round (void *cls,
454 const struct GNUNET_SCHEDULER_TaskContext *tc);
458 * Continuation called by the "get_all" and "get" functions at the
459 * end of a round. Obtains the final statistics and writes them to
460 * the file, then either starts the next round, or, if this was the
461 * last round, terminates the run.
463 * @param cls struct StatsContext
464 * @param op operation handle
465 * @param emsg error message, NULL on success
468 stats_finished_callback (void *cls,
469 struct GNUNET_TESTBED_Operation *op,
472 struct StatsContext *stats_context = cls;
476 GNUNET_TESTBED_operation_done (get_stats_op);
480 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
481 "Failed to get statistics: %s\n",
483 GNUNET_SCHEDULER_shutdown ();
484 GNUNET_free (stats_context);
487 LOG_DEBUG ("Finished collecting statistics\n");
488 if (NULL != data_file)
490 /* Stats lookup successful, write out data */
492 GNUNET_snprintf (buf, sizeof (buf),
493 "TOTAL_NSE_RECEIVED_MESSAGES_%u: %u \n",
495 stats_context->total_nse_received_messages);
496 GNUNET_DISK_file_write (data_file, buf, buf_len);
498 GNUNET_snprintf (buf, sizeof (buf),
499 "TOTAL_NSE_TRANSMITTED_MESSAGES_%u: %u\n",
501 stats_context->total_nse_transmitted_messages);
502 GNUNET_DISK_file_write (data_file, buf, buf_len);
504 GNUNET_snprintf (buf, sizeof (buf),
505 "TOTAL_NSE_CROSS_%u: %u \n",
507 stats_context->total_nse_cross);
508 GNUNET_DISK_file_write (data_file, buf, buf_len);
510 GNUNET_snprintf (buf, sizeof (buf),
511 "TOTAL_NSE_EXTRA_%u: %u \n",
513 stats_context->total_nse_extra);
514 GNUNET_DISK_file_write (data_file, buf, buf_len);
516 GNUNET_snprintf (buf, sizeof (buf),
517 "TOTAL_NSE_DISCARDED_%u: %u \n",
519 stats_context->total_discarded);
520 GNUNET_DISK_file_write (data_file, buf, buf_len);
522 GNUNET_SCHEDULER_add_now (&next_round, NULL);
523 GNUNET_free (stats_context);
528 * Callback function to process statistic values.
530 * @param cls struct StatsContext
531 * @param peer the peer the statistics belong to
532 * @param subsystem name of subsystem that created the statistic
533 * @param name the name of the datum
534 * @param value the current value
535 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
536 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
539 statistics_iterator (void *cls,
540 const struct GNUNET_TESTBED_Peer *peer,
541 const char *subsystem, const char *name, uint64_t value,
544 struct StatsContext *stats_context = cls;
548 if (0 != strcasecmp (subsystem, "nse"))
549 return GNUNET_SYSERR;
550 if (0 == strcmp (name, "# flood messages received"))
552 stats_context->total_nse_received_messages += value;
553 if ( (verbose > 1) &&
554 (NULL != data_file) )
557 GNUNET_snprintf (buf, sizeof (buf),
560 GNUNET_DISK_file_write (data_file, buf, buf_len);
563 if (0 == strcmp (name, "# flood messages transmitted"))
565 stats_context->total_nse_transmitted_messages += value;
566 if ( (verbose > 1) &&
567 (NULL != data_file) )
570 GNUNET_snprintf (buf, sizeof (buf),
571 "%p %u TRANSMITTED\n",
573 GNUNET_DISK_file_write (data_file, buf, buf_len);
576 if (0 == strcmp (name, "# cross messages"))
577 stats_context->total_nse_cross += value;
578 if (0 == strcmp (name, "# extra messages"))
579 stats_context->total_nse_extra += value;
580 if (0 == strcmp (name, "# flood messages discarded (clock skew too large)"))
581 stats_context->total_discarded += value;
587 * We're at the end of a round. Stop monitoring, write total
588 * number of connections to log and get full stats. Then trigger
591 * @param cls unused, NULL
595 finish_round (void *cls,
596 const struct GNUNET_SCHEDULER_TaskContext *tc)
598 struct StatsContext *stats_context;
602 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
604 LOG (GNUNET_ERROR_TYPE_INFO, "Have %u connections\n", total_connections);
605 if (NULL != data_file)
607 buf_len = GNUNET_snprintf (buf, sizeof (buf),
608 "CONNECTIONS_0: %u\n",
610 GNUNET_DISK_file_write (data_file, buf, buf_len);
612 close_monitor_connections ();
613 stats_context = GNUNET_malloc (sizeof (struct StatsContext));
615 GNUNET_TESTBED_get_statistics (num_peers_in_round[current_round],
618 &statistics_iterator,
619 &stats_finished_callback,
625 * We have reached the desired number of peers for the current round.
626 * Run it (by connecting and monitoring a few peers and waiting the
627 * specified delay before finishing the round).
632 LOG_DEBUG ("Running round %u\n", current_round);
633 connect_nse_service ();
634 GNUNET_SCHEDULER_add_delayed (wait_time,
641 * Creates an oplist entry and adds it to the oplist DLL
643 static struct OpListEntry *
646 struct OpListEntry *entry;
648 entry = GNUNET_malloc (sizeof (struct OpListEntry));
649 GNUNET_CONTAINER_DLL_insert_tail (oplist_head, oplist_tail, entry);
655 * Functions of this signature are called when a peer has been successfully
656 * started or stopped.
659 * @param emsg NULL on success; otherwise an error description
662 peer_churn_cb (void *cls, const char *emsg)
664 struct OpListEntry *entry = cls;
666 GNUNET_TESTBED_operation_done (entry->op);
667 GNUNET_CONTAINER_DLL_remove (oplist_head, oplist_tail, entry);
669 if (num_peers_in_round[current_round] == peers_running)
675 * Adjust the number of running peers to match the required number of running
676 * peers for the round
679 adjust_running_peers ()
681 struct OpListEntry *entry;
684 /* start peers if we have too few */
685 for (i=peers_running;i<num_peers_in_round[current_round];i++)
687 entry = make_oplist_entry ();
688 entry->op = GNUNET_TESTBED_peer_start (NULL, daemons[i],
689 &peer_churn_cb, entry);
691 /* stop peers if we have too many */
692 for (i=num_peers_in_round[current_round];i<peers_running;i++)
694 entry = make_oplist_entry ();
695 entry->op = GNUNET_TESTBED_peer_stop (NULL, daemons[i],
696 &peer_churn_cb, entry);
702 * Task run at the end of a round. Disconnect from all monitored
703 * peers; then get statistics from *all* peers.
705 * @param cls NULL, unused
709 next_round (void *cls,
710 const struct GNUNET_SCHEDULER_TaskContext *tc)
712 if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
714 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "disconnecting nse service of peers\n");
716 if (current_round == num_rounds)
718 /* this was the last round, terminate */
720 GNUNET_SCHEDULER_shutdown ();
723 if (num_peers_in_round[current_round] == peers_running)
725 /* no need to churn, just run next round */
729 adjust_running_peers ();
734 * Function that will be called whenever something in the
737 * @param cls closure, NULL
738 * @param event information on what is happening
741 master_controller_cb (void *cls,
742 const struct GNUNET_TESTBED_EventInformation *event)
746 case GNUNET_TESTBED_ET_PEER_START:
749 case GNUNET_TESTBED_ET_PEER_STOP:
752 case GNUNET_TESTBED_ET_CONNECT:
755 case GNUNET_TESTBED_ET_DISCONNECT:
765 * Signature of a main function for a testcase.
768 * @param num_peers_ number of peers in 'peers'
769 * @param peers handle to peers run in the testbed. NULL upon timeout (see
770 * GNUNET_TESTBED_test_run()).
771 * @param links_succeeded the number of overlay link connection attempts that
773 * @param links_failed the number of overlay link connection attempts that
777 test_master (void *cls,
778 unsigned int num_peers_,
779 struct GNUNET_TESTBED_Peer **peers,
780 unsigned int links_succeeded,
781 unsigned int links_failed)
789 GNUNET_break (num_peers_ == num_peers);
790 peers_running = num_peers;
791 if (num_peers_in_round[current_round] == peers_running)
793 /* no need to churn, just run the starting round */
797 adjust_running_peers ();
802 * Actual main function that runs the emulation.
805 * @param args remaining args, unused
806 * @param cfgfile name of the configuration
807 * @param cfg configuration handle
810 run (void *cls, char *const *args, const char *cfgfile,
811 const struct GNUNET_CONFIGURATION_Handle *cfg)
818 testing_cfg = GNUNET_CONFIGURATION_dup (cfg);
819 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting daemons.\n");
820 if (NULL == num_peer_spec)
822 fprintf (stderr, "You need to specify the number of peers to run\n");
825 for (tok = strtok (num_peer_spec, ","); NULL != tok; tok = strtok (NULL, ","))
827 if (1 != sscanf (tok, "%u", &num))
829 fprintf (stderr, "You need to specify numbers, not `%s'\n", tok);
834 fprintf (stderr, "Refusing to run a round with 0 peers\n");
837 GNUNET_array_append (num_peers_in_round, num_rounds, num);
838 num_peers = GNUNET_MAX (num_peers, num);
842 fprintf (stderr, "Refusing to run a testbed with no rounds\n");
845 if ( (NULL != data_filename) &&
846 (NULL == (data_file =
847 GNUNET_DISK_file_open (data_filename,
848 GNUNET_DISK_OPEN_READWRITE |
849 GNUNET_DISK_OPEN_TRUNCATE |
850 GNUNET_DISK_OPEN_CREATE,
851 GNUNET_DISK_PERM_USER_READ |
852 GNUNET_DISK_PERM_USER_WRITE))) )
853 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
857 if ( (NULL != output_filename) &&
858 (NULL == (output_file =
859 GNUNET_DISK_file_open (output_filename,
860 GNUNET_DISK_OPEN_READWRITE |
861 GNUNET_DISK_OPEN_CREATE,
862 GNUNET_DISK_PERM_USER_READ |
863 GNUNET_DISK_PERM_USER_WRITE))) )
864 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open",
867 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
868 event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_STOP);
869 event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
870 event_mask |= (1LL << GNUNET_TESTBED_ET_DISCONNECT);
871 GNUNET_TESTBED_run (hosts_file,
875 master_controller_cb,
876 NULL, /* master_controller_cb cls */
878 NULL); /* test_master cls */
880 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
881 &shutdown_task, NULL);
888 * @return 0 on success
891 main (int argc, char *const *argv)
893 static struct GNUNET_GETOPT_CommandLineOption options[] = {
894 {'C', "connections", "COUNT",
895 gettext_noop ("limit to the number of connections to NSE services, 0 for none"),
896 1, &GNUNET_GETOPT_set_uint, &connection_limit},
897 {'d', "details", "FILENAME",
898 gettext_noop ("name of the file for writing connection information and statistics"),
899 1, &GNUNET_GETOPT_set_string, &data_filename},
900 {'H', "hosts", "FILENAME",
901 gettext_noop ("name of the file with the login information for the testbed"),
902 1, &GNUNET_GETOPT_set_string, &hosts_file},
903 {'o', "output", "FILENAME",
904 gettext_noop ("name of the file for writing the main results"),
905 1, &GNUNET_GETOPT_set_string, &output_filename},
906 {'p', "peers", "NETWORKSIZESPEC",
907 gettext_noop ("Number of peers to run in each round, separated by commas"),
908 1, &GNUNET_GETOPT_set_string, &num_peer_spec},
909 {'V', "verbose", NULL,
910 gettext_noop ("be verbose (print progress information)"),
911 0, &GNUNET_GETOPT_increment_value, &verbose},
912 {'w', "wait", "DELAY",
913 gettext_noop ("delay between rounds"),
914 1, &GNUNET_GETOPT_set_relative_time, &wait_time},
915 GNUNET_GETOPT_OPTION_END
917 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
920 GNUNET_PROGRAM_run (argc, argv, "nse-profiler",
922 ("Measure quality and performance of the NSE service."),
923 options, &run, NULL))
928 /* end of nse-profiler.c */