3bc2d33306bfba196fb57f770d2d71ed83fd994a
[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   GNUNET_assert ( (sender_pid != 0) ||
332                   (0 == (options & GSF_PRO_FORWARD_ONLY)) );
333   if (ttl >= 0)
334     pr->public_data.ttl = GNUNET_TIME_relative_to_absolute (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
335                                                                                            (uint32_t) ttl));
336   else
337     pr->public_data.ttl = GNUNET_TIME_absolute_subtract (pr->public_data.start_time,
338                                                          GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
339                                                                                         (uint32_t) (- ttl)));
340   if (replies_seen_count > 0)
341     {
342       pr->replies_seen_size = replies_seen_count;
343       pr->replies_seen = GNUNET_malloc (sizeof (GNUNET_HashCode) * pr->replies_seen_size);
344       memcpy (pr->replies_seen,
345               replies_seen,
346               replies_seen_count * sizeof (GNUNET_HashCode));
347       pr->replies_seen_count = replies_seen_count;
348     }
349   if (NULL != bf_data)    
350     {
351       pr->bf = GNUNET_CONTAINER_bloomfilter_init (bf_data,
352                                                   bf_size,
353                                                   BLOOMFILTER_K);
354       pr->mingle = mingle;
355     }
356   else if ( (replies_seen_count > 0) &&
357             (0 != (options & GSF_PRO_BLOOMFILTER_FULL_REFRESH)) )
358     {
359       GNUNET_assert (GNUNET_YES == refresh_bloomfilter (pr));
360     }
361   GNUNET_CONTAINER_multihashmap_put (pr_map,
362                                      query,
363                                      pr,
364                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
365   if (0 != (options & GSF_PRO_REQUEST_EXPIRES))
366     {
367       pr->hnode = GNUNET_CONTAINER_heap_insert (requests_by_expiration_heap,
368                                                 pr,
369                                                 pr->public_data.ttl.abs_value);
370       /* make sure we don't track too many requests */
371       while (GNUNET_CONTAINER_heap_get_size (requests_by_expiration_heap) > max_pending_requests)
372         {
373           dpr = GNUNET_CONTAINER_heap_peek (requests_by_expiration_heap);
374           GNUNET_assert (dpr != NULL);
375           if (pr == dpr)
376             break; /* let the request live briefly... */
377           dpr->rh (dpr->rh_cls,
378                    GNUNET_BLOCK_EVALUATION_REQUEST_VALID,
379                    dpr,
380                    UINT32_MAX,
381                    GNUNET_TIME_UNIT_FOREVER_ABS,
382                    GNUNET_BLOCK_TYPE_ANY,
383                    NULL, 0);
384           GSF_pending_request_cancel_ (dpr);
385         }
386     }
387   GNUNET_STATISTICS_update (GSF_stats,
388                             gettext_noop ("# Pending requests active"),
389                             1,
390                             GNUNET_NO);
391   return pr;
392 }
393
394
395 /**
396  * Obtain the public data associated with a pending request
397  * 
398  * @param pr pending request
399  * @return associated public data
400  */
401 struct GSF_PendingRequestData *
402 GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr)
403 {
404   return &pr->public_data;
405 }
406
407
408 /**
409  * Update a given pending request with additional replies
410  * that have been seen.
411  *
412  * @param pr request to update
413  * @param replies_seen hash codes of replies that we've seen
414  * @param replies_seen_count size of the replies_seen array
415  */
416 void
417 GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
418                              const GNUNET_HashCode *replies_seen,
419                              unsigned int replies_seen_count)
420 {
421   unsigned int i;
422   GNUNET_HashCode mhash;
423
424   if (replies_seen_count + pr->replies_seen_count < pr->replies_seen_count)
425     return; /* integer overflow */
426   if (0 != (pr->public_data.options & GSF_PRO_BLOOMFILTER_FULL_REFRESH))
427     {
428       /* we're responsible for the BF, full refresh */
429       if (replies_seen_count + pr->replies_seen_count > pr->replies_seen_size)
430         GNUNET_array_grow (pr->replies_seen,
431                            pr->replies_seen_size,
432                            replies_seen_count + pr->replies_seen_count);
433       memcpy (&pr->replies_seen[pr->replies_seen_count],
434               replies_seen,
435               sizeof (GNUNET_HashCode) * replies_seen_count);
436       pr->replies_seen_count += replies_seen_count;
437       if (GNUNET_NO == refresh_bloomfilter (pr))
438         {
439           /* bf not recalculated, simply extend it with new bits */
440           for (i=0;i<replies_seen_count;i++)
441             {
442               GNUNET_BLOCK_mingle_hash (&replies_seen[i],
443                                         pr->mingle,
444                                         &mhash);
445               GNUNET_CONTAINER_bloomfilter_add (pr->bf, &mhash);
446             }
447         }
448     }
449   else
450     {
451       if (NULL == pr->bf)
452         {
453           /* we're not the initiator, but the initiator did not give us
454              any bloom-filter, so we need to create one on-the-fly */
455           pr->mingle = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 
456                                                  UINT32_MAX);
457           pr->bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
458                                                       compute_bloomfilter_size (replies_seen_count),
459                                                       BLOOMFILTER_K);
460         }
461       for (i=0;i<pr->replies_seen_count;i++)
462         {
463           GNUNET_BLOCK_mingle_hash (&replies_seen[i],
464                                     pr->mingle,
465                                     &mhash);
466           GNUNET_CONTAINER_bloomfilter_add (pr->bf, &mhash);
467         }
468     }
469 }
470
471
472 /**
473  * Generate the message corresponding to the given pending request for
474  * transmission to other peers (or at least determine its size).
475  *
476  * @param pr request to generate the message for
477  * @param buf_size number of bytes available in buf
478  * @param buf where to copy the message (can be NULL)
479  * @return number of bytes needed (if > buf_size) or used
480  */
481 size_t
482 GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
483                                   size_t buf_size,
484                                   void *buf)
485 {
486   char lbuf[GNUNET_SERVER_MAX_MESSAGE_SIZE];
487   struct GetMessage *gm;
488   GNUNET_HashCode *ext;
489   size_t msize;
490   unsigned int k;
491   uint32_t bm;
492   uint32_t prio;
493   size_t bf_size;
494   struct GNUNET_TIME_Absolute now;
495   int64_t ttl;
496   int do_route;
497
498 #if DEBUG_FS
499   if (buf_size > 0)
500     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
501                 "Building request message for `%s' of type %d\n",
502                 GNUNET_h2s (&pr->public_data.query),
503                 pr->public_data.type);
504 #endif 
505   k = 0;
506   bm = 0;
507   do_route = (0 == (pr->public_data.options & GSF_PRO_FORWARD_ONLY));
508   if ( (! do_route) && (pr->sender_pid == 0))
509     {
510       GNUNET_break (0);
511       do_route = GNUNET_YES;
512     }
513   if (! do_route)
514     {
515       bm |= GET_MESSAGE_BIT_RETURN_TO;
516       k++;      
517     }
518   if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
519     {
520       bm |= GET_MESSAGE_BIT_SKS_NAMESPACE;
521       k++;
522     }
523   if (GNUNET_YES == pr->public_data.has_target)
524     {
525       bm |= GET_MESSAGE_BIT_TRANSMIT_TO;
526       k++;
527     }
528   bf_size = GNUNET_CONTAINER_bloomfilter_get_size (pr->bf);
529   msize = sizeof (struct GetMessage) + bf_size + k * sizeof(GNUNET_HashCode);
530   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
531   if (buf_size < msize)
532     return msize;  
533   gm = (struct GetMessage*) lbuf;
534   gm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_GET);
535   gm->header.size = htons (msize);
536   gm->type = htonl (pr->public_data.type);
537   if (do_route)
538     prio = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
539                                      pr->public_data.priority + 1);
540   else
541     prio = 0;
542   pr->public_data.priority -= prio;
543   gm->priority = htonl (prio);
544   now = GNUNET_TIME_absolute_get ();
545   ttl = (int64_t) (pr->public_data.ttl.abs_value - now.abs_value);
546   gm->ttl = htonl (ttl / 1000);
547   gm->filter_mutator = htonl(pr->mingle); 
548   gm->hash_bitmap = htonl (bm);
549   gm->query = pr->public_data.query;
550   ext = (GNUNET_HashCode*) &gm[1];
551   k = 0;  
552   if (! do_route)
553     GNUNET_PEER_resolve (pr->sender_pid, 
554                          (struct GNUNET_PeerIdentity*) &ext[k++]);
555   if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
556     memcpy (&ext[k++], 
557             &pr->public_data.namespace, 
558             sizeof (GNUNET_HashCode));
559   if (GNUNET_YES == pr->public_data.has_target)
560     ext[k++] = pr->public_data.target.hashPubKey;
561   if (pr->bf != NULL)
562     GNUNET_assert (GNUNET_SYSERR !=
563                    GNUNET_CONTAINER_bloomfilter_get_raw_data (pr->bf,
564                                                               (char*) &ext[k],
565                                                               bf_size));
566   memcpy (buf, gm, msize);
567   return msize;
568 }
569
570
571 /**
572  * Iterator to free pending requests.
573  *
574  * @param cls closure, unused
575  * @param key current key code
576  * @param value value in the hash map (pending request)
577  * @return GNUNET_YES (we should continue to iterate)
578  */
579 static int 
580 clean_request (void *cls,
581                const GNUNET_HashCode * key,
582                void *value)
583 {
584   struct GSF_PendingRequest *pr = value;
585   GSF_LocalLookupContinuation cont;
586
587 #if DEBUG_FS
588   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
589               "Cleaning up pending request for `%s'.\n",
590               GNUNET_h2s (key));
591 #endif  
592   if (NULL != (cont = pr->llc_cont))
593     {
594       pr->llc_cont = NULL;
595       cont (pr->llc_cont_cls,
596             pr,
597             pr->local_result);
598     } 
599   GSF_plan_notify_request_done_ (pr);
600   GNUNET_free_non_null (pr->replies_seen);
601   if (NULL != pr->bf)
602     {
603       GNUNET_CONTAINER_bloomfilter_free (pr->bf);
604       pr->bf = NULL;
605     }
606   GNUNET_PEER_change_rc (pr->sender_pid, -1);
607   if (NULL != pr->hnode)
608     {
609       GNUNET_CONTAINER_heap_remove_node (pr->hnode);
610       pr->hnode = NULL;
611     }
612   if (NULL != pr->qe)
613     {
614       GNUNET_DATASTORE_cancel (pr->qe);
615       pr->qe = NULL;
616     }
617   if (NULL != pr->gh)
618     {
619       GNUNET_DHT_get_stop (pr->gh);
620       pr->gh = NULL;
621     }
622   if (GNUNET_SCHEDULER_NO_TASK != pr->warn_task)
623     {
624       GNUNET_SCHEDULER_cancel (pr->warn_task);
625       pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
626     }
627   GNUNET_assert (GNUNET_OK ==
628                  GNUNET_CONTAINER_multihashmap_remove (pr_map,
629                                                        &pr->public_data.query,
630                                                        pr));
631   GNUNET_STATISTICS_update (GSF_stats,
632                             gettext_noop ("# Pending requests active"),
633                             -1,
634                             GNUNET_NO);
635   GNUNET_free (pr);
636   return GNUNET_YES;
637 }
638
639
640 /**
641  * Explicitly cancel a pending request.
642  *
643  * @param pr request to cancel
644  */
645 void
646 GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr)
647 {
648   if (NULL == pr_map) 
649     return; /* already cleaned up! */
650   GNUNET_assert (GNUNET_YES ==
651                  clean_request (NULL, &pr->public_data.query, pr));  
652 }
653
654
655 /**
656  * Iterate over all pending requests.
657  *
658  * @param it function to call for each request
659  * @param cls closure for it
660  */
661 void
662 GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
663                                void *cls)
664 {
665   GNUNET_CONTAINER_multihashmap_iterate (pr_map,
666                                          (GNUNET_CONTAINER_HashMapIterator) it,
667                                          cls);
668 }
669
670
671
672
673 /**
674  * Closure for "process_reply" function.
675  */
676 struct ProcessReplyClosure
677 {
678   /**
679    * The data for the reply.
680    */
681   const void *data;
682
683   /**
684    * Who gave us this reply? NULL for local host (or DHT)
685    */
686   struct GSF_ConnectedPeer *sender;
687
688   /**
689    * When the reply expires.
690    */
691   struct GNUNET_TIME_Absolute expiration;
692
693   /**
694    * Size of data.
695    */
696   size_t size;
697
698   /**
699    * Type of the block.
700    */
701   enum GNUNET_BLOCK_Type type;
702
703   /**
704    * How much was this reply worth to us?
705    */
706   uint32_t priority;
707
708   /**
709    * Anonymity requirements for this reply.
710    */
711   uint32_t anonymity_level;
712
713   /**
714    * Evaluation result (returned).
715    */
716   enum GNUNET_BLOCK_EvaluationResult eval;
717
718   /**
719    * Did we find a matching request?
720    */
721   int request_found;
722 };
723
724
725 /**
726  * Update the performance data for the sender (if any) since
727  * the sender successfully answered one of our queries.
728  *
729  * @param prq information about the sender
730  * @param pr request that was satisfied
731  */
732 static void
733 update_request_performance_data (struct ProcessReplyClosure *prq,
734                                  struct GSF_PendingRequest *pr)
735 {
736   if (prq->sender == NULL)
737     return;      
738   GSF_peer_update_performance_ (prq->sender,
739                                 pr->public_data.start_time,
740                                 prq->priority);
741 }
742                                 
743
744 /**
745  * We have received a reply; handle it!
746  *
747  * @param cls response (struct ProcessReplyClosure)
748  * @param key our query
749  * @param value value in the hash map (info about the query)
750  * @return GNUNET_YES (we should continue to iterate)
751  */
752 static int
753 process_reply (void *cls,
754                const GNUNET_HashCode *key,
755                void *value)
756 {
757   struct ProcessReplyClosure *prq = cls;
758   struct GSF_PendingRequest *pr = value;
759   GNUNET_HashCode chash;
760
761 #if DEBUG_FS
762   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
763               "Matched result (type %u) for query `%s' with pending request\n",
764               (unsigned int) prq->type,
765               GNUNET_h2s (key));
766 #endif  
767   GNUNET_STATISTICS_update (GSF_stats,
768                             gettext_noop ("# replies received and matched"),
769                             1,
770                             GNUNET_NO);
771   prq->eval = GNUNET_BLOCK_evaluate (GSF_block_ctx,
772                                      prq->type,
773                                      key,
774                                      &pr->bf,
775                                      pr->mingle,
776                                      &pr->public_data.namespace, 
777                                      (prq->type == GNUNET_BLOCK_TYPE_FS_SBLOCK) ? sizeof (GNUNET_HashCode) : 0,
778                                      prq->data,
779                                      prq->size);
780   switch (prq->eval)
781     {
782     case GNUNET_BLOCK_EVALUATION_OK_MORE:
783       update_request_performance_data (prq, pr);
784       break;
785     case GNUNET_BLOCK_EVALUATION_OK_LAST:
786       /* short cut: stop processing early, no BF-update, etc. */
787       update_request_performance_data (prq, pr);
788       GNUNET_LOAD_update (GSF_rt_entry_lifetime,
789                           GNUNET_TIME_absolute_get_duration (pr->public_data.start_time).rel_value);
790       /* pass on to other peers / local clients */
791       pr->rh (pr->rh_cls,             
792               prq->eval,
793               pr,
794               prq->anonymity_level,
795               prq->expiration,
796               prq->type,
797               prq->data, prq->size);
798       return GNUNET_YES;
799     case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
800       GNUNET_STATISTICS_update (GSF_stats,
801                                 gettext_noop ("# duplicate replies discarded (bloomfilter)"),
802                                 1,
803                                 GNUNET_NO);
804 #if DEBUG_FS && 0
805       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
806                   "Duplicate response `%s', discarding.\n",
807                   GNUNET_h2s (&mhash));
808 #endif
809       return GNUNET_YES; /* duplicate */
810     case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
811       return GNUNET_YES; /* wrong namespace */  
812     case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
813       GNUNET_break (0);
814       return GNUNET_YES;
815     case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
816       GNUNET_break (0);
817       return GNUNET_YES;
818     case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
819       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
820                   _("Unsupported block type %u\n"),
821                   prq->type);
822       return GNUNET_NO;
823     }
824   /* update bloomfilter */
825   GNUNET_CRYPTO_hash (prq->data,
826                       prq->size,
827                       &chash);
828   GSF_pending_request_update_ (pr, &chash, 1);
829   if (NULL == prq->sender)
830     {
831 #if DEBUG_FS
832       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
833                   "Found result for query `%s' in local datastore\n",
834                   GNUNET_h2s (key));
835 #endif
836       GNUNET_STATISTICS_update (GSF_stats,
837                                 gettext_noop ("# results found locally"),
838                                 1,
839                                 GNUNET_NO);      
840     }
841   else
842     {     
843       GSF_dht_lookup_ (pr);
844     }
845   prq->priority += pr->public_data.original_priority;
846   pr->public_data.priority = 0;
847   pr->public_data.original_priority = 0;
848   pr->public_data.results_found++;
849   prq->request_found = GNUNET_YES;
850   /* finally, pass on to other peer / local client */
851   pr->rh (pr->rh_cls,
852           prq->eval,
853           pr, 
854           prq->anonymity_level,
855           prq->expiration,
856           prq->type,
857           prq->data, prq->size);
858   return GNUNET_YES;
859 }
860
861
862 /**
863  * Context for the 'put_migration_continuation'.
864  */
865 struct PutMigrationContext
866 {
867
868   /**
869    * Start time for the operation.
870    */
871   struct GNUNET_TIME_Absolute start;
872
873   /**
874    * Request origin.
875    */
876   struct GNUNET_PeerIdentity origin;
877
878   /**
879    * GNUNET_YES if we had a matching request for this block,
880    * GNUNET_NO if not.
881    */
882   int requested;
883 };
884
885
886 /**
887  * Continuation called to notify client about result of the
888  * operation.
889  *
890  * @param cls closure
891  * @param success GNUNET_SYSERR on failure
892  * @param msg NULL on success, otherwise an error message
893  */
894 static void 
895 put_migration_continuation (void *cls,
896                             int success,
897                             const char *msg)
898 {
899   struct PutMigrationContext *pmc = cls;
900   struct GNUNET_TIME_Relative delay;
901   struct GNUNET_TIME_Relative block_time;  
902   struct GSF_ConnectedPeer *cp;
903   struct GSF_PeerPerformanceData *ppd;
904                          
905   delay = GNUNET_TIME_absolute_get_duration (pmc->start);
906   cp = GSF_peer_get_ (&pmc->origin);
907   if ( (GNUNET_OK != success) &&
908        (GNUNET_NO == pmc->requested) )
909     {
910       /* block migration for a bit... */
911       if (NULL != cp)
912         {
913           ppd = GSF_get_peer_performance_data_ (cp);
914           ppd->migration_duplication++;
915           block_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
916                                                       5 * ppd->migration_duplication + 
917                                                       GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 5));
918           GSF_block_peer_migration_ (cp, block_time);
919         }
920     }
921   else
922     {
923       if (NULL != cp)
924         {
925           ppd = GSF_get_peer_performance_data_ (cp);
926           ppd->migration_duplication = 0; /* reset counter */
927         }
928     }
929   GNUNET_free (pmc);
930   /* FIXME: should we really update the load value on failure? */
931   GNUNET_LOAD_update (datastore_put_load,
932                       delay.rel_value);
933   if (GNUNET_OK == success)
934     return;
935   GNUNET_STATISTICS_update (GSF_stats,
936                             gettext_noop ("# Datastore `PUT' failures"),
937                             1,
938                             GNUNET_NO);
939 }
940
941
942 /**
943  * Test if the DATABASE (PUT) load on this peer is too high
944  * to even consider processing the query at
945  * all.  
946  * 
947  * @return GNUNET_YES if the load is too high to do anything (load high)
948  *         GNUNET_NO to process normally (load normal or low)
949  */
950 static int
951 test_put_load_too_high (uint32_t priority)
952 {
953   double ld;
954
955   if (GNUNET_LOAD_get_average (datastore_put_load) < 50)
956     return GNUNET_NO; /* very fast */
957   ld = GNUNET_LOAD_get_load (datastore_put_load);
958   if (ld < 2.0 * (1 + priority))
959     return GNUNET_NO;
960   GNUNET_STATISTICS_update (GSF_stats,
961                             gettext_noop ("# storage requests dropped due to high load"),
962                             1,
963                             GNUNET_NO);
964   return GNUNET_YES;
965 }
966
967
968 /**
969  * Iterator called on each result obtained for a DHT
970  * operation that expects a reply
971  *
972  * @param cls closure
973  * @param exp when will this value expire
974  * @param key key of the result
975  * @param get_path NULL-terminated array of pointers
976  *                 to the peers on reverse GET path (or NULL if not recorded)
977  * @param put_path NULL-terminated array of pointers
978  *                 to the peers on the PUT path (or NULL if not recorded)
979  * @param type type of the result
980  * @param size number of bytes in data
981  * @param data pointer to the result data
982  */
983 static void
984 handle_dht_reply (void *cls,
985                   struct GNUNET_TIME_Absolute exp,
986                   const GNUNET_HashCode *key,
987                   const struct GNUNET_PeerIdentity * const *get_path,
988                   const struct GNUNET_PeerIdentity * const *put_path,
989                   enum GNUNET_BLOCK_Type type,
990                   size_t size,
991                   const void *data)
992 {
993   struct GSF_PendingRequest *pr = cls;
994   struct ProcessReplyClosure prq;
995   struct PutMigrationContext *pmc;
996
997   GNUNET_STATISTICS_update (GSF_stats,
998                             gettext_noop ("# Replies received from DHT"),
999                             1,
1000                             GNUNET_NO);
1001   memset (&prq, 0, sizeof (prq));
1002   prq.data = data;
1003   prq.expiration = exp;
1004   prq.size = size;  
1005   prq.type = type;
1006   process_reply (&prq, key, pr);
1007   if ( (GNUNET_YES == active_to_migration) &&
1008        (GNUNET_NO == test_put_load_too_high (prq.priority)) )
1009     {      
1010 #if DEBUG_FS
1011       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1012                   "Replicating result for query `%s' with priority %u\n",
1013                   GNUNET_h2s (key),
1014                   prq.priority);
1015 #endif
1016       pmc = GNUNET_malloc (sizeof (struct PutMigrationContext));
1017       pmc->start = GNUNET_TIME_absolute_get ();
1018       pmc->requested = GNUNET_YES;
1019       if (NULL == 
1020           GNUNET_DATASTORE_put (GSF_dsh,
1021                                 0, key, size, data,
1022                                 type, prq.priority, 1 /* anonymity */, 
1023                                 0 /* replication */,
1024                                 exp, 
1025                                 1 + prq.priority, MAX_DATASTORE_QUEUE,
1026                                 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1027                                 &put_migration_continuation, 
1028                                 pmc))
1029         {
1030           put_migration_continuation (pmc, GNUNET_NO, NULL);    
1031         }
1032     }
1033 }
1034
1035
1036 /**
1037  * Consider looking up the data in the DHT (anonymity-level permitting).
1038  *
1039  * @param pr the pending request to process
1040  */
1041 void
1042 GSF_dht_lookup_ (struct GSF_PendingRequest *pr)
1043 {
1044   const void *xquery;
1045   size_t xquery_size;
1046   struct GNUNET_PeerIdentity pi;
1047   char buf[sizeof (GNUNET_HashCode) * 2];
1048
1049   if (0 != pr->public_data.anonymity_level)
1050     return;
1051   if (NULL != pr->gh)
1052     {
1053       GNUNET_DHT_get_stop (pr->gh);
1054       pr->gh = NULL;
1055     }
1056   xquery = NULL;
1057   xquery_size = 0;
1058   if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
1059     {
1060       xquery = buf;
1061       memcpy (buf, &pr->public_data.namespace, sizeof (GNUNET_HashCode));
1062       xquery_size = sizeof (GNUNET_HashCode);
1063     }
1064   if (0 != (pr->public_data.options & GSF_PRO_FORWARD_ONLY))
1065     {
1066       GNUNET_assert (0 != pr->sender_pid);
1067       GNUNET_PEER_resolve (pr->sender_pid,
1068                            &pi);
1069       memcpy (&buf[xquery_size], &pi, sizeof (struct GNUNET_PeerIdentity));
1070       xquery_size += sizeof (struct GNUNET_PeerIdentity);
1071     }
1072   pr->gh = GNUNET_DHT_get_start (GSF_dht,
1073                                  GNUNET_TIME_UNIT_FOREVER_REL,
1074                                  pr->public_data.type,
1075                                  &pr->public_data.query,
1076                                  DEFAULT_GET_REPLICATION,
1077                                  GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
1078                                  pr->bf,
1079                                  pr->mingle,
1080                                  xquery,
1081                                  xquery_size,
1082                                  &handle_dht_reply,
1083                                  pr);
1084 }
1085
1086
1087 /**
1088  * Task that issues a warning if the datastore lookup takes too long.
1089  * 
1090  * @param cls the 'struct GSF_PendingRequest'
1091  * @param tc task context
1092  */
1093 static void
1094 warn_delay_task (void *cls,
1095                  const struct GNUNET_SCHEDULER_TaskContext *tc)
1096 {
1097   struct GSF_PendingRequest *pr = cls;
1098
1099   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1100               _("Datastore lookup already took %llu ms!\n"),
1101               (unsigned long long) GNUNET_TIME_absolute_get_duration (pr->qe_start).rel_value);
1102   pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1103                                                 &warn_delay_task,
1104                                                 pr);
1105 }
1106
1107
1108 /**
1109  * Task that issues a warning if the datastore lookup takes too long.
1110  * 
1111  * @param cls the 'struct GSF_PendingRequest'
1112  * @param tc task context
1113  */
1114 static void
1115 odc_warn_delay_task (void *cls,
1116                      const struct GNUNET_SCHEDULER_TaskContext *tc)
1117 {
1118   struct GSF_PendingRequest *pr = cls;
1119
1120   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1121               _("On-demand lookup already took %llu ms!\n"),
1122               (unsigned long long) GNUNET_TIME_absolute_get_duration (pr->qe_start).rel_value);
1123   pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1124                                                 &odc_warn_delay_task,
1125                                                 pr);
1126 }
1127
1128
1129 /**
1130  * We're processing (local) results for a search request
1131  * from another peer.  Pass applicable results to the
1132  * peer and if we are done either clean up (operation
1133  * complete) or forward to other peers (more results possible).
1134  *
1135  * @param cls our closure (struct PendingRequest)
1136  * @param key key for the content
1137  * @param size number of bytes in data
1138  * @param data content stored
1139  * @param type type of the content
1140  * @param priority priority of the content
1141  * @param anonymity anonymity-level for the content
1142  * @param expiration expiration time for the content
1143  * @param uid unique identifier for the datum;
1144  *        maybe 0 if no unique identifier is available
1145  */
1146 static void
1147 process_local_reply (void *cls,
1148                      const GNUNET_HashCode *key,
1149                      size_t size,
1150                      const void *data,
1151                      enum GNUNET_BLOCK_Type type,
1152                      uint32_t priority,
1153                      uint32_t anonymity,
1154                      struct GNUNET_TIME_Absolute expiration, 
1155                      uint64_t uid)
1156 {
1157   struct GSF_PendingRequest *pr = cls;
1158   GSF_LocalLookupContinuation cont;
1159   struct ProcessReplyClosure prq;
1160   GNUNET_HashCode query;
1161   unsigned int old_rf;
1162
1163   GNUNET_SCHEDULER_cancel (pr->warn_task);
1164   pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1165   if (NULL != pr->qe)
1166     {
1167       pr->qe = NULL;
1168       if (NULL == key)
1169         {
1170           GNUNET_STATISTICS_update (GSF_stats,
1171                                     gettext_noop ("# Datastore lookups concluded (no results)"),
1172                                     1,
1173                                     GNUNET_NO);
1174         }
1175       if (GNUNET_NO == pr->have_first_uid)
1176         {
1177           pr->first_uid = uid;
1178           pr->have_first_uid = 1;
1179         }
1180       else
1181         {
1182           if ( (uid == pr->first_uid) && (key != NULL) )
1183             {
1184               GNUNET_STATISTICS_update (GSF_stats,
1185                                         gettext_noop ("# Datastore lookups concluded (seen all)"),
1186                                         1,
1187                                         GNUNET_NO);
1188               key = NULL; /* all replies seen! */
1189             }
1190           pr->have_first_uid++;
1191           if ( (pr->have_first_uid > MAX_RESULTS) && (key != NULL) )
1192             {
1193               GNUNET_STATISTICS_update (GSF_stats,
1194                                         gettext_noop ("# Datastore lookups aborted (more than MAX_RESULTS)"),
1195                                         1,
1196                                         GNUNET_NO);
1197               key = NULL; /* all replies seen! */
1198             }
1199         }
1200     }
1201   if (NULL == key)
1202     {
1203 #if DEBUG_FS > 1
1204       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1205                   "No further local responses available.\n");
1206 #endif
1207       if ( (pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK) ||
1208            (pr->public_data.type == GNUNET_BLOCK_TYPE_FS_IBLOCK) )
1209         GNUNET_STATISTICS_update (GSF_stats,
1210                                   gettext_noop ("# requested DBLOCK or IBLOCK not found"),
1211                                   1,
1212                                   GNUNET_NO);
1213       goto check_error_and_continue;
1214     }
1215 #if DEBUG_FS
1216   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1217               "Received reply for `%s' of type %d with UID %llu from datastore.\n",
1218               GNUNET_h2s (key),
1219               type,
1220               (unsigned long long) uid);
1221 #endif
1222   if (type == GNUNET_BLOCK_TYPE_FS_ONDEMAND)
1223     {
1224 #if DEBUG_FS > 1
1225       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1226                   "Found ONDEMAND block, performing on-demand encoding\n");
1227 #endif
1228       GNUNET_STATISTICS_update (GSF_stats,
1229                                 gettext_noop ("# on-demand blocks matched requests"),
1230                                 1,
1231                                 GNUNET_NO);
1232       pr->qe_start = GNUNET_TIME_absolute_get ();
1233       pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1234                                                     &odc_warn_delay_task,
1235                                                     pr);
1236       if (GNUNET_OK == 
1237           GNUNET_FS_handle_on_demand_block (key, size, data, type, priority, 
1238                                             anonymity, expiration, uid, 
1239                                             &process_local_reply,
1240                                             pr))
1241         {
1242           GNUNET_STATISTICS_update (GSF_stats,
1243                                     gettext_noop ("# on-demand lookups performed successfully"),
1244                                     1,
1245                                     GNUNET_NO);
1246           return; /* we're done */
1247         }
1248       GNUNET_STATISTICS_update (GSF_stats,
1249                                 gettext_noop ("# on-demand lookups failed"),
1250                                 1,
1251                                 GNUNET_NO);
1252       GNUNET_SCHEDULER_cancel (pr->warn_task);
1253       pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1254                                                     &warn_delay_task,
1255                                                     pr);        
1256       pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1257                                          pr->local_result_offset - 1,
1258                                          &pr->public_data.query,
1259                                          pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK 
1260                                          ? GNUNET_BLOCK_TYPE_ANY 
1261                                          : pr->public_data.type, 
1262                                          (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1263                                          ? UINT_MAX
1264                                          : 1 /* queue priority */,
1265                                          (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1266                                          ? UINT_MAX
1267                                          : 1 /* max queue size */,
1268                                          GNUNET_TIME_UNIT_FOREVER_REL,
1269                                          &process_local_reply,
1270                                          pr);
1271       if (NULL != pr->qe)
1272         {
1273           GNUNET_STATISTICS_update (GSF_stats,
1274                                     gettext_noop ("# Datastore lookups concluded (error queueing)"),
1275                                     1,
1276                                     GNUNET_NO);
1277           return; /* we're done */      
1278         }
1279       goto check_error_and_continue;
1280     }
1281   old_rf = pr->public_data.results_found;
1282   memset (&prq, 0, sizeof (prq));
1283   prq.data = data;
1284   prq.expiration = expiration;
1285   prq.size = size;  
1286   if (GNUNET_OK != 
1287       GNUNET_BLOCK_get_key (GSF_block_ctx,
1288                             type,
1289                             data,
1290                             size,
1291                             &query))
1292     {
1293       GNUNET_break (0);
1294       GNUNET_DATASTORE_remove (GSF_dsh,
1295                                key,
1296                                size, data,
1297                                -1, -1, 
1298                                GNUNET_TIME_UNIT_FOREVER_REL,
1299                                NULL, NULL);
1300       pr->qe_start = GNUNET_TIME_absolute_get ();
1301       pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1302                                                     &warn_delay_task,
1303                                                     pr);
1304       pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1305                                          pr->local_result_offset - 1,
1306                                          &pr->public_data.query,
1307                                          pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK 
1308                                          ? GNUNET_BLOCK_TYPE_ANY 
1309                                          : pr->public_data.type, 
1310                                          (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1311                                          ? UINT_MAX
1312                                          : 1 /* queue priority */,
1313                                          (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1314                                          ? UINT_MAX
1315                                          : 1 /* max queue size */,
1316                                          GNUNET_TIME_UNIT_FOREVER_REL,
1317                                          &process_local_reply,
1318                                          pr);
1319       if (pr->qe == NULL)       
1320         {
1321           GNUNET_STATISTICS_update (GSF_stats,
1322                                     gettext_noop ("# Datastore lookups concluded (error queueing)"),
1323                                     1,
1324                                     GNUNET_NO);
1325           goto check_error_and_continue;        
1326         }
1327       return;
1328     }
1329   prq.type = type;
1330   prq.priority = priority;  
1331   prq.request_found = GNUNET_NO;
1332   prq.anonymity_level = anonymity;
1333   if ( (old_rf == 0) &&
1334        (pr->public_data.results_found == 0) )
1335     GSF_update_datastore_delay_ (pr->public_data.start_time);
1336   process_reply (&prq, key, pr);
1337   pr->local_result = prq.eval;
1338   if (prq.eval == GNUNET_BLOCK_EVALUATION_OK_LAST)
1339     {
1340       GNUNET_STATISTICS_update (GSF_stats,
1341                                 gettext_noop ("# Datastore lookups concluded (found ultimate result)"),
1342                                 1,
1343                                 GNUNET_NO);
1344       goto check_error_and_continue;
1345     }
1346   if ( (0 == (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options)) &&
1347        ( (GNUNET_YES == GSF_test_get_load_too_high_ (0)) ||
1348          (pr->public_data.results_found > 5 + 2 * pr->public_data.priority) ) )
1349     {
1350 #if DEBUG_FS > 2
1351       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1352                   "Load too high, done with request\n");
1353 #endif
1354       GNUNET_STATISTICS_update (GSF_stats,
1355                                 gettext_noop ("# Datastore lookups concluded (load too high)"),
1356                                 1,
1357                                 GNUNET_NO);
1358       goto check_error_and_continue;
1359     }
1360   pr->qe_start = GNUNET_TIME_absolute_get ();
1361   pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1362                                                 &warn_delay_task,
1363                                                 pr);
1364   pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1365                                      pr->local_result_offset++,
1366                                      &pr->public_data.query,
1367                                      pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK 
1368                                      ? GNUNET_BLOCK_TYPE_ANY 
1369                                      : pr->public_data.type, 
1370                                      (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1371                                      ? UINT_MAX
1372                                      : 1 /* queue priority */,
1373                                      (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1374                                      ? UINT_MAX
1375                                      : 1 /* max queue size */,
1376                                      GNUNET_TIME_UNIT_FOREVER_REL,
1377                                      &process_local_reply,
1378                                      pr);
1379   /* check if we successfully queued another datastore request;
1380      if so, return, otherwise call our continuation (if we have
1381      any) */
1382  check_error_and_continue:
1383   if (NULL != pr->qe)
1384     return;
1385   if (GNUNET_SCHEDULER_NO_TASK != pr->warn_task)
1386     {
1387       GNUNET_SCHEDULER_cancel (pr->warn_task);
1388       pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1389     }
1390   if (NULL == (cont = pr->llc_cont))
1391     return; /* no continuation */      
1392   pr->llc_cont = NULL;
1393   cont (pr->llc_cont_cls,
1394         pr,
1395         pr->local_result);
1396 }
1397
1398
1399 /**
1400  * Look up the request in the local datastore.
1401  *
1402  * @param pr the pending request to process
1403  * @param cont function to call at the end
1404  * @param cont_cls closure for cont
1405  */
1406 void
1407 GSF_local_lookup_ (struct GSF_PendingRequest *pr,
1408                    GSF_LocalLookupContinuation cont,
1409                    void *cont_cls)
1410 {
1411   GNUNET_assert (NULL == pr->gh);
1412   GNUNET_assert (NULL == pr->llc_cont);
1413   pr->llc_cont = cont;
1414   pr->llc_cont_cls = cont_cls;
1415   pr->qe_start = GNUNET_TIME_absolute_get ();
1416   pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1417                                                 &warn_delay_task,
1418                                                 pr);
1419   GNUNET_STATISTICS_update (GSF_stats,
1420                             gettext_noop ("# Datastore lookups initiated"),
1421                             1,
1422                             GNUNET_NO);
1423   pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1424                                      pr->local_result_offset++,
1425                                      &pr->public_data.query,
1426                                      pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK 
1427                                      ? GNUNET_BLOCK_TYPE_ANY 
1428                                      : pr->public_data.type, 
1429                                      (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1430                                      ? UINT_MAX
1431                                      : 1 /* queue priority */,
1432                                      (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1433                                      ? UINT_MAX
1434                                      : 1 /* max queue size */,
1435                                      GNUNET_TIME_UNIT_FOREVER_REL,
1436                                      &process_local_reply,
1437                                      pr);
1438   if (NULL != pr->qe)
1439     {
1440       GNUNET_STATISTICS_update (GSF_stats,
1441                                 gettext_noop ("# Datastore lookups concluded (error queueing)"),
1442                                 1,
1443                                 GNUNET_NO);
1444       
1445       return;
1446     }
1447   GNUNET_SCHEDULER_cancel (pr->warn_task);
1448   pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1449   pr->llc_cont = NULL;
1450   if (NULL != cont)
1451     cont (cont_cls, pr, pr->local_result);      
1452 }
1453
1454
1455
1456 /**
1457  * Handle P2P "CONTENT" message.  Checks that the message is
1458  * well-formed and then checks if there are any pending requests for
1459  * this content and possibly passes it on (to local clients or other
1460  * peers).  Does NOT perform migration (content caching at this peer).
1461  *
1462  * @param cp the other peer involved (sender or receiver, NULL
1463  *        for loopback messages where we are both sender and receiver)
1464  * @param message the actual message
1465  * @return GNUNET_OK if the message was well-formed,
1466  *         GNUNET_SYSERR if the message was malformed (close connection,
1467  *         do not cache under any circumstances)
1468  */
1469 int
1470 GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
1471                          const struct GNUNET_MessageHeader *message)
1472 {
1473   const struct PutMessage *put;
1474   uint16_t msize;
1475   size_t dsize;
1476   enum GNUNET_BLOCK_Type type;
1477   struct GNUNET_TIME_Absolute expiration;
1478   GNUNET_HashCode query;
1479   struct ProcessReplyClosure prq;
1480   struct GNUNET_TIME_Relative block_time;  
1481   double putl;
1482   struct PutMigrationContext *pmc;
1483
1484   msize = ntohs (message->size);
1485   if (msize < sizeof (struct PutMessage))
1486     {
1487       GNUNET_break_op(0);
1488       return GNUNET_SYSERR;
1489     }
1490   put = (const struct PutMessage*) message;
1491   dsize = msize - sizeof (struct PutMessage);
1492   type = ntohl (put->type);
1493   expiration = GNUNET_TIME_absolute_ntoh (put->expiration);
1494   if (type == GNUNET_BLOCK_TYPE_FS_ONDEMAND)
1495     return GNUNET_SYSERR;
1496   if (GNUNET_OK !=
1497       GNUNET_BLOCK_get_key (GSF_block_ctx,
1498                             type,
1499                             &put[1],
1500                             dsize,
1501                             &query))
1502     {
1503       GNUNET_break_op (0);
1504       return GNUNET_SYSERR;
1505     }
1506   GNUNET_STATISTICS_update (GSF_stats,
1507                             gettext_noop ("# GAP PUT messages received"),
1508                             1,
1509                             GNUNET_NO);
1510   /* now, lookup 'query' */
1511   prq.data = (const void*) &put[1];
1512   if (NULL != cp)
1513     prq.sender = cp;
1514   else
1515     prq.sender = NULL;
1516   prq.size = dsize;
1517   prq.type = type;
1518   prq.expiration = expiration;
1519   prq.priority = 0;
1520   prq.anonymity_level = UINT32_MAX;
1521   prq.request_found = GNUNET_NO;
1522   GNUNET_CONTAINER_multihashmap_get_multiple (pr_map,
1523                                               &query,
1524                                               &process_reply,
1525                                               &prq);
1526   if (NULL != cp)
1527     {
1528       GSF_connected_peer_change_preference_ (cp, CONTENT_BANDWIDTH_VALUE + 1000 * prq.priority);
1529       GSF_get_peer_performance_data_ (cp)->trust += prq.priority;
1530     }
1531   if ( (GNUNET_YES == active_to_migration) &&
1532        (GNUNET_NO == test_put_load_too_high (prq.priority)) )
1533     {      
1534 #if DEBUG_FS
1535       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1536                   "Replicating result for query `%s' with priority %u\n",
1537                   GNUNET_h2s (&query),
1538                   prq.priority);
1539 #endif
1540       pmc = GNUNET_malloc (sizeof (struct PutMigrationContext));
1541       pmc->start = GNUNET_TIME_absolute_get ();
1542       pmc->requested = prq.request_found;
1543       GNUNET_assert (0 != GSF_get_peer_performance_data_ (cp)->pid);
1544       GNUNET_PEER_resolve (GSF_get_peer_performance_data_ (cp)->pid,
1545                            &pmc->origin);
1546       if (NULL ==
1547           GNUNET_DATASTORE_put (GSF_dsh,
1548                                 0, &query, dsize, &put[1],
1549                                 type, prq.priority, 1 /* anonymity */, 
1550                                 0 /* replication */,
1551                                 expiration, 
1552                                 1 + prq.priority, MAX_DATASTORE_QUEUE,
1553                                 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1554                                 &put_migration_continuation, 
1555                                 pmc))
1556         {
1557           put_migration_continuation (pmc, GNUNET_NO, NULL);      
1558         }
1559     }
1560   else
1561     {
1562 #if DEBUG_FS
1563       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1564                   "Choosing not to keep content `%s' (%d/%d)\n",
1565                   GNUNET_h2s (&query),
1566                   active_to_migration,
1567                   test_put_load_too_high (prq.priority));
1568 #endif
1569     }
1570   putl = GNUNET_LOAD_get_load (datastore_put_load);
1571   if ( (NULL != (cp = prq.sender)) &&
1572        (GNUNET_NO == prq.request_found) &&
1573        ( (GNUNET_YES != active_to_migration) ||
1574          (putl > 2.5 * (1 + prq.priority)) ) ) 
1575     {
1576       if (GNUNET_YES != active_to_migration) 
1577         putl = 1.0 + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 5);
1578       block_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1579                                                   5000 + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1580                                                                                    (unsigned int) (60000 * putl * putl)));
1581       GSF_block_peer_migration_ (cp, block_time);
1582     }  
1583   return GNUNET_OK;
1584 }
1585
1586
1587 /**
1588  * Setup the subsystem.
1589  */
1590 void
1591 GSF_pending_request_init_ ()
1592 {
1593   if (GNUNET_OK !=
1594       GNUNET_CONFIGURATION_get_value_number (GSF_cfg,
1595                                              "fs",
1596                                              "MAX_PENDING_REQUESTS",
1597                                              &max_pending_requests))
1598     {
1599       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1600                   _("Configuration fails to specify `%s', assuming default value."),
1601                   "MAX_PENDING_REQUESTS");
1602     }
1603   active_to_migration = GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
1604                                                               "FS",
1605                                                               "CONTENT_CACHING");
1606   datastore_put_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
1607   pr_map = GNUNET_CONTAINER_multihashmap_create (32 * 1024);
1608   requests_by_expiration_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN); 
1609 }
1610
1611
1612 /**
1613  * Shutdown the subsystem.
1614  */
1615 void
1616 GSF_pending_request_done_ ()
1617 {
1618   GNUNET_CONTAINER_multihashmap_iterate (pr_map,
1619                                          &clean_request,
1620                                          NULL);
1621   GNUNET_CONTAINER_multihashmap_destroy (pr_map);
1622   pr_map = NULL;
1623   GNUNET_CONTAINER_heap_destroy (requests_by_expiration_heap);
1624   requests_by_expiration_heap = NULL;
1625   GNUNET_LOAD_value_free (datastore_put_load);
1626   datastore_put_load = NULL;
1627 }
1628
1629
1630 /* end of gnunet-service-fs_pr.c */