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