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 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   if (get_context->retry_task != GNUNET_SCHEDULER_NO_TASK)
 196   {
 197     GNUNET_SCHEDULER_cancel (get_context->retry_task);
 198     get_context->retry_task = GNUNET_SCHEDULER_NO_TASK;
 199   }
 200
 201   if (get_context->peer == &peer2id)
 202   {
 203     get_context->peer = &peer1id;
 204     get_context->dht_handle = peer2dht;
 205     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 206                 "Received first correct GET request response!\n");
 207     GNUNET_DHT_get_stop (get_context->get_handle);
 208     GNUNET_SCHEDULER_add_now (&do_get, get_context);
 209   }
 210   else
 211   {
 212     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 213                 "Received second correct GET request response!\n");
 214     GNUNET_SCHEDULER_cancel (die_task);
 215     GNUNET_DHT_get_stop (get_context->get_handle);
 216     die_task = GNUNET_SCHEDULER_add_now (&finish_testing, NULL);
 217   }
 218
 219 }
 220
 221 static void
 222 stop_retry_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 223
 224
 225 static void
 226 get_stop_finished (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 227 {
 228   struct PeerGetContext *get_context = cls;
 229
 230   if (get_context->get_attempts >= MAX_GET_ATTEMPTS)
 231   {
 232     FPRINTF (stderr, "%s",  "?\n");
 233     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 234                 "Too many attempts failed, ending test!\n",
 235                 get_context->get_attempts);
 236     GNUNET_SCHEDULER_cancel (die_task);
 237     die_task =
 238         GNUNET_SCHEDULER_add_now (&end_badly,
 239                                   "GET attempt failed, ending test!\n");
 240     return;
 241   }
 242   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 243               "Get attempt %u failed, retrying request!\n",
 244               get_context->get_attempts);
 245   FPRINTF (stderr, "%s",  ".");
 246   get_context->get_attempts++;
 247   get_context->retry_task =
 248       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 249                                     (GNUNET_TIME_UNIT_SECONDS, 60),
 250                                     &stop_retry_get, get_context);
 251   get_context->get_handle =
 252       GNUNET_DHT_get_start (get_context->dht_handle,
 253                             GNUNET_TIME_relative_multiply
 254                             (GNUNET_TIME_UNIT_SECONDS, 5),
 255                             GNUNET_BLOCK_TYPE_DHT_HELLO,
 256                             &get_context->peer->hashPubKey, 1,
 257                             GNUNET_DHT_RO_NONE, NULL, 0, &get_result_iterator,
 258                             get_context);
 259 }
 260
 261
 262 static void
 263 stop_retry_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 264 {
 265   struct PeerGetContext *get_context = cls;
 266
 267   get_context->retry_task = GNUNET_SCHEDULER_NO_TASK;
 268   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 269               "Get attempt %u failed, canceling request!\n",
 270               get_context->get_attempts);
 271   GNUNET_DHT_get_stop (get_context->get_handle);
 272   get_context->get_handle = NULL;
 273   GNUNET_SCHEDULER_add_now (&get_stop_finished, get_context);
 274 }
 275
 276
 277 static void
 278 do_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 279 {
 280   struct PeerGetContext *get_context = cls;
 281
 282   get_context->retry_task =
 283       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 284                                     (GNUNET_TIME_UNIT_SECONDS, 10),
 285                                     &stop_retry_get, get_context);
 286   get_context->get_handle =
 287       GNUNET_DHT_get_start (get_context->dht_handle,
 288                             GNUNET_TIME_relative_multiply
 289                             (GNUNET_TIME_UNIT_SECONDS, 5),
 290                             GNUNET_BLOCK_TYPE_DHT_HELLO,
 291                             &get_context->peer->hashPubKey, 1,
 292                             GNUNET_DHT_RO_FIND_PEER, NULL, 0,
 293                             &get_result_iterator, get_context);
 294 }
 295
 296
 297 static void
 298 topology_callback (void *cls, const struct GNUNET_PeerIdentity *first,
 299                    const struct GNUNET_PeerIdentity *second, uint32_t distance,
 300                    const struct GNUNET_CONFIGURATION_Handle *first_cfg,
 301                    const struct GNUNET_CONFIGURATION_Handle *second_cfg,
 302                    struct GNUNET_TESTING_Daemon *first_daemon,
 303                    struct GNUNET_TESTING_Daemon *second_daemon,
 304                    const char *emsg)
 305 {
 306   if (emsg == NULL)
 307   {
 308     total_connections++;
 309 #if VERBOSE
 310     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 311                 "connected peer %s to peer %s, distance %u\n",
 312                 first_daemon->shortname, second_daemon->shortname, distance);
 313   }
 314   else
 315   {
 316     failed_connections++;
 317     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 318                 "Failed to connect peer %s to peer %s with error :\n%s\n",
 319                 first_daemon->shortname, second_daemon->shortname, emsg);
 320 #endif
 321   }
 322
 323   if (total_connections == expected_connections)
 324   {
 325 #if VERBOSE
 326     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 327                 "Created %d total connections, which is our target number!  Starting next phase of testing.\n",
 328                 total_connections);
 329 #endif
 330     GNUNET_SCHEDULER_cancel (die_task);
 331     die_task =
 332         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 333                                       "Timeout trying to GET");
 334
 335     curr_get_ctx.dht_handle = peer1dht;
 336     curr_get_ctx.peer = &peer2id;
 337     GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 338                                   (GNUNET_TIME_UNIT_SECONDS, 2), &do_get,
 339                                   &curr_get_ctx);
 340   }
 341   else if (total_connections + failed_connections == expected_connections)
 342   {
 343     GNUNET_SCHEDULER_cancel (die_task);
 344     die_task =
 345         GNUNET_SCHEDULER_add_now (&end_badly,
 346                                   "from topology_callback (too many failed connections)");
 347   }
 348 }
 349
 350
 351 static void
 352 connect_topology (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 353 {
 354   expected_connections = -1;
 355   if ((pg != NULL) && (peers_left == 0))
 356     expected_connections =
 357         GNUNET_TESTING_connect_topology (pg, GNUNET_TESTING_TOPOLOGY_CLIQUE,
 358                                          GNUNET_TESTING_TOPOLOGY_OPTION_ALL,
 359                                          0.0, TIMEOUT, 12, NULL, NULL);
 360
 361   GNUNET_SCHEDULER_cancel (die_task);
 362   if (expected_connections == GNUNET_SYSERR)
 363     die_task =
 364         GNUNET_SCHEDULER_add_now (&end_badly,
 365                                   "from connect topology (bad return)");
 366   else
 367     die_task =
 368         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 369                                       "from connect topology (timeout)");
 370 }
 371
 372
 373 static void
 374 peers_started_callback (void *cls, const struct GNUNET_PeerIdentity *id,
 375                         const struct GNUNET_CONFIGURATION_Handle *cfg,
 376                         struct GNUNET_TESTING_Daemon *d, const char *emsg)
 377 {
 378   if (emsg != NULL)
 379   {
 380     FPRINTF (stderr, "Failed to start daemon: `%s'\n", emsg);
 381     return;
 382   }
 383   GNUNET_assert (id != NULL);
 384   if (peers_left == num_peers)
 385   {
 386     memcpy (&peer1id, id, sizeof (struct GNUNET_PeerIdentity));
 387     peer1dht = GNUNET_DHT_connect (cfg, 100);
 388     if (peer1dht == NULL)
 389     {
 390       GNUNET_SCHEDULER_cancel (die_task);
 391       die_task =
 392           GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
 393     }
 394   }
 395   else
 396   {
 397     memcpy (&peer2id, id, sizeof (struct GNUNET_PeerIdentity));
 398     peer2dht = GNUNET_DHT_connect (cfg, 100);
 399     if (peer2dht == NULL)
 400     {
 401       GNUNET_SCHEDULER_cancel (die_task);
 402       die_task =
 403           GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
 404     }
 405   }
 406
 407
 408   peers_left--;
 409
 410   if (peers_left == 0)
 411   {
 412 #if VERBOSE
 413     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 414                 "All %d daemons started, now connecting peers!\n", num_peers);
 415 #endif
 416     GNUNET_SCHEDULER_cancel (die_task);
 417     /* Set up task in case topology creation doesn't finish
 418      * within a reasonable amount of time */
 419     die_task =
 420         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 421                                       "from peers_started_callback");
 422
 423     GNUNET_SCHEDULER_add_now (&connect_topology, NULL);
 424     ok = 0;
 425   }
 426 }
 427
 428
 429 static void
 430 run (void *cls, char *const *args, const char *cfgfile,
 431      const struct GNUNET_CONFIGURATION_Handle *cfg)
 432 {
 433
 434   if (GNUNET_YES !=
 435       GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
 436                                              &test_directory))
 437   {
 438     ok = 404;
 439     return;
 440   }
 441
 442   if (GNUNET_SYSERR ==
 443       GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
 444                                              &num_peers))
 445     num_peers = DEFAULT_NUM_PEERS;
 446
 447   peers_left = num_peers;
 448   total_gets = num_peers;
 449   gets_succeeded = 0;
 450   /* Set up a task to end testing if peer start fails */
 451   die_task =
 452       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 453                                     "didn't start all daemons in reasonable amount of time!!!");
 454
 455   pg = GNUNET_TESTING_daemons_start (cfg, num_peers, 10, num_peers, TIMEOUT,
 456                                      NULL, NULL, &peers_started_callback, NULL,
 457                                      &topology_callback, NULL, NULL);
 458
 459 }
 460
 461 static int
 462 check ()
 463 {
 464   int ret;
 465
 466   char *const argv[] = { "test-dht-twopeer",
 467     "-c",
 468     "test_dht_twopeer_data.conf",
 469 #if VERBOSE
 470     "-L", "DEBUG",
 471 #endif
 472     NULL
 473   };
 474   struct GNUNET_GETOPT_CommandLineOption options[] = {
 475     GNUNET_GETOPT_OPTION_END
 476   };
 477   ret =
 478       GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 479                           "test-dht-twopeer", "nohelp", options, &run, &ok);
 480   if (ret != GNUNET_OK)
 481   {
 482     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 483                 "`test-dht-twopeer': Failed with error code %d\n", ret);
 484   }
 485   return ok;
 486 }
 487
 488 int
 489 main (int argc, char *argv[])
 490 {
 491   int ret;
 492
 493   GNUNET_log_setup ("test-dht-twopeer",
 494 #if VERBOSE
 495                     "DEBUG",
 496 #else
 497                     "WARNING",
 498 #endif
 499                     NULL);
 500   ret = check ();
 501   /**
 502    * Need to remove base directory, subdirectories taken care
 503    * of by the testing framework.
 504    */
 505   if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
 506   {
 507     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 508                 "Failed to remove testing directory %s\n", test_directory);
 509   }
 510   return ret;
 511 }
 512
 513 /* end of test_dht_twopeer.c */