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 * Information we keep per request per peer. This is a doubly-linked
35 * list (with head and tail in the 'struct GSF_PendingRequestData')
36 * with one entry in each heap of each 'struct PeerPlan'. Each
37 * entry tracks information relevant for this request and this peer.
39 struct GSF_RequestPlan
43 * This is a doubly-linked list.
45 struct GSF_RequestPlan *next;
48 * This is a doubly-linked list.
50 struct GSF_RequestPlan *prev;
53 * Heap node associated with this request and this peer.
55 struct GNUNET_CONTAINER_HeapNode *hn;
58 * Associated pending request.
60 struct GSF_PendingRequest *pr;
63 * Earliest time we'd be happy to (re)transmit this request.
65 struct GNUNET_TIME_Absolute earliest_transmission;
68 * When was the last time we transmitted this request to this peer? 0 for never.
70 struct GNUNET_TIME_Absolute last_transmission;
73 * Current priority for this request for this target.
78 * How often did we transmit this request to this peer?
80 unsigned int transmission_counter;
86 * Transmission plan for a peer.
91 * Heap with pending queries (struct GSF_RequestPlan), higher weights mean higher priority.
93 struct GNUNET_CONTAINER_Heap *priority_heap;
96 * Heap with pending queries (struct GSF_RequestPlan), by transmission time, lowest first.
98 struct GNUNET_CONTAINER_Heap *delay_heap;
101 * Current transmission request handle.
103 struct GSF_PeerTransmitHandle *pth;
106 * Peer for which this is the plan.
108 struct GSF_ConnectedPeer *cp;
111 * Current task for executing the plan.
113 GNUNET_SCHEDULER_TaskIdentifier task;
118 * Hash map from peer identities to PeerPlans.
120 static struct GNUNET_CONTAINER_MultiHashMap *plans;
123 * Sum of all transmission counters (equals total delay for all plan entries).
125 static unsigned long long total_delay;
128 * Number of plan entries.
130 static unsigned long long plan_count;
134 * Figure out when and how to transmit to the given peer.
136 * @param cls the 'struct GSF_ConnectedPeer' for transmission
137 * @param tc scheduler context
140 schedule_peer_transmission (void *cls,
141 const struct GNUNET_SCHEDULER_TaskContext *tc);
145 * Insert the given request plan into the heap with the appropriate weight.
147 * @param pp associated peer's plan
148 * @param rp request to plan
151 plan (struct PeerPlan *pp,
152 struct GSF_RequestPlan *rp)
154 struct GSF_PendingRequestData *prd;
155 struct GNUNET_TIME_Relative delay;
157 GNUNET_STATISTICS_set (GSF_stats,
158 gettext_noop ("# average retransmission delay (ms)"),
159 total_delay * 1000LL / plan_count,
161 prd = GSF_pending_request_get_data_ (rp->pr);
162 // FIXME: calculate 'rp->priority'!
163 if (rp->transmission_counter < 32)
164 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
165 1LL << rp->transmission_counter);
167 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
169 rp->earliest_transmission
170 = GNUNET_TIME_relative_to_absolute (delay);
172 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
173 "Earliest (re)transmission for `%s' in %us\n",
174 GNUNET_h2s (&prd->query),
175 rp->transmission_counter);
178 GNUNET_assert (rp->hn == NULL);
179 if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0)
180 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
184 rp->hn = GNUNET_CONTAINER_heap_insert (pp->delay_heap,
186 rp->earliest_transmission.abs_value);
187 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
188 GNUNET_SCHEDULER_cancel (pp->task);
189 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
194 * Function called to get a message for transmission.
197 * @param buf_size number of bytes available in buf
198 * @param buf where to copy the message, NULL on error (peer disconnect)
199 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
202 transmit_message_callback (void *cls,
206 struct PeerPlan *pp = cls;
207 struct GSF_RequestPlan *rp;
213 /* failed, try again... */
214 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
217 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
220 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
223 msize = GSF_pending_request_get_message_ (rp->pr, buf_size, buf);
224 if (msize > buf_size)
226 /* buffer to small (message changed), try again */
227 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
230 /* remove from root, add again elsewhere... */
231 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
233 rp->last_transmission = GNUNET_TIME_absolute_get ();
234 rp->transmission_counter++;
237 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
238 "Executing plan %p executed %u times, planning retransmission\n",
240 rp->transmission_counter);
243 GNUNET_STATISTICS_update (GSF_stats,
244 gettext_noop ("# queries messages sent to other peers"),
252 * Figure out when and how to transmit to the given peer.
254 * @param cls the 'struct PeerPlan'
255 * @param tc scheduler context
258 schedule_peer_transmission (void *cls,
259 const struct GNUNET_SCHEDULER_TaskContext *tc)
261 struct PeerPlan *pp = cls;
262 struct GSF_RequestPlan *rp;
265 pp->task = GNUNET_SCHEDULER_NO_TASK;
268 GSF_peer_transmit_cancel_ (pp->pth);
271 /* move ready requests to priority queue */
272 while ( (NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
273 (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0) )
275 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
276 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
280 if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
282 /* priority heap (still) empty, check for delay... */
283 rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
287 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
288 "No active requests for plan %p.\n",
291 return; /* both queues empty */
294 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
295 "Sleeping for %llu ms before retrying requests on plan %p.\n",
296 (unsigned long long) GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value,
299 pp->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission),
300 &schedule_peer_transmission,
304 /* process from priority heap */
305 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
307 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
308 "Executing query plan %p\n",
311 GNUNET_assert (NULL != rp);
312 msize = GSF_pending_request_get_message_ (rp->pr, 0, NULL);
313 pp->pth = GSF_peer_transmit_ (pp->cp,
316 GNUNET_TIME_UNIT_FOREVER_REL,
318 &transmit_message_callback,
320 GNUNET_assert (NULL != pp->pth);
325 * Create a new query plan entry.
327 * @param cp peer with the entry
328 * @param pr request with the entry
331 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
332 struct GSF_PendingRequest *pr)
334 struct GNUNET_PeerIdentity id;
336 struct GSF_PendingRequestData *prd;
337 struct GSF_RequestPlan *rp;
339 GNUNET_assert (NULL != cp);
340 GSF_connected_peer_get_identity_ (cp, &id);
341 pp = GNUNET_CONTAINER_multihashmap_get (plans,
345 pp = GNUNET_malloc (sizeof (struct PeerPlan));
346 pp->priority_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
347 pp->delay_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
349 GNUNET_CONTAINER_multihashmap_put (plans,
352 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
354 prd = GSF_pending_request_get_data_ (pr);
356 GNUNET_STATISTICS_update (GSF_stats,
357 gettext_noop ("# query plan entries"),
360 rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
362 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
363 "Planning transmission of query `%s' to peer `%s' (%p)\n",
364 GNUNET_h2s (&prd->query),
369 GNUNET_CONTAINER_DLL_insert (prd->rp_head,
377 * Notify the plan about a peer being no longer available;
378 * destroy all entries associated with this peer.
380 * @param cp connected peer
383 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
385 struct GNUNET_PeerIdentity id;
387 struct GSF_RequestPlan *rp;
388 struct GSF_PendingRequestData *prd;
390 GSF_connected_peer_get_identity_ (cp, &id);
391 pp = GNUNET_CONTAINER_multihashmap_get (plans,
394 return; /* nothing was ever planned for this peer */
395 GNUNET_assert (GNUNET_YES ==
396 GNUNET_CONTAINER_multihashmap_remove (plans,
400 GSF_peer_transmit_cancel_ (pp->pth);
401 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
403 GNUNET_SCHEDULER_cancel (pp->task);
404 pp->task = GNUNET_SCHEDULER_NO_TASK;
406 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
408 prd = GSF_pending_request_get_data_ (rp->pr);
409 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
415 GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
416 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
418 prd = GSF_pending_request_get_data_ (rp->pr);
419 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
425 GNUNET_STATISTICS_set (GSF_stats,
426 gettext_noop ("# query plan entries"),
430 GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
436 * Notify the plan about a request being done; destroy all entries
437 * associated with this request.
439 * @param pr request that is done
442 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
444 struct GSF_RequestPlan *rp;
445 struct GSF_PendingRequestData *prd;
447 prd = GSF_pending_request_get_data_ (pr);
448 while (NULL != (rp = prd->rp_head))
450 GNUNET_CONTAINER_heap_remove_node (rp->hn);
451 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
457 GNUNET_STATISTICS_set (GSF_stats,
458 gettext_noop ("# query plan entries"),
465 * Initialize plan subsystem.
470 plans = GNUNET_CONTAINER_multihashmap_create (256);
475 * Shutdown plan subsystem.
481 GNUNET_CONTAINER_multihashmap_size (plans));
482 GNUNET_CONTAINER_multihashmap_destroy (plans);
487 /* end of gnunet-service-fs_pe.h */