2 This file is part of GNUnet
3 Copyright (C) 2012 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file consensus/gnunet-consensus-profiler.c
23 * @brief profiling tool for gnunet-consensus
24 * @author Florian Dold
27 #include "gnunet_util_lib.h"
28 #include "gnunet_time_lib.h"
29 #include "gnunet_consensus_service.h"
30 #include "gnunet_testbed_service.h"
32 static unsigned int num_peers = 2;
34 static unsigned int replication = 1;
36 static unsigned int num_values = 5;
38 static struct GNUNET_TIME_Relative conclude_timeout;
40 static struct GNUNET_TIME_Relative consensus_delay;
42 static struct GNUNET_CONSENSUS_Handle **consensus_handles;
44 static struct GNUNET_TESTBED_Operation **testbed_operations;
46 static unsigned int num_connected_handles;
48 static struct GNUNET_TESTBED_Peer **peers;
50 static struct GNUNET_PeerIdentity *peer_ids;
52 static unsigned int num_retrieved_peer_ids;
54 static struct GNUNET_HashCode session_id;
56 static unsigned int peers_done = 0;
58 static int dist_static;
60 static unsigned *results_for_peer;
63 * The profiler will write statistics
64 * for all peers to the file with this name.
66 static char *statistics_filename;
69 * The profiler will write statistics
70 * for all peers to this file.
72 static FILE *statistics_file;
77 * Start time for all consensuses.
79 static struct GNUNET_TIME_Absolute start;
82 * Deadline for all consensuses.
84 static struct GNUNET_TIME_Absolute deadline;
88 * Signature of the event handler function called by the
89 * respective event controller.
92 * @param event information about the event
95 controller_cb (void *cls,
96 const struct GNUNET_TESTBED_EventInformation *event)
103 statistics_done_cb (void *cls,
105 GNUNET_TESTBED_Operation
109 GNUNET_assert (NULL == emsg);
110 GNUNET_TESTBED_operation_done (op);
111 if (NULL != statistics_file)
112 fclose (statistics_file);
113 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "got statistics, shutting down\n");
114 GNUNET_SCHEDULER_shutdown ();
119 * Callback function to process statistic values from all peers.
122 * @param peer the peer the statistic belong to
123 * @param subsystem name of subsystem that created the statistic
124 * @param name the name of the datum
125 * @param value the current value
126 * @param is_persistent #GNUNET_YES if the value is persistent, #GNUNET_NO if not
127 * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
130 statistics_cb (void *cls,
131 const struct GNUNET_TESTBED_Peer *peer,
132 const char *subsystem,
137 if (NULL != statistics_file)
139 fprintf (statistics_file, "P%u\t%s\t%s\t%lu\n", GNUNET_TESTBED_get_index (peer), subsystem, name, (unsigned long) value);
148 struct GNUNET_CONSENSUS_Handle *consensus = cls;
150 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
151 "destroying consensus\n");
152 GNUNET_CONSENSUS_destroy (consensus);
154 if (peers_done == num_peers)
157 for (i = 0; i < num_peers; i++)
158 GNUNET_TESTBED_operation_done (testbed_operations[i]);
159 for (i = 0; i < num_peers; i++)
160 printf ("P%u got %u of %u elements\n",
164 if (NULL != statistics_filename)
165 statistics_file = fopen (statistics_filename, "w");
166 GNUNET_TESTBED_get_statistics (num_peers, peers, NULL, NULL,
175 * Called when a conclusion was successful.
177 * @param cls closure, the consensus handle
178 * @return #GNUNET_YES if more consensus groups should be offered,
182 conclude_cb (void *cls)
184 struct GNUNET_CONSENSUS_Handle **chp = cls;
186 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
187 "consensus %d done\n",
188 (int) (chp - consensus_handles));
189 GNUNET_SCHEDULER_add_now (destroy, *chp);
194 generate_indices (int *indices)
198 while (j < replication)
203 n = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, num_peers);
205 for (k = 0; k < j; k++)
211 if (GNUNET_NO == repeat)
220 int unique_indices[replication];
223 struct GNUNET_HashCode val;
224 struct GNUNET_SET_Element element;
228 for (i = 0; i < num_values; i++)
231 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_WEAK, &val);
234 element.size = sizeof (val);
235 for (j = 0; j < replication; j++)
237 GNUNET_CONSENSUS_insert (consensus_handles[j],
245 for (i = 0; i < num_values; i++)
247 generate_indices (unique_indices);
248 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_WEAK, &val);
251 element.size = sizeof (val);
252 for (j = 0; j < replication; j++)
256 cid = unique_indices[j];
257 GNUNET_CONSENSUS_insert (consensus_handles[cid],
264 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
265 "all elements inserted, calling conclude\n");
267 for (i = 0; i < num_peers; i++)
268 GNUNET_CONSENSUS_conclude (consensus_handles[i],
269 conclude_cb, &consensus_handles[i]);
274 * Callback to be called when a service connect operation is completed
276 * @param cls the callback closure from functions generating an operation
277 * @param op the operation that has been finished
278 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
279 * @param emsg error message in case the operation has failed; will be NULL if
280 * operation has executed successfully.
283 connect_complete (void *cls,
284 struct GNUNET_TESTBED_Operation *op,
291 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
292 "testbed connect emsg: %s\n",
297 num_connected_handles++;
299 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
300 "connect complete\n");
302 if (num_connected_handles == num_peers)
310 new_element_cb (void *cls,
311 const struct GNUNET_SET_Element *element)
313 struct GNUNET_CONSENSUS_Handle **chp = cls;
314 int idx = chp - consensus_handles;
316 GNUNET_assert (NULL != cls);
318 results_for_peer[idx]++;
320 GNUNET_assert (sizeof (struct GNUNET_HashCode) == element->size);
322 if (GNUNET_YES == verbose)
324 printf ("P%d received %s\n",
326 GNUNET_h2s ((struct GNUNET_HashCode *) element->data));
332 * Adapter function called to establish a connection to
336 * @param cfg configuration of the peer to connect to; will be available until
337 * GNUNET_TESTBED_operation_done() is called on the operation returned
338 * from GNUNET_TESTBED_service_connect()
339 * @return service handle to return in 'op_result', NULL on error
342 connect_adapter (void *cls,
343 const struct GNUNET_CONFIGURATION_Handle *cfg)
345 struct GNUNET_CONSENSUS_Handle **chp = cls;
346 struct GNUNET_CONSENSUS_Handle *consensus;
347 chp = (struct GNUNET_CONSENSUS_Handle **) cls;
349 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
350 "connect adapter, %d peers\n",
352 consensus = GNUNET_CONSENSUS_create (cfg,
357 &new_element_cb, chp);
358 *chp = (struct GNUNET_CONSENSUS_Handle *) consensus;
364 * Adapter function called to destroy a connection to
368 * @param op_result service handle returned from the connect adapter
371 disconnect_adapter(void *cls, void *op_result)
373 /* FIXME: what to do here? */
374 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
375 "disconnect adapter called\n");
380 * Callback to be called when the requested peer information is available
382 * @param cb_cls the closure from GNUNET_TETSBED_peer_get_information()
383 * @param op the operation this callback corresponds to
384 * @param pinfo the result; will be NULL if the operation has failed
385 * @param emsg error message if the operation has failed; will be NULL if the
386 * operation is successfull
389 peer_info_cb (void *cb_cls,
390 struct GNUNET_TESTBED_Operation *op,
391 const struct GNUNET_TESTBED_PeerInformation *pinfo,
394 struct GNUNET_PeerIdentity *p;
397 GNUNET_assert (NULL == emsg);
399 p = (struct GNUNET_PeerIdentity *) cb_cls;
401 if (pinfo->pit == GNUNET_TESTBED_PIT_IDENTITY)
403 *p = *pinfo->result.id;
404 num_retrieved_peer_ids++;
405 if (num_retrieved_peer_ids == num_peers)
406 for (i = 0; i < num_peers; i++)
407 testbed_operations[i] =
408 GNUNET_TESTBED_service_connect (NULL, peers[i], "consensus", connect_complete, NULL,
409 connect_adapter, disconnect_adapter, &consensus_handles[i]);
416 GNUNET_TESTBED_operation_done (op);
421 * Signature of a main function for a testcase.
424 * @param h the run handle
425 * @param num_peers number of peers in 'peers'
426 * @param started_peers handle to peers run in the testbed. NULL upon timeout (see
427 * GNUNET_TESTBED_test_run()).
428 * @param links_succeeded the number of overlay link connection attempts that
430 * @param links_failed the number of overlay link connection attempts that
434 test_master (void *cls,
435 struct GNUNET_TESTBED_RunHandle *h,
436 unsigned int num_peers,
437 struct GNUNET_TESTBED_Peer **started_peers,
438 unsigned int links_succeeded,
439 unsigned int links_failed)
443 GNUNET_log_setup ("gnunet-consensus", "INFO", NULL);
445 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "test master\n");
447 peers = started_peers;
449 peer_ids = GNUNET_malloc (num_peers * sizeof (struct GNUNET_PeerIdentity));
451 results_for_peer = GNUNET_malloc (num_peers * sizeof (unsigned int));
452 consensus_handles = GNUNET_malloc (num_peers * sizeof (struct ConsensusHandle *));
453 testbed_operations = GNUNET_malloc (num_peers * sizeof (struct ConsensusHandle *));
455 for (i = 0; i < num_peers; i++)
456 GNUNET_TESTBED_peer_get_information (peers[i],
457 GNUNET_TESTBED_PIT_IDENTITY,
464 run (void *cls, char *const *args, const char *cfgfile,
465 const struct GNUNET_CONFIGURATION_Handle *cfg)
467 static char *session_str = "gnunet-consensus/test";
469 int topology_cmp_result;
471 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "testbed", "OVERLAY_TOPOLOGY", &topology))
474 "'OVERLAY_TOPOLOGY' not found in 'testbed' config section, "
475 "seems like you passed the wrong configuration file\n");
479 topology_cmp_result = strcasecmp (topology, "NONE");
480 GNUNET_free (topology);
482 if (0 == topology_cmp_result)
485 "'OVERLAY_TOPOLOGY' set to 'NONE', "
486 "seems like you passed the wrong configuration file\n");
490 if (num_peers < replication)
492 fprintf (stderr, "k must be <=n\n");
496 start = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (), consensus_delay);
497 deadline = GNUNET_TIME_absolute_add (start, conclude_timeout);
499 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
500 "running gnunet-consensus\n");
502 GNUNET_CRYPTO_hash (session_str, strlen(session_str), &session_id);
504 (void) GNUNET_TESTBED_test_run ("gnunet-consensus",
516 main (int argc, char **argv)
518 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
519 { 'n', "num-peers", NULL,
520 gettext_noop ("number of peers in consensus"),
521 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers },
522 { 'k', "value-replication", NULL,
523 gettext_noop ("how many peers (random selection without replacement) receive one value?"),
524 GNUNET_YES, &GNUNET_GETOPT_set_uint, &replication },
525 { 'x', "num-values", NULL,
526 gettext_noop ("number of values"),
527 GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_values },
528 { 't', "timeout", NULL,
529 gettext_noop ("consensus timeout"),
530 GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &conclude_timeout },
531 { 'd', "delay", NULL,
532 gettext_noop ("delay until consensus starts"),
533 GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &consensus_delay },
534 { 's', "statistics", NULL,
535 gettext_noop ("write statistics to file"),
536 GNUNET_YES, &GNUNET_GETOPT_set_filename, &statistics_filename },
537 { 'S', "dist-static", NULL,
538 gettext_noop ("distribute elements to a static subset of good peers"),
539 GNUNET_YES, &GNUNET_GETOPT_set_one, &dist_static },
540 { 'V', "verbose", NULL,
541 gettext_noop ("be more verbose (print received values)"),
542 GNUNET_NO, &GNUNET_GETOPT_set_one, &verbose },
543 GNUNET_GETOPT_OPTION_END
545 conclude_timeout = GNUNET_TIME_UNIT_SECONDS;
546 GNUNET_PROGRAM_run2 (argc, argv, "gnunet-consensus-profiler",
548 options, &run, NULL, GNUNET_YES);