Exponential backoff
[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 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  * Should we do a PUT (mode = 0) or GET (mode = 1);
354  */
355 static enum
356 {
357   MODE_PUT = 0,
358
359   MODE_GET = 1
360 } mode;
361
362
363 /**
364  * Are we shutting down
365  */
366 static int in_shutdown = 0;
367
368 /**
369  * Task that collects successor statistics from all the peers. 
370  * @param cls
371  * @param tc
372  */
373 static void
374 collect_stats (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
375
376 /**
377  * Shutdown task.  Cleanup all resources and operations.
378  *
379  * @param cls NULL
380  * @param tc scheduler task context
381  */
382 static void
383 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
384 {
385   struct ActiveContext *ac;
386   unsigned int cnt;
387
388   in_shutdown = GNUNET_YES;
389   if (NULL != a_ctx)
390   {
391     for (cnt=0; cnt < num_peers; cnt++)
392     {
393       /* Cleanup active context if this peer is an active peer */
394       ac = a_ctx[cnt].ac;
395       if (NULL != ac)
396       {
397         if (GNUNET_SCHEDULER_NO_TASK != ac->delay_task)
398           GNUNET_SCHEDULER_cancel (ac->delay_task);
399         if (NULL != ac->put_data)
400           GNUNET_free (ac->put_data);
401         if (NULL != ac->dht_put)
402           GNUNET_DHT_put_cancel (ac->dht_put);
403         if (NULL != ac->dht_get)
404           GNUNET_DHT_get_stop (ac->dht_get);
405       }
406       /* Cleanup testbed operation handle at the last as this operation may
407          contain service connection to DHT */
408       if (NULL != a_ctx[cnt].op)
409         GNUNET_TESTBED_operation_done (a_ctx[cnt].op);
410     }
411     GNUNET_free (a_ctx);
412     a_ctx = NULL;
413   }
414   //FIXME: Should we collect stats only for put/get not for other messages.
415   if(NULL != bandwidth_stats_op)
416     GNUNET_TESTBED_operation_done (bandwidth_stats_op);
417   bandwidth_stats_op = NULL;
418   GNUNET_free_non_null (a_ac);
419 }
420
421
422 /**
423  * Stats callback. Finish the stats testbed operation and when all stats have
424  * been iterated, shutdown the test.
425  *
426  * @param cls closure
427  * @param op the operation that has been finished
428  * @param emsg error message in case the operation has failed; will be NULL if
429  *          operation has executed successfully.
430  */
431 static void
432 bandwidth_stats_cont (void *cls, 
433                       struct GNUNET_TESTBED_Operation *op, 
434                       const char *emsg)
435 {
436   INFO ("# Outgoing bandwidth: %u\n", outgoing_bandwidth);
437   INFO ("# Incoming bandwidth: %u\n", incoming_bandwidth);
438   GNUNET_SCHEDULER_shutdown ();
439 }
440
441
442 /**
443  * Process statistic values.
444  *
445  * @param cls closure
446  * @param peer the peer the statistic belong to
447  * @param subsystem name of subsystem that created the statistic
448  * @param name the name of the datum
449  * @param value the current value
450  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
451  * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
452  */
453 static int
454 bandwidth_stats_iterator (void *cls, 
455                           const struct GNUNET_TESTBED_Peer *peer,
456                           const char *subsystem, 
457                           const char *name,
458                           uint64_t value, 
459                           int is_persistent)
460 {
461    static const char *s_sent = "# Bytes transmitted to other peers";
462    static const char *s_recv = "# Bytes received from other peers";
463
464    if (0 == strncmp (s_sent, name, strlen (s_sent)))
465      outgoing_bandwidth = outgoing_bandwidth + value;
466    else if (0 == strncmp(s_recv, name, strlen (s_recv)))
467      incoming_bandwidth = incoming_bandwidth + value;
468    
469     return GNUNET_OK;
470 }
471
472
473 static void
474 summarize ()
475 {
476   INFO ("# PUTS made: %u\n", n_puts);
477   INFO ("# PUTS succeeded: %u\n", n_puts_ok);
478   INFO ("# PUTS failed: %u\n", n_puts_fail);
479   INFO ("# GETS made: %u\n", n_gets);
480   INFO ("# GETS succeeded: %u\n", n_gets_ok);
481   INFO ("# GETS failed: %u\n", n_gets_fail);
482   INFO ("# average_put_path_length: %f\n", average_put_path_length);
483   INFO ("# average_get_path_length: %f\n", average_get_path_length);
484   
485   if (NULL == testbed_handles)
486   {
487     INFO ("No peers found\n");
488     return;
489   }
490   /* Collect Stats*/
491   bandwidth_stats_op = GNUNET_TESTBED_get_statistics (n_active, testbed_handles,
492                                                       "dht", NULL,
493                                                        bandwidth_stats_iterator, 
494                                                        bandwidth_stats_cont, NULL);
495 }
496
497
498 /**
499  * Task to cancel DHT GET.
500  *
501  * @param cls NULL
502  * @param tc scheduler task context
503  */
504 static void
505 cancel_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
506 {
507   struct ActiveContext *ac = cls;
508   struct Context *ctx = ac->ctx;
509
510   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
511   GNUNET_assert (NULL != ac->dht_get);
512   GNUNET_DHT_get_stop (ac->dht_get);
513   ac->dht_get = NULL;
514   n_gets_fail++;
515   GNUNET_assert (NULL != ctx->op);
516   GNUNET_TESTBED_operation_done (ctx->op);
517   ctx->op = NULL;
518
519   /* If profiling is complete, summarize */
520   if (n_active == n_gets_fail + n_gets_ok)
521   {
522     average_put_path_length = (double)total_put_path_length/(double)n_active;
523     average_get_path_length = (double)total_get_path_length/(double )n_gets_ok;
524     summarize ();
525   }
526 }
527
528
529 /**
530  * Iterator called on each result obtained for a DHT
531  * operation that expects a reply
532  *
533  * @param cls closure
534  * @param exp when will this value expire
535  * @param key key of the result
536  * @param get_path peers on reply path (or NULL if not recorded)
537  *                 [0] = datastore's first neighbor, [length - 1] = local peer
538  * @param get_path_length number of entries in @a get_path
539  * @param put_path peers on the PUT path (or NULL if not recorded)
540  *                 [0] = origin, [length - 1] = datastore
541  * @param put_path_length number of entries in @a put_path
542  * @param type type of the result
543  * @param size number of bytes in @a data
544  * @param data pointer to the result data
545  */
546 static void
547 get_iter (void *cls,
548           struct GNUNET_TIME_Absolute exp,
549           const struct GNUNET_HashCode *key,
550           const struct GNUNET_PeerIdentity *get_path,
551           unsigned int get_path_length,
552           const struct GNUNET_PeerIdentity *put_path,
553           unsigned int put_path_length,
554           enum GNUNET_BLOCK_Type type,
555           size_t size, const void *data)
556 {
557   struct ActiveContext *ac = cls;
558   struct ActiveContext *get_ac = ac->get_ac;
559   struct Context *ctx = ac->ctx;
560
561   /* Check the keys of put and get match or not. */
562   GNUNET_assert (0 == memcmp (key, &get_ac->hash, sizeof (struct GNUNET_HashCode)));
563   /* we found the data we are looking for */
564   DEBUG ("We found a GET request; %u remaining\n", n_gets - (n_gets_fail + n_gets_ok)); //FIXME: It always prints 1.
565   n_gets_ok++;
566   get_ac->nrefs--;
567   GNUNET_DHT_get_stop (ac->dht_get);
568   ac->dht_get = NULL;
569   if (ac->delay_task != GNUNET_SCHEDULER_NO_TASK)
570     GNUNET_SCHEDULER_cancel (ac->delay_task);
571   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
572   GNUNET_assert (NULL != ctx->op);
573   GNUNET_TESTBED_operation_done (ctx->op);
574   ctx->op = NULL;
575   
576   total_put_path_length = total_put_path_length + (double)put_path_length;
577   total_get_path_length = total_get_path_length + (double)get_path_length;
578   DEBUG ("total_put_path_length = %f,put_path \n",total_put_path_length);
579   /* Summarize if profiling is complete */
580   if (n_active == n_gets_fail + n_gets_ok)
581   {
582     average_put_path_length = (double)total_put_path_length/(double)n_active;
583     average_get_path_length = (double)total_get_path_length/(double )n_gets_ok;
584     summarize ();
585   }
586 }
587
588
589 /**
590  * Task to do DHT GETs
591  *
592  * @param cls the active context
593  * @param tc the scheduler task context
594  */
595 static void
596 delayed_get (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
597 {
598   struct ActiveContext *ac = cls;
599   struct ActiveContext *get_ac;
600   unsigned int r;
601
602   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
603   get_ac = NULL;
604   while (1)
605   {
606     r = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, n_active);
607     get_ac = &a_ac[r];
608     if (NULL != get_ac->put_data)
609       break;
610   }
611   get_ac->nrefs++;
612   ac->get_ac = get_ac;
613   DEBUG ("GET_REQUEST_START key %s \n", GNUNET_h2s((struct GNUNET_HashCode *)ac->put_data));
614   ac->dht_get = GNUNET_DHT_get_start (ac->dht,
615                                       GNUNET_BLOCK_TYPE_TEST,
616                                       &get_ac->hash,
617                                       1, /* replication level */
618                                       GNUNET_DHT_RO_NONE,
619                                       NULL, 0, /* extended query and size */
620                                       get_iter, ac); /* GET iterator and closure
621                                                         */
622   n_gets++;
623
624   /* schedule the timeout task for GET */
625   ac->delay_task = GNUNET_SCHEDULER_add_delayed (timeout, &cancel_get, ac);
626 }
627
628
629 /**
630  * Task to teardown the dht connection.  We do it as a task because calling
631  * GNUNET_DHT_disconnect() from put_continutation_callback seems illegal (the
632  * put_continuation_callback() is getting called again synchronously).  Also,
633  * only free the operation when we are not shutting down; the shutdown task will
634  * clear the operation during shutdown.
635  *
636  * @param cls the context
637  * @return tc scheduler task context.
638  */
639 static void
640 teardown_dht_connection (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
641 {
642   struct Context *ctx = cls;
643   struct GNUNET_TESTBED_Operation *op;
644
645   if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
646     return;
647   GNUNET_assert (NULL != ctx);
648   GNUNET_assert (NULL != (op = ctx->op));
649   ctx->op = NULL;
650   GNUNET_TESTBED_operation_done (op);
651 }
652
653
654 /**
655  * Queue up a delayed task for doing DHT GET
656  *
657  * @param cls the active context
658  * @param success #GNUNET_OK if the PUT was transmitted,
659  *                #GNUNET_NO on timeout,
660  *                #GNUNET_SYSERR on disconnect from service
661  *                after the PUT message was transmitted
662  *                (so we don't know if it was received or not)
663  */
664 static void
665 put_cont (void *cls, int success)
666 {
667   struct ActiveContext *ac = cls;
668   struct Context *ctx = ac->ctx;
669
670   ac->dht_put = NULL;
671   if (success)
672     n_puts_ok++;
673   else
674     n_puts_fail++;
675   GNUNET_assert (NULL != ctx);
676   (void) GNUNET_SCHEDULER_add_now (&teardown_dht_connection, ctx);
677 }
678
679
680 /**
681  * Task to do DHT PUTS
682  *
683  * @param cls the active context
684  * @param tc the scheduler task context
685  */
686 static void
687 delayed_put (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
688 {
689   struct ActiveContext *ac = cls;
690
691   ac->delay_task = GNUNET_SCHEDULER_NO_TASK;
692   /* Generate and DHT PUT some random data */
693   ac->put_data_size = 16;       /* minimum */
694   ac->put_data_size += GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
695                                                  (63*1024));
696   ac->put_data = GNUNET_malloc (ac->put_data_size);
697   GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_WEAK,
698                               ac->put_data, ac->put_data_size);
699   GNUNET_CRYPTO_hash (ac->put_data, ac->put_data_size, &ac->hash);
700   DEBUG ("PUT_REQUEST_START key %s \n", GNUNET_h2s((struct GNUNET_HashCode *)ac->put_data));
701   ac->dht_put = GNUNET_DHT_put (ac->dht, &ac->hash,
702                                 replication,
703                                 GNUNET_DHT_RO_RECORD_ROUTE,
704                                 GNUNET_BLOCK_TYPE_TEST,
705                                 ac->put_data_size,
706                                 ac->put_data,
707                                 GNUNET_TIME_UNIT_FOREVER_ABS, /* expiration time */
708                                 timeout,                      /* PUT timeout */
709                                 put_cont, ac);                /* continuation and its closure */
710   n_puts++;
711 }
712
713
714 /**
715  * Connection to DHT has been established.  Call the delay task.
716  *
717  * @param cls the active context
718  * @param op the operation that has been finished
719  * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
720  * @param emsg error message in case the operation has failed; will be NULL if
721  *          operation has executed successfully.
722  */
723 static void
724 dht_connected (void *cls,
725                struct GNUNET_TESTBED_Operation *op,
726                void *ca_result,
727                const char *emsg)
728 {
729   struct ActiveContext *ac = cls;
730   struct Context *ctx = ac->ctx;
731
732   GNUNET_assert (NULL != ctx); //FIXME: Fails
733   GNUNET_assert (NULL != ctx->op);
734   GNUNET_assert (ctx->op == op);
735   ac->dht = (struct GNUNET_DHT_Handle *) ca_result;
736   if (NULL != emsg)
737   {
738     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Connection to DHT service failed: %s\n", emsg);
739     GNUNET_TESTBED_operation_done (ctx->op); /* Calls dht_disconnect() */
740     ctx->op = NULL;
741     return;
742   }
743   switch (mode)
744   {
745   case MODE_PUT:
746   {
747     struct GNUNET_TIME_Relative peer_delay_put;
748     peer_delay_put.rel_value_us =
749       GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
750                                 delay_put.rel_value_us);
751     ac->delay_task = GNUNET_SCHEDULER_add_delayed (peer_delay_put, &delayed_put, ac);
752     break;
753   }
754   case MODE_GET:
755   {
756     struct GNUNET_TIME_Relative peer_delay_get;
757     peer_delay_get.rel_value_us =
758       delay_get.rel_value_us +
759       GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
760                                 delay_get.rel_value_us);
761     ac->delay_task = GNUNET_SCHEDULER_add_delayed (peer_delay_get, &delayed_get, ac);
762     break;
763   }
764   }
765 }
766
767
768 /**
769  * Connect to DHT service and return the DHT client handler
770  *
771  * @param cls the active context
772  * @param cfg configuration of the peer to connect to; will be available until
773  *          GNUNET_TESTBED_operation_done() is called on the operation returned
774  *          from GNUNET_TESTBED_service_connect()
775  * @return service handle to return in 'op_result', NULL on error
776  */
777 static void *
778 dht_connect (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
779 {
780   n_dht++;
781   return GNUNET_DHT_connect (cfg, 10);
782 }
783
784
785 /**
786  * Connect to DHT services of active peers
787  */
788 static void
789 start_profiling();
790
791
792 /**
793  * Adapter function called to destroy a connection to
794  * a service.
795  *
796  * @param cls the active context
797  * @param op_result service handle returned from the connect adapter
798  */
799 static void
800 dht_disconnect (void *cls, void *op_result)
801 {
802   struct ActiveContext *ac = cls;
803
804   GNUNET_assert (NULL != ac->dht);
805   GNUNET_assert (ac->dht == op_result);
806   GNUNET_DHT_disconnect (ac->dht);
807   ac->dht = NULL;
808   n_dht--;
809   if (0 != n_dht)
810     return;
811   if (GNUNET_YES == in_shutdown)
812     return;
813   switch (mode)
814   {
815   case MODE_PUT:
816     if ((n_puts_ok + n_puts_fail) != n_active)
817       return;
818     /* Start GETs if all PUTs have been made */
819     mode = MODE_GET;
820     //(void) GNUNET_SCHEDULER_add_now (&call_start_profiling, NULL);
821     start_profiling ();
822     return;
823   case MODE_GET:
824     if ((n_gets_ok + n_gets_fail) != n_active)
825       return;
826     break;
827   }
828 }
829
830
831 /**
832  * Connect to DHT services of active peers
833  */
834 static void
835 start_profiling()
836 {
837   struct Context *ctx;
838   unsigned int i;
839
840   DEBUG("GNUNET_TESTBED_service_connect \n");
841   GNUNET_break (GNUNET_YES != in_shutdown);
842   for(i = 0; i < n_active; i++)
843   {
844     struct ActiveContext *ac = &a_ac[i];
845     GNUNET_assert (NULL != (ctx = ac->ctx));
846     GNUNET_assert (NULL == ctx->op);
847     ctx->op =
848         GNUNET_TESTBED_service_connect (ctx,
849                                         ctx->peer,
850                                         "dht",
851                                         &dht_connected, ac,
852                                         &dht_connect,
853                                         &dht_disconnect,
854                                         ac);
855   }
856 }
857
858 static int 
859 hashmap_iterate_remove(void *cls, 
860                        const struct GNUNET_HashCode *key, 
861                        void *value)
862 {
863   GNUNET_assert(GNUNET_YES == GNUNET_CONTAINER_multihashmap_remove(successor_peer_hashmap, key, value));
864   return GNUNET_YES;
865 }
866
867
868 static unsigned int tries;
869
870 /**
871  * Stats callback. Iterate over the hashmap and check if all th peers form
872  * a virtual ring topology.
873  *
874  * @param cls closure
875  * @param op the operation that has been finished
876  * @param emsg error message in case the operation has failed; will be NULL if
877  *          operation has executed successfully.
878  */
879 static void
880 successor_stats_cont (void *cls, 
881                       struct GNUNET_TESTBED_Operation *op, 
882                       const char *emsg)
883 {
884   struct GNUNET_HashCode *val;
885   struct GNUNET_HashCode *start_val;
886   struct GNUNET_HashCode *key;
887   int count;
888   
889   
890   /* Don't schedule the task till we are looking for circle here. */
891   successor_stats_task = GNUNET_SCHEDULER_NO_TASK;
892   GNUNET_TESTBED_operation_done (successor_stats_op);
893   successor_stats_op = NULL;
894   if (0 == max_searches)
895   {
896     start_profiling();
897     return;
898   }
899   start_val =
900           (struct GNUNET_HashCode *) GNUNET_CONTAINER_multihashmap_get(successor_peer_hashmap,
901                                                 start_key);
902
903   val = start_val;
904   for (count = 0; count < num_peers; count++)
905   {
906     key = val;
907     val = GNUNET_CONTAINER_multihashmap_get (successor_peer_hashmap,
908                                              key);
909     if(NULL == val)
910     {
911       break;
912     }
913     /* Remove the entry from hashmap. This is done to take care of loop. */
914     if (GNUNET_NO == 
915             GNUNET_CONTAINER_multihashmap_remove (successor_peer_hashmap,
916                                                   key, val))
917     {
918       DEBUG ("Failed to remove entry from hashmap\n");
919       break;
920     }
921     /* If a peer has its own identity as its successor. */
922     if (0 == memcmp(key, val, sizeof (struct GNUNET_HashCode)))
923     {
924       break;
925     } 
926   }
927   
928   GNUNET_assert(GNUNET_SYSERR != 
929           GNUNET_CONTAINER_multihashmap_iterate (successor_peer_hashmap,
930                                                  hashmap_iterate_remove,
931                                                  NULL));
932   
933   successor_peer_hashmap = GNUNET_CONTAINER_multihashmap_create (num_peers, 
934                                                                  GNUNET_NO);
935   //TODO:Check if comparison is correct. 
936   if ((start_val == val) && (count == num_peers))
937   {
938     DEBUG("CIRCLE COMPLETED after %u tries", tries);
939     //FIXME: FREE HASHMAP.
940     //FIXME: If circle is done, then check that finger table of all the peers
941     //are fill atleast O(log N) and then start with the experiments.
942     if(GNUNET_SCHEDULER_NO_TASK == successor_stats_task)
943       start_profiling();
944     
945     return;
946   }
947   else
948   {
949     if (max_searches == ++tries)
950     {
951       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
952                   "Maximum tries %u exceeded while checking successor TOTAL TRIES %u"
953                   " cirle formation.  Exiting\n",
954                   max_searches,tries);
955       if (GNUNET_SCHEDULER_NO_TASK != successor_stats_task)
956       {
957         successor_stats_task = GNUNET_SCHEDULER_NO_TASK;
958       }
959       if(GNUNET_SCHEDULER_NO_TASK == successor_stats_task)
960       {
961         start_profiling();
962       }
963       
964       return;
965     }
966     else
967     {
968       flag = 0;
969       successor_stats_task = GNUNET_SCHEDULER_add_delayed (delay_stats, &collect_stats, cls);
970     }
971   } 
972 }
973
974
975 /**
976  * Process successor statistic values.
977  *
978  * @param cls closure
979  * @param peer the peer the statistic belong to
980  * @param subsystem name of subsystem that created the statistic
981  * @param name the name of the datum
982  * @param value the current value
983  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
984  * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
985  */
986 static int
987 successor_stats_iterator (void *cls, 
988                           const struct GNUNET_TESTBED_Peer *peer,
989                           const char *subsystem, 
990                           const char *name,
991                           uint64_t value, 
992                           int is_persistent)
993 {
994   static const char *key_string = "XDHT";
995   if (0 == max_searches)
996     return GNUNET_OK;
997   
998   if (0 == strncmp (key_string, name, strlen (key_string)))
999   {
1000     char *my_id_str;
1001     char successor_str[13];
1002     char truncated_my_id_str[13];
1003     char truncated_successor_str[13];
1004     struct GNUNET_HashCode *my_id_key;
1005     struct GNUNET_HashCode *succ_key;
1006     
1007     strtok((char *)name,":");
1008     my_id_str = strtok(NULL,":");
1009     
1010     strncpy(truncated_my_id_str, my_id_str, 12);
1011     truncated_my_id_str[12] = '\0';
1012     my_id_key = GNUNET_new(struct GNUNET_HashCode);
1013     GNUNET_CRYPTO_hash (truncated_my_id_str, sizeof(truncated_my_id_str),my_id_key);
1014     GNUNET_STRINGS_data_to_string(&value, sizeof(uint64_t), successor_str, 13);
1015     strncpy(truncated_successor_str, successor_str, 12);
1016     truncated_successor_str[12] ='\0';
1017    
1018     succ_key = GNUNET_new(struct GNUNET_HashCode);
1019     GNUNET_CRYPTO_hash (truncated_successor_str, sizeof(truncated_successor_str),succ_key);
1020     
1021     if (0 == flag)
1022     {
1023       start_key = my_id_key;
1024       flag = 1;
1025     }
1026     /* FIXME: GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE do not free the value
1027      which is replaced, need to free it. */
1028     GNUNET_CONTAINER_multihashmap_put (successor_peer_hashmap,
1029                                        my_id_key, (void *)succ_key,
1030                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
1031   }
1032   return GNUNET_OK;
1033 }
1034
1035
1036 /* 
1037  * Task that collects peer and its corresponding successors. 
1038  * 
1039  * @param cls Closure (NULL).
1040  * @param tc Task Context.
1041  */
1042 static void
1043 collect_stats (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1044 {
1045   if ((GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason) != 0)
1046     return;
1047
1048   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Start collecting statistics...\n");
1049   GNUNET_assert(NULL != testbed_handles);
1050   
1051   if (0 != max_searches)
1052   successor_peer_hashmap = GNUNET_CONTAINER_multihashmap_create (num_peers, 
1053                                                                     GNUNET_NO);
1054   successor_stats_op = 
1055           GNUNET_TESTBED_get_statistics (num_peers, testbed_handles,
1056                                          "dht", NULL,
1057                                           successor_stats_iterator, 
1058                                           successor_stats_cont, cls);
1059   
1060   GNUNET_assert(NULL != successor_stats_op);
1061 }
1062
1063
1064 #if ENABLE_MALICIOUS
1065 /**
1066  * Set the malicious variable in peer malicious context.
1067  */
1068 static void
1069 set_malicious()
1070 {
1071   unsigned int i;
1072   DEBUG ("Setting %u peers malicious");
1073   for(i = 0; i < n_malicious; i++)
1074   {
1075     struct MaliciousContext *mc = &a_mc[i];
1076     mc->ctx->op =
1077         GNUNET_TESTBED_service_connect (ac->ctx,
1078                                         ac->ctx->peer,
1079                                         "dht",
1080                                         &dht_set_malicious, mc,
1081                                         &dht_connect,
1082                                         &dht_finish,
1083                                         mc);
1084   }
1085 }
1086 #endif
1087
1088
1089 /**
1090  * Callback called when DHT service on the peer is started
1091  *
1092  * @param cls the context
1093  * @param op the operation that has been finished
1094  * @param emsg error message in case the operation has failed; will be NULL if
1095  *          operation has executed successfully.
1096  */
1097 static void
1098 service_started (void *cls,
1099                  struct GNUNET_TESTBED_Operation *op,
1100                  const char *emsg)
1101 {
1102   struct Context *ctx = cls;
1103
1104   GNUNET_assert (NULL != ctx);
1105   GNUNET_assert (NULL != ctx->op);
1106   GNUNET_TESTBED_operation_done (ctx->op);
1107   ctx->op = NULL;
1108   peers_started++;
1109   DEBUG("Peers Started = %d; num_peers = %d \n", peers_started, num_peers);
1110   if (GNUNET_SCHEDULER_NO_TASK == successor_stats_task && peers_started == num_peers)
1111   {
1112 #if ENABLE_MALICIOUS
1113     set_malicious();
1114 #endif
1115     
1116      DEBUG("successor_stats_task \n");
1117      struct Collect_Stat_Context *collect_stat_cls = GNUNET_new(struct Collect_Stat_Context);
1118      collect_stat_cls->service_connect_ctx = cls;
1119      collect_stat_cls->op = op;
1120      successor_stats_task = GNUNET_SCHEDULER_add_delayed (delay_stats,
1121                                                           &collect_stats,
1122                                                           collect_stat_cls);
1123   }
1124 }
1125
1126
1127 /**
1128  * Signature of a main function for a testcase.
1129  *
1130  * @param cls closure
1131  * @param h the run handle
1132  * @param num_peers number of peers in 'peers'
1133  * @param peers handle to peers run in the testbed
1134  * @param links_succeeded the number of overlay link connection attempts that
1135  *          succeeded
1136  * @param links_failed the number of overlay link
1137  */
1138 static void
1139 test_run (void *cls,
1140           struct GNUNET_TESTBED_RunHandle *h,
1141           unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers,
1142           unsigned int links_succeeded,
1143           unsigned int links_failed)
1144 {
1145   unsigned int cnt;
1146   unsigned int ac_cnt;
1147   
1148   testbed_handles = peers;  
1149   if (NULL == peers)
1150   {
1151     /* exit */
1152     GNUNET_assert (0);
1153   }
1154   INFO ("%u peers started\n", num_peers);
1155   a_ctx = GNUNET_malloc (sizeof (struct Context) * num_peers);
1156
1157   /* select the peers which actively participate in profiling */
1158   n_active = num_peers * PUT_PROBABILITY / 100;
1159   if (0 == n_active)
1160   {
1161     GNUNET_SCHEDULER_shutdown ();
1162     GNUNET_free (a_ctx);
1163     return;
1164   }
1165   
1166 #if ENABLE_MALICIOUS
1167
1168   if(PUT_PROBABILITY + MALICIOUS_PEERS > 100)
1169   {
1170     DEBUG ("Reduce either number of malicious peer or active peers. ");
1171     GNUNET_SCHEDULER_shutdown ();
1172     GNUNET_free (a_ctx);
1173     return;
1174   }
1175   
1176   /* Select the peers which should act maliciously. */
1177   n_malicious = num_peers * MALICIOUS_PEERS / 100;
1178   
1179   /* Select n_malicious peers and ensure that those are not active peers. 
1180      keep all malicious peer at one place, and call act malicious for all
1181      those peers. */
1182   
1183 #endif
1184   
1185   a_ac = GNUNET_malloc (n_active * sizeof (struct ActiveContext));
1186   ac_cnt = 0;
1187   for (cnt = 0; cnt < num_peers && ac_cnt < n_active; cnt++)
1188   {
1189     if (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 100) >=
1190         PUT_PROBABILITY)
1191       continue;
1192     a_ctx[cnt].ac = &a_ac[ac_cnt];
1193     a_ac[ac_cnt].ctx = &a_ctx[cnt];
1194     ac_cnt++;
1195   }
1196   n_active = ac_cnt;
1197   INFO ("Active peers: %u\n", n_active);
1198
1199   /* start DHT service on all peers */
1200   for (cnt = 0; cnt < num_peers; cnt++)
1201   {
1202     a_ctx[cnt].peer = peers[cnt];
1203     a_ctx[cnt].op = GNUNET_TESTBED_peer_manage_service (&a_ctx[cnt],
1204                                                         peers[cnt],
1205                                                         "dht",
1206                                                         &service_started,
1207                                                         &a_ctx[cnt],
1208                                                         1);
1209   }
1210 }
1211
1212
1213 /**
1214  * Main function that will be run by the scheduler.
1215  *
1216  * @param cls closure
1217  * @param args remaining command-line arguments
1218  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
1219  * @param config configuration
1220  */
1221 static void
1222 run (void *cls, char *const *args, const char *cfgfile,
1223      const struct GNUNET_CONFIGURATION_Handle *config)
1224 {
1225   uint64_t event_mask;
1226
1227   if (0 == num_peers)
1228   {
1229     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Exiting as the number of peers is %u\n"),
1230                 num_peers);
1231     return;
1232   }
1233   cfg = GNUNET_CONFIGURATION_dup (config);
1234   event_mask = 0;
1235   GNUNET_TESTBED_run (hosts_file, cfg, num_peers, event_mask, NULL,
1236                       NULL, &test_run, NULL);
1237   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_shutdown,
1238                                 NULL);
1239 }
1240
1241
1242 /**
1243  * Main function.
1244  *
1245  * @return 0 on success
1246  */
1247 int
1248 main (int argc, char *const *argv)
1249 {
1250   int rc;
1251
1252   static struct GNUNET_GETOPT_CommandLineOption options[] = {
1253     {'n', "peers", "COUNT",
1254      gettext_noop ("number of peers to start"),
1255      1, &GNUNET_GETOPT_set_uint, &num_peers},
1256     {'s', "searches", "COUNT",
1257      gettext_noop ("maximum number of times we try to search for successor circle formation (default is 1)"),
1258      1, &GNUNET_GETOPT_set_uint, &max_searches},
1259     {'H', "hosts", "FILENAME",
1260      gettext_noop ("name of the file with the login information for the testbed"),
1261      1, &GNUNET_GETOPT_set_string, &hosts_file},
1262     {'D', "delay", "DELAY",
1263      gettext_noop ("delay between rounds for collecting statistics (default: 30 sec)"),
1264      1, &GNUNET_GETOPT_set_relative_time, &delay_stats},
1265     {'P', "PUT-delay", "DELAY",
1266      gettext_noop ("delay to start doing PUTs (default: 1 sec)"),
1267      1, &GNUNET_GETOPT_set_relative_time, &delay_put},
1268     {'G', "GET-delay", "DELAY",
1269      gettext_noop ("delay to start doing GETs (default: 5 min)"),
1270      1, &GNUNET_GETOPT_set_relative_time, &delay_get},
1271     {'r', "replication", "DEGREE",
1272      gettext_noop ("replication degree for DHT PUTs"),
1273      1, &GNUNET_GETOPT_set_uint, &replication},
1274     {'t', "timeout", "TIMEOUT",
1275      gettext_noop ("timeout for DHT PUT and GET requests (default: 1 min)"),
1276      1, &GNUNET_GETOPT_set_relative_time, &timeout},
1277     GNUNET_GETOPT_OPTION_END
1278   };
1279
1280   max_searches = 5;
1281   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
1282     return 2;
1283   /* set default delays */
1284   delay_stats = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10);
1285   delay_put = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10);
1286   delay_get = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10);
1287   timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10);
1288   replication = 1;      /* default replication */
1289   rc = 0;
1290   if (GNUNET_OK !=
1291       GNUNET_PROGRAM_run (argc, argv, "dht-profiler",
1292                           gettext_noop
1293                           ("Measure quality and performance of the DHT service."),
1294                           options, &run, NULL))
1295     rc = 1;
1296   return rc;
1297 }