c34569ace0ff22671b3f7bda3eb3a2dde6185405
[oweals/gnunet.git] / src / rps / gnunet-service-rps.c
1 /*
2      This file is part of GNUnet.
3      (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 take care that messages are not longer than 64k
42
43 // TODO check for overflows
44
45 // TODO align message structs
46
47 // (TODO api -- possibility of getting weak random peer immideately)
48
49 // TODO malicious peer
50
51 // TODO Change API to accept initialisation peers
52
53 // TODO Change API to accept good peers 'friends'
54
55 // TODO store peers somewhere
56
57 // TODO check that every id we get is valid - is it reachable?
58
59 // TODO ignore list
60
61 // hist_size_init, hist_size_max
62
63 /**
64  * Our configuration.
65  */
66 static const struct GNUNET_CONFIGURATION_Handle *cfg;
67
68 /**
69  * Our own identity.
70  */
71 static struct GNUNET_PeerIdentity *own_identity;
72
73 /**
74  * Closure to the callback cadet calls on each peer it passes to us
75  */
76 struct init_peer_cls
77 {
78   /**
79    * The server handle to later listen to client requests
80    */
81   struct GNUNET_SERVER_Handle *server;
82
83   /**
84    * Counts how many peers cadet already passed to us
85    */
86   uint32_t i;
87 };
88
89
90   struct GNUNET_PeerIdentity *
91 get_rand_peer (const struct GNUNET_PeerIdentity *peer_list, unsigned int size);
92
93
94 /***********************************************************************
95  * Housekeeping with peers
96 ***********************************************************************/
97
98 /**
99  * Struct used to store the context of a connected client.
100  */
101 struct client_ctx
102 {
103   /**
104    * The message queue to communicate with the client.
105    */
106   struct GNUNET_MQ_Handle *mq;
107 };
108
109 /**
110  * Used to keep track in what lists single peerIDs are.
111  */
112 enum in_list_flag // probably unneeded
113 {
114   in_other_sampler_list = 0x1,
115   in_other_gossip_list  = 0x2, // unneeded?
116   in_own_sampler_list   = 0x4,
117   in_own_gossip_list    = 0x8 // unneeded?
118 };
119
120 /**
121  * Struct used to keep track of other peer's status
122  *
123  * This is stored in a multipeermap.
124  */
125 struct peer_context
126 {
127   /**
128    * In own gossip/sampler list, in other's gossip/sampler list
129    */
130   uint32_t in_flags; // unneeded?
131
132   /**
133    * Message queue open to client
134    */
135   struct GNUNET_MQ_Handle *mq;
136
137   /**
138    * Channel open to client.
139    */
140   struct GNUNET_CADET_Channel *to_channel;
141
142   /**
143    * Channel open from client.
144    */
145   struct GNUNET_CADET_Channel *from_channel; // unneeded
146
147   /**
148    * This is pobably followed by 'statistical' data (when we first saw
149    * him, how did we get his ID, how many pushes (in a timeinterval),
150    * ...)
151    */
152 };
153
154 /***********************************************************************
155  * /Housekeeping with peers
156 ***********************************************************************/
157
158 /***********************************************************************
159  * Globals
160 ***********************************************************************/
161
162 /**
163  * Set of all peers to keep track of them.
164  */
165 static struct GNUNET_CONTAINER_MultiPeerMap *peer_map;
166
167
168 /**
169  * The gossiped list of peers.
170  */
171 static struct GNUNET_PeerIdentity *gossip_list;
172
173 /**
174  * Size of the gossiped list
175  */
176 //static unsigned int gossip_list_size;
177 static uint32_t gossip_list_size;
178
179
180 /**
181  * The actual size of the sampler
182  */
183 static unsigned int sampler_size;
184 //size_t sampler_size;
185
186 /**
187  * The size of sampler we need to be able to satisfy the client's need of
188  * random peers.
189  */
190 static unsigned int sampler_size_client_need;
191
192 /**
193  * The size of sampler we need to be able to satisfy the Brahms protocol's
194  * need of random peers.
195  *
196  * This is directly taken as the #gossip_list_size on update of the
197  * #gossip_list
198  *
199  * This is one minimum size the sampler grows to.
200  */
201 static unsigned int sampler_size_est_need;
202
203
204 /**
205  * Percentage of total peer number in the gossip list
206  * to send random PUSHes to
207  *
208  * TODO do not read from configuration
209  */
210 static float alpha;
211
212 /**
213  * Percentage of total peer number in the gossip list
214  * to send random PULLs to
215  *
216  * TODO do not read from configuration
217  */
218 static float beta;
219
220 /**
221  * The percentage gamma of history updates.
222  * Simply 1 - alpha - beta
223  */
224
225
226 /**
227  * Identifier for the main task that runs periodically.
228  */
229 static struct GNUNET_SCHEDULER_Task * do_round_task;
230
231 /**
232  * Time inverval the do_round task runs in.
233  */
234 static struct GNUNET_TIME_Relative round_interval;
235
236
237
238 /**
239  * List to store peers received through pushes temporary.
240  *
241  * TODO -> multipeermap
242  */
243 static struct GNUNET_PeerIdentity *push_list;
244
245 /**
246  * Size of the push_list;
247  */
248 static unsigned int push_list_size;
249 //size_t push_list_size;
250
251 /**
252  * List to store peers received through pulls temporary.
253  *
254  * TODO -> multipeermap
255  */
256 static struct GNUNET_PeerIdentity *pull_list;
257
258 /**
259  * Size of the pull_list;
260  */
261 static unsigned int pull_list_size;
262 //size_t pull_list_size;
263
264
265 /**
266  * Handler to NSE.
267  */
268 static struct GNUNET_NSE_Handle *nse;
269
270 /**
271  * Handler to CADET.
272  */
273 static struct GNUNET_CADET_Handle *cadet_handle;
274
275
276 /**
277  * Request counter.
278  *
279  * Only needed in the beginning to check how many of the 64 deltas
280  * we already have
281  */
282 static unsigned int req_counter;
283
284 /**
285  * Time of the last request we received.
286  *
287  * Used to compute the expected request rate.
288  */
289 static struct GNUNET_TIME_Absolute last_request;
290
291 /**
292  * Size of #request_deltas.
293  */
294 #define REQUEST_DELTAS_SIZE 64
295 static unsigned int request_deltas_size = REQUEST_DELTAS_SIZE;
296
297 /**
298  * Last 64 deltas between requests
299  */
300 static struct GNUNET_TIME_Relative request_deltas[REQUEST_DELTAS_SIZE];
301
302 /**
303  * The prediction of the rate of requests
304  */
305 static struct GNUNET_TIME_Relative  request_rate;
306
307
308 /***********************************************************************
309  * /Globals
310 ***********************************************************************/
311
312
313 /***********************************************************************
314  * Util functions
315 ***********************************************************************/
316
317 /**
318  * Check if peer is already in peer array.
319  */
320   int
321 in_arr (const struct GNUNET_PeerIdentity *array,
322         unsigned int arr_size,
323         const struct GNUNET_PeerIdentity *peer)
324 {
325   GNUNET_assert (NULL != peer);
326
327   if (0 == arr_size)
328     return GNUNET_NO;
329
330   GNUNET_assert (NULL != array);
331
332   unsigned int i;
333
334   i = 0;
335   while (0 != GNUNET_CRYPTO_cmp_peer_identity (&array[i], peer) &&
336          i < arr_size)
337     i++;
338
339   if (i == arr_size)
340     return GNUNET_NO;
341   else
342     return GNUNET_YES;
343 }
344
345
346 /**
347  * Get random peer from the gossip list.
348  */
349   struct GNUNET_PeerIdentity *
350 get_rand_peer(const struct GNUNET_PeerIdentity *peer_list, unsigned int list_size)
351 {
352   uint64_t r_index;
353   struct GNUNET_PeerIdentity *peer;
354
355   peer = GNUNET_new(struct GNUNET_PeerIdentity);
356   // FIXME if we have only NULL in gossip list this will block
357   // but then we might have a problem nevertheless
358
359   do
360   {
361
362     /**;
363      * Choose the r_index of the peer we want to return
364      * at random from the interval of the gossip list
365      */
366     r_index = GNUNET_CRYPTO_random_u64(GNUNET_CRYPTO_QUALITY_STRONG,
367                                      list_size);
368
369     *peer = peer_list[r_index];
370   } while (NULL == peer);
371
372   return peer;
373 }
374
375
376 /**
377  * Get the context of a peer. If not existing, create.
378  */
379   struct peer_context *
380 get_peer_ctx (struct GNUNET_CONTAINER_MultiPeerMap *peer_map, const struct GNUNET_PeerIdentity *peer)
381 {
382   struct peer_context *ctx;
383
384   if ( GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
385   {
386     ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
387   }
388   else
389   {
390     ctx = GNUNET_new (struct peer_context);
391     ctx->in_flags = 0;
392     ctx->mq = NULL;
393     ctx->to_channel = NULL;
394     ctx->from_channel = NULL;
395     (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
396   }
397   return ctx;
398 }
399
400
401 /**
402  * Get the channel of a peer. If not existing, create.
403  */
404   struct GNUNET_CADET_Channel *
405 get_channel (struct GNUNET_CONTAINER_MultiPeerMap *peer_map, const struct GNUNET_PeerIdentity *peer)
406 {
407   struct peer_context *ctx;
408
409   ctx = get_peer_ctx (peer_map, peer);
410   if (NULL == ctx->to_channel)
411   {
412     ctx->to_channel = GNUNET_CADET_channel_create (cadet_handle, NULL, peer,
413                                                    GNUNET_RPS_CADET_PORT,
414                                                    GNUNET_CADET_OPTION_RELIABLE);
415     // do I have to explicitly put it in the peer_map?
416     (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx,
417                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
418   }
419   return ctx->to_channel;
420 }
421
422
423 /**
424  * Get the message queue of a specific peer.
425  *
426  * If we already have a message queue open to this client,
427  * simply return it, otherways create one.
428  */
429   struct GNUNET_MQ_Handle *
430 get_mq (struct GNUNET_CONTAINER_MultiPeerMap *peer_map, const struct GNUNET_PeerIdentity *peer_id)
431 {
432   struct peer_context *ctx;
433
434   ctx = get_peer_ctx (peer_map, peer_id);
435   if (NULL == ctx->mq)
436   {
437     (void) get_channel (peer_map, peer_id);
438     ctx->mq = GNUNET_CADET_mq_create (ctx->to_channel);
439     //do I have to explicitly put it in the peer_map?
440     (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer_id, ctx,
441                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
442   }
443   return ctx->mq;
444 }
445
446
447 /**
448  * Sum all time relatives of an array.
449   */
450   struct GNUNET_TIME_Relative
451 T_relative_sum (const struct GNUNET_TIME_Relative *rel_array, uint64_t arr_size)
452 {
453   struct GNUNET_TIME_Relative sum;
454   uint64_t i;
455
456   sum = GNUNET_TIME_UNIT_ZERO;
457   for ( i = 0 ; i < arr_size ; i++ )
458   {
459     sum = GNUNET_TIME_relative_add (sum, rel_array[i]);
460   }
461   return sum;
462 }
463
464
465 /**
466  * Compute the average of given time relatives.
467  */
468   struct GNUNET_TIME_Relative
469 T_relative_avg (const struct GNUNET_TIME_Relative *rel_array, uint64_t arr_size)
470 {
471   return GNUNET_TIME_relative_divide (T_relative_sum (rel_array, arr_size), arr_size); // FIXME find a way to devide that by arr_size
472 }
473
474
475 /***********************************************************************
476  * /Util functions
477 ***********************************************************************/
478
479 /**
480  * Wrapper around _sampler_resize()
481  */
482   void
483 resize_wrapper()
484 {
485   uint64_t bigger_size;
486
487   // TODO statistics
488
489   if (sampler_size_est_need > sampler_size_client_need)
490     bigger_size = sampler_size_client_need;
491   else
492     bigger_size = sampler_size_est_need;
493
494   // TODO respect the request rate, min, max
495   if (sampler_size > bigger_size*4)
496   { /* Shrinking */
497     RPS_sampler_resize (sampler_size/2);
498   }
499   else if (sampler_size < bigger_size)
500   { /* Growing */
501     RPS_sampler_resize (sampler_size*2);
502   }
503 }
504
505
506 /**
507  * Function called by NSE.
508  *
509  * Updates sizes of sampler list and gossip list and adapt those lists
510  * accordingly.
511  */
512   void
513 nse_callback(void *cls, struct GNUNET_TIME_Absolute timestamp, double logestimate, double std_dev)
514 {
515   double estimate;
516   //double scale; // TODO this might go gloabal/config
517
518   LOG (GNUNET_ERROR_TYPE_DEBUG,
519       "Received a ns estimate - logest: %f, std_dev: %f (old_size: %f)\n",
520       logestimate, std_dev, sampler_size);
521   //scale = .01;
522   estimate = GNUNET_NSE_log_estimate_to_n (logestimate);
523   // GNUNET_NSE_log_estimate_to_n (logestimate);
524   estimate = pow (estimate, 1./3);
525   // TODO add if std_dev is a number
526   // estimate += (std_dev * scale);
527   if ( 0 < estimate ) {
528     LOG (GNUNET_ERROR_TYPE_DEBUG, "Changing estimate to %f\n", estimate);
529     sampler_size_est_need = estimate;
530   } else
531     LOG (GNUNET_ERROR_TYPE_DEBUG, "Not using estimate %f\n", estimate);
532
533   /* If the NSE has changed adapt the lists accordingly */
534   resize_wrapper ();
535 }
536
537
538 /**
539  * Callback called once the requested PeerIDs are ready.
540  *
541  * Sends those to the requesting client.
542  */
543 void client_respond (void *cls,
544     struct GNUNET_PeerIdentity *ids, uint64_t num_peers)
545 {
546   struct GNUNET_MQ_Envelope *ev;
547   struct GNUNET_RPS_CS_ReplyMessage *out_msg;
548   struct GNUNET_SERVER_Client *client;
549   struct client_ctx *cli_ctx;
550
551   client = (struct GNUNET_SERVER_Client *) cls;
552
553   ev = GNUNET_MQ_msg_extra (out_msg,
554                             num_peers * sizeof (struct GNUNET_PeerIdentity),
555                             GNUNET_MESSAGE_TYPE_RPS_CS_REPLY);
556   out_msg->num_peers = GNUNET_htonll (num_peers);
557
558   memcpy(&out_msg[1],
559       ids,
560       num_peers * sizeof (struct GNUNET_PeerIdentity));
561   GNUNET_free (ids);
562   
563   cli_ctx = GNUNET_SERVER_client_get_user_context (client, struct client_ctx);
564   if ( NULL == cli_ctx ) {
565     cli_ctx = GNUNET_new (struct client_ctx);
566     cli_ctx->mq = GNUNET_MQ_queue_for_server_client (client);
567     GNUNET_SERVER_client_set_user_context (client, cli_ctx);
568   }
569   
570   GNUNET_MQ_send (cli_ctx->mq, ev);
571 }
572
573
574 /**
575  * Handle RPS request from the client.
576  *
577  * @param cls closure
578  * @param client identification of the client
579  * @param message the actual message
580  */
581 static void
582 handle_client_request (void *cls,
583             struct GNUNET_SERVER_Client *client,
584             const struct GNUNET_MessageHeader *message)
585 {
586   LOG(GNUNET_ERROR_TYPE_DEBUG, "Client requested (a) random peer(s).\n");
587
588   struct GNUNET_RPS_CS_RequestMessage *msg;
589   uint64_t num_peers;
590   struct GNUNET_TIME_Relative max_round_duration;
591
592
593   /* Estimate request rate */
594   if (request_deltas_size > req_counter)
595     req_counter++;
596   if ( 1 < req_counter)
597   {
598     /* Shift last request deltas to the right */
599     memcpy (&request_deltas[1],
600         request_deltas,
601         (req_counter - 1) * sizeof (struct GNUNET_TIME_Relative));
602     /* Add current delta to beginning */
603     request_deltas[0] = GNUNET_TIME_absolute_get_difference (last_request,
604         GNUNET_TIME_absolute_get ());
605     request_rate = T_relative_avg (request_deltas, req_counter);
606
607     max_round_duration = GNUNET_TIME_relative_add (round_interval,
608         GNUNET_TIME_relative_divide (round_interval, 2));
609     sampler_size_client_need = max_round_duration.rel_value_us / request_rate.rel_value_us;
610
611     resize_wrapper();
612   }
613   last_request = GNUNET_TIME_absolute_get ();
614
615
616   // TODO check message size
617   msg = (struct GNUNET_RPS_CS_RequestMessage *) message;
618
619   num_peers = ntohl (msg->num_peers);
620
621   RPS_sampler_get_n_rand_peers (client_respond, client, num_peers);
622
623   GNUNET_SERVER_receive_done (client,
624                               GNUNET_OK);
625 }
626
627
628 /**
629  * Handle seed from the client.
630  *
631  * @param cls closure
632  * @param client identification of the client
633  * @param message the actual message
634  */
635   static void
636 handle_client_seed (void *cls,
637             struct GNUNET_SERVER_Client *client,
638             const struct GNUNET_MessageHeader *message)
639 {
640   struct GNUNET_RPS_CS_SeedMessage *in_msg;
641   struct GNUNET_PeerIdentity *peers;
642   uint64_t i;
643
644   if (sizeof (struct GNUNET_RPS_CS_SeedMessage) < ntohs (message->size))
645   {
646     GNUNET_break_op (0);
647     GNUNET_SERVER_receive_done (client,
648               GNUNET_SYSERR);
649   }
650   in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
651   if (ntohs (message->size) - sizeof (struct GNUNET_RPS_CS_SeedMessage) /
652       sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
653   {
654     GNUNET_break_op (0);
655     GNUNET_SERVER_receive_done (client,
656               GNUNET_SYSERR);
657   }
658
659   in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
660   peers = (struct GNUNET_PeerIdentity *) &message[1];
661
662   for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
663     RPS_sampler_update_list (&peers[i]);
664
665   GNUNET_SERVER_receive_done (client,
666                               GNUNET_OK);
667 }
668
669
670 /**
671  * Handle a PUSH message from another peer.
672  *
673  * Check the proof of work and store the PeerID
674  * in the temporary list for pushed PeerIDs.
675  *
676  * @param cls Closure
677  * @param channel The channel the PUSH was received over
678  * @param channel_ctx The context associated with this channel
679  * @param msg The message header
680  */
681 static int
682 handle_peer_push (void *cls,
683     struct GNUNET_CADET_Channel *channel,
684     void **channel_ctx,
685     const struct GNUNET_MessageHeader *msg)
686 {
687   const struct GNUNET_PeerIdentity *peer;
688
689   // (check the proof of work) 
690   
691   if (ntohs(msg->size) != sizeof (struct GNUNET_MessageHeader))
692   {
693     GNUNET_break_op (0);
694     return GNUNET_SYSERR;
695   }
696
697   peer = (const struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel, GNUNET_CADET_OPTION_PEER);
698   // FIXME wait for cadet to change this function
699   LOG (GNUNET_ERROR_TYPE_DEBUG, "PUSH received (%s)\n", GNUNET_i2s (peer));
700   
701   /* Add the sending peer to the push_list */
702   if (GNUNET_NO == in_arr (push_list, pull_list_size, peer))
703     GNUNET_array_append (push_list, push_list_size, *peer);
704
705   return GNUNET_OK;
706 }
707
708 /**
709  * Handle PULL REQUEST request message from another peer.
710  *
711  * Reply with the gossip list of PeerIDs.
712  *
713  * @param cls Closure
714  * @param channel The channel the PUSH was received over
715  * @param channel_ctx The context associated with this channel
716  * @param msg The message header
717  */
718 static int
719 handle_peer_pull_request (void *cls,
720     struct GNUNET_CADET_Channel *channel,
721     void **channel_ctx,
722     const struct GNUNET_MessageHeader *msg)
723 {
724   struct GNUNET_PeerIdentity *peer;
725   struct GNUNET_MQ_Handle *mq;
726   struct GNUNET_MQ_Envelope *ev;
727   struct GNUNET_RPS_P2P_PullReplyMessage *out_msg;
728
729
730   if (ntohs(msg->size) != sizeof (struct GNUNET_MessageHeader))
731   {
732     GNUNET_break_op (0); // At the moment our own implementation seems to break that.
733     return GNUNET_SYSERR;
734   }
735
736   peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel, GNUNET_CADET_OPTION_PEER);
737   // FIXME wait for cadet to change this function
738   LOG (GNUNET_ERROR_TYPE_DEBUG,
739       "PULL REQUEST from peer %s received, going to send %u peers\n",
740       GNUNET_i2s (peer), gossip_list_size);
741
742   mq = get_mq (peer_map, peer);
743
744   ev = GNUNET_MQ_msg_extra (out_msg,
745                            gossip_list_size * sizeof (struct GNUNET_PeerIdentity),
746                            GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY);
747   //out_msg->num_peers = GNUNET_htonll (gossip_list_size);
748   out_msg->num_peers = htonl (gossip_list_size);
749   memcpy (&out_msg[1], gossip_list,
750          gossip_list_size * sizeof (struct GNUNET_PeerIdentity));
751
752   GNUNET_MQ_send (mq, ev);
753
754   return GNUNET_OK;
755 }
756
757 /**
758  * Handle PULL REPLY message from another peer.
759  *
760  * Check whether we sent a corresponding request and
761  * whether this reply is the first one.
762  *
763  * @param cls Closure
764  * @param channel The channel the PUSH was received over
765  * @param channel_ctx The context associated with this channel
766  * @param msg The message header
767  */
768 static int
769 handle_peer_pull_reply (void *cls,
770     struct GNUNET_CADET_Channel *channel,
771     void **channel_ctx,
772     const struct GNUNET_MessageHeader *msg)
773 {
774   LOG (GNUNET_ERROR_TYPE_DEBUG, "PULL REPLY received\n");
775
776   struct GNUNET_RPS_P2P_PullReplyMessage *in_msg;
777   struct GNUNET_PeerIdentity *peers;
778   uint64_t i;
779
780   if (sizeof (struct GNUNET_RPS_P2P_PullReplyMessage) > ntohs (msg->size))
781   {
782     GNUNET_break_op (0); // At the moment our own implementation seems to break that.
783     return GNUNET_SYSERR;
784   }
785   in_msg = (struct GNUNET_RPS_P2P_PullReplyMessage *) msg;
786   if ((ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
787   {
788     LOG (GNUNET_ERROR_TYPE_ERROR, "message says it sends %" PRIu64 " peers, have space for %i peers\n",
789         ntohl (in_msg->num_peers),
790         (ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity));
791     GNUNET_break_op (0);
792     return GNUNET_SYSERR;
793   }
794
795   // TODO check that we sent a request and that it is the first reply
796
797   peers = (struct GNUNET_PeerIdentity *) &msg[1];
798   for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
799   {
800     if (GNUNET_NO == in_arr (pull_list, pull_list_size, &peers[i]))
801       GNUNET_array_append (pull_list, pull_list_size, peers[i]);
802   }
803
804   // TODO check that id is valid - whether it is reachable
805
806   return GNUNET_OK;
807 }
808
809
810 /**
811  * Send out PUSHes and PULLs.
812  *
813  * This is executed regylary.
814  */
815 static void
816 do_round (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
817 {
818   LOG(GNUNET_ERROR_TYPE_DEBUG, "Going to execute next round\n");
819
820   uint64_t i;
821   //unsigned int *n_arr;
822   unsigned int n_peers; /* Number of peers we send pushes/pulls to */
823   struct GNUNET_MessageHeader *push_msg;
824   struct GNUNET_MessageHeader *pull_msg;
825   struct GNUNET_MQ_Envelope *ev;
826   const struct GNUNET_PeerIdentity *peer;
827   struct GNUNET_MQ_Handle *mq;
828
829   // TODO log lists, ...
830
831
832   /* Would it make sense to have one shuffeled gossip list and then
833    * to send PUSHes to first alpha peers, PULL requests to next beta peers and
834    * use the rest to update sampler?
835    * in essence get random peers with consumption */
836
837   /* Send PUSHes */
838   //n_arr = GNUNET_CRYPTO_random_permute(GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) gossip_list_size);
839   n_peers = round (alpha * gossip_list_size);
840   if (0 == n_peers)
841     n_peers = 1;
842   LOG(GNUNET_ERROR_TYPE_DEBUG, "Going to send pushes to %u (%f * %u) peers.\n",
843       n_peers, alpha, gossip_list_size);
844   for ( i = 0 ; i < n_peers ; i++ )
845   {
846     peer = get_rand_peer (gossip_list, gossip_list_size);
847     if (own_identity != peer)
848     { // FIXME if this fails schedule/loop this for later
849       LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PUSH to peer %s of gossiped list.\n", GNUNET_i2s (peer));
850
851       ev = GNUNET_MQ_msg (push_msg, GNUNET_MESSAGE_TYPE_RPS_PP_PUSH);
852       // FIXME sometimes it returns a pointer to a freed mq
853       mq = get_mq (peer_map, peer);
854       GNUNET_MQ_send (mq, ev);
855     }
856   }
857
858
859   /* Send PULL requests */
860   //n_arr = GNUNET_CRYPTO_random_permute(GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) sampler_list->size);
861   n_peers = round (beta * gossip_list_size);
862   if (0 == n_peers)
863     n_peers = 1;
864   LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to send pulls to %u (%f * %u) peers.\n",
865       n_peers, beta, gossip_list_size);
866   for ( i = 0 ; i < n_peers ; i++ )
867   {
868     peer = get_rand_peer (gossip_list, gossip_list_size);
869     if (own_identity != peer)
870     { // FIXME if this fails schedule/loop this for later
871       LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PULL request to peer %s of gossiped list.\n", GNUNET_i2s (peer));
872
873       ev = GNUNET_MQ_msg (pull_msg, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST);
874       //pull_msg = NULL;
875       mq = get_mq (peer_map, peer);
876       GNUNET_MQ_send (mq, ev);
877     }
878   }
879
880
881   /* Update gossip list */
882   uint64_t r_index;
883
884   if ( push_list_size <= alpha * gossip_list_size &&
885        push_list_size != 0 &&
886        pull_list_size != 0 )
887   {
888     LOG(GNUNET_ERROR_TYPE_DEBUG, "Update of the gossip list. ()\n");
889
890     uint64_t first_border;
891     uint64_t second_border;
892     
893     GNUNET_array_grow (gossip_list, gossip_list_size, sampler_size_est_need);
894
895     first_border = round (alpha * gossip_list_size);
896     for ( i = 0 ; i < first_border ; i++ )
897     { // TODO use RPS_sampler_get_n_rand_peers
898       /* Update gossip list with peers received through PUSHes */
899       r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
900                                        push_list_size);
901       gossip_list[i] = push_list[r_index];
902       // TODO change the in_flags accordingly
903     }
904
905     second_border = first_border + round(beta * gossip_list_size);
906     for ( i = first_border ; i < second_border ; i++ )
907     {
908       /* Update gossip list with peers received through PULLs */
909       r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
910                                        pull_list_size);
911       gossip_list[i] = pull_list[r_index];
912       // TODO change the in_flags accordingly
913     }
914
915     for ( i = second_border ; i < gossip_list_size ; i++ )
916     {
917       /* Update gossip list with peers from history */
918       peer = RPS_sampler_get_n_rand_peers_ (1);
919       gossip_list[i] = *peer;
920       // TODO change the in_flags accordingly
921     }
922
923   }
924   else
925   {
926     LOG(GNUNET_ERROR_TYPE_DEBUG, "No update of the gossip list. ()\n");
927   }
928   // TODO independent of that also get some peers from CADET_get_peers()?
929
930
931   /* Update samplers */
932
933   for ( i = 0 ; i < push_list_size ; i++ )
934   {
935     RPS_sampler_update_list (&push_list[i]);
936     // TODO set in_flag?
937   }
938
939   for ( i = 0 ; i < pull_list_size ; i++ )
940   {
941     RPS_sampler_update_list (&pull_list[i]);
942     // TODO set in_flag?
943   }
944
945
946   /* Empty push/pull lists */
947   GNUNET_array_grow (push_list, push_list_size, 0);
948   GNUNET_array_grow (pull_list, pull_list_size, 0);
949
950   struct GNUNET_TIME_Relative time_next_round;
951   struct GNUNET_TIME_Relative half_round_interval;
952   unsigned int rand_delay;
953
954   /* Compute random time value between .5 * round_interval and 1.5 *round_interval */
955   half_round_interval = GNUNET_TIME_relative_divide (round_interval, 2);
956   do
957   {
958   /*
959    * Compute random value between (0 and 1) * round_interval
960    * via multiplying round_interval with a 'fraction' (0 to value)/value
961    */
962   rand_delay = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, UINT_MAX/10);
963   time_next_round = GNUNET_TIME_relative_multiply (round_interval,  rand_delay);
964   time_next_round = GNUNET_TIME_relative_divide   (time_next_round, UINT_MAX/10);
965   time_next_round = GNUNET_TIME_relative_add      (time_next_round, half_round_interval);
966   } while (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == time_next_round.rel_value_us);
967
968   /* Schedule next round */
969   do_round_task = GNUNET_SCHEDULER_add_delayed (round_interval, &do_round, NULL);
970   LOG (GNUNET_ERROR_TYPE_DEBUG, "Finished round\n");
971 }
972
973
974 /**
975  * Open a connection to given peer and store channel and mq.
976  */
977   void
978 insertCB (void *cls, const struct GNUNET_PeerIdentity *id)
979 {
980   // We open a channel to be notified when this peer goes down.
981   (void) get_channel (peer_map, id);
982 }
983
984
985 /**
986  * Close the connection to given peer and delete channel and mq.
987  */
988   void
989 removeCB (void *cls, const struct GNUNET_PeerIdentity *id)
990 {
991   size_t s;
992   struct peer_context *ctx;
993
994   s = RPS_sampler_count_id (id);
995   if ( 1 >= s )
996   {
997     if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, id))
998     {
999       ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, id);
1000       if (NULL != ctx->to_channel)
1001       {
1002         if (NULL != ctx->mq)
1003         {
1004           GNUNET_MQ_destroy (ctx->mq);
1005         }
1006         // may already be freed at shutdown of cadet
1007         //GNUNET_CADET_channel_destroy (ctx->to_channel);
1008       }
1009       // TODO cleanup peer
1010       (void) GNUNET_CONTAINER_multipeermap_remove_all (peer_map, id);
1011     }
1012   }
1013 }
1014
1015 static void
1016 rps_start (struct GNUNET_SERVER_Handle *server);
1017
1018 /**
1019  * This is called from GNUNET_CADET_get_peers().
1020  *
1021  * It is called on every peer(ID) that cadet somehow has contact with.
1022  * We use those to initialise the sampler.
1023  */
1024 void
1025 init_peer_cb (void *cls,
1026               const struct GNUNET_PeerIdentity *peer,
1027               int tunnel, // "Do we have a tunnel towards this peer?"
1028               unsigned int n_paths, // "Number of known paths towards this peer"
1029               unsigned int best_path) // "How long is the best path?
1030                                       // (0 = unknown, 1 = ourselves, 2 = neighbor)"
1031 {
1032   struct init_peer_cls *ipc;
1033
1034   ipc = (struct init_peer_cls *) cls;
1035   if ( NULL != peer )
1036   {
1037     LOG (GNUNET_ERROR_TYPE_DEBUG,
1038         "Got %" PRIX32 ". peer %s (at %p) from CADET (gossip_list_size: %u)\n",
1039         ipc->i, GNUNET_i2s (peer), peer, gossip_list_size);
1040     RPS_sampler_update_list (peer);
1041     (void) get_peer_ctx (peer_map, peer); // unneeded? -> insertCB
1042
1043     if (ipc->i < gossip_list_size)
1044     {
1045       gossip_list[ipc->i] = *peer; // FIXME sometimes we're writing to invalid space here
1046                                    // not sure whether fixed
1047       ipc->i++;
1048     }
1049
1050     // send push/pull to each of those peers?
1051   }
1052   else
1053   {
1054     if (ipc->i < gossip_list_size)
1055     {
1056       memcpy(&gossip_list[ipc->i],
1057           RPS_sampler_get_n_rand_peers_ (1),
1058           (gossip_list_size - ipc->i) * sizeof(struct GNUNET_PeerIdentity));
1059     }
1060     rps_start (ipc->server);
1061     GNUNET_free (ipc);
1062   }
1063 }
1064
1065
1066 /**
1067  * Task run during shutdown.
1068  *
1069  * @param cls unused
1070  * @param tc unused
1071  */
1072 static void
1073 shutdown_task (void *cls,
1074                const struct GNUNET_SCHEDULER_TaskContext *tc)
1075 {
1076   LOG(GNUNET_ERROR_TYPE_DEBUG, "RPS is going down\n");
1077
1078   if ( NULL != do_round_task )
1079   {
1080     GNUNET_SCHEDULER_cancel (do_round_task);
1081     do_round_task = NULL;
1082   }
1083
1084   GNUNET_NSE_disconnect (nse);
1085   GNUNET_CADET_disconnect (cadet_handle);
1086   GNUNET_free (own_identity);
1087   RPS_sampler_destroy ();
1088   GNUNET_array_grow (request_deltas, request_deltas_size, 0);
1089   GNUNET_array_grow (gossip_list, gossip_list_size, 0);
1090   GNUNET_array_grow (push_list, push_list_size, 0);
1091   GNUNET_array_grow (pull_list, pull_list_size, 0);
1092 }
1093
1094
1095 /**
1096  * A client disconnected.  Remove all of its data structure entries.
1097  *
1098  * @param cls closure, NULL
1099  * @param client identification of the client
1100  */
1101 static void
1102 handle_client_disconnect (void *cls,
1103                           struct GNUNET_SERVER_Client * client)
1104 {
1105 }
1106
1107 /**
1108  * Handle the channel a peer opens to us.
1109  *
1110  * @param cls The closure
1111  * @param channel The channel the peer wants to establish
1112  * @param initiator The peer's peer ID
1113  * @param port The port the channel is being established over
1114  * @param options Further options
1115  */
1116   static void *
1117 handle_inbound_channel (void *cls,
1118                         struct GNUNET_CADET_Channel *channel,
1119                         const struct GNUNET_PeerIdentity *initiator,
1120                         uint32_t port,
1121                         enum GNUNET_CADET_ChannelOption options)
1122 {
1123   struct peer_context *ctx;
1124
1125   LOG(GNUNET_ERROR_TYPE_DEBUG, "New channel was established to us (Peer %s).\n", GNUNET_i2s(initiator));
1126
1127   GNUNET_assert( NULL != channel );
1128
1129   // we might not even store the from_channel
1130
1131   ctx = get_peer_ctx(peer_map, initiator);
1132   if (NULL != ctx->from_channel)
1133   {
1134     ctx->from_channel = channel;
1135   }
1136
1137   // FIXME there might already be an established channel
1138
1139   //ctx->in_flags = in_other_gossip_list;
1140   ctx->mq = NULL; // TODO create mq?
1141
1142   (void) GNUNET_CONTAINER_multipeermap_put (peer_map, initiator, ctx,
1143       GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
1144   return NULL; // TODO
1145 }
1146
1147 /**
1148  * This is called when a remote peer destroys a channel.
1149  *
1150  * @param cls The closure
1151  * @param channel The channel being closed
1152  * @param channel_ctx The context associated with this channel
1153  */
1154 static void
1155 cleanup_channel(void *cls,
1156                 const struct GNUNET_CADET_Channel *channel,
1157                 void *channel_ctx)
1158 {
1159   struct GNUNET_PeerIdentity *peer;
1160   LOG(GNUNET_ERROR_TYPE_DEBUG, "Channel to remote peer was destroyed.\n");
1161
1162   peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1163       (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1164        // Guess simply casting isn't the nicest way...
1165        // FIXME wait for cadet to change this function
1166   RPS_sampler_reinitialise_by_value (peer);
1167 }
1168
1169 /**
1170  * Actually start the service.
1171  */
1172 static void
1173 rps_start (struct GNUNET_SERVER_Handle *server)
1174 {
1175   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1176     {&handle_client_request, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST,
1177       sizeof (struct GNUNET_RPS_CS_RequestMessage)},
1178     {&handle_client_seed,    NULL, GNUNET_MESSAGE_TYPE_RPS_CS_SEED, 0},
1179     {NULL, NULL, 0, 0}
1180   };
1181
1182   GNUNET_SERVER_add_handlers (server, handlers);
1183   GNUNET_SERVER_disconnect_notify (server,
1184                                    &handle_client_disconnect,
1185                                    NULL);
1186   LOG(GNUNET_ERROR_TYPE_DEBUG, "Ready to receive requests from clients\n");
1187
1188
1189   do_round_task = GNUNET_SCHEDULER_add_now (&do_round, NULL);
1190   LOG(GNUNET_ERROR_TYPE_DEBUG, "Scheduled first round\n");
1191
1192   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1193                                 &shutdown_task,
1194                                 NULL);
1195 }
1196
1197
1198 /**
1199  * Process statistics requests.
1200  *
1201  * @param cls closure
1202  * @param server the initialized server
1203  * @param c configuration to use
1204  */
1205 static void
1206 run (void *cls,
1207      struct GNUNET_SERVER_Handle *server,
1208      const struct GNUNET_CONFIGURATION_Handle *c)
1209 {
1210   // TODO check what this does -- copied from gnunet-boss
1211   // - seems to work as expected
1212   GNUNET_log_setup ("rps", GNUNET_error_type_to_string (GNUNET_ERROR_TYPE_DEBUG), NULL);
1213
1214   LOG(GNUNET_ERROR_TYPE_DEBUG, "RPS started\n");
1215
1216   struct init_peer_cls *ipc;
1217
1218   cfg = c;
1219
1220
1221   /* Get own ID */
1222   own_identity = GNUNET_new (struct GNUNET_PeerIdentity);
1223   GNUNET_CRYPTO_get_peer_identity (cfg, own_identity); // TODO check return value
1224   GNUNET_assert (NULL != own_identity);
1225   LOG (GNUNET_ERROR_TYPE_DEBUG, "Own identity is %s (at %p).\n", GNUNET_i2s(own_identity), own_identity);
1226
1227
1228   /* Get time interval from the configuration */
1229   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, "RPS",
1230                                                         "ROUNDINTERVAL",
1231                                                         &round_interval))
1232   {
1233     LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read ROUNDINTERVAL from config\n");
1234     GNUNET_SCHEDULER_shutdown();
1235     return;
1236   }
1237
1238   /* Get initial size of sampler/gossip list from the configuration */
1239   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, "RPS",
1240                                                          "INITSIZE",
1241                                                          (long long unsigned int *) &sampler_size_est_need))
1242   {
1243     LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read INITSIZE from config\n");
1244     GNUNET_SCHEDULER_shutdown ();
1245     return;
1246   }
1247   LOG (GNUNET_ERROR_TYPE_DEBUG, "INITSIZE is %" PRIu64 "\n", sampler_size_est_need);
1248
1249   //gossip_list_size = sampler_size; // TODO rename sampler_size
1250
1251   gossip_list = NULL;
1252   GNUNET_array_grow (gossip_list, gossip_list_size, sampler_size_est_need);
1253
1254
1255   /* connect to NSE */
1256   nse = GNUNET_NSE_connect (cfg, nse_callback, NULL);
1257   // TODO check whether that was successful
1258   // TODO disconnect on shutdown
1259   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to NSE\n");
1260
1261
1262   alpha = 0.45;
1263   beta  = 0.45;
1264   // TODO initialise thresholds - ?
1265
1266   /* Get alpha from the configuration */
1267   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_float (cfg, "RPS",
1268                                                          "ALPHA",
1269                                                          &alpha))
1270   {
1271     LOG(GNUNET_ERROR_TYPE_DEBUG, "No ALPHA specified in the config\n");
1272   }
1273   LOG(GNUNET_ERROR_TYPE_DEBUG, "ALPHA is %f\n", alpha);
1274  
1275   /* Get beta from the configuration */
1276   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_float (cfg, "RPS",
1277                                                          "BETA",
1278                                                          &beta))
1279   {
1280     LOG (GNUNET_ERROR_TYPE_DEBUG, "No BETA specified in the config\n");
1281   }
1282   LOG (GNUNET_ERROR_TYPE_DEBUG, "BETA is %f\n", beta);
1283
1284   // TODO check that alpha + beta < 1
1285
1286   peer_map = GNUNET_CONTAINER_multipeermap_create (sampler_size_est_need, GNUNET_NO);
1287
1288
1289   /* Initialise cadet */
1290   static const struct GNUNET_CADET_MessageHandler cadet_handlers[] = {
1291     {&handle_peer_push        , GNUNET_MESSAGE_TYPE_RPS_PP_PUSH        , 0},
1292     {&handle_peer_pull_request, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST, 0},
1293     {&handle_peer_pull_reply  , GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY  , 0},
1294     {NULL, 0, 0}
1295   };
1296
1297   const uint32_t ports[] = {GNUNET_RPS_CADET_PORT, 0}; // _PORT specified in src/rps/rps.h
1298   cadet_handle = GNUNET_CADET_connect (cfg,
1299                                     cls,
1300                                     &handle_inbound_channel,
1301                                     &cleanup_channel,
1302                                     cadet_handlers,
1303                                     ports);
1304   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to CADET\n");
1305
1306
1307   /* Initialise sampler */
1308   RPS_sampler_init (sampler_size_est_need, own_identity, insertCB, NULL, removeCB, NULL);
1309   sampler_size = sampler_size_est_need;
1310
1311   /* Initialise push and pull maps */
1312   push_list = NULL;
1313   push_list_size = 0;
1314   pull_list = NULL;
1315   pull_list_size = 0;
1316
1317
1318   ipc = GNUNET_new (struct init_peer_cls);
1319   ipc->server = server;
1320   ipc->i = 0;
1321   LOG (GNUNET_ERROR_TYPE_DEBUG, "Requesting peers from CADET\n");
1322   GNUNET_CADET_get_peers (cadet_handle, &init_peer_cb, ipc);
1323
1324   // TODO send push/pull to each of those peers?
1325 }
1326
1327
1328 /**
1329  * The main function for the rps service.
1330  *
1331  * @param argc number of arguments from the command line
1332  * @param argv command line arguments
1333  * @return 0 ok, 1 on error
1334  */
1335 int
1336 main (int argc, char *const *argv)
1337 {
1338   return (GNUNET_OK ==
1339           GNUNET_SERVICE_run (argc,
1340                               argv,
1341                               "rps",
1342                               GNUNET_SERVICE_OPTION_NONE,
1343                               &run, NULL)) ? 0 : 1;
1344 }
1345
1346 /* end of gnunet-service-rps.c */