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;
41 * DLL of request plans a particular pending request is
44 struct GSF_RequestPlanReference
48 * This is a doubly-linked list.
50 struct GSF_RequestPlanReference *next;
53 * This is a doubly-linked list.
55 struct GSF_RequestPlanReference *prev;
58 * Associated request plan.
60 struct GSF_RequestPlan *rp;
63 * Corresponding PendingRequestList.
65 struct PendingRequestList *prl;
70 * List of GSF_PendingRequests this request plan
73 struct PendingRequestList
77 * This is a doubly-linked list.
79 struct PendingRequestList *next;
82 * This is a doubly-linked list.
84 struct PendingRequestList *prev;
87 * Array of associated pending requests.
89 struct GSF_PendingRequest *pr;
92 * Corresponding GSF_RequestPlanReference.
94 struct GSF_RequestPlanReference *rpr;
100 * Information we keep per request per peer. This is a doubly-linked
101 * list (with head and tail in the 'struct GSF_PendingRequestData')
102 * with one entry in each heap of each 'struct PeerPlan'. Each
103 * entry tracks information relevant for this request and this peer.
105 struct GSF_RequestPlan
109 * This is a doubly-linked list.
111 struct GSF_RequestPlan *next;
114 * This is a doubly-linked list.
116 struct GSF_RequestPlan *prev;
119 * Heap node associated with this request and this peer.
121 struct GNUNET_CONTAINER_HeapNode *hn;
124 * Head of list of associated pending requests.
126 struct PendingRequestList *prl_head;
129 * Tail of list of associated pending requests.
131 struct PendingRequestList *prl_tail;
134 * Earliest time we'd be happy to (re)transmit this request.
136 struct GNUNET_TIME_Absolute earliest_transmission;
139 * When was the last time we transmitted this request to this peer? 0 for never.
141 struct GNUNET_TIME_Absolute last_transmission;
144 * Current priority for this request for this target.
149 * How often did we transmit this request to this peer?
151 unsigned int transmission_counter;
157 * Transmission plan for a peer.
162 * Heap with pending queries (struct GSF_RequestPlan), higher weights mean higher priority.
164 struct GNUNET_CONTAINER_Heap *priority_heap;
167 * Heap with pending queries (struct GSF_RequestPlan), by transmission time, lowest first.
169 struct GNUNET_CONTAINER_Heap *delay_heap;
172 * Current transmission request handle.
174 struct GSF_PeerTransmitHandle *pth;
177 * Peer for which this is the plan.
179 struct GSF_ConnectedPeer *cp;
182 * Current task for executing the plan.
184 GNUNET_SCHEDULER_TaskIdentifier task;
189 * Hash map from peer identities to PeerPlans.
191 static struct GNUNET_CONTAINER_MultiHashMap *plans;
194 * Sum of all transmission counters (equals total delay for all plan entries).
196 static unsigned long long total_delay;
199 * Number of plan entries.
201 static unsigned long long plan_count;
205 * Figure out when and how to transmit to the given peer.
207 * @param cls the 'struct GSF_ConnectedPeer' for transmission
208 * @param tc scheduler context
211 schedule_peer_transmission (void *cls,
212 const struct GNUNET_SCHEDULER_TaskContext *tc);
216 * Insert the given request plan into the heap with the appropriate weight.
218 * @param pp associated peer's plan
219 * @param rp request to plan
222 plan (struct PeerPlan *pp, struct GSF_RequestPlan *rp)
224 struct GSF_PendingRequestData *prd;
225 struct GNUNET_TIME_Relative delay;
227 GNUNET_STATISTICS_set (GSF_stats,
228 gettext_noop ("# average retransmission delay (ms)"),
229 total_delay * 1000LL / plan_count, GNUNET_NO);
230 prd = GSF_pending_request_get_data_ (rp->prl_head->pr);
231 // FIXME: calculate 'rp->priority'!
233 if (rp->transmission_counter < 32)
235 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
236 1LL << rp->transmission_counter);
238 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, UINT_MAX);
240 if (rp->transmission_counter < 32)
242 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
243 rp->transmission_counter);
244 else if (rp->transmission_counter < 32)
246 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
247 32 + (1LL << rp->transmission_counter));
249 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, UINT_MAX);
251 rp->earliest_transmission = GNUNET_TIME_relative_to_absolute (delay);
253 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
254 "Earliest (re)transmission for `%s' in %us\n",
255 GNUNET_h2s (&prd->query), rp->transmission_counter);
258 GNUNET_assert (rp->hn == NULL);
259 if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value
261 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap, rp, rp->priority);
264 GNUNET_CONTAINER_heap_insert (pp->delay_heap, rp,
265 rp->earliest_transmission.abs_value);
266 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
267 GNUNET_SCHEDULER_cancel (pp->task);
268 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
273 * Get the pending request with the highest TTL from the given plan.
275 * @param rp plan to investigate
276 * @return pending request with highest TTL
278 struct GSF_PendingRequest *
279 get_latest (const struct GSF_RequestPlan *rp)
281 struct GSF_PendingRequest *ret;
282 struct PendingRequestList *prl;
289 if (GSF_pending_request_get_data_ (prl->pr)->ttl.abs_value >
290 GSF_pending_request_get_data_ (ret)->ttl.abs_value)
299 * Function called to get a message for transmission.
302 * @param buf_size number of bytes available in buf
303 * @param buf where to copy the message, NULL on error (peer disconnect)
304 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
307 transmit_message_callback (void *cls, size_t buf_size, void *buf)
309 struct PeerPlan *pp = cls;
310 struct GSF_RequestPlan *rp;
316 /* failed, try again... */
317 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
318 GNUNET_STATISTICS_update (GSF_stats,
319 gettext_noop ("# transmission failed (core has no bandwidth)"), 1,
323 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
326 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
329 msize = GSF_pending_request_get_message_ (get_latest (rp), buf_size, buf);
330 if (msize > buf_size)
332 /* buffer to small (message changed), try again */
333 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
336 /* remove from root, add again elsewhere... */
337 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
339 rp->last_transmission = GNUNET_TIME_absolute_get ();
340 rp->transmission_counter++;
343 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
344 "Executing plan %p executed %u times, planning retransmission\n",
345 rp, rp->transmission_counter);
348 GNUNET_STATISTICS_update (GSF_stats,
350 ("# query messages sent to other peers"), 1,
357 * Figure out when and how to transmit to the given peer.
359 * @param cls the 'struct PeerPlan'
360 * @param tc scheduler context
363 schedule_peer_transmission (void *cls,
364 const struct GNUNET_SCHEDULER_TaskContext *tc)
366 struct PeerPlan *pp = cls;
367 struct GSF_RequestPlan *rp;
369 struct GNUNET_TIME_Relative delay;
371 pp->task = GNUNET_SCHEDULER_NO_TASK;
374 GSF_peer_transmit_cancel_ (pp->pth);
377 /* move ready requests to priority queue */
378 while ((NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
379 (GNUNET_TIME_absolute_get_remaining
380 (rp->earliest_transmission).rel_value == 0))
382 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
383 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap, rp, rp->priority);
385 if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
387 /* priority heap (still) empty, check for delay... */
388 rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
392 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "No active requests for plan %p.\n",
395 return; /* both queues empty */
397 delay = GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission);
399 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
400 "Sleeping for %llu ms before retrying requests on plan %p.\n",
402 delay.rel_value, pp);
404 GNUNET_STATISTICS_set (GSF_stats,
405 gettext_noop ("# delay heap timeout"),
410 GNUNET_SCHEDULER_add_delayed (delay,
411 &schedule_peer_transmission, pp);
414 GNUNET_STATISTICS_update (GSF_stats,
415 gettext_noop ("# query plans executed"), 1,
417 /* process from priority heap */
418 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
420 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Executing query plan %p\n", rp);
422 GNUNET_assert (NULL != rp);
423 msize = GSF_pending_request_get_message_ (get_latest (rp), 0, NULL);
425 GSF_peer_transmit_ (pp->cp, GNUNET_YES, rp->priority,
426 GNUNET_TIME_UNIT_FOREVER_REL, msize,
427 &transmit_message_callback, pp);
428 GNUNET_assert (NULL != pp->pth);
433 * Closure for 'merge_pr'.
438 struct GSF_PendingRequest *pr;
446 * Iterator that checks if an equivalent request is already
447 * present for this peer.
450 * @param node internal node of the heap (ignored)
451 * @param element request plan stored at the node
452 * @param cost cost associated with the node (ignored)
453 * @return GNUNET_YES if we should continue to iterate,
454 * GNUNET_NO if not (merge success)
457 merge_pr (void *cls, struct GNUNET_CONTAINER_HeapNode *node, void *element,
458 GNUNET_CONTAINER_HeapCostType cost)
460 struct MergeContext *mpr = cls;
461 struct GSF_RequestPlan *rp = element;
462 struct GSF_PendingRequestData *prd;
463 struct GSF_RequestPlanReference *rpr;
464 struct PendingRequestList *prl;
465 struct GSF_PendingRequest *latest;
468 GSF_pending_request_is_compatible_ (mpr->pr, rp->prl_head->pr))
470 /* merge new request with existing request plan */
471 rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
472 prl = GNUNET_malloc (sizeof (struct PendingRequestList));
477 prd = GSF_pending_request_get_data_ (mpr->pr);
478 GNUNET_CONTAINER_DLL_insert (prd->rpr_head, prd->rpr_tail, rpr);
479 GNUNET_CONTAINER_DLL_insert (rp->prl_head, rp->prl_tail, prl);
480 mpr->merged = GNUNET_YES;
481 GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# requests merged"), 1,
483 latest = get_latest (rp);
484 if (GSF_pending_request_get_data_ (latest)->ttl.abs_value <
487 GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# requests refreshed"),
489 rp->transmission_counter = 0; /* reset */
496 * Create a new query plan entry.
498 * @param cp peer with the entry
499 * @param pr request with the entry
502 GSF_plan_add_ (struct GSF_ConnectedPeer *cp, struct GSF_PendingRequest *pr)
504 struct GNUNET_PeerIdentity id;
506 struct GSF_PendingRequestData *prd;
507 struct GSF_RequestPlan *rp;
508 struct GSF_RequestPlanReference *rpr;
509 struct PendingRequestList *prl;
510 struct MergeContext mpc;
512 GNUNET_assert (NULL != cp);
513 GSF_connected_peer_get_identity_ (cp, &id);
514 pp = GNUNET_CONTAINER_multihashmap_get (plans, &id.hashPubKey);
517 pp = GNUNET_malloc (sizeof (struct PeerPlan));
519 GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
521 GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
523 GNUNET_CONTAINER_multihashmap_put (plans, &id.hashPubKey, pp,
524 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
526 mpc.merged = GNUNET_NO;
528 /* FIXME: O(n) call here, LRN reports this is a performance
529 problem. Try using hash map!? */
530 GNUNET_CONTAINER_heap_iterate (pp->priority_heap, &merge_pr, &mpc);
531 if (mpc.merged != GNUNET_NO)
533 GNUNET_CONTAINER_heap_iterate (pp->delay_heap, &merge_pr, &mpc);
534 if (mpc.merged != GNUNET_NO)
537 GNUNET_STATISTICS_update (GSF_stats, gettext_noop ("# query plan entries"), 1,
539 prd = GSF_pending_request_get_data_ (pr);
541 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
542 "Planning transmission of query `%s' to peer `%s'\n",
543 GNUNET_h2s (&prd->query), GNUNET_i2s (&id));
545 rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
546 rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
547 prl = GNUNET_malloc (sizeof (struct PendingRequestList));
552 GNUNET_CONTAINER_DLL_insert (prd->rpr_head, prd->rpr_tail, rpr);
553 GNUNET_CONTAINER_DLL_insert (rp->prl_head, rp->prl_tail, prl);
559 * Notify the plan about a peer being no longer available;
560 * destroy all entries associated with this peer.
562 * @param cp connected peer
565 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
567 struct GNUNET_PeerIdentity id;
569 struct GSF_RequestPlan *rp;
570 struct GSF_PendingRequestData *prd;
571 struct PendingRequestList *prl;
573 GSF_connected_peer_get_identity_ (cp, &id);
574 pp = GNUNET_CONTAINER_multihashmap_get (plans, &id.hashPubKey);
576 return; /* nothing was ever planned for this peer */
577 GNUNET_assert (GNUNET_YES ==
578 GNUNET_CONTAINER_multihashmap_remove (plans, &id.hashPubKey,
581 GSF_peer_transmit_cancel_ (pp->pth);
582 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
584 GNUNET_SCHEDULER_cancel (pp->task);
585 pp->task = GNUNET_SCHEDULER_NO_TASK;
587 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
589 while (NULL != (prl = rp->prl_head))
591 GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, prl);
592 prd = GSF_pending_request_get_data_ (prl->pr);
593 GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, prl->rpr);
594 GNUNET_free (prl->rpr);
599 GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
600 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
602 while (NULL != (prl = rp->prl_head))
604 GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, prl);
605 prd = GSF_pending_request_get_data_ (prl->pr);
606 GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, prl->rpr);
607 GNUNET_free (prl->rpr);
612 GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# query plan entries"),
613 plan_count, GNUNET_NO);
615 GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
621 * Notify the plan about a request being done; destroy all entries
622 * associated with this request.
624 * @param pr request that is done
627 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
629 struct GSF_RequestPlan *rp;
630 struct GSF_PendingRequestData *prd;
631 struct GSF_RequestPlanReference *rpr;
633 prd = GSF_pending_request_get_data_ (pr);
634 while (NULL != (rpr = prd->rpr_head))
636 GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, rpr);
638 GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, rpr->prl);
639 GNUNET_free (rpr->prl);
641 if (rp->prl_head == 0)
643 GNUNET_CONTAINER_heap_remove_node (rp->hn);
648 GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# query plan entries"),
649 plan_count, GNUNET_NO);
654 * Initialize plan subsystem.
659 plans = GNUNET_CONTAINER_multihashmap_create (256);
664 * Shutdown plan subsystem.
669 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (plans));
670 GNUNET_CONTAINER_multihashmap_destroy (plans);
675 /* end of gnunet-service-fs_pe.h */