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