2 This file is part of GNUnet.
3 (C) 2011 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_monitor.c
23 * @brief Test for the dht service: store, retrieve and monitor in a line.
24 * TODO: update this description
25 * Each peer stores it own ID in the DHT and then a different peer tries to
26 * retrieve that key from it. The GET starts after a first round of PUTS has
27 * been made. Periodically, each peer stores its ID into the DHT. If after
28 * a timeout no result has been returned, the test fails.
31 #include "gnunet_testing_lib.h"
32 #include "gnunet_dht_service.h"
34 #define VERBOSE GNUNET_YES
36 #define REMOVE_DIR GNUNET_YES
40 * How long until we give up on connecting the peers?
42 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1500)
44 #define GET_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
46 #define PUT_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
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 struct GNUNET_TESTING_Daemon *d1;
114 struct GNUNET_TESTING_Daemon *d2;
116 struct GNUNET_DHT_Handle **hs;
118 struct GNUNET_DHT_MonitorHandle **mhs;
120 struct GNUNET_DHT_GetHandle *get_h_far;
122 const char *id_origin = "FC74";
123 const char *id_far = "2UVH";
125 struct GNUNET_TESTING_Daemon *d_far;
126 struct GNUNET_TESTING_Daemon *o;
128 unsigned int monitor_counter;
133 * Check whether peers successfully shut down.
136 shutdown_callback (void *cls, const char *emsg)
141 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Shutdown of peers failed!\n");
148 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
149 "test: All peers successfully shut down!\n");
152 GNUNET_CONFIGURATION_destroy (testing_cfg);
157 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
160 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Ending test.\n");
163 if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
165 GNUNET_SCHEDULER_cancel (disconnect_task);
166 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
169 if (data_file != NULL)
170 GNUNET_DISK_file_close (data_file);
171 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
176 disconnect_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
180 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: disconnecting peers\n");
181 disconnect_task = GNUNET_SCHEDULER_NO_TASK;
182 GNUNET_SCHEDULER_cancel (put_task);
183 if (NULL != get_h_far)
184 GNUNET_DHT_get_stop (get_h_far);
185 for (i = 0; i < num_peers; i++)
187 GNUNET_DHT_disconnect (hs[i]);
189 GNUNET_SCHEDULER_cancel (shutdown_handle);
190 shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
194 dht_get_id_handler (void *cls, struct GNUNET_TIME_Absolute exp,
195 const GNUNET_HashCode * key,
196 const struct GNUNET_PeerIdentity *get_path,
197 unsigned int get_path_length,
198 const struct GNUNET_PeerIdentity *put_path,
199 unsigned int put_path_length, enum GNUNET_BLOCK_Type type,
200 size_t size, const void *data)
204 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
205 "test: ************* FOUND!!! ***********\n");
206 if (sizeof (GNUNET_HashCode) == size)
208 const GNUNET_HashCode *h = data;
210 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Contents: %s\n",
211 GNUNET_h2s_full (h));
214 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: PATH: (get %u, put %u)\n",
215 get_path_length, put_path_length);
216 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: LOCAL\n");
217 for (i = get_path_length - 1; i >= 0; i--)
219 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: %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, "test: %s\n",
225 GNUNET_i2s (&put_path[i]));
227 if (monitor_counter >= get_path_length + put_path_length)
230 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "expected at least %u hops, got %u\n",
231 get_path_length + put_path_length, monitor_counter);
234 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "expected at least %u hops, got %u\n",
235 get_path_length + put_path_length, monitor_counter);
236 GNUNET_SCHEDULER_cancel (disconnect_task);
237 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_peers, NULL);
241 * Start test: start GET request from the first node in the line looking for
242 * the ID of the last node in the line.
244 * @param cls Closure (not used).
245 * @param tc Task context.
248 do_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
250 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
255 in_test = GNUNET_YES;
256 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: test_task\n");
257 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: looking for %s\n",
258 GNUNET_h2s_full (&d_far->id.hashPubKey));
259 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: from %s\n",
260 GNUNET_h2s_full (&o->id.hashPubKey));
261 get_h_far = GNUNET_DHT_get_start (hs[0], GNUNET_TIME_UNIT_FOREVER_REL, /* timeout */
262 GNUNET_BLOCK_TYPE_TEST, /* type */
263 &d_far->id.hashPubKey, /*key to search */
264 4U, /* replication level */
265 GNUNET_DHT_RO_RECORD_ROUTE | GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE, NULL, /* xquery */
267 &dht_get_id_handler, NULL);
268 GNUNET_SCHEDULER_cancel (disconnect_task);
270 GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &disconnect_peers, NULL);
275 * Periodic function used to put the ID of the far peer in the DHT.
277 * @param cls Closure (not used).
278 * @param tc Task context.
281 put_id (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
283 struct GNUNET_TESTING_Daemon *d;
285 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
287 put_task = GNUNET_SCHEDULER_NO_TASK;
291 d = GNUNET_TESTING_daemon_get (pg, 4);
292 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: putting into DHT: %s\n",
293 GNUNET_h2s_full (&d->id.hashPubKey));
294 GNUNET_DHT_put (hs[4], &d->id.hashPubKey, 10U,
295 GNUNET_DHT_RO_RECORD_ROUTE |
296 GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
297 GNUNET_BLOCK_TYPE_TEST, sizeof (struct GNUNET_PeerIdentity),
298 (const char *) &d->id, GNUNET_TIME_UNIT_FOREVER_ABS,
299 GNUNET_TIME_UNIT_FOREVER_REL, NULL, NULL);
301 put_task = GNUNET_SCHEDULER_add_delayed (PUT_FREQUENCY, &put_id, NULL);
305 * Callback called on each request going through the DHT.
306 * Prints the info about the intercepted packet and increments a counter.
308 * @param cls Closure (long) # of daemon that got the monitor event.
309 * @param mtype Type of the DHT message monitored.
310 * @param exp When will this value expire.
311 * @param key Key of the result/request.
312 * @param get_path Peers on reply path (or NULL if not recorded).
313 * @param get_path_length number of entries in get_path.
314 * @param put_path peers on the PUT path (or NULL if not recorded).
315 * @param put_path_length number of entries in get_path.
316 * @param desired_replication_level Desired replication level.
317 * @param type Type of the result/request.
318 * @param data Pointer to the result data.
319 * @param size Number of bytes in data.
322 monitor_dht_cb (void *cls,
324 struct GNUNET_TIME_Absolute exp,
325 const GNUNET_HashCode * key,
326 const struct GNUNET_PeerIdentity * get_path,
327 unsigned int get_path_length,
328 const struct GNUNET_PeerIdentity * put_path,
329 unsigned int put_path_length,
330 uint32_t desired_replication_level,
331 enum GNUNET_DHT_RouteOption options,
332 enum GNUNET_BLOCK_Type type,
340 i = (unsigned int) (long) cls;
341 s_key = GNUNET_h2s(key);
355 mtype_s = "UNKNOWN!!!";
357 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
358 "%u got a message of type %s for key %s\n",
361 if ((mtype == GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET ||
362 mtype == GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT) &&
363 strncmp (s_key, id_far, 4) == 0 && in_test == GNUNET_YES)
369 * peergroup_ready: start test when all peers are connected
372 * @param emsg error message
375 peergroup_ready (void *cls, const char *emsg)
377 struct GNUNET_TESTING_Daemon *d;
384 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
385 "test: Peergroup callback called with error, aborting test!\n");
386 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Error from testing: `%s'\n",
389 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
393 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
394 "************************************************************\n");
395 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
396 "test: Peer Group started successfully!\n");
397 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Have %u connections\n",
401 if (data_file != NULL)
404 buf_len = GNUNET_asprintf (&buf, "CONNECTIONS_0: %u\n", total_connections);
406 GNUNET_DISK_file_write (data_file, buf, buf_len);
409 peers_running = GNUNET_TESTING_daemons_running (pg);
411 GNUNET_assert (peers_running == num_peers);
412 hs = GNUNET_malloc (num_peers * sizeof (struct GNUNET_DHT_Handle *));
413 mhs = GNUNET_malloc (num_peers * sizeof (struct GNUNET_DHT_MonitorHandle *));
415 o = GNUNET_TESTING_daemon_get (pg, 0);
416 d_far = GNUNET_TESTING_daemon_get (pg, 4);
418 for (i = 0; i < num_peers; i++)
420 d = GNUNET_TESTING_daemon_get (pg, i);
421 hs[i] = GNUNET_DHT_connect (d->cfg, 32);
422 mhs[i] = GNUNET_DHT_monitor_start(hs[i], GNUNET_BLOCK_TYPE_ANY, NULL,
423 &monitor_dht_cb, (void *)(long)i);
426 if ((NULL == o) || (NULL == d_far))
428 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
429 "test: Error getting daemons from pg\n");
430 GNUNET_SCHEDULER_cancel (disconnect_task);
431 disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_peers, NULL);
435 put_task = GNUNET_SCHEDULER_add_now (&put_id, NULL);
437 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
438 (GNUNET_TIME_UNIT_SECONDS, 2), &do_test,
441 GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &disconnect_peers, NULL);
447 * Function that will be called whenever two daemons are connected by
448 * the testing library.
451 * @param first peer id for first daemon
452 * @param second peer id for the second daemon
453 * @param distance distance between the connected peers
454 * @param first_cfg config for the first daemon
455 * @param second_cfg config for the second daemon
456 * @param first_daemon handle for the first daemon
457 * @param second_daemon handle for the second daemon
458 * @param emsg error message (NULL on success)
461 connect_cb (void *cls, const struct GNUNET_PeerIdentity *first,
462 const struct GNUNET_PeerIdentity *second, uint32_t distance,
463 const struct GNUNET_CONFIGURATION_Handle *first_cfg,
464 const struct GNUNET_CONFIGURATION_Handle *second_cfg,
465 struct GNUNET_TESTING_Daemon *first_daemon,
466 struct GNUNET_TESTING_Daemon *second_daemon, const char *emsg)
472 GNUNET_PEER_intern (first);
473 GNUNET_PEER_intern (second);
477 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
478 "test: Problem with new connection (%s)\n", emsg);
485 * run: load configuration options and schedule test to run (start peergroup)
488 * @param cfgfile configuration file name (can be NULL)
489 * @param cfg configuration handle
492 run (void *cls, char *const *args, const char *cfgfile,
493 const struct GNUNET_CONFIGURATION_Handle *cfg)
496 struct GNUNET_TESTING_Host *hosts;
500 testing_cfg = GNUNET_CONFIGURATION_dup (cfg);
502 GNUNET_log_setup ("test_dht_monitor",
511 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Starting daemons.\n");
512 GNUNET_CONFIGURATION_set_value_string (testing_cfg, "testing",
513 "use_progressbars", "YES");
517 GNUNET_CONFIGURATION_get_value_number (testing_cfg, "testing",
518 "num_peers", &num_peers))
520 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
521 "Option TESTING:NUM_PEERS is required!\n");
526 GNUNET_CONFIGURATION_get_value_string (testing_cfg, "testing",
527 "topology_output_file",
530 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
531 "Option test_dht_monitor:topology_output_file is required!\n");
536 GNUNET_CONFIGURATION_get_value_string (testing_cfg, "test_dht_topo",
541 GNUNET_DISK_file_open (data_filename,
542 GNUNET_DISK_OPEN_READWRITE |
543 GNUNET_DISK_OPEN_CREATE,
544 GNUNET_DISK_PERM_USER_READ |
545 GNUNET_DISK_PERM_USER_WRITE);
546 if (data_file == NULL)
548 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n",
550 GNUNET_free (data_filename);
555 GNUNET_CONFIGURATION_get_value_string (cfg, "test_dht_topo",
556 "output_file", &temp_str))
559 GNUNET_DISK_file_open (temp_str,
560 GNUNET_DISK_OPEN_READWRITE |
561 GNUNET_DISK_OPEN_CREATE,
562 GNUNET_DISK_PERM_USER_READ |
563 GNUNET_DISK_PERM_USER_WRITE);
564 if (output_file == NULL)
565 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n",
568 GNUNET_free_non_null (temp_str);
570 hosts = GNUNET_TESTING_hosts_load (testing_cfg);
572 pg = GNUNET_TESTING_peergroup_start (testing_cfg, num_peers, TIMEOUT,
573 &connect_cb, &peergroup_ready, NULL,
575 GNUNET_assert (pg != NULL);
577 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
578 &shutdown_task, NULL);
584 * test_dht_monitor command line options
586 static struct GNUNET_GETOPT_CommandLineOption options[] = {
587 {'V', "verbose", NULL,
588 gettext_noop ("be verbose (print progress information)"),
589 0, &GNUNET_GETOPT_set_one, &verbose},
590 GNUNET_GETOPT_OPTION_END
598 main (int xargc, char *xargv[])
600 char *const argv[] = { "test-dht-monitor",
602 "test_dht_line.conf",
610 GNUNET_PROGRAM_run (sizeof (argv) / sizeof (char *) - 1, argv,
612 gettext_noop ("Test dht monitoring in a line."),
613 options, &run, NULL);
615 GNUNET_DISK_directory_remove ("/tmp/test_dht_monitor");
619 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "test: FAILED!\n");
624 /* end of test_dht_monitor.c */