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)
224 "Failed to shutdown testing topology: %s\n",
232 do_stop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
234 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
240 * Master context for 'stat_run'.
244 struct GNUNET_STATISTICS_Handle *stat;
251 const char *subsystem;
253 unsigned long long total;
257 * Statistics we print out.
259 static struct StatValues stats[] = {
260 {"core", "# bytes decrypted", 0},
261 {"core", "# bytes encrypted", 0},
262 {"core", "# type maps received", 0},
263 {"core", "# session keys confirmed via PONG", 0},
264 {"core", "# entries in session map", 0},
265 {"core", "# key exchanges initiated", 0},
266 {"core", "# send requests dropped (disconnected)", 0},
267 {"core", "# transmissions delayed due to corking", 0},
268 {"core", "# messages discarded (expired prior to transmission)", 0},
269 {"core", "# messages discarded (disconnected)", 0},
270 {"core", "# discarded CORE_SEND requests", 0},
271 {"core", "# discarded lower priority CORE_SEND requests", 0},
272 {"transport", "# bytes received via TCP", 0},
273 {"transport", "# bytes transmitted via TCP", 0},
274 {"dht", "# PUT messages queued for transmission", 0},
275 {"dht", "# P2P PUT requests received", 0},
276 {"dht", "# GET messages queued for transmission", 0},
277 {"dht", "# P2P GET requests received", 0},
278 {"dht", "# RESULT messages queued for transmission", 0},
279 {"dht", "# P2P RESULTS received", 0},
280 {"dht", "# Queued messages discarded (peer disconnected)", 0},
281 {"dht", "# Peers excluded from routing due to Bloomfilter", 0},
282 {"dht", "# Peer selection failed", 0},
283 {"dht", "# FIND PEER requests ignored due to Bloomfilter", 0},
284 {"dht", "# FIND PEER requests ignored due to lack of HELLO", 0},
285 {"dht", "# P2P FIND PEER requests processed", 0},
286 {"dht", "# P2P GET requests ONLY routed", 0},
287 {"dht", "# Preference updates given to core", 0},
288 {"dht", "# REPLIES ignored for CLIENTS (no match)", 0},
289 {"dht", "# GET requests from clients injected", 0},
290 {"dht", "# GET requests received from clients", 0},
291 {"dht", "# GET STOP requests received from clients", 0},
292 {"dht", "# ITEMS stored in datacache", 0},
293 {"dht", "# Good RESULTS found in datacache", 0},
294 {"dht", "# GET requests given to datacache", 0},
300 * Callback function to process statistic values.
303 * @param subsystem name of subsystem that created the statistic
304 * @param name the name of the datum
305 * @param value the current value
306 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
307 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
310 print_stat (void *cls, const char *subsystem, const char *name, uint64_t value,
313 struct StatMaster *sm = cls;
315 stats[sm->value].total += value;
316 fprintf (stderr, "Peer %2u: %12s/%50s = %12llu\n", sm->daemon, subsystem,
317 name, (unsigned long long) value);
323 * Function that gathers stats from all daemons.
326 stat_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
330 * Function called when GET operation on stats is done.
333 get_done (void *cls, int success)
335 struct StatMaster *sm = cls;
337 GNUNET_break (GNUNET_OK == success);
339 GNUNET_SCHEDULER_add_now (&stat_run, sm);
344 * Function that gathers stats from all daemons.
347 stat_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
349 struct StatMaster *sm = cls;
352 die_task = GNUNET_SCHEDULER_NO_TASK;
353 if (stats[sm->value].name != NULL)
355 GNUNET_STATISTICS_get (sm->stat,
359 stats[sm->value].subsystem, stats[sm->value].name,
361 GNUNET_TIME_UNIT_FOREVER_REL, &get_done, &print_stat,
365 GNUNET_STATISTICS_destroy (sm->stat, GNUNET_NO);
368 if (sm->daemon == num_peers)
372 while (stats[i].name != NULL)
374 fprintf (stderr, "Total : %12s/%50s = %12llu\n", stats[i].subsystem,
375 stats[i].name, (unsigned long long) stats[i].total);
378 die_task = GNUNET_SCHEDULER_add_now (&do_stop, NULL);
382 GNUNET_STATISTICS_create ("<driver>",
383 GNUNET_TESTING_daemon_get (pg,
385 die_task = GNUNET_SCHEDULER_add_now (&stat_run, sm);
390 * Function scheduled to be run on the successful completion of this
394 finish_testing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
396 struct TestPutContext *test_put;
397 struct TestGetContext *test_get;
398 struct StatMaster *sm;
400 die_task = GNUNET_SCHEDULER_NO_TASK;
401 while (NULL != (test_put = all_puts_head))
403 if (test_put->task != GNUNET_SCHEDULER_NO_TASK)
404 GNUNET_SCHEDULER_cancel (test_put->task);
405 if (test_put->dht_handle != NULL)
406 GNUNET_DHT_disconnect (test_put->dht_handle);
407 GNUNET_CONTAINER_DLL_remove (all_puts_head,
410 GNUNET_free (test_put);
413 while (NULL != (test_get = all_gets_head))
415 if (test_get->task != GNUNET_SCHEDULER_NO_TASK)
416 GNUNET_SCHEDULER_cancel (test_get->task);
417 if (test_get->get_handle != NULL)
418 GNUNET_DHT_get_stop (test_get->get_handle);
419 if (test_get->dht_handle != NULL)
420 GNUNET_DHT_disconnect (test_get->dht_handle);
421 GNUNET_CONTAINER_DLL_remove (all_gets_head,
424 GNUNET_free (test_get);
426 sm = GNUNET_malloc (sizeof (struct StatMaster));
428 GNUNET_STATISTICS_create ("<driver>",
429 GNUNET_TESTING_daemon_get (pg,
431 die_task = GNUNET_SCHEDULER_add_now (&stat_run, sm);
436 * Check if the get_handle is being used, if so stop the request. Either
437 * way, schedule the end_badly_cont function which actually shuts down the
441 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
443 const char *emsg = cls;
444 struct TestPutContext *test_put;
445 struct TestGetContext *test_get;
447 die_task = GNUNET_SCHEDULER_NO_TASK;
449 "Failing test with error: `%s'!\n",
451 while (NULL != (test_put = all_puts_head))
453 if (test_put->task != GNUNET_SCHEDULER_NO_TASK)
454 GNUNET_SCHEDULER_cancel (test_put->task);
455 if (test_put->dht_handle != NULL)
456 GNUNET_DHT_disconnect (test_put->dht_handle);
457 GNUNET_CONTAINER_DLL_remove (all_puts_head,
460 GNUNET_free (test_put);
463 while (NULL != (test_get = all_gets_head))
465 if (test_get->task != GNUNET_SCHEDULER_NO_TASK)
466 GNUNET_SCHEDULER_cancel (test_get->task);
467 if (test_get->get_handle != NULL)
468 GNUNET_DHT_get_stop (test_get->get_handle);
469 if (test_get->dht_handle != NULL)
470 GNUNET_DHT_disconnect (test_get->dht_handle);
471 GNUNET_CONTAINER_DLL_remove (all_gets_head,
474 GNUNET_free (test_get);
477 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
483 * Task to release get handle.
486 get_stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
488 struct TestGetContext *test_get = cls;
489 GNUNET_HashCode search_key; /* Key stored under */
490 char original_data[TEST_DATA_SIZE]; /* Made up data to store */
492 test_get->task = GNUNET_SCHEDULER_NO_TASK;
493 memset (original_data, test_get->uid, sizeof (original_data));
494 GNUNET_CRYPTO_hash (original_data, TEST_DATA_SIZE, &search_key);
495 if (test_get->succeeded != GNUNET_YES)
499 "Get from peer %s for key %s failed!\n",
500 GNUNET_i2s (&test_get->daemon->id),
501 GNUNET_h2s (&search_key));
503 GNUNET_assert (test_get->get_handle != NULL);
504 GNUNET_DHT_get_stop (test_get->get_handle);
505 test_get->get_handle = NULL;
507 outstanding_gets--; /* GET is really finished */
508 GNUNET_DHT_disconnect (test_get->dht_handle);
509 test_get->dht_handle = NULL;
511 GNUNET_CONTAINER_DLL_remove (all_gets_head,
514 GNUNET_free (test_get);
515 if ((gets_failed > 10) && (outstanding_gets == 0))
517 /* Had more than 10% failures */
519 "%llu gets succeeded, %llu gets failed!\n",
520 gets_completed, gets_failed);
521 GNUNET_SCHEDULER_cancel (die_task);
523 die_task = GNUNET_SCHEDULER_add_now (&finish_testing, "not all gets succeeded");
526 if ( (gets_completed + gets_failed == num_peers * num_peers) &&
527 (outstanding_gets == 0) ) /* All gets successful */
530 "%llu gets succeeded, %llu gets failed!\n",
531 gets_completed, gets_failed);
532 GNUNET_SCHEDULER_cancel (die_task);
534 die_task = GNUNET_SCHEDULER_add_now (&finish_testing, NULL);
540 * Iterator called if the GET request initiated returns a response.
543 * @param exp when will this value expire
544 * @param key key of the result
545 * @param type type of the result
546 * @param size number of bytes in data
547 * @param data pointer to the result data
550 get_result_iterator (void *cls, struct GNUNET_TIME_Absolute exp,
551 const GNUNET_HashCode * key,
552 const struct GNUNET_PeerIdentity *get_path,
553 unsigned int get_path_length,
554 const struct GNUNET_PeerIdentity *put_path,
555 unsigned int put_path_length,
556 enum GNUNET_BLOCK_Type type, size_t size, const void *data)
558 struct TestGetContext *test_get = cls;
559 GNUNET_HashCode search_key; /* Key stored under */
560 char original_data[TEST_DATA_SIZE]; /* Made up data to store */
562 memset (original_data, test_get->uid, sizeof (original_data));
563 GNUNET_CRYPTO_hash (original_data, TEST_DATA_SIZE, &search_key);
564 if (test_get->succeeded == GNUNET_YES)
565 return; /* Get has already been successful, probably ending now */
568 if (put_path != NULL)
572 fprintf (stderr, "PUT (%u) Path: ",
574 for (i = 0; i<put_path_length; i++)
575 fprintf (stderr, "%s%s", i == 0 ? "" : "->", GNUNET_i2s (&put_path[i]));
576 fprintf (stderr, "\n");
578 if (get_path != NULL)
582 fprintf (stderr, "GET (%u) Path: ",
584 for (i = 0; i < get_path_length; i++)
585 fprintf (stderr, "%s%s", i == 0 ? "" : "->", GNUNET_i2s (&get_path[i]));
586 fprintf (stderr, "%s%s\n",
587 get_path_length > 0 ? "->":"",
588 GNUNET_i2s (&test_get->daemon->id));
592 if ((0 != memcmp (&search_key, key, sizeof (GNUNET_HashCode))) ||
593 (0 != memcmp (original_data, data, sizeof (original_data))))
596 "Key or data is not the same as was inserted!\n");
600 test_get->succeeded = GNUNET_YES;
601 GNUNET_SCHEDULER_cancel (test_get->task);
602 test_get->task = GNUNET_SCHEDULER_add_now (&get_stop_task, test_get);
607 * Set up some data, and call API PUT function
610 do_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
612 struct TestGetContext *test_get = cls;
613 GNUNET_HashCode key; /* Made up key to store data under */
614 char data[TEST_DATA_SIZE]; /* Made up data to store */
616 if (outstanding_gets > MAX_OUTSTANDING_GETS)
618 test_get->task = GNUNET_SCHEDULER_add_delayed (GET_DELAY, &do_get, test_get);
621 memset (data, test_get->uid, sizeof (data));
622 GNUNET_CRYPTO_hash (data, TEST_DATA_SIZE, &key);
623 test_get->dht_handle = GNUNET_DHT_connect (test_get->daemon->cfg, 10);
624 GNUNET_assert (test_get->dht_handle != NULL);
626 test_get->get_handle =
627 GNUNET_DHT_get_start (test_get->dht_handle, GNUNET_TIME_UNIT_FOREVER_REL,
628 GNUNET_BLOCK_TYPE_TEST, &key,
629 1, route_option, NULL, 0,
630 &get_result_iterator, test_get);
632 GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &get_stop_task, test_get);
637 * Task to release DHT handles for PUT
640 put_disconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
642 struct TestPutContext *test_put = cls;
644 test_put->task = GNUNET_SCHEDULER_NO_TASK;
645 GNUNET_DHT_disconnect (test_put->dht_handle);
646 test_put->dht_handle = NULL;
647 GNUNET_CONTAINER_DLL_remove (all_puts_head,
650 GNUNET_free (test_put);
655 * Schedule the GET requests
658 start_gets (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
660 unsigned long long i;
661 unsigned long long j;
662 struct TestGetContext *test_get;
666 "Issuing %llu GETs\n",
667 num_peers * num_peers);
669 for (i = 0; i < num_peers; i++)
670 for (j = 0; j < num_peers; j++)
672 test_get = GNUNET_malloc (sizeof (struct TestGetContext));
673 test_get->uid = i + j*num_peers;
674 test_get->daemon = GNUNET_TESTING_daemon_get (pg, j);
675 GNUNET_CONTAINER_DLL_insert (all_gets_head,
678 test_get->task = GNUNET_SCHEDULER_add_now (&do_get,
685 * Called when the PUT request has been transmitted to the DHT service.
688 put_finished (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
690 struct TestPutContext *test_put = cls;
694 GNUNET_SCHEDULER_cancel (test_put->task);
696 GNUNET_SCHEDULER_add_now (&put_disconnect_task, test_put);
697 if (puts_completed != num_peers * num_peers)
700 GNUNET_assert (outstanding_puts == 0);
701 GNUNET_SCHEDULER_add_delayed (START_DELAY,
708 * Set up some data, and call API PUT function
711 do_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
713 struct TestPutContext *test_put = cls;
714 GNUNET_HashCode key; /* Made up key to store data under */
715 char data[TEST_DATA_SIZE]; /* Made up data to store */
717 test_put->task = GNUNET_SCHEDULER_NO_TASK;
718 if (outstanding_puts > MAX_OUTSTANDING_PUTS)
720 test_put->task = GNUNET_SCHEDULER_add_delayed (PUT_DELAY, &do_put, test_put);
723 memset (data, test_put->uid, sizeof (data));
724 GNUNET_CRYPTO_hash (data, TEST_DATA_SIZE, &key);
725 test_put->dht_handle = GNUNET_DHT_connect (test_put->daemon->cfg, 10);
726 GNUNET_assert (test_put->dht_handle != NULL);
729 fprintf (stderr, "PUT %u at `%s'\n",
731 GNUNET_i2s (&test_put->daemon->id));
733 GNUNET_DHT_put (test_put->dht_handle, &key, 1,
734 route_option, GNUNET_BLOCK_TYPE_TEST, sizeof (data), data,
735 GNUNET_TIME_UNIT_FOREVER_ABS, GNUNET_TIME_UNIT_FOREVER_REL,
736 &put_finished, test_put);
738 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
739 &put_disconnect_task, test_put);
744 run_dht_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
746 unsigned long long i;
747 struct TestPutContext *test_put;
750 route_option = GNUNET_DHT_RO_RECORD_ROUTE | GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE;
752 route_option = GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE;
755 GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
756 "from setup puts/gets");
758 "Issuing %llu PUTs (one per peer)\n",
760 for (i = 0; i < num_peers * num_peers; i++)
762 test_put = GNUNET_malloc (sizeof (struct TestPutContext));
764 test_put->daemon = GNUNET_TESTING_daemon_get (pg, i % num_peers);
765 test_put->task = GNUNET_SCHEDULER_add_now (&do_put, test_put);
766 GNUNET_CONTAINER_DLL_insert (all_puts_head,
774 * This function is called once testing has finished setting up the topology.
777 * @param emsg variable is NULL on success (peers connected), and non-NULL on
778 * failure (peers failed to connect).
781 startup_done (void *cls, const char *emsg)
786 "Failed to setup topology: %s\n",
789 GNUNET_SCHEDULER_add_now (&end_badly,
790 "topology setup failed");
794 GNUNET_SCHEDULER_add_delayed (START_DELAY, &run_dht_test,
795 "from setup puts/gets");
800 run (void *cls, char *const *args, const char *cfgfile,
801 const struct GNUNET_CONFIGURATION_Handle *cfg)
803 /* Get path from configuration file */
805 GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
813 GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
815 num_peers = DEFAULT_NUM_PEERS;
816 pg = GNUNET_TESTING_peergroup_start (cfg,
823 GNUNET_assert (NULL != pg);
832 /* Arguments for GNUNET_PROGRAM_run */
833 char *const argv[] = { "test-dht-multipeer", /* Name to give running binary */
835 "test_dht_multipeer_data.conf", /* Config file to use */
841 struct GNUNET_GETOPT_CommandLineOption options[] = {
842 GNUNET_GETOPT_OPTION_END
844 /* Run the run function as a new program */
846 GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
847 "test-dht-multipeer", "nohelp", options, &run, &ok);
848 if (ret != GNUNET_OK)
850 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
851 "`test-dht-multipeer': Failed with error code %d\n", ret);
858 main (int argc, char *argv[])
863 GNUNET_log_setup ("test-dht-multipeer",
872 * Need to remove base directory, subdirectories taken care
873 * of by the testing framework.
875 if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
877 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
878 "Failed to remove testing directory %s\n", test_directory);
883 /* end of test_dht_multipeer.c */