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->earliest_transmission'!
163 // FIXME: claculate 'rp->priority'!
164 delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
165 rp->transmission_counter);
166 rp->earliest_transmission
167 = GNUNET_TIME_relative_to_absolute (delay);
169 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
170 "Earliest (re)transmission for `%s' in %us\n",
171 GNUNET_h2s (&prd->query),
172 rp->transmission_counter);
175 GNUNET_assert (rp->hn == NULL);
176 if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0)
177 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
181 rp->hn = GNUNET_CONTAINER_heap_insert (pp->delay_heap,
183 rp->earliest_transmission.abs_value);
184 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
185 GNUNET_SCHEDULER_cancel (pp->task);
186 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
191 * Function called to get a message for transmission.
194 * @param buf_size number of bytes available in buf
195 * @param buf where to copy the message, NULL on error (peer disconnect)
196 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
199 transmit_message_callback (void *cls,
203 struct PeerPlan *pp = cls;
204 struct GSF_RequestPlan *rp;
210 /* failed, try again... */
211 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
214 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
217 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
220 msize = GSF_pending_request_get_message_ (rp->pr, buf_size, buf);
221 if (msize > buf_size)
223 /* buffer to small (message changed), try again */
224 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
227 /* remove from root, add again elsewhere... */
228 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
230 rp->last_transmission = GNUNET_TIME_absolute_get ();
231 rp->transmission_counter++;
234 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
235 "Executing plan %p executed %u times, planning retransmission\n",
237 rp->transmission_counter);
240 GNUNET_STATISTICS_update (GSF_stats,
241 gettext_noop ("# queries messages sent to other peers"),
249 * Figure out when and how to transmit to the given peer.
251 * @param cls the 'struct PeerPlan'
252 * @param tc scheduler context
255 schedule_peer_transmission (void *cls,
256 const struct GNUNET_SCHEDULER_TaskContext *tc)
258 struct PeerPlan *pp = cls;
259 struct GSF_RequestPlan *rp;
262 pp->task = GNUNET_SCHEDULER_NO_TASK;
265 GSF_peer_transmit_cancel_ (pp->pth);
268 /* move ready requests to priority queue */
269 while ( (NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
270 (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0) )
272 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
273 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
277 if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
279 /* priority heap (still) empty, check for delay... */
280 rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
284 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
285 "No active requests for plan %p.\n",
288 return; /* both queues empty */
291 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
292 "Sleeping for %llu ms before retrying requests on plan %p.\n",
293 (unsigned long long) GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value,
296 pp->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission),
297 &schedule_peer_transmission,
301 /* process from priority heap */
302 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
304 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
305 "Executing query plan %p\n",
308 GNUNET_assert (NULL != rp);
309 msize = GSF_pending_request_get_message_ (rp->pr, 0, NULL);
310 pp->pth = GSF_peer_transmit_ (pp->cp,
313 GNUNET_TIME_UNIT_FOREVER_REL,
315 &transmit_message_callback,
317 GNUNET_assert (NULL != pp->pth);
322 * Create a new query plan entry.
324 * @param cp peer with the entry
325 * @param pr request with the entry
328 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
329 struct GSF_PendingRequest *pr)
331 struct GNUNET_PeerIdentity id;
333 struct GSF_PendingRequestData *prd;
334 struct GSF_RequestPlan *rp;
336 GNUNET_assert (NULL != cp);
337 GSF_connected_peer_get_identity_ (cp, &id);
338 pp = GNUNET_CONTAINER_multihashmap_get (plans,
342 pp = GNUNET_malloc (sizeof (struct PeerPlan));
343 pp->priority_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
344 pp->delay_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
346 GNUNET_CONTAINER_multihashmap_put (plans,
349 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
351 prd = GSF_pending_request_get_data_ (pr);
353 GNUNET_STATISTICS_update (GSF_stats,
354 gettext_noop ("# query plan entries"),
357 rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
359 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
360 "Planning transmission of query `%s' to peer `%s' (%p)\n",
361 GNUNET_h2s (&prd->query),
366 GNUNET_CONTAINER_DLL_insert (prd->rp_head,
374 * Notify the plan about a peer being no longer available;
375 * destroy all entries associated with this peer.
377 * @param cp connected peer
380 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
382 struct GNUNET_PeerIdentity id;
384 struct GSF_RequestPlan *rp;
385 struct GSF_PendingRequestData *prd;
387 GSF_connected_peer_get_identity_ (cp, &id);
388 pp = GNUNET_CONTAINER_multihashmap_get (plans,
391 return; /* nothing was ever planned for this peer */
392 GNUNET_assert (GNUNET_YES ==
393 GNUNET_CONTAINER_multihashmap_remove (plans,
397 GSF_peer_transmit_cancel_ (pp->pth);
398 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
400 GNUNET_SCHEDULER_cancel (pp->task);
401 pp->task = GNUNET_SCHEDULER_NO_TASK;
403 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
405 prd = GSF_pending_request_get_data_ (rp->pr);
406 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
412 GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
413 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
415 prd = GSF_pending_request_get_data_ (rp->pr);
416 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
422 GNUNET_STATISTICS_set (GSF_stats,
423 gettext_noop ("# query plan entries"),
427 GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
433 * Notify the plan about a request being done; destroy all entries
434 * associated with this request.
436 * @param pr request that is done
439 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
441 struct GSF_RequestPlan *rp;
442 struct GSF_PendingRequestData *prd;
444 prd = GSF_pending_request_get_data_ (pr);
445 while (NULL != (rp = prd->rp_head))
447 GNUNET_CONTAINER_heap_remove_node (rp->hn);
448 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
454 GNUNET_STATISTICS_set (GSF_stats,
455 gettext_noop ("# query plan entries"),
462 * Initialize plan subsystem.
467 plans = GNUNET_CONTAINER_multihashmap_create (256);
472 * Shutdown plan subsystem.
478 GNUNET_CONTAINER_multihashmap_size (plans));
479 GNUNET_CONTAINER_multihashmap_destroy (plans);
484 /* end of gnunet-service-fs_pe.h */