resizing lists implemented, fixed type error
[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   // TODO accept empty message
692   if (ntohs(msg->size) != sizeof (struct GNUNET_RPS_P2P_PushMessage))
693   {
694     GNUNET_break_op (0); // At the moment our own implementation seems to break that.
695     return GNUNET_SYSERR;
696   }
697
698   peer = (const struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel, GNUNET_CADET_OPTION_PEER);
699   // FIXME wait for cadet to change this function
700   LOG (GNUNET_ERROR_TYPE_DEBUG, "PUSH received (%s)\n", GNUNET_i2s (peer));
701   
702   /* Add the sending peer to the push_list */
703   if (GNUNET_NO == in_arr (push_list, pull_list_size, peer))
704     GNUNET_array_append (push_list, push_list_size, *peer);
705
706   return GNUNET_OK;
707 }
708
709 /**
710  * Handle PULL REQUEST request message from another peer.
711  *
712  * Reply with the gossip list of PeerIDs.
713  *
714  * @param cls Closure
715  * @param channel The channel the PUSH was received over
716  * @param channel_ctx The context associated with this channel
717  * @param msg The message header
718  */
719 static int
720 handle_peer_pull_request (void *cls,
721     struct GNUNET_CADET_Channel *channel,
722     void **channel_ctx,
723     const struct GNUNET_MessageHeader *msg)
724 {
725   struct GNUNET_PeerIdentity *peer;
726   struct GNUNET_MQ_Handle *mq;
727   struct GNUNET_MQ_Envelope *ev;
728   struct GNUNET_RPS_P2P_PullReplyMessage *out_msg;
729
730   // assert that msg->size is 0
731
732   // TODO accept empty message
733   if (ntohs(msg->size) != sizeof (struct GNUNET_RPS_P2P_PullRequestMessage))
734   {
735     GNUNET_break_op (0); // At the moment our own implementation seems to break that.
736     return GNUNET_SYSERR;
737   }
738
739   peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel, GNUNET_CADET_OPTION_PEER);
740   // FIXME wait for cadet to change this function
741   LOG (GNUNET_ERROR_TYPE_DEBUG,
742       "PULL REQUEST from peer %s received, going to send %u peers\n",
743       GNUNET_i2s (peer), gossip_list_size);
744
745   mq = get_mq (peer_map, peer);
746
747   ev = GNUNET_MQ_msg_extra (out_msg,
748                            gossip_list_size * sizeof (struct GNUNET_PeerIdentity),
749                            GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY);
750   //out_msg->num_peers = GNUNET_htonll (gossip_list_size);
751   out_msg->num_peers = htonl (gossip_list_size);
752   memcpy (&out_msg[1], gossip_list,
753          gossip_list_size * sizeof (struct GNUNET_PeerIdentity));
754
755   GNUNET_MQ_send (mq, ev);
756
757   return GNUNET_OK;
758 }
759
760 /**
761  * Handle PULL REPLY message from another peer.
762  *
763  * Check whether we sent a corresponding request and
764  * whether this reply is the first one.
765  *
766  * @param cls Closure
767  * @param channel The channel the PUSH was received over
768  * @param channel_ctx The context associated with this channel
769  * @param msg The message header
770  */
771 static int
772 handle_peer_pull_reply (void *cls,
773     struct GNUNET_CADET_Channel *channel,
774     void **channel_ctx,
775     const struct GNUNET_MessageHeader *msg)
776 {
777   LOG (GNUNET_ERROR_TYPE_DEBUG, "PULL REPLY received\n");
778
779   struct GNUNET_RPS_P2P_PullReplyMessage *in_msg;
780   struct GNUNET_PeerIdentity *peers;
781   uint64_t i;
782
783   if (sizeof (struct GNUNET_RPS_P2P_PullReplyMessage) > ntohs (msg->size))
784   {
785     GNUNET_break_op (0); // At the moment our own implementation seems to break that.
786     return GNUNET_SYSERR;
787   }
788   in_msg = (struct GNUNET_RPS_P2P_PullReplyMessage *) msg;
789   if ((ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
790   {
791     LOG (GNUNET_ERROR_TYPE_ERROR, "message says it sends %" PRIu64 " peers, have space for %i peers\n",
792         ntohl (in_msg->num_peers),
793         (ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity));
794     GNUNET_break_op (0);
795     return GNUNET_SYSERR;
796   }
797
798   // TODO check that we sent a request and that it is the first reply
799
800   peers = (struct GNUNET_PeerIdentity *) &msg[1];
801   for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
802   {
803     if (GNUNET_NO == in_arr (pull_list, pull_list_size, &peers[i]))
804       GNUNET_array_append (pull_list, pull_list_size, peers[i]);
805   }
806
807   // TODO check that id is valid - whether it is reachable
808
809   return GNUNET_OK;
810 }
811
812
813 /**
814  * Send out PUSHes and PULLs.
815  *
816  * This is executed regylary.
817  */
818 static void
819 do_round (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
820 {
821   LOG(GNUNET_ERROR_TYPE_DEBUG, "Going to execute next round\n");
822
823   uint64_t i;
824   //unsigned int *n_arr;
825   unsigned int n_peers; /* Number of peers we send pushes/pulls to */
826   struct GNUNET_RPS_P2P_PushMessage        *push_msg;
827   struct GNUNET_RPS_P2P_PullRequestMessage *pull_msg; // FIXME Send empty message
828   struct GNUNET_MQ_Envelope *ev;
829   const struct GNUNET_PeerIdentity *peer;
830   struct GNUNET_MQ_Handle *mq;
831
832   // TODO print lists, ...
833   // TODO randomise and spread calls herein over time
834
835
836   /* Would it make sense to have one shuffeled gossip list and then
837    * to send PUSHes to first alpha peers, PULL requests to next beta peers and
838    * use the rest to update sampler?
839    * in essence get random peers with consumption */
840
841   /* Send PUSHes */
842   //n_arr = GNUNET_CRYPTO_random_permute(GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) gossip_list_size);
843   n_peers = round (alpha * gossip_list_size);
844   if (0 == n_peers)
845     n_peers = 1;
846   LOG(GNUNET_ERROR_TYPE_DEBUG, "Going to send pushes to %u (%f * %u) peers.\n",
847       n_peers, alpha, gossip_list_size);
848   for ( i = 0 ; i < n_peers ; i++ )
849   {
850     peer = get_rand_peer (gossip_list, gossip_list_size);
851     if (own_identity != peer)
852     { // FIXME if this fails schedule/loop this for later
853       LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PUSH to peer %s of gossiped list.\n", GNUNET_i2s (peer));
854
855       ev = GNUNET_MQ_msg (push_msg, GNUNET_MESSAGE_TYPE_RPS_PP_PUSH);
856       push_msg = NULL;
857       // FIXME sometimes it returns a pointer to a freed mq
858       mq = get_mq (peer_map, peer);
859       GNUNET_MQ_send (mq, ev);
860     }
861   }
862
863
864   /* Send PULL requests */
865   //n_arr = GNUNET_CRYPTO_random_permute(GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) sampler_list->size);
866   n_peers = round (beta * gossip_list_size);
867   if (0 == n_peers)
868     n_peers = 1;
869   LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to send pulls to %u (%f * %u) peers.\n",
870       n_peers, beta, gossip_list_size);
871   for ( i = 0 ; i < n_peers ; i++ )
872   {
873     peer = get_rand_peer (gossip_list, gossip_list_size);
874     if (own_identity != peer)
875     { // FIXME if this fails schedule/loop this for later
876       LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PULL request to peer %s of gossiped list.\n", GNUNET_i2s (peer));
877
878       ev = GNUNET_MQ_msg (pull_msg, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST);
879       pull_msg = NULL;
880       mq = get_mq (peer_map, peer);
881       GNUNET_MQ_send (mq, ev);
882     }
883   }
884
885
886   /* Update gossip list */
887   uint64_t r_index;
888
889   if ( push_list_size <= alpha * gossip_list_size &&
890        push_list_size != 0 &&
891        pull_list_size != 0 )
892   {
893     LOG(GNUNET_ERROR_TYPE_DEBUG, "Update of the gossip list. ()\n");
894
895     uint64_t first_border;
896     uint64_t second_border;
897     
898     GNUNET_array_grow (gossip_list, gossip_list_size, sampler_size_est_need);
899
900     first_border = round (alpha * gossip_list_size);
901     for ( i = 0 ; i < first_border ; i++ )
902     { // TODO use RPS_sampler_get_n_rand_peers
903       /* Update gossip list with peers received through PUSHes */
904       r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
905                                        push_list_size);
906       gossip_list[i] = push_list[r_index];
907       // TODO change the in_flags accordingly
908     }
909
910     second_border = first_border + round(beta * gossip_list_size);
911     for ( i = first_border ; i < second_border ; i++ )
912     {
913       /* Update gossip list with peers received through PULLs */
914       r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
915                                        pull_list_size);
916       gossip_list[i] = pull_list[r_index];
917       // TODO change the in_flags accordingly
918     }
919
920     for ( i = second_border ; i < gossip_list_size ; i++ )
921     {
922       /* Update gossip list with peers from history */
923       peer = RPS_sampler_get_n_rand_peers_ (1);
924       gossip_list[i] = *peer;
925       // TODO change the in_flags accordingly
926     }
927
928   }
929   else
930   {
931     LOG(GNUNET_ERROR_TYPE_DEBUG, "No update of the gossip list. ()\n");
932   }
933   // TODO independent of that also get some peers from CADET_get_peers()?
934
935
936   /* Update samplers */
937
938   for ( i = 0 ; i < push_list_size ; i++ )
939   {
940     RPS_sampler_update_list (&push_list[i]);
941     // TODO set in_flag?
942   }
943
944   for ( i = 0 ; i < pull_list_size ; i++ )
945   {
946     RPS_sampler_update_list (&pull_list[i]);
947     // TODO set in_flag?
948   }
949
950
951   /* Empty push/pull lists */
952   GNUNET_array_grow (push_list, push_list_size, 0);
953   GNUNET_array_grow (pull_list, pull_list_size, 0);
954
955   struct GNUNET_TIME_Relative time_next_round;
956   struct GNUNET_TIME_Relative half_round_interval;
957   unsigned int rand_delay;
958
959   /* Compute random time value between .5 * round_interval and 1.5 *round_interval */
960   half_round_interval = GNUNET_TIME_relative_divide (round_interval, 2);
961   do
962   {
963   /*
964    * Compute random value between (0 and 1) * round_interval
965    * via multiplying round_interval with a 'fraction' (0 to value)/value
966    */
967   rand_delay = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, UINT_MAX/10);
968   time_next_round = GNUNET_TIME_relative_multiply (round_interval,  rand_delay);
969   time_next_round = GNUNET_TIME_relative_divide   (time_next_round, UINT_MAX/10);
970   time_next_round = GNUNET_TIME_relative_add      (time_next_round, half_round_interval);
971   } while (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == time_next_round.rel_value_us);
972
973   /* Schedule next round */
974   do_round_task = GNUNET_SCHEDULER_add_delayed (round_interval, &do_round, NULL);
975   LOG (GNUNET_ERROR_TYPE_DEBUG, "Finished round\n");
976 }
977
978
979 /**
980  * Open a connection to given peer and store channel and mq.
981  */
982   void
983 insertCB (void *cls, const struct GNUNET_PeerIdentity *id)
984 {
985   // We open a channel to be notified when this peer goes down.
986   (void) get_channel (peer_map, id);
987 }
988
989
990 /**
991  * Close the connection to given peer and delete channel and mq.
992  */
993   void
994 removeCB (void *cls, const struct GNUNET_PeerIdentity *id)
995 {
996   size_t s;
997   struct peer_context *ctx;
998
999   s = RPS_sampler_count_id (id);
1000   if ( 1 >= s )
1001   {
1002     if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, id))
1003     {
1004       ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, id);
1005       if (NULL != ctx->to_channel)
1006       {
1007         if (NULL != ctx->mq)
1008         {
1009           GNUNET_MQ_destroy (ctx->mq);
1010         }
1011         // may already be freed at shutdown of cadet
1012         //GNUNET_CADET_channel_destroy (ctx->to_channel);
1013       }
1014       // TODO cleanup peer
1015       (void) GNUNET_CONTAINER_multipeermap_remove_all (peer_map, id);
1016     }
1017   }
1018 }
1019
1020 static void
1021 rps_start (struct GNUNET_SERVER_Handle *server);
1022
1023 /**
1024  * This is called from GNUNET_CADET_get_peers().
1025  *
1026  * It is called on every peer(ID) that cadet somehow has contact with.
1027  * We use those to initialise the sampler.
1028  */
1029 void
1030 init_peer_cb (void *cls,
1031               const struct GNUNET_PeerIdentity *peer,
1032               int tunnel, // "Do we have a tunnel towards this peer?"
1033               unsigned int n_paths, // "Number of known paths towards this peer"
1034               unsigned int best_path) // "How long is the best path?
1035                                       // (0 = unknown, 1 = ourselves, 2 = neighbor)"
1036 {
1037   struct init_peer_cls *ipc;
1038
1039   ipc = (struct init_peer_cls *) cls;
1040   if ( NULL != peer )
1041   {
1042     LOG (GNUNET_ERROR_TYPE_DEBUG,
1043         "Got %" PRIX32 ". peer %s (at %p) from CADET (gossip_list_size: %u)\n",
1044         ipc->i, GNUNET_i2s (peer), peer, gossip_list_size);
1045     RPS_sampler_update_list (peer);
1046     (void) get_peer_ctx (peer_map, peer); // unneeded? -> insertCB
1047
1048     if (ipc->i < gossip_list_size)
1049     {
1050       gossip_list[ipc->i] = *peer; // FIXME sometimes we're writing to invalid space here
1051                                    // not sure whether fixed
1052       ipc->i++;
1053     }
1054
1055     // send push/pull to each of those peers?
1056   }
1057   else
1058   {
1059     if (ipc->i < gossip_list_size)
1060     {
1061       memcpy(&gossip_list[ipc->i],
1062           RPS_sampler_get_n_rand_peers_ (1),
1063           (gossip_list_size - ipc->i) * sizeof(struct GNUNET_PeerIdentity));
1064     }
1065     rps_start (ipc->server);
1066     GNUNET_free (ipc);
1067   }
1068 }
1069
1070
1071 /**
1072  * Task run during shutdown.
1073  *
1074  * @param cls unused
1075  * @param tc unused
1076  */
1077 static void
1078 shutdown_task (void *cls,
1079                const struct GNUNET_SCHEDULER_TaskContext *tc)
1080 {
1081   LOG(GNUNET_ERROR_TYPE_DEBUG, "RPS is going down\n");
1082
1083   if ( NULL != do_round_task )
1084   {
1085     GNUNET_SCHEDULER_cancel (do_round_task);
1086     do_round_task = NULL;
1087   }
1088
1089   GNUNET_NSE_disconnect (nse);
1090   GNUNET_CADET_disconnect (cadet_handle);
1091   GNUNET_free (own_identity);
1092   RPS_sampler_destroy ();
1093   GNUNET_array_grow (request_deltas, request_deltas_size, 0);
1094   GNUNET_array_grow (gossip_list, gossip_list_size, 0);
1095   GNUNET_array_grow (push_list, push_list_size, 0);
1096   GNUNET_array_grow (pull_list, pull_list_size, 0);
1097 }
1098
1099
1100 /**
1101  * A client disconnected.  Remove all of its data structure entries.
1102  *
1103  * @param cls closure, NULL
1104  * @param client identification of the client
1105  */
1106 static void
1107 handle_client_disconnect (void *cls,
1108                           struct GNUNET_SERVER_Client * client)
1109 {
1110 }
1111
1112 /**
1113  * Handle the channel a peer opens to us.
1114  *
1115  * @param cls The closure
1116  * @param channel The channel the peer wants to establish
1117  * @param initiator The peer's peer ID
1118  * @param port The port the channel is being established over
1119  * @param options Further options
1120  */
1121   static void *
1122 handle_inbound_channel (void *cls,
1123                         struct GNUNET_CADET_Channel *channel,
1124                         const struct GNUNET_PeerIdentity *initiator,
1125                         uint32_t port,
1126                         enum GNUNET_CADET_ChannelOption options)
1127 {
1128   struct peer_context *ctx;
1129
1130   LOG(GNUNET_ERROR_TYPE_DEBUG, "New channel was established to us (Peer %s).\n", GNUNET_i2s(initiator));
1131
1132   GNUNET_assert( NULL != channel );
1133
1134   // we might not even store the from_channel
1135
1136   ctx = get_peer_ctx(peer_map, initiator);
1137   if (NULL != ctx->from_channel)
1138   {
1139     ctx->from_channel = channel;
1140   }
1141
1142   // FIXME there might already be an established channel
1143
1144   //ctx->in_flags = in_other_gossip_list;
1145   ctx->mq = NULL; // TODO create mq?
1146
1147   (void) GNUNET_CONTAINER_multipeermap_put (peer_map, initiator, ctx,
1148       GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
1149   return NULL; // TODO
1150 }
1151
1152 /**
1153  * This is called when a remote peer destroys a channel.
1154  *
1155  * @param cls The closure
1156  * @param channel The channel being closed
1157  * @param channel_ctx The context associated with this channel
1158  */
1159 static void
1160 cleanup_channel(void *cls,
1161                 const struct GNUNET_CADET_Channel *channel,
1162                 void *channel_ctx)
1163 {
1164   struct GNUNET_PeerIdentity *peer;
1165   LOG(GNUNET_ERROR_TYPE_DEBUG, "Channel to remote peer was destroyed.\n");
1166
1167   peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1168       (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1169        // Guess simply casting isn't the nicest way...
1170        // FIXME wait for cadet to change this function
1171   RPS_sampler_reinitialise_by_value (peer);
1172 }
1173
1174 /**
1175  * Actually start the service.
1176  */
1177 static void
1178 rps_start (struct GNUNET_SERVER_Handle *server)
1179 {
1180   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1181     {&handle_client_request, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST,
1182       sizeof (struct GNUNET_RPS_CS_RequestMessage)},
1183     {&handle_client_seed,    NULL, GNUNET_MESSAGE_TYPE_RPS_CS_SEED, 0},
1184     {NULL, NULL, 0, 0}
1185   };
1186
1187   GNUNET_SERVER_add_handlers (server, handlers);
1188   GNUNET_SERVER_disconnect_notify (server,
1189                                    &handle_client_disconnect,
1190                                    NULL);
1191   LOG(GNUNET_ERROR_TYPE_DEBUG, "Ready to receive requests from clients\n");
1192
1193
1194   do_round_task = GNUNET_SCHEDULER_add_now (&do_round, NULL);
1195   LOG(GNUNET_ERROR_TYPE_DEBUG, "Scheduled first round\n");
1196
1197   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1198                                 &shutdown_task,
1199                                 NULL);
1200 }
1201
1202
1203 /**
1204  * Process statistics requests.
1205  *
1206  * @param cls closure
1207  * @param server the initialized server
1208  * @param c configuration to use
1209  */
1210 static void
1211 run (void *cls,
1212      struct GNUNET_SERVER_Handle *server,
1213      const struct GNUNET_CONFIGURATION_Handle *c)
1214 {
1215   // TODO check what this does -- copied from gnunet-boss
1216   // - seems to work as expected
1217   GNUNET_log_setup ("rps", GNUNET_error_type_to_string (GNUNET_ERROR_TYPE_DEBUG), NULL);
1218
1219   LOG(GNUNET_ERROR_TYPE_DEBUG, "RPS started\n");
1220
1221   struct init_peer_cls *ipc;
1222
1223   cfg = c;
1224
1225
1226   /* Get own ID */
1227   own_identity = GNUNET_new (struct GNUNET_PeerIdentity);
1228   GNUNET_CRYPTO_get_peer_identity (cfg, own_identity); // TODO check return value
1229   GNUNET_assert (NULL != own_identity);
1230   LOG (GNUNET_ERROR_TYPE_DEBUG, "Own identity is %s (at %p).\n", GNUNET_i2s(own_identity), own_identity);
1231
1232
1233   /* Get time interval from the configuration */
1234   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, "RPS",
1235                                                         "ROUNDINTERVAL",
1236                                                         &round_interval))
1237   {
1238     LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read ROUNDINTERVAL from config\n");
1239     GNUNET_SCHEDULER_shutdown();
1240     return;
1241   }
1242
1243   /* Get initial size of sampler/gossip list from the configuration */
1244   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, "RPS",
1245                                                          "INITSIZE",
1246                                                          (long long unsigned int *) &sampler_size_est_need))
1247   {
1248     LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read INITSIZE from config\n");
1249     GNUNET_SCHEDULER_shutdown ();
1250     return;
1251   }
1252   LOG (GNUNET_ERROR_TYPE_DEBUG, "INITSIZE is %" PRIu64 "\n", sampler_size_est_need);
1253
1254   //gossip_list_size = sampler_size; // TODO rename sampler_size
1255
1256   gossip_list = NULL;
1257   GNUNET_array_grow (gossip_list, gossip_list_size, sampler_size_est_need);
1258
1259
1260   /* connect to NSE */
1261   nse = GNUNET_NSE_connect (cfg, nse_callback, NULL);
1262   // TODO check whether that was successful
1263   // TODO disconnect on shutdown
1264   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to NSE\n");
1265
1266
1267   alpha = 0.45;
1268   beta  = 0.45;
1269   // TODO initialise thresholds - ?
1270
1271   /* Get alpha from the configuration */
1272   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_float (cfg, "RPS",
1273                                                          "ALPHA",
1274                                                          &alpha))
1275   {
1276     LOG(GNUNET_ERROR_TYPE_DEBUG, "No ALPHA specified in the config\n");
1277   }
1278   LOG(GNUNET_ERROR_TYPE_DEBUG, "ALPHA is %f\n", alpha);
1279  
1280   /* Get beta from the configuration */
1281   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_float (cfg, "RPS",
1282                                                          "BETA",
1283                                                          &beta))
1284   {
1285     LOG (GNUNET_ERROR_TYPE_DEBUG, "No BETA specified in the config\n");
1286   }
1287   LOG (GNUNET_ERROR_TYPE_DEBUG, "BETA is %f\n", beta);
1288
1289   // TODO check that alpha + beta < 1
1290
1291   peer_map = GNUNET_CONTAINER_multipeermap_create (sampler_size_est_need, GNUNET_NO);
1292
1293
1294   /* Initialise cadet */
1295   static const struct GNUNET_CADET_MessageHandler cadet_handlers[] = {
1296     {&handle_peer_push        , GNUNET_MESSAGE_TYPE_RPS_PP_PUSH        , 0},
1297     {&handle_peer_pull_request, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST, 0},
1298     {&handle_peer_pull_reply  , GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY  , 0},
1299     {NULL, 0, 0}
1300   };
1301
1302   const uint32_t ports[] = {GNUNET_RPS_CADET_PORT, 0}; // _PORT specified in src/rps/rps.h
1303   cadet_handle = GNUNET_CADET_connect (cfg,
1304                                     cls,
1305                                     &handle_inbound_channel,
1306                                     &cleanup_channel,
1307                                     cadet_handlers,
1308                                     ports);
1309   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to CADET\n");
1310
1311
1312   /* Initialise sampler */
1313   RPS_sampler_init (sampler_size_est_need, own_identity, insertCB, NULL, removeCB, NULL);
1314   sampler_size = sampler_size_est_need;
1315
1316   /* Initialise push and pull maps */
1317   push_list = NULL;
1318   push_list_size = 0;
1319   pull_list = NULL;
1320   pull_list_size = 0;
1321
1322
1323   ipc = GNUNET_new (struct init_peer_cls);
1324   ipc->server = server;
1325   ipc->i = 0;
1326   LOG (GNUNET_ERROR_TYPE_DEBUG, "Requesting peers from CADET\n");
1327   GNUNET_CADET_get_peers (cadet_handle, &init_peer_cb, ipc);
1328
1329   // TODO send push/pull to each of those peers?
1330 }
1331
1332
1333 /**
1334  * The main function for the rps service.
1335  *
1336  * @param argc number of arguments from the command line
1337  * @param argv command line arguments
1338  * @return 0 ok, 1 on error
1339  */
1340 int
1341 main (int argc, char *const *argv)
1342 {
1343   return (GNUNET_OK ==
1344           GNUNET_SERVICE_run (argc,
1345                               argv,
1346                               "rps",
1347                               GNUNET_SERVICE_OPTION_NONE,
1348                               &run, NULL)) ? 0 : 1;
1349 }
1350
1351 /* end of gnunet-service-rps.c */