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_NO
  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 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 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   ok = 0;
 110 }
 111
 112 static void
 113 end_badly_cont (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 114 {
 115   if (peer1dht != NULL)
 116     GNUNET_DHT_disconnect (peer1dht);
 117
 118   if (peer2dht != NULL)
 119     GNUNET_DHT_disconnect (peer2dht);
 120
 121   if (pg != NULL)
 122     GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 123
 124   if (curr_get_ctx.retry_task != GNUNET_SCHEDULER_NO_TASK)
 125     GNUNET_SCHEDULER_cancel (curr_get_ctx.retry_task);
 126 }
 127
 128 static void
 129 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 130 {
 131   if (curr_get_ctx.retry_task != GNUNET_SCHEDULER_NO_TASK)
 132     GNUNET_SCHEDULER_cancel (curr_get_ctx.retry_task);
 133
 134   if (curr_get_ctx.get_handle != NULL)
 135   {
 136     GNUNET_DHT_get_stop (curr_get_ctx.get_handle);
 137   }
 138
 139   GNUNET_SCHEDULER_add_now (&end_badly_cont, NULL);
 140   ok = 1;
 141 }
 142
 143 /* Forward declaration */
 144 static void
 145 do_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 146
 147 /**
 148  * Iterator called on each result obtained for a DHT
 149  * operation that expects a reply
 150  *
 151  * @param cls closure
 152  * @param exp when will this value expire
 153  * @param key key of the result
 154  * @param type type of the result
 155  * @param size number of bytes in data
 156  * @param data pointer to the result data
 157  */
 158 void
 159 get_result_iterator (void *cls, struct GNUNET_TIME_Absolute exp,
 160                      const GNUNET_HashCode * key,
 161                      const struct GNUNET_PeerIdentity *const *get_path,
 162                      const struct GNUNET_PeerIdentity *const *put_path,
 163                      enum GNUNET_BLOCK_Type type, size_t size, const void *data)
 164 {
 165   struct PeerGetContext *get_context = cls;
 166
 167   if (0 !=
 168       memcmp (&get_context->peer->hashPubKey, key, sizeof (GNUNET_HashCode)))
 169   {
 170     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 171                 "Key returned is not the same key as was searched for!\n");
 172     GNUNET_SCHEDULER_cancel (die_task);
 173     GNUNET_SCHEDULER_add_now (&end_badly, "key mismatch in get response!\n");
 174     return;
 175   }
 176
 177   if (get_context->retry_task != GNUNET_SCHEDULER_NO_TASK)
 178   {
 179     GNUNET_SCHEDULER_cancel (get_context->retry_task);
 180     get_context->retry_task = GNUNET_SCHEDULER_NO_TASK;
 181   }
 182
 183   if (get_context->peer == &peer2id)
 184   {
 185     get_context->peer = &peer1id;
 186     get_context->dht_handle = peer2dht;
 187     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 188                 "Received first correct GET request response!\n");
 189     GNUNET_DHT_get_stop (get_context->get_handle);
 190     GNUNET_SCHEDULER_add_now (&do_get, get_context);
 191   }
 192   else
 193   {
 194     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 195                 "Received second correct GET request response!\n");
 196     GNUNET_SCHEDULER_cancel (die_task);
 197     GNUNET_DHT_get_stop (get_context->get_handle);
 198     GNUNET_SCHEDULER_add_now (&finish_testing, NULL);
 199   }
 200
 201 }
 202
 203 static void
 204 stop_retry_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 205
 206 static void
 207 get_stop_finished (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 208 {
 209   struct PeerGetContext *get_context = cls;
 210
 211   if (get_context->get_attempts < MAX_GET_ATTEMPTS)
 212     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 213                 "Get attempt %u failed, retrying request!\n",
 214                 get_context->get_attempts);
 215   else
 216   {
 217     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 218                 "Too many attempts failed, ending test!\n",
 219                 get_context->get_attempts);
 220     GNUNET_SCHEDULER_cancel (die_task);
 221     GNUNET_SCHEDULER_add_now (&end_badly, "key mismatch in get response!\n");
 222     return;
 223   }
 224   get_context->get_attempts++;
 225   get_context->retry_task =
 226       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 227                                     (GNUNET_TIME_UNIT_SECONDS, 10),
 228                                     &stop_retry_get, get_context);
 229   get_context->get_handle =
 230       GNUNET_DHT_get_start (get_context->dht_handle,
 231                             GNUNET_TIME_relative_multiply
 232                             (GNUNET_TIME_UNIT_SECONDS, 5),
 233                             GNUNET_BLOCK_TYPE_DHT_HELLO,
 234                             &get_context->peer->hashPubKey,
 235                             DEFAULT_GET_REPLICATION, GNUNET_DHT_RO_NONE, NULL,
 236                             0, NULL, 0, &get_result_iterator, get_context);
 237 }
 238
 239 static void
 240 stop_retry_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 241 {
 242   struct PeerGetContext *get_context = cls;
 243
 244   get_context->retry_task = GNUNET_SCHEDULER_NO_TASK;
 245   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 246               "Get attempt %u failed, canceling request!\n",
 247               get_context->get_attempts);
 248   GNUNET_DHT_get_stop (get_context->get_handle);
 249   get_context->get_handle = NULL;
 250   GNUNET_SCHEDULER_add_now (&get_stop_finished, get_context);
 251 }
 252
 253 static void
 254 do_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 255 {
 256   struct PeerGetContext *get_context = cls;
 257
 258   get_context->retry_task =
 259       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 260                                     (GNUNET_TIME_UNIT_SECONDS, 10),
 261                                     &stop_retry_get, get_context);
 262
 263   get_context->get_handle =
 264       GNUNET_DHT_get_start (get_context->dht_handle,
 265                             GNUNET_TIME_relative_multiply
 266                             (GNUNET_TIME_UNIT_SECONDS, 5),
 267                             GNUNET_BLOCK_TYPE_DHT_HELLO,
 268                             &get_context->peer->hashPubKey,
 269                             DEFAULT_GET_REPLICATION, GNUNET_DHT_RO_NONE, NULL,
 270                             0, NULL, 0, &get_result_iterator, get_context);
 271 }
 272
 273
 274 void
 275 topology_callback (void *cls, const struct GNUNET_PeerIdentity *first,
 276                    const struct GNUNET_PeerIdentity *second, uint32_t distance,
 277                    const struct GNUNET_CONFIGURATION_Handle *first_cfg,
 278                    const struct GNUNET_CONFIGURATION_Handle *second_cfg,
 279                    struct GNUNET_TESTING_Daemon *first_daemon,
 280                    struct GNUNET_TESTING_Daemon *second_daemon,
 281                    const char *emsg)
 282 {
 283   if (emsg == NULL)
 284   {
 285     total_connections++;
 286 #if VERBOSE
 287     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 288                 "connected peer %s to peer %s, distance %u\n",
 289                 first_daemon->shortname, second_daemon->shortname, distance);
 290 #endif
 291   }
 292 #if VERBOSE
 293   else
 294   {
 295     failed_connections++;
 296     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 297                 "Failed to connect peer %s to peer %s with error :\n%s\n",
 298                 first_daemon->shortname, second_daemon->shortname, emsg);
 299   }
 300 #endif
 301
 302   if (total_connections == expected_connections)
 303   {
 304 #if VERBOSE
 305     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 306                 "Created %d total connections, which is our target number!  Starting next phase of testing.\n",
 307                 total_connections);
 308 #endif
 309     GNUNET_SCHEDULER_cancel (die_task);
 310     die_task =
 311         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, "from test gets");
 312
 313     curr_get_ctx.dht_handle = peer1dht;
 314     curr_get_ctx.peer = &peer2id;
 315     GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 316                                   (GNUNET_TIME_UNIT_SECONDS, 2), &do_get,
 317                                   &curr_get_ctx);
 318   }
 319   else if (total_connections + failed_connections == expected_connections)
 320   {
 321     GNUNET_SCHEDULER_cancel (die_task);
 322     die_task =
 323         GNUNET_SCHEDULER_add_now (&end_badly,
 324                                   "from topology_callback (too many failed connections)");
 325   }
 326 }
 327
 328 static void
 329 connect_topology (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 330 {
 331   expected_connections = -1;
 332   if ((pg != NULL) && (peers_left == 0))
 333     expected_connections =
 334         GNUNET_TESTING_connect_topology (pg, GNUNET_TESTING_TOPOLOGY_CLIQUE,
 335                                          GNUNET_TESTING_TOPOLOGY_OPTION_ALL,
 336                                          0.0, TIMEOUT, 12, NULL, NULL);
 337
 338   GNUNET_SCHEDULER_cancel (die_task);
 339   if (expected_connections == GNUNET_SYSERR)
 340     die_task =
 341         GNUNET_SCHEDULER_add_now (&end_badly,
 342                                   "from connect topology (bad return)");
 343
 344
 345   die_task =
 346       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 347                                     "from connect topology (timeout)");
 348 }
 349
 350 static void
 351 peers_started_callback (void *cls, const struct GNUNET_PeerIdentity *id,
 352                         const struct GNUNET_CONFIGURATION_Handle *cfg,
 353                         struct GNUNET_TESTING_Daemon *d, const char *emsg)
 354 {
 355   if (emsg != NULL)
 356   {
 357     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 358                 "Failed to start daemon with error: `%s'\n", emsg);
 359     return;
 360   }
 361   GNUNET_assert (id != NULL);
 362   if (peers_left == num_peers)
 363   {
 364     memcpy (&peer1id, id, sizeof (struct GNUNET_PeerIdentity));
 365     peer1dht = GNUNET_DHT_connect (cfg, 100);
 366     if (peer1dht == NULL)
 367     {
 368       GNUNET_SCHEDULER_cancel (die_task);
 369       GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
 370     }
 371   }
 372   else
 373   {
 374     memcpy (&peer2id, id, sizeof (struct GNUNET_PeerIdentity));
 375     peer2dht = GNUNET_DHT_connect (cfg, 100);
 376     if (peer2dht == NULL)
 377     {
 378       GNUNET_SCHEDULER_cancel (die_task);
 379       GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
 380     }
 381   }
 382
 383
 384   peers_left--;
 385
 386   if (peers_left == 0)
 387   {
 388 #if VERBOSE
 389     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 390                 "All %d daemons started, now connecting peers!\n", num_peers);
 391 #endif
 392     GNUNET_SCHEDULER_cancel (die_task);
 393     /* Set up task in case topology creation doesn't finish
 394      * within a reasonable amount of time */
 395     die_task =
 396         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 397                                       "from peers_started_callback");
 398
 399     GNUNET_SCHEDULER_add_now (&connect_topology, NULL);
 400     ok = 0;
 401   }
 402 }
 403
 404 static void
 405 run (void *cls, char *const *args, const char *cfgfile,
 406      const struct GNUNET_CONFIGURATION_Handle *cfg)
 407 {
 408
 409   if (GNUNET_YES !=
 410       GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
 411                                              &test_directory))
 412   {
 413     ok = 404;
 414     return;
 415   }
 416
 417   if (GNUNET_SYSERR ==
 418       GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
 419                                              &num_peers))
 420     num_peers = DEFAULT_NUM_PEERS;
 421
 422   peers_left = num_peers;
 423   total_gets = num_peers;
 424   gets_succeeded = 0;
 425   /* Set up a task to end testing if peer start fails */
 426   die_task =
 427       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 428                                     "didn't start all daemons in reasonable amount of time!!!");
 429
 430   pg = GNUNET_TESTING_daemons_start (cfg, num_peers, 10, num_peers, TIMEOUT,
 431                                      NULL, NULL, &peers_started_callback, NULL,
 432                                      &topology_callback, NULL, NULL);
 433
 434 }
 435
 436 static int
 437 check ()
 438 {
 439   int ret;
 440
 441   char *const argv[] = { "test-dht-twopeer",
 442     "-c",
 443     "test_dht_twopeer_data.conf",
 444 #if VERBOSE
 445     "-L", "DEBUG",
 446 #endif
 447     NULL
 448   };
 449   struct GNUNET_GETOPT_CommandLineOption options[] = {
 450     GNUNET_GETOPT_OPTION_END
 451   };
 452   ret =
 453       GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 454                           "test-dht-twopeer", "nohelp", options, &run, &ok);
 455   if (ret != GNUNET_OK)
 456   {
 457     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 458                 "`test-dht-twopeer': Failed with error code %d\n", ret);
 459   }
 460   return ok;
 461 }
 462
 463 int
 464 main (int argc, char *argv[])
 465 {
 466   int ret;
 467
 468   GNUNET_log_setup ("test-dht-twopeer",
 469 #if VERBOSE
 470                     "DEBUG",
 471 #else
 472                     "WARNING",
 473 #endif
 474                     NULL);
 475   ret = check ();
 476   /**
 477    * Need to remove base directory, subdirectories taken care
 478    * of by the testing framework.
 479    */
 480   if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
 481   {
 482     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 483                 "Failed to remove testing directory %s\n", test_directory);
 484   }
 485   return ret;
 486 }
 487
 488 /* end of test_dht_twopeer.c */