2 This file is part of GNUnet.
3 (C) 2011 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.
29 #include "gnunet_testing_lib.h"
30 #include "gnunet_nse_service.h"
40 struct GNUNET_TESTING_Daemon *daemon;
42 struct GNUNET_NSE_Handle *nse_handle;
44 struct GNUNET_STATISTICS_Handle *stats;
50 unsigned long long total_nse_bytes;
54 static struct NSEPeer *peer_head;
56 static struct NSEPeer *peer_tail;
59 * How long until we give up on connecting the peers?
61 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1500)
71 * Total number of peers in the test.
73 static unsigned long long num_peers;
76 * Global configuration file
78 static struct GNUNET_CONFIGURATION_Handle *testing_cfg;
81 * Total number of currently running peers.
83 static unsigned long long peers_running;
86 * Current round we are in.
88 static unsigned long long current_round;
91 * Peers desired in the next round.
93 static unsigned long long peers_next_round;
96 * Maximum number of connections to NSE services.
98 static unsigned long long connection_limit;
101 * Total number of connections in the whole network.
103 static unsigned int total_connections;
106 * The currently running peer group.
108 static struct GNUNET_TESTING_PeerGroup *pg;
111 * File to report results to.
113 static struct GNUNET_DISK_FileHandle *output_file;
116 * File to log connection info, statistics to.
118 static struct GNUNET_DISK_FileHandle *data_file;
121 * How many data points to capture before triggering next round?
123 static struct GNUNET_TIME_Relative wait_time;
126 * Task called to disconnect peers.
128 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
131 * Task called to shutdown test.
133 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
136 * Task used to churn the network.
138 static GNUNET_SCHEDULER_TaskIdentifier churn_task;
140 static char *topology_file;
143 * Check whether peers successfully shut down.
146 shutdown_callback (void *cls, const char *emsg)
151 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown of peers failed!\n");
159 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "All peers successfully shut down!\n");
167 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
172 fprintf (stderr, "Ending test.\n");
175 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
177 GNUNET_SCHEDULER_cancel (disconnect_task);
178 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
180 while (NULL != (pos = peer_head))
182 if (pos->nse_handle != NULL)
183 GNUNET_NSE_disconnect (pos->nse_handle);
184 GNUNET_CONTAINER_DLL_remove (peer_head, peer_tail, pos);
188 if (data_file != NULL)
189 GNUNET_DISK_file_close (data_file);
190 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
195 * Callback to call when network size estimate is updated.
198 * @param timestamp server timestamp
199 * @param estimate the value of the current network size estimate
200 * @param std_dev standard deviation (rounded down to nearest integer)
201 * of the size estimation values seen
205 handle_estimate (void *cls, struct GNUNET_TIME_Absolute timestamp,
206 double estimate, double std_dev)
208 struct NSEPeer *peer = cls;
212 if (output_file != NULL)
215 GNUNET_asprintf (&output_buffer, "%s %llu %llu %f %f %f\n",
216 GNUNET_i2s (&peer->daemon->id), peers_running,
218 GNUNET_NSE_log_estimate_to_n (estimate), estimate,
220 if (size != GNUNET_DISK_file_write (output_file, output_buffer, size))
221 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Unable to write to file!\n");
222 GNUNET_free (output_buffer);
226 "Received network size estimate from peer %s. Size: %f std.dev. %f\n",
227 GNUNET_i2s (&peer->daemon->id), estimate, std_dev);
232 * Process core statistic values.
235 * @param subsystem name of subsystem that created the statistic
236 * @param name the name of the datum
237 * @param value the current value
238 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
239 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
242 core_stats_iterator (void *cls, const char *subsystem, const char *name,
243 uint64_t value, int is_persistent)
245 struct NSEPeer *peer = cls;
249 if (output_file != NULL)
252 GNUNET_asprintf (&output_buffer, "%s -> %s [%s]: %llu\n",
253 GNUNET_i2s (&peer->daemon->id),
254 subsystem, name, value);
255 if (size != GNUNET_DISK_file_write (output_file, output_buffer, size))
256 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Unable to write to file!\n");
257 GNUNET_free (output_buffer);
260 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
261 "%s -> %s [%s]: %llu\n",
262 GNUNET_i2s (&peer->daemon->id), subsystem, name, value);
268 * Continuation called by "get_stats" function.
271 * @param success GNUNET_OK if statistics were
272 * successfully obtained, GNUNET_SYSERR if not.
275 core_stats_cont (void *cls, int success);
278 core_get_stats (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
280 struct NSEPeer *peer = cls;
281 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
283 GNUNET_STATISTICS_destroy(peer->stats, GNUNET_YES);
287 GNUNET_STATISTICS_get(peer->stats, "core", NULL,
288 GNUNET_TIME_UNIT_FOREVER_REL,
289 &core_stats_cont, &core_stats_iterator, peer);
294 * Continuation called by "get_stats" function.
297 * @param success GNUNET_OK if statistics were
298 * successfully obtained, GNUNET_SYSERR if not.
301 core_stats_cont (void *cls, int success)
303 struct NSEPeer *peer = cls;
304 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
305 &core_get_stats, peer);
313 connect_nse_service (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
315 struct NSEPeer *current_peer;
319 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to nse service of peers\n");
321 for (i = 0; i < num_peers; i++)
323 if ((connection_limit > 0) && (i % (num_peers / connection_limit) != 0))
326 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
327 "nse-profiler: connecting to nse service of peer %d\n", i);
329 current_peer = GNUNET_malloc (sizeof (struct NSEPeer));
330 current_peer->daemon = GNUNET_TESTING_daemon_get (pg, i);
332 GNUNET_TESTING_test_daemon_running (GNUNET_TESTING_daemon_get (pg, i)))
334 current_peer->nse_handle =
335 GNUNET_NSE_connect (current_peer->daemon->cfg, &handle_estimate,
337 GNUNET_assert (current_peer->nse_handle != NULL);
339 current_peer->stats = GNUNET_STATISTICS_create("profiler", current_peer->daemon->cfg);
340 GNUNET_STATISTICS_get(current_peer->stats, "core", NULL, GNUNET_TIME_UNIT_FOREVER_REL,
341 &core_stats_cont, &core_stats_iterator, current_peer);
342 GNUNET_STATISTICS_get(current_peer->stats, "transport", NULL, GNUNET_TIME_UNIT_FOREVER_REL,
343 NULL, &core_stats_iterator, current_peer);
344 GNUNET_STATISTICS_get(current_peer->stats, "nse", NULL, GNUNET_TIME_UNIT_FOREVER_REL,
345 NULL, &core_stats_iterator, current_peer);
346 GNUNET_CONTAINER_DLL_insert (peer_head, peer_tail, current_peer);
352 churn_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
356 * Continuation called by the "get_all" and "get" functions.
358 * @param cls struct StatsContext
359 * @param success GNUNET_OK if statistics were
360 * successfully obtained, GNUNET_SYSERR if not.
363 stats_finished_callback (void *cls, int success)
365 struct StatsContext *stats_context = cls;
369 if ((GNUNET_OK == success) && (data_file != NULL))
371 /* Stats lookup successful, write out data */
374 GNUNET_asprintf (&buf, "TOTAL_NSE_BYTES: %u\n",
375 stats_context->total_nse_bytes);
378 GNUNET_DISK_file_write (data_file, buf, buf_len);
380 GNUNET_free_non_null (buf);
383 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == shutdown_handle);
384 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
385 GNUNET_free (stats_context);
390 * Callback function to process statistic values.
392 * @param cls struct StatsContext
393 * @param peer the peer the statistics belong to
394 * @param subsystem name of subsystem that created the statistic
395 * @param name the name of the datum
396 * @param value the current value
397 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
398 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
401 statistics_iterator (void *cls, const struct GNUNET_PeerIdentity *peer,
402 const char *subsystem, const char *name, uint64_t value,
405 struct StatsContext *stats_context = cls;
407 if ((0 == strstr (subsystem, "nse")) &&
408 (0 == strstr (name, "# flood messages received")))
409 stats_context->total_nse_bytes += value;
415 disconnect_nse_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
419 struct StatsContext *stats_context;
421 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "disconnecting nse service of peers\n");
422 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
424 while (NULL != (pos = peer_head))
426 if (pos->nse_handle != NULL)
428 GNUNET_NSE_disconnect (pos->nse_handle);
429 pos->nse_handle = NULL;
431 GNUNET_CONTAINER_DLL_remove (peer_head, peer_tail, pos);
435 GNUNET_asprintf (&buf, "round%llu", current_round);
437 GNUNET_CONFIGURATION_get_value_number (testing_cfg, "nse-profiler", buf,
441 GNUNET_assert (churn_task == GNUNET_SCHEDULER_NO_TASK);
442 churn_task = GNUNET_SCHEDULER_add_now (&churn_peers, NULL);
444 else /* No more rounds, let's shut it down! */
446 stats_context = GNUNET_malloc (sizeof (struct StatsContext));
447 GNUNET_SCHEDULER_cancel (shutdown_handle);
448 shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
449 GNUNET_TESTING_get_statistics (pg, &stats_finished_callback,
450 &statistics_iterator, stats_context);
460 * @param emsg NULL on success
463 topology_output_callback (void *cls, const char *emsg)
466 GNUNET_SCHEDULER_add_delayed (wait_time, &disconnect_nse_peers, NULL);
467 GNUNET_SCHEDULER_add_now (&connect_nse_service, NULL);
475 * @param emsg NULL on success
478 churn_callback (void *cls, const char *emsg)
480 char *temp_output_file;
482 if (emsg == NULL) /* Everything is okay! */
484 peers_running = peers_next_round;
485 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
486 "Round %llu, churn finished successfully.\n", current_round);
487 GNUNET_assert (disconnect_task == GNUNET_SCHEDULER_NO_TASK);
488 GNUNET_asprintf (&temp_output_file, "%s_%llu.dot", topology_file,
490 GNUNET_TESTING_peergroup_topology_to_file (pg, temp_output_file,
491 &topology_output_callback, NULL);
492 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Writing topology to file %s\n",
494 GNUNET_free (temp_output_file);
498 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Round %llu, churn FAILED!!\n",
500 GNUNET_SCHEDULER_cancel (shutdown_handle);
501 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
507 churn_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
509 /* peers_running = GNUNET_TESTING_daemons_running(pg); */
510 churn_task = GNUNET_SCHEDULER_NO_TASK;
511 if (peers_next_round == peers_running)
513 /* Nothing to do... */
514 GNUNET_SCHEDULER_add_now (&connect_nse_service, NULL);
515 GNUNET_assert (disconnect_task == GNUNET_SCHEDULER_NO_TASK);
517 GNUNET_SCHEDULER_add_delayed (wait_time, &disconnect_nse_peers, NULL);
518 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Round %lu, doing nothing!\n",
523 if (peers_next_round > num_peers)
525 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
526 "Asked to turn on more peers than we have!!\n");
527 GNUNET_SCHEDULER_cancel (shutdown_handle);
528 GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
530 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
531 "Round %llu, turning off %llu peers, turning on %llu peers!\n",
534 peers_next_round) ? peers_running - peers_next_round : 0,
536 peers_running) ? peers_next_round - peers_running : 0);
537 GNUNET_TESTING_daemons_churn (pg, "nse",
539 peers_next_round) ? peers_running -
540 peers_next_round : 0,
542 peers_running) ? peers_next_round -
543 peers_running : 0, wait_time, &churn_callback,
550 nse_started_cb (void *cls, const char *emsg)
552 GNUNET_SCHEDULER_add_now (&connect_nse_service, NULL);
554 GNUNET_SCHEDULER_add_delayed (wait_time, &disconnect_nse_peers, NULL);
559 my_cb (void *cls, const char *emsg)
566 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
567 "Peergroup callback called with error, aborting test!\n");
568 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Error from testing: `%s'\n");
570 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
574 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
575 "Peer Group started successfully, connecting to NSE service for each peer!\n");
577 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Have %u connections\n",
579 if (data_file != NULL)
582 buf_len = GNUNET_asprintf (&buf, "CONNECTIONS_0: %u\n", total_connections);
584 GNUNET_DISK_file_write (data_file, buf, buf_len);
587 peers_running = GNUNET_TESTING_daemons_running (pg);
588 GNUNET_TESTING_daemons_start_service (pg, "nse", wait_time, &nse_started_cb,
595 * Function that will be called whenever two daemons are connected by
596 * the testing library.
599 * @param first peer id for first daemon
600 * @param second peer id for the second daemon
601 * @param distance distance between the connected peers
602 * @param first_cfg config for the first daemon
603 * @param second_cfg config for the second daemon
604 * @param first_daemon handle for the first daemon
605 * @param second_daemon handle for the second daemon
606 * @param emsg error message (NULL on success)
609 connect_cb (void *cls, const struct GNUNET_PeerIdentity *first,
610 const struct GNUNET_PeerIdentity *second, uint32_t distance,
611 const struct GNUNET_CONFIGURATION_Handle *first_cfg,
612 const struct GNUNET_CONFIGURATION_Handle *second_cfg,
613 struct GNUNET_TESTING_Daemon *first_daemon,
614 struct GNUNET_TESTING_Daemon *second_daemon, const char *emsg)
622 run (void *cls, char *const *args, const char *cfgfile,
623 const struct GNUNET_CONFIGURATION_Handle *cfg)
626 struct GNUNET_TESTING_Host *hosts;
630 //testing_cfg = GNUNET_CONFIGURATION_create ();
631 testing_cfg = GNUNET_CONFIGURATION_dup (cfg);
633 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting daemons.\n");
634 GNUNET_CONFIGURATION_set_value_string (testing_cfg, "testing",
635 "use_progressbars", "YES");
638 GNUNET_CONFIGURATION_get_value_number (testing_cfg, "testing",
639 "num_peers", &num_peers))
641 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
642 "Option TESTING:NUM_PEERS is required!\n");
647 GNUNET_CONFIGURATION_get_value_time (testing_cfg, "nse-profiler",
648 "WAIT_TIME", &wait_time))
650 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
651 "Option nse-profiler:wait_time is required!\n");
656 GNUNET_CONFIGURATION_get_value_number (testing_cfg, "nse-profiler",
660 connection_limit = 0;
664 GNUNET_CONFIGURATION_get_value_string (testing_cfg, "nse-profiler",
665 "topology_output_file",
668 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
669 "Option nse-profiler:topology_output_file is required!\n");
674 GNUNET_CONFIGURATION_get_value_string (testing_cfg, "nse-profiler",
679 GNUNET_DISK_file_open (data_filename,
680 GNUNET_DISK_OPEN_READWRITE |
681 GNUNET_DISK_OPEN_CREATE,
682 GNUNET_DISK_PERM_USER_READ |
683 GNUNET_DISK_PERM_USER_WRITE);
684 if (data_file == NULL)
685 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n",
687 GNUNET_free (data_filename);
691 GNUNET_CONFIGURATION_get_value_string (cfg, "nse-profiler", "output_file",
695 GNUNET_DISK_file_open (temp_str,
696 GNUNET_DISK_OPEN_READWRITE |
697 GNUNET_DISK_OPEN_CREATE,
698 GNUNET_DISK_PERM_USER_READ |
699 GNUNET_DISK_PERM_USER_WRITE);
700 if (output_file == NULL)
701 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n",
704 GNUNET_free_non_null (temp_str);
706 hosts = GNUNET_TESTING_hosts_load (testing_cfg);
708 pg = GNUNET_TESTING_peergroup_start (testing_cfg, num_peers, TIMEOUT,
709 &connect_cb, &my_cb, NULL, hosts);
710 GNUNET_assert (pg != NULL);
712 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_get_forever (),
713 &shutdown_task, NULL);
719 * nse-profiler command line options
721 static struct GNUNET_GETOPT_CommandLineOption options[] = {
722 {'V', "verbose", NULL,
723 gettext_noop ("be verbose (print progress information)"),
724 0, &GNUNET_GETOPT_set_one, &verbose},
725 GNUNET_GETOPT_OPTION_END
730 main (int argc, char *argv[])
732 GNUNET_log_setup ("nse-profiler",
739 GNUNET_PROGRAM_run (argc, argv, "nse-profiler",
741 ("Measure quality and performance of the NSE service."),
742 options, &run, NULL);
744 GNUNET_DISK_directory_remove ("/tmp/nse-profiler");
749 /* end of nse-profiler.c */