src/dht/test_dht_twopeer_put_get.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_put_get.c
  22  * @brief base testcase for testing DHT service with
  23  *        two running peers.
  24  *
  25  * This testcase starts peers using the GNUNET_TESTING_daemons_start
  26  * function call.  On peer start, connects to the peers DHT service
  27  * by calling GNUNET_DHT_connected.  Once notified about all peers
  28  * being started (by the peers_started_callback function), calls
  29  * GNUNET_TESTING_connect_topology, which connects the peers in a
  30  * "straight line" topology.  On notification that all peers have
  31  * been properly connected, runs the do_put function to insert data
  32  * at the first peer.  Once the GNUNET_DHT_put function completes,
  33  * calls the do_get function which initiates a GNUNET_DHT_get from
  34  * the *second* peer.  If the GET is successful, schedules finish_testing
  35  * to stop the test and shut down peers.  If GET is unsuccessful
  36  * after GET_TIMEOUT seconds, prints an error message and shuts down
  37  * the peers.
  38  */
  39 #include "platform.h"
  40 #include "gnunet_testing_lib.h"
  41 #include "gnunet_core_service.h"
  42 #include "gnunet_dht_service.h"
  43 #include "block_dns.h"
  44 #include "gnunet_signatures.h"
  45
  46 /* DEFINES */
  47 #define VERBOSE GNUNET_EXTRA_LOGGING
  48
  49 /* Timeout for entire testcase */
  50 #define TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 5)
  51
  52 /* Timeout for waiting for replies to get requests */
  53 #define GET_TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 30)
  54
  55 /* If number of peers not in config file, use this number */
  56 #define DEFAULT_NUM_PEERS 2
  57
  58 /* Globals */
  59
  60 /**
  61  * Directory to store temp data in, defined in config file
  62  */
  63 static char *test_directory;
  64
  65 /**
  66  * Variable used to store the number of connections we should wait for.
  67  */
  68 static unsigned int expected_connections;
  69
  70 /**
  71  * Variable used to keep track of how many peers aren't yet started.
  72  */
  73 static unsigned long long peers_left;
  74
  75 /**
  76  * Handle to the set of all peers run for this test.
  77  */
  78 static struct GNUNET_TESTING_PeerGroup *pg;
  79
  80 /**
  81  * Global handle we will use for GET requests.
  82  */
  83 struct GNUNET_DHT_GetHandle *global_get_handle;
  84
  85
  86 /**
  87  * Total number of peers to run, set based on config file.
  88  */
  89 static unsigned long long num_peers;
  90
  91 /**
  92  * Global used to count how many connections we have currently
  93  * been notified about (how many times has topology_callback been called
  94  * with success?)
  95  */
  96 static unsigned int total_connections;
  97
  98 /**
  99  * Global used to count how many failed connections we have
 100  * been notified about (how many times has topology_callback
 101  * been called with failure?)
 102  */
 103 static unsigned int failed_connections;
 104
 105 /* Task handle to use to schedule test failure */
 106 static GNUNET_SCHEDULER_TaskIdentifier die_task;
 107
 108 /* Global return value (0 for success, anything else for failure) */
 109 static int ok;
 110
 111 /**
 112  * Peer identity of the first peer started.
 113  */
 114 static struct GNUNET_PeerIdentity peer1id;
 115
 116 /**
 117  * Peer identity of the second peer started.
 118  */
 119 static struct GNUNET_PeerIdentity peer2id;
 120
 121 /**
 122  * Handle to the first peers DHT service (via the API)
 123  */
 124 static struct GNUNET_DHT_Handle *peer1dht;
 125
 126 /**
 127  * Handle to the second peers DHT service (via the API)
 128  */
 129 static struct GNUNET_DHT_Handle *peer2dht;
 130
 131 /**
 132  * Check whether peers successfully shut down.
 133  */
 134 void
 135 shutdown_callback (void *cls, const char *emsg)
 136 {
 137   if (emsg != NULL)
 138   {
 139     if (ok == 0)
 140       ok = 2;
 141   }
 142 }
 143
 144 /**
 145  * Function scheduled to be run on the successful completion of this
 146  * testcase.  Specifically, called when our get request completes.
 147  */
 148 static void
 149 finish_testing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 150 {
 151   GNUNET_assert (pg != NULL);
 152   GNUNET_assert (peer1dht != NULL);
 153   GNUNET_assert (peer2dht != NULL);
 154   GNUNET_DHT_disconnect (peer1dht);
 155   GNUNET_DHT_disconnect (peer2dht);
 156   GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 157   ok = 0;
 158 }
 159
 160 /**
 161  * Continuation for the GNUNET_DHT_get_stop call, so that we don't shut
 162  * down the peers without freeing memory associated with GET request.
 163  */
 164 static void
 165 end_badly_cont (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 166 {
 167   if (peer1dht != NULL)
 168     GNUNET_DHT_disconnect (peer1dht);
 169
 170   if (peer2dht != NULL)
 171     GNUNET_DHT_disconnect (peer2dht);
 172
 173   if (pg != NULL)
 174     GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 175 }
 176
 177 /**
 178  * Check if the get_handle is being used, if so stop the request.  Either
 179  * way, schedule the end_badly_cont function which actually shuts down the
 180  * test.
 181  */
 182 static void
 183 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 184 {
 185   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Failing test with error: `%s'!\n",
 186               (char *) cls);
 187   if (global_get_handle != NULL)
 188   {
 189     GNUNET_DHT_get_stop (global_get_handle);
 190     global_get_handle = NULL;
 191   }
 192   GNUNET_SCHEDULER_add_now (&end_badly_cont, NULL);
 193   ok = 1;
 194 }
 195
 196 /**
 197  * Iterator called if the GET request initiated returns a response.
 198  *
 199  * @param cls closure
 200  * @param exp when will this value expire
 201  * @param key key of the result
 202  * @param type type of the result
 203  * @param size number of bytes in data
 204  * @param data pointer to the result data
 205  */
 206 static void
 207 get_result_iterator (void *cls, struct GNUNET_TIME_Absolute exp,
 208                      const GNUNET_HashCode * key,
 209                      const struct GNUNET_PeerIdentity *get_path,
 210                      unsigned int get_path_size,
 211                      const struct GNUNET_PeerIdentity *put_path,
 212                      unsigned int put_path_size, enum GNUNET_BLOCK_Type type,
 213                      size_t size, const void *result_data)
 214 {
 215   GNUNET_HashCode original_key; /* Key data was stored data under */
 216   char original_data[4];        /* Made up data that was stored */
 217
 218   memset (&original_key, 42, sizeof (GNUNET_HashCode)); /* Set the key to what it was set to previously */
 219   memset (original_data, 43, sizeof (original_data));
 220
 221   if ((sizeof (original_data) != size) ||
 222       (0 != memcmp (&original_key, key, sizeof (GNUNET_HashCode))) ||
 223       (0 != memcmp (original_data, result_data, sizeof (original_data))))
 224   {
 225     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 226                 "Key or data is not the same as was inserted!\n");
 227     GNUNET_SCHEDULER_cancel (die_task);
 228     GNUNET_SCHEDULER_add_now (&end_badly,
 229                               "key or data mismatch in get response!\n");
 230     return;
 231   }
 232
 233   GNUNET_SCHEDULER_cancel (die_task);
 234   GNUNET_DHT_get_stop (global_get_handle);
 235   global_get_handle = NULL;
 236   GNUNET_SCHEDULER_add_now (&finish_testing, NULL);
 237 }
 238
 239
 240 /**
 241  * Called when the PUT request has been transmitted to the DHT service.
 242  * Schedule the GET request for some time in the future.
 243  */
 244 static void
 245 put_finished (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 246 {
 247   GNUNET_HashCode key;          /* Key for data lookup */
 248
 249   GNUNET_SCHEDULER_cancel (die_task);
 250   die_task =
 251       GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &end_badly,
 252                                     "waiting for get response (data not found)");
 253
 254   memset (&key, 42, sizeof (GNUNET_HashCode));  /* Set the key to the same thing as when data was inserted */
 255   global_get_handle =
 256       GNUNET_DHT_get_start (peer2dht, GNUNET_TIME_UNIT_FOREVER_REL,
 257                             GNUNET_BLOCK_TYPE_TEST, &key, 1, GNUNET_DHT_RO_NONE,
 258                             NULL, 0, &get_result_iterator, NULL);
 259 }
 260
 261
 262 /**
 263  * Set up some data, and call API PUT function
 264  */
 265 static void
 266 do_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 267 {
 268   GNUNET_HashCode key;          /* Made up key to store data under */
 269   char data[4];                 /* Made up data to store */
 270
 271   memset (&key, 42, sizeof (GNUNET_HashCode));  /* Set the key to something simple so we can issue GET request */
 272   memset (data, 43, sizeof (data));
 273
 274   /* Insert the data at the first peer */
 275   GNUNET_DHT_put (peer1dht, &key, 1, GNUNET_DHT_RO_NONE, GNUNET_BLOCK_TYPE_TEST,
 276                   sizeof (data), data, GNUNET_TIME_UNIT_FOREVER_ABS,
 277                   GNUNET_TIME_UNIT_FOREVER_REL, &put_finished, NULL);
 278 }
 279
 280
 281 /**
 282  * This function is called whenever a connection attempt is finished between two of
 283  * the started peers (started with GNUNET_TESTING_daemons_start).  The total
 284  * number of times this function is called should equal the number returned
 285  * from the GNUNET_TESTING_connect_topology call.
 286  *
 287  * The emsg variable is NULL on success (peers connected), and non-NULL on
 288  * failure (peers failed to connect).
 289  */
 290 static void
 291 topology_callback (void *cls, const struct GNUNET_PeerIdentity *first,
 292                    const struct GNUNET_PeerIdentity *second, uint32_t distance,
 293                    const struct GNUNET_CONFIGURATION_Handle *first_cfg,
 294                    const struct GNUNET_CONFIGURATION_Handle *second_cfg,
 295                    struct GNUNET_TESTING_Daemon *first_daemon,
 296                    struct GNUNET_TESTING_Daemon *second_daemon,
 297                    const char *emsg)
 298 {
 299   if (emsg == NULL)
 300   {
 301     total_connections++;
 302 #if VERBOSE
 303     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 304                 "connected peer %s to peer %s, distance %u\n",
 305                 first_daemon->shortname, second_daemon->shortname, distance);
 306 #endif
 307   }
 308 #if VERBOSE
 309   else
 310   {
 311     failed_connections++;
 312     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 313                 "Failed to connect peer %s to peer %s with error :\n%s\n",
 314                 first_daemon->shortname, second_daemon->shortname, emsg);
 315   }
 316 #endif
 317
 318   if (total_connections == expected_connections)
 319   {
 320 #if VERBOSE
 321     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 322                 "Created %d total connections, which is our target number!  Starting next phase of testing.\n",
 323                 total_connections);
 324 #endif
 325     GNUNET_SCHEDULER_cancel (die_task);
 326     die_task =
 327         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, "from test gets");
 328
 329     GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &do_put, NULL);
 330   }
 331   else if (total_connections + failed_connections == expected_connections)
 332   {
 333     GNUNET_SCHEDULER_cancel (die_task);
 334     die_task =
 335         GNUNET_SCHEDULER_add_now (&end_badly,
 336                                   "from topology_callback (too many failed connections)");
 337   }
 338 }
 339
 340
 341 /**
 342  * Callback which is called whenever a peer is started (as a result of the
 343  * GNUNET_TESTING_daemons_start call.
 344  *
 345  * @param cls closure argument given to GNUNET_TESTING_daemons_start
 346  * @param id the GNUNET_PeerIdentity of the started peer
 347  * @param cfg the configuration for this specific peer (needed to connect
 348  *            to the DHT)
 349  * @param d the handle to the daemon started
 350  * @param emsg NULL if peer started, non-NULL on error
 351  */
 352 static void
 353 peers_started_callback (void *cls, const struct GNUNET_PeerIdentity *id,
 354                         const struct GNUNET_CONFIGURATION_Handle *cfg,
 355                         struct GNUNET_TESTING_Daemon *d, const char *emsg)
 356 {
 357   if (emsg != NULL)
 358   {
 359     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 360                 "Failed to start daemon with error: `%s'\n", emsg);
 361     return;
 362   }
 363   GNUNET_assert (id != NULL);
 364
 365   /* This is the first peer started */
 366   if (peers_left == num_peers)
 367   {
 368     memcpy (&peer1id, id, sizeof (struct GNUNET_PeerIdentity)); /* Save the peer id */
 369     peer1dht = GNUNET_DHT_connect (cfg, 100);   /* Connect to the first peers DHT service */
 370     if (peer1dht == NULL)       /* If DHT connect failed */
 371     {
 372       GNUNET_SCHEDULER_cancel (die_task);
 373       GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
 374     }
 375   }
 376   else                          /* This is the second peer started */
 377   {
 378     memcpy (&peer2id, id, sizeof (struct GNUNET_PeerIdentity)); /* Same as for first peer... */
 379     peer2dht = GNUNET_DHT_connect (cfg, 100);
 380     if (peer2dht == NULL)
 381     {
 382       GNUNET_SCHEDULER_cancel (die_task);
 383       GNUNET_SCHEDULER_add_now (&end_badly, "Failed to get dht handle!\n");
 384     }
 385   }
 386
 387   /* Decrement number of peers left to start */
 388   peers_left--;
 389
 390   if (peers_left == 0)          /* Indicates all peers started */
 391   {
 392 #if VERBOSE
 393     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 394                 "All %d daemons started, now connecting peers!\n", num_peers);
 395 #endif
 396     expected_connections = -1;
 397     if ((pg != NULL))           /* Sanity check */
 398     {
 399       /* Connect peers in a "straight line" topology, return the number of expected connections */
 400       expected_connections =
 401           GNUNET_TESTING_connect_topology (pg, GNUNET_TESTING_TOPOLOGY_LINE,
 402                                            GNUNET_TESTING_TOPOLOGY_OPTION_ALL,
 403                                            0.0, TIMEOUT, 12, NULL, NULL);
 404     }
 405
 406     /* Cancel current timeout fail task */
 407     GNUNET_SCHEDULER_cancel (die_task);
 408     if (expected_connections == GNUNET_SYSERR)  /* Some error happened */
 409       die_task =
 410           GNUNET_SCHEDULER_add_now (&end_badly,
 411                                     "from connect topology (bad return)");
 412
 413     /* Schedule timeout on failure task */
 414     die_task =
 415         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 416                                       "from connect topology (timeout)");
 417     ok = 0;
 418   }
 419 }
 420
 421 static void
 422 run (void *cls, char *const *args, const char *cfgfile,
 423      const struct GNUNET_CONFIGURATION_Handle *cfg)
 424 {
 425
 426   /* Get path from configuration file */
 427   if (GNUNET_YES !=
 428       GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
 429                                              &test_directory))
 430   {
 431     ok = 404;
 432     return;
 433   }
 434
 435   /* Get number of peers to start from configuration (should be two) */
 436   if (GNUNET_SYSERR ==
 437       GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
 438                                              &num_peers))
 439     num_peers = DEFAULT_NUM_PEERS;
 440
 441   /* Set peers_left so we know when all peers started */
 442   peers_left = num_peers;
 443
 444   /* Set up a task to end testing if peer start fails */
 445   die_task =
 446       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly,
 447                                     "didn't start all daemons in reasonable amount of time!!!");
 448
 449   /* Start num_peers peers, call peers_started_callback on peer start, topology_callback on peer connect */
 450   /* Read the API documentation for other parameters! */
 451   pg = GNUNET_TESTING_daemons_start (cfg, num_peers, 2, 2, TIMEOUT, NULL, NULL,
 452                                      &peers_started_callback, NULL,
 453                                      &topology_callback, NULL, NULL);
 454
 455 }
 456
 457 static int
 458 check ()
 459 {
 460   int ret;
 461
 462   /* Arguments for GNUNET_PROGRAM_run */
 463   char *const argv[] = { "test-dht-twopeer-put-get",    /* Name to give running binary */
 464     "-c",
 465     "test_dht_twopeer_data.conf",       /* Config file to use */
 466 #if VERBOSE
 467     "-L", "DEBUG",
 468 #endif
 469     NULL
 470   };
 471   struct GNUNET_GETOPT_CommandLineOption options[] = {
 472     GNUNET_GETOPT_OPTION_END
 473   };
 474   /* Run the run function as a new program */
 475   ret =
 476       GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 477                           "test-dht-twopeer-put-get", "nohelp", options, &run,
 478                           &ok);
 479   if (ret != GNUNET_OK)
 480   {
 481     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 482                 "`test-dht-twopeer': Failed with error code %d\n", ret);
 483   }
 484   return ok;
 485 }
 486
 487 int
 488 main (int argc, char *argv[])
 489 {
 490   int ret;
 491
 492   GNUNET_log_setup ("test-dht-twopeer",
 493 #if VERBOSE
 494                     "DEBUG",
 495 #else
 496                     "WARNING",
 497 #endif
 498                     NULL);
 499   ret = check ();
 500   /**
 501    * Need to remove base directory, subdirectories taken care
 502    * of by the testing framework.
 503    */
 504   if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
 505   {
 506     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 507                 "Failed to remove testing directory %s\n", test_directory);
 508   }
 509   return ret;
 510 }
 511
 512 /* end of test_dht_twopeer_put_get.c */