e70fb53556b1df2e085e83f36cee08f3cd5791a0
[oweals/gnunet.git] / src / rps / gnunet-service-rps.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C)
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 rps/gnunet-service-rps.c
23  * @brief rps service implementation
24  * @author Julius Bünger
25  */
26 #include "platform.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet_cadet_service.h"
29 #include "gnunet_nse_service.h"
30 #include "rps.h"
31
32 #include "gnunet-service-rps_sampler.h"
33
34 #include <math.h>
35 #include <inttypes.h>
36
37 #define LOG(kind, ...) GNUNET_log(kind, __VA_ARGS__)
38
39 // TODO modify @brief in every file
40
41 // TODO check for overflows
42
43 // TODO align message structs
44
45 // (TODO api -- possibility of getting weak random peer immideately)
46
47 // TODO malicious peer
48
49 // TODO connect to friends
50
51 // TODO store peers somewhere
52
53 // TODO ignore list?
54
55 // hist_size_init, hist_size_max
56
57 /**
58  * Our configuration.
59  */
60 static const struct GNUNET_CONFIGURATION_Handle *cfg;
61
62 /**
63  * Our own identity.
64  */
65 static struct GNUNET_PeerIdentity own_identity;
66
67
68   struct GNUNET_PeerIdentity *
69 get_rand_peer_ignore_list (const struct GNUNET_PeerIdentity *peer_list, unsigned int size,
70                            const struct GNUNET_PeerIdentity *ignore_list, unsigned int ignore_size);
71
72
73 /***********************************************************************
74  * Housekeeping with peers
75 ***********************************************************************/
76
77 /**
78  * Struct used to store the context of a connected client.
79  */
80 struct client_ctx
81 {
82   /**
83    * The message queue to communicate with the client.
84    */
85   struct GNUNET_MQ_Handle *mq;
86 };
87
88 /**
89  * Used to keep track in what lists single peerIDs are.
90  */
91 enum PeerFlags
92 {
93   PULL_REPLY_PENDING   = 0x01,
94   IN_OTHER_GOSSIP_LIST = 0x02, // unneeded?
95   IN_OWN_SAMPLER_LIST  = 0x04, // unneeded?
96   IN_OWN_GOSSIP_LIST   = 0x08, // unneeded?
97
98   /**
99    * We set this bit when we can be sure the other peer is/was live.
100    */
101   VALID                = 0x10
102 };
103
104
105 /**
106  * Functions of this type can be used to be stored at a peer for later execution.
107  */
108 typedef void (* PeerOp) (void *cls, const struct GNUNET_PeerIdentity *peer);
109
110 /**
111  * Outstanding operation on peer consisting of callback and closure
112  */
113 struct PeerOutstandingOp
114 {
115   /**
116    * Callback
117    */
118   PeerOp op;
119
120   /**
121    * Closure
122    */
123   void *op_cls;
124 };
125
126
127 /**
128  * Struct used to keep track of other peer's status
129  *
130  * This is stored in a multipeermap.
131  */
132 struct PeerContext
133 {
134   /**
135    * In own gossip/sampler list, in other's gossip/sampler list
136    */
137   uint32_t peer_flags;
138
139   /**
140    * Message queue open to client
141    */
142   struct GNUNET_MQ_Handle *mq;
143
144   /**
145    * Channel open to client.
146    */
147   struct GNUNET_CADET_Channel *send_channel;
148
149   /**
150    * Channel open from client.
151    */
152   struct GNUNET_CADET_Channel *recv_channel; // unneeded?
153
154   /**
155    * Array of outstanding operations on this peer.
156    */
157   struct PeerOutstandingOp *outstanding_ops;
158
159   /**
160    * Number of outstanding operations.
161    */
162   unsigned int num_outstanding_ops;
163   //size_t num_outstanding_ops;
164
165   /**
166    * Handle to the callback given to cadet_ntfy_tmt_rdy()
167    *
168    * To be canceled on shutdown.
169    */
170   struct GNUNET_CADET_TransmitHandle *is_live_task;
171
172   /**
173    * Identity of the peer
174    */
175   struct GNUNET_PeerIdentity peer_id;
176
177   /**
178    * This is pobably followed by 'statistical' data (when we first saw
179    * him, how did we get his ID, how many pushes (in a timeinterval),
180    * ...)
181    */
182 };
183
184 /***********************************************************************
185  * /Housekeeping with peers
186 ***********************************************************************/
187
188
189
190
191
192 /***********************************************************************
193  * Globals
194 ***********************************************************************/
195
196 /**
197  * Sampler used for the Brahms protocol itself.
198  */
199 static struct RPS_Sampler *prot_sampler;
200
201 /**
202  * Sampler used for the clients.
203  */
204 static struct RPS_Sampler *client_sampler;
205
206 /**
207  * Set of all peers to keep track of them.
208  */
209 static struct GNUNET_CONTAINER_MultiPeerMap *peer_map;
210
211
212 /**
213  * The gossiped list of peers.
214  */
215 static struct GNUNET_PeerIdentity *gossip_list;
216
217 /**
218  * Size of the gossiped list
219  */
220 //static unsigned int gossip_list_size;
221 static uint32_t gossip_list_size;
222
223
224 /**
225  * The size of sampler we need to be able to satisfy the client's need of
226  * random peers.
227  */
228 static unsigned int sampler_size_client_need;
229
230 /**
231  * The size of sampler we need to be able to satisfy the Brahms protocol's
232  * need of random peers.
233  *
234  * This is directly taken as the #gossip_list_size on update of the
235  * #gossip_list
236  *
237  * This is one minimum size the sampler grows to.
238  */
239 static unsigned int sampler_size_est_need;
240
241
242 /**
243  * Percentage of total peer number in the gossip list
244  * to send random PUSHes to
245  */
246 static float alpha;
247
248 /**
249  * Percentage of total peer number in the gossip list
250  * to send random PULLs to
251  */
252 static float beta;
253
254 /**
255  * The percentage gamma of history updates.
256  * Simply 1 - alpha - beta
257  */
258
259
260 /**
261  * Identifier for the main task that runs periodically.
262  */
263 static struct GNUNET_SCHEDULER_Task *do_round_task;
264
265 /**
266  * Time inverval the do_round task runs in.
267  */
268 static struct GNUNET_TIME_Relative round_interval;
269
270
271
272 /**
273  * List to store peers received through pushes temporary.
274  *
275  * TODO -> multipeermap
276  */
277 static struct GNUNET_PeerIdentity *push_list;
278
279 /**
280  * Size of the push_list;
281  */
282 static unsigned int push_list_size;
283 //size_t push_list_size;
284
285 /**
286  * List to store peers received through pulls temporary.
287  *
288  * TODO -> multipeermap
289  */
290 static struct GNUNET_PeerIdentity *pull_list;
291
292 /**
293  * Size of the pull_list;
294  */
295 static unsigned int pull_list_size;
296 //size_t pull_list_size;
297
298
299 /**
300  * Handler to NSE.
301  */
302 static struct GNUNET_NSE_Handle *nse;
303
304 /**
305  * Handler to CADET.
306  */
307 static struct GNUNET_CADET_Handle *cadet_handle;
308
309
310 /**
311  * Request counter.
312  *
313  * Only needed in the beginning to check how many of the 64 deltas
314  * we already have
315  */
316 static unsigned int req_counter;
317
318 /**
319  * Time of the last request we received.
320  *
321  * Used to compute the expected request rate.
322  */
323 static struct GNUNET_TIME_Absolute last_request;
324
325 /**
326  * Size of #request_deltas.
327  */
328 #define REQUEST_DELTAS_SIZE 64
329 static unsigned int request_deltas_size = REQUEST_DELTAS_SIZE;
330
331 /**
332  * Last 64 deltas between requests
333  */
334 static struct GNUNET_TIME_Relative request_deltas[REQUEST_DELTAS_SIZE];
335
336 /**
337  * The prediction of the rate of requests
338  */
339 static struct GNUNET_TIME_Relative  request_rate;
340
341
342 /**
343  * List with the peers we sent requests to.
344  */
345 struct GNUNET_PeerIdentity *pending_pull_reply_list;
346
347 /**
348  * Size of #pending_pull_reply_list.
349  */
350 uint32_t pending_pull_reply_list_size;
351
352
353 /**
354  * Number of history update tasks.
355  */
356 uint32_t num_hist_update_tasks;
357
358
359 /***********************************************************************
360  * /Globals
361 ***********************************************************************/
362
363
364
365
366
367
368 /***********************************************************************
369  * Util functions
370 ***********************************************************************/
371
372 /**
373  * Set a peer flag of given peer context.
374  */
375 #define set_peer_flag(peer_ctx, mask) (peer_ctx->peer_flags |= mask)
376
377 /**
378  * Get peer flag of given peer context.
379  */
380 #define get_peer_flag(peer_ctx, mask) (peer_ctx->peer_flags & mask ? GNUNET_YES : GNUNET_NO)
381
382 /**
383  * Unset flag of given peer context.
384  */
385 #define unset_peer_flag(peer_ctx, mask) (peer_ctx->peer_flags &= (~mask))
386
387
388 /**
389  * Clean the send channel of a peer
390  */
391 void
392 peer_clean (const struct GNUNET_PeerIdentity *peer);
393
394
395 /**
396  * Check if peer is already in peer array.
397  */
398   int
399 in_arr (const struct GNUNET_PeerIdentity *array,
400         unsigned int arr_size,
401         const struct GNUNET_PeerIdentity *peer)
402 {
403   GNUNET_assert (NULL != peer);
404
405   if (0 == arr_size)
406     return GNUNET_NO;
407
408   GNUNET_assert (NULL != array);
409
410   unsigned int i;
411
412   for (i = 0; i < arr_size ; i++)
413     if (0 == GNUNET_CRYPTO_cmp_peer_identity (&array[i], peer))
414       return GNUNET_YES;
415   return GNUNET_NO;
416 }
417
418
419 /**
420  * Print peerlist to log.
421  */
422 void
423 print_peer_list (struct GNUNET_PeerIdentity *list, unsigned int len)
424 {
425   unsigned int i;
426
427   LOG (GNUNET_ERROR_TYPE_DEBUG,
428        "Printing peer list of length %u at %p:\n",
429        len,
430        list);
431   for (i = 0 ; i < len ; i++)
432   {
433     LOG (GNUNET_ERROR_TYPE_DEBUG,
434          "%u. peer: %s\n",
435          i, GNUNET_i2s (&list[i]));
436   }
437 }
438
439
440 /**
441  * Remove peer from list.
442  */
443   void
444 rem_from_list (struct GNUNET_PeerIdentity **peer_list,
445                unsigned int *list_size,
446                const struct GNUNET_PeerIdentity *peer)
447 {
448   unsigned int i;
449   struct GNUNET_PeerIdentity *tmp;
450
451   tmp = *peer_list;
452
453   LOG (GNUNET_ERROR_TYPE_DEBUG,
454        "Removing peer %s from list at %p\n",
455        GNUNET_i2s (peer),
456        tmp);
457   print_peer_list (tmp, *list_size);
458
459   for ( i = 0 ; i < *list_size ; i++ )
460   {
461     if (0 == GNUNET_CRYPTO_cmp_peer_identity (&tmp[i], peer))
462     {
463       if (i < *list_size -1)
464       { /* Not at the last entry -- shift peers left */
465         memcpy (&tmp[i], &tmp[i +1],
466                 ((*list_size) - i -1) * sizeof (struct GNUNET_PeerIdentity));
467       }
468       /* Remove last entry (should be now useless PeerID) */
469       GNUNET_array_grow (tmp, *list_size, (*list_size) -1);
470     }
471   }
472   *peer_list = tmp;
473 }
474
475 /**
476  * Get random peer from the given list but don't return one from the @a ignore_list.
477  */
478   struct GNUNET_PeerIdentity *
479 get_rand_peer_ignore_list (const struct GNUNET_PeerIdentity *peer_list,
480                            uint32_t list_size,
481                            const struct GNUNET_PeerIdentity *ignore_list,
482                            uint32_t ignore_size)
483 {
484   uint32_t r_index;
485   uint32_t tmp_size;
486   struct GNUNET_PeerIdentity *tmp_peer_list;
487   struct GNUNET_PeerIdentity *peer;
488
489   GNUNET_assert (NULL != peer_list);
490   if (0 == list_size)
491     return NULL;
492
493   tmp_size = 0;
494   tmp_peer_list = NULL;
495   GNUNET_array_grow (tmp_peer_list, tmp_size, list_size);
496   memcpy (tmp_peer_list,
497           peer_list,
498           list_size * sizeof (struct GNUNET_PeerIdentity));
499   peer = GNUNET_new (struct GNUNET_PeerIdentity);
500
501   /**;
502    * Choose the r_index of the peer we want to return
503    * at random from the interval of the gossip list
504    */
505   r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
506                                       tmp_size);
507   *peer = tmp_peer_list[r_index];
508
509   while (in_arr (ignore_list, ignore_size, peer))
510   {
511     rem_from_list (&tmp_peer_list, &tmp_size, peer);
512
513     print_peer_list (tmp_peer_list, tmp_size);
514
515     if (0 == tmp_size)
516     {
517       GNUNET_free (peer);
518       return NULL;
519     }
520
521     /**;
522      * Choose the r_index of the peer we want to return
523      * at random from the interval of the gossip list
524      */
525     r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
526                                         tmp_size);
527     *peer = tmp_peer_list[r_index];
528   }
529
530
531   GNUNET_array_grow (tmp_peer_list, tmp_size, 0);
532
533   return peer;
534 }
535
536
537 /**
538  * Get the context of a peer. If not existing, create.
539  */
540   struct PeerContext *
541 get_peer_ctx (struct GNUNET_CONTAINER_MultiPeerMap *peer_map,
542               const struct GNUNET_PeerIdentity *peer)
543 {
544   struct PeerContext *ctx;
545
546   if ( GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
547   {
548     ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
549   }
550   else
551   {
552     ctx = GNUNET_new (struct PeerContext);
553     ctx->peer_flags = 0;
554     ctx->mq = NULL;
555     ctx->send_channel = NULL;
556     ctx->recv_channel = NULL;
557     ctx->outstanding_ops = NULL;
558     ctx->num_outstanding_ops = 0;
559     (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx,
560                                               GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
561   }
562   return ctx;
563 }
564
565
566 /**
567  * Put random peer from sampler into the gossip list as history update.
568  */
569   void
570 hist_update (void *cls, struct GNUNET_PeerIdentity *ids, uint32_t num_peers)
571 {
572   GNUNET_assert (1 == num_peers);
573
574   if (gossip_list_size < sampler_size_est_need)
575     GNUNET_array_append (gossip_list, gossip_list_size, *ids);
576
577   if (0 < num_hist_update_tasks)
578     num_hist_update_tasks--;
579 }
580
581
582 /**
583  * Set the peer flag to living and call the outstanding operations on this peer.
584  */
585 static size_t
586 peer_is_live (struct PeerContext *peer_ctx)
587 {
588   struct GNUNET_PeerIdentity *peer;
589
590   peer = &peer_ctx->peer_id;
591   set_peer_flag (peer_ctx, VALID);
592
593   LOG (GNUNET_ERROR_TYPE_DEBUG, "Peer %s is live\n", GNUNET_i2s (peer));
594
595   if (0 != peer_ctx->num_outstanding_ops)
596   { /* Call outstanding operations */
597     unsigned int i;
598
599     for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
600       peer_ctx->outstanding_ops[i].op (peer_ctx->outstanding_ops[i].op_cls, peer);
601     GNUNET_array_grow (peer_ctx->outstanding_ops, peer_ctx->num_outstanding_ops, 0);
602   }
603
604   return 0;
605 }
606
607
608 /**
609  * Callback that is called when a channel was effectively established.
610  * This is given to ntfy_tmt_rdy and called when the channel was
611  * successfully established.
612  */
613 static size_t
614 cadet_ntfy_tmt_rdy_cb (void *cls, size_t size, void *buf)
615 {
616   struct PeerContext *peer_ctx = (struct PeerContext *) cls;
617
618   if (NULL != buf
619       && 0 != size)
620     peer_is_live (peer_ctx);
621
622   //if (NULL != peer_ctx->is_live_task)
623   //{
624   //  LOG (GNUNET_ERROR_TYPE_DEBUG,
625   //       "Trying to cancle is_live_task for peer %s\n",
626   //       GNUNET_i2s (&peer_ctx->peer_id));
627   //  GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->is_live_task);
628   //  peer_ctx->is_live_task = NULL;
629   //}
630   peer_ctx->is_live_task = NULL;
631
632   return 0;
633 }
634
635
636 /**
637  * Get the channel of a peer. If not existing, create.
638  */
639   struct GNUNET_CADET_Channel *
640 get_channel (struct GNUNET_CONTAINER_MultiPeerMap *peer_map,
641              const struct GNUNET_PeerIdentity *peer)
642 {
643   struct PeerContext *ctx;
644
645   LOG (GNUNET_ERROR_TYPE_DEBUG,
646        "Trying to establish channel to peer %s\n",
647        GNUNET_i2s (peer));
648
649   ctx = get_peer_ctx (peer_map, peer);
650   if (NULL == ctx->send_channel)
651   {
652     ctx->send_channel = GNUNET_CADET_channel_create (cadet_handle,
653                                                      NULL,
654                                                      peer,
655                                                      GNUNET_RPS_CADET_PORT,
656                                                      GNUNET_CADET_OPTION_RELIABLE);
657
658     /* If we don't know whether peer is live,
659      * get notified when we know it is live. */
660     if (NULL == ctx->recv_channel
661         && NULL == ctx->is_live_task)
662     {
663       ctx->peer_id = *peer;
664       LOG (GNUNET_ERROR_TYPE_DEBUG,
665            "Get informed about peer %s getting live\n",
666            GNUNET_i2s (peer));
667       ctx->is_live_task =
668           GNUNET_CADET_notify_transmit_ready (ctx->send_channel,
669                                               GNUNET_NO,
670                                               GNUNET_TIME_UNIT_FOREVER_REL,
671                                               sizeof (struct GNUNET_MessageHeader),
672                                               cadet_ntfy_tmt_rdy_cb,
673                                               ctx);
674     }
675     // FIXME check whether this is NULL
676
677     // do I have to explicitly put it in the peer_map?
678     (void) GNUNET_CONTAINER_multipeermap_put
679       (peer_map,
680        peer,
681        ctx,
682        GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
683   }
684   return ctx->send_channel;
685 }
686
687
688 /**
689  * Get the message queue of a specific peer.
690  *
691  * If we already have a message queue open to this client,
692  * simply return it, otherways create one.
693  */
694   struct GNUNET_MQ_Handle *
695 get_mq (struct GNUNET_CONTAINER_MultiPeerMap *peer_map,
696         const struct GNUNET_PeerIdentity *peer_id)
697 {
698   struct PeerContext *peer_ctx;
699
700   peer_ctx = get_peer_ctx (peer_map, peer_id);
701
702   GNUNET_assert (NULL == peer_ctx->is_live_task);
703
704   if (NULL == peer_ctx->mq)
705   {
706     (void) get_channel (peer_map, peer_id);
707     peer_ctx->mq = GNUNET_CADET_mq_create (peer_ctx->send_channel);
708     //do I have to explicitly put it in the peer_map?
709     (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer_id, peer_ctx,
710                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
711   }
712   return peer_ctx->mq;
713 }
714
715
716 /**
717  * Sum all time relatives of an array.
718   */
719   struct GNUNET_TIME_Relative
720 T_relative_sum (const struct GNUNET_TIME_Relative *rel_array, uint32_t arr_size)
721 {
722   struct GNUNET_TIME_Relative sum;
723   uint32_t i;
724
725   sum = GNUNET_TIME_UNIT_ZERO;
726   for ( i = 0 ; i < arr_size ; i++ )
727   {
728     sum = GNUNET_TIME_relative_add (sum, rel_array[i]);
729   }
730   return sum;
731 }
732
733
734 /**
735  * Compute the average of given time relatives.
736  */
737   struct GNUNET_TIME_Relative
738 T_relative_avg (const struct GNUNET_TIME_Relative *rel_array, uint32_t arr_size)
739 {
740   return GNUNET_TIME_relative_divide (T_relative_sum (rel_array, arr_size), arr_size);
741 }
742
743
744 /**
745  * Insert PeerID in #pull_list
746  *
747  * Called once we know a peer is live.
748  */
749   void
750 insert_in_pull_list (void *cls, const struct GNUNET_PeerIdentity *peer)
751 {
752   if (GNUNET_NO == in_arr (pull_list, pull_list_size, peer))
753     GNUNET_array_append (pull_list, pull_list_size, *peer);
754
755   peer_clean (peer);
756 }
757
758 /**
759  * Check whether #insert_in_pull_list was already scheduled
760  */
761   int
762 insert_in_pull_list_scheduled (const struct PeerContext *peer_ctx)
763 {
764   unsigned int i;
765
766   for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
767     if (insert_in_pull_list == peer_ctx->outstanding_ops[i].op)
768       return GNUNET_YES;
769   return GNUNET_NO;
770 }
771
772
773 /**
774  * Insert PeerID in #gossip_list
775  *
776  * Called once we know a peer is live.
777  */
778   void
779 insert_in_gossip_list (void *cls, const struct GNUNET_PeerIdentity *peer)
780 {
781   if (GNUNET_NO == in_arr (gossip_list, gossip_list_size, peer))
782     GNUNET_array_append (gossip_list, gossip_list_size, *peer);
783
784   (void) get_channel (peer_map, peer);
785 }
786
787 /**
788  * Check whether #insert_in_pull_list was already scheduled
789  */
790   int
791 insert_in_gossip_list_scheduled (const struct PeerContext *peer_ctx)
792 {
793   unsigned int i;
794
795   for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
796     if (insert_in_gossip_list == peer_ctx->outstanding_ops[i].op)
797       return GNUNET_YES;
798   return GNUNET_NO;
799 }
800
801
802 /**
803  * Update sampler with given PeerID.
804  */
805   void
806 insert_in_sampler (void *cls, const struct GNUNET_PeerIdentity *peer)
807 {
808   RPS_sampler_update (prot_sampler,   peer);
809   RPS_sampler_update (client_sampler, peer);
810 }
811
812
813 /**
814  * Check whether #insert_in_sampler was already scheduled
815  */
816 static int
817 insert_in_sampler_scheduled (const struct PeerContext *peer_ctx)
818 {
819   unsigned int i;
820
821   for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
822     if (insert_in_sampler== peer_ctx->outstanding_ops[i].op)
823       return GNUNET_YES;
824   return GNUNET_NO;
825 }
826
827
828 /**
829  * Wrapper around #RPS_sampler_resize()
830  *
831  * If we do not have enough sampler elements, double current sampler size
832  * If we have more than enough sampler elements, halv current sampler size
833  */
834 static void
835 resize_wrapper (struct RPS_Sampler *sampler, uint32_t new_size)
836 {
837   unsigned int sampler_size;
838
839   // TODO statistics
840   // TODO respect the min, max
841   sampler_size = RPS_sampler_get_size (sampler);
842   if (sampler_size > new_size * 4)
843   { /* Shrinking */
844     RPS_sampler_resize (sampler, sampler_size / 2);
845   }
846   else if (sampler_size < new_size)
847   { /* Growing */
848     RPS_sampler_resize (sampler, sampler_size * 2);
849   }
850   LOG (GNUNET_ERROR_TYPE_DEBUG, "sampler_size is now %u\n", sampler_size);
851 }
852
853
854 /**
855  * Wrapper around #RPS_sampler_resize() resizing the client sampler
856  */
857 static void
858 client_resize_wrapper ()
859 {
860   uint32_t bigger_size;
861   unsigned int sampler_size;
862
863   // TODO statistics
864
865   sampler_size = RPS_sampler_get_size (client_sampler);
866
867   if (sampler_size_est_need > sampler_size_client_need)
868     bigger_size = sampler_size_est_need;
869   else
870     bigger_size = sampler_size_client_need;
871
872   // TODO respect the min, max
873   resize_wrapper (client_sampler, bigger_size);
874   LOG (GNUNET_ERROR_TYPE_DEBUG, "sampler_size is now %u\n", sampler_size);
875 }
876
877
878 /**
879  * Estimate request rate
880  *
881  * Called every time we receive a request from the client.
882  */
883   void
884 est_request_rate()
885 {
886   struct GNUNET_TIME_Relative max_round_duration;
887
888   if (request_deltas_size > req_counter)
889     req_counter++;
890   if ( 1 < req_counter)
891   {
892     /* Shift last request deltas to the right */
893     memcpy (&request_deltas[1],
894         request_deltas,
895         (req_counter - 1) * sizeof (struct GNUNET_TIME_Relative));
896
897     /* Add current delta to beginning */
898     request_deltas[0] =
899         GNUNET_TIME_absolute_get_difference (last_request,
900                                              GNUNET_TIME_absolute_get ());
901     request_rate = T_relative_avg (request_deltas, req_counter);
902
903     /* Compute the duration a round will maximally take */
904     max_round_duration =
905         GNUNET_TIME_relative_add (round_interval,
906                                   GNUNET_TIME_relative_divide (round_interval, 2));
907
908     /* Set the estimated size the sampler has to have to
909      * satisfy the current client request rate */
910     sampler_size_client_need =
911         max_round_duration.rel_value_us / request_rate.rel_value_us;
912
913     /* Resize the sampler */
914     client_resize_wrapper ();
915   }
916   last_request = GNUNET_TIME_absolute_get ();
917 }
918
919
920 /***********************************************************************
921  * /Util functions
922 ***********************************************************************/
923
924
925
926
927
928 /**
929  * Function called by NSE.
930  *
931  * Updates sizes of sampler list and gossip list and adapt those lists
932  * accordingly.
933  */
934   void
935 nse_callback (void *cls, struct GNUNET_TIME_Absolute timestamp,
936               double logestimate, double std_dev)
937 {
938   double estimate;
939   //double scale; // TODO this might go gloabal/config
940
941   LOG (GNUNET_ERROR_TYPE_DEBUG,
942        "Received a ns estimate - logest: %f, std_dev: %f (old_size: %u)\n",
943        logestimate, std_dev, RPS_sampler_get_size (prot_sampler));
944   //scale = .01;
945   estimate = GNUNET_NSE_log_estimate_to_n (logestimate);
946   // GNUNET_NSE_log_estimate_to_n (logestimate);
947   estimate = pow (estimate, 1.0 / 3);
948   // TODO add if std_dev is a number
949   // estimate += (std_dev * scale);
950   if (2 < ceil (estimate))
951   {
952     LOG (GNUNET_ERROR_TYPE_DEBUG, "Changing estimate to %f\n", estimate);
953     sampler_size_est_need = estimate;
954   } else
955     LOG (GNUNET_ERROR_TYPE_DEBUG, "Not using estimate %f\n", estimate);
956
957   /* If the NSE has changed adapt the lists accordingly */
958   resize_wrapper (prot_sampler, sampler_size_est_need);
959   client_resize_wrapper ();
960 }
961
962
963 /**
964  * Callback called once the requested PeerIDs are ready.
965  *
966  * Sends those to the requesting client.
967  */
968 void client_respond (void *cls,
969     struct GNUNET_PeerIdentity *ids, uint32_t num_peers)
970 {
971   LOG (GNUNET_ERROR_TYPE_DEBUG, "sampler returned %" PRIX32 " peers\n", num_peers);
972   struct GNUNET_MQ_Envelope *ev;
973   struct GNUNET_RPS_CS_ReplyMessage *out_msg;
974   struct GNUNET_SERVER_Client *client;
975   uint32_t size_needed;
976   struct client_ctx *cli_ctx;
977
978   client = (struct GNUNET_SERVER_Client *) cls;
979
980   size_needed = sizeof (struct GNUNET_RPS_CS_ReplyMessage) +
981                 num_peers * sizeof (struct GNUNET_PeerIdentity);
982
983   GNUNET_assert (GNUNET_SERVER_MAX_MESSAGE_SIZE >= size_needed);
984
985   ev = GNUNET_MQ_msg_extra (out_msg,
986                             num_peers * sizeof (struct GNUNET_PeerIdentity),
987                             GNUNET_MESSAGE_TYPE_RPS_CS_REPLY);
988   out_msg->num_peers = htonl (num_peers);
989
990   memcpy (&out_msg[1],
991       ids,
992       num_peers * sizeof (struct GNUNET_PeerIdentity));
993   GNUNET_free (ids);
994
995   cli_ctx = GNUNET_SERVER_client_get_user_context (client, struct client_ctx);
996   if ( NULL == cli_ctx ) {
997     cli_ctx = GNUNET_new (struct client_ctx);
998     cli_ctx->mq = GNUNET_MQ_queue_for_server_client (client);
999     GNUNET_SERVER_client_set_user_context (client, cli_ctx);
1000   }
1001
1002   GNUNET_MQ_send (cli_ctx->mq, ev);
1003 }
1004
1005
1006 /**
1007  * Handle RPS request from the client.
1008  *
1009  * @param cls closure
1010  * @param client identification of the client
1011  * @param message the actual message
1012  */
1013 static void
1014 handle_client_request (void *cls,
1015             struct GNUNET_SERVER_Client *client,
1016             const struct GNUNET_MessageHeader *message)
1017 {
1018   struct GNUNET_RPS_CS_RequestMessage *msg;
1019   uint32_t num_peers;
1020   uint32_t size_needed;
1021   uint32_t i;
1022
1023   msg = (struct GNUNET_RPS_CS_RequestMessage *) message;
1024
1025   num_peers = ntohl (msg->num_peers);
1026   size_needed = sizeof (struct GNUNET_RPS_CS_ReplyMessage) +
1027                 num_peers * sizeof (struct GNUNET_PeerIdentity);
1028
1029   if (GNUNET_SERVER_MAX_MESSAGE_SIZE < size_needed)
1030   {
1031     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1032     return;
1033   }
1034
1035   for (i = 0 ; i < num_peers ; i++)
1036     est_request_rate();
1037
1038   LOG (GNUNET_ERROR_TYPE_DEBUG, "Client requested %" PRIX32 " random peer(s).\n", num_peers);
1039
1040   RPS_sampler_get_n_rand_peers (client_sampler, client_respond,
1041                                 client, num_peers, GNUNET_YES);
1042
1043   GNUNET_SERVER_receive_done (client,
1044                               GNUNET_OK);
1045 }
1046
1047
1048 /**
1049  * Handle seed from the client.
1050  *
1051  * @param cls closure
1052  * @param client identification of the client
1053  * @param message the actual message
1054  */
1055   static void
1056 handle_client_seed (void *cls,
1057             struct GNUNET_SERVER_Client *client,
1058             const struct GNUNET_MessageHeader *message)
1059 {
1060   struct GNUNET_RPS_CS_SeedMessage *in_msg;
1061   struct GNUNET_PeerIdentity *peers;
1062   uint32_t i;
1063
1064   if (sizeof (struct GNUNET_RPS_CS_SeedMessage) < ntohs (message->size))
1065   {
1066     GNUNET_break_op (0);
1067     GNUNET_SERVER_receive_done (client,
1068               GNUNET_SYSERR);
1069   }
1070   in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
1071   if ((ntohs (message->size) - sizeof (struct GNUNET_RPS_CS_SeedMessage)) /
1072       sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
1073   {
1074     GNUNET_break_op (0);
1075     GNUNET_SERVER_receive_done (client,
1076               GNUNET_SYSERR);
1077   }
1078
1079   in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
1080   peers = (struct GNUNET_PeerIdentity *) &message[1];
1081
1082   for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
1083     RPS_sampler_update (prot_sampler,   &peers[i]);
1084     RPS_sampler_update (client_sampler, &peers[i]);
1085
1086   GNUNET_SERVER_receive_done (client,
1087                               GNUNET_OK);
1088 }
1089
1090
1091 /**
1092  * Handle a PUSH message from another peer.
1093  *
1094  * Check the proof of work and store the PeerID
1095  * in the temporary list for pushed PeerIDs.
1096  *
1097  * @param cls Closure
1098  * @param channel The channel the PUSH was received over
1099  * @param channel_ctx The context associated with this channel
1100  * @param msg The message header
1101  */
1102 static int
1103 handle_peer_push (void *cls,
1104     struct GNUNET_CADET_Channel *channel,
1105     void **channel_ctx,
1106     const struct GNUNET_MessageHeader *msg)
1107 {
1108   const struct GNUNET_PeerIdentity *peer;
1109
1110   // (check the proof of work)
1111
1112   peer = (const struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel, GNUNET_CADET_OPTION_PEER);
1113   // FIXME wait for cadet to change this function
1114   LOG (GNUNET_ERROR_TYPE_DEBUG, "PUSH received (%s)\n", GNUNET_i2s (peer));
1115
1116   /* Add the sending peer to the push_list */
1117   if (GNUNET_NO == in_arr (push_list, pull_list_size, peer))
1118     GNUNET_array_append (push_list, push_list_size, *peer);
1119
1120   return GNUNET_OK;
1121 }
1122
1123 /**
1124  * Handle PULL REQUEST request message from another peer.
1125  *
1126  * Reply with the gossip list of PeerIDs.
1127  *
1128  * @param cls Closure
1129  * @param channel The channel the PUSH was received over
1130  * @param channel_ctx The context associated with this channel
1131  * @param msg The message header
1132  */
1133 static int
1134 handle_peer_pull_request (void *cls,
1135     struct GNUNET_CADET_Channel *channel,
1136     void **channel_ctx,
1137     const struct GNUNET_MessageHeader *msg)
1138 {
1139   struct GNUNET_PeerIdentity *peer;
1140   uint32_t send_size;
1141   struct GNUNET_MQ_Handle *mq;
1142   struct GNUNET_MQ_Envelope *ev;
1143   struct GNUNET_RPS_P2P_PullReplyMessage *out_msg;
1144
1145
1146   peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel,
1147                                                                        GNUNET_CADET_OPTION_PEER);
1148   // FIXME wait for cadet to change this function
1149
1150   /* Compute actual size */
1151   send_size = sizeof (struct GNUNET_RPS_P2P_PullReplyMessage) +
1152               gossip_list_size * sizeof (struct GNUNET_PeerIdentity);
1153
1154   if (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE < send_size)
1155     /* Compute number of peers to send
1156      * If too long, simply truncate */
1157     send_size =
1158       (GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE -
1159        sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) /
1160        sizeof (struct GNUNET_PeerIdentity);
1161   else
1162     send_size = gossip_list_size;
1163
1164   LOG (GNUNET_ERROR_TYPE_DEBUG,
1165       "PULL REQUEST from peer %s received, going to send %u peers\n",
1166       GNUNET_i2s (peer), send_size);
1167
1168   mq = get_mq (peer_map, peer);
1169
1170   ev = GNUNET_MQ_msg_extra (out_msg,
1171                            send_size * sizeof (struct GNUNET_PeerIdentity),
1172                            GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY);
1173   //out_msg->num_peers = htonl (gossip_list_size);
1174   out_msg->num_peers = htonl (send_size);
1175   memcpy (&out_msg[1], gossip_list,
1176          send_size * sizeof (struct GNUNET_PeerIdentity));
1177
1178   GNUNET_MQ_send (mq, ev);
1179
1180   return GNUNET_OK;
1181 }
1182
1183 /**
1184  * Handle PULL REPLY message from another peer.
1185  *
1186  * Check whether we sent a corresponding request and
1187  * whether this reply is the first one.
1188  *
1189  * @param cls Closure
1190  * @param channel The channel the PUSH was received over
1191  * @param channel_ctx The context associated with this channel
1192  * @param msg The message header
1193  */
1194   static int
1195 handle_peer_pull_reply (void *cls,
1196     struct GNUNET_CADET_Channel *channel,
1197     void **channel_ctx,
1198     const struct GNUNET_MessageHeader *msg)
1199 {
1200   LOG (GNUNET_ERROR_TYPE_DEBUG, "PULL REPLY received\n");
1201
1202   struct GNUNET_RPS_P2P_PullReplyMessage *in_msg;
1203   struct GNUNET_PeerIdentity *peers;
1204   struct PeerContext *peer_ctx;
1205   struct GNUNET_PeerIdentity *sender;
1206   struct PeerContext *sender_ctx;
1207   struct PeerOutstandingOp out_op;
1208   uint32_t i;
1209
1210   /* Check for protocol violation */
1211   if (sizeof (struct GNUNET_RPS_P2P_PullReplyMessage) > ntohs (msg->size))
1212   {
1213     GNUNET_break_op (0);
1214     return GNUNET_SYSERR;
1215   }
1216   in_msg = (struct GNUNET_RPS_P2P_PullReplyMessage *) msg;
1217   if ((ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) /
1218       sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
1219   {
1220     LOG (GNUNET_ERROR_TYPE_ERROR,
1221         "message says it sends %" PRIu64 " peers, have space for %i peers\n",
1222         ntohl (in_msg->num_peers),
1223         (ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) /
1224             sizeof (struct GNUNET_PeerIdentity));
1225     GNUNET_break_op (0);
1226     return GNUNET_SYSERR;
1227   }
1228
1229   /* Do actual logic */
1230   sender = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1231       (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1232        // Guess simply casting isn't the nicest way...
1233        // FIXME wait for cadet to change this function
1234   sender_ctx = get_peer_ctx (peer_map, sender);
1235
1236   if (GNUNET_YES == get_peer_flag (sender_ctx, PULL_REPLY_PENDING))
1237   {
1238     GNUNET_break_op (0);
1239     return GNUNET_OK;
1240   }
1241
1242   peers = (struct GNUNET_PeerIdentity *) &msg[1];
1243   for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
1244   {
1245     peer_ctx = get_peer_ctx (peer_map, &peers[i]);
1246     if (NULL != peer_ctx->send_channel
1247         || NULL != peer_ctx->recv_channel)
1248     {
1249       if (GNUNET_NO == in_arr (pull_list, pull_list_size, &peers[i])
1250           && GNUNET_CRYPTO_cmp_peer_identity (&own_identity, &peers[i]))
1251         GNUNET_array_append (pull_list, pull_list_size, peers[i]);
1252     }
1253     else if (GNUNET_NO == insert_in_pull_list_scheduled (peer_ctx))
1254     {
1255       out_op.op = insert_in_pull_list;
1256       out_op.op_cls = NULL;
1257       GNUNET_array_append (peer_ctx->outstanding_ops,
1258                            peer_ctx->num_outstanding_ops,
1259                            out_op);
1260     }
1261   }
1262
1263   unset_peer_flag (sender_ctx, PULL_REPLY_PENDING);
1264   rem_from_list (&pending_pull_reply_list, &pending_pull_reply_list_size, sender);
1265
1266   return GNUNET_OK;
1267 }
1268
1269
1270 /**
1271  * Send out PUSHes and PULLs.
1272  *
1273  * This is executed regylary.
1274  */
1275 static void
1276 do_round (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1277 {
1278   LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to execute next round\n");
1279
1280   uint32_t i;
1281   unsigned int *permut;
1282   unsigned int n_peers; /* Number of peers we send pushes/pulls to */
1283   struct GNUNET_MQ_Envelope *ev;
1284   struct GNUNET_PeerIdentity peer;
1285   struct GNUNET_PeerIdentity *tmp_peer;
1286   struct GNUNET_MQ_Handle *mq;
1287
1288   LOG (GNUNET_ERROR_TYPE_DEBUG,
1289        "Printing gossip list:\n");
1290   for (i = 0 ; i < gossip_list_size ; i++)
1291     LOG (GNUNET_ERROR_TYPE_DEBUG,
1292          "\t%s\n", GNUNET_i2s (&gossip_list[i]));
1293   // TODO log lists, ...
1294
1295   /* Would it make sense to have one shuffeled gossip list and then
1296    * to send PUSHes to first alpha peers, PULL requests to next beta peers and
1297    * use the rest to update sampler?
1298    * in essence get random peers with consumption */
1299
1300   /* Send PUSHes */
1301   if (0 < gossip_list_size)
1302   {
1303     permut = GNUNET_CRYPTO_random_permute (GNUNET_CRYPTO_QUALITY_STRONG,
1304                                            (unsigned int) gossip_list_size);
1305     n_peers = ceil (alpha * gossip_list_size);
1306     LOG (GNUNET_ERROR_TYPE_DEBUG,
1307          "Going to send pushes to %u ceil (%f * %u) peers.\n",
1308          n_peers, alpha, gossip_list_size);
1309     for (i = 0 ; i < n_peers ; i++)
1310     {
1311       peer = gossip_list[permut[i]];
1312       if (0 != GNUNET_CRYPTO_cmp_peer_identity (&own_identity, &peer)) // TODO
1313       { // FIXME if this fails schedule/loop this for later
1314         LOG (GNUNET_ERROR_TYPE_DEBUG,
1315              "Sending PUSH to peer %s of gossiped list.\n",
1316              GNUNET_i2s (&peer));
1317
1318         ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_PP_PUSH);
1319         mq = get_mq (peer_map, &peer);
1320         GNUNET_MQ_send (mq, ev);
1321       }
1322     }
1323     GNUNET_free (permut);
1324   }
1325
1326
1327   /* Send PULL requests */
1328   //permut = GNUNET_CRYPTO_random_permute (GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) sampler_list->size);
1329   n_peers = ceil (beta * gossip_list_size);
1330   LOG (GNUNET_ERROR_TYPE_DEBUG,
1331        "Going to send pulls to %u ceil (%f * %u) peers.\n",
1332        n_peers, beta, gossip_list_size);
1333   for (i = 0 ; i < n_peers ; i++)
1334   {
1335     tmp_peer = get_rand_peer_ignore_list (gossip_list, gossip_list_size,
1336         pending_pull_reply_list, pending_pull_reply_list_size);
1337     if (NULL != tmp_peer)
1338     {
1339       peer = *tmp_peer;
1340       GNUNET_free (tmp_peer);
1341
1342       GNUNET_array_append (pending_pull_reply_list, pending_pull_reply_list_size, peer);
1343
1344       if (0 != GNUNET_CRYPTO_cmp_peer_identity (&own_identity, &peer))
1345       { // FIXME if this fails schedule/loop this for later
1346         LOG (GNUNET_ERROR_TYPE_DEBUG,
1347              "Sending PULL request to peer %s of gossiped list.\n",
1348              GNUNET_i2s (&peer));
1349
1350         ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST);
1351         mq = get_mq (peer_map, &peer);
1352         GNUNET_MQ_send (mq, ev);
1353       }
1354     }
1355   }
1356
1357
1358   /* Update gossip list */
1359
1360   if ( push_list_size <= alpha * gossip_list_size &&
1361        push_list_size != 0 &&
1362        pull_list_size != 0 )
1363   {
1364     LOG (GNUNET_ERROR_TYPE_DEBUG, "Update of the gossip list.\n");
1365
1366     uint32_t first_border;
1367     uint32_t second_border;
1368     uint32_t r_index;
1369     uint32_t peers_to_clean_size;
1370     struct GNUNET_PeerIdentity *peers_to_clean;
1371
1372     peers_to_clean = NULL;
1373     peers_to_clean_size = 0;
1374     GNUNET_array_grow (peers_to_clean, peers_to_clean_size, gossip_list_size);
1375     memcpy (peers_to_clean,
1376             gossip_list,
1377             gossip_list_size * sizeof (struct GNUNET_PeerIdentity));
1378
1379     first_border  =                ceil (alpha * sampler_size_est_need);
1380     second_border = first_border + ceil (beta  * sampler_size_est_need);
1381
1382     GNUNET_array_grow (gossip_list, gossip_list_size, second_border);
1383
1384     for (i = 0 ; i < first_border ; i++)
1385     { // TODO use RPS_sampler_get_n_rand_peers
1386       /* Update gossip list with peers received through PUSHes */
1387       r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
1388                                        push_list_size);
1389       gossip_list[i] = push_list[r_index];
1390       // TODO change the peer_flags accordingly
1391     }
1392
1393     for (i = first_border ; i < second_border ; i++)
1394     {
1395       /* Update gossip list with peers received through PULLs */
1396       r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
1397                                        pull_list_size);
1398       gossip_list[i] = pull_list[r_index];
1399       // TODO change the peer_flags accordingly
1400     }
1401
1402     for (i = second_border ; i < sampler_size_est_need ; i++)
1403     {
1404       /* Update gossip list with peers from history */
1405       RPS_sampler_get_n_rand_peers (prot_sampler, hist_update, NULL, 1, GNUNET_NO);
1406       num_hist_update_tasks++;
1407       // TODO change the peer_flags accordingly
1408     }
1409
1410     for (i = 0 ; i < gossip_list_size ; i++)
1411       rem_from_list (&peers_to_clean, &peers_to_clean_size, &gossip_list[i]);
1412
1413     for (i = 0 ; i < peers_to_clean_size ; i++)
1414       peer_clean (&peers_to_clean[i]);
1415
1416     GNUNET_free (peers_to_clean);
1417   }
1418   else
1419   {
1420     LOG (GNUNET_ERROR_TYPE_DEBUG, "No update of the gossip list.\n");
1421   }
1422   // TODO independent of that also get some peers from CADET_get_peers()?
1423
1424
1425   /* Update samplers */
1426   for ( i = 0 ; i < push_list_size ; i++ )
1427   {
1428     RPS_sampler_update (prot_sampler,   &push_list[i]);
1429     RPS_sampler_update (client_sampler, &push_list[i]);
1430     // TODO set in_flag?
1431   }
1432
1433   for ( i = 0 ; i < pull_list_size ; i++ )
1434   {
1435     RPS_sampler_update (prot_sampler,   &push_list[i]);
1436     RPS_sampler_update (client_sampler, &push_list[i]);
1437     // TODO set in_flag?
1438   }
1439
1440
1441   /* Empty push/pull lists */
1442   GNUNET_array_grow (push_list, push_list_size, 0);
1443   GNUNET_array_grow (pull_list, pull_list_size, 0);
1444
1445   struct GNUNET_TIME_Relative time_next_round;
1446   struct GNUNET_TIME_Relative half_round_interval;
1447   unsigned int rand_delay;
1448
1449
1450   /* Compute random time value between .5 * round_interval and 1.5 *round_interval */
1451   half_round_interval = GNUNET_TIME_relative_divide (round_interval, 2);
1452   do
1453   {
1454   /*
1455    * Compute random value between (0 and 1) * round_interval
1456    * via multiplying round_interval with a 'fraction' (0 to value)/value
1457    */
1458   rand_delay = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, UINT_MAX/10);
1459   time_next_round = GNUNET_TIME_relative_multiply (round_interval,  rand_delay);
1460   time_next_round = GNUNET_TIME_relative_divide   (time_next_round, UINT_MAX/10);
1461   time_next_round = GNUNET_TIME_relative_add      (time_next_round, half_round_interval);
1462   } while (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == time_next_round.rel_value_us);
1463
1464   /* Schedule next round */
1465   do_round_task = GNUNET_SCHEDULER_add_delayed (round_interval, &do_round, NULL);
1466   LOG (GNUNET_ERROR_TYPE_DEBUG, "Finished round\n");
1467 }
1468
1469
1470 static void
1471 rps_start (struct GNUNET_SERVER_Handle *server);
1472
1473
1474 /**
1475  * This is called from GNUNET_CADET_get_peers().
1476  *
1477  * It is called on every peer(ID) that cadet somehow has contact with.
1478  * We use those to initialise the sampler.
1479  */
1480 void
1481 init_peer_cb (void *cls,
1482               const struct GNUNET_PeerIdentity *peer,
1483               int tunnel, // "Do we have a tunnel towards this peer?"
1484               unsigned int n_paths, // "Number of known paths towards this peer"
1485               unsigned int best_path) // "How long is the best path?
1486                                       // (0 = unknown, 1 = ourselves, 2 = neighbor)"
1487 {
1488   struct GNUNET_SERVER_Handle *server;
1489   struct PeerOutstandingOp out_op;
1490   struct PeerContext *peer_ctx;
1491
1492   server = (struct GNUNET_SERVER_Handle *) cls;
1493   if (NULL != peer
1494       && 0 != GNUNET_CRYPTO_cmp_peer_identity (&own_identity, peer))
1495   {
1496     LOG (GNUNET_ERROR_TYPE_DEBUG,
1497         "Got peer %s (at %p) from CADET (gossip_list_size: %u)\n",
1498         GNUNET_i2s (peer), peer, gossip_list_size);
1499
1500     // maybe create a function for that
1501     peer_ctx = get_peer_ctx (peer_map, peer);
1502     // FIXME this peer might already be marked as LIVE
1503     if (GNUNET_NO == insert_in_sampler_scheduled (peer_ctx))
1504     {
1505       out_op.op = insert_in_sampler;
1506       out_op.op_cls = NULL;
1507       GNUNET_array_append (peer_ctx->outstanding_ops,
1508                            peer_ctx->num_outstanding_ops,
1509                            out_op);
1510     }
1511
1512     if (GNUNET_NO == insert_in_gossip_list_scheduled (peer_ctx))
1513     {
1514       out_op.op = insert_in_gossip_list;
1515       out_op.op_cls = NULL;
1516       GNUNET_array_append (peer_ctx->outstanding_ops,
1517                            peer_ctx->num_outstanding_ops,
1518                            out_op);
1519     }
1520
1521     /* Trigger livelyness test on peer */
1522     (void) get_channel (peer_map, peer);
1523
1524     // send push/pull to each of those peers?
1525   }
1526   else if (NULL == peer)
1527     rps_start (server);
1528 }
1529
1530
1531 /**
1532  * Clean the send channel of a peer
1533  */
1534 void
1535 peer_clean (const struct GNUNET_PeerIdentity *peer)
1536 {
1537   struct PeerContext *peer_ctx;
1538   struct GNUNET_CADET_Channel *channel;
1539
1540   if (GNUNET_YES != in_arr (gossip_list, gossip_list_size, peer)
1541       && GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
1542   {
1543     peer_ctx = get_peer_ctx (peer_map, peer);
1544     if (NULL != peer_ctx->send_channel)
1545     {
1546       channel = peer_ctx->send_channel;
1547       peer_ctx->send_channel = NULL;
1548       GNUNET_CADET_channel_destroy (channel);
1549     }
1550   }
1551 }
1552
1553
1554 /**
1555  * Callback used to remove peers from the multipeermap.
1556  */
1557   int
1558 peer_remove_cb (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
1559 {
1560   struct PeerContext *peer_ctx;
1561   const struct GNUNET_CADET_Channel *channel =
1562     (const struct GNUNET_CADET_Channel *) cls;
1563   struct GNUNET_CADET_Channel *recv;
1564   struct GNUNET_CADET_Channel *send;
1565
1566   if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, value))
1567   {
1568     peer_ctx = (struct PeerContext *) value;
1569
1570     if (0 != peer_ctx->num_outstanding_ops)
1571       GNUNET_array_grow (peer_ctx->outstanding_ops,
1572                          peer_ctx->num_outstanding_ops,
1573                          0);
1574
1575     if (NULL != peer_ctx->mq)
1576       GNUNET_MQ_destroy (peer_ctx->mq);
1577
1578     if (NULL != peer_ctx->is_live_task)
1579     {
1580     LOG (GNUNET_ERROR_TYPE_DEBUG,
1581          "Trying to cancle is_live_task for peer %s\n",
1582          GNUNET_i2s (key));
1583       GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->is_live_task);
1584       peer_ctx->is_live_task = NULL;
1585     }
1586
1587     send = peer_ctx->send_channel;
1588     peer_ctx->send_channel = NULL;
1589     recv = peer_ctx->send_channel;
1590     peer_ctx->recv_channel = NULL;
1591
1592     if (NULL != send
1593         && channel != send)
1594     {
1595       GNUNET_CADET_channel_destroy (send);
1596     }
1597
1598     if (NULL != recv
1599         && channel != recv)
1600     {
1601       GNUNET_CADET_channel_destroy (recv);
1602     }
1603
1604     if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_remove_all (peer_map, key))
1605       LOG (GNUNET_ERROR_TYPE_WARNING, "removing peer from peer_map failed\n");
1606     else
1607       GNUNET_free (peer_ctx);
1608   }
1609
1610   return GNUNET_YES;
1611 }
1612
1613
1614 /**
1615  * Task run during shutdown.
1616  *
1617  * @param cls unused
1618  * @param tc unused
1619  */
1620 static void
1621 shutdown_task (void *cls,
1622                const struct GNUNET_SCHEDULER_TaskContext *tc)
1623 {
1624   LOG (GNUNET_ERROR_TYPE_DEBUG, "RPS is going down\n");
1625
1626   if ( NULL != do_round_task )
1627   {
1628     GNUNET_SCHEDULER_cancel (do_round_task);
1629     do_round_task = NULL;
1630   }
1631
1632
1633   {
1634   if (GNUNET_SYSERR ==
1635         GNUNET_CONTAINER_multipeermap_iterate (peer_map, peer_remove_cb, NULL))
1636     LOG (GNUNET_ERROR_TYPE_WARNING,
1637         "Iterating over peers to disconnect from them was cancelled\n");
1638   }
1639
1640   GNUNET_NSE_disconnect (nse);
1641   GNUNET_CADET_disconnect (cadet_handle);
1642   RPS_sampler_destroy (prot_sampler);
1643   RPS_sampler_destroy (client_sampler);
1644   GNUNET_break (0 == GNUNET_CONTAINER_multipeermap_size (peer_map));
1645   GNUNET_CONTAINER_multipeermap_destroy (peer_map);
1646   GNUNET_array_grow (gossip_list, gossip_list_size, 0);
1647   GNUNET_array_grow (push_list, push_list_size, 0);
1648   GNUNET_array_grow (pull_list, pull_list_size, 0);
1649 }
1650
1651
1652 /**
1653  * A client disconnected.  Remove all of its data structure entries.
1654  *
1655  * @param cls closure, NULL
1656  * @param client identification of the client
1657  */
1658 static void
1659 handle_client_disconnect (void *cls,
1660                           struct GNUNET_SERVER_Client * client)
1661 {
1662 }
1663
1664
1665 /**
1666  * Handle the channel a peer opens to us.
1667  *
1668  * @param cls The closure
1669  * @param channel The channel the peer wants to establish
1670  * @param initiator The peer's peer ID
1671  * @param port The port the channel is being established over
1672  * @param options Further options
1673  */
1674   static void *
1675 handle_inbound_channel (void *cls,
1676                         struct GNUNET_CADET_Channel *channel,
1677                         const struct GNUNET_PeerIdentity *initiator,
1678                         uint32_t port,
1679                         enum GNUNET_CADET_ChannelOption options)
1680 {
1681   struct PeerContext *peer_ctx;
1682
1683   LOG (GNUNET_ERROR_TYPE_DEBUG,
1684       "New channel was established to us (Peer %s).\n",
1685       GNUNET_i2s (initiator));
1686
1687   GNUNET_assert (NULL != channel);
1688
1689   // we might not even store the recv_channel
1690
1691   peer_ctx = get_peer_ctx (peer_map, initiator);
1692   // FIXME what do we do if a channel is established twice?
1693   //       overwrite? Clean old channel? ...?
1694   //if (NULL != peer_ctx->recv_channel)
1695   //{
1696   //  peer_ctx->recv_channel = channel;
1697   //}
1698   peer_ctx->recv_channel = channel;
1699
1700   peer_ctx->mq = NULL;
1701
1702   (void) GNUNET_CONTAINER_multipeermap_put (peer_map, initiator, peer_ctx,
1703       GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
1704
1705   peer_is_live (peer_ctx);
1706
1707   return NULL; // TODO
1708 }
1709
1710
1711 /**
1712  * This is called when a remote peer destroys a channel.
1713  *
1714  * @param cls The closure
1715  * @param channel The channel being closed
1716  * @param channel_ctx The context associated with this channel
1717  */
1718   static void
1719 cleanup_channel (void *cls,
1720                 const struct GNUNET_CADET_Channel *channel,
1721                 void *channel_ctx)
1722 {
1723   struct GNUNET_PeerIdentity *peer;
1724   struct PeerContext *peer_ctx;
1725
1726   peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1727       (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1728        // Guess simply casting isn't the nicest way...
1729        // FIXME wait for cadet to change this function
1730   LOG (GNUNET_ERROR_TYPE_DEBUG, "Cleaning up channel to peer %s\n",
1731        GNUNET_i2s (peer));
1732
1733   if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
1734   {
1735     peer_ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
1736
1737     if (NULL == peer_ctx) /* It could have been removed by shutdown_task */
1738       return;
1739
1740     if (channel == peer_ctx->send_channel)
1741     { /* Peer probably went down */
1742       rem_from_list (&gossip_list, &gossip_list_size, peer);
1743       rem_from_list (&pending_pull_reply_list, &pending_pull_reply_list_size, peer);
1744
1745       /* Somwewhat {ab,re}use the iterator function */
1746       /* Cast to void is ok, because it's used as void in peer_remove_cb */
1747       (void) peer_remove_cb ((void *) channel, peer, peer_ctx);
1748     }
1749     else
1750       peer_ctx->recv_channel = NULL;
1751   }
1752 }
1753
1754
1755 /**
1756  * Actually start the service.
1757  */
1758   static void
1759 rps_start (struct GNUNET_SERVER_Handle *server)
1760 {
1761   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1762     {&handle_client_request, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST,
1763       sizeof (struct GNUNET_RPS_CS_RequestMessage)},
1764     {&handle_client_seed,    NULL, GNUNET_MESSAGE_TYPE_RPS_CS_SEED, 0},
1765     {NULL, NULL, 0, 0}
1766   };
1767
1768   GNUNET_SERVER_add_handlers (server, handlers);
1769   GNUNET_SERVER_disconnect_notify (server,
1770                                    &handle_client_disconnect,
1771                                    NULL);
1772   LOG (GNUNET_ERROR_TYPE_DEBUG, "Ready to receive requests from clients\n");
1773
1774
1775   num_hist_update_tasks = 0;
1776
1777   do_round_task = GNUNET_SCHEDULER_add_now (&do_round, NULL);
1778   LOG (GNUNET_ERROR_TYPE_DEBUG, "Scheduled first round\n");
1779
1780   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1781                                 &shutdown_task,
1782                                 NULL);
1783 }
1784
1785
1786 /**
1787  * Process statistics requests.
1788  *
1789  * @param cls closure
1790  * @param server the initialized server
1791  * @param c configuration to use
1792  */
1793   static void
1794 run (void *cls,
1795      struct GNUNET_SERVER_Handle *server,
1796      const struct GNUNET_CONFIGURATION_Handle *c)
1797 {
1798   // TODO check what this does -- copied from gnunet-boss
1799   // - seems to work as expected
1800   GNUNET_log_setup ("rps", GNUNET_error_type_to_string (GNUNET_ERROR_TYPE_DEBUG), NULL);
1801   cfg = c;
1802
1803
1804   /* Get own ID */
1805   GNUNET_CRYPTO_get_peer_identity (cfg, &own_identity); // TODO check return value
1806   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1807               "STARTING SERVICE (rps) for peer [%s]\n",
1808               GNUNET_i2s (&own_identity));
1809
1810
1811   /* Get time interval from the configuration */
1812   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, "RPS",
1813                                                         "ROUNDINTERVAL",
1814                                                         &round_interval))
1815   {
1816     LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read ROUNDINTERVAL from config\n");
1817     GNUNET_SCHEDULER_shutdown ();
1818     return;
1819   }
1820
1821   /* Get initial size of sampler/gossip list from the configuration */
1822   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, "RPS",
1823                                                          "INITSIZE",
1824                                                          (long long unsigned int *) &sampler_size_est_need))
1825   {
1826     LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read INITSIZE from config\n");
1827     GNUNET_SCHEDULER_shutdown ();
1828     return;
1829   }
1830   LOG (GNUNET_ERROR_TYPE_DEBUG, "INITSIZE is %" PRIu64 "\n", sampler_size_est_need);
1831
1832
1833   gossip_list = NULL;
1834
1835
1836   /* connect to NSE */
1837   nse = GNUNET_NSE_connect (cfg, nse_callback, NULL);
1838   // TODO check whether that was successful
1839   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to NSE\n");
1840
1841
1842   alpha = 0.45;
1843   beta  = 0.45;
1844
1845   peer_map = GNUNET_CONTAINER_multipeermap_create (sampler_size_est_need, GNUNET_NO);
1846
1847
1848   /* Initialise cadet */
1849   static const struct GNUNET_CADET_MessageHandler cadet_handlers[] = {
1850     {&handle_peer_push        , GNUNET_MESSAGE_TYPE_RPS_PP_PUSH        ,
1851       sizeof (struct GNUNET_MessageHeader)},
1852     {&handle_peer_pull_request, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST,
1853       sizeof (struct GNUNET_MessageHeader)},
1854     {&handle_peer_pull_reply  , GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY  , 0},
1855     {NULL, 0, 0}
1856   };
1857
1858   const uint32_t ports[] = {GNUNET_RPS_CADET_PORT, 0}; // _PORT specified in src/rps/rps.h
1859   cadet_handle = GNUNET_CADET_connect (cfg,
1860                                        cls,
1861                                        &handle_inbound_channel,
1862                                        &cleanup_channel,
1863                                        cadet_handlers,
1864                                        ports);
1865   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to CADET\n");
1866
1867
1868   /* Initialise sampler */
1869   struct GNUNET_TIME_Relative half_round_interval;
1870   struct GNUNET_TIME_Relative  max_round_interval;
1871
1872   half_round_interval = GNUNET_TIME_relative_multiply (round_interval, .5);
1873   max_round_interval = GNUNET_TIME_relative_add (round_interval, half_round_interval);
1874
1875   prot_sampler =   RPS_sampler_init (sampler_size_est_need, max_round_interval);
1876   client_sampler = RPS_sampler_init (sampler_size_est_need, max_round_interval);
1877
1878   /* Initialise push and pull maps */
1879   push_list = NULL;
1880   push_list_size = 0;
1881   pull_list = NULL;
1882   pull_list_size = 0;
1883   pending_pull_reply_list = NULL;
1884   pending_pull_reply_list_size = 0;
1885
1886
1887   LOG (GNUNET_ERROR_TYPE_DEBUG, "Requesting peers from CADET\n");
1888   GNUNET_CADET_get_peers (cadet_handle, &init_peer_cb, server);
1889
1890   // TODO send push/pull to each of those peers?
1891 }
1892
1893
1894 /**
1895  * The main function for the rps service.
1896  *
1897  * @param argc number of arguments from the command line
1898  * @param argv command line arguments
1899  * @return 0 ok, 1 on error
1900  */
1901   int
1902 main (int argc, char *const *argv)
1903 {
1904   return (GNUNET_OK ==
1905           GNUNET_SERVICE_run (argc,
1906                               argv,
1907                               "rps",
1908                               GNUNET_SERVICE_OPTION_NONE,
1909                               &run, NULL)) ? 0 : 1;
1910 }
1911
1912 /* end of gnunet-service-rps.c */