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