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