src/fs/gnunet-service-fs_pe.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file fs/gnunet-service-fs_pe.c
  23  * @brief API to manage query plan
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-fs.h"
  28 #include "gnunet-service-fs_cp.h"
  29 #include "gnunet-service-fs_pe.h"
  30 #include "gnunet-service-fs_pr.h"
  31
  32
  33 /**
  34  * List of GSF_PendingRequests this request plan
  35  * participates with.
  36  */
  37 struct PendingRequestList;
  38
  39 /**
  40  * Transmission plan for a peer.
  41  */
  42 struct PeerPlan;
  43
  44
  45 /**
  46  * DLL of request plans a particular pending request is
  47  * involved with.
  48  */
  49 struct GSF_RequestPlanReference
  50 {
  51
  52   /**
  53    * This is a doubly-linked list.
  54    */
  55   struct GSF_RequestPlanReference *next;
  56
  57   /**
  58    * This is a doubly-linked list.
  59    */
  60   struct GSF_RequestPlanReference *prev;
  61
  62   /**
  63    * Associated request plan.
  64    */
  65   struct GSF_RequestPlan *rp;
  66
  67   /**
  68    * Corresponding PendingRequestList.
  69    */
  70   struct PendingRequestList *prl;
  71 };
  72
  73
  74 /**
  75  * List of GSF_PendingRequests this request plan
  76  * participates with.
  77  */
  78 struct PendingRequestList
  79 {
  80
  81   /**
  82    * This is a doubly-linked list.
  83    */
  84   struct PendingRequestList *next;
  85
  86   /**
  87    * This is a doubly-linked list.
  88    */
  89   struct PendingRequestList *prev;
  90
  91   /**
  92    * Associated pending request.
  93    */
  94   struct GSF_PendingRequest *pr;
  95
  96   /**
  97    * Corresponding GSF_RequestPlanReference.
  98    */
  99   struct GSF_RequestPlanReference *rpr;
 100
 101 };
 102
 103
 104 /**
 105  * Information we keep per request per peer.  This is a doubly-linked
 106  * list (with head and tail in the 'struct GSF_PendingRequestData')
 107  * with one entry in each heap of each 'struct PeerPlan'.  Each
 108  * entry tracks information relevant for this request and this peer.
 109  */
 110 struct GSF_RequestPlan
 111 {
 112
 113   /**
 114    * This is a doubly-linked list.
 115    */
 116   struct GSF_RequestPlan *next;
 117
 118   /**
 119    * This is a doubly-linked list.
 120    */
 121   struct GSF_RequestPlan *prev;
 122
 123   /**
 124    * Heap node associated with this request and this peer.
 125    */
 126   struct GNUNET_CONTAINER_HeapNode *hn;
 127
 128   /**
 129    * The transmission plan for a peer that this request is associated with.
 130    */
 131   struct PeerPlan *pp;
 132
 133   /**
 134    * Head of list of associated pending requests.
 135    */
 136   struct PendingRequestList *prl_head;
 137
 138   /**
 139    * Tail of list of associated pending requests.
 140    */
 141   struct PendingRequestList *prl_tail;
 142
 143   /**
 144    * Earliest time we'd be happy to (re)transmit this request.
 145    */
 146   struct GNUNET_TIME_Absolute earliest_transmission;
 147
 148   /**
 149    * When was the last time we transmitted this request to this peer? 0 for never.
 150    */
 151   struct GNUNET_TIME_Absolute last_transmission;
 152
 153   /**
 154    * Current priority for this request for this target.
 155    */
 156   uint64_t priority;
 157
 158   /**
 159    * How often did we transmit this request to this peer?
 160    */
 161   unsigned int transmission_counter;
 162
 163 };
 164
 165
 166 /**
 167  * Transmission plan for a peer.
 168  */
 169 struct PeerPlan
 170 {
 171   /**
 172    * Heap with pending queries (struct GSF_RequestPlan), higher weights mean higher priority.
 173    */
 174   struct GNUNET_CONTAINER_Heap *priority_heap;
 175
 176   /**
 177    * Heap with pending queries (struct GSF_RequestPlan), by transmission time, lowest first.
 178    */
 179   struct GNUNET_CONTAINER_Heap *delay_heap;
 180
 181   /**
 182    * Map of queries to plan entries.  All entries in the priority_heap or delay_heap
 183    * should be in the plan map.  Note that it IS possible for the plan map to have
 184    * multiple entries for the same query.
 185    */
 186   struct GNUNET_CONTAINER_MultiHashMap *plan_map;
 187
 188   /**
 189    * Current transmission request handle.
 190    */
 191   struct GSF_PeerTransmitHandle *pth;
 192
 193   /**
 194    * Peer for which this is the plan.
 195    */
 196   struct GSF_ConnectedPeer *cp;
 197
 198   /**
 199    * Current task for executing the plan.
 200    */
 201   GNUNET_SCHEDULER_TaskIdentifier task;
 202 };
 203
 204
 205 /**
 206  * Hash map from peer identities to PeerPlans.
 207  */
 208 static struct GNUNET_CONTAINER_MultiHashMap *plans;
 209
 210 /**
 211  * Sum of all transmission counters (equals total delay for all plan entries).
 212  */
 213 static unsigned long long total_delay;
 214
 215 /**
 216  * Number of plan entries.
 217  */
 218 static unsigned long long plan_count;
 219
 220
 221 /**
 222  * Return the query (key in the plan_map) for the given request plan.
 223  *
 224  * @param rp a request plan
 225  * @return the associated query
 226  */
 227 static const GNUNET_HashCode *
 228 get_rp_key (struct GSF_RequestPlan *rp)
 229 {
 230   return &GSF_pending_request_get_data_ (rp->prl_head->pr)->query;
 231 }
 232
 233
 234 /**
 235  * Figure out when and how to transmit to the given peer.
 236  *
 237  * @param cls the 'struct GSF_ConnectedPeer' for transmission
 238  * @param tc scheduler context
 239  */
 240 static void
 241 schedule_peer_transmission (void *cls,
 242                             const struct GNUNET_SCHEDULER_TaskContext *tc);
 243
 244
 245 /**
 246  * Insert the given request plan into the heap with the appropriate weight.
 247  *
 248  * @param pp associated peer's plan
 249  * @param rp request to plan
 250  */
 251 static void
 252 plan (struct PeerPlan *pp, struct GSF_RequestPlan *rp)
 253 {
 254 #define N ((double)128.0)
 255   /**
 256    * Running average delay we currently impose.
 257    */
 258   static double avg_delay;
 259
 260   struct GSF_PendingRequestData *prd;
 261   struct GNUNET_TIME_Relative delay;
 262
 263   GNUNET_assert (rp->pp == pp);
 264   GNUNET_STATISTICS_set (GSF_stats,
 265                          gettext_noop ("# average retransmission delay (ms)"),
 266                          total_delay * 1000LL / plan_count, GNUNET_NO);
 267   prd = GSF_pending_request_get_data_ (rp->prl_head->pr);
 268
 269   if (rp->transmission_counter < 8)
 270     delay =
 271         GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
 272                                        rp->transmission_counter);
 273   else if (rp->transmission_counter < 32)
 274     delay =
 275         GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
 276                                        8 +
 277                                        (1LL << (rp->transmission_counter - 8)));
 278   else
 279     delay =
 280         GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
 281                                        8 + (1LL << 24));
 282   delay.rel_value =
 283       GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 284                                 delay.rel_value + 1);
 285   /* Add 0.01 to avg_delay to avoid division-by-zero later */
 286   avg_delay = (((avg_delay * (N - 1.0)) + delay.rel_value) / N) + 0.01;
 287
 288   /*
 289    * For the priority, we need to consider a few basic rules:
 290    * 1) if we just started requesting (delay is small), we should
 291    * virtually always have a priority of zero.
 292    * 2) for requests with average latency, our priority should match
 293    * the average priority observed on the network
 294    * 3) even the longest-running requests should not be WAY out of
 295    * the observed average (thus we bound by a factor of 2)
 296    * 4) we add +1 to the observed average priority to avoid everyone
 297    * staying put at zero (2 * 0 = 0...).
 298    *
 299    * Using the specific calculation below, we get:
 300    *
 301    * delay = 0 => priority = 0;
 302    * delay = avg delay => priority = running-average-observed-priority;
 303    * delay >> avg_delay => priority = 2 * running-average-observed-priority;
 304    *
 305    * which satisfies all of the rules above.
 306    *
 307    * Note: M_PI_4 = PI/4 = arctan(1)
 308    */
 309   rp->priority =
 310       round ((GSF_current_priorities +
 311               1.0) * atan (delay.rel_value / avg_delay)) / M_PI_4;
 312   /* Note: usage of 'round' and 'atan' requires -lm */
 313
 314   if (rp->transmission_counter != 0)
 315     delay.rel_value += TTL_DECREMENT;
 316   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 317               "Considering (re)transmission number %u in %llu ms\n",
 318               (unsigned int) rp->transmission_counter,
 319               (unsigned long long) delay.rel_value);
 320   rp->earliest_transmission = GNUNET_TIME_relative_to_absolute (delay);
 321   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 322               "Earliest (re)transmission for `%s' in %us\n",
 323               GNUNET_h2s (&prd->query), rp->transmission_counter);
 324   GNUNET_assert (rp->hn == NULL);
 325   if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value
 326       == 0)
 327     rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap, rp, rp->priority);
 328   else
 329     rp->hn =
 330         GNUNET_CONTAINER_heap_insert (pp->delay_heap, rp,
 331                                       rp->earliest_transmission.abs_value);
 332   GNUNET_assert (GNUNET_YES ==
 333                  GNUNET_CONTAINER_multihashmap_contains_value (pp->plan_map,
 334                                                                get_rp_key (rp),
 335                                                                rp));
 336   if (GNUNET_SCHEDULER_NO_TASK != pp->task)
 337     GNUNET_SCHEDULER_cancel (pp->task);
 338   pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
 339 #undef N
 340 }
 341
 342
 343 /**
 344  * Get the pending request with the highest TTL from the given plan.
 345  *
 346  * @param rp plan to investigate
 347  * @return pending request with highest TTL
 348  */
 349 struct GSF_PendingRequest *
 350 get_latest (const struct GSF_RequestPlan *rp)
 351 {
 352   struct GSF_PendingRequest *ret;
 353   struct PendingRequestList *prl;
 354
 355   prl = rp->prl_head;
 356   ret = prl->pr;
 357   prl = prl->next;
 358   while (NULL != prl)
 359   {
 360     if (GSF_pending_request_get_data_ (prl->pr)->ttl.abs_value >
 361         GSF_pending_request_get_data_ (ret)->ttl.abs_value)
 362       ret = prl->pr;
 363     prl = prl->next;
 364   }
 365   return ret;
 366 }
 367
 368
 369 /**
 370  * Function called to get a message for transmission.
 371  *
 372  * @param cls closure
 373  * @param buf_size number of bytes available in buf
 374  * @param buf where to copy the message, NULL on error (peer disconnect)
 375  * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
 376  */
 377 static size_t
 378 transmit_message_callback (void *cls, size_t buf_size, void *buf)
 379 {
 380   struct PeerPlan *pp = cls;
 381   struct GSF_RequestPlan *rp;
 382   size_t msize;
 383
 384   pp->pth = NULL;
 385   if (NULL == buf)
 386   {
 387     /* failed, try again... */
 388     pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
 389     GNUNET_STATISTICS_update (GSF_stats,
 390                               gettext_noop
 391                               ("# transmission failed (core has no bandwidth)"),
 392                               1, GNUNET_NO);
 393     return 0;
 394   }
 395   rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
 396   if (NULL == rp)
 397   {
 398     pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
 399     return 0;
 400   }
 401   msize = GSF_pending_request_get_message_ (get_latest (rp), buf_size, buf);
 402   if (msize > buf_size)
 403   {
 404     /* buffer to small (message changed), try again */
 405     pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
 406     return 0;
 407   }
 408   /* remove from root, add again elsewhere... */
 409   GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
 410   rp->hn = NULL;
 411   rp->last_transmission = GNUNET_TIME_absolute_get ();
 412   rp->transmission_counter++;
 413   total_delay++;
 414   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 415               "Executing plan %p executed %u times, planning retransmission\n",
 416               rp, rp->transmission_counter);
 417   plan (pp, rp);
 418   GNUNET_STATISTICS_update (GSF_stats,
 419                             gettext_noop
 420                             ("# query messages sent to other peers"), 1,
 421                             GNUNET_NO);
 422   return msize;
 423 }
 424
 425
 426 /**
 427  * Figure out when and how to transmit to the given peer.
 428  *
 429  * @param cls the 'struct PeerPlan'
 430  * @param tc scheduler context
 431  */
 432 static void
 433 schedule_peer_transmission (void *cls,
 434                             const struct GNUNET_SCHEDULER_TaskContext *tc)
 435 {
 436   struct PeerPlan *pp = cls;
 437   struct GSF_RequestPlan *rp;
 438   size_t msize;
 439   struct GNUNET_TIME_Relative delay;
 440
 441   pp->task = GNUNET_SCHEDULER_NO_TASK;
 442   if (pp->pth != NULL)
 443   {
 444     GSF_peer_transmit_cancel_ (pp->pth);
 445     pp->pth = NULL;
 446   }
 447   /* move ready requests to priority queue */
 448   while ((NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
 449          (GNUNET_TIME_absolute_get_remaining
 450           (rp->earliest_transmission).rel_value == 0))
 451   {
 452     GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
 453     rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap, rp, rp->priority);
 454   }
 455   if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
 456   {
 457     /* priority heap (still) empty, check for delay... */
 458     rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
 459     if (NULL == rp)
 460     {
 461       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "No active requests for plan %p.\n",
 462                   pp);
 463       return;                   /* both queues empty */
 464     }
 465     delay = GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission);
 466     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 467                 "Sleeping for %llu ms before retrying requests on plan %p.\n",
 468                 (unsigned long long) delay.rel_value, pp);
 469     GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# delay heap timeout"),
 470                            delay.rel_value, GNUNET_NO);
 471
 472     pp->task =
 473         GNUNET_SCHEDULER_add_delayed (delay, &schedule_peer_transmission, pp);
 474     return;
 475   }
 476   GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# query plans executed"),
 477                             1, GNUNET_NO);
 478   /* process from priority heap */
 479   rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
 480   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Executing query plan %p\n", rp);
 481   GNUNET_assert (NULL != rp);
 482   msize = GSF_pending_request_get_message_ (get_latest (rp), 0, NULL);
 483   pp->pth =
 484       GSF_peer_transmit_ (pp->cp, GNUNET_YES, rp->priority,
 485                           GNUNET_TIME_UNIT_FOREVER_REL, msize,
 486                           &transmit_message_callback, pp);
 487   GNUNET_assert (NULL != pp->pth);
 488 }
 489
 490
 491 /**
 492  * Closure for 'merge_pr'.
 493  */
 494 struct MergeContext
 495 {
 496
 497   struct GSF_PendingRequest *pr;
 498
 499   int merged;
 500
 501 };
 502
 503
 504 /**
 505  * Iterator that checks if an equivalent request is already
 506  * present for this peer.
 507  *
 508  * @param cls closure
 509  * @param query the query
 510  * @param element request plan stored at the node
 511  * @return GNUNET_YES if we should continue to iterate,
 512  *         GNUNET_NO if not (merge success)
 513  */
 514 static int
 515 merge_pr (void *cls, const GNUNET_HashCode * query, void *element)
 516 {
 517   struct MergeContext *mpr = cls;
 518   struct GSF_RequestPlan *rp = element;
 519   struct GSF_PendingRequestData *prd;
 520   struct GSF_RequestPlanReference *rpr;
 521   struct PendingRequestList *prl;
 522   struct GSF_PendingRequest *latest;
 523
 524   if (GNUNET_OK !=
 525       GSF_pending_request_is_compatible_ (mpr->pr, rp->prl_head->pr))
 526     return GNUNET_YES;
 527   /* merge new request with existing request plan */
 528   rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
 529   prl = GNUNET_malloc (sizeof (struct PendingRequestList));
 530   rpr->rp = rp;
 531   rpr->prl = prl;
 532   prl->rpr = rpr;
 533   prl->pr = mpr->pr;
 534   prd = GSF_pending_request_get_data_ (mpr->pr);
 535   GNUNET_CONTAINER_DLL_insert (prd->rpr_head, prd->rpr_tail, rpr);
 536   GNUNET_CONTAINER_DLL_insert (rp->prl_head, rp->prl_tail, prl);
 537   mpr->merged = GNUNET_YES;
 538   GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# requests merged"), 1,
 539                             GNUNET_NO);
 540   latest = get_latest (rp);
 541   if (GSF_pending_request_get_data_ (latest)->ttl.abs_value <
 542       prd->ttl.abs_value)
 543   {
 544     GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# requests refreshed"),
 545                               1, GNUNET_NO);
 546     rp->transmission_counter = 0;       /* reset */
 547   }
 548   return GNUNET_NO;
 549 }
 550
 551
 552 /**
 553  * Create a new query plan entry.
 554  *
 555  * @param cp peer with the entry
 556  * @param pr request with the entry
 557  */
 558 void
 559 GSF_plan_add_ (struct GSF_ConnectedPeer *cp, struct GSF_PendingRequest *pr)
 560 {
 561   struct GNUNET_PeerIdentity id;
 562   struct PeerPlan *pp;
 563   struct GSF_PendingRequestData *prd;
 564   struct GSF_RequestPlan *rp;
 565   struct GSF_RequestPlanReference *rpr;
 566   struct PendingRequestList *prl;
 567   struct MergeContext mpc;
 568
 569   GNUNET_assert (NULL != cp);
 570   GSF_connected_peer_get_identity_ (cp, &id);
 571   pp = GNUNET_CONTAINER_multihashmap_get (plans, &id.hashPubKey);
 572   if (NULL == pp)
 573   {
 574     pp = GNUNET_malloc (sizeof (struct PeerPlan));
 575     pp->plan_map = GNUNET_CONTAINER_multihashmap_create (128);
 576     pp->priority_heap =
 577         GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
 578     pp->delay_heap =
 579         GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
 580     pp->cp = cp;
 581     GNUNET_CONTAINER_multihashmap_put (plans, &id.hashPubKey, pp,
 582                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
 583   }
 584   mpc.merged = GNUNET_NO;
 585   mpc.pr = pr;
 586   GNUNET_CONTAINER_multihashmap_get_multiple (pp->plan_map,
 587                                               &GSF_pending_request_get_data_
 588                                               (pr)->query, &merge_pr, &mpc);
 589   if (mpc.merged != GNUNET_NO)
 590     return;
 591   GNUNET_CONTAINER_multihashmap_get_multiple (pp->plan_map,
 592                                               &GSF_pending_request_get_data_
 593                                               (pr)->query, &merge_pr, &mpc);
 594   if (mpc.merged != GNUNET_NO)
 595     return;
 596   plan_count++;
 597   GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# query plan entries"), 1,
 598                             GNUNET_NO);
 599   prd = GSF_pending_request_get_data_ (pr);
 600   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 601               "Planning transmission of query `%s' to peer `%s'\n",
 602               GNUNET_h2s (&prd->query), GNUNET_i2s (&id));
 603   rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
 604   rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
 605   prl = GNUNET_malloc (sizeof (struct PendingRequestList));
 606   rpr->rp = rp;
 607   rpr->prl = prl;
 608   prl->rpr = rpr;
 609   prl->pr = pr;
 610   GNUNET_CONTAINER_DLL_insert (prd->rpr_head, prd->rpr_tail, rpr);
 611   GNUNET_CONTAINER_DLL_insert (rp->prl_head, rp->prl_tail, prl);
 612   rp->pp = pp;
 613   GNUNET_assert (GNUNET_YES ==
 614                  GNUNET_CONTAINER_multihashmap_put (pp->plan_map,
 615                                                     get_rp_key (rp), rp,
 616                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
 617   plan (pp, rp);
 618 }
 619
 620
 621 /**
 622  * Notify the plan about a peer being no longer available;
 623  * destroy all entries associated with this peer.
 624  *
 625  * @param cp connected peer
 626  */
 627 void
 628 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
 629 {
 630   struct GNUNET_PeerIdentity id;
 631   struct PeerPlan *pp;
 632   struct GSF_RequestPlan *rp;
 633   struct GSF_PendingRequestData *prd;
 634   struct PendingRequestList *prl;
 635
 636   GSF_connected_peer_get_identity_ (cp, &id);
 637   pp = GNUNET_CONTAINER_multihashmap_get (plans, &id.hashPubKey);
 638   if (NULL == pp)
 639     return;                     /* nothing was ever planned for this peer */
 640   GNUNET_assert (GNUNET_YES ==
 641                  GNUNET_CONTAINER_multihashmap_remove (plans, &id.hashPubKey,
 642                                                        pp));
 643   if (NULL != pp->pth)
 644     GSF_peer_transmit_cancel_ (pp->pth);
 645   if (GNUNET_SCHEDULER_NO_TASK != pp->task)
 646   {
 647     GNUNET_SCHEDULER_cancel (pp->task);
 648     pp->task = GNUNET_SCHEDULER_NO_TASK;
 649   }
 650   while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
 651   {
 652     GNUNET_break (GNUNET_YES ==
 653                   GNUNET_CONTAINER_multihashmap_remove (pp->plan_map,
 654                                                         get_rp_key (rp), rp));
 655     while (NULL != (prl = rp->prl_head))
 656     {
 657       GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, prl);
 658       prd = GSF_pending_request_get_data_ (prl->pr);
 659       GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, prl->rpr);
 660       GNUNET_free (prl->rpr);
 661       GNUNET_free (prl);
 662     }
 663     GNUNET_free (rp);
 664   }
 665   GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
 666   while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
 667   {
 668     GNUNET_break (GNUNET_YES ==
 669                   GNUNET_CONTAINER_multihashmap_remove (pp->plan_map,
 670                                                         get_rp_key (rp), rp));
 671     while (NULL != (prl = rp->prl_head))
 672     {
 673       GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, prl);
 674       prd = GSF_pending_request_get_data_ (prl->pr);
 675       GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, prl->rpr);
 676       GNUNET_free (prl->rpr);
 677       GNUNET_free (prl);
 678     }
 679     GNUNET_free (rp);
 680   }
 681   GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# query plan entries"),
 682                          plan_count, GNUNET_NO);
 683
 684   GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
 685   GNUNET_CONTAINER_multihashmap_destroy (pp->plan_map);
 686   GNUNET_free (pp);
 687 }
 688
 689 /**
 690  * Get the last transmission attempt time for the request plan list
 691  * referenced by 'rpr_head', that was sent to 'sender'
 692  *
 693  * @param rpr_head request plan reference list to check.
 694  * @param sender the peer that we've sent the request to.
 695  * @param result the timestamp to fill.
 696  * @return GNUNET_YES if 'result' was changed, GNUNET_NO otherwise.
 697  */
 698 int
 699 GSF_request_plan_reference_get_last_transmission_ (
 700     struct GSF_RequestPlanReference *rpr_head, struct GSF_ConnectedPeer *sender,
 701     struct GNUNET_TIME_Absolute *result)
 702 {
 703   struct GSF_RequestPlanReference *rpr;
 704   for (rpr = rpr_head; rpr; rpr = rpr->next)
 705   {
 706     if (rpr->rp->pp->cp == sender)
 707     {
 708       *result = rpr->rp->last_transmission;
 709       return GNUNET_YES;
 710     }
 711   }
 712   return GNUNET_NO;
 713 }
 714
 715 /**
 716  * Notify the plan about a request being done; destroy all entries
 717  * associated with this request.
 718  *
 719  * @param pr request that is done
 720  */
 721 void
 722 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
 723 {
 724   struct GSF_RequestPlan *rp;
 725   struct GSF_PendingRequestData *prd;
 726   struct GSF_RequestPlanReference *rpr;
 727
 728   prd = GSF_pending_request_get_data_ (pr);
 729   while (NULL != (rpr = prd->rpr_head))
 730   {
 731     GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, rpr);
 732     rp = rpr->rp;
 733     GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, rpr->prl);
 734     if (NULL == rp->prl_head)
 735     {
 736       GNUNET_CONTAINER_heap_remove_node (rp->hn);
 737       plan_count--;
 738       GNUNET_break (GNUNET_YES ==
 739                     GNUNET_CONTAINER_multihashmap_remove (rp->pp->plan_map,
 740                                                           &GSF_pending_request_get_data_
 741                                                           (rpr->prl->pr)->query,
 742                                                           rp));
 743       GNUNET_free (rp);
 744     }
 745     GNUNET_free (rpr->prl);
 746     GNUNET_free (rpr);
 747   }
 748   GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# query plan entries"),
 749                          plan_count, GNUNET_NO);
 750 }
 751
 752
 753 /**
 754  * Initialize plan subsystem.
 755  */
 756 void
 757 GSF_plan_init ()
 758 {
 759   plans = GNUNET_CONTAINER_multihashmap_create (256);
 760 }
 761
 762
 763 /**
 764  * Shutdown plan subsystem.
 765  */
 766 void
 767 GSF_plan_done ()
 768 {
 769   GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (plans));
 770   GNUNET_CONTAINER_multihashmap_destroy (plans);
 771 }
 772
 773
 774
 775 /* end of gnunet-service-fs_pe.h */