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