2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file fs/gnunet-service-fs_pe.c
23 * @brief API to manage query plan
24 * @author Christian Grothoff
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"
34 * List of GSF_PendingRequests this request plan
37 struct PendingRequestList;
40 * Transmission plan for a peer.
46 * DLL of request plans a particular pending request is
49 struct GSF_RequestPlanReference
53 * This is a doubly-linked list.
55 struct GSF_RequestPlanReference *next;
58 * This is a doubly-linked list.
60 struct GSF_RequestPlanReference *prev;
63 * Associated request plan.
65 struct GSF_RequestPlan *rp;
68 * Corresponding PendingRequestList.
70 struct PendingRequestList *prl;
75 * List of GSF_PendingRequests this request plan
78 struct PendingRequestList
82 * This is a doubly-linked list.
84 struct PendingRequestList *next;
87 * This is a doubly-linked list.
89 struct PendingRequestList *prev;
92 * Associated pending request.
94 struct GSF_PendingRequest *pr;
97 * Corresponding GSF_RequestPlanReference.
99 struct GSF_RequestPlanReference *rpr;
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.
110 struct GSF_RequestPlan
114 * This is a doubly-linked list.
116 struct GSF_RequestPlan *next;
119 * This is a doubly-linked list.
121 struct GSF_RequestPlan *prev;
124 * Heap node associated with this request and this peer.
126 struct GNUNET_CONTAINER_HeapNode *hn;
129 * The transmission plan for a peer that this request is associated with.
134 * Head of list of associated pending requests.
136 struct PendingRequestList *prl_head;
139 * Tail of list of associated pending requests.
141 struct PendingRequestList *prl_tail;
144 * Earliest time we'd be happy to (re)transmit this request.
146 struct GNUNET_TIME_Absolute earliest_transmission;
149 * When was the last time we transmitted this request to this peer? 0 for never.
151 struct GNUNET_TIME_Absolute last_transmission;
154 * Current priority for this request for this target.
159 * How often did we transmit this request to this peer?
161 unsigned int transmission_counter;
167 * Transmission plan for a peer.
172 * Heap with pending queries (struct GSF_RequestPlan), higher weights mean higher priority.
174 struct GNUNET_CONTAINER_Heap *priority_heap;
177 * Heap with pending queries (struct GSF_RequestPlan), by transmission time, lowest first.
179 struct GNUNET_CONTAINER_Heap *delay_heap;
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.
186 struct GNUNET_CONTAINER_MultiHashMap *plan_map;
189 * Current transmission request handle.
191 struct GSF_PeerTransmitHandle *pth;
194 * Peer for which this is the plan.
196 struct GSF_ConnectedPeer *cp;
199 * Current task for executing the plan.
201 GNUNET_SCHEDULER_TaskIdentifier task;
206 * Hash map from peer identities to PeerPlans.
208 static struct GNUNET_CONTAINER_MultiHashMap *plans;
211 * Sum of all transmission counters (equals total delay for all plan entries).
213 static unsigned long long total_delay;
216 * Number of plan entries.
218 static unsigned long long plan_count;
222 * Return the query (key in the plan_map) for the given request plan.
224 * @param rp a request plan
225 * @return the associated query
227 static const GNUNET_HashCode *
228 get_rp_key (struct GSF_RequestPlan *rp)
230 return &GSF_pending_request_get_data_ (rp->prl_head->pr)->query;
235 * Figure out when and how to transmit to the given peer.
237 * @param cls the 'struct GSF_ConnectedPeer' for transmission
238 * @param tc scheduler context
241 schedule_peer_transmission (void *cls,
242 const struct GNUNET_SCHEDULER_TaskContext *tc);
246 * Insert the given request plan into the heap with the appropriate weight.
248 * @param pp associated peer's plan
249 * @param rp request to plan
252 plan (struct PeerPlan *pp, struct GSF_RequestPlan *rp)
254 struct GSF_PendingRequestData *prd;
255 struct GNUNET_TIME_Relative delay;
257 GNUNET_assert (rp->pp == pp);
258 GNUNET_STATISTICS_set (GSF_stats,
259 gettext_noop ("# average retransmission delay (ms)"),
260 total_delay * 1000LL / plan_count, GNUNET_NO);
261 prd = GSF_pending_request_get_data_ (rp->prl_head->pr);
262 // FIXME: calculate 'rp->priority'!
263 if (rp->transmission_counter < 8)
265 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
266 rp->transmission_counter);
267 else if (rp->transmission_counter < 32)
269 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
271 (1LL << (rp->transmission_counter - 8)));
274 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
277 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
278 delay.rel_value + 1);
279 if (rp->transmission_counter != 0)
280 delay.rel_value += TTL_DECREMENT;
281 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
282 "Considering (re)transmission number %u in %llu ms\n",
283 (unsigned int) rp->transmission_counter,
284 (unsigned long long) delay.rel_value);
285 rp->earliest_transmission = GNUNET_TIME_relative_to_absolute (delay);
287 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
288 "Earliest (re)transmission for `%s' in %us\n",
289 GNUNET_h2s (&prd->query), rp->transmission_counter);
292 GNUNET_assert (rp->hn == NULL);
293 if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value
295 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap, rp, rp->priority);
298 GNUNET_CONTAINER_heap_insert (pp->delay_heap, rp,
299 rp->earliest_transmission.abs_value);
300 GNUNET_assert (GNUNET_YES ==
301 GNUNET_CONTAINER_multihashmap_contains_value (pp->plan_map,
304 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
305 GNUNET_SCHEDULER_cancel (pp->task);
306 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
311 * Get the pending request with the highest TTL from the given plan.
313 * @param rp plan to investigate
314 * @return pending request with highest TTL
316 struct GSF_PendingRequest *
317 get_latest (const struct GSF_RequestPlan *rp)
319 struct GSF_PendingRequest *ret;
320 struct PendingRequestList *prl;
327 if (GSF_pending_request_get_data_ (prl->pr)->ttl.abs_value >
328 GSF_pending_request_get_data_ (ret)->ttl.abs_value)
337 * Function called to get a message for transmission.
340 * @param buf_size number of bytes available in buf
341 * @param buf where to copy the message, NULL on error (peer disconnect)
342 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
345 transmit_message_callback (void *cls, size_t buf_size, void *buf)
347 struct PeerPlan *pp = cls;
348 struct GSF_RequestPlan *rp;
354 /* failed, try again... */
355 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
356 GNUNET_STATISTICS_update (GSF_stats,
358 ("# transmission failed (core has no bandwidth)"),
362 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
365 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
368 msize = GSF_pending_request_get_message_ (get_latest (rp), buf_size, buf);
369 if (msize > buf_size)
371 /* buffer to small (message changed), try again */
372 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
375 /* remove from root, add again elsewhere... */
376 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
378 rp->last_transmission = GNUNET_TIME_absolute_get ();
379 rp->transmission_counter++;
382 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
383 "Executing plan %p executed %u times, planning retransmission\n",
384 rp, rp->transmission_counter);
387 GNUNET_STATISTICS_update (GSF_stats,
389 ("# query messages sent to other peers"), 1,
396 * Figure out when and how to transmit to the given peer.
398 * @param cls the 'struct PeerPlan'
399 * @param tc scheduler context
402 schedule_peer_transmission (void *cls,
403 const struct GNUNET_SCHEDULER_TaskContext *tc)
405 struct PeerPlan *pp = cls;
406 struct GSF_RequestPlan *rp;
408 struct GNUNET_TIME_Relative delay;
410 pp->task = GNUNET_SCHEDULER_NO_TASK;
413 GSF_peer_transmit_cancel_ (pp->pth);
416 /* move ready requests to priority queue */
417 while ((NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
418 (GNUNET_TIME_absolute_get_remaining
419 (rp->earliest_transmission).rel_value == 0))
421 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
422 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap, rp, rp->priority);
424 if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
426 /* priority heap (still) empty, check for delay... */
427 rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
431 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "No active requests for plan %p.\n",
434 return; /* both queues empty */
436 delay = GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission);
438 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
439 "Sleeping for %llu ms before retrying requests on plan %p.\n",
440 (unsigned long long) delay.rel_value, pp);
442 GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# delay heap timeout"),
443 delay.rel_value, GNUNET_NO);
446 GNUNET_SCHEDULER_add_delayed (delay, &schedule_peer_transmission, pp);
449 GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# query plans executed"),
451 /* process from priority heap */
452 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
454 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Executing query plan %p\n", rp);
456 GNUNET_assert (NULL != rp);
457 msize = GSF_pending_request_get_message_ (get_latest (rp), 0, NULL);
459 GSF_peer_transmit_ (pp->cp, GNUNET_YES, rp->priority,
460 GNUNET_TIME_UNIT_FOREVER_REL, msize,
461 &transmit_message_callback, pp);
462 GNUNET_assert (NULL != pp->pth);
467 * Closure for 'merge_pr'.
472 struct GSF_PendingRequest *pr;
480 * Iterator that checks if an equivalent request is already
481 * present for this peer.
484 * @param query the query
485 * @param element request plan stored at the node
486 * @return GNUNET_YES if we should continue to iterate,
487 * GNUNET_NO if not (merge success)
490 merge_pr (void *cls, const GNUNET_HashCode * query, void *element)
492 struct MergeContext *mpr = cls;
493 struct GSF_RequestPlan *rp = element;
494 struct GSF_PendingRequestData *prd;
495 struct GSF_RequestPlanReference *rpr;
496 struct PendingRequestList *prl;
497 struct GSF_PendingRequest *latest;
500 GSF_pending_request_is_compatible_ (mpr->pr, rp->prl_head->pr))
502 /* merge new request with existing request plan */
503 rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
504 prl = GNUNET_malloc (sizeof (struct PendingRequestList));
509 prd = GSF_pending_request_get_data_ (mpr->pr);
510 GNUNET_CONTAINER_DLL_insert (prd->rpr_head, prd->rpr_tail, rpr);
511 GNUNET_CONTAINER_DLL_insert (rp->prl_head, rp->prl_tail, prl);
512 mpr->merged = GNUNET_YES;
513 GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# requests merged"), 1,
515 latest = get_latest (rp);
516 if (GSF_pending_request_get_data_ (latest)->ttl.abs_value <
519 GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# requests refreshed"),
521 rp->transmission_counter = 0; /* reset */
528 * Create a new query plan entry.
530 * @param cp peer with the entry
531 * @param pr request with the entry
534 GSF_plan_add_ (struct GSF_ConnectedPeer *cp, struct GSF_PendingRequest *pr)
536 struct GNUNET_PeerIdentity id;
538 struct GSF_PendingRequestData *prd;
539 struct GSF_RequestPlan *rp;
540 struct GSF_RequestPlanReference *rpr;
541 struct PendingRequestList *prl;
542 struct MergeContext mpc;
544 GNUNET_assert (NULL != cp);
545 GSF_connected_peer_get_identity_ (cp, &id);
546 pp = GNUNET_CONTAINER_multihashmap_get (plans, &id.hashPubKey);
549 pp = GNUNET_malloc (sizeof (struct PeerPlan));
550 pp->plan_map = GNUNET_CONTAINER_multihashmap_create (128);
552 GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
554 GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
556 GNUNET_CONTAINER_multihashmap_put (plans, &id.hashPubKey, pp,
557 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
559 mpc.merged = GNUNET_NO;
561 GNUNET_CONTAINER_multihashmap_get_multiple (pp->plan_map,
562 &GSF_pending_request_get_data_
563 (pr)->query, &merge_pr, &mpc);
564 if (mpc.merged != GNUNET_NO)
566 GNUNET_CONTAINER_multihashmap_get_multiple (pp->plan_map,
567 &GSF_pending_request_get_data_
568 (pr)->query, &merge_pr, &mpc);
569 if (mpc.merged != GNUNET_NO)
572 GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# query plan entries"), 1,
574 prd = GSF_pending_request_get_data_ (pr);
576 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
577 "Planning transmission of query `%s' to peer `%s'\n",
578 GNUNET_h2s (&prd->query), GNUNET_i2s (&id));
580 rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
581 rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
582 prl = GNUNET_malloc (sizeof (struct PendingRequestList));
587 GNUNET_CONTAINER_DLL_insert (prd->rpr_head, prd->rpr_tail, rpr);
588 GNUNET_CONTAINER_DLL_insert (rp->prl_head, rp->prl_tail, prl);
590 GNUNET_assert (GNUNET_YES ==
591 GNUNET_CONTAINER_multihashmap_put (pp->plan_map,
593 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
599 * Notify the plan about a peer being no longer available;
600 * destroy all entries associated with this peer.
602 * @param cp connected peer
605 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
607 struct GNUNET_PeerIdentity id;
609 struct GSF_RequestPlan *rp;
610 struct GSF_PendingRequestData *prd;
611 struct PendingRequestList *prl;
613 GSF_connected_peer_get_identity_ (cp, &id);
614 pp = GNUNET_CONTAINER_multihashmap_get (plans, &id.hashPubKey);
616 return; /* nothing was ever planned for this peer */
617 GNUNET_assert (GNUNET_YES ==
618 GNUNET_CONTAINER_multihashmap_remove (plans, &id.hashPubKey,
621 GSF_peer_transmit_cancel_ (pp->pth);
622 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
624 GNUNET_SCHEDULER_cancel (pp->task);
625 pp->task = GNUNET_SCHEDULER_NO_TASK;
627 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
629 GNUNET_break (GNUNET_YES ==
630 GNUNET_CONTAINER_multihashmap_remove (pp->plan_map,
631 get_rp_key (rp), rp));
632 while (NULL != (prl = rp->prl_head))
634 GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, prl);
635 prd = GSF_pending_request_get_data_ (prl->pr);
636 GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, prl->rpr);
637 GNUNET_free (prl->rpr);
642 GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
643 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
645 GNUNET_break (GNUNET_YES ==
646 GNUNET_CONTAINER_multihashmap_remove (pp->plan_map,
647 get_rp_key (rp), rp));
648 while (NULL != (prl = rp->prl_head))
650 GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, prl);
651 prd = GSF_pending_request_get_data_ (prl->pr);
652 GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, prl->rpr);
653 GNUNET_free (prl->rpr);
658 GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# query plan entries"),
659 plan_count, GNUNET_NO);
661 GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
662 GNUNET_CONTAINER_multihashmap_destroy (pp->plan_map);
668 * Notify the plan about a request being done; destroy all entries
669 * associated with this request.
671 * @param pr request that is done
674 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
676 struct GSF_RequestPlan *rp;
677 struct GSF_PendingRequestData *prd;
678 struct GSF_RequestPlanReference *rpr;
680 prd = GSF_pending_request_get_data_ (pr);
681 while (NULL != (rpr = prd->rpr_head))
683 GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, rpr);
685 GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, rpr->prl);
686 if (NULL == rp->prl_head)
688 GNUNET_CONTAINER_heap_remove_node (rp->hn);
690 GNUNET_break (GNUNET_YES ==
691 GNUNET_CONTAINER_multihashmap_remove (rp->pp->plan_map,
692 &GSF_pending_request_get_data_
693 (rpr->prl->pr)->query,
697 GNUNET_free (rpr->prl);
700 GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# query plan entries"),
701 plan_count, GNUNET_NO);
706 * Initialize plan subsystem.
711 plans = GNUNET_CONTAINER_multihashmap_create (256);
716 * Shutdown plan subsystem.
721 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (plans));
722 GNUNET_CONTAINER_multihashmap_destroy (plans);
727 /* end of gnunet-service-fs_pe.h */