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