src/dht/gnunet_dht_profiler.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2014 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 /**
  22  * @file dht/gnunet_dht_profiler.c
  23  * @brief Profiler for GNUnet DHT
  24  * @author Sree Harsha Totakura <sreeharsha@totakura.in>
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_testbed_service.h"
  30 #include "gnunet_dht_service.h"
  31
  32 #define INFO(...)                                       \
  33   GNUNET_log (GNUNET_ERROR_TYPE_INFO, __VA_ARGS__)
  34
  35 #define DEBUG(...)                                           \
  36   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
  37
  38 /**
  39  * Number of peers which should perform a PUT out of 100 peers
  40  */
  41 #define PUT_PROBABILITY 50
  42
  43 /**
  44  * Configuration
  45  */
  46 static struct GNUNET_CONFIGURATION_Handle *cfg;
  47
  48 /**
  49  * Name of the file with the hosts to run the test over
  50  */
  51 static char *hosts_file;
  52
  53 /**
  54  * Context for a peer which actively does DHT PUT/GET
  55  */
  56 struct ActiveContext;
  57
  58 /**
  59  * Context to hold data of peer
  60  */
  61 struct Context
  62 {
  63
  64   /**
  65    * The testbed peer this context belongs to
  66    */
  67   struct GNUNET_TESTBED_Peer *peer;
  68
  69   /**
  70    * Testbed operation acting on this peer
  71    */
  72   struct GNUNET_TESTBED_Operation *op;
  73
  74   /**
  75    * Active context; NULL if this peer is not an active peer
  76    */
  77   struct ActiveContext *ac;
  78 };
  79
  80
  81 /**
  82  * Context for a peer which actively does DHT PUT/GET
  83  */
  84 struct ActiveContext
  85 {
  86   /**
  87    * The linked peer context
  88    */
  89   struct Context *ctx;
  90
  91   /**
  92    * Handler to the DHT service
  93    */
  94   struct GNUNET_DHT_Handle *dht;
  95
  96   /**
  97    * The data used for do a PUT.  Will be NULL if a PUT hasn't been performed yet
  98    */
  99   void *put_data;
 100
 101   /**
 102    * The active context used for our DHT GET
 103    */
 104   struct ActiveContext *get_ac;
 105
 106   /**
 107    * The put handle
 108    */
 109   struct GNUNET_DHT_PutHandle *dht_put;
 110
 111   /**
 112    * The get handle
 113    */
 114   struct GNUNET_DHT_GetHandle *dht_get;
 115
 116   /**
 117    * The hash of the @e put_data
 118    */
 119   struct GNUNET_HashCode hash;
 120
 121   /**
 122    * Delay task
 123    */
 124   GNUNET_SCHEDULER_TaskIdentifier delay_task;
 125
 126   /**
 127    * The size of the @e put_data
 128    */
 129   uint16_t put_data_size;
 130
 131   /**
 132    * The number of peers currently doing GET on our data
 133    */
 134   uint16_t nrefs;
 135 };
 136
 137
 138 /**
 139  * An array of contexts.  The size of this array should be equal to @a num_peers
 140  */
 141 static struct Context *a_ctx;
 142
 143 /**
 144  * Array of active peers
 145  */
 146 static struct ActiveContext *a_ac;
 147
 148 /**
 149  * The delay between starting to do PUTS and GETS
 150  */
 151 static struct GNUNET_TIME_Relative delay;
 152
 153 /**
 154  * The timeout for GET and PUT
 155  */
 156 static struct GNUNET_TIME_Relative timeout;
 157
 158 /**
 159  * Number of peers
 160  */
 161 static unsigned int num_peers;
 162
 163 /**
 164  * Number of active peers
 165  */
 166 static unsigned int n_active;
 167
 168 /**
 169  * Number of DHT service connections we currently have
 170  */
 171 static unsigned int n_dht;
 172
 173 /**
 174  * Number of DHT PUTs made
 175  */
 176 static unsigned int n_puts;
 177
 178 /**
 179  * Number of DHT PUTs succeeded
 180  */
 181 static unsigned int n_puts_ok;
 182
 183 /**
 184  * Number of DHT PUTs failed
 185  */
 186 static unsigned int n_puts_fail;
 187
 188 /**
 189  * Number of DHT GETs made
 190  */
 191 static unsigned int n_gets;
 192
 193 /**
 194  * Number of DHT GETs succeeded
 195  */
 196 static unsigned int n_gets_ok;
 197
 198 /**
 199  * Number of DHT GETs succeeded
 200  */
 201 static unsigned int n_gets_fail;
 202
 203
 204 /**
 205  * Shutdown task.  Cleanup all resources and operations.
 206  *
 207  * @param cls NULL
 208  * @param tc scheduler task context
 209  */
 210 static void
 211 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 212 {
 213   struct ActiveContext *ac;
 214   unsigned int cnt;
 215
 216   if (NULL != a_ctx)
 217   {
 218     for (cnt=0; cnt < num_peers; cnt++)
 219     {
 220       if (NULL != a_ctx[cnt].op)
 221         GNUNET_TESTBED_operation_done (a_ctx[cnt].op);
 222
 223       /* Cleanup active context if this peer is an active peer */
 224       ac = a_ctx[cnt].ac;
 225       if (NULL == ac)
 226         continue;
 227       if (GNUNET_SCHEDULER_NO_TASK != ac->delay_task)
 228         GNUNET_SCHEDULER_cancel (ac->delay_task);
 229       if (NULL != ac->put_data)
 230         GNUNET_free (ac->put_data);
 231       if (NULL != ac->dht_put)
 232         GNUNET_DHT_put_cancel (ac->dht_put);
 233       if (NULL != ac->dht_get)
 234         GNUNET_DHT_get_stop (ac->dht_get);
 235     }
 236     GNUNET_free (a_ctx);
 237     a_ctx = NULL;
 238   }
 239   GNUNET_free_non_null (a_ac);
 240 }
 241
 242
 243 static void
 244 summarize ()
 245 {
 246   INFO ("# PUTS made: %u\n", n_puts);
 247   INFO ("# PUTS succeeded: %u\n", n_puts_ok);
 248   INFO ("# PUTS failed: %u\n", n_puts_fail);
 249   INFO ("# GETS made: %u\n", n_gets);
 250   INFO ("# GETS succeeded: %u\n", n_gets_ok);
 251   INFO ("# GETS failed: %u\n", n_gets_fail);
 252   GNUNET_SCHEDULER_shutdown ();
 253 }
 254
 255
 256 /**
 257  * Task to cancel DHT GET.
 258  *
 259  * @param cls NULL
 260  * @param tc scheduler task context
 261  */
 262 static void
 263 cancel_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 264 {
 265   struct ActiveContext *ac = cls;
 266
 267   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
 268   GNUNET_assert (NULL != ac->dht_get);
 269   GNUNET_DHT_get_stop (ac->dht_get);
 270   ac->dht_get = NULL;
 271   n_gets_fail++;
 272
 273   /* If profiling is complete, summarize */
 274   if (n_gets == n_gets_fail + n_gets_ok)
 275     summarize ();
 276 }
 277
 278
 279 /**
 280  * Iterator called on each result obtained for a DHT
 281  * operation that expects a reply
 282  *
 283  * @param cls closure
 284  * @param exp when will this value expire
 285  * @param key key of the result
 286  * @param get_path peers on reply path (or NULL if not recorded)
 287  *                 [0] = datastore's first neighbor, [length - 1] = local peer
 288  * @param get_path_length number of entries in @a get_path
 289  * @param put_path peers on the PUT path (or NULL if not recorded)
 290  *                 [0] = origin, [length - 1] = datastore
 291  * @param put_path_length number of entries in @a put_path
 292  * @param type type of the result
 293  * @param size number of bytes in @a data
 294  * @param data pointer to the result data
 295  */
 296 static void
 297 get_iter (void *cls,
 298           struct GNUNET_TIME_Absolute exp,
 299           const struct GNUNET_HashCode *key,
 300           const struct GNUNET_PeerIdentity *get_path,
 301           unsigned int get_path_length,
 302           const struct GNUNET_PeerIdentity *put_path,
 303           unsigned int put_path_length,
 304           enum GNUNET_BLOCK_Type type,
 305           size_t size, const void *data)
 306 {
 307   struct ActiveContext *ac = cls;
 308   struct ActiveContext *get_ac = ac->get_ac;
 309
 310   /* FIXME: check the keys of put and get match or not. */
 311   if (get_ac->put_data_size != size)
 312   {
 313     DEBUG ("Found a GET with incorrect data length (this may happen, but very unlikely)\n");
 314     return;
 315   }
 316   if (0 != memcmp (data, get_ac->put_data, size))
 317   {
 318     DEBUG ("Found a GET with incorrect data (this may happen, but very unlikely)\n");
 319     return;
 320   }
 321
 322   /* we found the data we are looking for */
 323   DEBUG ("We found a GET request; %u remaining\n", n_gets - (n_gets_fail + n_gets_ok));
 324   n_gets_ok++;
 325   get_ac->nrefs--;
 326   GNUNET_DHT_get_stop (ac->dht_get);
 327   ac->dht_get = NULL;
 328   GNUNET_SCHEDULER_cancel (ac->delay_task);
 329   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
 330
 331   /* Summarize if profiling is complete */
 332   if (n_gets == n_gets_fail + n_gets_ok)
 333     summarize ();
 334 }
 335
 336
 337 /**
 338  * Task to do DHT GETs
 339  *
 340  * @param cls the active context
 341  * @param tc the scheduler task context
 342  */
 343 static void
 344 delayed_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 345 {
 346   struct ActiveContext *ac = cls;
 347   struct ActiveContext *get_ac;
 348   unsigned int r;
 349
 350   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
 351   get_ac = NULL;
 352   while (1)
 353   {
 354     r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, n_active);
 355     get_ac = &a_ac[r];
 356     if (NULL != get_ac->put_data)
 357       break;
 358   }
 359   get_ac->nrefs++;
 360   ac->get_ac = get_ac;
 361   ac->dht_get = GNUNET_DHT_get_start (ac->dht,
 362                                       GNUNET_BLOCK_TYPE_TEST,
 363                                       &ac->hash,
 364                                       1, /* replication level */
 365                                       GNUNET_DHT_RO_NONE,
 366                                       NULL, 0, /* extended query and size */
 367                                       get_iter, ac); /* GET iterator and closure
 368                                                         */
 369   n_gets++;
 370
 371   /* schedule the timeout task for GET */
 372   ac->delay_task = GNUNET_SCHEDULER_add_delayed (timeout, &cancel_get, ac);
 373 }
 374
 375
 376 /**
 377  * Queue up a delayed task for doing DHT GET
 378  *
 379  * @param cls the active context
 380  * @param success #GNUNET_OK if the PUT was transmitted,
 381  *                #GNUNET_NO on timeout,
 382  *                #GNUNET_SYSERR on disconnect from service
 383  *                after the PUT message was transmitted
 384  *                (so we don't know if it was received or not)
 385  */
 386 static void
 387 put_cont (void *cls, int success)
 388 {
 389   struct ActiveContext *ac = cls;
 390
 391   ac->dht_put = NULL;
 392   if (success)
 393     n_puts_ok++;
 394   else
 395     n_puts_fail++;
 396   ac->delay_task = GNUNET_SCHEDULER_add_delayed (delay, &delayed_get, ac);
 397 }
 398
 399
 400 /**
 401  * Task to do DHT PUTS
 402  *
 403  * @param cls the active context
 404  * @param tc the scheduler task context
 405  */
 406 static void
 407 delayed_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 408 {
 409   struct ActiveContext *ac = cls;
 410
 411   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
 412   /* Generate and DHT PUT some random data */
 413   ac->put_data_size = 16;       /* minimum */
 414   ac->put_data_size += GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 415                                                  (63*1024));
 416   ac->put_data = GNUNET_malloc (ac->put_data_size);
 417   GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_WEAK,
 418                               ac->put_data, ac->put_data_size);
 419   GNUNET_CRYPTO_hash (ac->put_data, ac->put_data_size, &ac->hash);
 420   DEBUG ("Doing a DHT PUT with data of size %u\n", ac->put_data_size);
 421   ac->dht_put = GNUNET_DHT_put (ac->dht, &ac->hash,
 422                                 1,            /* replication level */
 423                                 GNUNET_DHT_RO_NONE,
 424                                 GNUNET_BLOCK_TYPE_TEST,
 425                                 ac->put_data_size,
 426                                 ac->put_data,
 427                                 GNUNET_TIME_UNIT_FOREVER_ABS, /* expiration time */
 428                                 timeout,                      /* PUT timeout */
 429                                 put_cont, ac);                /* continuation and its closure */
 430   n_puts++;
 431 }
 432
 433
 434 /**
 435  * Connection to DHT has been established.  Call the delay task.
 436  *
 437  * @param cls the active context
 438  * @param op the operation that has been finished
 439  * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
 440  * @param emsg error message in case the operation has failed; will be NULL if
 441  *          operation has executed successfully.
 442  */
 443 static void
 444 dht_connected (void *cls,
 445                struct GNUNET_TESTBED_Operation *op,
 446                void *ca_result,
 447                const char *emsg)
 448 {
 449   struct ActiveContext *ac = cls;
 450   struct Context *ctx = ac->ctx;
 451
 452   GNUNET_assert (NULL != ctx);
 453   GNUNET_assert (NULL != ctx->op);
 454   GNUNET_assert (ctx->op == op);
 455   ac->dht = (struct GNUNET_DHT_Handle *) ca_result;
 456   if (NULL != emsg)
 457   {
 458     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Connection to DHT service failed: %s\n", emsg);
 459     GNUNET_TESTBED_operation_done (ctx->op); /* Calls dht_disconnect() */
 460     ctx->op = NULL;
 461     return;
 462   }
 463   ac->delay_task = GNUNET_SCHEDULER_add_delayed (delay, &delayed_put, ac);
 464 }
 465
 466
 467 /**
 468  * Connect to DHT service and return the DHT client handler
 469  *
 470  * @param cls the active context
 471  * @param cfg configuration of the peer to connect to; will be available until
 472  *          GNUNET_TESTBED_operation_done() is called on the operation returned
 473  *          from GNUNET_TESTBED_service_connect()
 474  * @return service handle to return in 'op_result', NULL on error
 475  */
 476 static void *
 477 dht_connect (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
 478 {
 479   n_dht++;
 480   return GNUNET_DHT_connect (cfg, 10);
 481 }
 482
 483
 484 /**
 485  * Adapter function called to destroy a connection to
 486  * a service.
 487  *
 488  * @param cls the active context
 489  * @param op_result service handle returned from the connect adapter
 490  */
 491 static void
 492 dht_disconnect (void *cls, void *op_result)
 493 {
 494   struct ActiveContext *ac = cls;
 495
 496   GNUNET_assert (NULL != ac->dht);
 497   GNUNET_assert (ac->dht == op_result);
 498   GNUNET_DHT_disconnect (ac->dht);
 499   n_dht--;
 500   if (0 == n_dht)
 501     GNUNET_SCHEDULER_shutdown ();
 502 }
 503
 504
 505 /**
 506  * Callback called when DHT service on the peer is started
 507  *
 508  * @param cls the context
 509  * @param op the operation that has been finished
 510  * @param emsg error message in case the operation has failed; will be NULL if
 511  *          operation has executed successfully.
 512  */
 513 static void
 514 service_started (void *cls,
 515                  struct GNUNET_TESTBED_Operation *op,
 516                  const char *emsg)
 517 {
 518   struct Context *ctx = cls;
 519
 520   GNUNET_assert (NULL != ctx);
 521   GNUNET_assert (NULL != ctx->op);
 522   GNUNET_TESTBED_operation_done (ctx->op);
 523   ctx->op = NULL;
 524   if (NULL == ctx->ac)
 525     return;
 526   /* FIXME: connect to the DHT service and wait before starting a PUT */
 527   ctx->op = GNUNET_TESTBED_service_connect (ctx, ctx->peer,
 528                                             "dht",
 529                                             &dht_connected, ctx->ac,
 530                                             &dht_connect,
 531                                             &dht_disconnect,
 532                                             ctx->ac);
 533 }
 534
 535
 536 /**
 537  * Signature of a main function for a testcase.
 538  *
 539  * @param cls closure
 540  * @param h the run handle
 541  * @param num_peers number of peers in 'peers'
 542  * @param peers handle to peers run in the testbed
 543  * @param links_succeeded the number of overlay link connection attempts that
 544  *          succeeded
 545  * @param links_failed the number of overlay link
 546  */
 547 static void
 548 test_run (void *cls,
 549           struct GNUNET_TESTBED_RunHandle *h,
 550           unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers,
 551           unsigned int links_succeeded,
 552           unsigned int links_failed)
 553 {
 554   unsigned int cnt;
 555   unsigned int ac_cnt;
 556
 557   if (NULL == peers)
 558   {
 559     /* exit */
 560     GNUNET_assert (0);
 561   }
 562   INFO ("%u peers started\n", num_peers);
 563   a_ctx = GNUNET_malloc (sizeof (struct Context) * num_peers);
 564
 565   /* select the peers which actively participate in profiling */
 566   n_active = num_peers * PUT_PROBABILITY / 100;
 567   if (0 == n_active)
 568   {
 569     GNUNET_SCHEDULER_shutdown ();
 570     GNUNET_free (a_ctx);
 571     return;
 572   }
 573   a_ac = GNUNET_malloc (n_active * sizeof (struct ActiveContext));
 574   ac_cnt = 0;
 575   for (cnt = 0; cnt < num_peers && ac_cnt < n_active; cnt++)
 576   {
 577     if (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 100) >=
 578         PUT_PROBABILITY)
 579       continue;
 580     a_ctx[cnt].ac = &a_ac[ac_cnt];
 581     a_ac[ac_cnt].ctx = &a_ctx[cnt];
 582     ac_cnt++;
 583   }
 584   n_active = ac_cnt;
 585   a_ac = GNUNET_realloc (a_ac, n_active * sizeof (struct ActiveContext));
 586   INFO ("Active peers: %u\n", n_active);
 587
 588   /* start DHT service on all peers */
 589   for (cnt = 0; cnt < num_peers; cnt++)
 590   {
 591     a_ctx[cnt].peer = peers[cnt];
 592     a_ctx[cnt].op = GNUNET_TESTBED_peer_manage_service (&a_ctx[cnt],
 593                                                         peers[cnt],
 594                                                         "dht",
 595                                                         &service_started,
 596                                                         &a_ctx[cnt],
 597                                                         1);
 598   }
 599 }
 600
 601
 602 /**
 603  * Main function that will be run by the scheduler.
 604  *
 605  * @param cls closure
 606  * @param args remaining command-line arguments
 607  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 608  * @param config configuration
 609  */
 610 static void
 611 run (void *cls, char *const *args, const char *cfgfile,
 612      const struct GNUNET_CONFIGURATION_Handle *config)
 613 {
 614   uint64_t event_mask;
 615
 616   if (0 == num_peers)
 617   {
 618     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Exiting as the number of peers is %u\n"),
 619                 num_peers);
 620     return;
 621   }
 622   cfg = GNUNET_CONFIGURATION_dup (config);
 623   event_mask = 0;
 624   GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask, NULL,
 625                       NULL, &test_run, NULL);
 626   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_shutdown,
 627                                 NULL);
 628 }
 629
 630
 631 /**
 632  * Main function.
 633  *
 634  * @return 0 on success
 635  */
 636 int
 637 main (int argc, char *const *argv)
 638 {
 639   int rc;
 640
 641   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 642     {'n', "peers", "COUNT",
 643      gettext_noop ("number of peers to start"),
 644      1, &GNUNET_GETOPT_set_uint, &num_peers},
 645     {'H', "hosts", "FILENAME",
 646      gettext_noop ("name of the file with the login information for the testbed"),
 647      1, &GNUNET_GETOPT_set_string, &hosts_file},
 648     {'d', "delay", "DELAY",
 649      gettext_noop ("delay for starting DHT PUT and GET"),
 650      1, &GNUNET_GETOPT_set_relative_time, &delay},
 651     {'t', "timeout", "TIMEOUT",
 652      gettext_noop ("timeout for DHT PUT and GET requests"),
 653      1, &GNUNET_GETOPT_set_relative_time, &timeout},
 654     GNUNET_GETOPT_OPTION_END
 655   };
 656
 657   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 658     return 2;
 659   delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3); /* default delay */
 660   timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3); /* default timeout */
 661   rc = 0;
 662   if (GNUNET_OK !=
 663       GNUNET_PROGRAM_run (argc, argv, "dht-profiler",
 664                           gettext_noop
 665                           ("Measure quality and performance of the DHT service."),
 666                           options, &run, NULL))
 667     rc = 1;
 668   return rc;
 669 }