src/fs/gnunet-service-fs_cp.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011, 2016 GNUnet e.V.
   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      SPDX-License-Identifier: AGPL3.0-or-later
  19 */
  20 /**
  21  * @file fs/gnunet-service-fs_cp.c
  22  * @brief API to handle 'connected peers'
  23  * @author Christian Grothoff
  24  */
  25 #include "platform.h"
  26 #include "gnunet_util_lib.h"
  27 #include "gnunet_load_lib.h"
  28 #include "gnunet-service-fs.h"
  29 #include "gnunet-service-fs_cp.h"
  30 #include "gnunet-service-fs_pe.h"
  31 #include "gnunet-service-fs_pr.h"
  32 #include "gnunet-service-fs_push.h"
  33 #include "gnunet_peerstore_service.h"
  34
  35
  36 /**
  37  * Ratio for moving average delay calculation.  The previous
  38  * average goes in with a factor of (n-1) into the calculation.
  39  * Must be > 0.
  40  */
  41 #define RUNAVG_DELAY_N 16
  42
  43 /**
  44  * How often do we flush respect values to disk?
  45  */
  46 #define RESPECT_FLUSH_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
  47
  48 /**
  49  * After how long do we discard a reply?
  50  */
  51 #define REPLY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
  52
  53 /**
  54  * Collect an instane number of statistics?  May cause excessive IPC.
  55  */
  56 #define INSANE_STATISTICS GNUNET_NO
  57
  58
  59 /**
  60  * Handle to cancel a transmission request.
  61  */
  62 struct GSF_PeerTransmitHandle
  63 {
  64
  65   /**
  66    * Kept in a doubly-linked list.
  67    */
  68   struct GSF_PeerTransmitHandle *next;
  69
  70   /**
  71    * Kept in a doubly-linked list.
  72    */
  73   struct GSF_PeerTransmitHandle *prev;
  74
  75   /**
  76    * Time when this transmission request was issued.
  77    */
  78   struct GNUNET_TIME_Absolute transmission_request_start_time;
  79
  80   /**
  81    * Envelope with the actual message.
  82    */
  83   struct GNUNET_MQ_Envelope *env;
  84
  85   /**
  86    * Peer this request targets.
  87    */
  88   struct GSF_ConnectedPeer *cp;
  89
  90   /**
  91    * #GNUNET_YES if this is a query, #GNUNET_NO for content.
  92    */
  93   int is_query;
  94
  95   /**
  96    * Did we get a reservation already?
  97    */
  98   int was_reserved;
  99
 100   /**
 101    * Priority of this request.
 102    */
 103   uint32_t priority;
 104
 105 };
 106
 107
 108 /**
 109  * Handle for an entry in our delay list.
 110  */
 111 struct GSF_DelayedHandle
 112 {
 113
 114   /**
 115    * Kept in a doubly-linked list.
 116    */
 117   struct GSF_DelayedHandle *next;
 118
 119   /**
 120    * Kept in a doubly-linked list.
 121    */
 122   struct GSF_DelayedHandle *prev;
 123
 124   /**
 125    * Peer this transmission belongs to.
 126    */
 127   struct GSF_ConnectedPeer *cp;
 128
 129   /**
 130    * Envelope of the message that was delayed.
 131    */
 132   struct GNUNET_MQ_Envelope *env;
 133
 134   /**
 135    * Task for the delay.
 136    */
 137   struct GNUNET_SCHEDULER_Task *delay_task;
 138
 139   /**
 140    * Size of the message.
 141    */
 142   size_t msize;
 143
 144 };
 145
 146
 147 /**
 148  * Information per peer and request.
 149  */
 150 struct PeerRequest
 151 {
 152
 153   /**
 154    * Handle to generic request (generic: from peer or local client).
 155    */
 156   struct GSF_PendingRequest *pr;
 157
 158   /**
 159    * Which specific peer issued this request?
 160    */
 161   struct GSF_ConnectedPeer *cp;
 162
 163   /**
 164    * Task for asynchronous stopping of this request.
 165    */
 166   struct GNUNET_SCHEDULER_Task *kill_task;
 167
 168 };
 169
 170
 171 /**
 172  * A connected peer.
 173  */
 174 struct GSF_ConnectedPeer
 175 {
 176
 177   /**
 178    * Performance data for this peer.
 179    */
 180   struct GSF_PeerPerformanceData ppd;
 181
 182   /**
 183    * Time until when we blocked this peer from migrating
 184    * data to us.
 185    */
 186   struct GNUNET_TIME_Absolute last_migration_block;
 187
 188   /**
 189    * Task scheduled to revive migration to this peer.
 190    */
 191   struct GNUNET_SCHEDULER_Task *mig_revive_task;
 192
 193   /**
 194    * Messages (replies, queries, content migration) we would like to
 195    * send to this peer in the near future.  Sorted by priority, head.
 196    */
 197   struct GSF_PeerTransmitHandle *pth_head;
 198
 199   /**
 200    * Messages (replies, queries, content migration) we would like to
 201    * send to this peer in the near future.  Sorted by priority, tail.
 202    */
 203   struct GSF_PeerTransmitHandle *pth_tail;
 204
 205   /**
 206    * Messages (replies, queries, content migration) we would like to
 207    * send to this peer in the near future.  Sorted by priority, head.
 208    */
 209   struct GSF_DelayedHandle *delayed_head;
 210
 211   /**
 212    * Messages (replies, queries, content migration) we would like to
 213    * send to this peer in the near future.  Sorted by priority, tail.
 214    */
 215   struct GSF_DelayedHandle *delayed_tail;
 216
 217   /**
 218    * Context of our GNUNET_ATS_reserve_bandwidth call (or NULL).
 219    */
 220   struct GNUNET_ATS_ReservationContext *rc;
 221
 222   /**
 223    * Task scheduled if we need to retry bandwidth reservation later.
 224    */
 225   struct GNUNET_SCHEDULER_Task *rc_delay_task;
 226
 227   /**
 228    * Active requests from this neighbour, map of query to `struct PeerRequest`.
 229    */
 230   struct GNUNET_CONTAINER_MultiHashMap *request_map;
 231
 232   /**
 233    * Handle for an active request for transmission to this
 234    * peer.
 235    */
 236   struct GNUNET_MQ_Handle *mq;
 237
 238   /**
 239    * Increase in traffic preference still to be submitted
 240    * to the core service for this peer.
 241    */
 242   uint64_t inc_preference;
 243
 244   /**
 245    * Number of entries in @e delayed_head DLL.
 246    */
 247   unsigned int delay_queue_size;
 248
 249   /**
 250    * Respect rating for this peer on disk.
 251    */
 252   uint32_t disk_respect;
 253
 254   /**
 255    * Which offset in @e last_p2p_replies will be updated next?
 256    * (we go round-robin).
 257    */
 258   unsigned int last_p2p_replies_woff;
 259
 260   /**
 261    * Which offset in @e last_client_replies will be updated next?
 262    * (we go round-robin).
 263    */
 264   unsigned int last_client_replies_woff;
 265
 266   /**
 267    * Current offset into @e last_request_times ring buffer.
 268    */
 269   unsigned int last_request_times_off;
 270
 271   /**
 272    * #GNUNET_YES if we did successfully reserve 32k bandwidth,
 273    * #GNUNET_NO if not.
 274    */
 275   int did_reserve;
 276
 277   /**
 278    * Handle to the PEERSTORE iterate request for peer respect value
 279    */
 280   struct GNUNET_PEERSTORE_IterateContext *respect_iterate_req;
 281
 282 };
 283
 284
 285 /**
 286  * Map from peer identities to `struct GSF_ConnectPeer` entries.
 287  */
 288 static struct GNUNET_CONTAINER_MultiPeerMap *cp_map;
 289
 290 /**
 291  * Handle to peerstore service.
 292  */
 293 static struct GNUNET_PEERSTORE_Handle *peerstore;
 294
 295 /**
 296  * Task used to flush respect values to disk.
 297  */
 298 static struct GNUNET_SCHEDULER_Task *fr_task;
 299
 300
 301 /**
 302  * Update the latency information kept for the given peer.
 303  *
 304  * @param id peer record to update
 305  * @param latency current latency value
 306  */
 307 void
 308 GSF_update_peer_latency_ (const struct GNUNET_PeerIdentity *id,
 309                           struct GNUNET_TIME_Relative latency)
 310 {
 311   struct GSF_ConnectedPeer *cp;
 312
 313   cp = GSF_peer_get_ (id);
 314   if (NULL == cp)
 315     return; /* we're not yet connected at the core level, ignore */
 316   GNUNET_LOAD_value_set_decline (cp->ppd.transmission_delay,
 317                                  latency);
 318 }
 319
 320
 321 /**
 322  * Return the performance data record for the given peer
 323  *
 324  * @param cp peer to query
 325  * @return performance data record for the peer
 326  */
 327 struct GSF_PeerPerformanceData *
 328 GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp)
 329 {
 330   return &cp->ppd;
 331 }
 332
 333
 334 /**
 335  * Core is ready to transmit to a peer, get the message.
 336  *
 337  * @param cp which peer to send a message to
 338  */
 339 static void
 340 peer_transmit (struct GSF_ConnectedPeer *cp);
 341
 342
 343 /**
 344  * Function called by core upon success or failure of our bandwidth reservation request.
 345  *
 346  * @param cls the `struct GSF_ConnectedPeer` of the peer for which we made the request
 347  * @param peer identifies the peer
 348  * @param amount set to the amount that was actually reserved or unreserved;
 349  *               either the full requested amount or zero (no partial reservations)
 350  * @param res_delay if the reservation could not be satisfied (amount was 0), how
 351  *        long should the client wait until re-trying?
 352  */
 353 static void
 354 ats_reserve_callback (void *cls,
 355                       const struct GNUNET_PeerIdentity *peer,
 356                       int32_t amount,
 357                       struct GNUNET_TIME_Relative res_delay);
 358
 359
 360 /**
 361  * If ready (bandwidth reserved), try to schedule transmission via
 362  * core for the given handle.
 363  *
 364  * @param pth transmission handle to schedule
 365  */
 366 static void
 367 schedule_transmission (struct GSF_PeerTransmitHandle *pth)
 368 {
 369   struct GSF_ConnectedPeer *cp;
 370   struct GNUNET_PeerIdentity target;
 371
 372   cp = pth->cp;
 373   GNUNET_assert (0 != cp->ppd.pid);
 374   GNUNET_PEER_resolve (cp->ppd.pid, &target);
 375
 376   if (0 != cp->inc_preference)
 377   {
 378     GNUNET_ATS_performance_change_preference (GSF_ats,
 379                                               &target,
 380                                               GNUNET_ATS_PREFERENCE_BANDWIDTH,
 381                                               (double) cp->inc_preference,
 382                                               GNUNET_ATS_PREFERENCE_END);
 383     cp->inc_preference = 0;
 384   }
 385
 386   if ( (GNUNET_YES == pth->is_query) &&
 387        (GNUNET_YES != pth->was_reserved) )
 388   {
 389     /* query, need reservation */
 390     if (GNUNET_YES != cp->did_reserve)
 391       return;                   /* not ready */
 392     cp->did_reserve = GNUNET_NO;
 393     /* reservation already done! */
 394     pth->was_reserved = GNUNET_YES;
 395     cp->rc = GNUNET_ATS_reserve_bandwidth (GSF_ats,
 396                                            &target,
 397                                            DBLOCK_SIZE,
 398                                            &ats_reserve_callback,
 399                                            cp);
 400     return;
 401   }
 402   peer_transmit (cp);
 403 }
 404
 405
 406 /**
 407  * Core is ready to transmit to a peer, get the message.
 408  *
 409  * @param cp which peer to send a message to
 410  */
 411 static void
 412 peer_transmit (struct GSF_ConnectedPeer *cp)
 413 {
 414   struct GSF_PeerTransmitHandle *pth = cp->pth_head;
 415   struct GSF_PeerTransmitHandle *pos;
 416
 417   if (NULL == pth)
 418     return;
 419   GNUNET_CONTAINER_DLL_remove (cp->pth_head,
 420                                cp->pth_tail,
 421                                pth);
 422   if (GNUNET_YES == pth->is_query)
 423   {
 424     cp->ppd.last_request_times[(cp->last_request_times_off++) %
 425                                MAX_QUEUE_PER_PEER] =
 426       GNUNET_TIME_absolute_get ();
 427     GNUNET_assert (0 < cp->ppd.pending_queries--);
 428   }
 429   else if (GNUNET_NO == pth->is_query)
 430   {
 431     GNUNET_assert (0 < cp->ppd.pending_replies--);
 432   }
 433   GNUNET_LOAD_update (cp->ppd.transmission_delay,
 434                       GNUNET_TIME_absolute_get_duration
 435                       (pth->transmission_request_start_time).rel_value_us);
 436   GNUNET_MQ_send (cp->mq,
 437                   pth->env);
 438   GNUNET_free (pth);
 439   if (NULL != (pos = cp->pth_head))
 440   {
 441     GNUNET_assert (pos != pth);
 442     schedule_transmission (pos);
 443   }
 444 }
 445
 446
 447 /**
 448  * (re)try to reserve bandwidth from the given peer.
 449  *
 450  * @param cls the `struct GSF_ConnectedPeer` to reserve from
 451  */
 452 static void
 453 retry_reservation (void *cls)
 454 {
 455   struct GSF_ConnectedPeer *cp = cls;
 456   struct GNUNET_PeerIdentity target;
 457
 458   GNUNET_PEER_resolve (cp->ppd.pid, &target);
 459   cp->rc_delay_task = NULL;
 460   cp->rc =
 461     GNUNET_ATS_reserve_bandwidth (GSF_ats,
 462                                   &target,
 463                                   DBLOCK_SIZE,
 464                                   &ats_reserve_callback, cp);
 465 }
 466
 467
 468 /**
 469  * Function called by core upon success or failure of our bandwidth reservation request.
 470  *
 471  * @param cls the `struct GSF_ConnectedPeer` of the peer for which we made the request
 472  * @param peer identifies the peer
 473  * @param amount set to the amount that was actually reserved or unreserved;
 474  *               either the full requested amount or zero (no partial reservations)
 475  * @param res_delay if the reservation could not be satisfied (amount was 0), how
 476  *        long should the client wait until re-trying?
 477  */
 478 static void
 479 ats_reserve_callback (void *cls,
 480                       const struct GNUNET_PeerIdentity *peer,
 481                       int32_t amount,
 482                       struct GNUNET_TIME_Relative res_delay)
 483 {
 484   struct GSF_ConnectedPeer *cp = cls;
 485   struct GSF_PeerTransmitHandle *pth;
 486
 487   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 488               "Reserved %d bytes / need to wait %s for reservation\n",
 489               (int) amount,
 490               GNUNET_STRINGS_relative_time_to_string (res_delay, GNUNET_YES));
 491   cp->rc = NULL;
 492   if (0 == amount)
 493   {
 494     cp->rc_delay_task =
 495         GNUNET_SCHEDULER_add_delayed (res_delay,
 496                                       &retry_reservation,
 497                                       cp);
 498     return;
 499   }
 500   cp->did_reserve = GNUNET_YES;
 501   pth = cp->pth_head;
 502   if (NULL != pth)
 503   {
 504     /* reservation success, try transmission now! */
 505     peer_transmit (cp);
 506   }
 507 }
 508
 509
 510 /**
 511  * Function called by PEERSTORE with peer respect record
 512  *
 513  * @param cls handle to connected peer entry
 514  * @param record peerstore record information
 515  * @param emsg error message, or NULL if no errors
 516  */
 517 static void
 518 peer_respect_cb (void *cls,
 519                  const struct GNUNET_PEERSTORE_Record *record,
 520                  const char *emsg)
 521 {
 522   struct GSF_ConnectedPeer *cp = cls;
 523
 524   GNUNET_assert (NULL != cp->respect_iterate_req);
 525   if ( (NULL != record) &&
 526        (sizeof (cp->disk_respect) == record->value_size))
 527   {
 528     cp->disk_respect = *((uint32_t *)record->value);
 529     cp->ppd.respect += *((uint32_t *)record->value);
 530   }
 531   GSF_push_start_ (cp);
 532   if (NULL != record)
 533     GNUNET_PEERSTORE_iterate_cancel (cp->respect_iterate_req);
 534   cp->respect_iterate_req = NULL;
 535 }
 536
 537
 538 /**
 539  * Function called for each pending request whenever a new
 540  * peer connects, giving us a chance to decide about submitting
 541  * the existing request to the new peer.
 542  *
 543  * @param cls the `struct GSF_ConnectedPeer` of the new peer
 544  * @param key query for the request
 545  * @param pr handle to the pending request
 546  * @return #GNUNET_YES to continue to iterate
 547  */
 548 static int
 549 consider_peer_for_forwarding (void *cls,
 550                               const struct GNUNET_HashCode *key,
 551                               struct GSF_PendingRequest *pr)
 552 {
 553   struct GSF_ConnectedPeer *cp = cls;
 554   struct GNUNET_PeerIdentity pid;
 555
 556   if (GNUNET_YES !=
 557       GSF_pending_request_test_active_ (pr))
 558     return GNUNET_YES; /* request is not actually active, skip! */
 559   GSF_connected_peer_get_identity_ (cp, &pid);
 560   if (GNUNET_YES !=
 561       GSF_pending_request_test_target_ (pr, &pid))
 562   {
 563     GNUNET_STATISTICS_update (GSF_stats,
 564                               gettext_noop ("# Loopback routes suppressed"),
 565                               1,
 566                               GNUNET_NO);
 567     return GNUNET_YES;
 568   }
 569   GSF_plan_add_ (cp, pr);
 570   return GNUNET_YES;
 571 }
 572
 573
 574 /**
 575  * A peer connected to us.  Setup the connected peer
 576  * records.
 577  *
 578  * @param cls NULL
 579  * @param peer identity of peer that connected
 580  * @param mq message queue for talking to @a peer
 581  * @return our internal handle for the peer
 582  */
 583 void *
 584 GSF_peer_connect_handler (void *cls,
 585                           const struct GNUNET_PeerIdentity *peer,
 586                           struct GNUNET_MQ_Handle *mq)
 587 {
 588   struct GSF_ConnectedPeer *cp;
 589
 590   if (0 ==
 591       GNUNET_memcmp (&GSF_my_id,
 592                                        peer))
 593     return NULL;
 594   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 595               "Connected to peer %s\n",
 596               GNUNET_i2s (peer));
 597   cp = GNUNET_new (struct GSF_ConnectedPeer);
 598   cp->ppd.pid = GNUNET_PEER_intern (peer);
 599   cp->ppd.peer = peer;
 600   cp->mq = mq;
 601   cp->ppd.transmission_delay = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_ZERO);
 602   cp->rc =
 603       GNUNET_ATS_reserve_bandwidth (GSF_ats,
 604                                     peer,
 605                                     DBLOCK_SIZE,
 606                                     &ats_reserve_callback, cp);
 607   cp->request_map = GNUNET_CONTAINER_multihashmap_create (128,
 608                                                           GNUNET_YES);
 609   GNUNET_break (GNUNET_OK ==
 610                 GNUNET_CONTAINER_multipeermap_put (cp_map,
 611                GSF_connected_peer_get_identity2_ (cp),
 612                                                    cp,
 613                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 614   GNUNET_STATISTICS_set (GSF_stats,
 615                          gettext_noop ("# peers connected"),
 616                          GNUNET_CONTAINER_multipeermap_size (cp_map),
 617                          GNUNET_NO);
 618   cp->respect_iterate_req
 619     = GNUNET_PEERSTORE_iterate (peerstore,
 620                                 "fs",
 621                                 peer,
 622                                 "respect",
 623                                 &peer_respect_cb,
 624                                 cp);
 625   GSF_iterate_pending_requests_ (&consider_peer_for_forwarding,
 626                                  cp);
 627   return cp;
 628 }
 629
 630
 631 /**
 632  * It may be time to re-start migrating content to this
 633  * peer.  Check, and if so, restart migration.
 634  *
 635  * @param cls the `struct GSF_ConnectedPeer`
 636  */
 637 static void
 638 revive_migration (void *cls)
 639 {
 640   struct GSF_ConnectedPeer *cp = cls;
 641   struct GNUNET_TIME_Relative bt;
 642
 643   cp->mig_revive_task = NULL;
 644   bt = GNUNET_TIME_absolute_get_remaining (cp->ppd.migration_blocked_until);
 645   if (0 != bt.rel_value_us)
 646   {
 647     /* still time left... */
 648     cp->mig_revive_task =
 649         GNUNET_SCHEDULER_add_delayed (bt, &revive_migration, cp);
 650     return;
 651   }
 652   GSF_push_start_ (cp);
 653 }
 654
 655
 656 /**
 657  * Get a handle for a connected peer.
 658  *
 659  * @param peer peer's identity
 660  * @return NULL if the peer is not currently connected
 661  */
 662 struct GSF_ConnectedPeer *
 663 GSF_peer_get_ (const struct GNUNET_PeerIdentity *peer)
 664 {
 665   if (NULL == cp_map)
 666     return NULL;
 667   return GNUNET_CONTAINER_multipeermap_get (cp_map, peer);
 668 }
 669
 670
 671 /**
 672  * Handle P2P #GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP message.
 673  *
 674  * @param cls closure, the `struct GSF_ConnectedPeer`
 675  * @param msm the actual message
 676  */
 677 void
 678 handle_p2p_migration_stop (void *cls,
 679                            const struct MigrationStopMessage *msm)
 680 {
 681   struct GSF_ConnectedPeer *cp = cls;
 682   struct GNUNET_TIME_Relative bt;
 683
 684   GNUNET_STATISTICS_update (GSF_stats,
 685                             gettext_noop ("# migration stop messages received"),
 686                             1, GNUNET_NO);
 687   bt = GNUNET_TIME_relative_ntoh (msm->duration);
 688   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 689               _("Migration of content to peer `%s' blocked for %s\n"),
 690               GNUNET_i2s (cp->ppd.peer),
 691               GNUNET_STRINGS_relative_time_to_string (bt, GNUNET_YES));
 692   cp->ppd.migration_blocked_until = GNUNET_TIME_relative_to_absolute (bt);
 693   if ( (NULL == cp->mig_revive_task) &&
 694        (NULL == cp->respect_iterate_req) )
 695   {
 696     GSF_push_stop_ (cp);
 697     cp->mig_revive_task =
 698         GNUNET_SCHEDULER_add_delayed (bt,
 699                                       &revive_migration, cp);
 700   }
 701 }
 702
 703
 704 /**
 705  * Free resources associated with the given peer request.
 706  *
 707  * @param peerreq request to free
 708  */
 709 static void
 710 free_pending_request (struct PeerRequest *peerreq)
 711 {
 712   struct GSF_ConnectedPeer *cp = peerreq->cp;
 713   struct GSF_PendingRequestData *prd;
 714
 715   prd = GSF_pending_request_get_data_ (peerreq->pr);
 716   if (NULL != peerreq->kill_task)
 717   {
 718     GNUNET_SCHEDULER_cancel (peerreq->kill_task);
 719     peerreq->kill_task = NULL;
 720   }
 721   GNUNET_STATISTICS_update (GSF_stats,
 722                             gettext_noop ("# P2P searches active"),
 723                             -1,
 724                             GNUNET_NO);
 725   GNUNET_break (GNUNET_YES ==
 726                 GNUNET_CONTAINER_multihashmap_remove (cp->request_map,
 727                                                       &prd->query,
 728                                                       peerreq));
 729   GNUNET_free (peerreq);
 730 }
 731
 732
 733 /**
 734  * Cancel all requests associated with the peer.
 735  *
 736  * @param cls unused
 737  * @param query hash code of the request
 738  * @param value the `struct GSF_PendingRequest`
 739  * @return #GNUNET_YES (continue to iterate)
 740  */
 741 static int
 742 cancel_pending_request (void *cls,
 743                         const struct GNUNET_HashCode *query,
 744                         void *value)
 745 {
 746   struct PeerRequest *peerreq = value;
 747   struct GSF_PendingRequest *pr = peerreq->pr;
 748
 749   free_pending_request (peerreq);
 750   GSF_pending_request_cancel_ (pr,
 751                                GNUNET_NO);
 752   return GNUNET_OK;
 753 }
 754
 755
 756 /**
 757  * Free the given request.
 758  *
 759  * @param cls the request to free
 760  */
 761 static void
 762 peer_request_destroy (void *cls)
 763 {
 764   struct PeerRequest *peerreq = cls;
 765   struct GSF_PendingRequest *pr = peerreq->pr;
 766   struct GSF_PendingRequestData *prd;
 767
 768   peerreq->kill_task = NULL;
 769   prd = GSF_pending_request_get_data_ (pr);
 770   cancel_pending_request (NULL,
 771                           &prd->query,
 772                           peerreq);
 773 }
 774
 775
 776 /**
 777  * The artificial delay is over, transmit the message now.
 778  *
 779  * @param cls the `struct GSF_DelayedHandle` with the message
 780  */
 781 static void
 782 transmit_delayed_now (void *cls)
 783 {
 784   struct GSF_DelayedHandle *dh = cls;
 785   struct GSF_ConnectedPeer *cp = dh->cp;
 786
 787   GNUNET_CONTAINER_DLL_remove (cp->delayed_head,
 788                                cp->delayed_tail,
 789                                dh);
 790   cp->delay_queue_size--;
 791   GSF_peer_transmit_ (cp,
 792                       GNUNET_NO,
 793                       UINT32_MAX,
 794                       dh->env);
 795   GNUNET_free (dh);
 796 }
 797
 798
 799 /**
 800  * Get the randomized delay a response should be subjected to.
 801  *
 802  * @return desired delay
 803  */
 804 static struct GNUNET_TIME_Relative
 805 get_randomized_delay ()
 806 {
 807   struct GNUNET_TIME_Relative ret;
 808
 809   ret =
 810       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
 811                                      GNUNET_CRYPTO_random_u32
 812                                      (GNUNET_CRYPTO_QUALITY_WEAK,
 813                                       2 * GSF_avg_latency.rel_value_us + 1));
 814 #if INSANE_STATISTICS
 815   GNUNET_STATISTICS_update (GSF_stats,
 816                             gettext_noop
 817                             ("# artificial delays introduced (ms)"),
 818                             ret.rel_value_us / 1000LL, GNUNET_NO);
 819 #endif
 820   return ret;
 821 }
 822
 823
 824 /**
 825  * Handle a reply to a pending request.  Also called if a request
 826  * expires (then with data == NULL).  The handler may be called
 827  * many times (depending on the request type), but will not be
 828  * called during or after a call to GSF_pending_request_cancel
 829  * and will also not be called anymore after a call signalling
 830  * expiration.
 831  *
 832  * @param cls `struct PeerRequest` this is an answer for
 833  * @param eval evaluation of the result
 834  * @param pr handle to the original pending request
 835  * @param reply_anonymity_level anonymity level for the reply, UINT32_MAX for "unknown"
 836  * @param expiration when does @a data expire?
 837  * @param last_transmission when did we last transmit a request for this block
 838  * @param type type of the block
 839  * @param data response data, NULL on request expiration
 840  * @param data_len number of bytes in @a data
 841  */
 842 static void
 843 handle_p2p_reply (void *cls,
 844                   enum GNUNET_BLOCK_EvaluationResult eval,
 845                   struct GSF_PendingRequest *pr,
 846                   uint32_t reply_anonymity_level,
 847                   struct GNUNET_TIME_Absolute expiration,
 848                   struct GNUNET_TIME_Absolute last_transmission,
 849                   enum GNUNET_BLOCK_Type type,
 850                   const void *data,
 851                   size_t data_len)
 852 {
 853   struct PeerRequest *peerreq = cls;
 854   struct GSF_ConnectedPeer *cp = peerreq->cp;
 855   struct GSF_PendingRequestData *prd;
 856   struct GNUNET_MQ_Envelope *env;
 857   struct PutMessage *pm;
 858   size_t msize;
 859
 860   GNUNET_assert (data_len + sizeof (struct PutMessage) <
 861                  GNUNET_MAX_MESSAGE_SIZE);
 862   GNUNET_assert (peerreq->pr == pr);
 863   prd = GSF_pending_request_get_data_ (pr);
 864   if (NULL == data)
 865   {
 866     free_pending_request (peerreq);
 867     return;
 868   }
 869   GNUNET_break (GNUNET_BLOCK_TYPE_ANY != type);
 870   if ((prd->type != type) && (GNUNET_BLOCK_TYPE_ANY != prd->type))
 871   {
 872     GNUNET_STATISTICS_update (GSF_stats,
 873                               gettext_noop
 874                               ("# replies dropped due to type mismatch"),
 875                                 1, GNUNET_NO);
 876     return;
 877   }
 878   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 879               "Transmitting result for query `%s' to peer\n",
 880               GNUNET_h2s (&prd->query));
 881   GNUNET_STATISTICS_update (GSF_stats,
 882                             gettext_noop ("# replies received for other peers"),
 883                             1, GNUNET_NO);
 884   msize = sizeof (struct PutMessage) + data_len;
 885   if (msize >= GNUNET_MAX_MESSAGE_SIZE)
 886   {
 887     GNUNET_break (0);
 888     return;
 889   }
 890   if ((UINT32_MAX != reply_anonymity_level) && (reply_anonymity_level > 1))
 891   {
 892     if (reply_anonymity_level - 1 > GSF_cover_content_count)
 893     {
 894       GNUNET_STATISTICS_update (GSF_stats,
 895                                 gettext_noop
 896                                 ("# replies dropped due to insufficient cover traffic"),
 897                                 1, GNUNET_NO);
 898       return;
 899     }
 900     GSF_cover_content_count -= (reply_anonymity_level - 1);
 901   }
 902
 903   env = GNUNET_MQ_msg_extra (pm,
 904                              data_len,
 905                              GNUNET_MESSAGE_TYPE_FS_PUT);
 906   pm->type = htonl (type);
 907   pm->expiration = GNUNET_TIME_absolute_hton (expiration);
 908   GNUNET_memcpy (&pm[1],
 909                  data,
 910                  data_len);
 911   if ( (UINT32_MAX != reply_anonymity_level) &&
 912        (0 != reply_anonymity_level) &&
 913        (GNUNET_YES == GSF_enable_randomized_delays) )
 914   {
 915     struct GSF_DelayedHandle *dh;
 916
 917     dh = GNUNET_new (struct GSF_DelayedHandle);
 918     dh->cp = cp;
 919     dh->env = env;
 920     dh->msize = msize;
 921     GNUNET_CONTAINER_DLL_insert (cp->delayed_head,
 922                                  cp->delayed_tail,
 923                                  dh);
 924     cp->delay_queue_size++;
 925     dh->delay_task =
 926         GNUNET_SCHEDULER_add_delayed (get_randomized_delay (),
 927                                       &transmit_delayed_now,
 928                                       dh);
 929   }
 930   else
 931   {
 932     GSF_peer_transmit_ (cp,
 933                         GNUNET_NO,
 934                         UINT32_MAX,
 935                         env);
 936   }
 937   if (GNUNET_BLOCK_EVALUATION_OK_LAST != eval)
 938     return;
 939   if (NULL == peerreq->kill_task)
 940   {
 941     GNUNET_STATISTICS_update (GSF_stats,
 942                               gettext_noop
 943                               ("# P2P searches destroyed due to ultimate reply"),
 944                               1,
 945                               GNUNET_NO);
 946     peerreq->kill_task =
 947         GNUNET_SCHEDULER_add_now (&peer_request_destroy,
 948                                   peerreq);
 949   }
 950 }
 951
 952
 953 /**
 954  * Increase the peer's respect by a value.
 955  *
 956  * @param cp which peer to change the respect value on
 957  * @param value is the int value by which the
 958  *  peer's credit is to be increased or decreased
 959  * @returns the actual change in respect (positive or negative)
 960  */
 961 static int
 962 change_peer_respect (struct GSF_ConnectedPeer *cp, int value)
 963 {
 964   if (0 == value)
 965     return 0;
 966   GNUNET_assert (NULL != cp);
 967   if (value > 0)
 968   {
 969     if (cp->ppd.respect + value < cp->ppd.respect)
 970     {
 971       value = UINT32_MAX - cp->ppd.respect;
 972       cp->ppd.respect = UINT32_MAX;
 973     }
 974     else
 975       cp->ppd.respect += value;
 976   }
 977   else
 978   {
 979     if (cp->ppd.respect < -value)
 980     {
 981       value = -cp->ppd.respect;
 982       cp->ppd.respect = 0;
 983     }
 984     else
 985       cp->ppd.respect += value;
 986   }
 987   return value;
 988 }
 989
 990
 991 /**
 992  * We've received a request with the specified priority.  Bound it
 993  * according to how much we respect the given peer.
 994  *
 995  * @param prio_in requested priority
 996  * @param cp the peer making the request
 997  * @return effective priority
 998  */
 999 static int32_t
