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;
124 * Figure out when and how to transmit to the given peer.
126 * @param cls the 'struct GSF_ConnectedPeer' for transmission
127 * @param tc scheduler context
130 schedule_peer_transmission (void *cls,
131 const struct GNUNET_SCHEDULER_TaskContext *tc);
135 * Insert the given request plan into the heap with the appropriate weight.
137 * @param pp associated peer's plan
138 * @param rp request to plan
141 plan (struct PeerPlan *pp,
142 struct GSF_RequestPlan *rp)
144 struct GSF_PendingRequestData *prd;
146 prd = GSF_pending_request_get_data_ (rp->pr);
147 // FIXME: calculate 'rp->earliest_transmission'!
148 // FIXME: claculate 'rp->priority'!
149 rp->earliest_transmission
150 = GNUNET_TIME_relative_to_absolute
151 (GNUNET_TIME_relative_multiply
152 (GNUNET_TIME_UNIT_SECONDS,
153 rp->transmission_counter));
155 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
156 "Earliest (re)transmission for `%s' in %us\n",
157 GNUNET_h2s (&prd->query),
158 rp->transmission_counter);
161 GNUNET_assert (rp->hn == NULL);
162 if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0)
163 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
167 rp->hn = GNUNET_CONTAINER_heap_insert (pp->delay_heap,
169 rp->earliest_transmission.abs_value);
170 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
171 GNUNET_SCHEDULER_cancel (pp->task);
172 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
177 * Function called to get a message for transmission.
180 * @param buf_size number of bytes available in buf
181 * @param buf where to copy the message, NULL on error (peer disconnect)
182 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
185 transmit_message_callback (void *cls,
189 struct PeerPlan *pp = cls;
190 struct GSF_RequestPlan *rp;
196 /* failed, try again... */
197 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
200 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
203 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
206 msize = GSF_pending_request_get_message_ (rp->pr, buf_size, buf);
207 if (msize > buf_size)
209 /* buffer to small (message changed), try again */
210 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
213 /* remove from root, add again elsewhere... */
214 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
216 rp->last_transmission = GNUNET_TIME_absolute_get ();
217 rp->transmission_counter++;
219 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
220 "Executing plan %p executed %u times, planning retransmission\n",
222 rp->transmission_counter);
230 * Figure out when and how to transmit to the given peer.
232 * @param cls the 'struct PeerPlan'
233 * @param tc scheduler context
236 schedule_peer_transmission (void *cls,
237 const struct GNUNET_SCHEDULER_TaskContext *tc)
239 struct PeerPlan *pp = cls;
240 struct GSF_RequestPlan *rp;
243 pp->task = GNUNET_SCHEDULER_NO_TASK;
246 GSF_peer_transmit_cancel_ (pp->pth);
249 /* move ready requests to priority queue */
250 while ( (NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
251 (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0) )
253 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
254 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
258 if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
260 /* priority heap (still) empty, check for delay... */
261 rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
265 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
266 "No active requests for plan %p.\n",
269 return; /* both queues empty */
272 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
273 "Sleeping for %llu ms before retrying requests on plan %p.\n",
274 (unsigned long long) GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value,
277 pp->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission),
278 &schedule_peer_transmission,
282 /* process from priority heap */
283 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
285 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
286 "Executing query plan %p\n",
289 GNUNET_assert (NULL != rp);
290 msize = GSF_pending_request_get_message_ (rp->pr, 0, NULL);
291 pp->pth = GSF_peer_transmit_ (pp->cp,
294 GNUNET_TIME_UNIT_FOREVER_REL,
296 &transmit_message_callback,
298 GNUNET_assert (NULL != pp->pth);
303 * Create a new query plan entry.
305 * @param cp peer with the entry
306 * @param pr request with the entry
309 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
310 struct GSF_PendingRequest *pr)
312 struct GNUNET_PeerIdentity id;
314 struct GSF_PendingRequestData *prd;
315 struct GSF_RequestPlan *rp;
317 GNUNET_assert (NULL != cp);
318 GSF_connected_peer_get_identity_ (cp, &id);
319 pp = GNUNET_CONTAINER_multihashmap_get (plans,
323 pp = GNUNET_malloc (sizeof (struct PeerPlan));
324 pp->priority_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
325 pp->delay_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
327 GNUNET_CONTAINER_multihashmap_put (plans,
330 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
332 prd = GSF_pending_request_get_data_ (pr);
333 rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
335 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
336 "Planning transmission of query `%s' to peer `%s' (%p)\n",
337 GNUNET_h2s (&prd->query),
342 GNUNET_CONTAINER_DLL_insert (prd->rp_head,
350 * Notify the plan about a peer being no longer available;
351 * destroy all entries associated with this peer.
353 * @param cp connected peer
356 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
358 struct GNUNET_PeerIdentity id;
360 struct GSF_RequestPlan *rp;
361 struct GSF_PendingRequestData *prd;
363 GSF_connected_peer_get_identity_ (cp, &id);
364 pp = GNUNET_CONTAINER_multihashmap_get (plans,
367 return; /* nothing was ever planned for this peer */
368 GNUNET_CONTAINER_multihashmap_remove (plans,
372 GSF_peer_transmit_cancel_ (pp->pth);
373 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
374 GNUNET_SCHEDULER_cancel (pp->task);
375 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
377 prd = GSF_pending_request_get_data_ (rp->pr);
378 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
383 GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
384 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
386 prd = GSF_pending_request_get_data_ (rp->pr);
387 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
392 GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
398 * Notify the plan about a request being done; destroy all entries
399 * associated with this request.
401 * @param pr request that is done
404 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
406 struct GSF_RequestPlan *rp;
407 struct GSF_PendingRequestData *prd;
409 prd = GSF_pending_request_get_data_ (pr);
410 while (NULL != (rp = prd->rp_head))
412 GNUNET_CONTAINER_heap_remove_node (rp->hn);
413 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
422 * Initialize plan subsystem.
427 plans = GNUNET_CONTAINER_multihashmap_create (256);
432 * Shutdown plan subsystem.
438 GNUNET_CONTAINER_multihashmap_size (plans));
439 GNUNET_CONTAINER_multihashmap_destroy (plans);
444 /* end of gnunet-service-fs_pe.h */