src/dht/test_dht_twopeer.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20 /**
  21  * @file dht/test_dht_twopeer.c
  22  * @brief base testcase for testing DHT service with
  23  *        two running peers
  24  */
  25 #include "platform.h"
  26 #include "gnunet_testing_lib.h"
  27 #include "gnunet_core_service.h"
  28 #include "gnunet_dht_service.h"
  29
  30 /* DEFINES */
  31 #define VERBOSE GNUNET_EXTRA_LOGGING
  32
  33 #define MAX_GET_ATTEMPTS 10
  34
  35 #define TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 5)
  36
  37 #define DEFAULT_NUM_PEERS 2
  38
  39 /* Structs */
  40
  41 struct PeerGetContext
  42 {
  43   struct GNUNET_PeerIdentity *peer;
  44
  45   struct GNUNET_DHT_Handle *dht_handle;
  46
  47   struct GNUNET_DHT_GetHandle *get_handle;
  48
  49   unsigned int get_attempts;
  50
  51   GNUNET_SCHEDULER_TaskIdentifier retry_task;
  52 };
  53
  54 /* Globals */
  55 static char *test_directory;
  56
  57 static struct PeerGetContext curr_get_ctx;
  58
  59 static unsigned int expected_connections;
  60
  61 static unsigned long long peers_left;
  62
  63 static struct GNUNET_TESTING_PeerGroup *pg;
  64
  65 static unsigned long long num_peers;
  66
  67 static unsigned int total_gets;
  68
  69 static unsigned int gets_succeeded;
  70
  71 static unsigned int total_connections;
  72
  73 static unsigned int failed_connections;
  74
  75 static GNUNET_SCHEDULER_TaskIdentifier die_task;
  76
  77 static int ok;
  78
  79 static struct GNUNET_PeerIdentity peer1id;
  80
  81 static struct GNUNET_PeerIdentity peer2id;
  82
  83 static struct GNUNET_DHT_Handle *peer1dht;
  84
  85 static struct GNUNET_DHT_Handle *peer2dht;
  86
  87 /**
  88  * Check whether peers successfully shut down.
  89  */
  90 static void
  91 shutdown_callback (void *cls, const char *emsg)
  92 {
  93   if (emsg != NULL)
  94   {
  95     if (ok == 0)
  96       ok = 2;
  97   }
  98 }
  99
 100 static void
 101 finish_testing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 102 {
 103   GNUNET_assert (pg != NULL);
 104   GNUNET_assert (peer1dht != NULL);
 105   GNUNET_assert (peer2dht != NULL);
 106   GNUNET_DHT_disconnect (peer1dht);
 107   GNUNET_DHT_disconnect (peer2dht);
 108   GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 109   pg = NULL;
 110   ok = 0;
 111 }
 112
 113 static void
 114 end_badly_cont (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 115 {
 116   if (peer1dht != NULL)
 117     GNUNET_DHT_disconnect (peer1dht);
 118
 119   if (peer2dht != NULL)
 120     GNUNET_DHT_disconnect (peer2dht);
 121
 122   if (pg != NULL)
 123   {
 124     GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 125     pg = NULL;
 126   }
 127
 128   if (curr_get_ctx.retry_task != GNUNET_SCHEDULER_NO_TASK)
 129   {
 130     GNUNET_SCHEDULER_cancel (curr_get_ctx.retry_task);
 131     curr_get_ctx.retry_task = GNUNET_SCHEDULER_NO_TASK;
 132   }
 133 }
 134
 135
 136 static void
 137 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 138 {
 139   const char *emsg = cls;
 140
 141   FPRINTF (stderr, "Error: %s\n", emsg);
 142   if (curr_get_ctx.retry_task != GNUNET_SCHEDULER_NO_TASK)
 143   {
 144     GNUNET_SCHEDULER_cancel (curr_get_ctx.retry_task);
 145     curr_get_ctx.retry_task = GNUNET_SCHEDULER_NO_TASK;
 146   }
 147   if (curr_get_ctx.get_handle != NULL)
 148   {
 149     GNUNET_DHT_get_stop (curr_get_ctx.get_handle);
 150   }
 151
 152   GNUNET_SCHEDULER_add_now (&end_badly_cont, NULL);
 153   ok = 1;
 154 }
 155
 156
 157 /* Forward declaration */
 158 static void
 159 do_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 160
 161 /**
 162  * Iterator called on each result obtained for a DHT
 163  * operation that expects a reply
 164  *
 165  * @param cls closure
 166  * @param exp when will this value expire
 167  * @param key key of the result
 168  * @param type type of the result
 169  * @param size number of bytes in data
 170  * @param data pointer to the result data
 171  */
 172 static void
 173 get_result_iterator (void *cls, struct GNUNET_TIME_Absolute exp,
 174                      const GNUNET_HashCode * key,
 175                      const struct GNUNET_PeerIdentity *get_path,
 176                      unsigned int get_path_length,
 177                      const struct GNUNET_PeerIdentity *put_path,
 178                      unsigned int put_path_length, enum GNUNET_BLOCK_Type type,
 179                      size_t size, const void *data)
 180 {
 181   struct PeerGetContext *get_context = cls;
 182
 183   if (0 !=
 184       memcmp (&get_context->peer->hashPubKey, key, sizeof (GNUNET_HashCode)))
 185   {
 186     FPRINTF (stderr, "%s",  "??\n");
 187     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 188                 "Key returned is not the same key as was searched for!\n");
 189     GNUNET_SCHEDULER_cancel (die_task);
 190     die_task =
 191         GNUNET_SCHEDULER_add_now (&end_badly,
 192                                   "key mismatch in get response!\n");
 193     return;
 194   }
 195   FPRINTF (stderr, "%s",  "!\n");
 196   if (get_context->retry_task != GNUNET_SCHEDULER_NO_TASK)
 197   {
 198     GNUNET_SCHEDULER_cancel (get_context->retry_task);
 199     get_context->retry_task = GNUNET_SCHEDULER_NO_TASK;
 200   }
 201
 202   if (get_context->peer == &peer2id)
 203   {
 204     get_context->peer = &peer1id;
 205     get_context->dht_handle = peer2dht;
 206     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 207                 "Received first correct GET request response!\n");
 208     GNUNET_DHT_get_stop (get_context->get_handle);
 209     GNUNET_SCHEDULER_add_now (&do_get, get_context);
 210   }
 211   else
 212   {
 213     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 214                 "Received second correct GET request response!\n");
 215     GNUNET_SCHEDULER_cancel (die_task);
 216     GNUNET_DHT_get_stop (get_context->get_handle);
 217     die_task = GNUNET_SCHEDULER_add_now (&finish_testing, NULL);
 218   }
 219
 220 }
 221
 222 static void
 223 stop_retry_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 224
 225
 226 static void
 227 get_stop_finished (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 228 {
 229   struct PeerGetContext *get_context = cls;
 230
 231   if (get_context->get_attempts < MAX_GET_ATTEMPTS)
 232     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 233                 "Get attempt %u failed, retrying request!\n",
 234                 get_context->get_attempts);
 235   else
 236   {
 237     FPRINTF (stderr, "%s",  "?\n");
 238     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 239                 "Too many attempts failed, ending test!\n",
 240                 get_context->get_attempts);
 241     GNUNET_SCHEDULER_cancel (die_task);
 242     die_task =
 243         GNUNET_SCHEDULER_add_now (&end_badly,
 244                                   "GET attempt failed, ending test!\n");
 245     return;
 246   }
 247   FPRINTF (stderr, "%s",  ".");
 248   get_context->get_attempts++;
 249   get_context->retry_task =
 250       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 251                                     (GNUNET_TIME_UNIT_SECONDS, 10),
 252                                     &stop_retry_get, get_context);
 253   get_context->get_handle =
 254       GNUNET_DHT_get_start (get_context->dht_handle,
 255                             GNUNET_TIME_relative_multiply
 256                             (GNUNET_TIME_UNIT_SECONDS, 5),
 257                             GNUNET_BLOCK_TYPE_DHT_HELLO,
 258                             &get_context->peer->hashPubKey, 1,
 259                             GNUNET_DHT_RO_NONE, NULL, 0, &get_result_iterator,
 260                             get_context);
 261 }
 262
 263
 264 static void
 265 stop_retry_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 266 {
 267   struct PeerGetContext *get_context = cls;
 268
 269   get_context->retry_task = GNUNET_SCHEDULER_NO_TASK;
 270   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 271               "Get attempt %u failed, canceling request!\n",
 272               get_context->get_attempts);
 273   GNUNET_DHT_get_stop (get_context->get_handle);
 274   get_context->get_handle = NULL;
 275   GNUNET_SCHEDULER_add_now (&get_stop_finished, get_context);
 276 }
 277
 278
 279 static void
 280 do_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 281 {
 282   struct PeerGetContext *get_context = cls;
 283
 284   get_context->retry_task =
 285       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 286                                     (GNUNET_TIME_UNIT_SECONDS, 10),
 287                                     &stop_retry_get, get_context);
 288   get_context->get_handle =
 289       GNUNET_DHT_get_start (get_context->dht_handle,
 290                             GNUNET_TIME_relative_multiply
 291                             (GNUNET_TIME_UNIT_SECONDS, 5),
 292                             GNUNET_BLOCK_TYPE_DHT_HELLO,
 293                             &get_context->peer->hashPubKey, 1,
 294                             GNUNET_DHT_RO_FIND_PEER, NULL, 0,
 295                             &get_result_iterator, get_context);
 296 }
 297
 298
 299 static void
 300 topology_callback (void *cls, const struct GNUNET_PeerIdentity *first,
 301                    const struct GNUNET_PeerIdentity *second, uint32_t distance,
 302                    const struct GNUNET_CONFIGURATION_Handle *first_cfg,
 303                    const struct GNUNET_CONFIGURATION_Handle *second_cfg,
 304                    struct GNUNET_TESTING_Daemon *first_daemon,
 305                    struct GNUNET_TESTING_Daemon *second_daemon,
 306                    const char *emsg)
 307 {
 308   if (emsg == NULL)
 309   {
 310     total_connections++;
 311 #if VERBOSE
 312     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 313                 "connected peer %s to peer %s, distance %u\n",
 314                 first_daemon->shortname, second_daemon->shortname, distance);
 315 #endif
 316   }
 317 #if VERBOSE
 318   else
 319   {
 320     failed_connections++;
 321     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 322                 "Failed to connect peer %s to peer %s with error :\n%s\n",
 323                 first_daemon->shortname, second_daemon->shortname, emsg);
 324   }
 325 #endif
 326
 327   if (total_connections == expected_connections)
 328   {
 329 #if VERBOSE
 330     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 331                 "Created %d total connections, which is our target number!  Starting next phase of testing.\n",
 332                 total_connections);
 333 #endif
 334     GNUNET_SCHEDULER_cancel (die_task);
 335     die_task =
 336         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 337                                       "Timeout trying to GET");
 338
 339     curr_get_ctx.dht_handle = peer1dht;
 340     curr_get_ctx.peer = &peer2id;
 341     GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 342                                   (GNUNET_TIME_UNIT_SECONDS, 2), &do_get,
 343                                   &curr_get_ctx);
 344   }
 345   else if (total_connections + failed_connections == expected_connections)
 346   {
 347     GNUNET_SCHEDULER_cancel (die_task);
 348     die_task =
 349         GNUNET_SCHEDULER_add_now (&end_badly,
 350                                   "from topology_callback (too many failed connections)");
 351   }
 352 }
 353
 354
 355 static void
 356 connect_topology (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 357 {
 358   expected_connections = -1;
 359   if ((pg != NULL) && (peers_left == 0))
 360     expected_connections =
 361         GNUNET_TESTING_connect_topology (pg, GNUNET_TESTING_TOPOLOGY_CLIQUE,
 362                                          GNUNET_TESTING_TOPOLOGY_OPTION_ALL,
 363                                          0.0, TIMEOUT, 12, NULL, NULL);
 364
 365   GNUNET_SCHEDULER_cancel (die_task);
 366   if (expected_connections == GNUNET_SYSERR)
 367     die_task =
 368         GNUNET_SCHEDULER_add_now (&end_badly,
 369                                   "from connect topology (bad return)");
 370   else
 371     die_task =
 372         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 373                                       "from connect topology (timeout)");
 374 }
 375
 376
 377 static void
 378 peers_started_callback (void *cls, const struct GNUNET_PeerIdentity *id,
 379                         const struct GNUNET_CONFIGURATION_Handle *cfg,
 380                         struct GNUNET_TESTING_Daemon *d, const char *emsg)
 381 {
 382   if (emsg != NULL)
 383   {
 384     FPRINTF (stderr, "Failed to start daemon: `%s'\n", emsg);
 385     return;
 386   }
 387   GNUNET_assert (id != NULL);
 388   if (peers_left == num_peers)
 389   {
 390     memcpy (&peer1id, id, sizeof (struct GNUNET_PeerIdentity));
 391     peer1dht = GNUNET_DHT_connect (cfg, 100);
 392     if (peer1dht == NULL)
 393     {
 394       GNUNET_SCHEDULER_cancel (die_task);
 395       die_task =
 396           GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
 397     }
 398   }
 399   else
 400   {
 401     memcpy (&peer2id, id, sizeof (struct GNUNET_PeerIdentity));
 402     peer2dht = GNUNET_DHT_connect (cfg, 100);
 403     if (peer2dht == NULL)
 404     {
 405       GNUNET_SCHEDULER_cancel (die_task);
 406       die_task =
 407           GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
 408     }
 409   }
 410
 411
 412   peers_left--;
 413
 414   if (peers_left == 0)
 415   {
 416 #if VERBOSE
 417     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 418                 "All %d daemons started, now connecting peers!\n", num_peers);
 419 #endif
 420     GNUNET_SCHEDULER_cancel (die_task);
 421     /* Set up task in case topology creation doesn't finish
 422      * within a reasonable amount of time */
 423     die_task =
 424         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 425                                       "from peers_started_callback");
 426
 427     GNUNET_SCHEDULER_add_now (&connect_topology, NULL);
 428     ok = 0;
 429   }
 430 }
 431
 432
 433 static void
 434 run (void *cls, char *const *args, const char *cfgfile,
 435      const struct GNUNET_CONFIGURATION_Handle *cfg)
 436 {
 437
 438   if (GNUNET_YES !=
 439       GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
 440                                              &test_directory))
 441   {
 442     ok = 404;
 443     return;
 444   }
 445
 446   if (GNUNET_SYSERR ==
 447       GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
 448                                              &num_peers))
 449     num_peers = DEFAULT_NUM_PEERS;
 450
 451   peers_left = num_peers;
 452   total_gets = num_peers;
 453   gets_succeeded = 0;
 454   /* Set up a task to end testing if peer start fails */
 455   die_task =
 456       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 457                                     "didn't start all daemons in reasonable amount of time!!!");
 458
 459   pg = GNUNET_TESTING_daemons_start (cfg, num_peers, 10, num_peers, TIMEOUT,
 460                                      NULL, NULL, &peers_started_callback, NULL,
 461                                      &topology_callback, NULL, NULL);
 462
 463 }
 464
 465 static int
 466 check ()
 467 {
 468   int ret;
 469
 470   char *const argv[] = { "test-dht-twopeer",
 471     "-c",
 472     "test_dht_twopeer_data.conf",
 473 #if VERBOSE
 474     "-L", "DEBUG",
 475 #endif
 476     NULL
 477   };
 478   struct GNUNET_GETOPT_CommandLineOption options[] = {
 479     GNUNET_GETOPT_OPTION_END
 480   };
 481   ret =
 482       GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 483                           "test-dht-twopeer", "nohelp", options, &run, &ok);
 484   if (ret != GNUNET_OK)
 485   {
 486     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 487                 "`test-dht-twopeer': Failed with error code %d\n", ret);
 488   }
 489   return ok;
 490 }
 491
 492 int
 493 main (int argc, char *argv[])
 494 {
 495   int ret;
 496
 497   GNUNET_log_setup ("test-dht-twopeer",
 498 #if VERBOSE
 499                     "DEBUG",
 500 #else
 501                     "WARNING",
 502 #endif
 503                     NULL);
 504   ret = check ();
 505   /**
 506    * Need to remove base directory, subdirectories taken care
 507    * of by the testing framework.
 508    */
 509   if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
 510   {
 511     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 512                 "Failed to remove testing directory %s\n", test_directory);
 513   }
 514   return ret;
 515 }
 516
 517 /* end of test_dht_twopeer.c */