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