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 dht/test_dht_multipeer.c
22 * @brief testcase for testing DHT service with
26 #include "gnunet_testing_lib.h"
27 #include "gnunet_core_service.h"
28 #include "gnunet_dht_service.h"
31 #define VERBOSE GNUNET_EXTRA_LOGGING
33 /* Timeout for entire testcase */
34 #define TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 30)
36 /* Timeout for waiting for replies to get requests */
37 #define GET_TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 300)
40 #define START_DELAY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 30)
42 /* Timeout for waiting for gets to complete */
43 #define GET_DELAY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 50)
45 /* Timeout for waiting for puts to complete */
46 #define PUT_DELAY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 50)
48 /* If number of peers not in config file, use this number */
49 #define DEFAULT_NUM_PEERS 10
51 #define TEST_DATA_SIZE 8
53 #define MAX_OUTSTANDING_PUTS 100
55 #define MAX_OUTSTANDING_GETS 100
57 #define PATH_TRACKING GNUNET_NO
64 * This is a linked list
66 struct TestPutContext *next;
69 * This is a linked list
71 struct TestPutContext *prev;
74 * Handle to the first peers DHT service (via the API)
76 struct GNUNET_DHT_Handle *dht_handle;
79 * Handle to the PUT peer daemon
81 struct GNUNET_TESTING_Daemon *daemon;
84 * Identifier for this PUT
89 * Task handle for processing of the put.
91 GNUNET_SCHEDULER_TaskIdentifier task;
98 * This is a linked list
100 struct TestGetContext *next;
103 * This is a linked list
105 struct TestGetContext *prev;
108 * Handle to the first peers DHT service (via the API)
110 struct GNUNET_DHT_Handle *dht_handle;
113 * Handle for the DHT get request
115 struct GNUNET_DHT_GetHandle *get_handle;
118 * Handle to the GET peer daemon
120 struct GNUNET_TESTING_Daemon *daemon;
123 * Identifier for this GET
128 * Task for disconnecting DHT handles (and stopping GET)
130 GNUNET_SCHEDULER_TaskIdentifier task;
133 * Whether or not this request has been fulfilled already.
140 * List of GETS to perform
142 static struct TestGetContext *all_gets_head;
145 * List of GETS to perform
147 static struct TestGetContext *all_gets_tail;
150 * List of PUTS to perform
152 static struct TestPutContext *all_puts_head;
155 * List of PUTS to perform
157 static struct TestPutContext *all_puts_tail;
160 * Handle to the set of all peers run for this test.
162 static struct GNUNET_TESTING_PeerGroup *pg;
165 * Total number of peers to run, set based on config file.
167 static unsigned long long num_peers;
170 * How many puts do we currently have in flight?
172 static unsigned long long outstanding_puts;
175 * How many puts are done?
177 static unsigned long long puts_completed;
180 * How many puts do we currently have in flight?
182 static unsigned long long outstanding_gets;
185 * How many gets are done?
187 static unsigned long long gets_completed;
190 * How many gets failed?
192 static unsigned long long gets_failed;
195 * Directory to remove on shutdown.
197 static char *test_directory;
200 * Option to use when routing.
202 static enum GNUNET_DHT_RouteOption route_option;
205 * Task handle to use to schedule test failure / success.
207 static GNUNET_SCHEDULER_TaskIdentifier die_task;
210 * Global return value (0 for success, anything else for failure)
216 * Check whether peers successfully shut down.
219 shutdown_callback (void *cls, const char *emsg)
223 fprintf (stderr, "Failed to shutdown testing topology: %s\n", emsg);
230 do_stop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
232 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
238 * Master context for 'stat_run'.
242 struct GNUNET_STATISTICS_Handle *stat;
249 const char *subsystem;
251 unsigned long long total;
255 * Statistics we print out.
257 static struct StatValues stats[] = {
258 {"core", "# bytes decrypted", 0},
259 {"core", "# bytes encrypted", 0},
260 {"core", "# type maps received", 0},
261 {"core", "# session keys confirmed via PONG", 0},
262 {"core", "# entries in session map", 0},
263 {"core", "# key exchanges initiated", 0},
264 {"core", "# send requests dropped (disconnected)", 0},
265 {"core", "# transmissions delayed due to corking", 0},
266 {"core", "# messages discarded (expired prior to transmission)", 0},
267 {"core", "# messages discarded (disconnected)", 0},
268 {"core", "# discarded CORE_SEND requests", 0},
269 {"core", "# discarded lower priority CORE_SEND requests", 0},
270 {"transport", "# bytes received via TCP", 0},
271 {"transport", "# bytes transmitted via TCP", 0},
272 {"dht", "# PUT messages queued for transmission", 0},
273 {"dht", "# P2P PUT requests received", 0},
274 {"dht", "# GET messages queued for transmission", 0},
275 {"dht", "# P2P GET requests received", 0},
276 {"dht", "# RESULT messages queued for transmission", 0},
277 {"dht", "# P2P RESULTS received", 0},
278 {"dht", "# Queued messages discarded (peer disconnected)", 0},
279 {"dht", "# Peers excluded from routing due to Bloomfilter", 0},
280 {"dht", "# Peer selection failed", 0},
281 {"dht", "# FIND PEER requests ignored due to Bloomfilter", 0},
282 {"dht", "# FIND PEER requests ignored due to lack of HELLO", 0},
283 {"dht", "# P2P FIND PEER requests processed", 0},
284 {"dht", "# P2P GET requests ONLY routed", 0},
285 {"dht", "# Preference updates given to core", 0},
286 {"dht", "# REPLIES ignored for CLIENTS (no match)", 0},
287 {"dht", "# GET requests from clients injected", 0},
288 {"dht", "# GET requests received from clients", 0},
289 {"dht", "# GET STOP requests received from clients", 0},
290 {"dht", "# ITEMS stored in datacache", 0},
291 {"dht", "# Good RESULTS found in datacache", 0},
292 {"dht", "# GET requests given to datacache", 0},
298 * Callback function to process statistic values.
301 * @param subsystem name of subsystem that created the statistic
302 * @param name the name of the datum
303 * @param value the current value
304 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
305 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
308 print_stat (void *cls, const char *subsystem, const char *name, uint64_t value,
311 struct StatMaster *sm = cls;
313 stats[sm->value].total += value;
314 fprintf (stderr, "Peer %2u: %12s/%50s = %12llu\n", sm->daemon, subsystem,
315 name, (unsigned long long) value);
321 * Function that gathers stats from all daemons.
324 stat_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
328 * Function called when GET operation on stats is done.
331 get_done (void *cls, int success)
333 struct StatMaster *sm = cls;
335 GNUNET_break (GNUNET_OK == success);
337 GNUNET_SCHEDULER_add_now (&stat_run, sm);
342 * Function that gathers stats from all daemons.
345 stat_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
347 struct StatMaster *sm = cls;
350 die_task = GNUNET_SCHEDULER_NO_TASK;
351 if (stats[sm->value].name != NULL)
353 GNUNET_STATISTICS_get (sm->stat,
357 stats[sm->value].subsystem, stats[sm->value].name,
359 GNUNET_TIME_UNIT_FOREVER_REL, &get_done, &print_stat,
363 GNUNET_STATISTICS_destroy (sm->stat, GNUNET_NO);
366 if (sm->daemon == num_peers)
370 while (stats[i].name != NULL)
372 fprintf (stderr, "Total : %12s/%50s = %12llu\n", stats[i].subsystem,
373 stats[i].name, (unsigned long long) stats[i].total);
376 die_task = GNUNET_SCHEDULER_add_now (&do_stop, NULL);
380 GNUNET_STATISTICS_create ("<driver>",
381 GNUNET_TESTING_daemon_get (pg,
383 die_task = GNUNET_SCHEDULER_add_now (&stat_run, sm);
388 * Function scheduled to be run on the successful completion of this
392 finish_testing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
394 struct TestPutContext *test_put;
395 struct TestGetContext *test_get;
396 struct StatMaster *sm;
398 die_task = GNUNET_SCHEDULER_NO_TASK;
399 while (NULL != (test_put = all_puts_head))
401 if (test_put->task != GNUNET_SCHEDULER_NO_TASK)
402 GNUNET_SCHEDULER_cancel (test_put->task);
403 if (test_put->dht_handle != NULL)
404 GNUNET_DHT_disconnect (test_put->dht_handle);
405 GNUNET_CONTAINER_DLL_remove (all_puts_head, all_puts_tail, test_put);
406 GNUNET_free (test_put);
409 while (NULL != (test_get = all_gets_head))
411 if (test_get->task != GNUNET_SCHEDULER_NO_TASK)
412 GNUNET_SCHEDULER_cancel (test_get->task);
413 if (test_get->get_handle != NULL)
414 GNUNET_DHT_get_stop (test_get->get_handle);
415 if (test_get->dht_handle != NULL)
416 GNUNET_DHT_disconnect (test_get->dht_handle);
417 GNUNET_CONTAINER_DLL_remove (all_gets_head, all_gets_tail, test_get);
418 GNUNET_free (test_get);
420 sm = GNUNET_malloc (sizeof (struct StatMaster));
422 GNUNET_STATISTICS_create ("<driver>",
423 GNUNET_TESTING_daemon_get (pg,
425 die_task = GNUNET_SCHEDULER_add_now (&stat_run, sm);
430 * Check if the get_handle is being used, if so stop the request. Either
431 * way, schedule the end_badly_cont function which actually shuts down the
435 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
437 const char *emsg = cls;
438 struct TestPutContext *test_put;
439 struct TestGetContext *test_get;
441 die_task = GNUNET_SCHEDULER_NO_TASK;
442 fprintf (stderr, "Failing test with error: `%s'!\n", emsg);
443 while (NULL != (test_put = all_puts_head))
445 if (test_put->task != GNUNET_SCHEDULER_NO_TASK)
446 GNUNET_SCHEDULER_cancel (test_put->task);
447 if (test_put->dht_handle != NULL)
448 GNUNET_DHT_disconnect (test_put->dht_handle);
449 GNUNET_CONTAINER_DLL_remove (all_puts_head, all_puts_tail, test_put);
450 GNUNET_free (test_put);
453 while (NULL != (test_get = all_gets_head))
455 if (test_get->task != GNUNET_SCHEDULER_NO_TASK)
456 GNUNET_SCHEDULER_cancel (test_get->task);
457 if (test_get->get_handle != NULL)
458 GNUNET_DHT_get_stop (test_get->get_handle);
459 if (test_get->dht_handle != NULL)
460 GNUNET_DHT_disconnect (test_get->dht_handle);
461 GNUNET_CONTAINER_DLL_remove (all_gets_head, all_gets_tail, test_get);
462 GNUNET_free (test_get);
465 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
471 * Task to release get handle.
474 get_stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
476 struct TestGetContext *test_get = cls;
477 GNUNET_HashCode search_key; /* Key stored under */
478 char original_data[TEST_DATA_SIZE]; /* Made up data to store */
480 test_get->task = GNUNET_SCHEDULER_NO_TASK;
481 memset (original_data, test_get->uid, sizeof (original_data));
482 GNUNET_CRYPTO_hash (original_data, TEST_DATA_SIZE, &search_key);
483 if (test_get->succeeded != GNUNET_YES)
486 fprintf (stderr, "Get from peer %s for key %s failed!\n",
487 GNUNET_i2s (&test_get->daemon->id), GNUNET_h2s (&search_key));
489 GNUNET_assert (test_get->get_handle != NULL);
490 GNUNET_DHT_get_stop (test_get->get_handle);
491 test_get->get_handle = NULL;
493 outstanding_gets--; /* GET is really finished */
494 GNUNET_DHT_disconnect (test_get->dht_handle);
495 test_get->dht_handle = NULL;
497 GNUNET_CONTAINER_DLL_remove (all_gets_head, all_gets_tail, test_get);
498 GNUNET_free (test_get);
499 if ((gets_failed > 10) && (outstanding_gets == 0))
501 /* Had more than 10% failures */
502 fprintf (stderr, "%llu gets succeeded, %llu gets failed!\n", gets_completed,
504 GNUNET_SCHEDULER_cancel (die_task);
507 GNUNET_SCHEDULER_add_now (&finish_testing, "not all gets succeeded");
510 if ((gets_completed + gets_failed == num_peers * num_peers) && (outstanding_gets == 0)) /* All gets successful */
512 fprintf (stderr, "%llu gets succeeded, %llu gets failed!\n", gets_completed,
514 GNUNET_SCHEDULER_cancel (die_task);
516 die_task = GNUNET_SCHEDULER_add_now (&finish_testing, NULL);
522 * Iterator called if the GET request initiated returns a response.
525 * @param exp when will this value expire
526 * @param key key of the result
527 * @param type type of the result
528 * @param size number of bytes in data
529 * @param data pointer to the result data
532 get_result_iterator (void *cls, struct GNUNET_TIME_Absolute exp,
533 const GNUNET_HashCode * key,
534 const struct GNUNET_PeerIdentity *get_path,
535 unsigned int get_path_length,
536 const struct GNUNET_PeerIdentity *put_path,
537 unsigned int put_path_length, enum GNUNET_BLOCK_Type type,
538 size_t size, const void *data)
540 struct TestGetContext *test_get = cls;
541 GNUNET_HashCode search_key; /* Key stored under */
542 char original_data[TEST_DATA_SIZE]; /* Made up data to store */
544 memset (original_data, test_get->uid, sizeof (original_data));
545 GNUNET_CRYPTO_hash (original_data, TEST_DATA_SIZE, &search_key);
546 if (test_get->succeeded == GNUNET_YES)
547 return; /* Get has already been successful, probably ending now */
550 if (put_path != NULL)
554 fprintf (stderr, "PUT (%u) Path: ", test_get->uid);
555 for (i = 0; i < put_path_length; i++)
556 fprintf (stderr, "%s%s", i == 0 ? "" : "->", GNUNET_i2s (&put_path[i]));
557 fprintf (stderr, "\n");
559 if (get_path != NULL)
563 fprintf (stderr, "GET (%u) Path: ", test_get->uid);
564 for (i = 0; i < get_path_length; i++)
565 fprintf (stderr, "%s%s", i == 0 ? "" : "->", GNUNET_i2s (&get_path[i]));
566 fprintf (stderr, "%s%s\n", get_path_length > 0 ? "->" : "",
567 GNUNET_i2s (&test_get->daemon->id));
571 if ((0 != memcmp (&search_key, key, sizeof (GNUNET_HashCode))) ||
572 (0 != memcmp (original_data, data, sizeof (original_data))))
574 fprintf (stderr, "Key or data is not the same as was inserted!\n");
578 test_get->succeeded = GNUNET_YES;
579 GNUNET_SCHEDULER_cancel (test_get->task);
580 test_get->task = GNUNET_SCHEDULER_add_now (&get_stop_task, test_get);
585 * Set up some data, and call API PUT function
588 do_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
590 struct TestGetContext *test_get = cls;
591 GNUNET_HashCode key; /* Made up key to store data under */
592 char data[TEST_DATA_SIZE]; /* Made up data to store */
594 if (outstanding_gets > MAX_OUTSTANDING_GETS)
597 GNUNET_SCHEDULER_add_delayed (GET_DELAY, &do_get, test_get);
600 memset (data, test_get->uid, sizeof (data));
601 GNUNET_CRYPTO_hash (data, TEST_DATA_SIZE, &key);
602 test_get->dht_handle = GNUNET_DHT_connect (test_get->daemon->cfg, 10);
603 GNUNET_assert (test_get->dht_handle != NULL);
605 test_get->get_handle =
606 GNUNET_DHT_get_start (test_get->dht_handle, GNUNET_TIME_UNIT_FOREVER_REL,
607 GNUNET_BLOCK_TYPE_TEST, &key, 1, route_option, NULL,
608 0, &get_result_iterator, test_get);
610 GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &get_stop_task, test_get);
615 * Task to release DHT handles for PUT
618 put_disconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
620 struct TestPutContext *test_put = cls;
622 test_put->task = GNUNET_SCHEDULER_NO_TASK;
623 GNUNET_DHT_disconnect (test_put->dht_handle);
624 test_put->dht_handle = NULL;
625 GNUNET_CONTAINER_DLL_remove (all_puts_head, all_puts_tail, test_put);
626 GNUNET_free (test_put);
631 * Schedule the GET requests
634 start_gets (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
636 unsigned long long i;
637 unsigned long long j;
638 struct TestGetContext *test_get;
641 fprintf (stderr, "Issuing %llu GETs\n",
642 (unsigned long long) (num_peers * num_peers));
644 for (i = 0; i < num_peers; i++)
645 for (j = 0; j < num_peers; j++)
647 test_get = GNUNET_malloc (sizeof (struct TestGetContext));
648 test_get->uid = i + j * num_peers;
649 test_get->daemon = GNUNET_TESTING_daemon_get (pg, j);
650 GNUNET_CONTAINER_DLL_insert (all_gets_head, all_gets_tail, test_get);
651 test_get->task = GNUNET_SCHEDULER_add_now (&do_get, test_get);
657 * Called when the PUT request has been transmitted to the DHT service.
660 put_finished (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
662 struct TestPutContext *test_put = cls;
666 GNUNET_SCHEDULER_cancel (test_put->task);
667 test_put->task = GNUNET_SCHEDULER_add_now (&put_disconnect_task, test_put);
668 if (puts_completed != num_peers * num_peers)
671 GNUNET_assert (outstanding_puts == 0);
672 GNUNET_SCHEDULER_add_delayed (START_DELAY, &start_gets, NULL);
677 * Set up some data, and call API PUT function
680 do_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
682 struct TestPutContext *test_put = cls;
683 GNUNET_HashCode key; /* Made up key to store data under */
684 char data[TEST_DATA_SIZE]; /* Made up data to store */
686 test_put->task = GNUNET_SCHEDULER_NO_TASK;
687 if (outstanding_puts > MAX_OUTSTANDING_PUTS)
690 GNUNET_SCHEDULER_add_delayed (PUT_DELAY, &do_put, test_put);
693 memset (data, test_put->uid, sizeof (data));
694 GNUNET_CRYPTO_hash (data, TEST_DATA_SIZE, &key);
695 test_put->dht_handle = GNUNET_DHT_connect (test_put->daemon->cfg, 10);
696 GNUNET_assert (test_put->dht_handle != NULL);
699 fprintf (stderr, "PUT %u at `%s'\n", test_put->uid,
700 GNUNET_i2s (&test_put->daemon->id));
702 GNUNET_DHT_put (test_put->dht_handle, &key, 1, route_option,
703 GNUNET_BLOCK_TYPE_TEST, sizeof (data), data,
704 GNUNET_TIME_UNIT_FOREVER_ABS, GNUNET_TIME_UNIT_FOREVER_REL,
705 &put_finished, test_put);
707 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
708 &put_disconnect_task, test_put);
713 run_dht_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
715 unsigned long long i;
716 struct TestPutContext *test_put;
720 GNUNET_DHT_RO_RECORD_ROUTE | GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE;
722 route_option = GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE;
725 GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
726 "from setup puts/gets");
727 fprintf (stderr, "Issuing %llu PUTs (one per peer)\n",
728 (unsigned long long) (num_peers * num_peers));
729 for (i = 0; i < num_peers * num_peers; i++)
731 test_put = GNUNET_malloc (sizeof (struct TestPutContext));
733 test_put->daemon = GNUNET_TESTING_daemon_get (pg, i % num_peers);
734 test_put->task = GNUNET_SCHEDULER_add_now (&do_put, test_put);
735 GNUNET_CONTAINER_DLL_insert (all_puts_head, all_puts_tail, test_put);
741 * This function is called once testing has finished setting up the topology.
744 * @param emsg variable is NULL on success (peers connected), and non-NULL on
745 * failure (peers failed to connect).
748 startup_done (void *cls, const char *emsg)
752 fprintf (stderr, "Failed to setup topology: %s\n", emsg);
753 die_task = GNUNET_SCHEDULER_add_now (&end_badly, "topology setup failed");
757 GNUNET_SCHEDULER_add_delayed (START_DELAY, &run_dht_test,
758 "from setup puts/gets");
763 run (void *cls, char *const *args, const char *cfgfile,
764 const struct GNUNET_CONFIGURATION_Handle *cfg)
766 /* Get path from configuration file */
768 GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
776 GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
778 num_peers = DEFAULT_NUM_PEERS;
779 pg = GNUNET_TESTING_peergroup_start (cfg, num_peers, TIMEOUT, NULL,
780 &startup_done, NULL, NULL);
781 GNUNET_assert (NULL != pg);
790 /* Arguments for GNUNET_PROGRAM_run */
791 char *const argv[] = { "test-dht-multipeer", /* Name to give running binary */
793 "test_dht_multipeer_data.conf", /* Config file to use */
799 struct GNUNET_GETOPT_CommandLineOption options[] = {
800 GNUNET_GETOPT_OPTION_END
802 /* Run the run function as a new program */
804 GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
805 "test-dht-multipeer", "nohelp", options, &run, &ok);
806 if (ret != GNUNET_OK)
808 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
809 "`test-dht-multipeer': Failed with error code %d\n", ret);
816 main (int argc, char *argv[])
821 GNUNET_log_setup ("test-dht-multipeer",
830 * Need to remove base directory, subdirectories taken care
831 * of by the testing framework.
833 if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
835 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
836 "Failed to remove testing directory %s\n", test_directory);
841 /* end of test_dht_multipeer.c */