2a6897cfb8b2a721d0af6a0ffee1a86f00a8ba49
[oweals/gnunet.git] / src / fs / gnunet-service-fs_pr.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file fs/gnunet-service-fs_pr.c
23  * @brief API to handle pending requests
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet_load_lib.h"
28 #include "gnunet-service-fs.h"
29 #include "gnunet-service-fs_cp.h"
30 #include "gnunet-service-fs_indexing.h"
31 #include "gnunet-service-fs_pe.h"
32 #include "gnunet-service-fs_pr.h"
33
34 /**
35  * Hard limit on the number of results we may get from the datastore per query.
36  */
37 #define MAX_RESULTS (100 * 1024)
38
39 /**
40  * An active request.
41  */
42 struct GSF_PendingRequest
43 {
44   /**
45    * Public data for the request.
46    */ 
47   struct GSF_PendingRequestData public_data;
48
49   /**
50    * Function to call if we encounter a reply.
51    */
52   GSF_PendingRequestReplyHandler rh;
53
54   /**
55    * Closure for 'rh'
56    */
57   void *rh_cls;
58
59   /**
60    * Array of hash codes of replies we've already seen.
61    */
62   GNUNET_HashCode *replies_seen;
63
64   /**
65    * Bloomfilter masking replies we've already seen.
66    */
67   struct GNUNET_CONTAINER_BloomFilter *bf;
68
69   /**
70    * Entry for this pending request in the expiration heap, or NULL.
71    */
72   struct GNUNET_CONTAINER_HeapNode *hnode;
73
74   /**
75    * Datastore queue entry for this request (or NULL for none).
76    */
77   struct GNUNET_DATASTORE_QueueEntry *qe;
78
79   /**
80    * DHT request handle for this request (or NULL for none).
81    */
82   struct GNUNET_DHT_GetHandle *gh;
83
84   /**
85    * Function to call upon completion of the local get
86    * request, or NULL for none.
87    */
88   GSF_LocalLookupContinuation llc_cont;
89
90   /**
91    * Closure for llc_cont.
92    */
93   void *llc_cont_cls;
94
95   /**
96    * Last result from the local datastore lookup evaluation.
97    */
98   enum GNUNET_BLOCK_EvaluationResult local_result;
99
100   /**
101    * Identity of the peer that we should use for the 'sender'
102    * (recipient of the response) when forwarding (0 for none).
103    */
104   GNUNET_PEER_Id sender_pid;
105
106   /**
107    * Time we started the last datastore lookup.
108    */
109   struct GNUNET_TIME_Absolute qe_start;
110
111   /**
112    * Task that warns us if the local datastore lookup takes too long.
113    */
114   GNUNET_SCHEDULER_TaskIdentifier warn_task;
115
116   /**
117    * Current offset for querying our local datastore for results.
118    * Starts at a random value, incremented until we get the same
119    * UID again (detected using 'first_uid'), which is then used
120    * to termiante the iteration.
121    */
122   uint64_t local_result_offset;
123
124   /**
125    * Unique ID of the first result from the local datastore;
126    * used to detect wrap-around of the offset.
127    */
128   uint64_t first_uid;
129
130   /**
131    * Number of valid entries in the 'replies_seen' array.
132    */
133   unsigned int replies_seen_count;
134
135   /**
136    * Length of the 'replies_seen' array.
137    */
138   unsigned int replies_seen_size;
139
140   /**
141    * Mingle value we currently use for the bf.
142    */
143   uint32_t mingle;
144
145   /**
146    * Do we have a first UID yet?
147    */
148   unsigned int have_first_uid;
149
150 };
151
152
153 /**
154  * All pending requests, ordered by the query.  Entries
155  * are of type 'struct GSF_PendingRequest*'.
156  */
157 static struct GNUNET_CONTAINER_MultiHashMap *pr_map;
158
159
160 /**
161  * Datastore 'PUT' load tracking.
162  */
163 static struct GNUNET_LOAD_Value *datastore_put_load;
164
165
166 /**
167  * Are we allowed to migrate content to this peer.
168  */
169 static int active_to_migration;
170
171
172 /**
173  * Heap with the request that will expire next at the top.  Contains
174  * pointers of type "struct PendingRequest*"; these will *also* be
175  * aliased from the "requests_by_peer" data structures and the
176  * "requests_by_query" table.  Note that requests from our clients
177  * don't expire and are thus NOT in the "requests_by_expiration"
178  * (or the "requests_by_peer" tables).
179  */
180 static struct GNUNET_CONTAINER_Heap *requests_by_expiration_heap;
181
182
183 /**
184  * Maximum number of requests (from other peers, overall) that we're
185  * willing to have pending at any given point in time.  Can be changed
186  * via the configuration file (32k is just the default).
187  */
188 static unsigned long long max_pending_requests = (32 * 1024);
189
190
191 /**
192  * How many bytes should a bloomfilter be if we have already seen
193  * entry_count responses?  Note that BLOOMFILTER_K gives us the number
194  * of bits set per entry.  Furthermore, we should not re-size the
195  * filter too often (to keep it cheap).
196  *
197  * Since other peers will also add entries but not resize the filter,
198  * we should generally pick a slightly larger size than what the
199  * strict math would suggest.
200  *
201  * @return must be a power of two and smaller or equal to 2^15.
202  */
203 static size_t
204 compute_bloomfilter_size (unsigned int entry_count)
205 {
206   size_t size;
207   unsigned int ideal = (entry_count * BLOOMFILTER_K) / 4;
208   uint16_t max = 1 << 15;
209
210   if (entry_count > max)
211     return max;
212   size = 8;
213   while ((size < max) && (size < ideal))
214     size *= 2;
215   if (size > max)
216     return max;
217   return size;
218 }
219
220
221 /**
222  * Recalculate our bloom filter for filtering replies.  This function
223  * will create a new bloom filter from scratch, so it should only be
224  * called if we have no bloomfilter at all (and hence can create a
225  * fresh one of minimal size without problems) OR if our peer is the
226  * initiator (in which case we may resize to larger than mimimum size).
227  *
228  * @param pr request for which the BF is to be recomputed
229  * @return GNUNET_YES if a refresh actually happened
230  */
231 static int
232 refresh_bloomfilter (struct GSF_PendingRequest *pr)
233 {
234   unsigned int i;
235   size_t nsize;
236   GNUNET_HashCode mhash;
237
238   nsize = compute_bloomfilter_size (pr->replies_seen_count);
239   if ( (pr->bf != NULL) &&
240        (nsize == GNUNET_CONTAINER_bloomfilter_get_size (pr->bf)) )
241     return GNUNET_NO; /* size not changed */
242   if (pr->bf != NULL)
243     GNUNET_CONTAINER_bloomfilter_free (pr->bf);
244   pr->mingle = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 
245                                          UINT32_MAX);
246   pr->bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 
247                                               nsize,
248                                               BLOOMFILTER_K);
249   for (i=0;i<pr->replies_seen_count;i++)
250     {
251       GNUNET_BLOCK_mingle_hash (&pr->replies_seen[i],
252                                 pr->mingle,
253                                 &mhash);
254       GNUNET_CONTAINER_bloomfilter_add (pr->bf, &mhash);
255     }
256   return GNUNET_YES;
257 }
258
259
260 /**
261  * Create a new pending request.  
262  *
263  * @param options request options
264  * @param type type of the block that is being requested
265  * @param query key for the lookup
266  * @param namespace namespace to lookup, NULL for no namespace
267  * @param target preferred target for the request, NULL for none
268  * @param bf_data raw data for bloom filter for known replies, can be NULL
269  * @param bf_size number of bytes in bf_data
270  * @param mingle mingle value for bf
271  * @param anonymity_level desired anonymity level
272  * @param priority maximum outgoing cummulative request priority to use
273  * @param ttl current time-to-live for the request
274  * @param sender_pid peer ID to use for the sender when forwarding, 0 for none
275  * @param replies_seen hash codes of known local replies
276  * @param replies_seen_count size of the 'replies_seen' array
277  * @param rh handle to call when we get a reply
278  * @param rh_cls closure for rh
279  * @return handle for the new pending request
280  */
281 struct GSF_PendingRequest *
282 GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
283                              enum GNUNET_BLOCK_Type type,
284                              const GNUNET_HashCode *query,
285                              const GNUNET_HashCode *namespace,
286                              const struct GNUNET_PeerIdentity *target,
287                              const char *bf_data,
288                              size_t bf_size,
289                              uint32_t mingle,
290                              uint32_t anonymity_level,
291                              uint32_t priority,
292                              int32_t ttl,
293                              GNUNET_PEER_Id sender_pid,
294                              const GNUNET_HashCode *replies_seen,
295                              unsigned int replies_seen_count,
296                              GSF_PendingRequestReplyHandler rh,
297                              void *rh_cls)
298 {
299   struct GSF_PendingRequest *pr;
300   struct GSF_PendingRequest *dpr;
301   
302 #if DEBUG_FS > 1
303   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
304               "Creating request handle for `%s' of type %d\n",
305               GNUNET_h2s (query),
306               type);
307 #endif 
308   pr = GNUNET_malloc (sizeof (struct GSF_PendingRequest));
309   pr->local_result_offset = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
310                                                       UINT64_MAX);                                                       
311   pr->public_data.query = *query;
312   if (GNUNET_BLOCK_TYPE_FS_SBLOCK == type)
313     {
314       GNUNET_assert (NULL != namespace);
315       pr->public_data.namespace = *namespace;
316     }
317   if (NULL != target)
318     {
319       pr->public_data.target = *target;
320       pr->public_data.has_target = GNUNET_YES;
321     }
322   pr->public_data.anonymity_level = anonymity_level;
323   pr->public_data.priority = priority;
324   pr->public_data.original_priority = priority;
325   pr->public_data.options = options;
326   pr->public_data.type = type;  
327   pr->public_data.start_time = GNUNET_TIME_absolute_get ();
328   pr->sender_pid = sender_pid;
329   pr->rh = rh;
330   pr->rh_cls = rh_cls;
331   if (ttl >= 0)
332     pr->public_data.ttl = GNUNET_TIME_relative_to_absolute (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
333                                                                                            (uint32_t) ttl));
334   else
335     pr->public_data.ttl = GNUNET_TIME_absolute_subtract (pr->public_data.start_time,
336                                                          GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
337                                                                                         (uint32_t) (- ttl)));
338   if (replies_seen_count > 0)
339     {
340       pr->replies_seen_size = replies_seen_count;
341       pr->replies_seen = GNUNET_malloc (sizeof (GNUNET_HashCode) * pr->replies_seen_size);
342       memcpy (pr->replies_seen,
343               replies_seen,
344               replies_seen_count * sizeof (GNUNET_HashCode));
345       pr->replies_seen_count = replies_seen_count;
346     }
347   if (NULL != bf_data)    
348     {
349       pr->bf = GNUNET_CONTAINER_bloomfilter_init (bf_data,
350                                                   bf_size,
351                                                   BLOOMFILTER_K);
352       pr->mingle = mingle;
353     }
354   else if ( (replies_seen_count > 0) &&
355             (0 != (options & GSF_PRO_BLOOMFILTER_FULL_REFRESH)) )
356     {
357       GNUNET_assert (GNUNET_YES == refresh_bloomfilter (pr));
358     }
359   GNUNET_CONTAINER_multihashmap_put (pr_map,
360                                      query,
361                                      pr,
362                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
363   if (0 != (options & GSF_PRO_REQUEST_EXPIRES))
364     {
365       pr->hnode = GNUNET_CONTAINER_heap_insert (requests_by_expiration_heap,
366                                                 pr,
367                                                 pr->public_data.ttl.abs_value);
368       /* make sure we don't track too many requests */
369       while (GNUNET_CONTAINER_heap_get_size (requests_by_expiration_heap) > max_pending_requests)
370         {
371           dpr = GNUNET_CONTAINER_heap_peek (requests_by_expiration_heap);
372           GNUNET_assert (dpr != NULL);
373           if (pr == dpr)
374             break; /* let the request live briefly... */
375           dpr->rh (dpr->rh_cls,
376                    GNUNET_BLOCK_EVALUATION_REQUEST_VALID,
377                    dpr,
378                    UINT32_MAX,
379                    GNUNET_TIME_UNIT_FOREVER_ABS,
380                    GNUNET_BLOCK_TYPE_ANY,
381                    NULL, 0);
382           GSF_pending_request_cancel_ (dpr);
383         }
384     }
385   GNUNET_STATISTICS_update (GSF_stats,
386                             gettext_noop ("# Pending requests active"),
387                             1,
388                             GNUNET_NO);
389   return pr;
390 }
391
392
393 /**
394  * Obtain the public data associated with a pending request
395  * 
396  * @param pr pending request
397  * @return associated public data
398  */
399 struct GSF_PendingRequestData *
400 GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr)
401 {
402   return &pr->public_data;
403 }
404
405
406 /**
407  * Update a given pending request with additional replies
408  * that have been seen.
409  *
410  * @param pr request to update
411  * @param replies_seen hash codes of replies that we've seen
412  * @param replies_seen_count size of the replies_seen array
413  */
414 void
415 GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
416                              const GNUNET_HashCode *replies_seen,
417                              unsigned int replies_seen_count)
418 {
419   unsigned int i;
420   GNUNET_HashCode mhash;
421
422   if (replies_seen_count + pr->replies_seen_count < pr->replies_seen_count)
423     return; /* integer overflow */
424   if (0 != (pr->public_data.options & GSF_PRO_BLOOMFILTER_FULL_REFRESH))
425     {
426       /* we're responsible for the BF, full refresh */
427       if (replies_seen_count + pr->replies_seen_count > pr->replies_seen_size)
428         GNUNET_array_grow (pr->replies_seen,
429                            pr->replies_seen_size,
430                            replies_seen_count + pr->replies_seen_count);
431       memcpy (&pr->replies_seen[pr->replies_seen_count],
432               replies_seen,
433               sizeof (GNUNET_HashCode) * replies_seen_count);
434       pr->replies_seen_count += replies_seen_count;
435       if (GNUNET_NO == refresh_bloomfilter (pr))
436         {
437           /* bf not recalculated, simply extend it with new bits */
438           for (i=0;i<replies_seen_count;i++)
439             {
440               GNUNET_BLOCK_mingle_hash (&replies_seen[i],
441                                         pr->mingle,
442                                         &mhash);
443               GNUNET_CONTAINER_bloomfilter_add (pr->bf, &mhash);
444             }
445         }
446     }
447   else
448     {
449       if (NULL == pr->bf)
450         {
451           /* we're not the initiator, but the initiator did not give us
452              any bloom-filter, so we need to create one on-the-fly */
453           pr->mingle = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 
454                                                  UINT32_MAX);
455           pr->bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
456                                                       compute_bloomfilter_size (replies_seen_count),
457                                                       BLOOMFILTER_K);
458         }
459       for (i=0;i<pr->replies_seen_count;i++)
460         {
461           GNUNET_BLOCK_mingle_hash (&replies_seen[i],
462                                     pr->mingle,
463                                     &mhash);
464           GNUNET_CONTAINER_bloomfilter_add (pr->bf, &mhash);
465         }
466     }
467 }
468
469
470 /**
471  * Generate the message corresponding to the given pending request for
472  * transmission to other peers (or at least determine its size).
473  *
474  * @param pr request to generate the message for
475  * @param buf_size number of bytes available in buf
476  * @param buf where to copy the message (can be NULL)
477  * @return number of bytes needed (if > buf_size) or used
478  */
479 size_t
480 GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
481                                   size_t buf_size,
482                                   void *buf)
483 {
484   char lbuf[GNUNET_SERVER_MAX_MESSAGE_SIZE];
485   struct GetMessage *gm;
486   GNUNET_HashCode *ext;
487   size_t msize;
488   unsigned int k;
489   uint32_t bm;
490   uint32_t prio;
491   size_t bf_size;
492   struct GNUNET_TIME_Absolute now;
493   int64_t ttl;
494   int do_route;
495
496 #if DEBUG_FS
497   if (buf_size > 0)
498     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
499                 "Building request message for `%s' of type %d\n",
500                 GNUNET_h2s (&pr->public_data.query),
501                 pr->public_data.type);
502 #endif 
503   k = 0;
504   bm = 0;
505   do_route = (0 == (pr->public_data.options & GSF_PRO_FORWARD_ONLY));
506   if (! do_route)
507     {
508       bm |= GET_MESSAGE_BIT_RETURN_TO;
509       k++;      
510     }
511   if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
512     {
513       bm |= GET_MESSAGE_BIT_SKS_NAMESPACE;
514       k++;
515     }
516   if (GNUNET_YES == pr->public_data.has_target)
517     {
518       bm |= GET_MESSAGE_BIT_TRANSMIT_TO;
519       k++;
520     }
521   bf_size = GNUNET_CONTAINER_bloomfilter_get_size (pr->bf);
522   msize = sizeof (struct GetMessage) + bf_size + k * sizeof(GNUNET_HashCode);
523   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
524   if (buf_size < msize)
525     return msize;  
526   gm = (struct GetMessage*) lbuf;
527   gm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_GET);
528   gm->header.size = htons (msize);
529   gm->type = htonl (pr->public_data.type);
530   if (do_route)
531     prio = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
532                                      pr->public_data.priority + 1);
533   else
534     prio = 0;
535   pr->public_data.priority -= prio;
536   gm->priority = htonl (prio);
537   now = GNUNET_TIME_absolute_get ();
538   ttl = (int64_t) (pr->public_data.ttl.abs_value - now.abs_value);
539   gm->ttl = htonl (ttl / 1000);
540   gm->filter_mutator = htonl(pr->mingle); 
541   gm->hash_bitmap = htonl (bm);
542   gm->query = pr->public_data.query;
543   ext = (GNUNET_HashCode*) &gm[1];
544   k = 0;  
545   if (! do_route)
546     GNUNET_PEER_resolve (pr->sender_pid, 
547                          (struct GNUNET_PeerIdentity*) &ext[k++]);
548   if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
549     memcpy (&ext[k++], 
550             &pr->public_data.namespace, 
551             sizeof (GNUNET_HashCode));
552   if (GNUNET_YES == pr->public_data.has_target)
553     ext[k++] = pr->public_data.target.hashPubKey;
554   if (pr->bf != NULL)
555     GNUNET_CONTAINER_bloomfilter_get_raw_data (pr->bf,
556                                                (char*) &ext[k],
557                                                bf_size);
558   memcpy (buf, gm, msize);
559   return msize;
560 }
561
562
563 /**
564  * Iterator to free pending requests.
565  *
566  * @param cls closure, unused
567  * @param key current key code
568  * @param value value in the hash map (pending request)
569  * @return GNUNET_YES (we should continue to iterate)
570  */
571 static int 
572 clean_request (void *cls,
573                const GNUNET_HashCode * key,
574                void *value)
575 {
576   struct GSF_PendingRequest *pr = value;
577   GSF_LocalLookupContinuation cont;
578
579 #if DEBUG_FS
580   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
581               "Cleaning up pending request for `%s'.\n",
582               GNUNET_h2s (key));
583 #endif  
584   if (NULL != (cont = pr->llc_cont))
585     {
586       pr->llc_cont = NULL;
587       cont (pr->llc_cont_cls,
588             pr,
589             pr->local_result);
590     } 
591   GSF_plan_notify_request_done_ (pr);
592   GNUNET_free_non_null (pr->replies_seen);
593   if (NULL != pr->bf)
594     {
595       GNUNET_CONTAINER_bloomfilter_free (pr->bf);
596       pr->bf = NULL;
597     }
598   GNUNET_PEER_change_rc (pr->sender_pid, -1);
599   if (NULL != pr->hnode)
600     {
601       GNUNET_CONTAINER_heap_remove_node (pr->hnode);
602       pr->hnode = NULL;
603     }
604   if (NULL != pr->qe)
605     {
606       GNUNET_DATASTORE_cancel (pr->qe);
607       pr->qe = NULL;
608     }
609   if (NULL != pr->gh)
610     {
611       GNUNET_DHT_get_stop (pr->gh);
612       pr->gh = NULL;
613     }
614   if (GNUNET_SCHEDULER_NO_TASK != pr->warn_task)
615     {
616       GNUNET_SCHEDULER_cancel (pr->warn_task);
617       pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
618     }
619   GNUNET_assert (GNUNET_OK ==
620                  GNUNET_CONTAINER_multihashmap_remove (pr_map,
621                                                        &pr->public_data.query,
622                                                        pr));
623   GNUNET_STATISTICS_update (GSF_stats,
624                             gettext_noop ("# Pending requests active"),
625                             -1,
626                             GNUNET_NO);
627   GNUNET_free (pr);
628   return GNUNET_YES;
629 }
630
631
632 /**
633  * Explicitly cancel a pending request.
634  *
635  * @param pr request to cancel
636  */
637 void
638 GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr)
639 {
640   if (NULL == pr_map) 
641     return; /* already cleaned up! */
642   GNUNET_assert (GNUNET_YES ==
643                  clean_request (NULL, &pr->public_data.query, pr));  
644 }
645
646
647 /**
648  * Iterate over all pending requests.
649  *
650  * @param it function to call for each request
651  * @param cls closure for it
652  */
653 void
654 GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
655                                void *cls)
656 {
657   GNUNET_CONTAINER_multihashmap_iterate (pr_map,
658                                          (GNUNET_CONTAINER_HashMapIterator) it,
659                                          cls);
660 }
661
662
663
664
665 /**
666  * Closure for "process_reply" function.
667  */
668 struct ProcessReplyClosure
669 {
670   /**
671    * The data for the reply.
672    */
673   const void *data;
674
675   /**
676    * Who gave us this reply? NULL for local host (or DHT)
677    */
678   struct GSF_ConnectedPeer *sender;
679
680   /**
681    * When the reply expires.
682    */
683   struct GNUNET_TIME_Absolute expiration;
684
685   /**
686    * Size of data.
687    */
688   size_t size;
689
690   /**
691    * Type of the block.
692    */
693   enum GNUNET_BLOCK_Type type;
694
695   /**
696    * How much was this reply worth to us?
697    */
698   uint32_t priority;
699
700   /**
701    * Anonymity requirements for this reply.
702    */
703   uint32_t anonymity_level;
704
705   /**
706    * Evaluation result (returned).
707    */
708   enum GNUNET_BLOCK_EvaluationResult eval;
709
710   /**
711    * Did we find a matching request?
712    */
713   int request_found;
714 };
715
716
717 /**
718  * Update the performance data for the sender (if any) since
719  * the sender successfully answered one of our queries.
720  *
721  * @param prq information about the sender
722  * @param pr request that was satisfied
723  */
724 static void
725 update_request_performance_data (struct ProcessReplyClosure *prq,
726                                  struct GSF_PendingRequest *pr)
727 {
728   if (prq->sender == NULL)
729     return;      
730   GSF_peer_update_performance_ (prq->sender,
731                                 pr->public_data.start_time,
732                                 prq->priority);
733 }
734                                 
735
736 /**
737  * We have received a reply; handle it!
738  *
739  * @param cls response (struct ProcessReplyClosure)
740  * @param key our query
741  * @param value value in the hash map (info about the query)
742  * @return GNUNET_YES (we should continue to iterate)
743  */
744 static int
745 process_reply (void *cls,
746                const GNUNET_HashCode *key,
747                void *value)
748 {
749   struct ProcessReplyClosure *prq = cls;
750   struct GSF_PendingRequest *pr = value;
751   GNUNET_HashCode chash;
752
753 #if DEBUG_FS
754   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
755               "Matched result (type %u) for query `%s' with pending request\n",
756               (unsigned int) prq->type,
757               GNUNET_h2s (key));
758 #endif  
759   GNUNET_STATISTICS_update (GSF_stats,
760                             gettext_noop ("# replies received and matched"),
761                             1,
762                             GNUNET_NO);
763   prq->eval = GNUNET_BLOCK_evaluate (GSF_block_ctx,
764                                      prq->type,
765                                      key,
766                                      &pr->bf,
767                                      pr->mingle,
768                                      &pr->public_data.namespace, 
769                                      (prq->type == GNUNET_BLOCK_TYPE_FS_SBLOCK) ? sizeof (GNUNET_HashCode) : 0,
770                                      prq->data,
771                                      prq->size);
772   switch (prq->eval)
773     {
774     case GNUNET_BLOCK_EVALUATION_OK_MORE:
775       update_request_performance_data (prq, pr);
776       break;
777     case GNUNET_BLOCK_EVALUATION_OK_LAST:
778       /* short cut: stop processing early, no BF-update, etc. */
779       update_request_performance_data (prq, pr);
780       GNUNET_LOAD_update (GSF_rt_entry_lifetime,
781                           GNUNET_TIME_absolute_get_duration (pr->public_data.start_time).rel_value);
782       /* pass on to other peers / local clients */
783       pr->rh (pr->rh_cls,             
784               prq->eval,
785               pr,
786               prq->anonymity_level,
787               prq->expiration,
788               prq->type,
789               prq->data, prq->size);
790       return GNUNET_YES;
791     case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
792       GNUNET_STATISTICS_update (GSF_stats,
793                                 gettext_noop ("# duplicate replies discarded (bloomfilter)"),
794                                 1,
795                                 GNUNET_NO);
796 #if DEBUG_FS && 0
797       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
798                   "Duplicate response `%s', discarding.\n",
799                   GNUNET_h2s (&mhash));
800 #endif
801       return GNUNET_YES; /* duplicate */
802     case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
803       return GNUNET_YES; /* wrong namespace */  
804     case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
805       GNUNET_break (0);
806       return GNUNET_YES;
807     case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
808       GNUNET_break (0);
809       return GNUNET_YES;
810     case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
811       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
812                   _("Unsupported block type %u\n"),
813                   prq->type);
814       return GNUNET_NO;
815     }
816   /* update bloomfilter */
817   GNUNET_CRYPTO_hash (prq->data,
818                       prq->size,
819                       &chash);
820   GSF_pending_request_update_ (pr, &chash, 1);
821   if (NULL == prq->sender)
822     {
823 #if DEBUG_FS
824       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
825                   "Found result for query `%s' in local datastore\n",
826                   GNUNET_h2s (key));
827 #endif
828       GNUNET_STATISTICS_update (GSF_stats,
829                                 gettext_noop ("# results found locally"),
830                                 1,
831                                 GNUNET_NO);      
832     }
833   else
834     {     
835       GSF_dht_lookup_ (pr);
836     }
837   prq->priority += pr->public_data.original_priority;
838   pr->public_data.priority = 0;
839   pr->public_data.original_priority = 0;
840   pr->public_data.results_found++;
841   prq->request_found = GNUNET_YES;
842   /* finally, pass on to other peer / local client */
843   pr->rh (pr->rh_cls,
844           prq->eval,
845           pr, 
846           prq->anonymity_level,
847           prq->expiration,
848           prq->type,
849           prq->data, prq->size);
850   return GNUNET_YES;
851 }
852
853
854 /**
855  * Context for the 'put_migration_continuation'.
856  */
857 struct PutMigrationContext
858 {
859
860   /**
861    * Start time for the operation.
862    */
863   struct GNUNET_TIME_Absolute start;
864
865   /**
866    * Request origin.
867    */
868   struct GNUNET_PeerIdentity origin;
869
870   /**
871    * GNUNET_YES if we had a matching request for this block,
872    * GNUNET_NO if not.
873    */
874   int requested;
875 };
876
877
878 /**
879  * Continuation called to notify client about result of the
880  * operation.
881  *
882  * @param cls closure
883  * @param success GNUNET_SYSERR on failure
884  * @param msg NULL on success, otherwise an error message
885  */
886 static void 
887 put_migration_continuation (void *cls,
888                             int success,
889                             const char *msg)
890 {
891   struct PutMigrationContext *pmc = cls;
892   struct GNUNET_TIME_Relative delay;
893   struct GNUNET_TIME_Relative block_time;  
894   struct GSF_ConnectedPeer *cp;
895   struct GSF_PeerPerformanceData *ppd;
896                          
897   delay = GNUNET_TIME_absolute_get_duration (pmc->start);
898   cp = GSF_peer_get_ (&pmc->origin);
899   if ( (GNUNET_OK != success) &&
900        (GNUNET_NO == pmc->requested) )
901     {
902       /* block migration for a bit... */
903       if (NULL != cp)
904         {
905           ppd = GSF_get_peer_performance_data_ (cp);
906           ppd->migration_duplication++;
907           block_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
908                                                       5 * ppd->migration_duplication + 
909                                                       GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 5));
910           GSF_block_peer_migration_ (cp, block_time);
911         }
912     }
913   else
914     {
915       if (NULL != cp)
916         {
917           ppd = GSF_get_peer_performance_data_ (cp);
918           ppd->migration_duplication = 0; /* reset counter */
919         }
920     }
921   GNUNET_free (pmc);
922   /* FIXME: should we really update the load value on failure? */
923   GNUNET_LOAD_update (datastore_put_load,
924                       delay.rel_value);
925   if (GNUNET_OK == success)
926     return;
927   GNUNET_STATISTICS_update (GSF_stats,
928                             gettext_noop ("# datastore 'put' failures"),
929                             1,
930                             GNUNET_NO);
931 }
932
933
934 /**
935  * Test if the DATABASE (PUT) load on this peer is too high
936  * to even consider processing the query at
937  * all.  
938  * 
939  * @return GNUNET_YES if the load is too high to do anything (load high)
940  *         GNUNET_NO to process normally (load normal or low)
941  */
942 static int
943 test_put_load_too_high (uint32_t priority)
944 {
945   double ld;
946
947   if (GNUNET_LOAD_get_average (datastore_put_load) < 50)
948     return GNUNET_NO; /* very fast */
949   ld = GNUNET_LOAD_get_load (datastore_put_load);
950   if (ld < 2.0 * (1 + priority))
951     return GNUNET_NO;
952   GNUNET_STATISTICS_update (GSF_stats,
953                             gettext_noop ("# storage requests dropped due to high load"),
954                             1,
955                             GNUNET_NO);
956   return GNUNET_YES;
957 }
958
959
960 /**
961  * Iterator called on each result obtained for a DHT
962  * operation that expects a reply
963  *
964  * @param cls closure
965  * @param exp when will this value expire
966  * @param key key of the result
967  * @param get_path NULL-terminated array of pointers
968  *                 to the peers on reverse GET path (or NULL if not recorded)
969  * @param put_path NULL-terminated array of pointers
970  *                 to the peers on the PUT path (or NULL if not recorded)
971  * @param type type of the result
972  * @param size number of bytes in data
973  * @param data pointer to the result data
974  */
975 static void
976 handle_dht_reply (void *cls,
977                   struct GNUNET_TIME_Absolute exp,
978                   const GNUNET_HashCode *key,
979                   const struct GNUNET_PeerIdentity * const *get_path,
980                   const struct GNUNET_PeerIdentity * const *put_path,
981                   enum GNUNET_BLOCK_Type type,
982                   size_t size,
983                   const void *data)
984 {
985   struct GSF_PendingRequest *pr = cls;
986   struct ProcessReplyClosure prq;
987   struct PutMigrationContext *pmc;
988
989   GNUNET_STATISTICS_update (GSF_stats,
990                             gettext_noop ("# Replies received from DHT"),
991                             1,
992                             GNUNET_NO);
993   memset (&prq, 0, sizeof (prq));
994   prq.data = data;
995   prq.expiration = exp;
996   prq.size = size;  
997   prq.type = type;
998   process_reply (&prq, key, pr);
999   if ( (GNUNET_YES == active_to_migration) &&
1000        (GNUNET_NO == test_put_load_too_high (prq.priority)) )
1001     {      
1002 #if DEBUG_FS
1003       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1004                   "Replicating result for query `%s' with priority %u\n",
1005                   GNUNET_h2s (key),
1006                   prq.priority);
1007 #endif
1008       pmc = GNUNET_malloc (sizeof (struct PutMigrationContext));
1009       pmc->start = GNUNET_TIME_absolute_get ();
1010       pmc->requested = GNUNET_YES;
1011       if (NULL == 
1012           GNUNET_DATASTORE_put (GSF_dsh,
1013                                 0, key, size, data,
1014                                 type, prq.priority, 1 /* anonymity */, 
1015                                 0 /* replication */,
1016                                 exp, 
1017                                 1 + prq.priority, MAX_DATASTORE_QUEUE,
1018                                 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1019                                 &put_migration_continuation, 
1020                                 pmc))
1021         {
1022           put_migration_continuation (pmc, GNUNET_NO, NULL);    
1023         }
1024     }
1025 }
1026
1027
1028 /**
1029  * Consider looking up the data in the DHT (anonymity-level permitting).
1030  *
1031  * @param pr the pending request to process
1032  */
1033 void
1034 GSF_dht_lookup_ (struct GSF_PendingRequest *pr)
1035 {
1036   const void *xquery;
1037   size_t xquery_size;
1038   struct GNUNET_PeerIdentity pi;
1039   char buf[sizeof (GNUNET_HashCode) * 2];
1040
1041   if (0 != pr->public_data.anonymity_level)
1042     return;
1043   if (NULL != pr->gh)
1044     {
1045       GNUNET_DHT_get_stop (pr->gh);
1046       pr->gh = NULL;
1047     }
1048   xquery = NULL;
1049   xquery_size = 0;
1050   if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
1051     {
1052       xquery = buf;
1053       memcpy (buf, &pr->public_data.namespace, sizeof (GNUNET_HashCode));
1054       xquery_size = sizeof (GNUNET_HashCode);
1055     }
1056   if (0 != (pr->public_data.options & GSF_PRO_FORWARD_ONLY))
1057     {
1058       GNUNET_PEER_resolve (pr->sender_pid,
1059                            &pi);
1060       memcpy (&buf[xquery_size], &pi, sizeof (struct GNUNET_PeerIdentity));
1061       xquery_size += sizeof (struct GNUNET_PeerIdentity);
1062     }
1063   pr->gh = GNUNET_DHT_get_start (GSF_dht,
1064                                  GNUNET_TIME_UNIT_FOREVER_REL,
1065                                  pr->public_data.type,
1066                                  &pr->public_data.query,
1067                                  DEFAULT_GET_REPLICATION,
1068                                  GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
1069                                  pr->bf,
1070                                  pr->mingle,
1071                                  xquery,
1072                                  xquery_size,
1073                                  &handle_dht_reply,
1074                                  pr);
1075 }
1076
1077
1078 /**
1079  * Task that issues a warning if the datastore lookup takes too long.
1080  * 
1081  * @param cls the 'struct GSF_PendingRequest'
1082  * @param tc task context
1083  */
1084 static void
1085 warn_delay_task (void *cls,
1086                  const struct GNUNET_SCHEDULER_TaskContext *tc)
1087 {
1088   struct GSF_PendingRequest *pr = cls;
1089
1090   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1091               _("Datastore lookup already took %llu ms!\n"),
1092               (unsigned long long) GNUNET_TIME_absolute_get_duration (pr->qe_start).rel_value);
1093   pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1094                                                 &warn_delay_task,
1095                                                 pr);
1096 }
1097
1098
1099 /**
1100  * Task that issues a warning if the datastore lookup takes too long.
1101  * 
1102  * @param cls the 'struct GSF_PendingRequest'
1103  * @param tc task context
1104  */
1105 static void
1106 odc_warn_delay_task (void *cls,
1107                      const struct GNUNET_SCHEDULER_TaskContext *tc)
1108 {
1109   struct GSF_PendingRequest *pr = cls;
1110
1111   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1112               _("On-demand lookup already took %llu ms!\n"),
1113               (unsigned long long) GNUNET_TIME_absolute_get_duration (pr->qe_start).rel_value);
1114   pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1115                                                 &odc_warn_delay_task,
1116                                                 pr);
1117 }
1118
1119
1120 /**
1121  * We're processing (local) results for a search request
1122  * from another peer.  Pass applicable results to the
1123  * peer and if we are done either clean up (operation
1124  * complete) or forward to other peers (more results possible).
1125  *
1126  * @param cls our closure (struct PendingRequest)
1127  * @param key key for the content
1128  * @param size number of bytes in data
1129  * @param data content stored
1130  * @param type type of the content
1131  * @param priority priority of the content
1132  * @param anonymity anonymity-level for the content
1133  * @param expiration expiration time for the content
1134  * @param uid unique identifier for the datum;
1135  *        maybe 0 if no unique identifier is available
1136  */
1137 static void
1138 process_local_reply (void *cls,
1139                      const GNUNET_HashCode *key,
1140                      size_t size,
1141                      const void *data,
1142                      enum GNUNET_BLOCK_Type type,
1143                      uint32_t priority,
1144                      uint32_t anonymity,
1145                      struct GNUNET_TIME_Absolute expiration, 
1146                      uint64_t uid)
1147 {
1148   struct GSF_PendingRequest *pr = cls;
1149   GSF_LocalLookupContinuation cont;
1150   struct ProcessReplyClosure prq;
1151   GNUNET_HashCode query;
1152   unsigned int old_rf;
1153   
1154   pr->qe = NULL;
1155   GNUNET_SCHEDULER_cancel (pr->warn_task);
1156   pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1157   if (GNUNET_NO == pr->have_first_uid)
1158     {
1159       pr->first_uid = uid;
1160       pr->have_first_uid = 1;
1161     }
1162   else
1163     {
1164       if (uid == pr->first_uid)
1165         {
1166           GNUNET_STATISTICS_update (GSF_stats,
1167                                     gettext_noop ("# Datastore lookups concluded"),
1168                                     1,
1169                                     GNUNET_NO);
1170           key = NULL; /* all replies seen! */
1171         }
1172       pr->have_first_uid++;
1173       if (pr->have_first_uid > MAX_RESULTS)
1174         {
1175           GNUNET_STATISTICS_update (GSF_stats,
1176                                     gettext_noop ("# Datastore lookups aborted (more than MAX_RESULTS)"),
1177                                     1,
1178                                     GNUNET_NO);
1179           key = NULL; /* all replies seen! */
1180         }
1181     }
1182   if (NULL == key)
1183     {
1184 #if DEBUG_FS > 1
1185       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1186                   "No further local responses available.\n");
1187 #endif
1188       if ( (pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK) ||
1189            (pr->public_data.type == GNUNET_BLOCK_TYPE_FS_IBLOCK) )
1190         GNUNET_STATISTICS_update (GSF_stats,
1191                                   gettext_noop ("# requested DBLOCK or IBLOCK not found"),
1192                                   1,
1193                                   GNUNET_NO);
1194       goto check_error_and_continue;
1195     }
1196 #if DEBUG_FS
1197   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1198               "Received reply for `%s' of type %d with UID %llu from datastore.\n",
1199               GNUNET_h2s (key),
1200               type,
1201               (unsigned long long) uid);
1202 #endif
1203   if (type == GNUNET_BLOCK_TYPE_FS_ONDEMAND)
1204     {
1205 #if DEBUG_FS > 1
1206       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1207                   "Found ONDEMAND block, performing on-demand encoding\n");
1208 #endif
1209       GNUNET_STATISTICS_update (GSF_stats,
1210                                 gettext_noop ("# on-demand blocks matched requests"),
1211                                 1,
1212                                 GNUNET_NO);
1213       pr->qe_start = GNUNET_TIME_absolute_get ();
1214       pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1215                                                     &odc_warn_delay_task,
1216                                                     pr);
1217       if (GNUNET_OK == 
1218           GNUNET_FS_handle_on_demand_block (key, size, data, type, priority, 
1219                                             anonymity, expiration, uid, 
1220                                             &process_local_reply,
1221                                             pr))
1222         {
1223           GNUNET_STATISTICS_update (GSF_stats,
1224                                     gettext_noop ("# on-demand lookups performed successfully"),
1225                                     1,
1226                                     GNUNET_NO);
1227           return; /* we're done */
1228         }
1229       GNUNET_STATISTICS_update (GSF_stats,
1230                                 gettext_noop ("# on-demand lookups failed"),
1231                                 1,
1232                                 GNUNET_NO);
1233       GNUNET_SCHEDULER_cancel (pr->warn_task);
1234       pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1235                                                     &warn_delay_task,
1236                                                     pr);        
1237       pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1238                                          pr->local_result_offset - 1,
1239                                          &pr->public_data.query,
1240                                          pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK 
1241                                          ? GNUNET_BLOCK_TYPE_ANY 
1242                                          : pr->public_data.type, 
1243                                          (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1244                                          ? UINT_MAX
1245                                          : 1 /* queue priority */,
1246                                          (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1247                                          ? UINT_MAX
1248                                          : 1 /* max queue size */,
1249                                          GNUNET_TIME_UNIT_FOREVER_REL,
1250                                          &process_local_reply,
1251                                          pr);
1252       if (NULL != pr->qe)
1253         return; /* we're done */        
1254       goto check_error_and_continue;
1255     }
1256   old_rf = pr->public_data.results_found;
1257   memset (&prq, 0, sizeof (prq));
1258   prq.data = data;
1259   prq.expiration = expiration;
1260   prq.size = size;  
1261   if (GNUNET_OK != 
1262       GNUNET_BLOCK_get_key (GSF_block_ctx,
1263                             type,
1264                             data,
1265                             size,
1266                             &query))
1267     {
1268       GNUNET_break (0);
1269       GNUNET_DATASTORE_remove (GSF_dsh,
1270                                key,
1271                                size, data,
1272                                -1, -1, 
1273                                GNUNET_TIME_UNIT_FOREVER_REL,
1274                                NULL, NULL);
1275       pr->qe_start = GNUNET_TIME_absolute_get ();
1276       pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1277                                                     &warn_delay_task,
1278                                                     pr);
1279       pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1280                                          pr->local_result_offset - 1,
1281                                          &pr->public_data.query,
1282                                          pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK 
1283                                          ? GNUNET_BLOCK_TYPE_ANY 
1284                                          : pr->public_data.type, 
1285                                          (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1286                                          ? UINT_MAX
1287                                          : 1 /* queue priority */,
1288                                          (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1289                                          ? UINT_MAX
1290                                          : 1 /* max queue size */,
1291                                          GNUNET_TIME_UNIT_FOREVER_REL,
1292                                          &process_local_reply,
1293                                          pr);
1294       if (pr->qe == NULL)       
1295         goto check_error_and_continue;  
1296       return;
1297     }
1298   prq.type = type;
1299   prq.priority = priority;  
1300   prq.request_found = GNUNET_NO;
1301   prq.anonymity_level = anonymity;
1302   if ( (old_rf == 0) &&
1303        (pr->public_data.results_found == 0) )
1304     GSF_update_datastore_delay_ (pr->public_data.start_time);
1305   process_reply (&prq, key, pr);
1306   pr->local_result = prq.eval;
1307   if (prq.eval == GNUNET_BLOCK_EVALUATION_OK_LAST)
1308     goto check_error_and_continue;
1309   if ( (0 == (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options)) &&
1310        ( (GNUNET_YES == GSF_test_get_load_too_high_ (0)) ||
1311          (pr->public_data.results_found > 5 + 2 * pr->public_data.priority) ) )
1312     {
1313 #if DEBUG_FS > 2
1314       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1315                   "Load too high, done with request\n");
1316 #endif
1317       GNUNET_STATISTICS_update (GSF_stats,
1318                                 gettext_noop ("# processing result set cut short due to load"),
1319                                 1,
1320                                 GNUNET_NO);
1321       goto check_error_and_continue;
1322     }
1323   pr->qe_start = GNUNET_TIME_absolute_get ();
1324   pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1325                                                 &warn_delay_task,
1326                                                 pr);
1327   pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1328                                      pr->local_result_offset++,
1329                                      &pr->public_data.query,
1330                                      pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK 
1331                                      ? GNUNET_BLOCK_TYPE_ANY 
1332                                      : pr->public_data.type, 
1333                                      (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1334                                      ? UINT_MAX
1335                                      : 1 /* queue priority */,
1336                                      (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1337                                      ? UINT_MAX
1338                                      : 1 /* max queue size */,
1339                                      GNUNET_TIME_UNIT_FOREVER_REL,
1340                                      &process_local_reply,
1341                                      pr);
1342   /* check if we successfully queued another datastore request;
1343      if so, return, otherwise call our continuation (if we have
1344      any) */
1345  check_error_and_continue:
1346   if (NULL != pr->qe)
1347     return;
1348   if (GNUNET_SCHEDULER_NO_TASK != pr->warn_task)
1349     {
1350       GNUNET_SCHEDULER_cancel (pr->warn_task);
1351       pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1352     }
1353   if (NULL == (cont = pr->llc_cont))
1354     return; /* no continuation */      
1355   pr->llc_cont = NULL;
1356   cont (pr->llc_cont_cls,
1357         pr,
1358         pr->local_result);
1359 }
1360
1361
1362 /**
1363  * Look up the request in the local datastore.
1364  *
1365  * @param pr the pending request to process
1366  * @param cont function to call at the end
1367  * @param cont_cls closure for cont
1368  */
1369 void
1370 GSF_local_lookup_ (struct GSF_PendingRequest *pr,
1371                    GSF_LocalLookupContinuation cont,
1372                    void *cont_cls)
1373 {
1374   GNUNET_assert (NULL == pr->gh);
1375   GNUNET_assert (NULL == pr->llc_cont);
1376   pr->llc_cont = cont;
1377   pr->llc_cont_cls = cont_cls;
1378   pr->qe_start = GNUNET_TIME_absolute_get ();
1379   pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1380                                                 &warn_delay_task,
1381                                                 pr);
1382   GNUNET_STATISTICS_update (GSF_stats,
1383                             gettext_noop ("# Datastore lookups initiated"),
1384                             1,
1385                             GNUNET_NO);
1386   pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1387                                      pr->local_result_offset++,
1388                                      &pr->public_data.query,
1389                                      pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK 
1390                                      ? GNUNET_BLOCK_TYPE_ANY 
1391                                      : pr->public_data.type, 
1392                                      (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1393                                      ? UINT_MAX
1394                                      : 1 /* queue priority */,
1395                                      (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1396                                      ? UINT_MAX
1397                                      : 1 /* max queue size */,
1398                                      GNUNET_TIME_UNIT_FOREVER_REL,
1399                                      &process_local_reply,
1400                                      pr);
1401   if (NULL != pr->qe)
1402     return;
1403   GNUNET_SCHEDULER_cancel (pr->warn_task);
1404   pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1405   pr->llc_cont = NULL;
1406   if (NULL != cont)
1407     cont (cont_cls, pr, pr->local_result);      
1408 }
1409
1410
1411
1412 /**
1413  * Handle P2P "CONTENT" message.  Checks that the message is
1414  * well-formed and then checks if there are any pending requests for
1415  * this content and possibly passes it on (to local clients or other
1416  * peers).  Does NOT perform migration (content caching at this peer).
1417  *
1418  * @param cp the other peer involved (sender or receiver, NULL
1419  *        for loopback messages where we are both sender and receiver)
1420  * @param message the actual message
1421  * @return GNUNET_OK if the message was well-formed,
1422  *         GNUNET_SYSERR if the message was malformed (close connection,
1423  *         do not cache under any circumstances)
1424  */
1425 int
1426 GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
1427                          const struct GNUNET_MessageHeader *message)
1428 {
1429   const struct PutMessage *put;
1430   uint16_t msize;
1431   size_t dsize;
1432   enum GNUNET_BLOCK_Type type;
1433   struct GNUNET_TIME_Absolute expiration;
1434   GNUNET_HashCode query;
1435   struct ProcessReplyClosure prq;
1436   struct GNUNET_TIME_Relative block_time;  
1437   double putl;
1438   struct PutMigrationContext *pmc;
1439
1440   msize = ntohs (message->size);
1441   if (msize < sizeof (struct PutMessage))
1442     {
1443       GNUNET_break_op(0);
1444       return GNUNET_SYSERR;
1445     }
1446   put = (const struct PutMessage*) message;
1447   dsize = msize - sizeof (struct PutMessage);
1448   type = ntohl (put->type);
1449   expiration = GNUNET_TIME_absolute_ntoh (put->expiration);
1450   if (type == GNUNET_BLOCK_TYPE_FS_ONDEMAND)
1451     return GNUNET_SYSERR;
1452   if (GNUNET_OK !=
1453       GNUNET_BLOCK_get_key (GSF_block_ctx,
1454                             type,
1455                             &put[1],
1456                             dsize,
1457                             &query))
1458     {
1459       GNUNET_break_op (0);
1460       return GNUNET_SYSERR;
1461     }
1462   GNUNET_STATISTICS_update (GSF_stats,
1463                             gettext_noop ("# GAP PUT messages received"),
1464                             1,
1465                             GNUNET_NO);
1466   /* now, lookup 'query' */
1467   prq.data = (const void*) &put[1];
1468   if (NULL != cp)
1469     prq.sender = cp;
1470   else
1471     prq.sender = NULL;
1472   prq.size = dsize;
1473   prq.type = type;
1474   prq.expiration = expiration;
1475   prq.priority = 0;
1476   prq.anonymity_level = UINT32_MAX;
1477   prq.request_found = GNUNET_NO;
1478   GNUNET_CONTAINER_multihashmap_get_multiple (pr_map,
1479                                               &query,
1480                                               &process_reply,
1481                                               &prq);
1482   if (NULL != cp)
1483     {
1484       GSF_connected_peer_change_preference_ (cp, CONTENT_BANDWIDTH_VALUE + 1000 * prq.priority);
1485       GSF_get_peer_performance_data_ (cp)->trust += prq.priority;
1486     }
1487   if ( (GNUNET_YES == active_to_migration) &&
1488        (GNUNET_NO == test_put_load_too_high (prq.priority)) )
1489     {      
1490 #if DEBUG_FS
1491       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1492                   "Replicating result for query `%s' with priority %u\n",
1493                   GNUNET_h2s (&query),
1494                   prq.priority);
1495 #endif
1496       pmc = GNUNET_malloc (sizeof (struct PutMigrationContext));
1497       pmc->start = GNUNET_TIME_absolute_get ();
1498       pmc->requested = prq.request_found;
1499       GNUNET_PEER_resolve (GSF_get_peer_performance_data_ (cp)->pid,
1500                            &pmc->origin);
1501       if (NULL ==
1502           GNUNET_DATASTORE_put (GSF_dsh,
1503                                 0, &query, dsize, &put[1],
1504                                 type, prq.priority, 1 /* anonymity */, 
1505                                 0 /* replication */,
1506                                 expiration, 
1507                                 1 + prq.priority, MAX_DATASTORE_QUEUE,
1508                                 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1509                                 &put_migration_continuation, 
1510                                 pmc))
1511         {
1512           put_migration_continuation (pmc, GNUNET_NO, NULL);      
1513         }
1514     }
1515   else
1516     {
1517 #if DEBUG_FS
1518       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1519                   "Choosing not to keep content `%s' (%d/%d)\n",
1520                   GNUNET_h2s (&query),
1521                   active_to_migration,
1522                   test_put_load_too_high (prq.priority));
1523 #endif
1524     }
1525   putl = GNUNET_LOAD_get_load (datastore_put_load);
1526   if ( (NULL != (cp = prq.sender)) &&
1527        (GNUNET_NO == prq.request_found) &&
1528        ( (GNUNET_YES != active_to_migration) ||
1529          (putl > 2.5 * (1 + prq.priority)) ) ) 
1530     {
1531       if (GNUNET_YES != active_to_migration) 
1532         putl = 1.0 + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 5);
1533       block_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1534                                                   5000 + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1535                                                                                    (unsigned int) (60000 * putl * putl)));
1536       GSF_block_peer_migration_ (cp, block_time);
1537     }  
1538   return GNUNET_OK;
1539 }
1540
1541
1542 /**
1543  * Setup the subsystem.
1544  */
1545 void
1546 GSF_pending_request_init_ ()
1547 {
1548   if (GNUNET_OK !=
1549       GNUNET_CONFIGURATION_get_value_number (GSF_cfg,
1550                                              "fs",
1551                                              "MAX_PENDING_REQUESTS",
1552                                              &max_pending_requests))
1553     {
1554       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1555                   _("Configuration fails to specify `%s', assuming default value."),
1556                   "MAX_PENDING_REQUESTS");
1557     }
1558   active_to_migration = GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
1559                                                               "FS",
1560                                                               "CONTENT_CACHING");
1561   datastore_put_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
1562   pr_map = GNUNET_CONTAINER_multihashmap_create (32 * 1024);
1563   requests_by_expiration_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN); 
1564 }
1565
1566
1567 /**
1568  * Shutdown the subsystem.
1569  */
1570 void
1571 GSF_pending_request_done_ ()
1572 {
1573   GNUNET_CONTAINER_multihashmap_iterate (pr_map,
1574                                          &clean_request,
1575                                          NULL);
1576   GNUNET_CONTAINER_multihashmap_destroy (pr_map);
1577   pr_map = NULL;
1578   GNUNET_CONTAINER_heap_destroy (requests_by_expiration_heap);
1579   requests_by_expiration_heap = NULL;
1580   GNUNET_LOAD_value_free (datastore_put_load);
1581   datastore_put_load = NULL;
1582 }
1583
1584
1585 /* end of gnunet-service-fs_pr.c */