src/dht/test_dht_monitor.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 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_monitor.c
  22  *
  23  * @brief Test for the dht service: store, retrieve and monitor in a line.
  24  * TODO: update this description
  25  * Each peer stores it own ID in the DHT and then a different peer tries to
  26  * retrieve that key from it. The GET starts after a first round of PUTS has
  27  * been made. Periodically, each peer stores its ID into the DHT. If after
  28  * a timeout no result has been returned, the test fails.
  29  */
  30 #include "platform.h"
  31 #include "gnunet_testing_lib.h"
  32 #include "gnunet_dht_service.h"
  33
  34 #define VERBOSE GNUNET_YES
  35
  36 #define REMOVE_DIR GNUNET_YES
  37
  38
  39 /**
  40  * How long until we give up on connecting the peers?
  41  */
  42 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1500)
  43
  44 #define GET_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
  45
  46 #define PUT_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
  47
  48 static int ok;
  49
  50 /**
  51  * Be verbose
  52  */
  53 static int verbose;
  54
  55 /**
  56  * Total number of peers in the test.
  57  */
  58 static unsigned long long num_peers;
  59
  60 /**
  61  * Global configuration file
  62  */
  63 static struct GNUNET_CONFIGURATION_Handle *testing_cfg;
  64
  65 /**
  66  * Total number of currently running peers.
  67  */
  68 static unsigned long long peers_running;
  69
  70 /**
  71  * Total number of connections in the whole network.
  72  */
  73 static unsigned int total_connections;
  74
  75 /**
  76  * The currently running peer group.
  77  */
  78 static struct GNUNET_TESTING_PeerGroup *pg;
  79
  80 /**
  81  * File to report results to.
  82  */
  83 static struct GNUNET_DISK_FileHandle *output_file;
  84
  85 /**
  86  * File to log connection info, statistics to.
  87  */
  88 static struct GNUNET_DISK_FileHandle *data_file;
  89
  90 /**
  91  * Task called to disconnect peers.
  92  */
  93 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
  94
  95 /**
  96  * Task To perform tests
  97  */
  98 static GNUNET_SCHEDULER_TaskIdentifier test_task;
  99
 100 /**
 101  * Task to do DHT_puts
 102  */
 103 static GNUNET_SCHEDULER_TaskIdentifier put_task;
 104
 105 /**
 106  * Task called to shutdown test.
 107  */
 108 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
 109
 110 static char *topology_file;
 111
 112 struct GNUNET_TESTING_Daemon *d1;
 113
 114 struct GNUNET_TESTING_Daemon *d2;
 115
 116 struct GNUNET_DHT_Handle **hs;
 117
 118 struct GNUNET_DHT_MonitorHandle **mhs;
 119
 120 struct GNUNET_DHT_GetHandle *get_h_far;
 121
 122 const char *id_origin = "FC74";
 123 const char *id_far = "2UVH";
 124
 125 struct GNUNET_TESTING_Daemon *d_far;
 126 struct GNUNET_TESTING_Daemon *o;
 127
 128 unsigned int monitor_counter;
 129
 130 int in_test;
 131
 132 /**
 133  * Check whether peers successfully shut down.
 134  */
 135 static void
 136 shutdown_callback (void *cls, const char *emsg)
 137 {
 138   if (emsg != NULL)
 139   {
 140 #if VERBOSE
 141     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Shutdown of peers failed!\n");
 142 #endif
 143     ok++;
 144   }
 145   else
 146   {
 147 #if VERBOSE
 148     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 149                 "test: All peers successfully shut down!\n");
 150 #endif
 151   }
 152   GNUNET_CONFIGURATION_destroy (testing_cfg);
 153 }
 154
 155
 156 static void
 157 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 158 {
 159 #if VERBOSE
 160   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Ending test.\n");
 161 #endif
 162
 163   if (disconnect_task != GNUNET_SCHEDULER_NO_TASK)
 164   {
 165     GNUNET_SCHEDULER_cancel (disconnect_task);
 166     disconnect_task = GNUNET_SCHEDULER_NO_TASK;
 167   }
 168
 169   if (data_file != NULL)
 170     GNUNET_DISK_file_close (data_file);
 171   GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 172 }
 173
 174
 175 static void
 176 disconnect_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 177 {
 178   unsigned int i;
 179
 180   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: disconnecting peers\n");
 181   disconnect_task = GNUNET_SCHEDULER_NO_TASK;
 182   GNUNET_SCHEDULER_cancel (put_task);
 183   if (NULL != get_h_far)
 184     GNUNET_DHT_get_stop (get_h_far);
 185   for (i = 0; i < num_peers; i++)
 186   {
 187     GNUNET_DHT_disconnect (hs[i]);
 188   }
 189   GNUNET_SCHEDULER_cancel (shutdown_handle);
 190   shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
 191 }
 192
 193 static void
 194 dht_get_id_handler (void *cls, struct GNUNET_TIME_Absolute exp,
 195                     const GNUNET_HashCode * key,
 196                     const struct GNUNET_PeerIdentity *get_path,
 197                     unsigned int get_path_length,
 198                     const struct GNUNET_PeerIdentity *put_path,
 199                     unsigned int put_path_length, enum GNUNET_BLOCK_Type type,
 200                     size_t size, const void *data)
 201 {
 202   int i;
 203
 204   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 205               "test: ************* FOUND!!! ***********\n");
 206   if (sizeof (GNUNET_HashCode) == size)
 207   {
 208     const GNUNET_HashCode *h = data;
 209
 210     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test:   Contents: %s\n",
 211                 GNUNET_h2s_full (h));
 212
 213   }
 214   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: PATH: (get %u, put %u)\n",
 215               get_path_length, put_path_length);
 216   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test:   LOCAL\n");
 217   for (i = get_path_length - 1; i >= 0; i--)
 218   {
 219     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test:   %s\n",
 220                 GNUNET_i2s (&get_path[i]));
 221   }
 222   for (i = put_path_length - 1; i >= 0; i--)
 223   {
 224     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test:   %s\n",
 225                 GNUNET_i2s (&put_path[i]));
 226   }
 227   if (monitor_counter >= get_path_length + put_path_length)
 228   {
 229     ok = 0;
 230     GNUNET_log (GNUNET_ERROR_TYPE_INFO, "expected at least %u hops, got %u\n",
 231                 get_path_length + put_path_length, monitor_counter);
 232   }
 233   else
 234     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "expected at least %u hops, got %u\n",
 235                 get_path_length + put_path_length, monitor_counter);
 236   GNUNET_SCHEDULER_cancel (disconnect_task);
 237   disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_peers, NULL);
 238 }
 239
 240 static void
 241 do_test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 242 {
 243   in_test = GNUNET_YES;
 244   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: test_task\n");
 245   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: looking for %s\n",
 246               GNUNET_h2s_full (&d_far->id.hashPubKey));
 247   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test:        from %s\n",
 248               GNUNET_h2s_full (&o->id.hashPubKey));
 249   get_h_far = GNUNET_DHT_get_start (hs[0], GNUNET_TIME_UNIT_FOREVER_REL,        /* timeout */
 250                                     GNUNET_BLOCK_TYPE_TEST,     /* type */
 251                                     &d_far->id.hashPubKey,      /*key to search */
 252                                     4U, /* replication level */
 253                                     GNUNET_DHT_RO_RECORD_ROUTE | GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE, NULL,    /* xquery */
 254                                     0,  /* xquery bits */
 255                                     &dht_get_id_handler, NULL);
 256   GNUNET_SCHEDULER_cancel (disconnect_task);
 257   disconnect_task =
 258       GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &disconnect_peers, NULL);
 259 }
 260
 261
 262 /**
 263  * Periodic function used to put the ID of the far peer in the DHT.
 264  *
 265  * @param cls Closure (not used).
 266  * @param tc Task context.
 267  */
 268 static void
 269 put_id (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 270 {
 271   struct GNUNET_TESTING_Daemon *d;
 272
 273   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 274   {
 275     put_task = GNUNET_SCHEDULER_NO_TASK;
 276     return;
 277   }
 278
 279   d = GNUNET_TESTING_daemon_get (pg, 4);
 280   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: putting into DHT: %s\n",
 281               GNUNET_h2s_full (&d->id.hashPubKey));
 282   GNUNET_DHT_put (hs[4], &d->id.hashPubKey, 10U,
 283                   GNUNET_DHT_RO_RECORD_ROUTE |
 284                   GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
 285                   GNUNET_BLOCK_TYPE_TEST, sizeof (struct GNUNET_PeerIdentity),
 286                   (const char *) &d->id, GNUNET_TIME_UNIT_FOREVER_ABS,
 287                   GNUNET_TIME_UNIT_FOREVER_REL, NULL, NULL);
 288
 289   put_task = GNUNET_SCHEDULER_add_delayed (PUT_FREQUENCY, &put_id, NULL);
 290 }
 291
 292 /**
 293  * Callback called on each request going through the DHT.
 294  *
 295  * @param cls Closure.
 296  * @param mtype Type of the DHT message monitored.
 297  * @param exp When will this value expire.
 298  * @param key Key of the result/request.
 299  * @param get_path Peers on reply path (or NULL if not recorded).
 300  * @param get_path_length number of entries in get_path.
 301  * @param put_path peers on the PUT path (or NULL if not recorded).
 302  * @param put_path_length number of entries in get_path.
 303  * @param desired_replication_level Desired replication level.
 304  * @param type Type of the result/request.
 305  * @param data Pointer to the result data.
 306  * @param size Number of bytes in data.
 307  */
 308 void
 309 monitor_dht_cb (void *cls,
 310                 uint16_t mtype,
 311                 struct GNUNET_TIME_Absolute exp,
 312                 const GNUNET_HashCode * key,
 313                 const struct GNUNET_PeerIdentity * get_path,
 314                 unsigned int get_path_length,
 315                 const struct GNUNET_PeerIdentity * put_path,
 316                 unsigned int put_path_length,
 317                 uint32_t desired_replication_level,
 318                 enum GNUNET_DHT_RouteOption options,
 319                 enum GNUNET_BLOCK_Type type,
 320                 const void *data,
 321                 size_t size)
 322 {
 323   const char *s_key;
 324
 325   s_key = GNUNET_h2s(key);
 326   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 327               "%u got a message of type %u for key %s\n",
 328               cls, mtype, s_key);
 329
 330   if ((mtype == GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET ||
 331        mtype == GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT) &&
 332       strncmp (s_key, id_far, 4) == 0 && in_test == GNUNET_YES)
 333     monitor_counter++;
 334 }
 335
 336
 337 /**
 338  * peergroup_ready: start test when all peers are connected
 339  *
 340  * @param cls closure
 341  * @param emsg error message
 342  */
 343 static void
 344 peergroup_ready (void *cls, const char *emsg)
 345 {
 346   struct GNUNET_TESTING_Daemon *d;
 347   char *buf;
 348   int buf_len;
 349   unsigned int i;
 350
 351   if (emsg != NULL)
 352   {
 353     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 354                 "test: Peergroup callback called with error, aborting test!\n");
 355     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Error from testing: `%s'\n",
 356                 emsg);
 357     ok++;
 358     GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 359     return;
 360   }
 361 #if VERBOSE
 362   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 363               "************************************************************\n");
 364   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 365               "test: Peer Group started successfully!\n");
 366   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Have %u connections\n",
 367               total_connections);
 368 #endif
 369
 370   if (data_file != NULL)
 371   {
 372     buf = NULL;
 373     buf_len = GNUNET_asprintf (&buf, "CONNECTIONS_0: %u\n", total_connections);
 374     if (buf_len > 0)
 375       GNUNET_DISK_file_write (data_file, buf, buf_len);
 376     GNUNET_free (buf);
 377   }
 378   peers_running = GNUNET_TESTING_daemons_running (pg);
 379
 380   GNUNET_assert (peers_running == num_peers);
 381   hs = GNUNET_malloc (num_peers * sizeof (struct GNUNET_DHT_Handle *));
 382   mhs = GNUNET_malloc (num_peers * sizeof (struct GNUNET_DHT_MonitorHandle *));
 383   d_far = o = NULL;
 384   o = GNUNET_TESTING_daemon_get (pg, 0);
 385   d_far = GNUNET_TESTING_daemon_get (pg, 4);
 386
 387   for (i = 0; i < num_peers; i++)
 388   {
 389     d = GNUNET_TESTING_daemon_get (pg, i);
 390     hs[i] = GNUNET_DHT_connect (d->cfg, 32);
 391     mhs[i] = GNUNET_DHT_monitor_start(hs[i], GNUNET_BLOCK_TYPE_ANY, NULL,
 392                                       &monitor_dht_cb, (void *)(long)i);
 393   }
 394
 395   if ((NULL == o) || (NULL == d_far))
 396   {
 397     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 398                 "test: Error getting daemons from pg\n");
 399     GNUNET_SCHEDULER_cancel (disconnect_task);
 400     disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_peers, NULL);
 401     return;
 402   }
 403   monitor_counter = 0;
 404   put_task = GNUNET_SCHEDULER_add_now (&put_id, NULL);
 405   test_task =
 406       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 407                                     (GNUNET_TIME_UNIT_SECONDS, 2), &do_test,
 408                                     NULL);
 409   disconnect_task =
 410       GNUNET_SCHEDULER_add_delayed (GET_TIMEOUT, &disconnect_peers, NULL);
 411
 412 }
 413
 414
 415 /**
 416  * Function that will be called whenever two daemons are connected by
 417  * the testing library.
 418  *
 419  * @param cls closure
 420  * @param first peer id for first daemon
 421  * @param second peer id for the second daemon
 422  * @param distance distance between the connected peers
 423  * @param first_cfg config for the first daemon
 424  * @param second_cfg config for the second daemon
 425  * @param first_daemon handle for the first daemon
 426  * @param second_daemon handle for the second daemon
 427  * @param emsg error message (NULL on success)
 428  */
 429 static void
 430 connect_cb (void *cls, const struct GNUNET_PeerIdentity *first,
 431             const struct GNUNET_PeerIdentity *second, uint32_t distance,
 432             const struct GNUNET_CONFIGURATION_Handle *first_cfg,
 433             const struct GNUNET_CONFIGURATION_Handle *second_cfg,
 434             struct GNUNET_TESTING_Daemon *first_daemon,
 435             struct GNUNET_TESTING_Daemon *second_daemon, const char *emsg)
 436 {
 437
 438   if (emsg == NULL)
 439   {
 440     total_connections++;
 441     GNUNET_PEER_intern (first);
 442     GNUNET_PEER_intern (second);
 443   }
 444   else
 445   {
 446     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 447                 "test: Problem with new connection (%s)\n", emsg);
 448   }
 449
 450 }
 451
 452
 453 /**
 454  * run: load configuration options and schedule test to run (start peergroup)
 455  * @param cls closure
 456  * @param args argv
 457  * @param cfgfile configuration file name (can be NULL)
 458  * @param cfg configuration handle
 459  */
 460 static void
 461 run (void *cls, char *const *args, const char *cfgfile,
 462      const struct GNUNET_CONFIGURATION_Handle *cfg)
 463 {
 464   char *temp_str;
 465   struct GNUNET_TESTING_Host *hosts;
 466   char *data_filename;
 467
 468   ok = 1;
 469   testing_cfg = GNUNET_CONFIGURATION_dup (cfg);
 470
 471   GNUNET_log_setup ("test_dht_monitor",
 472 #if VERBOSE
 473                     "DEBUG",
 474 #else
 475                     "WARNING",
 476 #endif
 477                     NULL);
 478
 479 #if VERBOSE
 480   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Starting daemons.\n");
 481   GNUNET_CONFIGURATION_set_value_string (testing_cfg, "testing",
 482                                          "use_progressbars", "YES");
 483 #endif
 484
 485   if (GNUNET_OK !=
 486       GNUNET_CONFIGURATION_get_value_number (testing_cfg, "testing",
 487                                              "num_peers", &num_peers))
 488   {
 489     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 490                 "Option TESTING:NUM_PEERS is required!\n");
 491     return;
 492   }
 493
 494   if (GNUNET_OK !=
 495       GNUNET_CONFIGURATION_get_value_string (testing_cfg, "testing",
 496                                              "topology_output_file",
 497                                              &topology_file))
 498   {
 499     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 500                 "Option test_dht_monitor:topology_output_file is required!\n");
 501     return;
 502   }
 503
 504   if (GNUNET_OK ==
 505       GNUNET_CONFIGURATION_get_value_string (testing_cfg, "test_dht_topo",
 506                                              "data_output_file",
 507                                              &data_filename))
 508   {
 509     data_file =
 510         GNUNET_DISK_file_open (data_filename,
 511                                GNUNET_DISK_OPEN_READWRITE |
 512                                GNUNET_DISK_OPEN_CREATE,
 513                                GNUNET_DISK_PERM_USER_READ |
 514                                GNUNET_DISK_PERM_USER_WRITE);
 515     if (data_file == NULL)
 516     {
 517       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n",
 518                   data_filename);
 519       GNUNET_free (data_filename);
 520     }
 521   }
 522
 523   if (GNUNET_YES ==
 524       GNUNET_CONFIGURATION_get_value_string (cfg, "test_dht_topo",
 525                                              "output_file", &temp_str))
 526   {
 527     output_file =
 528         GNUNET_DISK_file_open (temp_str,
 529                                GNUNET_DISK_OPEN_READWRITE |
 530                                GNUNET_DISK_OPEN_CREATE,
 531                                GNUNET_DISK_PERM_USER_READ |
 532                                GNUNET_DISK_PERM_USER_WRITE);
 533     if (output_file == NULL)
 534       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Failed to open %s for output!\n",
 535                   temp_str);
 536   }
 537   GNUNET_free_non_null (temp_str);
 538
 539   hosts = GNUNET_TESTING_hosts_load (testing_cfg);
 540
 541   pg = GNUNET_TESTING_peergroup_start (testing_cfg, num_peers, TIMEOUT,
 542                                        &connect_cb, &peergroup_ready, NULL,
 543                                        hosts);
 544   GNUNET_assert (pg != NULL);
 545   shutdown_handle =
 546       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 547                                     &shutdown_task, NULL);
 548 }
 549
 550
 551
 552 /**
 553  * test_dht_monitor command line options
 554  */
 555 static struct GNUNET_GETOPT_CommandLineOption options[] = {
 556   {'V', "verbose", NULL,
 557    gettext_noop ("be verbose (print progress information)"),
 558    0, &GNUNET_GETOPT_set_one, &verbose},
 559   GNUNET_GETOPT_OPTION_END
 560 };
 561
 562
 563 /**
 564  * Main: start test
 565  */
 566 int
 567 main (int xargc, char *xargv[])
 568 {
 569   char *const argv[] = { "test-dht-monitor",
 570     "-c",
 571     "test_dht_line.conf",
 572 #if VERBOSE
 573     "-L", "DEBUG",
 574 #endif
 575     NULL
 576   };
 577
 578   in_test = GNUNET_NO;
 579   GNUNET_PROGRAM_run (sizeof (argv) / sizeof (char *) - 1, argv,
 580                       "test_dht_monitor",
 581                       gettext_noop ("Test dht monitoring in a line."),
 582                       options, &run, NULL);
 583 #if REMOVE_DIR
 584   GNUNET_DISK_directory_remove ("/tmp/test_dht_monitor");
 585 #endif
 586   if (0 != ok)
 587   {
 588     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "test: FAILED!\n");
 589   }
 590   return ok;
 591 }
 592
 593 /* end of test_dht_monitor.c */