src/fs/gnunet-service-fs_pe.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011 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 /**
  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  * Collect an instane number of statistics?  May cause excessive IPC.
  34  */
  35 #define INSANE_STATISTICS GNUNET_NO
  36
  37 /**
  38  * List of GSF_PendingRequests this request plan
  39  * participates with.
  40  */
  41 struct PendingRequestList;
  42
  43 /**
  44  * Transmission plan for a peer.
  45  */
  46 struct PeerPlan;
  47
  48
  49 /**
  50  * M:N binding of plans to pending requests.
  51  * Each pending request can be in a number of plans,
  52  * and each plan can have a number of pending requests.
  53  * Objects of this type indicate a mapping of a plan to
  54  * a particular pending request.
  55  *
  56  * The corresponding head and tail of the "PE" MDLL
  57  * are stored in a `struct GSF_RequestPlan`. (We need
  58  * to be able to lookup all pending requests corresponding
  59  * to a given plan entry.)
  60  *
  61  * Similarly head and tail of the "PR" MDLL are stored
  62  * with the `struct GSF_PendingRequest`.  (We need
  63  * to be able to lookup all plan entries corresponding
  64  * to a given pending request.)
  65  */
  66 struct GSF_PendingRequestPlanBijection
  67 {
  68   /**
  69    * This is a doubly-linked list.
  70    */
  71   struct GSF_PendingRequestPlanBijection *next_PR;
  72
  73   /**
  74    * This is a doubly-linked list.
  75    */
  76   struct GSF_PendingRequestPlanBijection *prev_PR;
  77
  78   /**
  79    * This is a doubly-linked list.
  80    */
  81   struct GSF_PendingRequestPlanBijection *next_PE;
  82
  83   /**
  84    * This is a doubly-linked list.
  85    */
  86   struct GSF_PendingRequestPlanBijection *prev_PE;
  87
  88   /**
  89    * Associated request plan (tells us one of the peers that
  90    * we plan to forward the request to).
  91    */
  92   struct GSF_RequestPlan *rp;
  93
  94   /**
  95    * Associated pending request (identifies request details
  96    * and one of the origins of the request).
  97    */
  98   struct GSF_PendingRequest *pr;
  99 };
 100
 101
 102 /**
 103  * Information we keep per request per peer.  This is a doubly-linked
 104  * list (with head and tail in the `struct GSF_PendingRequestData`)
 105  * with one entry in each heap of each `struct PeerPlan`.  Each
 106  * entry tracks information relevant for this request and this peer.
 107  */
 108 struct GSF_RequestPlan
 109 {
 110   /**
 111    * This is a doubly-linked list.
 112    */
 113   struct GSF_RequestPlan *next;
 114
 115   /**
 116    * This is a doubly-linked list.
 117    */
 118   struct GSF_RequestPlan *prev;
 119
 120   /**
 121    * Heap node associated with this request and this peer.
 122    */
 123   struct GNUNET_CONTAINER_HeapNode *hn;
 124
 125   /**
 126    * The transmission plan for a peer that this request is associated with.
 127    */
 128   struct PeerPlan *pp;
 129
 130   /**
 131    * Head of list of associated pending requests.  This tells us
 132    * which incoming requests from other peers this plan entry
 133    * corresponds to.
 134    */
 135   struct GSF_PendingRequestPlanBijection *pe_head;
 136
 137   /**
 138    * Tail of list of associated pending requests.
 139    */
 140   struct GSF_PendingRequestPlanBijection *pe_tail;
 141
 142   /**
 143    * Earliest time we'd be happy to (re)transmit this request.
 144    */
 145   struct GNUNET_TIME_Absolute earliest_transmission;
 146
 147   /**
 148    * When was the last time we transmitted this request to this peer? 0 for never.
 149    */
 150   struct GNUNET_TIME_Absolute last_transmission;
 151
 152   /**
 153    * Current priority for this request for this target.
 154    */
 155   uint64_t priority;
 156
 157   /**
 158    * How often did we transmit this request to this peer?
 159    */
 160   unsigned int transmission_counter;
 161 };
 162
 163
 164 /**
 165  * Transmission plan for a peer.
 166  */
 167 struct PeerPlan
 168 {
 169   /**
 170    * Heap with pending queries (`struct GSF_RequestPlan`), higher weights mean higher priority.
 171    */
 172   struct GNUNET_CONTAINER_Heap *priority_heap;
 173
 174   /**
 175    * Heap with pending queries (`struct GSF_RequestPlan`), by transmission time, lowest first.
 176    */
 177   struct GNUNET_CONTAINER_Heap *delay_heap;
 178
 179   /**
 180    * Map of queries to plan entries.  All entries in the @e priority_heap
 181    * or @e delay_heap should be in the @e plan_map.  Note that it is
 182    * possible for the @e plan_map to have multiple entries for the same
 183    * query.
 184    */
 185   struct GNUNET_CONTAINER_MultiHashMap *plan_map;
 186
 187   /**
 188    * Peer for which this is the plan.
 189    */
 190   struct GSF_ConnectedPeer *cp;
 191
 192   /**
 193    * Current task for executing the plan.
 194    */
 195   struct GNUNET_SCHEDULER_Task *task;
 196
 197   /**
 198    * Current message under transmission for the plan.
 199    */
 200   struct GNUNET_MQ_Envelope *env;
 201 };
 202
 203
 204 /**
 205  * Hash map from peer identities to PeerPlans.
 206  */
 207 static struct GNUNET_CONTAINER_MultiPeerMap *plans;
 208
 209 /**
 210  * Sum of all transmission counters (equals total delay for all plan entries).
 211  */
 212 static unsigned long long total_delay;
 213
 214 /**
 215  * Number of plan entries.
 216  */
 217 static unsigned long long plan_count;
 218
 219
 220 /**
 221  * Return the query (key in the plan_map) for the given request plan.
 222  * Note that this key may change as there can be multiple pending
 223  * requests for the same key and we just return _one_ of them; this
 224  * particular one might complete while another one might still be
 225  * active, hence the lifetime of the returned hash code is NOT
 226  * necessarily identical to that of the `struct GSF_RequestPlan`
 227  * given.
 228  *
 229  * @param rp a request plan
 230  * @return the associated query
 231  */
 232 static const struct GNUNET_HashCode *
 233 get_rp_key (struct GSF_RequestPlan *rp)
 234 {
 235   return &GSF_pending_request_get_data_ (rp->pe_head->pr)->query;
 236 }
 237
 238
 239 /**
 240  * Insert the given request plan into the heap with the appropriate weight.
 241  *
 242  * @param pp associated peer's plan
 243  * @param rp request to plan
 244  */
 245 static void
 246 plan (struct PeerPlan *pp,
 247       struct GSF_RequestPlan *rp)
 248 {
 249 #define N ((double) 128.0)
 250   /**
 251    * Running average delay we currently impose.
 252    */
 253   static double avg_delay;
 254
 255   struct GSF_PendingRequestData *prd;
 256   struct GNUNET_TIME_Relative delay;
 257
 258   GNUNET_assert (rp->pp == pp);
 259   GNUNET_STATISTICS_set (GSF_stats,
 260                          gettext_noop ("# average retransmission delay (ms)"),
 261                          total_delay * 1000LL / plan_count, GNUNET_NO);
 262   prd = GSF_pending_request_get_data_ (rp->pe_head->pr);
 263
 264   if (rp->transmission_counter < 8)
 265     delay =
 266       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
 267                                      rp->transmission_counter);
 268   else if (rp->transmission_counter < 32)
 269     delay =
 270       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
 271                                      8
 272                                      + (1LL << (rp->transmission_counter - 8)));
 273   else
 274     delay =
 275       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
 276                                      8 + (1LL << 24));
 277   delay.rel_value_us =
 278     GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 279                               delay.rel_value_us + 1);
 280   /* Add 0.01 to avg_delay to avoid division-by-zero later */
 281   avg_delay = (((avg_delay * (N - 1.0)) + delay.rel_value_us) / N) + 0.01;
 282
 283   /*
 284    * For the priority, we need to consider a few basic rules:
 285    * 1) if we just started requesting (delay is small), we should
 286    * virtually always have a priority of zero.
 287    * 2) for requests with average latency, our priority should match
 288    * the average priority observed on the network
 289    * 3) even the longest-running requests should not be WAY out of
 290    * the observed average (thus we bound by a factor of 2)
 291    * 4) we add +1 to the observed average priority to avoid everyone
 292    * staying put at zero (2 * 0 = 0...).
 293    *
 294    * Using the specific calculation below, we get:
 295    *
 296    * delay = 0 => priority = 0;
 297    * delay = avg delay => priority = running-average-observed-priority;
 298    * delay >> avg_delay => priority = 2 * running-average-observed-priority;
 299    *
 300    * which satisfies all of the rules above.
 301    *
 302    * Note: M_PI_4 = PI/4 = arctan(1)
 303    */rp->priority =
 304     round ((GSF_current_priorities
 305             + 1.0) * atan (delay.rel_value_us / avg_delay)) / M_PI_4;
 306   /* Note: usage of 'round' and 'atan' requires -lm */
 307
 308   if (rp->transmission_counter != 0)
 309     delay.rel_value_us += TTL_DECREMENT * 1000;
 310   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 311               "Considering (re)transmission number %u in %s\n",
 312               (unsigned int) rp->transmission_counter,
 313               GNUNET_STRINGS_relative_time_to_string (delay,
 314                                                       GNUNET_YES));
 315   rp->earliest_transmission = GNUNET_TIME_relative_to_absolute (delay);
 316   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 317               "Earliest (re)transmission for `%s' in %us\n",
 318               GNUNET_h2s (&prd->query),
 319               rp->transmission_counter);
 320   GNUNET_assert (rp->hn == NULL);
 321   if (0 == GNUNET_TIME_absolute_get_remaining (
 322         rp->earliest_transmission).rel_value_us)
 323     rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
 324                                            rp,
 325                                            rp->priority);
 326   else
 327     rp->hn =
 328       GNUNET_CONTAINER_heap_insert (pp->delay_heap,
 329                                     rp,
 330                                     rp->earliest_transmission.abs_value_us);
 331   GNUNET_assert (GNUNET_YES ==
 332                  GNUNET_CONTAINER_multihashmap_contains_value (pp->plan_map,
 333                                                                get_rp_key (rp),
 334                                                                rp));
 335 #undef N
 336 }
 337
 338
 339 /**
 340  * Get the pending request with the highest TTL from the given plan.
 341  *
 342  * @param rp plan to investigate
 343  * @return pending request with highest TTL
 344  */
 345 struct GSF_PendingRequest *
 346 get_latest (const struct GSF_RequestPlan *rp)
 347 {
 348   struct GSF_PendingRequest *ret;
 349   struct GSF_PendingRequestPlanBijection *bi;
 350   const struct GSF_PendingRequestData *rprd;
 351   const struct GSF_PendingRequestData *prd;
 352
 353   bi = rp->pe_head;
 354   if (NULL == bi)
 355     return NULL; /* should never happen */
 356   ret = bi->pr;
 357   rprd = GSF_pending_request_get_data_ (ret);
 358   for (bi = bi->next_PE; NULL != bi; bi = bi->next_PE)
 359   {
 360     GNUNET_break (GNUNET_YES ==
 361                   GSF_pending_request_test_active_ (bi->pr));
 362     prd = GSF_pending_request_get_data_ (bi->pr);
 363     if (prd->ttl.abs_value_us > rprd->ttl.abs_value_us)
 364     {
 365       ret = bi->pr;
 366       rprd = prd;
 367     }
 368   }
 369   return ret;
 370 }
 371
 372
 373 /**
 374  * Figure out when and how to transmit to the given peer.
 375  *
 376  * @param cls the `struct PeerPlan`
 377  */
 378 static void
 379 schedule_peer_transmission (void *cls)
 380 {
 381   struct PeerPlan *pp = cls;
 382   struct GSF_RequestPlan *rp;
 383   struct GNUNET_TIME_Relative delay;
 384
 385   if (NULL != pp->task)
 386   {
 387     pp->task = NULL;
 388   }
 389   else
 390   {
 391     GNUNET_assert (NULL != pp->env);
 392     pp->env = NULL;
 393   }
 394   /* move ready requests to priority queue */
 395   while ((NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
 396          (0 == GNUNET_TIME_absolute_get_remaining
 397             (rp->earliest_transmission).rel_value_us))
 398   {
 399     GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
 400     rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
 401                                            rp,
 402                                            rp->priority);
 403   }
 404   if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
 405   {
 406     /* priority heap (still) empty, check for delay... */
 407     rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
 408     if (NULL == rp)
 409     {
 410       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 411                   "No active requests for plan %p.\n",
 412                   pp);
 413       return;                   /* both queues empty */
 414     }
 415     delay = GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission);
 416     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 417                 "Sleeping for %s before retrying requests on plan %p.\n",
 418                 GNUNET_STRINGS_relative_time_to_string (delay,
 419                                                         GNUNET_YES),
 420                 pp);
 421     GNUNET_STATISTICS_set (GSF_stats,
 422                            gettext_noop ("# delay heap timeout (ms)"),
 423                            delay.rel_value_us / 1000LL, GNUNET_NO);
 424
 425     pp->task
 426       = GNUNET_SCHEDULER_add_at (rp->earliest_transmission,
 427                                  &schedule_peer_transmission,
 428                                  pp);
 429     return;
 430   }
 431 #if INSANE_STATISTICS
 432   GNUNET_STATISTICS_update (GSF_stats,
 433                             gettext_noop ("# query plans executed"),
 434                             1,
 435                             GNUNET_NO);
 436 #endif
 437   /* process from priority heap */
 438   rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap);
 439   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 440               "Executing query plan %p\n",
 441               rp);
 442   GNUNET_assert (NULL != rp);
 443   rp->hn = NULL;
 444   rp->last_transmission = GNUNET_TIME_absolute_get ();
 445   rp->transmission_counter++;
 446   total_delay++;
 447   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 448               "Executing plan %p executed %u times, planning retransmission\n",
 449               rp,
 450               rp->transmission_counter);
 451   GNUNET_assert (NULL == pp->env);
 452   pp->env = GSF_pending_request_get_message_ (get_latest (rp));
 453   GNUNET_MQ_notify_sent (pp->env,
 454                          &schedule_peer_transmission,
 455                          pp);
 456   GSF_peer_transmit_ (pp->cp,
 457                       GNUNET_YES,
 458                       rp->priority,
 459                       pp->env);
 460   GNUNET_STATISTICS_update (GSF_stats,
 461                             gettext_noop (
 462                               "# query messages sent to other peers"),
 463                             1,
 464                             GNUNET_NO);
 465   plan (pp,
 466         rp);
 467 }
 468
 469
 470 /**
 471  * Closure for merge_pr().
 472  */
 473 struct MergeContext
 474 {
 475   /**
 476    * Request we are trying to merge.
 477    */
 478   struct GSF_PendingRequest *pr;
 479
 480   /**
 481    * Set to #GNUNET_YES if we succeeded to merge.
 482    */
 483   int merged;
 484 };
 485
 486
 487 /**
 488  * Iterator that checks if an equivalent request is already
 489  * present for this peer.
 490  *
 491  * @param cls closure
 492  * @param query the query
 493  * @param element request plan stored at the node
 494  * @return #GNUNET_YES if we should continue to iterate,
 495  *         #GNUNET_NO if not (merge success)
 496  */
 497 static int
 498 merge_pr (void *cls,
 499           const struct GNUNET_HashCode *query,
 500           void *element)
 501 {
 502   struct MergeContext *mpr = cls;
 503   struct GSF_RequestPlan *rp = element;
 504   struct GSF_PendingRequestData *prd;
 505   struct GSF_PendingRequestPlanBijection *bi;
 506   struct GSF_PendingRequest *latest;
 507
 508   GNUNET_break (GNUNET_YES ==
 509                 GSF_pending_request_test_active_ (mpr->pr));
 510   if (GNUNET_OK !=
 511       GSF_pending_request_is_compatible_ (mpr->pr,
 512                                           rp->pe_head->pr))
 513     return GNUNET_YES;
 514   /* merge new request with existing request plan */
 515   bi = GNUNET_new (struct GSF_PendingRequestPlanBijection);
 516   bi->rp = rp;
 517   bi->pr = mpr->pr;
 518   prd = GSF_pending_request_get_data_ (mpr->pr);
 519   GNUNET_CONTAINER_MDLL_insert (PR,
 520                                 prd->pr_head,
 521                                 prd->pr_tail,
 522                                 bi);
 523   GNUNET_CONTAINER_MDLL_insert (PE,
 524                                 rp->pe_head,
 525                                 rp->pe_tail,
 526                                 bi);
 527   mpr->merged = GNUNET_YES;
 528 #if INSANE_STATISTICS
 529   GNUNET_STATISTICS_update (GSF_stats,
 530                             gettext_noop ("# requests merged"),
 531                             1,
 532                             GNUNET_NO);
 533 #endif
 534   latest = get_latest (rp);
 535   if (GSF_pending_request_get_data_ (latest)->ttl.abs_value_us <
 536       prd->ttl.abs_value_us)
 537   {
 538 #if INSANE_STATISTICS
 539     GNUNET_STATISTICS_update (GSF_stats,
 540                               gettext_noop ("# requests refreshed"),
 541                               1,
 542                               GNUNET_NO);
 543 #endif
 544     rp->transmission_counter = 0;       /* reset */
 545   }
 546   return GNUNET_NO;
 547 }
 548
 549
 550 /**
 551  * Create a new query plan entry.
 552  *
 553  * @param cp peer with the entry
 554  * @param pr request with the entry
 555  */
 556 void
 557 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
 558                struct GSF_PendingRequest *pr)
 559 {
 560   const struct GNUNET_PeerIdentity *id;
 561   struct PeerPlan *pp;
 562   struct GSF_PendingRequestData *prd;
 563   struct GSF_RequestPlan *rp;
 564   struct GSF_PendingRequestPlanBijection *bi;
 565   struct MergeContext mpc;
 566
 567   GNUNET_assert (GNUNET_YES ==
 568                  GSF_pending_request_test_active_ (pr));
 569   GNUNET_assert (NULL != cp);
 570   id = GSF_connected_peer_get_identity2_ (cp);
 571   pp = GNUNET_CONTAINER_multipeermap_get (plans, id);
 572   if (NULL == pp)
 573   {
 574     pp = GNUNET_new (struct PeerPlan);
 575     pp->plan_map = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
 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_assert (GNUNET_OK ==
 582                    GNUNET_CONTAINER_multipeermap_put (plans,
 583                                                       id,
 584                                                       pp,
 585                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 586     pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission,
 587                                          pp);
 588   }
 589   mpc.merged = GNUNET_NO;
 590   mpc.pr = pr;
 591   prd = GSF_pending_request_get_data_ (pr);
 592   GNUNET_CONTAINER_multihashmap_get_multiple (pp->plan_map,
 593                                               &prd->query,
 594                                               &merge_pr,
 595                                               &mpc);
 596   if (GNUNET_NO != mpc.merged)
 597     return;
 598   plan_count++;
 599   GNUNET_STATISTICS_update (GSF_stats,
 600                             gettext_noop ("# query plan entries"),
 601                             1,
 602                             GNUNET_NO);
 603   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 604               "Planning transmission of query `%s' to peer `%s'\n",
 605               GNUNET_h2s (&prd->query),
 606               GNUNET_i2s (id));
 607   rp = GNUNET_new (struct GSF_RequestPlan);
 608   bi = GNUNET_new (struct GSF_PendingRequestPlanBijection);
 609   bi->rp = rp;
 610   bi->pr = pr;
 611   GNUNET_CONTAINER_MDLL_insert (PR,
 612                                 prd->pr_head,
 613                                 prd->pr_tail,
 614                                 bi);
 615   GNUNET_CONTAINER_MDLL_insert (PE,
 616                                 rp->pe_head,
 617                                 rp->pe_tail,
 618                                 bi);
 619   rp->pp = pp;
 620   GNUNET_assert (GNUNET_YES ==
 621                  GNUNET_CONTAINER_multihashmap_put (pp->plan_map,
 622                                                     get_rp_key (rp),
 623                                                     rp,
 624                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
 625   plan (pp,
 626         rp);
 627 }
 628
 629
 630 /**
 631  * Notify the plan about a peer being no longer available;
 632  * destroy all entries associated with this peer.
 633  *
 634  * @param cp connected peer
 635  */
 636 void
 637 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
 638 {
 639   const struct GNUNET_PeerIdentity *id;
 640   struct PeerPlan *pp;
 641   struct GSF_RequestPlan *rp;
 642   struct GSF_PendingRequestData *prd;
 643   struct GSF_PendingRequestPlanBijection *bi;
 644
 645   id = GSF_connected_peer_get_identity2_ (cp);
 646   pp = GNUNET_CONTAINER_multipeermap_get (plans, id);
 647   if (NULL == pp)
 648     return;                     /* nothing was ever planned for this peer */
 649   GNUNET_assert (GNUNET_YES ==
 650                  GNUNET_CONTAINER_multipeermap_remove (plans, id,
 651                                                        pp));
 652   if (NULL != pp->task)
 653   {
 654     GNUNET_SCHEDULER_cancel (pp->task);
 655     pp->task = NULL;
 656   }
 657   while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
 658   {
 659     GNUNET_break (GNUNET_YES ==
 660                   GNUNET_CONTAINER_multihashmap_remove (pp->plan_map,
 661                                                         get_rp_key (rp),
 662                                                         rp));
 663     while (NULL != (bi = rp->pe_head))
 664     {
 665       GNUNET_CONTAINER_MDLL_remove (PE,
 666                                     rp->pe_head,
 667                                     rp->pe_tail,
 668                                     bi);
 669       prd = GSF_pending_request_get_data_ (bi->pr);
 670       GNUNET_CONTAINER_MDLL_remove (PR,
 671                                     prd->pr_head,
 672                                     prd->pr_tail,
 673                                     bi);
 674       GNUNET_free (bi);
 675     }
 676     plan_count--;
 677     GNUNET_free (rp);
 678   }
 679   GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
 680   while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
 681   {
 682     GNUNET_break (GNUNET_YES ==
 683                   GNUNET_CONTAINER_multihashmap_remove (pp->plan_map,
 684                                                         get_rp_key (rp),
 685                                                         rp));
 686     while (NULL != (bi = rp->pe_head))
 687     {
 688       prd = GSF_pending_request_get_data_ (bi->pr);
 689       GNUNET_CONTAINER_MDLL_remove (PE,
 690                                     rp->pe_head,
 691                                     rp->pe_tail,
 692                                     bi);
 693       GNUNET_CONTAINER_MDLL_remove (PR,
 694                                     prd->pr_head,
 695                                     prd->pr_tail,
 696                                     bi);
 697       GNUNET_free (bi);
 698     }
 699     plan_count--;
 700     GNUNET_free (rp);
 701   }
 702   GNUNET_STATISTICS_set (GSF_stats,
 703                          gettext_noop ("# query plan entries"),
 704                          plan_count,
 705                          GNUNET_NO);
 706   GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
 707   GNUNET_CONTAINER_multihashmap_destroy (pp->plan_map);
 708   GNUNET_free (pp);
 709 }
 710
 711
 712 /**
 713  * Get the last transmission attempt time for the request plan list
 714  * referenced by @a pr_head, that was sent to @a sender
 715  *
 716  * @param pr_head request plan reference list to check.
 717  * @param sender the peer that we've sent the request to.
 718  * @param result the timestamp to fill, set to #GNUNET_TIME_UNIT_FOREVER_ABS if never transmitted
 719  * @return #GNUNET_YES if @a result was changed, #GNUNET_NO otherwise.
 720  */
 721 int
 722 GSF_request_plan_reference_get_last_transmission_ (struct
 723                                                    GSF_PendingRequestPlanBijection
 724                                                    *pr_head,
 725                                                    struct GSF_ConnectedPeer *
 726                                                    sender,
 727                                                    struct GNUNET_TIME_Absolute *
 728                                                    result)
 729 {
 730   struct GSF_PendingRequestPlanBijection *bi;
 731
 732   for (bi = pr_head; NULL != bi; bi = bi->next_PR)
 733   {
 734     if (bi->rp->pp->cp == sender)
 735     {
 736       if (0 == bi->rp->last_transmission.abs_value_us)
 737         *result = GNUNET_TIME_UNIT_FOREVER_ABS;
 738       else
 739         *result = bi->rp->last_transmission;
 740       return GNUNET_YES;
 741     }
 742   }
 743   return GNUNET_NO;
 744 }
 745
 746
 747 /**
 748  * Notify the plan about a request being done; destroy all entries
 749  * associated with this request.
 750  *
 751  * @param pr request that is done
 752  */
 753 void
 754 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
 755 {
 756   struct GSF_RequestPlan *rp;
 757   struct GSF_PendingRequestData *prd;
 758   struct GSF_PendingRequestPlanBijection *bi;
 759
 760   prd = GSF_pending_request_get_data_ (pr);
 761   while (NULL != (bi = prd->pr_head))
 762   {
 763     rp = bi->rp;
 764     GNUNET_CONTAINER_MDLL_remove (PR,
 765                                   prd->pr_head,
 766                                   prd->pr_tail,
 767                                   bi);
 768     GNUNET_CONTAINER_MDLL_remove (PE,
 769                                   rp->pe_head,
 770                                   rp->pe_tail,
 771                                   bi);
 772     GNUNET_assert (bi->pr == pr);
 773     if (NULL == rp->pe_head)
 774     {
 775       GNUNET_CONTAINER_heap_remove_node (rp->hn);
 776       plan_count--;
 777       GNUNET_break (GNUNET_YES ==
 778                     GNUNET_CONTAINER_multihashmap_remove (rp->pp->plan_map,
 779                                                           &prd->query,
 780                                                           rp));
 781       GNUNET_free (rp);
 782     }
 783     GNUNET_free (bi);
 784   }
 785   GNUNET_STATISTICS_set (GSF_stats,
 786                          gettext_noop ("# query plan entries"),
 787                          plan_count,
 788                          GNUNET_NO);
 789 }
 790
 791
 792 /**
 793  * Initialize plan subsystem.
 794  */
 795 void
 796 GSF_plan_init ()
 797 {
 798   plans = GNUNET_CONTAINER_multipeermap_create (256,
 799                                                 GNUNET_YES);
 800 }
 801
 802
 803 /**
 804  * Shutdown plan subsystem.
 805  */
 806 void
 807 GSF_plan_done ()
 808 {
 809   GNUNET_assert (0 == GNUNET_CONTAINER_multipeermap_size (plans));
 810   GNUNET_CONTAINER_multipeermap_destroy (plans);
 811 }
 812
 813
 814 /* end of gnunet-service-fs_pe.h */