2 This file is part of GNUnet.
3 (C) 2012 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_topo.c
23 * @brief Test for the dht service: store and retrieve in various topologies.
24 * Each peer stores it own ID in the DHT and then a different peer tries to
25 * retrieve that key from it. The GET starts after a first round of PUTS has
26 * been made. Periodically, each peer stores its ID into the DHT. If after
27 * a timeout no result has been returned, the test fails.
30 #include "gnunet_testing_lib.h"
31 #include "gnunet_dht_service.h"
33 #define REMOVE_DIR GNUNET_YES
36 * DIFFERENT TESTS TO RUN
42 * How long until we give up on connecting the peers?
44 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1500)
46 #define GET_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
48 #define PUT_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
56 * Total number of peers in the test.
58 static unsigned long long num_peers;
61 * Global configuration file
63 static struct GNUNET_CONFIGURATION_Handle *testing_cfg;
66 * Total number of currently running peers.
68 static unsigned long long peers_running;
71 * Total number of connections in the whole network.
73 static unsigned int total_connections;
76 * The currently running peer group.
78 static struct GNUNET_TESTING_PeerGroup *pg;
81 * File to report results to.
83 static struct GNUNET_DISK_FileHandle *output_file;
86 * File to log connection info, statistics to.
88 static struct GNUNET_DISK_FileHandle *data_file;
91 * Task called to disconnect peers.
93 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
96 * Task To perform tests
98 static GNUNET_SCHEDULER_TaskIdentifier test_task;
101 * Task to do DHT_puts
103 static GNUNET_SCHEDULER_TaskIdentifier put_task;
106 * Task called to shutdown test.
108 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
110 static char *topology_file;
112 static struct GNUNET_DHT_Handle **hs;
114 static struct GNUNET_DHT_GetHandle *get_h;
116 static struct GNUNET_DHT_GetHandle *get_h_2;
118 static struct GNUNET_DHT_GetHandle *get_h_far;
124 static int found_far;
127 * Which topology are we to run
129 static int test_topology;
133 * Check whether peers successfully shut down.
136 shutdown_callback (void *cls, const char *emsg)
140 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Shutdown of peers failed!\n");
145 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "All peers successfully shut down!\n");
147 GNUNET_CONFIGURATION_destroy (testing_cfg);
152 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
154 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Ending test.\n");
156 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
158 GNUNET_SCHEDULER_cancel (disconnect_task);
159 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
162 if (data_file != NULL)
163 GNUNET_DISK_file_close (data_file);
164 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
169 disconnect_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
173 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "disconnecting peers\n");
174 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
175 GNUNET_SCHEDULER_cancel (put_task);
177 GNUNET_DHT_get_stop (get_h);
179 GNUNET_DHT_get_stop (get_h_2);
180 if (NULL != get_h_far)
181 GNUNET_DHT_get_stop (get_h_far);
182 for (i = 0; i < num_peers; i++)
184 GNUNET_DHT_disconnect (hs[i]);
186 GNUNET_SCHEDULER_cancel (shutdown_handle);
187 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
192 dht_get_id_handler (void *cls, struct GNUNET_TIME_Absolute exp,
193 const struct GNUNET_HashCode * key,
194 const struct GNUNET_PeerIdentity *get_path,
195 unsigned int get_path_length,
196 const struct GNUNET_PeerIdentity *put_path,
197 unsigned int put_path_length, enum GNUNET_BLOCK_Type type,
198 size_t size, const void *data)
202 if (sizeof (struct GNUNET_HashCode) == size)
204 const struct GNUNET_HashCode *h = data;
206 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " Contents: %s\n",
207 GNUNET_h2s_full (h));
214 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "PATH: (get %u, put %u)\n",
215 get_path_length, put_path_length);
216 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " LOCAL\n");
217 for (i = get_path_length - 1; i >= 0; i--)
219 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " %s\n",
220 GNUNET_i2s (&get_path[i]));
222 for (i = put_path_length - 1; i >= 0; i--)
224 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " %s\n",
225 GNUNET_i2s (&put_path[i]));
231 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "FOUND 1!\n");
235 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "FOUND 2!\n");
239 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "FOUND FAR!\n");
244 if ( (TORUS == test_topology) &&
245 ( (found_1 == 0) || (found_2 == 0) || (found_far == 0)) )
248 GNUNET_SCHEDULER_cancel (disconnect_task);
249 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_peers, NULL);
254 do_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
256 struct GNUNET_TESTING_Daemon *d;
257 struct GNUNET_TESTING_Daemon *d2;
258 struct GNUNET_TESTING_Daemon *d_far;
259 struct GNUNET_TESTING_Daemon *o;
260 struct GNUNET_TESTING_Daemon *aux;
262 const char *id_origin = "FC74";
263 const char *id_near = "9P6V";
264 const char *id_near2 = "2GDS";
265 const char *id_far = "KPST";
268 d = d2 = d_far = o = NULL;
269 found_1 = found_2 = found_far = 0;
270 if (LINE == test_topology)
272 o = GNUNET_TESTING_daemon_get (pg, 0);
273 d = GNUNET_TESTING_daemon_get (pg, 4);
275 else if (TORUS == test_topology)
277 for (i = 0; i < num_peers; i++)
279 aux = GNUNET_TESTING_daemon_get (pg, i);
280 id_aux = GNUNET_i2s (&aux->id);
281 if (strcmp (id_aux, id_origin) == 0)
283 if (strcmp (id_aux, id_far) == 0)
285 if (strcmp (id_aux, id_near) == 0)
287 if (strcmp (id_aux, id_near2) == 0)
290 if ((NULL == o) || (NULL == d) || (NULL == d2) || (NULL == d_far))
292 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
293 "Peers not found (hostkey file changed?)\n");
294 GNUNET_SCHEDULER_cancel (disconnect_task);
295 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_peers, NULL);
303 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test_task\nfrom %s\n",
304 GNUNET_h2s_full (&o->id.hashPubKey));
305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " looking for %s\n",
306 GNUNET_h2s_full (&d->id.hashPubKey));
307 get_h = GNUNET_DHT_get_start (hs[0],
308 GNUNET_BLOCK_TYPE_TEST, /* type */
309 &d->id.hashPubKey, /*key to search */
310 4U, /* replication level */
311 GNUNET_DHT_RO_RECORD_ROUTE | GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE, NULL, /* xquery */
313 &dht_get_id_handler, (void *)1);
314 if (TORUS == test_topology)
316 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " looking for %s\n",
317 GNUNET_h2s_full (&d2->id.hashPubKey));
318 get_h_2 = GNUNET_DHT_get_start (hs[0],
319 GNUNET_BLOCK_TYPE_TEST, /* type */
320 &d2->id.hashPubKey, /*key to search */
321 4U, /* replication level */
322 GNUNET_DHT_RO_RECORD_ROUTE | GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE, NULL, /* xquery */
324 &dht_get_id_handler, (void *)2);
325 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " looking for %s\n",
326 GNUNET_h2s_full (&d_far->id.hashPubKey));
327 get_h_far = GNUNET_DHT_get_start (hs[0],
328 GNUNET_BLOCK_TYPE_TEST, /* type */
329 &d_far->id.hashPubKey, /*key to search */
330 4U, /* replication level */
331 GNUNET_DHT_RO_RECORD_ROUTE | GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE, NULL, /* xquery */
333 &dht_get_id_handler, (void *)3);
335 GNUNET_SCHEDULER_cancel (disconnect_task);
337 GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &disconnect_peers, NULL);
341 * Task to put the id of each peer into teh DHT.
343 * @param cls Closure (unused)
344 * @param tc Task context
348 put_id (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
350 struct GNUNET_TESTING_Daemon *d;
353 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "putting id's in DHT\n");
354 for (i = 0; i < num_peers; i++)
356 d = GNUNET_TESTING_daemon_get (pg, i);
357 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " putting into DHT: %s\n",
358 GNUNET_h2s_full (&d->id.hashPubKey));
359 GNUNET_DHT_put (hs[i], &d->id.hashPubKey, 10U,
360 GNUNET_DHT_RO_RECORD_ROUTE |
361 GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
362 GNUNET_BLOCK_TYPE_TEST, sizeof (struct GNUNET_PeerIdentity),
363 (const char *) &d->id, GNUNET_TIME_UNIT_FOREVER_ABS,
364 GNUNET_TIME_UNIT_FOREVER_REL, NULL, NULL);
367 put_task = GNUNET_SCHEDULER_add_delayed (PUT_FREQUENCY, &put_id, NULL);
368 if (GNUNET_SCHEDULER_NO_TASK == test_task)
369 test_task = GNUNET_SCHEDULER_add_now (&do_test, NULL);
374 * peergroup_ready: start test when all peers are connected
377 * @param emsg error message
381 peergroup_ready (void *cls, const char *emsg)
383 struct GNUNET_TESTING_Daemon *d;
390 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
391 "Peergroup callback called with error, aborting test!\n");
392 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
393 "Error from testing: `%s'\n",
396 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
399 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
400 "Peer Group started successfully with %u connections\n",
402 if (data_file != NULL)
405 buf_len = GNUNET_asprintf (&buf, "CONNECTIONS_0: %u\n", total_connections);
407 GNUNET_DISK_file_write (data_file, buf, buf_len);
410 peers_running = GNUNET_TESTING_daemons_running (pg);
412 GNUNET_assert (peers_running == num_peers);
413 hs = GNUNET_malloc (num_peers * sizeof (struct GNUNET_DHT_Handle *));
414 for (i = 0; i < num_peers; i++)
416 d = GNUNET_TESTING_daemon_get (pg, i);
417 hs[i] = GNUNET_DHT_connect (d->cfg, 32);
420 test_task = GNUNET_SCHEDULER_NO_TASK;
421 put_task = GNUNET_SCHEDULER_add_now (&put_id, NULL);
423 GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &disconnect_peers, NULL);
429 * Function that will be called whenever two daemons are connected by
430 * the testing library.
433 * @param first peer id for first daemon
434 * @param second peer id for the second daemon
435 * @param distance distance between the connected peers
436 * @param first_cfg config for the first daemon
437 * @param second_cfg config for the second daemon
438 * @param first_daemon handle for the first daemon
439 * @param second_daemon handle for the second daemon
440 * @param emsg error message (NULL on success)
443 connect_cb (void *cls, const struct GNUNET_PeerIdentity *first,
444 const struct GNUNET_PeerIdentity *second, uint32_t distance,
445 const struct GNUNET_CONFIGURATION_Handle *first_cfg,
446 const struct GNUNET_CONFIGURATION_Handle *second_cfg,
447 struct GNUNET_TESTING_Daemon *first_daemon,
448 struct GNUNET_TESTING_Daemon *second_daemon, const char *emsg)
453 GNUNET_PEER_intern (first);
454 GNUNET_PEER_intern (second);
458 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
459 "Problem with new connection (%s)\n", emsg);
465 * run: load configuration options and schedule test to run (start peergroup)
468 * @param cfgfile configuration file name (can be NULL)
469 * @param cfg configuration handle
472 run (void *cls, char *const *args, const char *cfgfile,
473 const struct GNUNET_CONFIGURATION_Handle *cfg)
476 struct GNUNET_TESTING_Host *hosts;
480 testing_cfg = GNUNET_CONFIGURATION_dup (cfg);
482 GNUNET_log_setup ("test_dht_topo",
485 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting daemons.\n");
486 GNUNET_CONFIGURATION_set_value_string (testing_cfg, "testing_old",
487 "use_progressbars", "YES");
489 GNUNET_CONFIGURATION_get_value_number (testing_cfg, "testing_old",
490 "num_peers", &num_peers))
492 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
493 "Option TESTING:NUM_PEERS is required!\n");
498 GNUNET_CONFIGURATION_get_value_string (testing_cfg, "testing_old",
499 "topology_output_file",
502 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
503 "Option test_dht_topo:topology_output_file is required!\n");
508 GNUNET_CONFIGURATION_get_value_string (testing_cfg, "test_dht_topo",
513 GNUNET_DISK_file_open (data_filename,
514 GNUNET_DISK_OPEN_READWRITE |
515 GNUNET_DISK_OPEN_CREATE,
516 GNUNET_DISK_PERM_USER_READ |
517 GNUNET_DISK_PERM_USER_WRITE);
518 if (data_file == NULL)
520 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n",
522 GNUNET_free (data_filename);
527 GNUNET_CONFIGURATION_get_value_string (cfg, "test_dht_topo",
528 "output_file", &temp_str))
531 GNUNET_DISK_file_open (temp_str,
532 GNUNET_DISK_OPEN_READWRITE |
533 GNUNET_DISK_OPEN_CREATE,
534 GNUNET_DISK_PERM_USER_READ |
535 GNUNET_DISK_PERM_USER_WRITE);
536 if (output_file == NULL)
537 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n",
540 GNUNET_free_non_null (temp_str);
542 hosts = GNUNET_TESTING_hosts_load (testing_cfg);
544 pg = GNUNET_TESTING_peergroup_start (testing_cfg, num_peers, TIMEOUT,
545 &connect_cb, &peergroup_ready, NULL,
547 GNUNET_assert (pg != NULL);
549 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
550 &shutdown_task, NULL);
558 main (int xargc, char *xargv[])
560 static struct GNUNET_GETOPT_CommandLineOption options[] = {
561 GNUNET_GETOPT_OPTION_END
563 static char *const argv_torus[] = { "test-dht-2dtorus",
565 "test_dht_2dtorus.conf",
568 static char *const argv_line[] = { "test-dht-line",
570 "test_dht_line.conf",
576 if (strstr (xargv[0], "test_dht_2dtorus") != NULL)
579 argc = sizeof (argv_torus) / sizeof (char *);
580 test_topology = TORUS;
582 else if (strstr (xargv[0], "test_dht_line") != NULL)
585 argc = sizeof (argv_line) / sizeof (char *);
586 test_topology = LINE;
593 GNUNET_PROGRAM_run (argc - 1, argv,
595 gettext_noop ("Test dht in different topologies."),
599 GNUNET_DISK_directory_remove ("/tmp/test_dht_topo");
603 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "ID 1 not found!\n");
605 if (TORUS == test_topology)
609 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "ID 2 not found!\n");
613 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "ID far not found!\n");
619 /* end of test_dht_topo.c */