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 50
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;
205 * Shutdown task. Cleanup all resources and operations.
208 * @param tc scheduler task context
211 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
213 struct ActiveContext *ac;
218 for (cnt=0; cnt < num_peers; cnt++)
220 if (NULL != a_ctx[cnt].op)
221 GNUNET_TESTBED_operation_done (a_ctx[cnt].op);
223 /* Cleanup active context if this peer is an active peer */
227 if (GNUNET_SCHEDULER_NO_TASK != ac->delay_task)
228 GNUNET_SCHEDULER_cancel (ac->delay_task);
229 if (NULL != ac->put_data)
230 GNUNET_free (ac->put_data);
231 if (NULL != ac->dht_put)
232 GNUNET_DHT_put_cancel (ac->dht_put);
233 if (NULL != ac->dht_get)
234 GNUNET_DHT_get_stop (ac->dht_get);
239 GNUNET_free_non_null (a_ac);
246 INFO ("# PUTS made: %u\n", n_puts);
247 INFO ("# PUTS succeeded: %u\n", n_puts_ok);
248 INFO ("# PUTS failed: %u\n", n_puts_fail);
249 INFO ("# GETS made: %u\n", n_gets);
250 INFO ("# GETS succeeded: %u\n", n_gets_ok);
251 INFO ("# GETS failed: %u\n", n_gets_fail);
252 GNUNET_SCHEDULER_shutdown ();
257 * Task to cancel DHT GET.
260 * @param tc scheduler task context
263 cancel_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
265 struct ActiveContext *ac = cls;
267 ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
268 GNUNET_assert (NULL != ac->dht_get);
269 GNUNET_DHT_get_stop (ac->dht_get);
273 /* If profiling is complete, summarize */
274 if (n_gets == n_gets_fail + n_gets_ok)
280 * Iterator called on each result obtained for a DHT
281 * operation that expects a reply
284 * @param exp when will this value expire
285 * @param key key of the result
286 * @param get_path peers on reply path (or NULL if not recorded)
287 * [0] = datastore's first neighbor, [length - 1] = local peer
288 * @param get_path_length number of entries in @a get_path
289 * @param put_path peers on the PUT path (or NULL if not recorded)
290 * [0] = origin, [length - 1] = datastore
291 * @param put_path_length number of entries in @a put_path
292 * @param type type of the result
293 * @param size number of bytes in @a data
294 * @param data pointer to the result data
298 struct GNUNET_TIME_Absolute exp,
299 const struct GNUNET_HashCode *key,
300 const struct GNUNET_PeerIdentity *get_path,
301 unsigned int get_path_length,
302 const struct GNUNET_PeerIdentity *put_path,
303 unsigned int put_path_length,
304 enum GNUNET_BLOCK_Type type,
305 size_t size, const void *data)
307 struct ActiveContext *ac = cls;
308 struct ActiveContext *get_ac = ac->get_ac;
310 if (get_ac->put_data_size != size)
312 DEBUG ("Found a GET with incorrect data length (this may happen, but very unlikely)\n");
315 if (0 != memcmp (data, get_ac->put_data, size))
317 DEBUG ("Found a GET with incorrect data (this may happen, but very unlikely)\n");
321 /* we found the data we are looking for */
322 DEBUG ("We found a GET request; %u remaining\n", n_gets - (n_gets_fail + n_gets_ok));
325 GNUNET_DHT_get_stop (ac->dht_get);
327 GNUNET_SCHEDULER_cancel (ac->delay_task);
328 ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
330 /* Summarize if profiling is complete */
331 if (n_gets == n_gets_fail + n_gets_ok)
337 * Task to do DHT GETs
339 * @param cls the active context
340 * @param tc the scheduler task context
343 delayed_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
345 struct ActiveContext *ac = cls;
346 struct ActiveContext *get_ac;
349 ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
353 r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, n_active);
355 if (NULL != get_ac->put_data)
360 ac->dht_get = GNUNET_DHT_get_start (ac->dht,
361 GNUNET_BLOCK_TYPE_TEST,
363 1, /* replication level */
365 NULL, 0, /* extended query and size */
366 get_iter, ac); /* GET iterator and closure
370 /* schedule the timeout task for GET */
371 ac->delay_task = GNUNET_SCHEDULER_add_delayed (timeout, &cancel_get, ac);
376 * Queue up a delayed task for doing DHT GET
378 * @param cls the active context
379 * @param success #GNUNET_OK if the PUT was transmitted,
380 * #GNUNET_NO on timeout,
381 * #GNUNET_SYSERR on disconnect from service
382 * after the PUT message was transmitted
383 * (so we don't know if it was received or not)
386 put_cont (void *cls, int success)
388 struct ActiveContext *ac = cls;
395 ac->delay_task = GNUNET_SCHEDULER_add_delayed (delay, &delayed_get, ac);
400 * Task to do DHT PUTS
402 * @param cls the active context
403 * @param tc the scheduler task context
406 delayed_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
408 struct ActiveContext *ac = cls;
410 ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
411 /* Generate and DHT PUT some random data */
412 ac->put_data_size = 16; /* minimum */
413 ac->put_data_size += GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
415 ac->put_data = GNUNET_malloc (ac->put_data_size);
416 GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_WEAK,
417 ac->put_data, ac->put_data_size);
418 GNUNET_CRYPTO_hash (ac->put_data, ac->put_data_size, &ac->hash);
419 DEBUG ("Doing a DHT PUT with data of size %u\n", ac->put_data_size);
420 ac->dht_put = GNUNET_DHT_put (ac->dht, &ac->hash,
421 1, /* replication level */
423 GNUNET_BLOCK_TYPE_TEST,
426 GNUNET_TIME_UNIT_FOREVER_ABS, /* expiration time */
427 timeout, /* PUT timeout */
428 put_cont, ac); /* continuation and its closure */
434 * Connection to DHT has been established. Call the delay task.
436 * @param cls the active context
437 * @param op the operation that has been finished
438 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
439 * @param emsg error message in case the operation has failed; will be NULL if
440 * operation has executed successfully.
443 dht_connected (void *cls,
444 struct GNUNET_TESTBED_Operation *op,
448 struct ActiveContext *ac = cls;
449 struct Context *ctx = ac->ctx;
451 GNUNET_assert (NULL != ctx);
452 GNUNET_assert (NULL != ctx->op);
453 GNUNET_assert (ctx->op == op);
454 ac->dht = (struct GNUNET_DHT_Handle *) ca_result;
457 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Connection to DHT service failed: %s\n", emsg);
458 GNUNET_TESTBED_operation_done (ctx->op); /* Calls dht_disconnect() */
462 ac->delay_task = GNUNET_SCHEDULER_add_delayed (delay, &delayed_put, ac);
467 * Connect to DHT service and return the DHT client handler
469 * @param cls the active context
470 * @param cfg configuration of the peer to connect to; will be available until
471 * GNUNET_TESTBED_operation_done() is called on the operation returned
472 * from GNUNET_TESTBED_service_connect()
473 * @return service handle to return in 'op_result', NULL on error
476 dht_connect (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
479 return GNUNET_DHT_connect (cfg, 10);
484 * Adapter function called to destroy a connection to
487 * @param cls the active context
488 * @param op_result service handle returned from the connect adapter
491 dht_disconnect (void *cls, void *op_result)
493 struct ActiveContext *ac = cls;
495 GNUNET_assert (NULL != ac->dht);
496 GNUNET_assert (ac->dht == op_result);
497 GNUNET_DHT_disconnect (ac->dht);
500 GNUNET_SCHEDULER_shutdown ();
505 * Callback called when DHT service on the peer is started
507 * @param cls the context
508 * @param op the operation that has been finished
509 * @param emsg error message in case the operation has failed; will be NULL if
510 * operation has executed successfully.
513 service_started (void *cls,
514 struct GNUNET_TESTBED_Operation *op,
517 struct Context *ctx = cls;
519 GNUNET_assert (NULL != ctx);
520 GNUNET_assert (NULL != ctx->op);
521 GNUNET_TESTBED_operation_done (ctx->op);
525 /* FIXME: connect to the DHT service and wait before starting a PUT */
526 ctx->op = GNUNET_TESTBED_service_connect (ctx, ctx->peer,
528 &dht_connected, ctx->ac,
536 * Signature of a main function for a testcase.
539 * @param h the run handle
540 * @param num_peers number of peers in 'peers'
541 * @param peers handle to peers run in the testbed
542 * @param links_succeeded the number of overlay link connection attempts that
544 * @param links_failed the number of overlay link
548 struct GNUNET_TESTBED_RunHandle *h,
549 unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers,
550 unsigned int links_succeeded,
551 unsigned int links_failed)
561 INFO ("%u peers started\n", num_peers);
562 a_ctx = GNUNET_malloc (sizeof (struct Context) * num_peers);
564 /* select the peers which actively participate in profiling */
565 n_active = num_peers * PUT_PROBABILITY / 100;
568 GNUNET_SCHEDULER_shutdown ();
572 a_ac = GNUNET_malloc (n_active * sizeof (struct ActiveContext));
574 for (cnt = 0; cnt < num_peers && ac_cnt < n_active; cnt++)
576 if (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 100) >=
579 a_ctx[cnt].ac = &a_ac[ac_cnt];
580 a_ac[ac_cnt].ctx = &a_ctx[cnt];
584 a_ac = GNUNET_realloc (a_ac, n_active * sizeof (struct ActiveContext));
585 INFO ("Active peers: %u\n", n_active);
587 /* start DHT service on all peers */
588 for (cnt = 0; cnt < num_peers; cnt++)
590 a_ctx[cnt].peer = peers[cnt];
591 a_ctx[cnt].op = GNUNET_TESTBED_peer_manage_service (&a_ctx[cnt],
602 * Main function that will be run by the scheduler.
605 * @param args remaining command-line arguments
606 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
607 * @param config configuration
610 run (void *cls, char *const *args, const char *cfgfile,
611 const struct GNUNET_CONFIGURATION_Handle *config)
617 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Exiting as the number of peers is %u\n"),
621 cfg = GNUNET_CONFIGURATION_dup (config);
623 GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask, NULL,
624 NULL, &test_run, NULL);
625 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_shutdown,
633 * @return 0 on success
636 main (int argc, char *const *argv)
640 static struct GNUNET_GETOPT_CommandLineOption options[] = {
641 {'n', "peers", "COUNT",
642 gettext_noop ("number of peers to start"),
643 1, &GNUNET_GETOPT_set_uint, &num_peers},
644 {'H', "hosts", "FILENAME",
645 gettext_noop ("name of the file with the login information for the testbed"),
646 1, &GNUNET_GETOPT_set_string, &hosts_file},
647 {'d', "delay", "DELAY",
648 gettext_noop ("delay for starting DHT PUT and GET"),
649 1, &GNUNET_GETOPT_set_relative_time, &delay},
650 {'t', "timeout", "TIMEOUT",
651 gettext_noop ("timeout for DHT PUT and GET requests"),
652 1, &GNUNET_GETOPT_set_relative_time, &timeout},
653 GNUNET_GETOPT_OPTION_END
656 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
658 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3); /* default delay */
659 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3); /* default timeout */
662 GNUNET_PROGRAM_run (argc, argv, "dht-profiler",
664 ("Measure quality and performance of the DHT service."),
665 options, &run, NULL))