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/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"
32 #define VERBOSE GNUNET_NO
40 struct GNUNET_TESTING_Daemon *daemon;
42 struct GNUNET_NSE_Handle *nse_handle;
47 GNUNET_SCHEDULER_Task task;
48 GNUNET_SCHEDULER_TaskIdentifier *task_id;
50 unsigned long long total_nse_bytes;
53 static struct NSEPeer *peer_head;
55 static struct NSEPeer *peer_tail;
58 * How long until we give up on connecting the peers?
60 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1500)
70 * Total number of peers in the test.
72 static unsigned long long num_peers;
75 * Global configuration file
77 static struct GNUNET_CONFIGURATION_Handle *testing_cfg;
80 * Total number of currently running peers.
82 static unsigned long long peers_running;
85 * Current round we are in.
87 static unsigned long long current_round;
90 * Peers desired in the next round.
92 static unsigned long long peers_next_round;
95 * Maximum number of connections to NSE services.
97 static unsigned long long connection_limit;
100 * Total number of connections in the whole network.
102 static unsigned int total_connections;
105 * The currently running peer group.
107 static struct GNUNET_TESTING_PeerGroup *pg;
110 * File to report results to.
112 static struct GNUNET_DISK_FileHandle *output_file;
115 * File to log connection info, statistics to.
117 static struct GNUNET_DISK_FileHandle *data_file;
120 * How many data points to capture before triggering next round?
122 static struct GNUNET_TIME_Relative wait_time;
125 * Task called to disconnect peers.
127 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
130 * Task called to shutdown test.
132 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
135 * Task used to churn the network.
137 static GNUNET_SCHEDULER_TaskIdentifier churn_task;
139 static char *topology_file;
141 static char *data_filename;
143 static uint64_t clock_skew;
146 * Check whether peers successfully shut down.
149 shutdown_callback (void *cls, const char *emsg)
154 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown of peers failed!\n");
162 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
163 "All peers successfully shut down!\n");
170 shutdown_task (void *cls,
171 const struct GNUNET_SCHEDULER_TaskContext *tc)
175 fprintf(stderr, "Ending test.\n");
178 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
180 GNUNET_SCHEDULER_cancel(disconnect_task);
181 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
183 while (NULL != (pos = peer_head))
185 if (pos->nse_handle != NULL)
186 GNUNET_NSE_disconnect(pos->nse_handle);
187 GNUNET_CONTAINER_DLL_remove(peer_head, peer_tail, pos);
191 if (data_file != NULL)
192 GNUNET_DISK_file_close(data_file);
193 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
197 * Callback to call when network size estimate is updated.
200 * @param estimate the value of the current network size estimate
201 * @param std_dev standard deviation (rounded down to nearest integer)
202 * of the size estimation values seen
206 handle_estimate (void *cls, double estimate, double std_dev)
208 struct NSEPeer *peer = cls;
212 if (output_file != NULL)
214 size = GNUNET_asprintf(&output_buffer,
216 GNUNET_i2s(&peer->daemon->id),
221 if (size != GNUNET_DISK_file_write(output_file, output_buffer, size))
222 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
223 "Unable to write to file!\n");
224 GNUNET_free (output_buffer);
228 "Received network size estimate from peer %s. Size: %f std.dev. %f\n",
229 GNUNET_i2s(&peer->daemon->id),
236 connect_nse_service (void *cls,
237 const struct GNUNET_SCHEDULER_TaskContext *tc)
239 struct NSEPeer *current_peer;
243 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
244 "Connecting to nse service of peers\n");
246 for (i = 0; i < num_peers; i++)
248 if ((connection_limit > 0) && (i % (num_peers / connection_limit) != 0))
251 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "nse-profiler: connecting to nse service of peer %d\n", i);
253 current_peer = GNUNET_malloc(sizeof(struct NSEPeer));
254 current_peer->daemon = GNUNET_TESTING_daemon_get(pg, i);
255 if (GNUNET_YES == GNUNET_TESTING_daemon_running(GNUNET_TESTING_daemon_get(pg, i)))
257 current_peer->nse_handle = GNUNET_NSE_connect (current_peer->daemon->cfg,
260 GNUNET_assert(current_peer->nse_handle != NULL);
262 GNUNET_CONTAINER_DLL_insert (peer_head, peer_tail, current_peer);
268 churn_peers (void *cls,
269 const struct GNUNET_SCHEDULER_TaskContext *tc);
273 * Continuation called by the "get_all" and "get" functions.
275 * @param cls struct StatsContext
276 * @param success GNUNET_OK if statistics were
277 * successfully obtained, GNUNET_SYSERR if not.
280 stats_finished_callback (void *cls, int success)
282 struct StatsContext *stats_context = (struct StatsContext *)cls;
286 if ((GNUNET_OK == success) && (data_file != NULL)) /* Stats lookup successful, write out data */
289 buf_len = GNUNET_asprintf(&buf,
290 "TOTAL_NSE_BYTES: %u\n",
291 stats_context->total_nse_bytes);
294 GNUNET_DISK_file_write(data_file, buf, buf_len);
296 GNUNET_free_non_null(buf);
299 if (stats_context->task != NULL)
300 *stats_context->task_id = GNUNET_SCHEDULER_add_now(stats_context->task,
301 stats_context->task_cls);
302 GNUNET_free(stats_context);
307 * Callback function to process statistic values.
309 * @param cls struct StatsContext
310 * @param peer the peer the statistics belong to
311 * @param subsystem name of subsystem that created the statistic
312 * @param name the name of the datum
313 * @param value the current value
314 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
315 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
318 statistics_iterator (void *cls,
319 const struct GNUNET_PeerIdentity *peer,
320 const char *subsystem,
325 struct StatsContext *stats_context = cls;
327 if ((0 == strstr(subsystem, "nse")) && (0 == strstr(name, "# flood messages received")))
329 stats_context->total_nse_bytes += value;
337 * @param cls struct StatsContext
338 * @param tc task context
341 get_statistics (void *cls,
342 const struct GNUNET_SCHEDULER_TaskContext *tc)
344 struct StatsContext *stats_context = cls;
346 GNUNET_TESTING_get_statistics(pg,
347 &stats_finished_callback,
348 &statistics_iterator,
354 disconnect_nse_peers (void *cls,
355 const struct GNUNET_SCHEDULER_TaskContext *tc)
359 struct StatsContext *stats_context;
360 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
363 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
364 "disconnecting nse service of peers\n");
365 while (NULL != (pos = peer_head))
367 if (pos->nse_handle != NULL)
369 GNUNET_NSE_disconnect(pos->nse_handle);
370 pos->nse_handle = NULL;
372 GNUNET_CONTAINER_DLL_remove(peer_head, peer_tail, pos);
376 GNUNET_asprintf(&buf,
379 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (testing_cfg,
385 GNUNET_assert(churn_task == GNUNET_SCHEDULER_NO_TASK);
386 churn_task = GNUNET_SCHEDULER_add_now(&churn_peers, NULL);
388 else /* No more rounds, let's shut it down! */
390 stats_context = GNUNET_malloc(sizeof(struct StatsContext));
391 GNUNET_SCHEDULER_cancel(shutdown_handle);
392 shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
393 stats_context->task = &shutdown_task;
394 stats_context->task_cls = NULL;
395 stats_context->task_id = &shutdown_handle;
396 GNUNET_SCHEDULER_add_now(&get_statistics, stats_context);
397 //shutdown_handle = GNUNET_SCHEDULER_add_now(&shutdown_task, NULL);
404 * Prototype of a function that will be called when a
405 * particular operation was completed the testing library.
408 * @param emsg NULL on success
411 topology_output_callback (void *cls, const char *emsg)
413 struct StatsContext *stats_context;
414 stats_context = GNUNET_malloc(sizeof(struct StatsContext));
416 disconnect_task = GNUNET_SCHEDULER_add_delayed(wait_time, &disconnect_nse_peers, NULL);
417 GNUNET_SCHEDULER_add_now(&connect_nse_service, NULL);
422 * Prototype of a function that will be called when a
423 * particular operation was completed the testing library.
426 * @param emsg NULL on success
429 churn_callback (void *cls, const char *emsg)
431 char *temp_output_file;
433 if (emsg == NULL) /* Everything is okay! */
435 peers_running = peers_next_round;
436 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
437 "Round %lu, churn finished successfully.\n",
439 GNUNET_assert(disconnect_task == GNUNET_SCHEDULER_NO_TASK);
440 GNUNET_asprintf(&temp_output_file,
444 GNUNET_TESTING_peergroup_topology_to_file(pg,
446 &topology_output_callback,
448 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
449 "Writing topology to file %s\n",
451 GNUNET_free(temp_output_file);
455 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
456 "Round %lu, churn FAILED!!\n",
458 GNUNET_SCHEDULER_cancel(shutdown_handle);
459 GNUNET_SCHEDULER_add_now(&shutdown_task, NULL);
465 churn_peers (void *cls,
466 const struct GNUNET_SCHEDULER_TaskContext *tc)
468 /* peers_running = GNUNET_TESTING_daemons_running(pg); */
469 churn_task = GNUNET_SCHEDULER_NO_TASK;
470 if (peers_next_round == peers_running)
472 /* Nothing to do... */
473 GNUNET_SCHEDULER_add_now(&connect_nse_service, NULL);
474 GNUNET_assert(disconnect_task == GNUNET_SCHEDULER_NO_TASK);
475 disconnect_task = GNUNET_SCHEDULER_add_delayed(wait_time,
476 &disconnect_nse_peers, NULL);
477 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
478 "Round %lu, doing nothing!\n",
483 if (peers_next_round > num_peers)
485 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
486 "Asked to turn on more peers than we have!!\n");
487 GNUNET_SCHEDULER_cancel(shutdown_handle);
488 GNUNET_SCHEDULER_add_now(&shutdown_task, NULL);
490 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
491 "Round %lu, turning off %lu peers, turning on %lu peers!\n",
493 (peers_running > peers_next_round) ? peers_running
494 - peers_next_round : 0,
495 (peers_next_round > peers_running) ? peers_next_round
496 - peers_running : 0);
497 GNUNET_TESTING_daemons_churn (pg, "nse",
498 (peers_running > peers_next_round) ? peers_running
501 (peers_next_round > peers_running) ? peers_next_round
503 : 0, wait_time, &churn_callback,
517 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
518 "Peergroup callback called with error, aborting test!\n");
519 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Error from testing: `%s'\n");
521 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
525 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
526 "Peer Group started successfully, connecting to NSE service for each peer!\n");
528 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
529 "Have %u connections\n", total_connections);
530 if (data_file != NULL)
533 buf_len = GNUNET_asprintf(&buf,
534 "CONNECTIONS_0: %u\n",
537 GNUNET_DISK_file_write(data_file, buf, buf_len);
540 peers_running = GNUNET_TESTING_daemons_running(pg);
541 GNUNET_SCHEDULER_add_now(&connect_nse_service, NULL);
542 disconnect_task = GNUNET_SCHEDULER_add_delayed(wait_time, &disconnect_nse_peers, NULL);
547 * Function that will be called whenever two daemons are connected by
548 * the testing library.
551 * @param first peer id for first daemon
552 * @param second peer id for the second daemon
553 * @param distance distance between the connected peers
554 * @param first_cfg config for the first daemon
555 * @param second_cfg config for the second daemon
556 * @param first_daemon handle for the first daemon
557 * @param second_daemon handle for the second daemon
558 * @param emsg error message (NULL on success)
561 connect_cb (void *cls,
562 const struct GNUNET_PeerIdentity *first,
563 const struct GNUNET_PeerIdentity *second,
565 const struct GNUNET_CONFIGURATION_Handle *first_cfg,
566 const struct GNUNET_CONFIGURATION_Handle *second_cfg,
567 struct GNUNET_TESTING_Daemon *first_daemon,
568 struct GNUNET_TESTING_Daemon *second_daemon,
579 const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
582 unsigned long long temp_wait;
585 testing_cfg = GNUNET_CONFIGURATION_create();
586 GNUNET_assert(GNUNET_OK == GNUNET_CONFIGURATION_load(testing_cfg, cfgfile));
588 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting daemons.\n");
589 GNUNET_CONFIGURATION_set_value_string (testing_cfg, "testing",
593 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (testing_cfg,
595 "num_peers", &num_peers))
597 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Option TESTING:NUM_PEERS is required!\n");
601 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (testing_cfg,
606 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
607 "Option nse-profiler:wait_time is required!\n");
611 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (testing_cfg,
612 "nse-profiler", "connection_limit",
615 connection_limit = 0;
618 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (testing_cfg,
619 "nse-profiler", "topology_output_file",
622 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
623 "Option nse-profiler:topology_output_file is required!\n");
627 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (testing_cfg,
628 "nse-profiler", "data_output_file",
631 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
632 "Option nse-profiler:data_output_file is required!\n");
636 if (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno (testing_cfg,
640 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
641 "Setting our clock as skewed...\n");
642 clock_skew = GNUNET_CRYPTO_random_u64(GNUNET_CRYPTO_QUALITY_WEAK,
643 GNUNET_TIME_UNIT_MINUTES.rel_value);
647 data_file = GNUNET_DISK_file_open (data_filename,
648 GNUNET_DISK_OPEN_READWRITE
649 | GNUNET_DISK_OPEN_CREATE,
650 GNUNET_DISK_PERM_USER_READ |
651 GNUNET_DISK_PERM_USER_WRITE);
652 if (data_file == NULL)
653 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
654 "Failed to open %s for output!\n",
656 GNUNET_free(data_filename);
658 wait_time = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, temp_wait);
660 if (GNUNET_YES == GNUNET_CONFIGURATION_get_value_string(cfg,
665 output_file = GNUNET_DISK_file_open (temp_str, GNUNET_DISK_OPEN_READWRITE
666 | GNUNET_DISK_OPEN_CREATE,
667 GNUNET_DISK_PERM_USER_READ |
668 GNUNET_DISK_PERM_USER_WRITE);
669 if (output_file == NULL)
670 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
671 "Failed to open %s for output!\n",
674 GNUNET_free_non_null(temp_str);
676 pg = GNUNET_TESTING_peergroup_start(testing_cfg,
682 GNUNET_assert (pg != NULL);
683 shutdown_handle = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_get_forever(),
691 * nse-profiler command line options
693 static struct GNUNET_GETOPT_CommandLineOption options[] = {
694 {'V', "verbose", NULL,
695 gettext_noop ("be verbose (print progress information)"),
696 0, &GNUNET_GETOPT_set_one, &verbose},
697 GNUNET_GETOPT_OPTION_END
702 main (int argc, char *argv[])
706 GNUNET_log_setup ("nse-profiler",
714 GNUNET_PROGRAM_run (argc,
715 argv, "nse-profiler", gettext_noop
716 ("Run a test of the NSE service."),
718 GNUNET_DISK_directory_remove ("/tmp/nse-profiler");
722 /* end of nse-profiler.c */