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_NO
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, 60)
40 #define START_DELAY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 60)
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 10
55 #define MAX_OUTSTANDING_GETS 10
57 #define PATH_TRACKING GNUNET_YES
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",
233 * Function scheduled to be run on the successful completion of this
237 finish_testing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
239 struct TestPutContext *test_put;
240 struct TestGetContext *test_get;
242 die_task = GNUNET_SCHEDULER_NO_TASK;
243 while (NULL != (test_put = all_puts_head))
245 if (test_put->task != GNUNET_SCHEDULER_NO_TASK)
246 GNUNET_SCHEDULER_cancel (test_put->task);
247 if (test_put->dht_handle != NULL)
248 GNUNET_DHT_disconnect (test_put->dht_handle);
249 GNUNET_CONTAINER_DLL_remove (all_puts_head,
252 GNUNET_free (test_put);
255 while (NULL != (test_get = all_gets_head))
257 if (test_get->task != GNUNET_SCHEDULER_NO_TASK)
258 GNUNET_SCHEDULER_cancel (test_get->task);
259 if (test_get->get_handle != NULL)
260 GNUNET_DHT_get_stop (test_get->get_handle);
261 if (test_get->dht_handle != NULL)
262 GNUNET_DHT_disconnect (test_get->dht_handle);
263 GNUNET_CONTAINER_DLL_remove (all_gets_head,
266 GNUNET_free (test_get);
270 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
276 * Check if the get_handle is being used, if so stop the request. Either
277 * way, schedule the end_badly_cont function which actually shuts down the
281 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
283 const char *emsg = cls;
284 struct TestPutContext *test_put;
285 struct TestGetContext *test_get;
287 die_task = GNUNET_SCHEDULER_NO_TASK;
289 "Failing test with error: `%s'!\n",
291 while (NULL != (test_put = all_puts_head))
293 if (test_put->task != GNUNET_SCHEDULER_NO_TASK)
294 GNUNET_SCHEDULER_cancel (test_put->task);
295 if (test_put->dht_handle != NULL)
296 GNUNET_DHT_disconnect (test_put->dht_handle);
297 GNUNET_CONTAINER_DLL_remove (all_puts_head,
300 GNUNET_free (test_put);
303 while (NULL != (test_get = all_gets_head))
305 if (test_get->task != GNUNET_SCHEDULER_NO_TASK)
306 GNUNET_SCHEDULER_cancel (test_get->task);
307 if (test_get->get_handle != NULL)
308 GNUNET_DHT_get_stop (test_get->get_handle);
309 if (test_get->dht_handle != NULL)
310 GNUNET_DHT_disconnect (test_get->dht_handle);
311 GNUNET_CONTAINER_DLL_remove (all_gets_head,
314 GNUNET_free (test_get);
317 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
323 * Task to release get handle.
326 get_stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
328 struct TestGetContext *test_get = cls;
329 GNUNET_HashCode search_key; /* Key stored under */
330 char original_data[TEST_DATA_SIZE]; /* Made up data to store */
332 test_get->task = GNUNET_SCHEDULER_NO_TASK;
333 memset (original_data, test_get->uid, sizeof (original_data));
334 GNUNET_CRYPTO_hash (original_data, TEST_DATA_SIZE, &search_key);
335 if (test_get->succeeded != GNUNET_YES)
339 "Get from peer %s for key %s failed!\n",
340 GNUNET_i2s (&test_get->daemon->id),
341 GNUNET_h2s (&search_key));
343 GNUNET_assert (test_get->get_handle != NULL);
344 GNUNET_DHT_get_stop (test_get->get_handle);
345 test_get->get_handle = NULL;
347 outstanding_gets--; /* GET is really finished */
348 GNUNET_DHT_disconnect (test_get->dht_handle);
349 test_get->dht_handle = NULL;
352 "%llu gets succeeded, %llu gets failed!\n",
353 gets_completed, gets_failed);
354 GNUNET_CONTAINER_DLL_remove (all_gets_head,
357 GNUNET_free (test_get);
359 if ((gets_failed > 0) && (outstanding_gets == 0)) /* Had some failures */
361 GNUNET_SCHEDULER_cancel (die_task);
362 die_task = GNUNET_SCHEDULER_add_now (&end_badly, "not all gets succeeded");
366 if ( (gets_completed == num_peers * num_peers) &&
367 (outstanding_gets == 0) ) /* All gets successful */
369 GNUNET_SCHEDULER_cancel (die_task);
370 die_task = GNUNET_SCHEDULER_add_now (&finish_testing, NULL);
376 * Iterator called if the GET request initiated returns a response.
379 * @param exp when will this value expire
380 * @param key key of the result
381 * @param type type of the result
382 * @param size number of bytes in data
383 * @param data pointer to the result data
386 get_result_iterator (void *cls, struct GNUNET_TIME_Absolute exp,
387 const GNUNET_HashCode * key,
388 const struct GNUNET_PeerIdentity *get_path,
389 unsigned int get_path_length,
390 const struct GNUNET_PeerIdentity *put_path,
391 unsigned int put_path_length,
392 enum GNUNET_BLOCK_Type type, size_t size, const void *data)
394 struct TestGetContext *test_get = cls;
395 GNUNET_HashCode search_key; /* Key stored under */
396 char original_data[TEST_DATA_SIZE]; /* Made up data to store */
399 memset (original_data, test_get->uid, sizeof (original_data));
400 GNUNET_CRYPTO_hash (original_data, TEST_DATA_SIZE, &search_key);
401 if (test_get->succeeded == GNUNET_YES)
402 return; /* Get has already been successful, probably ending now */
405 if (put_path != NULL)
407 fprintf (stderr, "PUT (%u) Path: ",
409 for (i = 0; i<put_path_length; i++)
410 fprintf (stderr, "%s%s", i == 0 ? "" : "->", GNUNET_i2s (&put_path[i]));
411 fprintf (stderr, "\n");
413 if (get_path != NULL)
415 fprintf (stderr, "GET (%u) Path: ",
417 for (i = 0; i < get_path_length; i++)
418 fprintf (stderr, "%s%s", i == 0 ? "" : "->", GNUNET_i2s (&get_path[i]));
419 fprintf (stderr, "%s%s\n",
420 get_path_length > 0 ? "->":"",
421 GNUNET_i2s (&test_get->daemon->id));
425 if ((0 != memcmp (&search_key, key, sizeof (GNUNET_HashCode))) ||
426 (0 != memcmp (original_data, data, sizeof (original_data))))
429 "Key or data is not the same as was inserted!\n");
433 test_get->succeeded = GNUNET_YES;
434 GNUNET_SCHEDULER_cancel (test_get->task);
435 test_get->task = GNUNET_SCHEDULER_add_now (&get_stop_task, test_get);
440 * Set up some data, and call API PUT function
443 do_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
445 struct TestGetContext *test_get = cls;
446 GNUNET_HashCode key; /* Made up key to store data under */
447 char data[TEST_DATA_SIZE]; /* Made up data to store */
449 if (outstanding_gets > MAX_OUTSTANDING_GETS)
451 test_get->task = GNUNET_SCHEDULER_add_delayed (GET_DELAY, &do_get, test_get);
454 memset (data, test_get->uid, sizeof (data));
455 GNUNET_CRYPTO_hash (data, TEST_DATA_SIZE, &key);
456 test_get->dht_handle = GNUNET_DHT_connect (test_get->daemon->cfg, 10);
457 GNUNET_assert (test_get->dht_handle != NULL);
459 test_get->get_handle =
460 GNUNET_DHT_get_start (test_get->dht_handle, GNUNET_TIME_UNIT_FOREVER_REL,
461 GNUNET_BLOCK_TYPE_TEST, &key,
462 1, route_option, NULL, 0,
463 &get_result_iterator, test_get);
465 GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &get_stop_task, test_get);
470 * Task to release DHT handles for PUT
473 put_disconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
475 struct TestPutContext *test_put = cls;
477 test_put->task = GNUNET_SCHEDULER_NO_TASK;
478 GNUNET_DHT_disconnect (test_put->dht_handle);
479 test_put->dht_handle = NULL;
480 GNUNET_CONTAINER_DLL_remove (all_puts_head,
483 GNUNET_free (test_put);
488 * Called when the PUT request has been transmitted to the DHT service.
489 * Schedule the GET request for some time in the future.
492 put_finished (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
494 struct TestPutContext *test_put = cls;
495 unsigned long long i;
496 unsigned long long j;
497 struct TestGetContext *test_get;
501 GNUNET_SCHEDULER_cancel (test_put->task);
503 GNUNET_SCHEDULER_add_now (&put_disconnect_task, test_put);
504 if (puts_completed != num_peers * num_peers)
507 GNUNET_assert (outstanding_puts == 0);
509 "Issuing %llu GETs\n",
510 num_peers * num_peers);
511 for (i = 0; i < num_peers; i++)
512 for (j = 0; j < num_peers; j++)
514 test_get = GNUNET_malloc (sizeof (struct TestGetContext));
515 test_get->uid = i + j*num_peers;
516 test_get->daemon = GNUNET_TESTING_daemon_get (pg, j);
517 GNUNET_CONTAINER_DLL_insert (all_gets_head,
520 test_get->task = GNUNET_SCHEDULER_add_now (&do_get,
527 * Set up some data, and call API PUT function
530 do_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
532 struct TestPutContext *test_put = cls;
533 GNUNET_HashCode key; /* Made up key to store data under */
534 char data[TEST_DATA_SIZE]; /* Made up data to store */
536 test_put->task = GNUNET_SCHEDULER_NO_TASK;
537 if (outstanding_puts > MAX_OUTSTANDING_PUTS)
539 test_put->task = GNUNET_SCHEDULER_add_delayed (PUT_DELAY, &do_put, test_put);
542 memset (data, test_put->uid, sizeof (data));
543 GNUNET_CRYPTO_hash (data, TEST_DATA_SIZE, &key);
544 test_put->dht_handle = GNUNET_DHT_connect (test_put->daemon->cfg, 10);
545 GNUNET_assert (test_put->dht_handle != NULL);
547 fprintf (stderr, "PUT %u at `%s'\n",
549 GNUNET_i2s (&test_put->daemon->id));
550 GNUNET_DHT_put (test_put->dht_handle, &key, 1,
551 route_option, GNUNET_BLOCK_TYPE_TEST, sizeof (data), data,
552 GNUNET_TIME_UNIT_FOREVER_ABS, GNUNET_TIME_UNIT_FOREVER_REL,
553 &put_finished, test_put);
555 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
556 &put_disconnect_task, test_put);
561 run_dht_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
563 unsigned long long i;
564 struct TestPutContext *test_put;
567 route_option = GNUNET_DHT_RO_RECORD_ROUTE | GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE;
569 route_option = GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE;
572 GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
573 "from setup puts/gets");
575 "Issuing %llu PUTs (one per peer)\n",
577 for (i = 0; i < num_peers * num_peers; i++)
579 test_put = GNUNET_malloc (sizeof (struct TestPutContext));
581 test_put->daemon = GNUNET_TESTING_daemon_get (pg, i % num_peers);
582 test_put->task = GNUNET_SCHEDULER_add_now (&do_put, test_put);
583 GNUNET_CONTAINER_DLL_insert (all_puts_head,
591 * This function is called once testing has finished setting up the topology.
594 * @param emsg variable is NULL on success (peers connected), and non-NULL on
595 * failure (peers failed to connect).
598 startup_done (void *cls, const char *emsg)
603 "Failed to setup topology: %s\n",
606 GNUNET_SCHEDULER_add_now (&end_badly,
607 "topology setup failed");
611 GNUNET_SCHEDULER_add_delayed (START_DELAY, &run_dht_test,
612 "from setup puts/gets");
617 run (void *cls, char *const *args, const char *cfgfile,
618 const struct GNUNET_CONFIGURATION_Handle *cfg)
620 /* Get path from configuration file */
622 GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
630 GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
632 num_peers = DEFAULT_NUM_PEERS;
633 pg = GNUNET_TESTING_peergroup_start (cfg,
640 GNUNET_assert (NULL != pg);
649 /* Arguments for GNUNET_PROGRAM_run */
650 char *const argv[] = { "test-dht-multipeer", /* Name to give running binary */
652 "test_dht_multipeer_data.conf", /* Config file to use */
658 struct GNUNET_GETOPT_CommandLineOption options[] = {
659 GNUNET_GETOPT_OPTION_END
661 /* Run the run function as a new program */
663 GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
664 "test-dht-multipeer", "nohelp", options, &run, &ok);
665 if (ret != GNUNET_OK)
667 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
668 "`test-dht-multipeer': Failed with error code %d\n", ret);
675 main (int argc, char *argv[])
680 GNUNET_log_setup ("test-dht-multipeer",
689 * Need to remove base directory, subdirectories taken care
690 * of by the testing framework.
692 if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
694 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
695 "Failed to remove testing directory %s\n", test_directory);
700 /* end of test_dht_multipeer.c */