1000 bound_priority (uint32_t prio_in,
1001                 struct GSF_ConnectedPeer *cp)
1002 {
1003 #define N ((double)128.0)
1004   uint32_t ret;
1005   double rret;
1006   int ld;
1007
1008   ld = GSF_test_get_load_too_high_ (0);
1009   if (GNUNET_SYSERR == ld)
1010   {
1011 #if INSANE_STATISTICS
1012     GNUNET_STATISTICS_update (GSF_stats,
1013                               gettext_noop
1014                               ("# requests done for free (low load)"), 1,
1015                               GNUNET_NO);
1016 #endif
1017     return 0;                   /* excess resources */
1018   }
1019   if (prio_in > INT32_MAX)
1020     prio_in = INT32_MAX;
1021   ret = -change_peer_respect (cp, -(int) prio_in);
1022   if (ret > 0)
1023   {
1024     if (ret > GSF_current_priorities + N)
1025       rret = GSF_current_priorities + N;
1026     else
1027       rret = ret;
1028     GSF_current_priorities = (GSF_current_priorities * (N - 1) + rret) / N;
1029   }
1030   if ((GNUNET_YES == ld) && (ret > 0))
1031   {
1032     /* try with charging */
1033     ld = GSF_test_get_load_too_high_ (ret);
1034   }
1035   if (GNUNET_YES == ld)
1036   {
1037     GNUNET_STATISTICS_update (GSF_stats,
1038                               gettext_noop
1039                               ("# request dropped, priority insufficient"), 1,
1040                               GNUNET_NO);
1041     /* undo charge */
1042     change_peer_respect (cp, (int) ret);
1043     return -1;                  /* not enough resources */
1044   }
1045   else
1046   {
1047     GNUNET_STATISTICS_update (GSF_stats,
1048                               gettext_noop
1049                               ("# requests done for a price (normal load)"), 1,
1050                               GNUNET_NO);
1051   }
1052 #undef N
1053   return ret;
1054 }
1055
1056
1057 /**
1058  * The priority level imposes a bound on the maximum
1059  * value for the ttl that can be requested.
1060  *
1061  * @param ttl_in requested ttl
1062  * @param prio given priority
1063  * @return @a ttl_in if @a ttl_in is below the limit,
1064  *         otherwise the ttl-limit for the given @a prio
1065  */
1066 static int32_t
1067 bound_ttl (int32_t ttl_in,
1068            uint32_t prio)
1069 {
1070   unsigned long long allowed;
1071
1072   if (ttl_in <= 0)
1073     return ttl_in;
1074   allowed = ((unsigned long long) prio) * TTL_DECREMENT / 1000;
1075   if (ttl_in > allowed)
1076   {
1077     if (allowed >= (1 << 30))
1078       return 1 << 30;
1079     return allowed;
1080   }
1081   return ttl_in;
1082 }
1083
1084
1085 /**
1086  * Closure for #test_exist_cb().
1087  */
1088 struct TestExistClosure
1089 {
1090
1091   /**
1092    * Priority of the incoming request.
1093    */
1094   int32_t priority;
1095
1096   /**
1097    * Relative TTL of the incoming request.
1098    */
1099   int32_t ttl;
1100
1101   /**
1102    * Type of the incoming request.
1103    */
1104   enum GNUNET_BLOCK_Type type;
1105
1106   /**
1107    * Set to #GNUNET_YES if we are done handling the query.
1108    */
1109   int finished;
1110
1111 };
1112
1113
1114 /**
1115  * Test if the query already exists.  If so, merge it, otherwise
1116  * keep `finished` at #GNUNET_NO.
1117  *
1118  * @param cls our `struct TestExistClosure`
1119  * @param hc the key of the query
1120  * @param value the existing `struct PeerRequest`.
1121  * @return #GNUNET_YES to continue to iterate,
1122  *         #GNUNET_NO if we successfully merged
1123  */
1124 static int
1125 test_exist_cb (void *cls,
1126                const struct GNUNET_HashCode *hc,
1127                void *value)
1128 {
1129   struct TestExistClosure *tec = cls;
1130   struct PeerRequest *peerreq = value;
1131   struct GSF_PendingRequest *pr;
1132   struct GSF_PendingRequestData *prd;
1133
1134   pr = peerreq->pr;
1135   prd = GSF_pending_request_get_data_ (pr);
1136   if (prd->type != tec->type)
1137     return GNUNET_YES;
1138   if (prd->ttl.abs_value_us >=
1139       GNUNET_TIME_absolute_get ().abs_value_us + tec->ttl * 1000LL)
1140   {
1141     /* existing request has higher TTL, drop new one! */
1142     prd->priority += tec->priority;
1143     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1144                 "Have existing request with higher TTL, dropping new request.\n");
1145     GNUNET_STATISTICS_update (GSF_stats,
1146                               gettext_noop
1147                               ("# requests dropped due to higher-TTL request"),
1148                               1, GNUNET_NO);
1149     tec->finished = GNUNET_YES;
1150     return GNUNET_NO;
1151   }
1152   /* existing request has lower TTL, drop old one! */
1153   tec->priority += prd->priority;
1154   free_pending_request (peerreq);
1155   GSF_pending_request_cancel_ (pr,
1156                                GNUNET_YES);
1157   return GNUNET_NO;
1158 }
1159
1160
1161 /**
1162  * Handle P2P "QUERY" message.  Creates the pending request entry
1163  * and sets up all of the data structures to that we will
1164  * process replies properly.  Does not initiate forwarding or
1165  * local database lookups.
1166  *
1167  * @param cls the other peer involved (sender of the message)
1168  * @param gm the GET message
1169  */
1170 void
1171 handle_p2p_get (void *cls,
1172                 const struct GetMessage *gm)
1173 {
1174   struct GSF_ConnectedPeer *cps = cls;
1175   struct PeerRequest *peerreq;
1176   struct GSF_PendingRequest *pr;
1177   struct GSF_ConnectedPeer *cp;
1178   const struct GNUNET_PeerIdentity *target;
1179   enum GSF_PendingRequestOptions options;
1180   uint16_t msize;
1181   unsigned int bits;
1182   const struct GNUNET_PeerIdentity *opt;
1183   uint32_t bm;
1184   size_t bfsize;
1185   uint32_t ttl_decrement;
1186   struct TestExistClosure tec;
1187   GNUNET_PEER_Id spid;
1188   const struct GSF_PendingRequestData *prd;
1189
1190   msize = ntohs (gm->header.size);
1191   tec.type = ntohl (gm->type);
1192   bm = ntohl (gm->hash_bitmap);
1193   bits = 0;
1194   while (bm > 0)
1195   {
1196     if (1 == (bm & 1))
1197       bits++;
1198     bm >>= 1;
1199   }
1200   opt = (const struct GNUNET_PeerIdentity *) &gm[1];
1201   bfsize = msize - sizeof (struct GetMessage) - bits * sizeof (struct GNUNET_PeerIdentity);
1202   GNUNET_STATISTICS_update (GSF_stats,
1203                             gettext_noop
1204                             ("# GET requests received (from other peers)"),
1205                             1,
1206                             GNUNET_NO);
1207   GSF_cover_query_count++;
1208   bm = ntohl (gm->hash_bitmap);
1209   bits = 0;
1210   if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
1211     cp = GSF_peer_get_ (&opt[bits++]);
1212   else
1213     cp = cps;
1214   if (NULL == cp)
1215   {
1216     if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
1217       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1218                   "Failed to find RETURN-TO peer `%s' in connection set. Dropping query.\n",
1219                   GNUNET_i2s (&opt[bits - 1]));
1220
1221     else
1222       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1223                   "Failed to find peer `%s' in connection set. Dropping query.\n",
1224                   GNUNET_i2s (cps->ppd.peer));
1225     GNUNET_STATISTICS_update (GSF_stats,
1226                               gettext_noop
1227                               ("# requests dropped due to missing reverse route"),
1228                               1,
1229                               GNUNET_NO);
1230     return;
1231   }
1232   unsigned int queue_size = GNUNET_MQ_get_length (cp->mq);
1233   queue_size += cp->ppd.pending_replies + cp->delay_queue_size;
1234   if (queue_size > MAX_QUEUE_PER_PEER)
1235   {
1236     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1237                 "Peer `%s' has too many replies queued already. Dropping query.\n",
1238                 GNUNET_i2s (cps->ppd.peer));
1239     GNUNET_STATISTICS_update (GSF_stats,
1240                               gettext_noop ("# requests dropped due to full reply queue"),
1241                               1,
1242                               GNUNET_NO);
1243     return;
1244   }
1245   /* note that we can really only check load here since otherwise
1246    * peers could find out that we are overloaded by not being
1247    * disconnected after sending us a malformed query... */
1248   tec.priority = bound_priority (ntohl (gm->priority),
1249                                  cps);
1250   if (tec.priority < 0)
1251   {
1252     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1253                 "Dropping query from `%s', this peer is too busy.\n",
1254                 GNUNET_i2s (cps->ppd.peer));
1255     return;
1256   }
1257   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1258               "Received request for `%s' of type %u from peer `%s' with flags %u\n",
1259               GNUNET_h2s (&gm->query),
1260               (unsigned int) tec.type,
1261               GNUNET_i2s (cps->ppd.peer),
1262               (unsigned int) bm);
1263   target =
1264       (0 !=
1265        (bm & GET_MESSAGE_BIT_TRANSMIT_TO)) ? (&opt[bits++]) : NULL;
1266   options = GSF_PRO_DEFAULTS;
1267   spid = 0;
1268   if ((GNUNET_LOAD_get_load (cp->ppd.transmission_delay) > 3 * (1 + tec.priority))
1269       || (GNUNET_LOAD_get_average (cp->ppd.transmission_delay) >
1270           GNUNET_CONSTANTS_MAX_CORK_DELAY.rel_value_us * 2 +
1271           GNUNET_LOAD_get_average (GSF_rt_entry_lifetime)))
1272   {
1273     /* don't have BW to send to peer, or would likely take longer than we have for it,
1274      * so at best indirect the query */
1275     tec.priority = 0;
1276     options |= GSF_PRO_FORWARD_ONLY;
1277     spid = GNUNET_PEER_intern (cps->ppd.peer);
1278     GNUNET_assert (0 != spid);
1279   }
1280   tec.ttl = bound_ttl (ntohl (gm->ttl),
1281                        tec.priority);
1282   /* decrement ttl (always) */
1283   ttl_decrement =
1284       2 * TTL_DECREMENT + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1285                                                     TTL_DECREMENT);
1286   if ( (tec.ttl < 0) &&
1287        (((int32_t) (tec.ttl - ttl_decrement)) > 0) )
1288   {
1289     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1290                 "Dropping query from `%s' due to TTL underflow (%d - %u).\n",
1291                 GNUNET_i2s (cps->ppd.peer),
1292                 tec.ttl,
1293                 ttl_decrement);
1294     GNUNET_STATISTICS_update (GSF_stats,
1295                               gettext_noop
1296                               ("# requests dropped due TTL underflow"), 1,
1297                               GNUNET_NO);
1298     /* integer underflow => drop (should be very rare)! */
1299     return;
1300   }
1301   tec.ttl -= ttl_decrement;
1302
1303   /* test if the request already exists */
1304   tec.finished = GNUNET_NO;
1305   GNUNET_CONTAINER_multihashmap_get_multiple (cp->request_map,
1306                                               &gm->query,
1307                                               &test_exist_cb,
1308                                               &tec);
1309   if (GNUNET_YES == tec.finished)
1310     return; /* merged into existing request, we're done */
1311
1312   peerreq = GNUNET_new (struct PeerRequest);
1313   peerreq->cp = cp;
1314   pr = GSF_pending_request_create_ (options,
1315                                     tec.type,
1316                                     &gm->query,
1317                                     target,
1318                                     (bfsize > 0)
1319                                     ? (const char *) &opt[bits]
1320                                     : NULL,
1321                                     bfsize,
1322                                     ntohl (gm->filter_mutator),
1323                                     1 /* anonymity */,
1324                                     (uint32_t) tec.priority,
1325                                     tec.ttl,
1326                                     spid,
1327                                     GNUNET_PEER_intern (cps->ppd.peer),
1328                                     NULL, 0,        /* replies_seen */
1329                                     &handle_p2p_reply,
1330                                     peerreq);
1331   GNUNET_assert (NULL != pr);
1332   prd = GSF_pending_request_get_data_ (pr);
1333   peerreq->pr = pr;
1334   GNUNET_break (GNUNET_OK ==
1335                 GNUNET_CONTAINER_multihashmap_put (cp->request_map,
1336                                                    &prd->query,
1337                                                    peerreq,
1338                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
1339   GNUNET_STATISTICS_update (GSF_stats,
1340                             gettext_noop ("# P2P query messages received and processed"),
1341                             1,
1342                             GNUNET_NO);
1343   GNUNET_STATISTICS_update (GSF_stats,
1344                             gettext_noop ("# P2P searches active"),
1345                             1,
1346                             GNUNET_NO);
1347   GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
1348   GSF_local_lookup_ (pr,
1349                      &GSF_consider_forwarding,
1350                      NULL);
1351 }
1352
1353
1354 /**
1355  * Transmit a message to the given peer as soon as possible.
1356  * If the peer disconnects before the transmission can happen,
1357  * the callback is invoked with a `NULL` @a buffer.
1358  *
1359  * @param cp target peer
1360  * @param is_query is this a query (#GNUNET_YES) or content (#GNUNET_NO) or neither (#GNUNET_SYSERR)
1361  * @param priority how important is this request?
1362  * @param timeout when does this request timeout
1363  * @param size number of bytes we would like to send to the peer
1364  * @param env message to send
1365  */
1366 void
1367 GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp,
1368                     int is_query,
1369                     uint32_t priority,
1370                     struct GNUNET_MQ_Envelope *env)
1371 {
1372   struct GSF_PeerTransmitHandle *pth;
1373   struct GSF_PeerTransmitHandle *pos;
1374   struct GSF_PeerTransmitHandle *prev;
1375
1376   pth = GNUNET_new (struct GSF_PeerTransmitHandle);
1377   pth->transmission_request_start_time = GNUNET_TIME_absolute_get ();
1378   pth->env = env;
1379   pth->is_query = is_query;
1380   pth->priority = priority;
1381   pth->cp = cp;
1382   /* insertion sort (by priority, descending) */
1383   prev = NULL;
1384   pos = cp->pth_head;
1385   while ((NULL != pos) && (pos->priority > priority))
1386   {
1387     prev = pos;
1388     pos = pos->next;
1389   }
1390   GNUNET_CONTAINER_DLL_insert_after (cp->pth_head,
1391                                      cp->pth_tail,
1392                                      prev,
1393                                      pth);
1394   if (GNUNET_YES == is_query)
1395     cp->ppd.pending_queries++;
1396   else if (GNUNET_NO == is_query)
1397     cp->ppd.pending_replies++;
1398   schedule_transmission (pth);
1399 }
1400
1401
1402 /**
1403  * Report on receiving a reply; update the performance record of the given peer.
1404  *
1405  * @param cp responding peer (will be updated)
1406  * @param request_time time at which the original query was transmitted
1407  * @param request_priority priority of the original request
1408  */
1409 void
1410 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
1411                               struct GNUNET_TIME_Absolute request_time,
1412                               uint32_t request_priority)
1413 {
1414   struct GNUNET_TIME_Relative delay;
1415
1416   delay = GNUNET_TIME_absolute_get_duration (request_time);
1417   cp->ppd.avg_reply_delay.rel_value_us =
1418       (cp->ppd.avg_reply_delay.rel_value_us * (RUNAVG_DELAY_N - 1) +
1419        delay.rel_value_us) / RUNAVG_DELAY_N;
1420   cp->ppd.avg_priority =
1421       (cp->ppd.avg_priority * (RUNAVG_DELAY_N - 1) +
1422        request_priority) / RUNAVG_DELAY_N;
1423 }
1424
1425
1426 /**
1427  * Report on receiving a reply in response to an initiating client.
1428  * Remember that this peer is good for this client.
1429  *
1430  * @param cp responding peer (will be updated)
1431  * @param initiator_client local client on responsible for query
1432  */
1433 void
1434 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
1435                                    struct GSF_LocalClient *initiator_client)
1436 {
1437   cp->ppd.last_client_replies[cp->last_client_replies_woff++ %
1438                               CS2P_SUCCESS_LIST_SIZE] = initiator_client;
1439 }
1440
1441
1442 /**
1443  * Report on receiving a reply in response to an initiating peer.
1444  * Remember that this peer is good for this initiating peer.
1445  *
1446  * @param cp responding peer (will be updated)
1447  * @param initiator_peer other peer responsible for query
1448  */
1449 void
1450 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
1451                                  const struct GSF_ConnectedPeer *initiator_peer)
1452 {
1453   unsigned int woff;
1454
1455   woff = cp->last_p2p_replies_woff % P2P_SUCCESS_LIST_SIZE;
1456   GNUNET_PEER_change_rc (cp->ppd.last_p2p_replies[woff], -1);
1457   cp->ppd.last_p2p_replies[woff] = initiator_peer->ppd.pid;
1458   GNUNET_PEER_change_rc (initiator_peer->ppd.pid, 1);
1459   cp->last_p2p_replies_woff = (woff + 1) % P2P_SUCCESS_LIST_SIZE;
1460 }
1461
1462
1463 /**
1464  * Write peer-respect information to a file - flush the buffer entry!
1465  *
1466  * @param cls unused
1467  * @param key peer identity
1468  * @param value the `struct GSF_ConnectedPeer` to flush
1469  * @return #GNUNET_OK to continue iteration
1470  */
1471 static int
1472 flush_respect (void *cls,
1473                const struct GNUNET_PeerIdentity *key,
1474                void *value)
1475 {
1476   struct GSF_ConnectedPeer *cp = value;
1477   struct GNUNET_PeerIdentity pid;
1478
1479   if (cp->ppd.respect == cp->disk_respect)
1480     return GNUNET_OK;           /* unchanged */
1481   GNUNET_assert (0 != cp->ppd.pid);
1482   GNUNET_PEER_resolve (cp->ppd.pid, &pid);
1483   GNUNET_PEERSTORE_store (peerstore, "fs", &pid, "respect", &cp->ppd.respect,
1484                           sizeof (cp->ppd.respect),
1485                           GNUNET_TIME_UNIT_FOREVER_ABS,
1486                           GNUNET_PEERSTORE_STOREOPTION_REPLACE,
1487                           NULL,
1488                           NULL);
1489   return GNUNET_OK;
1490 }
1491
1492
1493 /**
1494  * A peer disconnected from us.  Tear down the connected peer
1495  * record.
1496  *
1497  * @param cls unused
1498  * @param peer identity of peer that disconnected
1499  * @param internal_cls the corresponding `struct GSF_ConnectedPeer`
1500  */
1501 void
1502 GSF_peer_disconnect_handler (void *cls,
1503                              const struct GNUNET_PeerIdentity *peer,
1504                              void *internal_cls)
1505 {
1506   struct GSF_ConnectedPeer *cp = internal_cls;
1507   struct GSF_PeerTransmitHandle *pth;
1508   struct GSF_DelayedHandle *dh;
1509
1510   if (NULL == cp)
1511     return;  /* must have been disconnect from core with
1512               * 'peer' == my_id, ignore */
1513   flush_respect (NULL,
1514                  peer,
1515                  cp);
1516   GNUNET_assert (GNUNET_YES ==
1517                  GNUNET_CONTAINER_multipeermap_remove (cp_map,
1518                                                        peer,
1519                                                        cp));
1520   GNUNET_STATISTICS_set (GSF_stats,
1521                          gettext_noop ("# peers connected"),
1522                          GNUNET_CONTAINER_multipeermap_size (cp_map),
1523                          GNUNET_NO);
1524   if (NULL != cp->respect_iterate_req)
1525   {
1526     GNUNET_PEERSTORE_iterate_cancel (cp->respect_iterate_req);
1527     cp->respect_iterate_req = NULL;
1528   }
1529   if (NULL != cp->rc)
1530   {
1531     GNUNET_ATS_reserve_bandwidth_cancel (cp->rc);
1532     cp->rc = NULL;
1533   }
1534   if (NULL != cp->rc_delay_task)
1535   {
1536     GNUNET_SCHEDULER_cancel (cp->rc_delay_task);
1537     cp->rc_delay_task = NULL;
1538   }
1539   GNUNET_CONTAINER_multihashmap_iterate (cp->request_map,
1540                                          &cancel_pending_request,
1541                                          cp);
1542   GNUNET_CONTAINER_multihashmap_destroy (cp->request_map);
1543   cp->request_map = NULL;
1544   GSF_plan_notify_peer_disconnect_ (cp);
1545   GNUNET_LOAD_value_free (cp->ppd.transmission_delay);
1546   GNUNET_PEER_decrement_rcs (cp->ppd.last_p2p_replies,
1547                              P2P_SUCCESS_LIST_SIZE);
1548   memset (cp->ppd.last_p2p_replies,
1549           0,
1550           sizeof (cp->ppd.last_p2p_replies));
1551   GSF_push_stop_ (cp);
1552   while (NULL != (pth = cp->pth_head))
1553   {
1554     GNUNET_CONTAINER_DLL_remove (cp->pth_head,
1555                                  cp->pth_tail,
1556                                  pth);
1557     if (GNUNET_YES == pth->is_query)
1558       GNUNET_assert (0 < cp->ppd.pending_queries--);
1559     else if (GNUNET_NO == pth->is_query)
1560       GNUNET_assert (0 < cp->ppd.pending_replies--);
1561     GNUNET_free (pth);
1562   }
1563   while (NULL != (dh = cp->delayed_head))
1564   {
1565     GNUNET_CONTAINER_DLL_remove (cp->delayed_head,
1566                                  cp->delayed_tail,
1567                                  dh);
1568     GNUNET_MQ_discard (dh->env);
1569     cp->delay_queue_size--;
1570     GNUNET_SCHEDULER_cancel (dh->delay_task);
1571     GNUNET_free (dh);
1572   }
1573   GNUNET_PEER_change_rc (cp->ppd.pid, -1);
1574   if (NULL != cp->mig_revive_task)
1575   {
1576     GNUNET_SCHEDULER_cancel (cp->mig_revive_task);
1577     cp->mig_revive_task = NULL;
1578   }
1579   GNUNET_break (0 == cp->ppd.pending_queries);
1580   GNUNET_break (0 == cp->ppd.pending_replies);
1581   GNUNET_free (cp);
1582 }
1583
1584
1585 /**
1586  * Closure for #call_iterator().
1587  */
1588 struct IterationContext
1589 {
1590   /**
1591    * Function to call on each entry.
1592    */
1593   GSF_ConnectedPeerIterator it;
1594
1595   /**
1596    * Closure for @e it.
1597    */
1598   void *it_cls;
1599 };
1600
1601
1602 /**
1603  * Function that calls the callback for each peer.
1604  *
1605  * @param cls the `struct IterationContext *`
1606  * @param key identity of the peer
1607  * @param value the `struct GSF_ConnectedPeer *`
1608  * @return #GNUNET_YES to continue iteration
1609  */
1610 static int
1611 call_iterator (void *cls,
1612                const struct GNUNET_PeerIdentity *key,
1613                void *value)
1614 {
1615   struct IterationContext *ic = cls;
1616   struct GSF_ConnectedPeer *cp = value;
1617
1618   ic->it (ic->it_cls,
1619           key, cp,
1620           &cp->ppd);
1621   return GNUNET_YES;
1622 }
1623
1624
1625 /**
1626  * Iterate over all connected peers.
1627  *
1628  * @param it function to call for each peer
1629  * @param it_cls closure for @a it
1630  */
1631 void
1632 GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it,
1633                               void *it_cls)
1634 {
1635   struct IterationContext ic;
1636
1637   ic.it = it;
1638   ic.it_cls = it_cls;
1639   GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1640                                          &call_iterator,
1641                                          &ic);
1642 }
1643
1644
1645 /**
1646  * Obtain the identity of a connected peer.
1647  *
1648  * @param cp peer to get identity of
1649  * @param id identity to set (written to)
1650  */
1651 void
1652 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
1653                                   struct GNUNET_PeerIdentity *id)
1654 {
1655   GNUNET_assert (0 != cp->ppd.pid);
1656   GNUNET_PEER_resolve (cp->ppd.pid, id);
1657 }
1658
1659
1660 /**
1661  * Obtain the identity of a connected peer.
1662  *
1663  * @param cp peer to get identity of
1664  * @return reference to peer identity, valid until peer disconnects (!)
1665  */
1666 const struct GNUNET_PeerIdentity *
1667 GSF_connected_peer_get_identity2_ (const struct GSF_ConnectedPeer *cp)
1668 {
1669   GNUNET_assert (0 != cp->ppd.pid);
1670   return GNUNET_PEER_resolve2 (cp->ppd.pid);
1671 }
1672
1673
1674 /**
1675  * Ask a peer to stop migrating data to us until the given point
1676  * in time.
1677  *
1678  * @param cp peer to ask
1679  * @param block_time until when to block
1680  */
1681 void
1682 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
1683                            struct GNUNET_TIME_Absolute block_time)
1684 {
1685   struct GNUNET_MQ_Envelope *env;
1686   struct MigrationStopMessage *msm;
1687
1688   if (cp->last_migration_block.abs_value_us > block_time.abs_value_us)
1689   {
1690     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1691                 "Migration already blocked for another %s\n",
1692                 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining
1693                                                         (cp->last_migration_block), GNUNET_YES));
1694     return;                     /* already blocked */
1695   }
1696   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Asking to stop migration for %s\n",
1697               GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (block_time),
1698                                                       GNUNET_YES));
1699   cp->last_migration_block = block_time;
1700   env = GNUNET_MQ_msg (msm,
1701                        GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP);
1702   msm->reserved = htonl (0);
1703   msm->duration
1704     = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining
1705                                  (cp->last_migration_block));
1706   GNUNET_STATISTICS_update (GSF_stats,
1707                             gettext_noop ("# migration stop messages sent"),
1708                             1,
1709                             GNUNET_NO);
1710   GSF_peer_transmit_ (cp,
1711                       GNUNET_SYSERR,
1712                       UINT32_MAX,
1713                       env);
1714 }
1715
1716
1717 /**
1718  * Notify core about a preference we have for the given peer
1719  * (to allocate more resources towards it).  The change will
1720  * be communicated the next time we reserve bandwidth with
1721  * core (not instantly).
1722  *
1723  * @param cp peer to reserve bandwidth from
1724  * @param pref preference change
1725  */
1726 void
1727 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
1728                                        uint64_t pref)
1729 {
1730   cp->inc_preference += pref;
1731 }
1732
1733
1734 /**
1735  * Call this method periodically to flush respect information to disk.
1736  *
1737  * @param cls closure, not used
1738  */
1739 static void
1740 cron_flush_respect (void *cls)
1741 {
1742   fr_task = NULL;
1743   GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1744                                          &flush_respect,
1745                                          NULL);
1746   fr_task = GNUNET_SCHEDULER_add_delayed_with_priority (RESPECT_FLUSH_FREQ,
1747                                                         GNUNET_SCHEDULER_PRIORITY_HIGH,
1748                                                         &cron_flush_respect, NULL);
1749 }
1750
1751
1752 /**
1753  * Initialize peer management subsystem.
1754  */
1755 void
1756 GSF_connected_peer_init_ ()
1757 {
1758   cp_map = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
1759   peerstore = GNUNET_PEERSTORE_connect (GSF_cfg);
1760   fr_task = GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_HIGH,
1761                                                 &cron_flush_respect, NULL);
1762 }
1763
1764
1765 /**
1766  * Shutdown peer management subsystem.
1767  */
1768 void
1769 GSF_connected_peer_done_ ()
1770 {
1771   GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1772                                          &flush_respect,
1773                                          NULL);
1774   GNUNET_SCHEDULER_cancel (fr_task);
1775   fr_task = NULL;
1776   GNUNET_CONTAINER_multipeermap_destroy (cp_map);
1777   cp_map = NULL;
1778   GNUNET_PEERSTORE_disconnect (peerstore,
1779                                GNUNET_YES);
1780
1781 }
1782
1783
1784 /**
1785  * Iterator to remove references to LC entry.
1786  *
1787  * @param cls the `struct GSF_LocalClient *` to look for
1788  * @param key current key code
1789  * @param value value in the hash map (peer entry)
1790  * @return #GNUNET_YES (we should continue to iterate)
1791  */
1792 static int
1793 clean_local_client (void *cls,
1794                     const struct GNUNET_PeerIdentity *key,
1795                     void *value)
1796 {
1797   const struct GSF_LocalClient *lc = cls;
1798   struct GSF_ConnectedPeer *cp = value;
1799   unsigned int i;
1800
1801   for (i = 0; i < CS2P_SUCCESS_LIST_SIZE; i++)
1802     if (cp->ppd.last_client_replies[i] == lc)
1803       cp->ppd.last_client_replies[i] = NULL;
1804   return GNUNET_YES;
1805 }
1806
1807
1808 /**
1809  * Notification that a local client disconnected.  Clean up all of our
1810  * references to the given handle.
1811  *
1812  * @param lc handle to the local client (henceforth invalid)
1813  */
1814 void
1815 GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc)
1816 {
1817   if (NULL == cp_map)
1818     return;                     /* already cleaned up */
1819   GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1820                                          &clean_local_client,
1821                                          (void *) lc);
1822 }
1823
1824
1825 /* end of gnunet-service-fs_cp.c */