2 This file is part of GNUnet.
3 (C) 2009 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 struct NSEPeer *peer_head;
55 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 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;
211 //fprintf(stderr, "Received network size estimate from peer %s. Size: %f std.dev. %f\n", GNUNET_i2s(&peer->daemon->id), estimate, std_dev);
212 if (output_file != NULL)
214 size = GNUNET_asprintf(&output_buffer, "%s %u %f %f\n", GNUNET_i2s(&peer->daemon->id), peers_running, estimate, std_dev);
215 if (size != GNUNET_DISK_file_write(output_file, output_buffer, size))
216 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "%s: Unable to write to file!\n", "nse-profiler");
219 fprintf(stderr, "Received network size estimate from peer %s. Size: %f std.dev. %f\n", GNUNET_i2s(&peer->daemon->id), estimate, std_dev);
224 connect_nse_service (void *cls,
225 const struct GNUNET_SCHEDULER_TaskContext *tc)
227 struct NSEPeer *current_peer;
230 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "TEST_NSE_MULTIPEER: connecting to nse service of peers\n");
232 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "TEST_NSE_MULTIPEER: connecting to nse service of peers\n");
233 for (i = 0; i < num_peers; i++)
235 if ((connection_limit > 0) && (i % (num_peers / connection_limit) != 0))
237 current_peer = GNUNET_malloc(sizeof(struct NSEPeer));
238 current_peer->daemon = GNUNET_TESTING_daemon_get(pg, i);
239 if (GNUNET_YES == GNUNET_TESTING_daemon_running(GNUNET_TESTING_daemon_get(pg, i)))
241 current_peer->nse_handle = GNUNET_NSE_connect (current_peer->daemon->cfg, &handle_estimate, current_peer);
242 GNUNET_assert(current_peer->nse_handle != NULL);
244 GNUNET_CONTAINER_DLL_insert (peer_head, peer_tail, current_peer);
249 churn_peers (void *cls,
250 const struct GNUNET_SCHEDULER_TaskContext *tc);
253 * Continuation called by the "get_all" and "get" functions.
255 * @param cls struct StatsContext
256 * @param success GNUNET_OK if statistics were
257 * successfully obtained, GNUNET_SYSERR if not.
259 static void stats_finished_callback (void *cls, int success)
261 struct StatsContext *stats_context = (struct StatsContext *)cls;
265 if ((GNUNET_OK == success) && (data_file != NULL)) /* Stats lookup successful, write out data */
268 buf_len = GNUNET_asprintf(&buf, "TOTAL_NSE_BYTES: %u\n", stats_context->total_nse_bytes);
271 GNUNET_DISK_file_write(data_file, buf, buf_len);
273 GNUNET_free_non_null(buf);
276 if (stats_context->task != NULL)
277 (*stats_context->task_id) = GNUNET_SCHEDULER_add_now(stats_context->task, stats_context->task_cls);
279 GNUNET_free(stats_context);
283 * Callback function to process statistic values.
285 * @param cls struct StatsContext
286 * @param peer the peer the statistics belong to
287 * @param subsystem name of subsystem that created the statistic
288 * @param name the name of the datum
289 * @param value the current value
290 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
291 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
293 static int statistics_iterator (void *cls,
294 const struct GNUNET_PeerIdentity *peer,
295 const char *subsystem,
300 struct StatsContext *stats_context = (struct StatsContext *)cls;
303 GNUNET_assert(0 < GNUNET_asprintf(&buf, "bytes of messages of type %d received", GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD));
304 if ((0 == strstr(subsystem, "core")) && (0 == strstr(name, buf)))
306 stats_context->total_nse_bytes += value;
313 * @param cls struct StatsContext
314 * @param tc task context
317 get_statistics (void *cls,
318 const struct GNUNET_SCHEDULER_TaskContext *tc)
320 struct StatsContext *stats_context = (struct StatsContext *)cls;
321 GNUNET_TESTING_get_statistics(pg, &stats_finished_callback, &statistics_iterator, stats_context);
325 disconnect_nse_peers (void *cls,
326 const struct GNUNET_SCHEDULER_TaskContext *tc)
330 struct StatsContext *stats_context;
331 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
334 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "TEST_NSE_MULTIPEER: disconnecting nse service of peers\n");
335 while (NULL != (pos = peer_head))
337 if (pos->nse_handle != NULL)
339 GNUNET_NSE_disconnect(pos->nse_handle);
340 pos->nse_handle = NULL;
342 GNUNET_CONTAINER_DLL_remove(peer_head, peer_tail, pos);
346 GNUNET_asprintf(&buf, "round%llu", current_round);
347 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (testing_cfg, "nse-profiler", buf, &peers_next_round))
350 GNUNET_assert(churn_task == GNUNET_SCHEDULER_NO_TASK);
351 churn_task = GNUNET_SCHEDULER_add_now(&churn_peers, NULL);
353 else /* No more rounds, let's shut it down! */
355 stats_context = GNUNET_malloc(sizeof(struct StatsContext));
356 GNUNET_SCHEDULER_cancel(shutdown_handle);
357 shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
358 stats_context->task = &shutdown_task;
359 stats_context->task_cls = NULL;
360 stats_context->task_id = &shutdown_handle;
361 GNUNET_SCHEDULER_add_now(&get_statistics, stats_context);
362 //shutdown_handle = GNUNET_SCHEDULER_add_now(&shutdown_task, NULL);
368 * Prototype of a function that will be called when a
369 * particular operation was completed the testing library.
372 * @param emsg NULL on success
374 void topology_output_callback (void *cls, const char *emsg)
376 struct StatsContext *stats_context;
377 stats_context = GNUNET_malloc(sizeof(struct StatsContext));
379 disconnect_task = GNUNET_SCHEDULER_add_delayed(wait_time, &disconnect_nse_peers, NULL);
380 GNUNET_SCHEDULER_add_now(&connect_nse_service, NULL);
385 * Prototype of a function that will be called when a
386 * particular operation was completed the testing library.
389 * @param emsg NULL on success
392 churn_callback (void *cls, const char *emsg)
394 char *temp_output_file;
396 if (emsg == NULL) /* Everything is okay! */
398 peers_running = GNUNET_TESTING_daemons_running(pg);
399 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
400 "Round %lu, churn finished successfully.\n", current_round);
401 GNUNET_assert(disconnect_task == GNUNET_SCHEDULER_NO_TASK);
402 GNUNET_asprintf(&temp_output_file, "%s%lu.dot", topology_file, current_round);
403 GNUNET_TESTING_peergroup_topology_to_file(pg,
405 &topology_output_callback,
407 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Writing topology to file %s\n", temp_output_file);
408 GNUNET_free(temp_output_file);
412 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
413 "Round %lu, churn FAILED!!\n", current_round);
414 GNUNET_SCHEDULER_cancel(shutdown_handle);
415 GNUNET_SCHEDULER_add_now(&shutdown_task, NULL);
420 churn_peers (void *cls,
421 const struct GNUNET_SCHEDULER_TaskContext *tc)
423 peers_running = GNUNET_TESTING_daemons_running(pg);
424 churn_task = GNUNET_SCHEDULER_NO_TASK;
425 if (peers_next_round == peers_running)
427 /* Nothing to do... */
428 GNUNET_SCHEDULER_add_now(&connect_nse_service, NULL);
429 GNUNET_assert(disconnect_task == GNUNET_SCHEDULER_NO_TASK);
430 disconnect_task = GNUNET_SCHEDULER_add_delayed(wait_time, &disconnect_nse_peers, NULL);
431 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Round %lu, doing nothing!\n", current_round);
435 if (peers_next_round > num_peers)
437 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Asked to turn on more peers than have!!\n");
438 GNUNET_SCHEDULER_cancel(shutdown_handle);
439 GNUNET_SCHEDULER_add_now(&shutdown_task, NULL);
441 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
442 "Round %lu, turning off %lu peers, turning on %lu peers!\n",
444 (peers_running > peers_next_round) ? peers_running
445 - peers_next_round : 0,
446 (peers_next_round > peers_running) ? peers_next_round
447 - peers_running : 0);
448 GNUNET_TESTING_daemons_churn (pg,
449 (peers_running > peers_next_round) ? peers_running
452 (peers_next_round > peers_running) ? peers_next_round
454 : 0, wait_time, &churn_callback,
468 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
469 "Peergroup callback called with error, aborting test!\n");
470 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Error from testing: `%s'\n");
472 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
476 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
477 "Peer Group started successfully, connecting to NSE service for each peer!\n");
479 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Have %u connections\n", total_connections);
480 if (data_file != NULL)
483 buf_len = GNUNET_asprintf(&buf, "CONNECTIONS_0: %u\n", total_connections);
485 GNUNET_DISK_file_write(data_file, buf, buf_len);
486 GNUNET_free_non_null(buf);
488 peers_running = GNUNET_TESTING_daemons_running(pg);
489 GNUNET_SCHEDULER_add_now(&connect_nse_service, NULL);
490 disconnect_task = GNUNET_SCHEDULER_add_delayed(wait_time, &disconnect_nse_peers, NULL);
494 * Prototype of a function that will be called whenever
495 * two daemons are connected by the testing library.
498 * @param first peer id for first daemon
499 * @param second peer id for the second daemon
500 * @param distance distance between the connected peers
501 * @param first_cfg config for the first daemon
502 * @param second_cfg config for the second daemon
503 * @param first_daemon handle for the first daemon
504 * @param second_daemon handle for the second daemon
505 * @param emsg error message (NULL on success)
507 void connect_cb (void *cls,
508 const struct GNUNET_PeerIdentity *first,
509 const struct GNUNET_PeerIdentity *second,
511 const struct GNUNET_CONFIGURATION_Handle *first_cfg,
512 const struct GNUNET_CONFIGURATION_Handle *second_cfg,
513 struct GNUNET_TESTING_Daemon *first_daemon,
514 struct GNUNET_TESTING_Daemon *second_daemon,
519 second_id = GNUNET_strdup(GNUNET_i2s(second));
528 const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
531 unsigned long long temp_wait;
533 testing_cfg = GNUNET_CONFIGURATION_create();
534 GNUNET_assert(GNUNET_OK == GNUNET_CONFIGURATION_load(testing_cfg, cfgfile));
536 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting daemons.\n");
537 GNUNET_CONFIGURATION_set_value_string (testing_cfg, "testing",
541 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (testing_cfg, "testing", "num_peers", &num_peers))
543 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Option TESTING:NUM_PEERS is required!\n");
547 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (testing_cfg, "nse-profiler", "wait_time", &temp_wait))
549 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Option nse-profiler:wait_time is required!\n");
553 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (testing_cfg, "nse-profiler", "connection_limit", &connection_limit))
555 connection_limit = 0;
558 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (testing_cfg, "nse-profiler", "topology_output_file", &topology_file))
560 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Option nse-profiler:topology_output_file is required!\n");
564 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (testing_cfg, "nse-profiler", "data_output_file", &data_filename))
566 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Option nse-profiler:data_output_file is required!\n");
570 if (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno (testing_cfg, "nse-profiler", "skew_clock"))
572 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Setting our clock as skewed...\n");
573 clock_skew = GNUNET_CRYPTO_random_u64(GNUNET_CRYPTO_QUALITY_WEAK, GNUNET_TIME_UNIT_MINUTES.rel_value);
577 data_file = GNUNET_DISK_file_open (data_filename, GNUNET_DISK_OPEN_READWRITE
578 | GNUNET_DISK_OPEN_CREATE,
579 GNUNET_DISK_PERM_USER_READ |
580 GNUNET_DISK_PERM_USER_WRITE);
581 if (data_file == NULL)
582 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n", data_filename);
583 GNUNET_free(data_filename);
585 wait_time = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, temp_wait);
587 if (GNUNET_YES == GNUNET_CONFIGURATION_get_value_string(cfg, "nse-profiler", "output_file", &temp_str))
589 output_file = GNUNET_DISK_file_open (temp_str, GNUNET_DISK_OPEN_READWRITE
590 | GNUNET_DISK_OPEN_CREATE,
591 GNUNET_DISK_PERM_USER_READ |
592 GNUNET_DISK_PERM_USER_WRITE);
593 if (output_file == NULL)
594 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n", temp_str);
596 GNUNET_free_non_null(temp_str);
598 pg = GNUNET_TESTING_peergroup_start(testing_cfg,
604 GNUNET_assert (pg != NULL);
605 shutdown_handle = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_get_forever(), &shutdown_task, NULL);
611 * nse-profiler command line options
613 static struct GNUNET_GETOPT_CommandLineOption options[] = {
614 {'V', "verbose", NULL,
615 gettext_noop ("be verbose (print progress information)"),
616 0, &GNUNET_GETOPT_set_one, &verbose},
617 GNUNET_GETOPT_OPTION_END
621 main (int argc, char *argv[])
625 GNUNET_log_setup ("nse-profiler",
633 GNUNET_PROGRAM_run (argc,
634 argv, "nse-profiler", gettext_noop
635 ("Run a test of the NSE service."),
638 GNUNET_DISK_directory_remove ("/tmp/nse-profiler");
642 /* end of nse-profiler.c */