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