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'!
232 if (rp->transmission_counter < 32)
233 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
234 1LL << rp->transmission_counter);
236 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, UINT_MAX);
237 rp->earliest_transmission = GNUNET_TIME_relative_to_absolute (delay);
239 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
240 "Earliest (re)transmission for `%s' in %us\n",
241 GNUNET_h2s (&prd->query), rp->transmission_counter);
244 GNUNET_assert (rp->hn == NULL);
245 if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value
247 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap, rp, rp->priority);
249 rp->hn = GNUNET_CONTAINER_heap_insert (pp->delay_heap,
251 rp->earliest_transmission.abs_value);
252 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
253 GNUNET_SCHEDULER_cancel (pp->task);
254 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
259 * Get the pending request with the highest TTL from the given plan.
261 * @param rp plan to investigate
262 * @return pending request with highest TTL
264 struct GSF_PendingRequest *
265 get_latest (const struct GSF_RequestPlan *rp)
267 struct GSF_PendingRequest *ret;
268 struct PendingRequestList *prl;
275 if (GSF_pending_request_get_data_ (prl->pr)->ttl.abs_value >
276 GSF_pending_request_get_data_ (ret)->ttl.abs_value)
285 * Function called to get a message for transmission.
288 * @param buf_size number of bytes available in buf
289 * @param buf where to copy the message, NULL on error (peer disconnect)
290 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
293 transmit_message_callback (void *cls, size_t buf_size, void *buf)
295 struct PeerPlan *pp = cls;
296 struct GSF_RequestPlan *rp;
302 /* failed, try again... */
303 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
306 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
309 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
312 msize = GSF_pending_request_get_message_ (get_latest (rp), buf_size, buf);
313 if (msize > buf_size)
315 /* buffer to small (message changed), try again */
316 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
319 /* remove from root, add again elsewhere... */
320 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
322 rp->last_transmission = GNUNET_TIME_absolute_get ();
323 rp->transmission_counter++;
326 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
327 "Executing plan %p executed %u times, planning retransmission\n",
328 rp, rp->transmission_counter);
331 GNUNET_STATISTICS_update (GSF_stats,
333 ("# queries messages sent to other peers"), 1,
340 * Figure out when and how to transmit to the given peer.
342 * @param cls the 'struct PeerPlan'
343 * @param tc scheduler context
346 schedule_peer_transmission (void *cls,
347 const struct GNUNET_SCHEDULER_TaskContext *tc)
349 struct PeerPlan *pp = cls;
350 struct GSF_RequestPlan *rp;
353 pp->task = GNUNET_SCHEDULER_NO_TASK;
356 GSF_peer_transmit_cancel_ (pp->pth);
359 /* move ready requests to priority queue */
360 while ((NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
361 (GNUNET_TIME_absolute_get_remaining
362 (rp->earliest_transmission).rel_value == 0))
364 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
365 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap, rp, rp->priority);
367 if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
369 /* priority heap (still) empty, check for delay... */
370 rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
374 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
375 "No active requests for plan %p.\n", pp);
377 return; /* both queues empty */
380 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
381 "Sleeping for %llu ms before retrying requests on plan %p.\n",
383 GNUNET_TIME_absolute_get_remaining
384 (rp->earliest_transmission).rel_value, pp);
387 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
388 (rp->earliest_transmission),
389 &schedule_peer_transmission, pp);
392 /* process from priority heap */
393 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
395 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Executing query plan %p\n", rp);
397 GNUNET_assert (NULL != rp);
398 msize = GSF_pending_request_get_message_ (get_latest (rp), 0, NULL);
399 pp->pth = GSF_peer_transmit_ (pp->cp,
402 GNUNET_TIME_UNIT_FOREVER_REL,
403 msize, &transmit_message_callback, pp);
404 GNUNET_assert (NULL != pp->pth);
409 * Closure for 'merge_pr'.
414 struct GSF_PendingRequest *pr;
422 * Iterator that checks if an equivalent request is already
423 * present for this peer.
426 * @param node internal node of the heap (ignored)
427 * @param element request plan stored at the node
428 * @param cost cost associated with the node (ignored)
429 * @return GNUNET_YES if we should continue to iterate,
430 * GNUNET_NO if not (merge success)
434 struct GNUNET_CONTAINER_HeapNode *node,
435 void *element, GNUNET_CONTAINER_HeapCostType cost)
437 struct MergeContext *mpr = cls;
438 struct GSF_RequestPlan *rp = element;
439 struct GSF_PendingRequestData *prd;
440 struct GSF_RequestPlanReference *rpr;
441 struct PendingRequestList *prl;
442 struct GSF_PendingRequest *latest;
445 GSF_pending_request_is_compatible_ (mpr->pr, rp->prl_head->pr))
447 /* merge new request with existing request plan */
448 rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
449 prl = GNUNET_malloc (sizeof (struct PendingRequestList));
454 prd = GSF_pending_request_get_data_ (mpr->pr);
455 GNUNET_CONTAINER_DLL_insert (prd->rpr_head, prd->rpr_tail, rpr);
456 GNUNET_CONTAINER_DLL_insert (rp->prl_head, rp->prl_tail, prl);
457 mpr->merged = GNUNET_YES;
458 GNUNET_STATISTICS_update (GSF_stats,
459 gettext_noop ("# requests merged"), 1, GNUNET_NO);
460 latest = get_latest (rp);
461 if (GSF_pending_request_get_data_ (latest)->ttl.abs_value <
464 GNUNET_STATISTICS_update (GSF_stats,
465 gettext_noop ("# requests refreshed"),
467 rp->transmission_counter = 0; /* reset */
474 * Create a new query plan entry.
476 * @param cp peer with the entry
477 * @param pr request with the entry
480 GSF_plan_add_ (struct GSF_ConnectedPeer *cp, struct GSF_PendingRequest *pr)
482 struct GNUNET_PeerIdentity id;
484 struct GSF_PendingRequestData *prd;
485 struct GSF_RequestPlan *rp;
486 struct GSF_RequestPlanReference *rpr;
487 struct PendingRequestList *prl;
488 struct MergeContext mpc;
490 GNUNET_assert (NULL != cp);
491 GSF_connected_peer_get_identity_ (cp, &id);
492 pp = GNUNET_CONTAINER_multihashmap_get (plans, &id.hashPubKey);
495 pp = GNUNET_malloc (sizeof (struct PeerPlan));
497 GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
499 GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
501 GNUNET_CONTAINER_multihashmap_put (plans,
504 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
506 mpc.merged = GNUNET_NO;
508 GNUNET_CONTAINER_heap_iterate (pp->priority_heap, &merge_pr, &mpc);
509 if (mpc.merged != GNUNET_NO)
511 GNUNET_CONTAINER_heap_iterate (pp->delay_heap, &merge_pr, &mpc);
512 if (mpc.merged != GNUNET_NO)
515 GNUNET_STATISTICS_update (GSF_stats,
516 gettext_noop ("# query plan entries"),
518 prd = GSF_pending_request_get_data_ (pr);
520 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
521 "Planning transmission of query `%s' to peer `%s'\n",
522 GNUNET_h2s (&prd->query), GNUNET_i2s (&id));
524 rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
525 rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
526 prl = GNUNET_malloc (sizeof (struct PendingRequestList));
531 GNUNET_CONTAINER_DLL_insert (prd->rpr_head, prd->rpr_tail, rpr);
532 GNUNET_CONTAINER_DLL_insert (rp->prl_head, rp->prl_tail, prl);
538 * Notify the plan about a peer being no longer available;
539 * destroy all entries associated with this peer.
541 * @param cp connected peer
544 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
546 struct GNUNET_PeerIdentity id;
548 struct GSF_RequestPlan *rp;
549 struct GSF_PendingRequestData *prd;
550 struct PendingRequestList *prl;
552 GSF_connected_peer_get_identity_ (cp, &id);
553 pp = GNUNET_CONTAINER_multihashmap_get (plans, &id.hashPubKey);
555 return; /* nothing was ever planned for this peer */
556 GNUNET_assert (GNUNET_YES ==
557 GNUNET_CONTAINER_multihashmap_remove (plans,
558 &id.hashPubKey, pp));
560 GSF_peer_transmit_cancel_ (pp->pth);
561 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
563 GNUNET_SCHEDULER_cancel (pp->task);
564 pp->task = GNUNET_SCHEDULER_NO_TASK;
566 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
568 while (NULL != (prl = rp->prl_head))
570 GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, prl);
571 prd = GSF_pending_request_get_data_ (prl->pr);
572 GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, prl->rpr);
573 GNUNET_free (prl->rpr);
578 GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
579 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
581 while (NULL != (prl = rp->prl_head))
583 GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, prl);
584 prd = GSF_pending_request_get_data_ (prl->pr);
585 GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, prl->rpr);
586 GNUNET_free (prl->rpr);
591 GNUNET_STATISTICS_set (GSF_stats,
592 gettext_noop ("# query plan entries"),
593 plan_count, GNUNET_NO);
595 GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
601 * Notify the plan about a request being done; destroy all entries
602 * associated with this request.
604 * @param pr request that is done
607 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
609 struct GSF_RequestPlan *rp;
610 struct GSF_PendingRequestData *prd;
611 struct GSF_RequestPlanReference *rpr;
613 prd = GSF_pending_request_get_data_ (pr);
614 while (NULL != (rpr = prd->rpr_head))
616 GNUNET_CONTAINER_DLL_remove (prd->rpr_head, prd->rpr_tail, rpr);
618 GNUNET_CONTAINER_DLL_remove (rp->prl_head, rp->prl_tail, rpr->prl);
619 GNUNET_free (rpr->prl);
621 if (rp->prl_head == 0)
623 GNUNET_CONTAINER_heap_remove_node (rp->hn);
628 GNUNET_STATISTICS_set (GSF_stats,
629 gettext_noop ("# query plan entries"),
630 plan_count, GNUNET_NO);
635 * Initialize plan subsystem.
640 plans = GNUNET_CONTAINER_multihashmap_create (256);
645 * Shutdown plan subsystem.
650 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (plans));
651 GNUNET_CONTAINER_multihashmap_destroy (plans);
656 /* end of gnunet-service-fs_pe.h */