Reinitialise the (client) sampler element after querying
[oweals/gnunet.git] / src / rps / gnunet-service-rps_sampler.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 it
6      under the terms of the GNU Affero General Public License as published
7      by the Free Software Foundation, either version 3 of the License,
8      or (at your 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      Affero General Public License for more details.
14     
15      You should have received a copy of the GNU Affero General Public License
16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 /**
20  * @file rps/gnunet-service-rps_sampler.c
21  * @brief sampler implementation
22  * @author Julius Bünger
23  */
24 #include "platform.h"
25 #include "gnunet_util_lib.h"
26 #include "rps.h"
27
28 #include "gnunet-service-rps_sampler.h"
29 #include "gnunet-service-rps_sampler_elem.h"
30
31 #include <math.h>
32 #include <inttypes.h>
33
34 #include "rps-test_util.h"
35
36 #define LOG(kind, ...) GNUNET_log_from(kind,"rps-sampler",__VA_ARGS__)
37
38
39 // multiple 'clients'?
40
41 // TODO check for overflows
42
43 // TODO align message structs
44
45 // hist_size_init, hist_size_max
46
47 /***********************************************************************
48  * WARNING: This section needs to be reviewed regarding the use of
49  * functions providing (pseudo)randomness!
50 ***********************************************************************/
51
52 // TODO care about invalid input of the caller (size 0 or less...)
53
54 /**
55  * Callback that is called from _get_rand_peer() when the PeerID is ready.
56  *
57  * @param cls the closure given alongside this function.
58  * @param id the PeerID that was returned
59  */
60 typedef void
61 (*RPS_sampler_rand_peer_ready_cont) (void *cls,
62                                      const struct GNUNET_PeerIdentity *id);
63
64
65 /**
66  * Closure for #sampler_mod_get_rand_peer() and #sampler_get_rand_peer
67  */
68 struct GetPeerCls
69 {
70   /**
71    * DLL
72    */
73   struct GetPeerCls *next;
74   struct GetPeerCls *prev;
75
76   /**
77    * The #RPS_SamplerRequestHandle this single request belongs to.
78    */
79   struct RPS_SamplerRequestHandle *req_handle;
80
81   /**
82    * The task for this function.
83    */
84   struct GNUNET_SCHEDULER_Task *get_peer_task;
85
86   /**
87    * The callback
88    */
89   RPS_sampler_rand_peer_ready_cont cont;
90
91   /**
92    * The closure to the callback @e cont
93    */
94   void *cont_cls;
95
96   /**
97    * The address of the id to be stored at
98    */
99   struct GNUNET_PeerIdentity *id;
100 };
101
102
103 /**
104  * Type of function used to differentiate between modified and not modified
105  * Sampler.
106  */
107 typedef void
108 (*RPS_get_peers_type) (void *cls);
109
110 /**
111  * Get one random peer out of the sampled peers.
112  *
113  * We might want to reinitialise this sampler after giving the
114  * corrsponding peer to the client.
115  * Only used internally
116  */
117 static void
118 sampler_get_rand_peer (void *cls);
119
120
121 /**
122  * Get one random peer out of the sampled peers.
123  *
124  * We might want to reinitialise this sampler after giving the
125  * corrsponding peer to the client.
126  */
127 static void
128 sampler_mod_get_rand_peer (void *cls);
129
130
131 /**
132  * Sampler with its own array of SamplerElements
133  */
134 struct RPS_Sampler
135 {
136   /**
137    * Number of sampler elements we hold.
138    */
139   unsigned int sampler_size;
140   //size_t size;
141
142   /**
143    * All sampler elements in one array.
144    */
145   struct RPS_SamplerElement **sampler_elements;
146
147   /**
148    * Maximum time a round takes
149    *
150    * Used in the context of RPS
151    */
152   struct GNUNET_TIME_Relative max_round_interval;
153
154   /**
155    * Stores the function to return peers. Which one it is depends on whether
156    * the Sampler is the modified one or not.
157    */
158   RPS_get_peers_type get_peers;
159
160   /**
161    * Head and tail for the DLL to store the #RPS_SamplerRequestHandle
162    */
163   struct RPS_SamplerRequestHandle *req_handle_head;
164   struct RPS_SamplerRequestHandle *req_handle_tail;
165
166   #ifdef TO_FILE
167   /**
168    * File name to log to
169    */
170   char *file_name;
171   #endif /* TO_FILE */
172 };
173
174 /**
175  * Closure to _get_n_rand_peers_ready_cb()
176  */
177 struct RPS_SamplerRequestHandle
178 {
179   /**
180    * DLL
181    */
182   struct RPS_SamplerRequestHandle *next;
183   struct RPS_SamplerRequestHandle *prev;
184
185   /**
186    * Number of peers we are waiting for.
187    */
188   uint32_t num_peers;
189
190   /**
191    * Number of peers we currently have.
192    */
193   uint32_t cur_num_peers;
194
195   /**
196    * Pointer to the array holding the ids.
197    */
198   struct GNUNET_PeerIdentity *ids;
199
200   /**
201    * Head and tail for the DLL to store the tasks for single requests
202    */
203   struct GetPeerCls *gpc_head;
204   struct GetPeerCls *gpc_tail;
205
206   /**
207    * Sampler.
208    */
209   struct RPS_Sampler *sampler;
210
211   /**
212    * Callback to be called when all ids are available.
213    */
214   RPS_sampler_n_rand_peers_ready_cb callback;
215
216   /**
217    * Closure given to the callback
218    */
219   void *cls;
220 };
221
222 ///**
223 // * Global sampler variable.
224 // */
225 //struct RPS_Sampler *sampler;
226
227
228 /**
229  * The minimal size for the extended sampler elements.
230  */
231 static size_t min_size;
232
233 /**
234  * The maximal size the extended sampler elements should grow to.
235  */
236 static size_t max_size;
237
238 /**
239  * The size the extended sampler elements currently have.
240  */
241 //static size_t extra_size;
242
243 /**
244  * Inedex to the sampler element that is the next to be returned
245  */
246 static uint32_t client_get_index;
247
248
249 /**
250  * Callback to _get_rand_peer() used by _get_n_rand_peers().
251  *
252  * Checks whether all n peers are available. If they are,
253  * give those back.
254  */
255 static void
256 check_n_peers_ready (void *cls,
257                      const struct GNUNET_PeerIdentity *id)
258 {
259   struct RPS_SamplerRequestHandle *req_handle = cls;
260   (void) id;
261
262   req_handle->cur_num_peers++;
263   LOG (GNUNET_ERROR_TYPE_DEBUG,
264       "Got %" PRIX32 ". of %" PRIX32 " peers\n",
265       req_handle->cur_num_peers, req_handle->num_peers);
266
267   if (req_handle->num_peers == req_handle->cur_num_peers)
268   { /* All peers are ready -- return those to the client */
269     GNUNET_assert (NULL != req_handle->callback);
270
271     LOG (GNUNET_ERROR_TYPE_DEBUG,
272         "returning %" PRIX32 " peers to the client\n",
273         req_handle->num_peers);
274     req_handle->callback (req_handle->cls, req_handle->ids, req_handle->num_peers);
275
276     RPS_sampler_request_cancel (req_handle);
277   }
278 }
279
280
281 /**
282  * Get the size of the sampler.
283  *
284  * @param sampler the sampler to return the size of.
285  * @return the size of the sampler
286  */
287 unsigned int
288 RPS_sampler_get_size (struct RPS_Sampler *sampler)
289 {
290   return sampler->sampler_size;
291 }
292
293
294 /**
295  * Grow or shrink the size of the sampler.
296  *
297  * @param sampler the sampler to resize.
298  * @param new_size the new size of the sampler
299  */
300 static void
301 sampler_resize (struct RPS_Sampler *sampler, unsigned int new_size)
302 {
303   unsigned int old_size;
304   uint32_t i;
305
306   // TODO check min and max size
307
308   old_size = sampler->sampler_size;
309
310   if (old_size > new_size)
311   { /* Shrinking */
312
313     LOG (GNUNET_ERROR_TYPE_DEBUG,
314          "Shrinking sampler %d -> %d\n",
315          old_size,
316          new_size);
317
318     to_file (sampler->file_name,
319          "Shrinking sampler %d -> %d",
320          old_size,
321          new_size);
322
323     for (i = new_size ; i < old_size ; i++)
324     {
325       to_file (sampler->file_name,
326                "-%" PRIu32 ": %s",
327                i,
328                sampler->sampler_elements[i]->file_name);
329       RPS_sampler_elem_destroy (sampler->sampler_elements[i]);
330     }
331
332     GNUNET_array_grow (sampler->sampler_elements,
333                        sampler->sampler_size,
334                        new_size);
335     LOG (GNUNET_ERROR_TYPE_DEBUG,
336          "sampler->sampler_elements now points to %p\n",
337          sampler->sampler_elements);
338
339   }
340   else if (old_size < new_size)
341   { /* Growing */
342     LOG (GNUNET_ERROR_TYPE_DEBUG,
343          "Growing sampler %d -> %d\n",
344          old_size,
345          new_size);
346
347     to_file (sampler->file_name,
348          "Growing sampler %d -> %d",
349          old_size,
350          new_size);
351
352     GNUNET_array_grow (sampler->sampler_elements,
353         sampler->sampler_size,
354         new_size);
355
356     for (i = old_size ; i < new_size ; i++)
357     { /* Add new sampler elements */
358       sampler->sampler_elements[i] = RPS_sampler_elem_create ();
359
360       to_file (sampler->file_name,
361                "+%" PRIu32 ": %s",
362                i,
363                sampler->sampler_elements[i]->file_name);
364     }
365   }
366   else
367   {
368     LOG (GNUNET_ERROR_TYPE_DEBUG, "Size remains the same -- nothing to do\n");
369     return;
370   }
371
372   GNUNET_assert (sampler->sampler_size == new_size);
373 }
374
375
376 /**
377  * Grow or shrink the size of the sampler.
378  *
379  * @param sampler the sampler to resize.
380  * @param new_size the new size of the sampler
381  */
382 void
383 RPS_sampler_resize (struct RPS_Sampler *sampler, unsigned int new_size)
384 {
385   GNUNET_assert (0 < new_size);
386   sampler_resize (sampler, new_size);
387 }
388
389
390 /**
391  * Empty the sampler.
392  *
393  * @param sampler the sampler to empty.
394  * @param new_size the new size of the sampler
395  */
396 static void
397 sampler_empty (struct RPS_Sampler *sampler)
398 {
399   sampler_resize (sampler, 0);
400 }
401
402
403 /**
404  * Initialise a tuple of sampler elements.
405  *
406  * @param init_size the size the sampler is initialised with
407  * @param max_round_interval maximum time a round takes
408  * @return a handle to a sampler that consists of sampler elements.
409  */
410 struct RPS_Sampler *
411 RPS_sampler_init (size_t init_size,
412                   struct GNUNET_TIME_Relative max_round_interval)
413 {
414   struct RPS_Sampler *sampler;
415
416   /* Initialise context around extended sampler */
417   min_size = 10; // TODO make input to _samplers_init()
418   max_size = 1000; // TODO make input to _samplers_init()
419
420   sampler = GNUNET_new (struct RPS_Sampler);
421
422   #ifdef TO_FILE
423   sampler->file_name = create_file ("sampler-");
424
425   LOG (GNUNET_ERROR_TYPE_DEBUG,
426        "Initialised sampler %s\n",
427        sampler->file_name);
428   #endif /* TO_FILE */
429
430   sampler->max_round_interval = max_round_interval;
431   sampler->get_peers = sampler_get_rand_peer;
432   //sampler->sampler_elements = GNUNET_new_array(init_size, struct GNUNET_PeerIdentity);
433   //GNUNET_array_grow (sampler->sampler_elements, sampler->sampler_size, min_size);
434   RPS_sampler_resize (sampler, init_size);
435
436   client_get_index = 0;
437
438   //GNUNET_assert (init_size == sampler->sampler_size);
439   return sampler;
440 }
441
442 /**
443  * Initialise a modified tuple of sampler elements.
444  *
445  * @param init_size the size the sampler is initialised with
446  * @param max_round_interval maximum time a round takes
447  * @return a handle to a sampler that consists of sampler elements.
448  */
449 struct RPS_Sampler *
450 RPS_sampler_mod_init (size_t init_size,
451                       struct GNUNET_TIME_Relative max_round_interval)
452 {
453   struct RPS_Sampler *sampler;
454
455   sampler = RPS_sampler_init (init_size, max_round_interval);
456   sampler->get_peers = sampler_mod_get_rand_peer;
457
458   LOG (GNUNET_ERROR_TYPE_DEBUG,
459        "Initialised modified sampler %s\n",
460        sampler->file_name);
461   to_file (sampler->file_name,
462            "This is a modified sampler");
463
464   return sampler;
465 }
466
467
468 /**
469  * A fuction to update every sampler in the given list
470  *
471  * @param sampler the sampler to update.
472  * @param id the PeerID that is put in the sampler
473  */
474   void
475 RPS_sampler_update (struct RPS_Sampler *sampler,
476                     const struct GNUNET_PeerIdentity *id)
477 {
478   uint32_t i;
479
480   to_file (sampler->file_name,
481            "Got %s",
482            GNUNET_i2s_full (id));
483
484   for (i = 0 ; i < sampler->sampler_size ; i++)
485   {
486     RPS_sampler_elem_next (sampler->sampler_elements[i],
487                            id);
488   }
489
490 }
491
492
493 /**
494  * Reinitialise all previously initialised sampler elements with the given value.
495  *
496  * Used to get rid of a PeerID.
497  *
498  * @param sampler the sampler to reinitialise a sampler element in.
499  * @param id the id of the sampler elements to update.
500  */
501   void
502 RPS_sampler_reinitialise_by_value (struct RPS_Sampler *sampler,
503                                    const struct GNUNET_PeerIdentity *id)
504 {
505   uint32_t i;
506
507   for (i = 0; i < sampler->sampler_size; i++)
508   {
509     if (0 == GNUNET_CRYPTO_cmp_peer_identity(id,
510           &(sampler->sampler_elements[i]->peer_id)) )
511     {
512       LOG (GNUNET_ERROR_TYPE_DEBUG, "Reinitialising sampler\n");
513       to_file (sampler->sampler_elements[i]->file_name,
514                "--- non-active");
515       RPS_sampler_elem_reinit (sampler->sampler_elements[i]);
516     }
517   }
518 }
519
520
521 /**
522  * Get one random peer out of the sampled peers.
523  *
524  * We might want to reinitialise this sampler after giving the
525  * corrsponding peer to the client.
526  * Only used internally
527  */
528 static void
529 sampler_get_rand_peer (void *cls)
530 {
531   struct GetPeerCls *gpc = cls;
532   uint32_t r_index;
533   struct RPS_Sampler *sampler;
534
535   gpc->get_peer_task = NULL;
536   sampler = gpc->req_handle->sampler;
537
538   /**;
539    * Choose the r_index of the peer we want to return
540    * at random from the interval of the gossip list
541    */
542   r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
543       sampler->sampler_size);
544
545   if (EMPTY == sampler->sampler_elements[r_index]->is_empty)
546   {
547     //LOG (GNUNET_ERROR_TYPE_DEBUG,
548     //     "Not returning randomly selected, empty PeerID. - Rescheduling.\n");
549
550     /* FIXME no active wait - get notified, when new id arrives?
551      * Might also be a freshly emptied one. Others might still contain ids.
552      * Counter?
553      */
554     gpc->get_peer_task =
555       GNUNET_SCHEDULER_add_delayed (
556           GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1),
557           &sampler_get_rand_peer,
558           cls);
559     return;
560   }
561
562   GNUNET_CONTAINER_DLL_remove (gpc->req_handle->gpc_head,
563                                gpc->req_handle->gpc_tail,
564                                gpc);
565   *gpc->id = sampler->sampler_elements[r_index]->peer_id;
566   gpc->cont (gpc->cont_cls, gpc->id);
567
568   GNUNET_free (gpc);
569 }
570
571
572 /**
573  * Get one random peer out of the sampled peers.
574  *
575  * This reinitialises the queried sampler element.
576  */
577 static void
578 sampler_mod_get_rand_peer (void *cls)
579 {
580   struct GetPeerCls *gpc = cls;
581   struct RPS_SamplerElement *s_elem;
582   struct GNUNET_TIME_Relative last_request_diff;
583   struct RPS_Sampler *sampler;
584
585   gpc->get_peer_task = NULL;
586   sampler = gpc->req_handle->sampler;
587
588   LOG (GNUNET_ERROR_TYPE_DEBUG, "Single peer was requested\n");
589
590   /* Cycle the #client_get_index one step further */
591   client_get_index = (client_get_index + 1) % sampler->sampler_size;
592
593   s_elem = sampler->sampler_elements[client_get_index];
594   *gpc->id = s_elem->peer_id;
595   GNUNET_assert (NULL != s_elem);
596
597   if (EMPTY == s_elem->is_empty)
598   {
599     LOG (GNUNET_ERROR_TYPE_DEBUG,
600          "Sampler_mod element empty, rescheduling.\n");
601     GNUNET_assert (NULL == gpc->get_peer_task);
602     gpc->get_peer_task =
603       GNUNET_SCHEDULER_add_delayed (sampler->max_round_interval,
604                                     &sampler_mod_get_rand_peer,
605                                     cls);
606     return;
607   }
608
609   /* Check whether we may use this sampler to give it back to the client */
610   if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us != s_elem->last_client_request.abs_value_us)
611   {
612     last_request_diff =
613       GNUNET_TIME_absolute_get_difference (s_elem->last_client_request,
614                                            GNUNET_TIME_absolute_get ());
615     /* We're not going to give it back now if it was
616      * already requested by a client this round */
617     if (last_request_diff.rel_value_us < sampler->max_round_interval.rel_value_us)
618     {
619       LOG (GNUNET_ERROR_TYPE_DEBUG,
620           "Last client request on this sampler was less than max round interval ago -- scheduling for later\n");
621       ///* How many time remains untile the next round has started? */
622       //inv_last_request_diff =
623       //  GNUNET_TIME_absolute_get_difference (last_request_diff,
624       //                                       sampler->max_round_interval);
625       // add a little delay
626       /* Schedule it one round later */
627       GNUNET_assert (NULL == gpc->get_peer_task);
628       gpc->get_peer_task =
629         GNUNET_SCHEDULER_add_delayed (sampler->max_round_interval,
630                                       &sampler_mod_get_rand_peer,
631                                       cls);
632       return;
633     }
634     // TODO add other reasons to wait here
635   }
636
637   s_elem->last_client_request = GNUNET_TIME_absolute_get ();
638   RPS_sampler_elem_reinit (s_elem);
639
640   GNUNET_CONTAINER_DLL_remove (gpc->req_handle->gpc_head,
641                                gpc->req_handle->gpc_tail,
642                                gpc);
643   gpc->cont (gpc->cont_cls, gpc->id);
644   GNUNET_free (gpc);
645 }
646
647
648 /**
649  * Get n random peers out of the sampled peers.
650  *
651  * We might want to reinitialise this sampler after giving the
652  * corrsponding peer to the client.
653  * Random with or without consumption?
654  *
655  * @param sampler the sampler to get peers from.
656  * @param cb callback that will be called once the ids are ready.
657  * @param cls closure given to @a cb
658  * @param for_client #GNUNET_YES if result is used for client,
659  *                   #GNUNET_NO if used internally
660  * @param num_peers the number of peers requested
661  */
662 struct RPS_SamplerRequestHandle *
663 RPS_sampler_get_n_rand_peers (struct RPS_Sampler *sampler,
664                               RPS_sampler_n_rand_peers_ready_cb cb,
665                               void *cls, uint32_t num_peers)
666 {
667   GNUNET_assert (0 != sampler->sampler_size);
668   if (0 == num_peers)
669     return NULL;
670
671   // TODO check if we have too much (distinct) sampled peers
672   uint32_t i;
673   struct RPS_SamplerRequestHandle *req_handle;
674   struct GetPeerCls *gpc;
675
676   req_handle = GNUNET_new (struct RPS_SamplerRequestHandle);
677   req_handle->num_peers = num_peers;
678   req_handle->cur_num_peers = 0;
679   req_handle->ids = GNUNET_new_array (num_peers, struct GNUNET_PeerIdentity);
680   req_handle->sampler = sampler;
681   req_handle->callback = cb;
682   req_handle->cls = cls;
683   GNUNET_CONTAINER_DLL_insert (sampler->req_handle_head,
684                                sampler->req_handle_tail,
685                                req_handle);
686
687   LOG (GNUNET_ERROR_TYPE_DEBUG,
688       "Scheduling requests for %" PRIu32 " peers\n", num_peers);
689
690   for (i = 0 ; i < num_peers ; i++)
691   {
692     gpc = GNUNET_new (struct GetPeerCls);
693     gpc->req_handle = req_handle;
694     gpc->cont = check_n_peers_ready;
695     gpc->cont_cls = req_handle;
696     gpc->id = &req_handle->ids[i];
697
698     GNUNET_CONTAINER_DLL_insert (req_handle->gpc_head,
699                                  req_handle->gpc_tail,
700                                  gpc);
701     // maybe add a little delay
702     gpc->get_peer_task = GNUNET_SCHEDULER_add_now (sampler->get_peers,
703                                                    gpc);
704   }
705   return req_handle;
706 }
707
708 /**
709  * Cancle a request issued through #RPS_sampler_n_rand_peers_ready_cb.
710  *
711  * @param req_handle the handle to the request
712  */
713 void
714 RPS_sampler_request_cancel (struct RPS_SamplerRequestHandle *req_handle)
715 {
716   struct GetPeerCls *i;
717
718   while (NULL != (i = req_handle->gpc_head) )
719   {
720     GNUNET_CONTAINER_DLL_remove (req_handle->gpc_head,
721                                  req_handle->gpc_tail,
722                                  i);
723     if (NULL != i->get_peer_task)
724     {
725       GNUNET_SCHEDULER_cancel (i->get_peer_task);
726     }
727     GNUNET_free (i);
728   }
729   GNUNET_free (req_handle->ids);
730   GNUNET_CONTAINER_DLL_remove (req_handle->sampler->req_handle_head,
731                                req_handle->sampler->req_handle_tail,
732                                req_handle);
733   GNUNET_free (req_handle);
734 }
735
736
737 /**
738  * Counts how many Samplers currently hold a given PeerID.
739  *
740  * @param sampler the sampler to count ids in.
741  * @param id the PeerID to count.
742  *
743  * @return the number of occurrences of id.
744  */
745   uint32_t
746 RPS_sampler_count_id (struct RPS_Sampler *sampler,
747                       const struct GNUNET_PeerIdentity *id)
748 {
749   uint32_t count;
750   uint32_t i;
751
752   count = 0;
753   for ( i = 0 ; i < sampler->sampler_size ; i++ )
754   {
755     if ( 0 == GNUNET_CRYPTO_cmp_peer_identity (&sampler->sampler_elements[i]->peer_id, id)
756         && EMPTY != sampler->sampler_elements[i]->is_empty)
757       count++;
758   }
759   return count;
760 }
761
762
763 /**
764  * Cleans the sampler.
765  */
766   void
767 RPS_sampler_destroy (struct RPS_Sampler *sampler)
768 {
769   if (NULL != sampler->req_handle_head)
770   {
771     LOG (GNUNET_ERROR_TYPE_WARNING,
772         "There are still pending requests. Going to remove them.\n");
773     while (NULL != sampler->req_handle_head)
774     {
775       RPS_sampler_request_cancel (sampler->req_handle_head);
776     }
777   }
778   sampler_empty (sampler);
779   GNUNET_free (sampler);
780 }
781
782 /* end of gnunet-service-rps.c */