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,
223 struct GSF_RequestPlan *rp)
225 struct GSF_PendingRequestData *prd;
226 struct GNUNET_TIME_Relative delay;
228 GNUNET_STATISTICS_set (GSF_stats,
229 gettext_noop ("# average retransmission delay (ms)"),
230 total_delay * 1000LL / plan_count,
232 prd = GSF_pending_request_get_data_ (rp->prl_head->pr);
233 // FIXME: calculate 'rp->priority'!
234 if (rp->transmission_counter < 32)
235 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
236 1LL << rp->transmission_counter);
238 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
240 rp->earliest_transmission
241 = GNUNET_TIME_relative_to_absolute (delay);
243 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
244 "Earliest (re)transmission for `%s' in %us\n",
245 GNUNET_h2s (&prd->query),
246 rp->transmission_counter);
249 GNUNET_assert (rp->hn == NULL);
250 if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0)
251 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
255 rp->hn = GNUNET_CONTAINER_heap_insert (pp->delay_heap,
257 rp->earliest_transmission.abs_value);
258 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
259 GNUNET_SCHEDULER_cancel (pp->task);
260 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
265 * Get the pending request with the highest TTL from the given plan.
267 * @param rp plan to investigate
268 * @return pending request with highest TTL
270 struct GSF_PendingRequest *
271 get_latest (const struct GSF_RequestPlan *rp)
273 struct GSF_PendingRequest *ret;
274 struct PendingRequestList *prl;
281 if (GSF_pending_request_get_data_ (prl->pr)->ttl.abs_value >
282 GSF_pending_request_get_data_ (ret)->ttl.abs_value)
291 * Function called to get a message for transmission.
294 * @param buf_size number of bytes available in buf
295 * @param buf where to copy the message, NULL on error (peer disconnect)
296 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
299 transmit_message_callback (void *cls,
303 struct PeerPlan *pp = cls;
304 struct GSF_RequestPlan *rp;
310 /* failed, try again... */
311 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
314 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
317 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
320 msize = GSF_pending_request_get_message_ (get_latest (rp), buf_size, buf);
321 if (msize > buf_size)
323 /* buffer to small (message changed), try again */
324 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
327 /* remove from root, add again elsewhere... */
328 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
330 rp->last_transmission = GNUNET_TIME_absolute_get ();
331 rp->transmission_counter++;
334 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
335 "Executing plan %p executed %u times, planning retransmission\n",
337 rp->transmission_counter);
340 GNUNET_STATISTICS_update (GSF_stats,
341 gettext_noop ("# queries messages sent to other peers"),
349 * Figure out when and how to transmit to the given peer.
351 * @param cls the 'struct PeerPlan'
352 * @param tc scheduler context
355 schedule_peer_transmission (void *cls,
356 const struct GNUNET_SCHEDULER_TaskContext *tc)
358 struct PeerPlan *pp = cls;
359 struct GSF_RequestPlan *rp;
362 pp->task = GNUNET_SCHEDULER_NO_TASK;
365 GSF_peer_transmit_cancel_ (pp->pth);
368 /* move ready requests to priority queue */
369 while ( (NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
370 (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0) )
372 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
373 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
377 if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
379 /* priority heap (still) empty, check for delay... */
380 rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
384 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
385 "No active requests for plan %p.\n",
388 return; /* both queues empty */
391 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
392 "Sleeping for %llu ms before retrying requests on plan %p.\n",
393 (unsigned long long) GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value,
396 pp->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission),
397 &schedule_peer_transmission,
401 /* process from priority heap */
402 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
404 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
405 "Executing query plan %p\n",
408 GNUNET_assert (NULL != rp);
409 msize = GSF_pending_request_get_message_ (get_latest (rp), 0, NULL);
410 pp->pth = GSF_peer_transmit_ (pp->cp,
413 GNUNET_TIME_UNIT_FOREVER_REL,
415 &transmit_message_callback,
417 GNUNET_assert (NULL != pp->pth);
422 * Closure for 'merge_pr'.
427 struct GSF_PendingRequest *pr;
435 * Iterator that checks if an equivalent request is already
436 * present for this peer.
439 * @param node internal node of the heap (ignored)
440 * @param element request plan stored at the node
441 * @param cost cost associated with the node (ignored)
442 * @return GNUNET_YES if we should continue to iterate,
443 * GNUNET_NO if not (merge success)
447 struct GNUNET_CONTAINER_HeapNode *node,
449 GNUNET_CONTAINER_HeapCostType cost)
451 struct MergeContext *mpr = cls;
452 struct GSF_RequestPlan *rp = element;
453 struct GSF_PendingRequestData *prd;
454 struct GSF_RequestPlanReference *rpr;
455 struct PendingRequestList *prl;
456 struct GSF_PendingRequest *latest;
459 GSF_pending_request_is_compatible_ (mpr->pr,
462 /* merge new request with existing request plan */
463 rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
464 prl = GNUNET_malloc (sizeof (struct PendingRequestList));
469 prd = GSF_pending_request_get_data_ (mpr->pr);
470 GNUNET_CONTAINER_DLL_insert (prd->rpr_head,
473 GNUNET_CONTAINER_DLL_insert (rp->prl_head,
476 mpr->merged = GNUNET_YES;
477 GNUNET_STATISTICS_update (GSF_stats,
478 gettext_noop ("# requests merged"),
481 latest = get_latest (rp);
482 if (GSF_pending_request_get_data_ (latest)->ttl.abs_value < prd->ttl.abs_value)
484 GNUNET_STATISTICS_update (GSF_stats,
485 gettext_noop ("# requests refreshed"),
488 rp->transmission_counter = 0; /* reset */
495 * Create a new query plan entry.
497 * @param cp peer with the entry
498 * @param pr request with the entry
501 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
502 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,
518 pp = GNUNET_malloc (sizeof (struct PeerPlan));
519 pp->priority_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
520 pp->delay_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
522 GNUNET_CONTAINER_multihashmap_put (plans,
525 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
527 mpc.merged = GNUNET_NO;
529 GNUNET_CONTAINER_heap_iterate (pp->priority_heap, &merge_pr, &mpc);
530 if (mpc.merged != GNUNET_NO)
532 GNUNET_CONTAINER_heap_iterate (pp->delay_heap, &merge_pr, &mpc);
533 if (mpc.merged != GNUNET_NO)
536 GNUNET_STATISTICS_update (GSF_stats,
537 gettext_noop ("# query plan entries"),
540 prd = GSF_pending_request_get_data_ (pr);
542 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
543 "Planning transmission of query `%s' to peer `%s'\n",
544 GNUNET_h2s (&prd->query),
547 rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
548 rpr = GNUNET_malloc (sizeof (struct GSF_RequestPlanReference));
549 prl = GNUNET_malloc (sizeof (struct PendingRequestList));
554 GNUNET_CONTAINER_DLL_insert (prd->rpr_head,
557 GNUNET_CONTAINER_DLL_insert (rp->prl_head,
565 * Notify the plan about a peer being no longer available;
566 * destroy all entries associated with this peer.
568 * @param cp connected peer
571 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
573 struct GNUNET_PeerIdentity id;
575 struct GSF_RequestPlan *rp;
576 struct GSF_PendingRequestData *prd;
577 struct PendingRequestList *prl;
579 GSF_connected_peer_get_identity_ (cp, &id);
580 pp = GNUNET_CONTAINER_multihashmap_get (plans,
583 return; /* nothing was ever planned for this peer */
584 GNUNET_assert (GNUNET_YES ==
585 GNUNET_CONTAINER_multihashmap_remove (plans,
589 GSF_peer_transmit_cancel_ (pp->pth);
590 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
592 GNUNET_SCHEDULER_cancel (pp->task);
593 pp->task = GNUNET_SCHEDULER_NO_TASK;
595 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
597 while (NULL != (prl = rp->prl_head))
599 GNUNET_CONTAINER_DLL_remove (rp->prl_head,
602 prd = GSF_pending_request_get_data_ (prl->pr);
603 GNUNET_CONTAINER_DLL_remove (prd->rpr_head,
606 GNUNET_free (prl->rpr);
611 GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
612 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
614 while (NULL != (prl = rp->prl_head))
616 GNUNET_CONTAINER_DLL_remove (rp->prl_head,
619 prd = GSF_pending_request_get_data_ (prl->pr);
620 GNUNET_CONTAINER_DLL_remove (prd->rpr_head,
623 GNUNET_free (prl->rpr);
628 GNUNET_STATISTICS_set (GSF_stats,
629 gettext_noop ("# query plan entries"),
633 GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
639 * Notify the plan about a request being done; destroy all entries
640 * associated with this request.
642 * @param pr request that is done
645 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
647 struct GSF_RequestPlan *rp;
648 struct GSF_PendingRequestData *prd;
649 struct GSF_RequestPlanReference *rpr;
651 prd = GSF_pending_request_get_data_ (pr);
652 while (NULL != (rpr = prd->rpr_head))
654 GNUNET_CONTAINER_DLL_remove (prd->rpr_head,
658 GNUNET_CONTAINER_DLL_remove (rp->prl_head,
661 GNUNET_free (rpr->prl);
663 if (rp->prl_head == 0)
665 GNUNET_CONTAINER_heap_remove_node (rp->hn);
670 GNUNET_STATISTICS_set (GSF_stats,
671 gettext_noop ("# query plan entries"),
678 * Initialize plan subsystem.
683 plans = GNUNET_CONTAINER_multihashmap_create (256);
688 * Shutdown plan subsystem.
694 GNUNET_CONTAINER_multihashmap_size (plans));
695 GNUNET_CONTAINER_multihashmap_destroy (plans);
700 /* end of gnunet-service-fs_pe.h */