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 * Insert the given request plan into the heap with the appropriate weight.
126 * @param pp associated peer's plan
127 * @param rp request to plan
130 plan (struct PeerPlan *pp,
131 struct GSF_RequestPlan *rp)
133 struct GSF_PendingRequestData *prd;
135 prd = GSF_pending_request_get_data_ (rp->pr);
136 // FIXME: calculate 'rp->earliest_transmission'!
137 // FIXME: claculate 'rp->priority'!
138 rp->earliest_transmission
139 = GNUNET_TIME_relative_to_absolute
140 (GNUNET_TIME_relative_multiply
141 (GNUNET_TIME_UNIT_SECONDS,
142 rp->transmission_counter));
144 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
145 "Earliest (re)transmission for `%s' in %us\n",
146 GNUNET_h2s (&prd->query),
147 rp->transmission_counter);
151 if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0)
152 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
156 rp->hn = GNUNET_CONTAINER_heap_insert (pp->delay_heap,
158 rp->earliest_transmission.abs_value);
163 * Figure out when and how to transmit to the given peer.
165 * @param cls the 'struct GSF_ConnectedPeer' for transmission
166 * @param tc scheduler context
169 schedule_peer_transmission (void *cls,
170 const struct GNUNET_SCHEDULER_TaskContext *tc);
174 * Function called to get a message for transmission.
177 * @param buf_size number of bytes available in buf
178 * @param buf where to copy the message, NULL on error (peer disconnect)
179 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
182 transmit_message_callback (void *cls,
186 struct PeerPlan *pp = cls;
187 struct GSF_RequestPlan *rp;
193 /* failed, try again... */
194 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
197 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
200 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
203 msize = GSF_pending_request_get_message_ (rp->pr, buf_size, buf);
204 if (msize > buf_size)
206 /* buffer to small (message changed), try again */
207 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
210 /* remove from root, add again elsewhere... */
211 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
213 rp->last_transmission = GNUNET_TIME_absolute_get ();
214 rp->transmission_counter++;
216 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
217 "Executing plan %p executed %u times, planning retransmission\n",
219 rp->transmission_counter);
227 * Figure out when and how to transmit to the given peer.
229 * @param cls the 'struct PeerPlan'
230 * @param tc scheduler context
233 schedule_peer_transmission (void *cls,
234 const struct GNUNET_SCHEDULER_TaskContext *tc)
236 struct PeerPlan *pp = cls;
237 struct GSF_RequestPlan *rp;
240 pp->task = GNUNET_SCHEDULER_NO_TASK;
241 GNUNET_assert (NULL == pp->pth);
242 /* move ready requests to priority queue */
243 while ( (NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
244 (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0) )
246 GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
247 rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
251 if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
253 /* priority heap (still) empty, check for delay... */
254 rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
256 return; /* both queues empty */
257 pp->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission),
258 &schedule_peer_transmission,
262 /* process from priority heap */
263 rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
265 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
266 "Executing query plan %p\n",
269 GNUNET_assert (NULL != rp);
270 msize = GSF_pending_request_get_message_ (rp->pr, 0, NULL);
271 pp->pth = GSF_peer_transmit_ (pp->cp,
274 GNUNET_TIME_UNIT_FOREVER_REL,
276 &transmit_message_callback,
278 GNUNET_assert (NULL != pp->pth);
283 * Create a new query plan entry.
285 * @param cp peer with the entry
286 * @param pr request with the entry
289 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
290 struct GSF_PendingRequest *pr)
292 struct GNUNET_PeerIdentity id;
294 struct GSF_PendingRequestData *prd;
295 struct GSF_RequestPlan *rp;
297 GSF_connected_peer_get_identity_ (cp, &id);
298 pp = GNUNET_CONTAINER_multihashmap_get (plans,
302 pp = GNUNET_malloc (sizeof (struct PeerPlan));
303 pp->priority_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
304 pp->delay_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
306 GNUNET_CONTAINER_multihashmap_put (plans,
309 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
311 prd = GSF_pending_request_get_data_ (pr);
312 rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
314 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
315 "Planning transmission of query `%s' to peer `%s' (%p)\n",
316 GNUNET_h2s (&prd->query),
321 GNUNET_CONTAINER_DLL_insert (prd->rp_head,
325 if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
327 /* no request that should be done immediately, figure out delay */
328 if (rp != GNUNET_CONTAINER_heap_peek (pp->delay_heap))
329 return; /* did not change delay heap top, no need to do anything */
330 GNUNET_assert (NULL == pp->pth);
331 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
332 GNUNET_SCHEDULER_cancel (pp->task);
333 pp->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission),
334 &schedule_peer_transmission,
341 if (rp != GNUNET_CONTAINER_heap_peek (pp->priority_heap))
342 return; /* did not change priority heap top, no need to do anyhing */
343 GSF_peer_transmit_cancel_ (pp->pth);
346 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
347 GNUNET_SCHEDULER_cancel (pp->task);
348 pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission,
354 * Notify the plan about a peer being no longer available;
355 * destroy all entries associated with this peer.
357 * @param cp connected peer
360 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
362 struct GNUNET_PeerIdentity id;
364 struct GSF_RequestPlan *rp;
365 struct GSF_PendingRequestData *prd;
367 GSF_connected_peer_get_identity_ (cp, &id);
368 pp = GNUNET_CONTAINER_multihashmap_get (plans,
371 return; /* nothing was ever planned for this peer */
372 GNUNET_CONTAINER_multihashmap_remove (plans,
376 GSF_peer_transmit_cancel_ (pp->pth);
377 if (GNUNET_SCHEDULER_NO_TASK != pp->task)
378 GNUNET_SCHEDULER_cancel (pp->task);
379 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
381 prd = GSF_pending_request_get_data_ (rp->pr);
382 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
387 GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
388 while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
390 prd = GSF_pending_request_get_data_ (rp->pr);
391 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
396 GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
402 * Notify the plan about a request being done; destroy all entries
403 * associated with this request.
405 * @param pr request that is done
408 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
410 struct GSF_RequestPlan *rp;
411 struct GSF_PendingRequestData *prd;
413 prd = GSF_pending_request_get_data_ (pr);
414 while (NULL != (rp = prd->rp_head))
416 GNUNET_CONTAINER_heap_remove_node (rp->hn);
417 GNUNET_CONTAINER_DLL_remove (prd->rp_head,
426 * Initialize plan subsystem.
431 plans = GNUNET_CONTAINER_multihashmap_create (256);
436 * Shutdown plan subsystem.
442 GNUNET_CONTAINER_multihashmap_size (plans));
443 GNUNET_CONTAINER_multihashmap_destroy (plans);
448 /* end of gnunet-service-fs_pe.h */