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_twopeer_path_tracking.c
22 * @brief testcase for testing DHT service with
23 * two running peers, logging the path of the dht requests.
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, 5)
36 /* Timeout for waiting for replies to get requests */
37 #define GET_TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 30)
39 /* If number of peers not in config file, use this number */
40 #define DEFAULT_NUM_PEERS 2
45 * Directory to store temp data in, defined in config file
47 static char *test_directory;
50 * Variable used to store the number of connections we should wait for.
52 static unsigned int expected_connections;
55 * Variable used to keep track of how many peers aren't yet started.
57 static unsigned long long peers_left;
60 * Handle to the set of all peers run for this test.
62 static struct GNUNET_TESTING_PeerGroup *pg;
65 * Global handle we will use for GET requests.
67 struct GNUNET_DHT_GetHandle *global_get_handle;
71 * Total number of peers to run, set based on config file.
73 static unsigned long long num_peers;
76 * Global used to count how many connections we have currently
77 * been notified about (how many times has topology_callback been called
80 static unsigned int total_connections;
83 * Global used to count how many failed connections we have
84 * been notified about (how many times has topology_callback
85 * been called with failure?)
87 static unsigned int failed_connections;
89 /* Task handle to use to schedule test failure */
90 GNUNET_SCHEDULER_TaskIdentifier die_task;
92 /* Global return value (0 for success, anything else for failure) */
96 * Peer identity of the first peer started.
98 static struct GNUNET_PeerIdentity peer1id;
101 * Peer identity of the second peer started.
103 static struct GNUNET_PeerIdentity peer2id;
106 * Handle to the first peers DHT service (via the API)
108 static struct GNUNET_DHT_Handle *peer1dht;
111 * Handle to the second peers DHT service (via the API)
113 static struct GNUNET_DHT_Handle *peer2dht;
116 * Check whether peers successfully shut down.
119 shutdown_callback (void *cls, const char *emsg)
129 * Function scheduled to be run on the successful completion of this
130 * testcase. Specifically, called when our get request completes.
133 finish_testing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
135 GNUNET_assert (pg != NULL);
136 GNUNET_assert (peer1dht != NULL);
137 GNUNET_assert (peer2dht != NULL);
138 GNUNET_DHT_disconnect (peer1dht);
139 GNUNET_DHT_disconnect (peer2dht);
140 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
145 * Continuation for the GNUNET_DHT_get_stop call, so that we don't shut
146 * down the peers without freeing memory associated with GET request.
149 end_badly_cont (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
151 if (peer1dht != NULL)
152 GNUNET_DHT_disconnect (peer1dht);
154 if (peer2dht != NULL)
155 GNUNET_DHT_disconnect (peer2dht);
158 GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
162 * Check if the get_handle is being used, if so stop the request. Either
163 * way, schedule the end_badly_cont function which actually shuts down the
167 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
169 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Failing test with error: `%s'!\n",
171 if (global_get_handle != NULL)
173 GNUNET_DHT_get_stop (global_get_handle);
174 global_get_handle = NULL;
176 GNUNET_SCHEDULER_add_now (&end_badly_cont, NULL);
181 * Iterator called if the GET request initiated returns a response.
184 * @param exp when will this value expire
185 * @param key key of the result
186 * @param type type of the result
187 * @param size number of bytes in data
188 * @param data pointer to the result data
191 get_result_iterator (void *cls, struct GNUNET_TIME_Absolute exp,
192 const GNUNET_HashCode * key,
193 const struct GNUNET_PeerIdentity *get_path,
194 unsigned int get_path_length,
195 const struct GNUNET_PeerIdentity *put_path,
196 unsigned int put_path_length,
197 enum GNUNET_BLOCK_Type type, size_t size, const void *data)
199 GNUNET_HashCode original_key; /* Key data was stored data under */
200 char original_data[4]; /* Made up data that was stored */
202 memset (&original_key, 42, sizeof (GNUNET_HashCode)); /* Set the key to what it was set to previously */
203 memset (original_data, 43, sizeof (original_data));
208 if ((0 != memcmp (&original_key, key, sizeof (GNUNET_HashCode))) ||
209 (0 != memcmp (original_data, data, sizeof (original_data))))
211 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
212 "Key or data is not the same as was inserted!\n");
213 GNUNET_SCHEDULER_cancel (die_task);
214 GNUNET_SCHEDULER_add_now (&end_badly,
215 "key or data mismatch in get response!\n");
220 if (put_path != NULL)
222 fprintf (stderr, "PUT Path: ");
223 for (i = 0; i<put_path_length; i++)
224 fprintf (stderr, "%s%s", i == 0 ? "" : "->", GNUNET_i2s (&put_path[i]));
225 fprintf (stderr, "\n");
227 if (get_path != NULL)
229 fprintf (stderr, "GET Path: ");
230 for (i = 0; i<get_path_length; i++)
231 fprintf (stderr, "%s%s", i == 0 ? "" : "->", GNUNET_i2s (&get_path[i]));
232 fprintf (stderr, "\n");
236 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received correct GET response!\n");
237 GNUNET_SCHEDULER_cancel (die_task);
238 GNUNET_DHT_get_stop (global_get_handle);
239 GNUNET_SCHEDULER_add_now (&finish_testing, NULL);
244 * Called when the PUT request has been transmitted to the DHT service.
245 * Schedule the GET request for some time in the future.
248 put_finished (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
250 GNUNET_HashCode key; /* Key for data lookup */
252 GNUNET_SCHEDULER_cancel (die_task);
254 GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &end_badly,
255 "waiting for get response (data not found)");
256 memset (&key, 42, sizeof (GNUNET_HashCode)); /* Set the key to the same thing as when data was inserted */
258 GNUNET_DHT_get_start (peer2dht, GNUNET_TIME_relative_get_forever (),
259 GNUNET_BLOCK_TYPE_TEST, &key,
260 1, GNUNET_DHT_RO_RECORD_ROUTE,
261 NULL, 0, &get_result_iterator, NULL);
265 * Set up some data, and call API PUT function
268 do_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
270 GNUNET_HashCode key; /* Made up key to store data under */
271 char data[4]; /* Made up data to store */
273 memset (&key, 42, sizeof (GNUNET_HashCode)); /* Set the key to something simple so we can issue GET request */
274 memset (data, 43, sizeof (data));
276 /* Insert the data at the first peer */
277 GNUNET_DHT_put (peer1dht, &key, 1,
278 GNUNET_DHT_RO_RECORD_ROUTE, GNUNET_BLOCK_TYPE_TEST,
279 sizeof (data), data, GNUNET_TIME_UNIT_FOREVER_ABS,
280 GNUNET_TIME_UNIT_FOREVER_REL, &put_finished, NULL);
284 * This function is called whenever a connection attempt is finished between two of
285 * the started peers (started with GNUNET_TESTING_daemons_start). The total
286 * number of times this function is called should equal the number returned
287 * from the GNUNET_TESTING_connect_topology call.
289 * The emsg variable is NULL on success (peers connected), and non-NULL on
290 * failure (peers failed to connect).
293 topology_callback (void *cls, const struct GNUNET_PeerIdentity *first,
294 const struct GNUNET_PeerIdentity *second, uint32_t distance,
295 const struct GNUNET_CONFIGURATION_Handle *first_cfg,
296 const struct GNUNET_CONFIGURATION_Handle *second_cfg,
297 struct GNUNET_TESTING_Daemon *first_daemon,
298 struct GNUNET_TESTING_Daemon *second_daemon,
305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
306 "connected peer %s to peer %s, distance %u\n",
307 first_daemon->shortname, second_daemon->shortname, distance);
313 failed_connections++;
314 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
315 "Failed to connect peer %s to peer %s with error :\n%s\n",
316 first_daemon->shortname, second_daemon->shortname, emsg);
320 if (total_connections == expected_connections)
323 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
324 "Created %d total connections, which is our target number! Starting next phase of testing.\n",
327 GNUNET_SCHEDULER_cancel (die_task);
329 GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, "from test gets");
331 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
332 (GNUNET_TIME_UNIT_SECONDS, 2), &do_put, NULL);
334 else if (total_connections + failed_connections == expected_connections)
336 GNUNET_SCHEDULER_cancel (die_task);
338 GNUNET_SCHEDULER_add_now (&end_badly,
339 "from topology_callback (too many failed connections)");
345 * Callback which is called whenever a peer is started (as a result of the
346 * GNUNET_TESTING_daemons_start call.
348 * @param cls closure argument given to GNUNET_TESTING_daemons_start
349 * @param id the GNUNET_PeerIdentity of the started peer
350 * @param cfg the configuration for this specific peer (needed to connect
352 * @param d the handle to the daemon started
353 * @param emsg NULL if peer started, non-NULL on error
356 peers_started_callback (void *cls, const struct GNUNET_PeerIdentity *id,
357 const struct GNUNET_CONFIGURATION_Handle *cfg,
358 struct GNUNET_TESTING_Daemon *d, const char *emsg)
362 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
363 "Failed to start daemon with error: `%s'\n", emsg);
366 GNUNET_assert (id != NULL);
368 /* This is the first peer started */
369 if (peers_left == num_peers)
371 memcpy (&peer1id, id, sizeof (struct GNUNET_PeerIdentity)); /* Save the peer id */
372 peer1dht = GNUNET_DHT_connect (cfg, 100); /* Connect to the first peers DHT service */
373 if (peer1dht == NULL) /* If DHT connect failed */
375 GNUNET_SCHEDULER_cancel (die_task);
376 GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
379 else /* This is the second peer started */
381 memcpy (&peer2id, id, sizeof (struct GNUNET_PeerIdentity)); /* Same as for first peer... */
382 peer2dht = GNUNET_DHT_connect (cfg, 100);
383 if (peer2dht == NULL)
385 GNUNET_SCHEDULER_cancel (die_task);
386 GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
390 /* Decrement number of peers left to start */
393 if (peers_left == 0) /* Indicates all peers started */
396 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
397 "All %d daemons started, now connecting peers!\n", num_peers);
399 expected_connections = -1;
400 if ((pg != NULL)) /* Sanity check */
402 /* Connect peers in a "straight line" topology, return the number of expected connections */
403 expected_connections =
404 GNUNET_TESTING_connect_topology (pg, GNUNET_TESTING_TOPOLOGY_LINE,
405 GNUNET_TESTING_TOPOLOGY_OPTION_ALL,
406 0.0, TIMEOUT, 2, NULL, NULL);
409 /* Cancel current timeout fail task */
410 GNUNET_SCHEDULER_cancel (die_task);
411 if (expected_connections == GNUNET_SYSERR) /* Some error happened */
413 GNUNET_SCHEDULER_add_now (&end_badly,
414 "from connect topology (bad return)");
416 /* Schedule timeout on failure task */
418 GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
419 "from connect topology (timeout)");
425 run (void *cls, char *const *args, const char *cfgfile,
426 const struct GNUNET_CONFIGURATION_Handle *cfg)
429 /* Get path from configuration file */
431 GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
438 /* Get number of peers to start from configuration (should be two) */
440 GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
442 num_peers = DEFAULT_NUM_PEERS;
444 /* Set peers_left so we know when all peers started */
445 peers_left = num_peers;
447 /* Set up a task to end testing if peer start fails */
449 GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
450 "didn't start all daemons in reasonable amount of time!!!");
452 /* Start num_peers peers, call peers_started_callback on peer start, topology_callback on peer connect */
453 /* Read the API documentation for other parameters! */
454 pg = GNUNET_TESTING_daemons_start (cfg, peers_left, /* Total number of peers */
455 peers_left, /* Number of outstanding connections */
456 peers_left, /* Number of parallel ssh connections, or peers being started at once */
458 &peers_started_callback, NULL,
459 &topology_callback, NULL, NULL);
468 /* Arguments for GNUNET_PROGRAM_run */
469 char *const argv[] = { "test-dht-twopeer-put-get", /* Name to give running binary */
471 "test_dht_twopeer_data.conf", /* Config file to use */
477 struct GNUNET_GETOPT_CommandLineOption options[] = {
478 GNUNET_GETOPT_OPTION_END
480 /* Run the run function as a new program */
482 GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
483 "test-dht-twopeer-put-get", "nohelp", options, &run,
485 if (ret != GNUNET_OK)
487 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
488 "`test-dht-twopeer': Failed with error code %d\n", ret);
494 main (int argc, char *argv[])
498 GNUNET_log_setup ("test-dht-twopeer",
507 * Need to remove base directory, subdirectories taken care
508 * of by the testing framework.
510 if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
512 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
513 "Failed to remove testing directory %s\n", test_directory);
518 /* end of test_dht_twopeer_put_get.c */