2 This file is part of GNUnet.
3 (C) 2014 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.
22 * @file dht/gnunet_dht_profiler.c
23 * @brief Profiler for GNUnet DHT
24 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
28 #include "gnunet_util_lib.h"
29 #include "gnunet_testbed_service.h"
30 #include "gnunet_dht_service.h"
33 GNUNET_log (GNUNET_ERROR_TYPE_INFO, __VA_ARGS__)
36 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
39 * Number of peers which should perform a PUT out of 100 peers
41 #define PUT_PROBABILITY 100
46 static struct GNUNET_CONFIGURATION_Handle *cfg;
49 * Name of the file with the hosts to run the test over
51 static char *hosts_file;
54 * Context for a peer which actively does DHT PUT/GET
59 * Context to hold data of peer
65 * The testbed peer this context belongs to
67 struct GNUNET_TESTBED_Peer *peer;
70 * Testbed operation acting on this peer
72 struct GNUNET_TESTBED_Operation *op;
75 * Active context; NULL if this peer is not an active peer
77 struct ActiveContext *ac;
82 * Context for a peer which actively does DHT PUT/GET
87 * The linked peer context
92 * Handler to the DHT service
94 struct GNUNET_DHT_Handle *dht;
97 * The data used for do a PUT. Will be NULL if a PUT hasn't been performed yet
102 * The active context used for our DHT GET
104 struct ActiveContext *get_ac;
109 struct GNUNET_DHT_PutHandle *dht_put;
114 struct GNUNET_DHT_GetHandle *dht_get;
117 * The hash of the @e put_data
119 struct GNUNET_HashCode hash;
124 GNUNET_SCHEDULER_TaskIdentifier delay_task;
127 * The size of the @e put_data
129 uint16_t put_data_size;
132 * The number of peers currently doing GET on our data
139 * An array of contexts. The size of this array should be equal to @a num_peers
141 static struct Context *a_ctx;
144 * Array of active peers
146 static struct ActiveContext *a_ac;
149 * The delay between starting to do PUTS and GETS
151 static struct GNUNET_TIME_Relative delay;
154 * The timeout for GET and PUT
156 static struct GNUNET_TIME_Relative timeout;
161 static unsigned int num_peers;
164 * Number of active peers
166 static unsigned int n_active;
169 * Number of DHT service connections we currently have
171 static unsigned int n_dht;
174 * Number of DHT PUTs made
176 static unsigned int n_puts;
179 * Number of DHT PUTs succeeded
181 static unsigned int n_puts_ok;
184 * Number of DHT PUTs failed
186 static unsigned int n_puts_fail;
189 * Number of DHT GETs made
191 static unsigned int n_gets;
194 * Number of DHT GETs succeeded
196 static unsigned int n_gets_ok;
199 * Number of DHT GETs succeeded
201 static unsigned int n_gets_fail;
206 static unsigned int replication;
209 * Testbed Operation (to get stats).
211 static struct GNUNET_TESTBED_Operation *stats_op;
214 * Testbed peer handles.
216 static struct GNUNET_TESTBED_Peer **testbed_handles;
219 * Total number of messages sent by peer.
221 static uint64_t outgoing_bandwidth;
224 * Total number of messages received by peer.
226 static uint64_t incoming_bandwidth;
229 * Average number of hops taken to do put.
231 static unsigned int average_put_path_length;
234 * Average number of hops taken to do get.
236 static unsigned int average_get_path_length;
238 static unsigned int total_put_path_length;
240 static unsigned int total_get_path_length;
242 * Shutdown task. Cleanup all resources and operations.
245 * @param tc scheduler task context
248 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
250 struct ActiveContext *ac;
255 for (cnt=0; cnt < num_peers; cnt++)
257 if (NULL != a_ctx[cnt].op)
258 GNUNET_TESTBED_operation_done (a_ctx[cnt].op);
260 /* Cleanup active context if this peer is an active peer */
264 if (GNUNET_SCHEDULER_NO_TASK != ac->delay_task)
265 GNUNET_SCHEDULER_cancel (ac->delay_task);
266 if (NULL != ac->put_data)
267 GNUNET_free (ac->put_data);
268 if (NULL != ac->dht_put)
269 GNUNET_DHT_put_cancel (ac->dht_put);
270 if (NULL != ac->dht_get)
271 GNUNET_DHT_get_stop (ac->dht_get);
277 GNUNET_TESTBED_operation_done (stats_op);
279 GNUNET_free_non_null (a_ac);
284 * Stats callback. Finish the stats testbed operation and when all stats have
285 * been iterated, shutdown the test.
288 * @param op the operation that has been finished
289 * @param emsg error message in case the operation has failed; will be NULL if
290 * operation has executed successfully.
293 bandwidth_stats_cont (void *cls,
294 struct GNUNET_TESTBED_Operation *op,
297 INFO ("# Outgoing bandwidth: %u\n", outgoing_bandwidth);
298 INFO ("# Incoming bandwidth: %u\n", incoming_bandwidth);
299 GNUNET_SCHEDULER_shutdown ();
304 * Process statistic values.
307 * @param peer the peer the statistic belong to
308 * @param subsystem name of subsystem that created the statistic
309 * @param name the name of the datum
310 * @param value the current value
311 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
312 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
315 bandwidth_stats_iterator (void *cls,
316 const struct GNUNET_TESTBED_Peer *peer,
317 const char *subsystem,
322 static const char *s_sent = "# Bytes transmitted to other peers";
323 static const char *s_recv = "# Bytes received from other peers";
325 if (0 == strncmp (s_sent, name, strlen (s_sent)))
326 outgoing_bandwidth = outgoing_bandwidth + value;
327 else if (0 == strncmp(s_recv, name, strlen (s_recv)))
328 incoming_bandwidth = incoming_bandwidth + value;
331 DEBUG ("Bandwith - Out: %lu; In: %lu\n",
332 (unsigned long) outgoing_bandwidth,
333 (unsigned long) incoming_bandwidth);
341 INFO ("# PUTS made: %u\n", n_puts);
342 INFO ("# PUTS succeeded: %u\n", n_puts_ok);
343 INFO ("# PUTS failed: %u\n", n_puts_fail);
344 INFO ("# GETS made: %u\n", n_gets);
345 INFO ("# GETS succeeded: %u\n", n_gets_ok);
346 INFO ("# GETS failed: %u\n", n_gets_fail);
347 INFO ("# average_put_path_length: %u\n", average_put_path_length);
348 INFO ("# average_get_path_length: %u\n", average_get_path_length);
350 if (NULL == testbed_handles)
352 INFO ("No peers found\n");
356 stats_op = GNUNET_TESTBED_get_statistics (n_active, testbed_handles,
358 bandwidth_stats_iterator,
359 bandwidth_stats_cont, NULL);
364 * Task to cancel DHT GET.
367 * @param tc scheduler task context
370 cancel_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
372 struct ActiveContext *ac = cls;
374 ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
375 GNUNET_assert (NULL != ac->dht_get);
376 GNUNET_DHT_get_stop (ac->dht_get);
380 /* If profiling is complete, summarize */
381 if (n_active == n_gets_fail + n_gets_ok)
388 * Iterator called on each result obtained for a DHT
389 * operation that expects a reply
392 * @param exp when will this value expire
393 * @param key key of the result
394 * @param get_path peers on reply path (or NULL if not recorded)
395 * [0] = datastore's first neighbor, [length - 1] = local peer
396 * @param get_path_length number of entries in @a get_path
397 * @param put_path peers on the PUT path (or NULL if not recorded)
398 * [0] = origin, [length - 1] = datastore
399 * @param put_path_length number of entries in @a put_path
400 * @param type type of the result
401 * @param size number of bytes in @a data
402 * @param data pointer to the result data
406 struct GNUNET_TIME_Absolute exp,
407 const struct GNUNET_HashCode *key,
408 const struct GNUNET_PeerIdentity *get_path,
409 unsigned int get_path_length,
410 const struct GNUNET_PeerIdentity *put_path,
411 unsigned int put_path_length,
412 enum GNUNET_BLOCK_Type type,
413 size_t size, const void *data)
415 struct ActiveContext *ac = cls;
416 struct ActiveContext *get_ac = ac->get_ac;
418 /* Check the keys of put and get match or not. */
419 GNUNET_assert (0 == memcmp (key, &get_ac->hash, sizeof (struct GNUNET_HashCode)));
420 /* we found the data we are looking for */
421 DEBUG ("We found a GET request; %u remaining\n", n_gets - (n_gets_fail + n_gets_ok));
424 GNUNET_DHT_get_stop (ac->dht_get);
426 GNUNET_SCHEDULER_cancel (ac->delay_task);
427 ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
429 total_put_path_length = total_put_path_length + put_path_length;
430 total_get_path_length = total_get_path_length + get_path_length;
432 /* Summarize if profiling is complete */
433 if (n_active == n_gets_fail + n_gets_ok)
435 average_put_path_length = total_put_path_length/n_active;
436 average_get_path_length = total_get_path_length/n_active;
443 * Task to do DHT GETs
445 * @param cls the active context
446 * @param tc the scheduler task context
449 delayed_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
451 struct ActiveContext *ac = cls;
452 struct ActiveContext *get_ac;
455 ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
459 r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, n_active);
461 if (NULL != get_ac->put_data)
466 DEBUG ("Doing a DHT GET for data of size %u\n", get_ac->put_data_size);
467 ac->dht_get = GNUNET_DHT_get_start (ac->dht,
468 GNUNET_BLOCK_TYPE_TEST,
470 1, /* replication level */
472 NULL, 0, /* extended query and size */
473 get_iter, ac); /* GET iterator and closure
477 /* schedule the timeout task for GET */
478 ac->delay_task = GNUNET_SCHEDULER_add_delayed (timeout, &cancel_get, ac);
483 * Queue up a delayed task for doing DHT GET
485 * @param cls the active context
486 * @param success #GNUNET_OK if the PUT was transmitted,
487 * #GNUNET_NO on timeout,
488 * #GNUNET_SYSERR on disconnect from service
489 * after the PUT message was transmitted
490 * (so we don't know if it was received or not)
493 put_cont (void *cls, int success)
495 struct ActiveContext *ac = cls;
502 ac->delay_task = GNUNET_SCHEDULER_add_delayed (delay, &delayed_get, ac);
507 * Task to do DHT PUTS
509 * @param cls the active context
510 * @param tc the scheduler task context
513 delayed_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
515 struct ActiveContext *ac = cls;
517 ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
518 /* Generate and DHT PUT some random data */
519 ac->put_data_size = 16; /* minimum */
520 ac->put_data_size += GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
522 ac->put_data = GNUNET_malloc (ac->put_data_size);
523 GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_WEAK,
524 ac->put_data, ac->put_data_size);
525 GNUNET_CRYPTO_hash (ac->put_data, ac->put_data_size, &ac->hash);
526 DEBUG ("Doing a DHT PUT with data of size %u\n", ac->put_data_size);
527 ac->dht_put = GNUNET_DHT_put (ac->dht, &ac->hash,
530 GNUNET_BLOCK_TYPE_TEST,
533 GNUNET_TIME_UNIT_FOREVER_ABS, /* expiration time */
534 timeout, /* PUT timeout */
535 put_cont, ac); /* continuation and its closure */
541 * Connection to DHT has been established. Call the delay task.
543 * @param cls the active context
544 * @param op the operation that has been finished
545 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
546 * @param emsg error message in case the operation has failed; will be NULL if
547 * operation has executed successfully.
550 dht_connected (void *cls,
551 struct GNUNET_TESTBED_Operation *op,
555 struct ActiveContext *ac = cls;
556 struct Context *ctx = ac->ctx;
558 GNUNET_assert (NULL != ctx);
559 GNUNET_assert (NULL != ctx->op);
560 GNUNET_assert (ctx->op == op);
561 ac->dht = (struct GNUNET_DHT_Handle *) ca_result;
564 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Connection to DHT service failed: %s\n", emsg);
565 GNUNET_TESTBED_operation_done (ctx->op); /* Calls dht_disconnect() */
569 ac->delay_task = GNUNET_SCHEDULER_add_delayed (delay, &delayed_put, ac);
574 * Connect to DHT service and return the DHT client handler
576 * @param cls the active context
577 * @param cfg configuration of the peer to connect to; will be available until
578 * GNUNET_TESTBED_operation_done() is called on the operation returned
579 * from GNUNET_TESTBED_service_connect()
580 * @return service handle to return in 'op_result', NULL on error
583 dht_connect (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
586 return GNUNET_DHT_connect (cfg, 10);
591 * Adapter function called to destroy a connection to
594 * @param cls the active context
595 * @param op_result service handle returned from the connect adapter
598 dht_disconnect (void *cls, void *op_result)
600 struct ActiveContext *ac = cls;
602 GNUNET_assert (NULL != ac->dht);
603 GNUNET_assert (ac->dht == op_result);
604 GNUNET_DHT_disconnect (ac->dht);
607 GNUNET_SCHEDULER_shutdown ();
612 * Callback called when DHT service on the peer is started
614 * @param cls the context
615 * @param op the operation that has been finished
616 * @param emsg error message in case the operation has failed; will be NULL if
617 * operation has executed successfully.
620 service_started (void *cls,
621 struct GNUNET_TESTBED_Operation *op,
624 struct Context *ctx = cls;
626 GNUNET_assert (NULL != ctx);
627 GNUNET_assert (NULL != ctx->op);
628 GNUNET_TESTBED_operation_done (ctx->op);
632 /* FIXME: connect to the DHT service and wait before starting a PUT */
633 ctx->op = GNUNET_TESTBED_service_connect (ctx, ctx->peer,
635 &dht_connected, ctx->ac,
643 * Signature of a main function for a testcase.
646 * @param h the run handle
647 * @param num_peers number of peers in 'peers'
648 * @param peers handle to peers run in the testbed
649 * @param links_succeeded the number of overlay link connection attempts that
651 * @param links_failed the number of overlay link
655 struct GNUNET_TESTBED_RunHandle *h,
656 unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers,
657 unsigned int links_succeeded,
658 unsigned int links_failed)
663 testbed_handles = peers;
669 INFO ("%u peers started\n", num_peers);
670 a_ctx = GNUNET_malloc (sizeof (struct Context) * num_peers);
672 /* select the peers which actively participate in profiling */
673 n_active = num_peers * PUT_PROBABILITY / 100;
676 GNUNET_SCHEDULER_shutdown ();
680 a_ac = GNUNET_malloc (n_active * sizeof (struct ActiveContext));
682 for (cnt = 0; cnt < num_peers && ac_cnt < n_active; cnt++)
684 if (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 100) >=
687 a_ctx[cnt].ac = &a_ac[ac_cnt];
688 a_ac[ac_cnt].ctx = &a_ctx[cnt];
692 a_ac = GNUNET_realloc (a_ac, n_active * sizeof (struct ActiveContext));
693 INFO ("Active peers: %u\n", n_active);
695 /* start DHT service on all peers */
696 for (cnt = 0; cnt < num_peers; cnt++)
698 a_ctx[cnt].peer = peers[cnt];
699 a_ctx[cnt].op = GNUNET_TESTBED_peer_manage_service (&a_ctx[cnt],
710 * Main function that will be run by the scheduler.
713 * @param args remaining command-line arguments
714 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
715 * @param config configuration
718 run (void *cls, char *const *args, const char *cfgfile,
719 const struct GNUNET_CONFIGURATION_Handle *config)
725 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Exiting as the number of peers is %u\n"),
729 cfg = GNUNET_CONFIGURATION_dup (config);
731 GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask, NULL,
732 NULL, &test_run, NULL);
733 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_shutdown,
741 * @return 0 on success
744 main (int argc, char *const *argv)
748 static struct GNUNET_GETOPT_CommandLineOption options[] = {
749 {'n', "peers", "COUNT",
750 gettext_noop ("number of peers to start"),
751 1, &GNUNET_GETOPT_set_uint, &num_peers},
752 {'H', "hosts", "FILENAME",
753 gettext_noop ("name of the file with the login information for the testbed"),
754 1, &GNUNET_GETOPT_set_string, &hosts_file},
755 {'d', "delay", "DELAY",
756 gettext_noop ("delay for starting DHT PUT and GET"),
757 1, &GNUNET_GETOPT_set_relative_time, &delay},
758 {'r', "replication", "DEGREE",
759 gettext_noop ("replication degree for DHT PUTs"),
760 1, &GNUNET_GETOPT_set_uint, &replication},
761 {'t', "timeout", "TIMEOUT",
762 gettext_noop ("timeout for DHT PUT and GET requests"),
763 1, &GNUNET_GETOPT_set_relative_time, &timeout},
764 GNUNET_GETOPT_OPTION_END
767 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
769 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30); /* default delay */
770 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1); /* default timeout */
771 replication = 1; /* default replication */
774 GNUNET_PROGRAM_run (argc, argv, "dht-profiler",
776 ("Measure quality and performance of the DHT service."),
777 options, &run, NULL))