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