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 100
  42
  43 /**
  44  * Percentage of peers that should act maliciously.
  45  * These peers will never start PUT/GET request.
  46  * n_active and n_malicious should not intersect.
  47  */
  48 #define MALICIOUS_PEERS 0
  49
  50 /**
  51  * Configuration
  52  */
  53 static struct GNUNET_CONFIGURATION_Handle *cfg;
  54
  55 /**
  56  * Name of the file with the hosts to run the test over
  57  */
  58 static char *hosts_file;
  59
  60 /**
  61  * Context for a peer which actively does DHT PUT/GET
  62  */
  63 struct ActiveContext;
  64
  65 /**
  66  * Context to hold data of peer
  67  */
  68 struct Context
  69 {
  70
  71   /**
  72    * The testbed peer this context belongs to
  73    */
  74   struct GNUNET_TESTBED_Peer *peer;
  75
  76   /**
  77    * Testbed operation acting on this peer
  78    */
  79   struct GNUNET_TESTBED_Operation *op;
  80
  81   /**
  82    * Active context; NULL if this peer is not an active peer
  83    */
  84   struct ActiveContext *ac;
  85 };
  86
  87
  88 #if ENABLE_MALICIOUS
  89 /**
  90  * Context for a peer which should act maliciously.
  91  */
  92 struct MaliciousContext
  93 {
  94   /**
  95    * The linked peer context
  96    */
  97   struct Context *ctx;
  98
  99   /**
 100    * Handler to the DHT service
 101    */
 102   struct GNUNET_DHT_Handle *dht;
 103 };
 104
 105 /**
 106  * List of all the malicious peers contexts.
 107  */
 108 struct Context **malicious_peer_contexts = NULL;
 109
 110 #endif
 111
 112 /**
 113  * Context for a peer which actively does DHT PUT/GET
 114  */
 115 struct ActiveContext
 116 {
 117   /**
 118    * The linked peer context
 119    */
 120   struct Context *ctx;
 121
 122   /**
 123    * Handler to the DHT service
 124    */
 125   struct GNUNET_DHT_Handle *dht;
 126
 127   /**
 128    * The data used for do a PUT.  Will be NULL if a PUT hasn't been performed yet
 129    */
 130   void *put_data;
 131
 132   /**
 133    * The active context used for our DHT GET
 134    */
 135   struct ActiveContext *get_ac;
 136
 137   /**
 138    * The put handle
 139    */
 140   struct GNUNET_DHT_PutHandle *dht_put;
 141
 142   /**
 143    * The get handle
 144    */
 145   struct GNUNET_DHT_GetHandle *dht_get;
 146
 147   /**
 148    * The hash of the @e put_data
 149    */
 150   struct GNUNET_HashCode hash;
 151
 152   /**
 153    * Delay task
 154    */
 155   GNUNET_SCHEDULER_TaskIdentifier delay_task;
 156
 157   /**
 158    * The size of the @e put_data
 159    */
 160   uint16_t put_data_size;
 161
 162   /**
 163    * The number of peers currently doing GET on our data
 164    */
 165   uint16_t nrefs;
 166 };
 167
 168
 169 /**
 170  * An array of contexts.  The size of this array should be equal to @a num_peers
 171  */
 172 static struct Context *a_ctx;
 173
 174 /**
 175  * Array of active peers
 176  */
 177 static struct ActiveContext *a_ac;
 178
 179 /**
 180  * The delay between rounds for collecting statistics
 181  */
 182 static struct GNUNET_TIME_Relative delay_stats;
 183
 184 /**
 185  * The delay to start puts.
 186  */
 187 static struct GNUNET_TIME_Relative delay_put;
 188
 189 /**
 190  * The delay to start puts.
 191  */
 192 static struct GNUNET_TIME_Relative delay_get;
 193
 194 /**
 195  * The timeout for GET and PUT
 196  */
 197 static struct GNUNET_TIME_Relative timeout;
 198
 199 /**
 200  * Number of peers
 201  */
 202 static unsigned int num_peers;
 203
 204 #if ENABLE_MALICIOUS
 205 /**
 206  * Number or malicious peers.
 207  */
 208 static unsigned int n_malicious;
 209 #endif
 210
 211 /**
 212  * Number of active peers
 213  */
 214 static unsigned int n_active;
 215
 216 /**
 217  * Number of DHT service connections we currently have
 218  */
 219 static unsigned int n_dht;
 220
 221 /**
 222  * Number of DHT PUTs made
 223  */
 224 static unsigned int n_puts;
 225
 226 /**
 227  * Number of DHT PUTs succeeded
 228  */
 229 static unsigned int n_puts_ok;
 230
 231 /**
 232  * Number of DHT PUTs failed
 233  */
 234 static unsigned int n_puts_fail;
 235
 236 /**
 237  * Number of DHT GETs made
 238  */
 239 static unsigned int n_gets;
 240
 241 /**
 242  * Number of DHT GETs succeeded
 243  */
 244 static unsigned int n_gets_ok;
 245
 246 /**
 247  * Number of DHT GETs succeeded
 248  */
 249 static unsigned int n_gets_fail;
 250
 251 /**
 252  * Replication degree
 253  */
 254 static unsigned int replication;
 255
 256 /**
 257  * Number of times we try to find the successor circle formation
 258  */
 259 static unsigned int max_searches;
 260
 261 /**
 262  * Testbed Operation (to get stats).
 263  */
 264 static struct GNUNET_TESTBED_Operation *bandwidth_stats_op;
 265
 266 /**
 267  * To get successor stats.
 268  */
 269 static struct GNUNET_TESTBED_Operation *successor_stats_op;
 270
 271 /**
 272  * Testbed peer handles.
 273  */
 274 static struct GNUNET_TESTBED_Peer **testbed_handles;
 275
 276 /**
 277  * Total number of messages sent by peer.
 278  */
 279 static uint64_t outgoing_bandwidth;
 280
 281 /**
 282  * Total number of messages received by peer.
 283  */
 284 static uint64_t incoming_bandwidth;
 285
 286 /**
 287  * Average number of hops taken to do put.
 288  */
 289 static double average_put_path_length;
 290
 291 /**
 292  * Average number of hops taken to do get.
 293  */
 294 static double average_get_path_length;
 295
 296 /**
 297  * Total put path length across all peers.
 298  */
 299 static unsigned int total_put_path_length;
 300
 301 /**
 302  * Total get path length across all peers.
 303  */
 304 static unsigned int total_get_path_length;
 305
 306 /**
 307  * Hashmap to store pair of peer and its corresponding successor.
 308  */
 309 static struct GNUNET_CONTAINER_MultiHashMap *successor_peer_hashmap;
 310
 311 /**
 312  * Key to start the lookup on successor_peer_hashmap.
 313  */
 314 static struct GNUNET_HashCode *start_key;
 315
 316 /**
 317  * Flag used to get the start_key.
 318  */
 319 static int flag = 0;
 320
 321 /**
 322  * Task to collect peer and its current successor statistics.
 323  */
 324 static GNUNET_SCHEDULER_TaskIdentifier successor_stats_task;
 325
 326 /**
 327  * Closure for successor_stats_task.
 328  */
 329 struct Collect_Stat_Context
 330 {
 331   /**
 332    * Current Peer Context.
 333    */
 334   struct Context *service_connect_ctx;
 335
 336   /**
 337    * Testbed operation acting on this peer
 338    */
 339   struct GNUNET_TESTBED_Operation *op;
 340 };
 341
 342 /**
 343  * List of all the peers contexts.
 344  */
 345 struct Context **peer_contexts = NULL;
 346
 347 /**
 348  * Counter to keep track of peers added to peer_context lists.
 349  */
 350 static int peers_started = 0;
 351
 352
 353 /**
 354  * Should we do a PUT (mode = 0) or GET (mode = 1);
 355  */
 356 static enum
 357 {
 358   MODE_PUT = 0,
 359
 360   MODE_GET = 1
 361 } mode;
 362
 363 /**
 364  * Task that collects successor statistics from all the peers.
 365  * @param cls
 366  * @param tc
 367  */
 368 static void
 369 collect_stats (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 370
 371
 372 /**
 373  * Shutdown task.  Cleanup all resources and operations.
 374  *
 375  * @param cls NULL
 376  * @param tc scheduler task context
 377  */
 378 static void
 379 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 380 {
 381   struct ActiveContext *ac;
 382   unsigned int cnt;
 383
 384   if (NULL != a_ctx)
 385   {
 386     for (cnt=0; cnt < num_peers; cnt++)
 387     {
 388       if (NULL != a_ctx[cnt].op)
 389         GNUNET_TESTBED_operation_done (a_ctx[cnt].op); //FIXME: assertion fails.
 390
 391       /* Cleanup active context if this peer is an active peer */
 392       ac = a_ctx[cnt].ac;
 393       if (NULL == ac)
 394         continue;
 395       if (GNUNET_SCHEDULER_NO_TASK != ac->delay_task)
 396         GNUNET_SCHEDULER_cancel (ac->delay_task);
 397       if (NULL != ac->put_data)
 398         GNUNET_free (ac->put_data);
 399       if (NULL != ac->dht_put)
 400         GNUNET_DHT_put_cancel (ac->dht_put);
 401       if (NULL != ac->dht_get)
 402         GNUNET_DHT_get_stop (ac->dht_get);
 403     }
 404     GNUNET_free (a_ctx);
 405     a_ctx = NULL;
 406   }
 407   //FIXME: Should we collect stats only for put/get not for other messages.
 408   if(NULL != bandwidth_stats_op)
 409     GNUNET_TESTBED_operation_done (bandwidth_stats_op);
 410   bandwidth_stats_op = NULL;
 411   GNUNET_free_non_null (a_ac);
 412 }
 413
 414
 415 /**
 416  * Stats callback. Finish the stats testbed operation and when all stats have
 417  * been iterated, shutdown the test.
 418  *
 419  * @param cls closure
 420  * @param op the operation that has been finished
 421  * @param emsg error message in case the operation has failed; will be NULL if
 422  *          operation has executed successfully.
 423  */
 424 static void
 425 bandwidth_stats_cont (void *cls,
 426                       struct GNUNET_TESTBED_Operation *op,
 427                       const char *emsg)
 428 {
 429   INFO ("# Outgoing bandwidth: %u\n", outgoing_bandwidth);
 430   INFO ("# Incoming bandwidth: %u\n", incoming_bandwidth);
 431   GNUNET_SCHEDULER_shutdown ();
 432 }
 433
 434
 435 /**
 436  * Process statistic values.
 437  *
 438  * @param cls closure
 439  * @param peer the peer the statistic belong to
 440  * @param subsystem name of subsystem that created the statistic
 441  * @param name the name of the datum
 442  * @param value the current value
 443  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
 444  * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
 445  */
 446 static int
 447 bandwidth_stats_iterator (void *cls,
 448                           const struct GNUNET_TESTBED_Peer *peer,
 449                           const char *subsystem,
 450                           const char *name,
 451                           uint64_t value,
 452                           int is_persistent)
 453 {
 454    static const char *s_sent = "# Bytes transmitted to other peers";
 455    static const char *s_recv = "# Bytes received from other peers";
 456
 457    if (0 == strncmp (s_sent, name, strlen (s_sent)))
 458      outgoing_bandwidth = outgoing_bandwidth + value;
 459    else if (0 == strncmp(s_recv, name, strlen (s_recv)))
 460      incoming_bandwidth = incoming_bandwidth + value;
 461
 462     return GNUNET_OK;
 463 }
 464
 465
 466 static void
 467 summarize ()
 468 {
 469   INFO ("# PUTS made: %u\n", n_puts);
 470   INFO ("# PUTS succeeded: %u\n", n_puts_ok);
 471   INFO ("# PUTS failed: %u\n", n_puts_fail);
 472   INFO ("# GETS made: %u\n", n_gets);
 473   INFO ("# GETS succeeded: %u\n", n_gets_ok);
 474   INFO ("# GETS failed: %u\n", n_gets_fail);
 475   INFO ("# average_put_path_length: %f\n", average_put_path_length);
 476   INFO ("# average_get_path_length: %f\n", average_get_path_length);
 477
 478   if (NULL == testbed_handles)
 479   {
 480     INFO ("No peers found\n");
 481     return;
 482   }
 483   /* Collect Stats*/
 484   bandwidth_stats_op = GNUNET_TESTBED_get_statistics (n_active, testbed_handles,
 485                                                       "dht", NULL,
 486                                                        bandwidth_stats_iterator,
 487                                                        bandwidth_stats_cont, NULL);
 488 }
 489
 490
 491 /**
 492  * Task to cancel DHT GET.
 493  *
 494  * @param cls NULL
 495  * @param tc scheduler task context
 496  */
 497 static void
 498 cancel_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 499 {
 500   struct ActiveContext *ac = cls;
 501   struct Context *ctx = ac->ctx;
 502
 503   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
 504   GNUNET_assert (NULL != ac->dht_get);
 505   GNUNET_DHT_get_stop (ac->dht_get);
 506   ac->dht_get = NULL;
 507   n_gets_fail++;
 508   GNUNET_assert (NULL != ctx->op);
 509   GNUNET_TESTBED_operation_done (ctx->op);
 510   ctx->op = NULL;
 511
 512   /* If profiling is complete, summarize */
 513   if (n_active == n_gets_fail + n_gets_ok)
 514     summarize ();
 515
 516 }
 517
 518
 519 /**
 520  * Iterator called on each result obtained for a DHT
 521  * operation that expects a reply
 522  *
 523  * @param cls closure
 524  * @param exp when will this value expire
 525  * @param key key of the result
 526  * @param get_path peers on reply path (or NULL if not recorded)
 527  *                 [0] = datastore's first neighbor, [length - 1] = local peer
 528  * @param get_path_length number of entries in @a get_path
 529  * @param put_path peers on the PUT path (or NULL if not recorded)
 530  *                 [0] = origin, [length - 1] = datastore
 531  * @param put_path_length number of entries in @a put_path
 532  * @param type type of the result
 533  * @param size number of bytes in @a data
 534  * @param data pointer to the result data
 535  */
 536 static void
 537 get_iter (void *cls,
 538           struct GNUNET_TIME_Absolute exp,
 539           const struct GNUNET_HashCode *key,
 540           const struct GNUNET_PeerIdentity *get_path,
 541           unsigned int get_path_length,
 542           const struct GNUNET_PeerIdentity *put_path,
 543           unsigned int put_path_length,
 544           enum GNUNET_BLOCK_Type type,
 545           size_t size, const void *data)
 546 {
 547   struct ActiveContext *ac = cls;
 548   struct ActiveContext *get_ac = ac->get_ac;
 549   struct Context *ctx = ac->ctx;
 550
 551   /* Check the keys of put and get match or not. */
 552   GNUNET_assert (0 == memcmp (key, &get_ac->hash, sizeof (struct GNUNET_HashCode)));
 553   /* we found the data we are looking for */
 554   DEBUG ("We found a GET request; %u remaining\n", n_gets - (n_gets_fail + n_gets_ok));
 555   n_gets_ok++;
 556   get_ac->nrefs--;
 557   GNUNET_DHT_get_stop (ac->dht_get);
 558   ac->dht_get = NULL;
 559   GNUNET_SCHEDULER_cancel (ac->delay_task);
 560   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
 561   GNUNET_assert (NULL != ctx->op);
 562   GNUNET_TESTBED_operation_done (ctx->op);
 563   ctx->op = NULL;
 564
 565   total_put_path_length = total_put_path_length + put_path_length;
 566   total_get_path_length = total_get_path_length + get_path_length;
 567
 568   /* Summarize if profiling is complete */
 569   if (n_active == n_gets_fail + n_gets_ok)
 570   {
 571     average_put_path_length = (double)total_put_path_length/(double)n_active;
 572     average_get_path_length = (double)total_get_path_length/(double )n_active;
 573     summarize ();
 574   }
 575 }
 576
 577
 578 /**
 579  * Task to do DHT GETs
 580  *
 581  * @param cls the active context
 582  * @param tc the scheduler task context
 583  */
 584 static void
 585 delayed_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 586 {
 587   struct ActiveContext *ac = cls;
 588   struct ActiveContext *get_ac;
 589   unsigned int r;
 590
 591   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
 592   get_ac = NULL;
 593   while (1)
 594   {
 595     r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, n_active);
 596     get_ac = &a_ac[r];
 597     if (NULL != get_ac->put_data)
 598       break;
 599   }
 600   get_ac->nrefs++;
 601   ac->get_ac = get_ac;
 602   DEBUG ("GET_REQUEST_START key %s \n", GNUNET_h2s((struct GNUNET_HashCode *)ac->put_data));
 603   ac->dht_get = GNUNET_DHT_get_start (ac->dht,
 604                                       GNUNET_BLOCK_TYPE_TEST,
 605                                       &get_ac->hash,
 606                                       1, /* replication level */
 607                                       GNUNET_DHT_RO_NONE,
 608                                       NULL, 0, /* extended query and size */
 609                                       get_iter, ac); /* GET iterator and closure
 610                                                         */
 611   n_gets++;
 612
 613   /* schedule the timeout task for GET */
 614   ac->delay_task = GNUNET_SCHEDULER_add_delayed (timeout, &cancel_get, ac);
 615 }
 616
 617
 618 /**
 619  * Task to teardown the dht connection.  We do it as a task because calling
 620  * GNUNET_DHT_disconnect() from put_continutation_callback seems illegal (the
 621  * put_continuation_callback() is getting called again synchronously).  Also,
 622  * only free the operation when we are not shutting down; the shutdown task will
 623  * clear the operation during shutdown.
 624  *
 625  * @param cls the context
 626  * @return tc scheduler task context.
 627  */
 628 static void
 629 teardown_dht_connection (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 630 {
 631   struct Context *ctx = cls;
 632   struct GNUNET_TESTBED_Operation *op;
 633
 634   if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
 635     return;
 636   GNUNET_assert (NULL != ctx);
 637   GNUNET_assert (NULL != (op = ctx->op));
 638   ctx->op = NULL;
 639   GNUNET_TESTBED_operation_done (op);
 640 }
 641
 642
 643 /**
 644  * Queue up a delayed task for doing DHT GET
 645  *
 646  * @param cls the active context
 647  * @param success #GNUNET_OK if the PUT was transmitted,
 648  *                #GNUNET_NO on timeout,
 649  *                #GNUNET_SYSERR on disconnect from service
 650  *                after the PUT message was transmitted
 651  *                (so we don't know if it was received or not)
 652  */
 653 static void
 654 put_cont (void *cls, int success)
 655 {
 656   struct ActiveContext *ac = cls;
 657   struct Context *ctx = ac->ctx;
 658
 659   ac->dht_put = NULL;
 660   if (success)
 661     n_puts_ok++;
 662   else
 663     n_puts_fail++;
 664   GNUNET_assert (NULL != ctx);
 665   (void) GNUNET_SCHEDULER_add_now (&teardown_dht_connection, ctx);
 666 }
 667
 668
 669 /**
 670  * Task to do DHT PUTS
 671  *
 672  * @param cls the active context
 673  * @param tc the scheduler task context
 674  */
 675 static void
 676 delayed_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 677 {
 678   struct ActiveContext *ac = cls;
 679
 680   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
 681   /* Generate and DHT PUT some random data */
 682   ac->put_data_size = 16;       /* minimum */
 683   ac->put_data_size += GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 684                                                  (63*1024));
 685   ac->put_data = GNUNET_malloc (ac->put_data_size);
 686   GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_WEAK,
 687                               ac->put_data, ac->put_data_size);
 688   GNUNET_CRYPTO_hash (ac->put_data, ac->put_data_size, &ac->hash);
 689   DEBUG ("PUT_REQUEST_START key %s \n", GNUNET_h2s((struct GNUNET_HashCode *)ac->put_data));
 690   ac->dht_put = GNUNET_DHT_put (ac->dht, &ac->hash,
 691                                 replication,
 692                                 GNUNET_DHT_RO_NONE,
 693                                 GNUNET_BLOCK_TYPE_TEST,
 694                                 ac->put_data_size,
 695                                 ac->put_data,
 696                                 GNUNET_TIME_UNIT_FOREVER_ABS, /* expiration time */
 697                                 timeout,                      /* PUT timeout */
 698                                 put_cont, ac);                /* continuation and its closure */
 699   n_puts++;
 700 }
 701
 702
 703 /**
 704  * Connection to DHT has been established.  Call the delay task.
 705  *
 706  * @param cls the active context
 707  * @param op the operation that has been finished
 708  * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
 709  * @param emsg error message in case the operation has failed; will be NULL if
 710  *          operation has executed successfully.
 711  */
 712 static void
 713 dht_connected (void *cls,
 714                struct GNUNET_TESTBED_Operation *op,
 715                void *ca_result,
 716                const char *emsg)
 717 {
 718   struct ActiveContext *ac = cls;
 719   struct Context *ctx = ac->ctx;
 720
 721   GNUNET_assert (NULL != ctx); //FIXME: Fails
 722   GNUNET_assert (NULL != ctx->op);
 723   GNUNET_assert (ctx->op == op);
 724   ac->dht = (struct GNUNET_DHT_Handle *) ca_result;
 725   if (NULL != emsg)
 726   {
 727     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Connection to DHT service failed: %s\n", emsg);
 728     GNUNET_TESTBED_operation_done (ctx->op); /* Calls dht_disconnect() */
 729     ctx->op = NULL;
 730     return;
 731   }
 732   switch (mode)
 733   {
 734   case MODE_PUT:
 735     ac->delay_task = GNUNET_SCHEDULER_add_delayed (delay_put, &delayed_put, ac);
 736     break;
 737   case MODE_GET:
 738     ac->delay_task = GNUNET_SCHEDULER_add_delayed (delay_get, &delayed_get, ac);
 739     break;
 740   }
 741 }
 742
 743
 744 /**
 745  * Connect to DHT service and return the DHT client handler
 746  *
 747  * @param cls the active context
 748  * @param cfg configuration of the peer to connect to; will be available until
 749  *          GNUNET_TESTBED_operation_done() is called on the operation returned
 750  *          from GNUNET_TESTBED_service_connect()
 751  * @return service handle to return in 'op_result', NULL on error
 752  */
 753 static void *
 754 dht_connect (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
 755 {
 756   n_dht++;
 757   return GNUNET_DHT_connect (cfg, 10);
 758 }
 759
 760
 761 /**
 762  * Connect to DHT services of active peers
 763  */
 764 static void
 765 start_profiling();
 766
 767
 768 /**
 769  * Adapter function called to destroy a connection to
 770  * a service.
 771  *
 772  * @param cls the active context
 773  * @param op_result service handle returned from the connect adapter
 774  */
 775 static void
 776 dht_disconnect (void *cls, void *op_result)
 777 {
 778   struct ActiveContext *ac = cls;
 779
 780   GNUNET_assert (NULL != ac->dht);
 781   GNUNET_assert (ac->dht == op_result);
 782   GNUNET_DHT_disconnect (ac->dht);
 783   ac->dht = NULL;
 784   n_dht--;
 785   if (0 != n_dht)
 786     return;
 787   switch (mode)
 788   {
 789   case MODE_PUT:
 790     if ((n_puts_ok + n_puts_fail) != n_active)
 791       return;
 792     /* Start GETs if all PUTs have been made */
 793     mode = MODE_GET;
 794     //(void) GNUNET_SCHEDULER_add_now (&call_start_profiling, NULL);
 795     start_profiling ();
 796     return;
 797   case MODE_GET:
 798     if ((n_gets_ok + n_gets_fail) != n_active)
 799       return;
 800     break;
 801   }
 802   GNUNET_SCHEDULER_shutdown ();
 803 }
 804
 805
 806 /**
 807  * Connect to DHT services of active peers
 808  */
 809 static void
 810 start_profiling()
 811 {
 812   struct Context *ctx;
 813   unsigned int i;
 814
 815   DEBUG("GNUNET_TESTBED_service_connect \n");
 816   for(i = 0; i < n_active; i++)
 817   {
 818     struct ActiveContext *ac = &a_ac[i];
 819     GNUNET_assert (NULL != (ctx = ac->ctx));
 820     GNUNET_assert (NULL == ctx->op);
 821     ctx->op =
 822         GNUNET_TESTBED_service_connect (ctx,
 823                                         ctx->peer,
 824                                         "dht",
 825                                         &dht_connected, ac,
 826                                         &dht_connect,
 827                                         &dht_disconnect,
 828                                         ac);
 829   }
 830 }
 831
 832 static int
 833 hashmap_iterate_remove(void *cls,
 834                        const struct GNUNET_HashCode *key,
 835                        void *value)
 836 {
 837   GNUNET_assert(GNUNET_YES == GNUNET_CONTAINER_multihashmap_remove(successor_peer_hashmap, key, value));
 838   return GNUNET_YES;
 839 }
 840
 841
 842 static unsigned int tries;
 843
 844 /**
 845  * Stats callback. Iterate over the hashmap and check if all th peers form
 846  * a virtual ring topology.
 847  *
 848  * @param cls closure
 849  * @param op the operation that has been finished
 850  * @param emsg error message in case the operation has failed; will be NULL if
 851  *          operation has executed successfully.
 852  */
 853 static void
 854 successor_stats_cont (void *cls,
 855                       struct GNUNET_TESTBED_Operation *op,
 856                       const char *emsg)
 857 {
 858   struct GNUNET_HashCode *val;
 859   struct GNUNET_HashCode *start_val;
 860   struct GNUNET_HashCode *key;
 861   int count;
 862
 863   /* Don't schedule the task till we are looking for circle here. */
 864   successor_stats_task = GNUNET_SCHEDULER_NO_TASK;
 865   GNUNET_TESTBED_operation_done (successor_stats_op);
 866   successor_stats_op = NULL;
 867
 868   start_val =
 869           (struct GNUNET_HashCode *) GNUNET_CONTAINER_multihashmap_get(successor_peer_hashmap,
 870                                                 start_key);
 871
 872   val = start_val;
 873   for (count = 0; count < num_peers; count++)
 874   {
 875     key = val;
 876     val = GNUNET_CONTAINER_multihashmap_get (successor_peer_hashmap,
 877                                              key);
 878     if(NULL == val)
 879     {
 880       break;
 881     }
 882     /* Remove the entry from hashmap. This is done to take care of loop. */
 883     if (GNUNET_NO ==
 884             GNUNET_CONTAINER_multihashmap_remove (successor_peer_hashmap,
 885                                                   key, val))
 886     {
 887       DEBUG ("Failed to remove entry from hashmap\n");
 888       break;
 889     }
 890     /* If a peer has its own identity as its successor. */
 891     if (0 == memcmp(key, val, sizeof (struct GNUNET_HashCode)))
 892     {
 893       break;
 894     }
 895   }
 896
 897   GNUNET_assert(GNUNET_SYSERR !=
 898           GNUNET_CONTAINER_multihashmap_iterate (successor_peer_hashmap,
 899                                                  hashmap_iterate_remove,
 900                                                  NULL));
 901
 902   successor_peer_hashmap = GNUNET_CONTAINER_multihashmap_create (num_peers,
 903                                                                     GNUNET_NO);
 904
 905   if ((start_val == val) && (count == num_peers))
 906   {
 907     DEBUG("CIRCLE COMPLETED after %u tries", tries);
 908     //FIXME: FREE HASHMAP.
 909     //FIXME: If circle is done, then check that finger table of all the peers
 910     //are fill atleast O(log N) and then start with the experiments.
 911     if(GNUNET_SCHEDULER_NO_TASK == successor_stats_task)
 912       start_profiling();
 913
 914     return;
 915   }
 916   else
 917   {
 918     if (max_searches == ++tries)
 919     {
 920       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 921                   "Maximum tries %u exceeded while checking successor TOTAL TRIES %u"
 922                   " cirle formation.  Exiting\n",
 923                   max_searches,tries);
 924       if (GNUNET_SCHEDULER_NO_TASK != successor_stats_task)
 925       {
 926         successor_stats_task = GNUNET_SCHEDULER_NO_TASK;
 927       }
 928       if(GNUNET_SCHEDULER_NO_TASK == successor_stats_task)
 929       {
 930         start_profiling();
 931       }
 932
 933       return;
 934     }
 935     else
 936     {
 937       flag = 0;
 938       successor_stats_task = GNUNET_SCHEDULER_add_delayed (delay_stats, &collect_stats, cls);
 939     }
 940   }
 941 }
 942
 943
 944 /**
 945  * Process successor statistic values.
 946  *
 947  * @param cls closure
 948  * @param peer the peer the statistic belong to
 949  * @param subsystem name of subsystem that created the statistic
 950  * @param name the name of the datum
 951  * @param value the current value
 952  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
 953  * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
 954  */
 955 static int
 956 successor_stats_iterator (void *cls,
 957                           const struct GNUNET_TESTBED_Peer *peer,
 958                           const char *subsystem,
 959                           const char *name,
 960                           uint64_t value,
 961                           int is_persistent)
 962 {
 963   static const char *key_string = "XDHT";
 964   if (0 == strncmp (key_string, name, strlen (key_string)))
 965   {
 966     char *my_id_str;
 967     char successor_str[13];
 968     char truncated_my_id_str[13];
 969     char truncated_successor_str[13];
 970     struct GNUNET_HashCode *my_id_key;
 971     struct GNUNET_HashCode *succ_key;
 972
 973     strtok((char *)name,":");
 974     my_id_str = strtok(NULL,":");
 975
 976     strncpy(truncated_my_id_str, my_id_str, 12);
 977     truncated_my_id_str[12] = '\0';
 978     my_id_key = GNUNET_new(struct GNUNET_HashCode);
 979     GNUNET_CRYPTO_hash (truncated_my_id_str, sizeof(truncated_my_id_str),my_id_key);
 980     GNUNET_STRINGS_data_to_string(&value, sizeof(uint64_t), successor_str, 13);
 981     strncpy(truncated_successor_str, successor_str, 12);
 982     truncated_successor_str[12] ='\0';
 983
 984     succ_key = GNUNET_new(struct GNUNET_HashCode);
 985     GNUNET_CRYPTO_hash (truncated_successor_str, sizeof(truncated_successor_str),succ_key);
 986
 987     if (0 == flag)
 988     {
 989       start_key = my_id_key;
 990       flag = 1;
 991     }
 992     /* FIXME: GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE do not free the value
 993      which is replaced, need to free it. */
 994     GNUNET_CONTAINER_multihashmap_put (successor_peer_hashmap,
 995                                        my_id_key, (void *)succ_key,
 996                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
 997   }
 998   return GNUNET_OK;
 999 }
1000
1001
1002 /*
1003  * Task that collects peer and its corresponding successors.
1004  *
1005  * @param cls Closure (NULL).
1006  * @param tc Task Context.
1007  */
1008 static void
1009 collect_stats (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1010 {
1011   if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
1012     return;
1013
1014   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Start collecting statistics...\n");
1015   GNUNET_assert(NULL != testbed_handles);
1016   successor_peer_hashmap = GNUNET_CONTAINER_multihashmap_create (num_peers,
1017                                                                     GNUNET_NO);
1018   successor_stats_op =
1019           GNUNET_TESTBED_get_statistics (num_peers, testbed_handles,
1020                                          "dht", NULL,
1021                                           successor_stats_iterator,
1022                                           successor_stats_cont, cls);
1023
1024   GNUNET_assert(NULL != successor_stats_op);
1025 }
1026
1027
1028 #if ENABLE_MALICIOUS
1029 /**
1030  * Set the malicious variable in peer malicious context.
1031  */
1032 static void
1033 set_malicious()
1034 {
1035   unsigned int i;
1036   DEBUG ("Setting %u peers malicious");
1037   for(i = 0; i < n_malicious; i++)
1038   {
1039     struct MaliciousContext *mc = &a_mc[i];
1040     mc->ctx->op =
1041         GNUNET_TESTBED_service_connect (ac->ctx,
1042                                         ac->ctx->peer,
1043                                         "dht",
1044                                         &dht_set_malicious, mc,
1045                                         &dht_connect,
1046                                         &dht_finish,
1047                                         mc);
1048   }
1049 }
1050 #endif
1051 /**
1052  * Callback called when DHT service on the peer is started
1053  *
1054  * @param cls the context
1055  * @param op the operation that has been finished
1056  * @param emsg error message in case the operation has failed; will be NULL if
1057  *          operation has executed successfully.
1058  */
1059 static void
1060 service_started (void *cls,
1061                  struct GNUNET_TESTBED_Operation *op,
1062                  const char *emsg)
1063 {
1064   struct Context *ctx = cls;
1065
1066   GNUNET_assert (NULL != ctx);
1067   GNUNET_assert (NULL != ctx->op);
1068   GNUNET_TESTBED_operation_done (ctx->op);
1069   ctx->op = NULL;
1070   peers_started++;
1071   DEBUG("Peers Started = %d; num_peers = %d \n", peers_started, num_peers);
1072   if (GNUNET_SCHEDULER_NO_TASK == successor_stats_task && peers_started == num_peers)
1073   {
1074 #if ENABLE_MALICIOUS
1075     set_malicious();
1076 #endif
1077      DEBUG("successor_stats_task \n");
1078      struct Collect_Stat_Context *collect_stat_cls = GNUNET_new(struct Collect_Stat_Context);
1079      collect_stat_cls->service_connect_ctx = cls;
1080      collect_stat_cls->op = op;
1081      successor_stats_task = GNUNET_SCHEDULER_add_delayed (delay_stats,
1082                                                           &collect_stats,
1083                                                           collect_stat_cls);
1084   }
1085 }
1086
1087
1088 /**
1089  * Signature of a main function for a testcase.
1090  *
1091  * @param cls closure
1092  * @param h the run handle
1093  * @param num_peers number of peers in 'peers'
1094  * @param peers handle to peers run in the testbed
1095  * @param links_succeeded the number of overlay link connection attempts that
1096  *          succeeded
1097  * @param links_failed the number of overlay link
1098  */
1099 static void
1100 test_run (void *cls,
1101           struct GNUNET_TESTBED_RunHandle *h,
1102           unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers,
1103           unsigned int links_succeeded,
1104           unsigned int links_failed)
1105 {
1106   unsigned int cnt;
1107   unsigned int ac_cnt;
1108
1109   testbed_handles = peers;
1110   if (NULL == peers)
1111   {
1112     /* exit */
1113     GNUNET_assert (0);
1114   }
1115   INFO ("%u peers started\n", num_peers);
1116   a_ctx = GNUNET_malloc (sizeof (struct Context) * num_peers);
1117
1118   /* select the peers which actively participate in profiling */
1119   n_active = num_peers * PUT_PROBABILITY / 100;
1120   if (0 == n_active)
1121   {
1122     GNUNET_SCHEDULER_shutdown ();
1123     GNUNET_free (a_ctx);
1124     return;
1125   }
1126
1127 #if ENABLE_MALICIOUS
1128
1129   if(PUT_PROBABILITY + MALICIOUS_PEERS > 100)
1130   {
1131     DEBUG ("Reduce either number of malicious peer or active peers. ");
1132     GNUNET_SCHEDULER_shutdown ();
1133     GNUNET_free (a_ctx);
1134     return;
1135   }
1136
1137   /* Select the peers which should act maliciously. */
1138   n_malicious = num_peers * MALICIOUS_PEERS / 100;
1139
1140   /* Select n_malicious peers and ensure that those are not active peers.
1141      keep all malicious peer at one place, and call act malicious for all
1142      those peers. */
1143
1144 #endif
1145
1146   a_ac = GNUNET_malloc (n_active * sizeof (struct ActiveContext));
1147   ac_cnt = 0;
1148   for (cnt = 0; cnt < num_peers && ac_cnt < n_active; cnt++)
1149   {
1150     if (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 100) >=
1151         PUT_PROBABILITY)
1152       continue;
1153     a_ctx[cnt].ac = &a_ac[ac_cnt];
1154     a_ac[ac_cnt].ctx = &a_ctx[cnt];
1155     ac_cnt++;
1156   }
1157   n_active = ac_cnt;
1158   INFO ("Active peers: %u\n", n_active);
1159
1160   /* start DHT service on all peers */
1161   for (cnt = 0; cnt < num_peers; cnt++)
1162   {
1163     a_ctx[cnt].peer = peers[cnt];
1164     a_ctx[cnt].op = GNUNET_TESTBED_peer_manage_service (&a_ctx[cnt],
1165                                                         peers[cnt],
1166                                                         "dht",
1167                                                         &service_started,
1168                                                         &a_ctx[cnt],
1169                                                         1);
1170   }
1171 }
1172
1173
1174 /**
1175  * Main function that will be run by the scheduler.
1176  *
1177  * @param cls closure
1178  * @param args remaining command-line arguments
1179  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
1180  * @param config configuration
1181  */
1182 static void
1183 run (void *cls, char *const *args, const char *cfgfile,
1184      const struct GNUNET_CONFIGURATION_Handle *config)
1185 {
1186   uint64_t event_mask;
1187
1188   if (0 == num_peers)
1189   {
1190     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Exiting as the number of peers is %u\n"),
1191                 num_peers);
1192     return;
1193   }
1194   cfg = GNUNET_CONFIGURATION_dup (config);
1195   event_mask = 0;
1196   GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask, NULL,
1197                       NULL, &test_run, NULL);
1198   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_shutdown,
1199                                 NULL);
1200 }
1201
1202
1203 /**
1204  * Main function.
1205  *
1206  * @return 0 on success
1207  */
1208 int
1209 main (int argc, char *const *argv)
1210 {
1211   int rc;
1212
1213   static struct GNUNET_GETOPT_CommandLineOption options[] = {
1214     {'n', "peers", "COUNT",
1215      gettext_noop ("number of peers to start"),
1216      1, &GNUNET_GETOPT_set_uint, &num_peers},
1217     {'s', "searches", "COUNT",
1218      gettext_noop ("maximum number of times we try to search for successor circle formation (default is 1)"),
1219      1, &GNUNET_GETOPT_set_uint, &max_searches},
1220     {'H', "hosts", "FILENAME",
1221      gettext_noop ("name of the file with the login information for the testbed"),
1222      1, &GNUNET_GETOPT_set_string, &hosts_file},
1223     {'D', "delay", "DELAY",
1224      gettext_noop ("delay between rounds for collecting statistics (default: 30 sec)"),
1225      1, &GNUNET_GETOPT_set_relative_time, &delay_stats},
1226     {'P', "PUT-delay", "DELAY",
1227      gettext_noop ("delay to start doing PUTs (default: 1 sec)"),
1228      1, &GNUNET_GETOPT_set_relative_time, &delay_put},
1229     {'G', "GET-delay", "DELAY",
1230      gettext_noop ("delay to start doing GETs (default: 5 min)"),
1231      1, &GNUNET_GETOPT_set_relative_time, &delay_get},
1232     {'r', "replication", "DEGREE",
1233      gettext_noop ("replication degree for DHT PUTs"),
1234      1, &GNUNET_GETOPT_set_uint, &replication},
1235     {'t', "timeout", "TIMEOUT",
1236      gettext_noop ("timeout for DHT PUT and GET requests (default: 1 min)"),
1237      1, &GNUNET_GETOPT_set_relative_time, &timeout},
1238     GNUNET_GETOPT_OPTION_END
1239   };
1240
1241   max_searches = 5;
1242   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
1243     return 2;
1244   /* set default delays */
1245   delay_stats = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30);
1246   delay_put = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1);
1247   delay_get = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5);
1248   timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1);
1249   replication = 1;      /* default replication */
1250   rc = 0;
1251   if (GNUNET_OK !=
1252       GNUNET_PROGRAM_run (argc, argv, "dht-profiler",
1253                           gettext_noop
1254                           ("Measure quality and performance of the DHT service."),
1255                           options, &run, NULL))
1256     rc = 1;
1257   return rc;
1258 }