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