2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file fs/gnunet-service-fs_pr.c
23 * @brief API to handle pending requests
24 * @author Christian Grothoff
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"
38 struct GSF_PendingRequest
41 * Public data for the request.
43 struct GSF_PendingRequestData public_data;
46 * Function to call if we encounter a reply.
48 GSF_PendingRequestReplyHandler rh;
56 * Array of hash codes of replies we've already seen.
58 GNUNET_HashCode *replies_seen;
61 * Bloomfilter masking replies we've already seen.
63 struct GNUNET_CONTAINER_BloomFilter *bf;
66 * Entry for this pending request in the expiration heap, or NULL.
68 struct GNUNET_CONTAINER_HeapNode *hnode;
71 * Datastore queue entry for this request (or NULL for none).
73 struct GNUNET_DATASTORE_QueueEntry *qe;
76 * DHT request handle for this request (or NULL for none).
78 struct GNUNET_DHT_GetHandle *gh;
81 * Function to call upon completion of the local get
82 * request, or NULL for none.
84 GSF_LocalLookupContinuation llc_cont;
87 * Closure for llc_cont.
92 * Last result from the local datastore lookup evaluation.
94 enum GNUNET_BLOCK_EvaluationResult local_result;
97 * Identity of the peer that we should use for the 'sender'
98 * (recipient of the response) when forwarding (0 for none).
100 GNUNET_PEER_Id sender_pid;
103 * Time we started the last datastore lookup.
105 struct GNUNET_TIME_Absolute qe_start;
108 * Task that warns us if the local datastore lookup takes too long.
110 GNUNET_SCHEDULER_TaskIdentifier warn_task;
113 * Current offset for querying our local datastore for results.
114 * Starts at a random value, incremented until we get the same
115 * UID again (detected using 'first_uid'), which is then used
116 * to termiante the iteration.
118 uint64_t local_result_offset;
121 * Unique ID of the first result from the local datastore;
122 * used to detect wrap-around of the offset.
127 * Number of valid entries in the 'replies_seen' array.
129 unsigned int replies_seen_count;
132 * Length of the 'replies_seen' array.
134 unsigned int replies_seen_size;
137 * Mingle value we currently use for the bf.
145 * All pending requests, ordered by the query. Entries
146 * are of type 'struct GSF_PendingRequest*'.
148 static struct GNUNET_CONTAINER_MultiHashMap *pr_map;
152 * Datastore 'PUT' load tracking.
154 static struct GNUNET_LOAD_Value *datastore_put_load;
158 * Are we allowed to migrate content to this peer.
160 static int active_to_migration;
164 * Heap with the request that will expire next at the top. Contains
165 * pointers of type "struct PendingRequest*"; these will *also* be
166 * aliased from the "requests_by_peer" data structures and the
167 * "requests_by_query" table. Note that requests from our clients
168 * don't expire and are thus NOT in the "requests_by_expiration"
169 * (or the "requests_by_peer" tables).
171 static struct GNUNET_CONTAINER_Heap *requests_by_expiration_heap;
175 * Maximum number of requests (from other peers, overall) that we're
176 * willing to have pending at any given point in time. Can be changed
177 * via the configuration file (32k is just the default).
179 static unsigned long long max_pending_requests = (32 * 1024);
183 * How many bytes should a bloomfilter be if we have already seen
184 * entry_count responses? Note that BLOOMFILTER_K gives us the number
185 * of bits set per entry. Furthermore, we should not re-size the
186 * filter too often (to keep it cheap).
188 * Since other peers will also add entries but not resize the filter,
189 * we should generally pick a slightly larger size than what the
190 * strict math would suggest.
192 * @return must be a power of two and smaller or equal to 2^15.
195 compute_bloomfilter_size (unsigned int entry_count)
198 unsigned int ideal = (entry_count * BLOOMFILTER_K) / 4;
199 uint16_t max = 1 << 15;
201 if (entry_count > max)
204 while ((size < max) && (size < ideal))
213 * Recalculate our bloom filter for filtering replies. This function
214 * will create a new bloom filter from scratch, so it should only be
215 * called if we have no bloomfilter at all (and hence can create a
216 * fresh one of minimal size without problems) OR if our peer is the
217 * initiator (in which case we may resize to larger than mimimum size).
219 * @param pr request for which the BF is to be recomputed
220 * @return GNUNET_YES if a refresh actually happened
223 refresh_bloomfilter (struct GSF_PendingRequest *pr)
227 GNUNET_HashCode mhash;
229 nsize = compute_bloomfilter_size (pr->replies_seen_count);
230 if ( (pr->bf != NULL) &&
231 (nsize == GNUNET_CONTAINER_bloomfilter_get_size (pr->bf)) )
232 return GNUNET_NO; /* size not changed */
234 GNUNET_CONTAINER_bloomfilter_free (pr->bf);
235 pr->mingle = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
237 pr->bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
240 for (i=0;i<pr->replies_seen_count;i++)
242 GNUNET_BLOCK_mingle_hash (&pr->replies_seen[i],
245 GNUNET_CONTAINER_bloomfilter_add (pr->bf, &mhash);
252 * Create a new pending request.
254 * @param options request options
255 * @param type type of the block that is being requested
256 * @param query key for the lookup
257 * @param namespace namespace to lookup, NULL for no namespace
258 * @param target preferred target for the request, NULL for none
259 * @param bf_data raw data for bloom filter for known replies, can be NULL
260 * @param bf_size number of bytes in bf_data
261 * @param mingle mingle value for bf
262 * @param anonymity_level desired anonymity level
263 * @param priority maximum outgoing cummulative request priority to use
264 * @param ttl current time-to-live for the request
265 * @param sender_pid peer ID to use for the sender when forwarding, 0 for none
266 * @param replies_seen hash codes of known local replies
267 * @param replies_seen_count size of the 'replies_seen' array
268 * @param rh handle to call when we get a reply
269 * @param rh_cls closure for rh
270 * @return handle for the new pending request
272 struct GSF_PendingRequest *
273 GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
274 enum GNUNET_BLOCK_Type type,
275 const GNUNET_HashCode *query,
276 const GNUNET_HashCode *namespace,
277 const struct GNUNET_PeerIdentity *target,
281 uint32_t anonymity_level,
284 GNUNET_PEER_Id sender_pid,
285 const GNUNET_HashCode *replies_seen,
286 unsigned int replies_seen_count,
287 GSF_PendingRequestReplyHandler rh,
290 struct GSF_PendingRequest *pr;
291 struct GSF_PendingRequest *dpr;
294 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
295 "Creating request handle for `%s' of type %d\n",
299 pr = GNUNET_malloc (sizeof (struct GSF_PendingRequest));
300 pr->local_result_offset = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
302 pr->public_data.query = *query;
303 if (GNUNET_BLOCK_TYPE_FS_SBLOCK == type)
305 GNUNET_assert (NULL != namespace);
306 pr->public_data.namespace = *namespace;
310 pr->public_data.target = *target;
311 pr->public_data.has_target = GNUNET_YES;
313 pr->public_data.anonymity_level = anonymity_level;
314 pr->public_data.priority = priority;
315 pr->public_data.original_priority = priority;
316 pr->public_data.options = options;
317 pr->public_data.type = type;
318 pr->public_data.start_time = GNUNET_TIME_absolute_get ();
319 pr->sender_pid = sender_pid;
323 pr->public_data.ttl = GNUNET_TIME_relative_to_absolute (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
326 pr->public_data.ttl = GNUNET_TIME_absolute_subtract (pr->public_data.start_time,
327 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
328 (uint32_t) (- ttl)));
329 if (replies_seen_count > 0)
331 pr->replies_seen_size = replies_seen_count;
332 pr->replies_seen = GNUNET_malloc (sizeof (GNUNET_HashCode) * pr->replies_seen_size);
333 memcpy (pr->replies_seen,
335 replies_seen_count * sizeof (GNUNET_HashCode));
336 pr->replies_seen_count = replies_seen_count;
340 pr->bf = GNUNET_CONTAINER_bloomfilter_init (bf_data,
345 else if ( (replies_seen_count > 0) &&
346 (0 != (options & GSF_PRO_BLOOMFILTER_FULL_REFRESH)) )
348 GNUNET_assert (GNUNET_YES == refresh_bloomfilter (pr));
350 GNUNET_CONTAINER_multihashmap_put (pr_map,
353 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
354 if (0 != (options & GSF_PRO_REQUEST_EXPIRES))
356 pr->hnode = GNUNET_CONTAINER_heap_insert (requests_by_expiration_heap,
358 pr->public_data.ttl.abs_value);
359 /* make sure we don't track too many requests */
360 while (GNUNET_CONTAINER_heap_get_size (requests_by_expiration_heap) > max_pending_requests)
362 dpr = GNUNET_CONTAINER_heap_peek (requests_by_expiration_heap);
363 GNUNET_assert (dpr != NULL);
365 break; /* let the request live briefly... */
366 dpr->rh (dpr->rh_cls,
367 GNUNET_BLOCK_EVALUATION_REQUEST_VALID,
370 GNUNET_TIME_UNIT_FOREVER_ABS,
371 GNUNET_BLOCK_TYPE_ANY,
373 GSF_pending_request_cancel_ (dpr);
381 * Obtain the public data associated with a pending request
383 * @param pr pending request
384 * @return associated public data
386 struct GSF_PendingRequestData *
387 GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr)
389 return &pr->public_data;
394 * Update a given pending request with additional replies
395 * that have been seen.
397 * @param pr request to update
398 * @param replies_seen hash codes of replies that we've seen
399 * @param replies_seen_count size of the replies_seen array
402 GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
403 const GNUNET_HashCode *replies_seen,
404 unsigned int replies_seen_count)
407 GNUNET_HashCode mhash;
409 if (replies_seen_count + pr->replies_seen_count < pr->replies_seen_count)
410 return; /* integer overflow */
411 if (0 != (pr->public_data.options & GSF_PRO_BLOOMFILTER_FULL_REFRESH))
413 /* we're responsible for the BF, full refresh */
414 if (replies_seen_count + pr->replies_seen_count > pr->replies_seen_size)
415 GNUNET_array_grow (pr->replies_seen,
416 pr->replies_seen_size,
417 replies_seen_count + pr->replies_seen_count);
418 memcpy (&pr->replies_seen[pr->replies_seen_count],
420 sizeof (GNUNET_HashCode) * replies_seen_count);
421 pr->replies_seen_count += replies_seen_count;
422 if (GNUNET_NO == refresh_bloomfilter (pr))
424 /* bf not recalculated, simply extend it with new bits */
425 for (i=0;i<replies_seen_count;i++)
427 GNUNET_BLOCK_mingle_hash (&replies_seen[i],
430 GNUNET_CONTAINER_bloomfilter_add (pr->bf, &mhash);
438 /* we're not the initiator, but the initiator did not give us
439 any bloom-filter, so we need to create one on-the-fly */
440 pr->mingle = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
442 pr->bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
443 compute_bloomfilter_size (replies_seen_count),
446 for (i=0;i<pr->replies_seen_count;i++)
448 GNUNET_BLOCK_mingle_hash (&replies_seen[i],
451 GNUNET_CONTAINER_bloomfilter_add (pr->bf, &mhash);
458 * Generate the message corresponding to the given pending request for
459 * transmission to other peers (or at least determine its size).
461 * @param pr request to generate the message for
462 * @param buf_size number of bytes available in buf
463 * @param buf where to copy the message (can be NULL)
464 * @return number of bytes needed (if > buf_size) or used
467 GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
471 char lbuf[GNUNET_SERVER_MAX_MESSAGE_SIZE];
472 struct GetMessage *gm;
473 GNUNET_HashCode *ext;
479 struct GNUNET_TIME_Absolute now;
485 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
486 "Building request message for `%s' of type %d\n",
487 GNUNET_h2s (&pr->public_data.query),
488 pr->public_data.type);
492 do_route = (0 == (pr->public_data.options & GSF_PRO_FORWARD_ONLY));
495 bm |= GET_MESSAGE_BIT_RETURN_TO;
498 if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
500 bm |= GET_MESSAGE_BIT_SKS_NAMESPACE;
503 if (GNUNET_YES == pr->public_data.has_target)
505 bm |= GET_MESSAGE_BIT_TRANSMIT_TO;
508 bf_size = GNUNET_CONTAINER_bloomfilter_get_size (pr->bf);
509 msize = sizeof (struct GetMessage) + bf_size + k * sizeof(GNUNET_HashCode);
510 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
511 if (buf_size < msize)
513 gm = (struct GetMessage*) lbuf;
514 gm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_GET);
515 gm->header.size = htons (msize);
516 gm->type = htonl (pr->public_data.type);
518 prio = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
519 pr->public_data.priority + 1);
522 pr->public_data.priority -= prio;
523 gm->priority = htonl (prio);
524 now = GNUNET_TIME_absolute_get ();
525 ttl = (int64_t) (pr->public_data.ttl.abs_value - now.abs_value);
526 gm->ttl = htonl (ttl / 1000);
527 gm->filter_mutator = htonl(pr->mingle);
528 gm->hash_bitmap = htonl (bm);
529 gm->query = pr->public_data.query;
530 ext = (GNUNET_HashCode*) &gm[1];
533 GNUNET_PEER_resolve (pr->sender_pid,
534 (struct GNUNET_PeerIdentity*) &ext[k++]);
535 if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
537 &pr->public_data.namespace,
538 sizeof (GNUNET_HashCode));
539 if (GNUNET_YES == pr->public_data.has_target)
540 ext[k++] = pr->public_data.target.hashPubKey;
542 GNUNET_CONTAINER_bloomfilter_get_raw_data (pr->bf,
545 memcpy (buf, gm, msize);
551 * Iterator to free pending requests.
553 * @param cls closure, unused
554 * @param key current key code
555 * @param value value in the hash map (pending request)
556 * @return GNUNET_YES (we should continue to iterate)
559 clean_request (void *cls,
560 const GNUNET_HashCode * key,
563 struct GSF_PendingRequest *pr = value;
564 GSF_LocalLookupContinuation cont;
567 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
568 "Cleaning up pending request for `%s'.\n",
571 if (NULL != (cont = pr->llc_cont))
574 cont (pr->llc_cont_cls,
578 GSF_plan_notify_request_done_ (pr);
579 GNUNET_free_non_null (pr->replies_seen);
582 GNUNET_CONTAINER_bloomfilter_free (pr->bf);
585 GNUNET_PEER_change_rc (pr->sender_pid, -1);
586 if (NULL != pr->hnode)
588 GNUNET_CONTAINER_heap_remove_node (pr->hnode);
593 GNUNET_DATASTORE_cancel (pr->qe);
598 GNUNET_DHT_get_stop (pr->gh);
601 if (GNUNET_SCHEDULER_NO_TASK != pr->warn_task)
603 GNUNET_SCHEDULER_cancel (pr->warn_task);
604 pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
612 * Explicitly cancel a pending request.
614 * @param pr request to cancel
617 GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr)
620 return; /* already cleaned up! */
621 GNUNET_assert (GNUNET_OK ==
622 GNUNET_CONTAINER_multihashmap_remove (pr_map,
623 &pr->public_data.query,
625 GNUNET_assert (GNUNET_YES ==
626 clean_request (NULL, &pr->public_data.query, pr));
631 * Iterate over all pending requests.
633 * @param it function to call for each request
634 * @param cls closure for it
637 GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
640 GNUNET_CONTAINER_multihashmap_iterate (pr_map,
641 (GNUNET_CONTAINER_HashMapIterator) it,
649 * Closure for "process_reply" function.
651 struct ProcessReplyClosure
654 * The data for the reply.
659 * Who gave us this reply? NULL for local host (or DHT)
661 struct GSF_ConnectedPeer *sender;
664 * When the reply expires.
666 struct GNUNET_TIME_Absolute expiration;
676 enum GNUNET_BLOCK_Type type;
679 * How much was this reply worth to us?
684 * Anonymity requirements for this reply.
686 uint32_t anonymity_level;
689 * Evaluation result (returned).
691 enum GNUNET_BLOCK_EvaluationResult eval;
694 * Did we find a matching request?
701 * Update the performance data for the sender (if any) since
702 * the sender successfully answered one of our queries.
704 * @param prq information about the sender
705 * @param pr request that was satisfied
708 update_request_performance_data (struct ProcessReplyClosure *prq,
709 struct GSF_PendingRequest *pr)
711 if (prq->sender == NULL)
713 GSF_peer_update_performance_ (prq->sender,
714 pr->public_data.start_time,
720 * We have received a reply; handle it!
722 * @param cls response (struct ProcessReplyClosure)
723 * @param key our query
724 * @param value value in the hash map (info about the query)
725 * @return GNUNET_YES (we should continue to iterate)
728 process_reply (void *cls,
729 const GNUNET_HashCode *key,
732 struct ProcessReplyClosure *prq = cls;
733 struct GSF_PendingRequest *pr = value;
734 GNUNET_HashCode chash;
737 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
738 "Matched result (type %u) for query `%s' with pending request\n",
739 (unsigned int) prq->type,
742 GNUNET_STATISTICS_update (GSF_stats,
743 gettext_noop ("# replies received and matched"),
746 prq->eval = GNUNET_BLOCK_evaluate (GSF_block_ctx,
751 &pr->public_data.namespace,
752 (prq->type == GNUNET_BLOCK_TYPE_FS_SBLOCK) ? sizeof (GNUNET_HashCode) : 0,
757 case GNUNET_BLOCK_EVALUATION_OK_MORE:
758 update_request_performance_data (prq, pr);
760 case GNUNET_BLOCK_EVALUATION_OK_LAST:
761 /* short cut: stop processing early, no BF-update, etc. */
762 update_request_performance_data (prq, pr);
763 GNUNET_LOAD_update (GSF_rt_entry_lifetime,
764 GNUNET_TIME_absolute_get_duration (pr->public_data.start_time).rel_value);
765 /* pass on to other peers / local clients */
769 prq->anonymity_level,
772 prq->data, prq->size);
774 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
775 GNUNET_STATISTICS_update (GSF_stats,
776 gettext_noop ("# duplicate replies discarded (bloomfilter)"),
780 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
781 "Duplicate response `%s', discarding.\n",
782 GNUNET_h2s (&mhash));
784 return GNUNET_YES; /* duplicate */
785 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
786 return GNUNET_YES; /* wrong namespace */
787 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
790 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
793 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
794 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
795 _("Unsupported block type %u\n"),
799 /* update bloomfilter */
800 GNUNET_CRYPTO_hash (prq->data,
803 GSF_pending_request_update_ (pr, &chash, 1);
804 if (NULL == prq->sender)
807 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
808 "Found result for query `%s' in local datastore\n",
811 GNUNET_STATISTICS_update (GSF_stats,
812 gettext_noop ("# results found locally"),
818 GSF_dht_lookup_ (pr);
820 prq->priority += pr->public_data.original_priority;
821 pr->public_data.priority = 0;
822 pr->public_data.original_priority = 0;
823 pr->public_data.results_found++;
824 prq->request_found = GNUNET_YES;
825 /* finally, pass on to other peer / local client */
829 prq->anonymity_level,
832 prq->data, prq->size);
838 * Context for the 'put_migration_continuation'.
840 struct PutMigrationContext
844 * Start time for the operation.
846 struct GNUNET_TIME_Absolute start;
851 struct GNUNET_PeerIdentity origin;
854 * GNUNET_YES if we had a matching request for this block,
862 * Continuation called to notify client about result of the
866 * @param success GNUNET_SYSERR on failure
867 * @param msg NULL on success, otherwise an error message
870 put_migration_continuation (void *cls,
874 struct PutMigrationContext *pmc = cls;
875 struct GNUNET_TIME_Relative delay;
876 struct GNUNET_TIME_Relative block_time;
877 struct GSF_ConnectedPeer *cp;
878 struct GSF_PeerPerformanceData *ppd;
880 delay = GNUNET_TIME_absolute_get_duration (pmc->start);
881 cp = GSF_peer_get_ (&pmc->origin);
882 if ( (GNUNET_OK != success) &&
883 (GNUNET_NO == pmc->requested) )
885 /* block migration for a bit... */
888 ppd = GSF_get_peer_performance_data_ (cp);
889 ppd->migration_duplication++;
890 block_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
891 5 * ppd->migration_duplication +
892 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 5));
893 GSF_block_peer_migration_ (cp, block_time);
900 ppd = GSF_get_peer_performance_data_ (cp);
901 ppd->migration_duplication = 0; /* reset counter */
905 /* FIXME: should we really update the load value on failure? */
906 GNUNET_LOAD_update (datastore_put_load,
908 if (GNUNET_OK == success)
910 GNUNET_STATISTICS_update (GSF_stats,
911 gettext_noop ("# datastore 'put' failures"),
918 * Test if the DATABASE (PUT) load on this peer is too high
919 * to even consider processing the query at
922 * @return GNUNET_YES if the load is too high to do anything (load high)
923 * GNUNET_NO to process normally (load normal or low)
926 test_put_load_too_high (uint32_t priority)
930 if (GNUNET_LOAD_get_average (datastore_put_load) < 50)
931 return GNUNET_NO; /* very fast */
932 ld = GNUNET_LOAD_get_load (datastore_put_load);
933 if (ld < 2.0 * (1 + priority))
935 GNUNET_STATISTICS_update (GSF_stats,
936 gettext_noop ("# storage requests dropped due to high load"),
944 * Iterator called on each result obtained for a DHT
945 * operation that expects a reply
948 * @param exp when will this value expire
949 * @param key key of the result
950 * @param get_path NULL-terminated array of pointers
951 * to the peers on reverse GET path (or NULL if not recorded)
952 * @param put_path NULL-terminated array of pointers
953 * to the peers on the PUT path (or NULL if not recorded)
954 * @param type type of the result
955 * @param size number of bytes in data
956 * @param data pointer to the result data
959 handle_dht_reply (void *cls,
960 struct GNUNET_TIME_Absolute exp,
961 const GNUNET_HashCode *key,
962 const struct GNUNET_PeerIdentity * const *get_path,
963 const struct GNUNET_PeerIdentity * const *put_path,
964 enum GNUNET_BLOCK_Type type,
968 struct GSF_PendingRequest *pr = cls;
969 struct ProcessReplyClosure prq;
970 struct PutMigrationContext *pmc;
972 memset (&prq, 0, sizeof (prq));
974 prq.expiration = exp;
977 process_reply (&prq, key, pr);
978 if ( (GNUNET_YES == active_to_migration) &&
979 (GNUNET_NO == test_put_load_too_high (prq.priority)) )
982 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
983 "Replicating result for query `%s' with priority %u\n",
987 pmc = GNUNET_malloc (sizeof (struct PutMigrationContext));
988 pmc->start = GNUNET_TIME_absolute_get ();
989 pmc->requested = GNUNET_YES;
991 GNUNET_DATASTORE_put (GSF_dsh,
993 type, prq.priority, 1 /* anonymity */,
996 1 + prq.priority, MAX_DATASTORE_QUEUE,
997 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
998 &put_migration_continuation,
1001 put_migration_continuation (pmc, GNUNET_NO, NULL);
1008 * Consider looking up the data in the DHT (anonymity-level permitting).
1010 * @param pr the pending request to process
1013 GSF_dht_lookup_ (struct GSF_PendingRequest *pr)
1017 struct GNUNET_PeerIdentity pi;
1018 char buf[sizeof (GNUNET_HashCode) * 2];
1020 if (0 != pr->public_data.anonymity_level)
1024 GNUNET_DHT_get_stop (pr->gh);
1029 if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
1032 memcpy (buf, &pr->public_data.namespace, sizeof (GNUNET_HashCode));
1033 xquery_size = sizeof (GNUNET_HashCode);
1035 if (0 != (pr->public_data.options & GSF_PRO_FORWARD_ONLY))
1037 GNUNET_PEER_resolve (pr->sender_pid,
1039 memcpy (&buf[xquery_size], &pi, sizeof (struct GNUNET_PeerIdentity));
1040 xquery_size += sizeof (struct GNUNET_PeerIdentity);
1042 pr->gh = GNUNET_DHT_get_start (GSF_dht,
1043 GNUNET_TIME_UNIT_FOREVER_REL,
1044 pr->public_data.type,
1045 &pr->public_data.query,
1046 DEFAULT_GET_REPLICATION,
1047 GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
1058 * Task that issues a warning if the datastore lookup takes too long.
1060 * @param cls the 'struct GSF_PendingRequest'
1061 * @param tc task context
1064 warn_delay_task (void *cls,
1065 const struct GNUNET_SCHEDULER_TaskContext *tc)
1067 struct GSF_PendingRequest *pr = cls;
1069 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1070 _("Datastore lookup already took %llu ms!\n"),
1071 (unsigned long long) GNUNET_TIME_absolute_get_duration (pr->qe_start).rel_value);
1072 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1079 * Task that issues a warning if the datastore lookup takes too long.
1081 * @param cls the 'struct GSF_PendingRequest'
1082 * @param tc task context
1085 odc_warn_delay_task (void *cls,
1086 const struct GNUNET_SCHEDULER_TaskContext *tc)
1088 struct GSF_PendingRequest *pr = cls;
1090 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1091 _("On-demand 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 &odc_warn_delay_task,
1100 * We're processing (local) results for a search request
1101 * from another peer. Pass applicable results to the
1102 * peer and if we are done either clean up (operation
1103 * complete) or forward to other peers (more results possible).
1105 * @param cls our closure (struct PendingRequest)
1106 * @param key key for the content
1107 * @param size number of bytes in data
1108 * @param data content stored
1109 * @param type type of the content
1110 * @param priority priority of the content
1111 * @param anonymity anonymity-level for the content
1112 * @param expiration expiration time for the content
1113 * @param uid unique identifier for the datum;
1114 * maybe 0 if no unique identifier is available
1117 process_local_reply (void *cls,
1118 const GNUNET_HashCode *key,
1121 enum GNUNET_BLOCK_Type type,
1124 struct GNUNET_TIME_Absolute expiration,
1127 struct GSF_PendingRequest *pr = cls;
1128 GSF_LocalLookupContinuation cont;
1129 struct ProcessReplyClosure prq;
1130 GNUNET_HashCode query;
1131 unsigned int old_rf;
1134 GNUNET_SCHEDULER_cancel (pr->warn_task);
1135 pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1136 if (0 == pr->replies_seen_count)
1138 pr->first_uid = uid;
1142 if (uid == pr->first_uid)
1143 key = NULL; /* all replies seen! */
1148 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1149 "No further local responses available.\n");
1151 if ( (pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK) ||
1152 (pr->public_data.type == GNUNET_BLOCK_TYPE_FS_IBLOCK) )
1153 GNUNET_STATISTICS_update (GSF_stats,
1154 gettext_noop ("# requested DBLOCK or IBLOCK not found"),
1157 goto check_error_and_continue;
1160 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1161 "Received reply for `%s' of type %d with UID %llu from datastore.\n",
1164 (unsigned long long) uid);
1166 if (type == GNUNET_BLOCK_TYPE_FS_ONDEMAND)
1169 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1170 "Found ONDEMAND block, performing on-demand encoding\n");
1172 GNUNET_STATISTICS_update (GSF_stats,
1173 gettext_noop ("# on-demand blocks matched requests"),
1176 pr->qe_start = GNUNET_TIME_absolute_get ();
1177 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1178 &odc_warn_delay_task,
1181 GNUNET_FS_handle_on_demand_block (key, size, data, type, priority,
1182 anonymity, expiration, uid,
1183 &process_local_reply,
1186 GNUNET_STATISTICS_update (GSF_stats,
1187 gettext_noop ("# on-demand lookups performed successfully"),
1190 return; /* we're done */
1192 GNUNET_STATISTICS_update (GSF_stats,
1193 gettext_noop ("# on-demand lookups failed"),
1196 GNUNET_SCHEDULER_cancel (pr->warn_task);
1197 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1200 pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1201 pr->local_result_offset - 1,
1202 &pr->public_data.query,
1203 pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK
1204 ? GNUNET_BLOCK_TYPE_ANY
1205 : pr->public_data.type,
1206 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1208 : 1 /* queue priority */,
1209 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1211 : 1 /* max queue size */,
1212 GNUNET_TIME_UNIT_FOREVER_REL,
1213 &process_local_reply,
1216 return; /* we're done */
1217 goto check_error_and_continue;
1219 old_rf = pr->public_data.results_found;
1220 memset (&prq, 0, sizeof (prq));
1222 prq.expiration = expiration;
1225 GNUNET_BLOCK_get_key (GSF_block_ctx,
1232 GNUNET_DATASTORE_remove (GSF_dsh,
1236 GNUNET_TIME_UNIT_FOREVER_REL,
1238 pr->qe_start = GNUNET_TIME_absolute_get ();
1239 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1242 pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1243 pr->local_result_offset - 1,
1244 &pr->public_data.query,
1245 pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK
1246 ? GNUNET_BLOCK_TYPE_ANY
1247 : pr->public_data.type,
1248 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1250 : 1 /* queue priority */,
1251 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1253 : 1 /* max queue size */,
1254 GNUNET_TIME_UNIT_FOREVER_REL,
1255 &process_local_reply,
1258 goto check_error_and_continue;
1262 prq.priority = priority;
1263 prq.request_found = GNUNET_NO;
1264 prq.anonymity_level = anonymity;
1265 if ( (old_rf == 0) &&
1266 (pr->public_data.results_found == 0) )
1267 GSF_update_datastore_delay_ (pr->public_data.start_time);
1268 process_reply (&prq, key, pr);
1269 pr->local_result = prq.eval;
1270 if (prq.eval == GNUNET_BLOCK_EVALUATION_OK_LAST)
1271 goto check_error_and_continue;
1272 if ( (0 == (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options)) &&
1273 ( (GNUNET_YES == GSF_test_get_load_too_high_ (0)) ||
1274 (pr->public_data.results_found > 5 + 2 * pr->public_data.priority) ) )
1277 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1278 "Load too high, done with request\n");
1280 GNUNET_STATISTICS_update (GSF_stats,
1281 gettext_noop ("# processing result set cut short due to load"),
1284 goto check_error_and_continue;
1286 pr->qe_start = GNUNET_TIME_absolute_get ();
1287 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1290 pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1291 pr->local_result_offset++,
1292 &pr->public_data.query,
1293 pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK
1294 ? GNUNET_BLOCK_TYPE_ANY
1295 : pr->public_data.type,
1296 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1298 : 1 /* queue priority */,
1299 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1301 : 1 /* max queue size */,
1302 GNUNET_TIME_UNIT_FOREVER_REL,
1303 &process_local_reply,
1305 /* check if we successfully queued another datastore request;
1306 if so, return, otherwise call our continuation (if we have
1308 check_error_and_continue:
1311 if (GNUNET_SCHEDULER_NO_TASK != pr->warn_task)
1313 GNUNET_SCHEDULER_cancel (pr->warn_task);
1314 pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1316 if (NULL == (cont = pr->llc_cont))
1317 return; /* no continuation */
1318 pr->llc_cont = NULL;
1319 cont (pr->llc_cont_cls,
1326 * Look up the request in the local datastore.
1328 * @param pr the pending request to process
1329 * @param cont function to call at the end
1330 * @param cont_cls closure for cont
1333 GSF_local_lookup_ (struct GSF_PendingRequest *pr,
1334 GSF_LocalLookupContinuation cont,
1337 GNUNET_assert (NULL == pr->gh);
1338 GNUNET_assert (NULL == pr->llc_cont);
1339 pr->llc_cont = cont;
1340 pr->llc_cont_cls = cont_cls;
1341 pr->qe_start = GNUNET_TIME_absolute_get ();
1342 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1345 pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1346 pr->local_result_offset++,
1347 &pr->public_data.query,
1348 pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK
1349 ? GNUNET_BLOCK_TYPE_ANY
1350 : pr->public_data.type,
1351 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1353 : 1 /* queue priority */,
1354 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1356 : 1 /* max queue size */,
1357 GNUNET_TIME_UNIT_FOREVER_REL,
1358 &process_local_reply,
1362 GNUNET_SCHEDULER_cancel (pr->warn_task);
1363 pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1364 pr->llc_cont = NULL;
1366 cont (cont_cls, pr, pr->local_result);
1372 * Handle P2P "CONTENT" message. Checks that the message is
1373 * well-formed and then checks if there are any pending requests for
1374 * this content and possibly passes it on (to local clients or other
1375 * peers). Does NOT perform migration (content caching at this peer).
1377 * @param cp the other peer involved (sender or receiver, NULL
1378 * for loopback messages where we are both sender and receiver)
1379 * @param message the actual message
1380 * @return GNUNET_OK if the message was well-formed,
1381 * GNUNET_SYSERR if the message was malformed (close connection,
1382 * do not cache under any circumstances)
1385 GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
1386 const struct GNUNET_MessageHeader *message)
1388 const struct PutMessage *put;
1391 enum GNUNET_BLOCK_Type type;
1392 struct GNUNET_TIME_Absolute expiration;
1393 GNUNET_HashCode query;
1394 struct ProcessReplyClosure prq;
1395 struct GNUNET_TIME_Relative block_time;
1397 struct PutMigrationContext *pmc;
1399 msize = ntohs (message->size);
1400 if (msize < sizeof (struct PutMessage))
1403 return GNUNET_SYSERR;
1405 put = (const struct PutMessage*) message;
1406 dsize = msize - sizeof (struct PutMessage);
1407 type = ntohl (put->type);
1408 expiration = GNUNET_TIME_absolute_ntoh (put->expiration);
1409 if (type == GNUNET_BLOCK_TYPE_FS_ONDEMAND)
1410 return GNUNET_SYSERR;
1412 GNUNET_BLOCK_get_key (GSF_block_ctx,
1418 GNUNET_break_op (0);
1419 return GNUNET_SYSERR;
1421 /* now, lookup 'query' */
1422 prq.data = (const void*) &put[1];
1429 prq.expiration = expiration;
1431 prq.anonymity_level = UINT32_MAX;
1432 prq.request_found = GNUNET_NO;
1433 GNUNET_CONTAINER_multihashmap_get_multiple (pr_map,
1439 GSF_connected_peer_change_preference_ (cp, CONTENT_BANDWIDTH_VALUE + 1000 * prq.priority);
1440 GSF_get_peer_performance_data_ (cp)->trust += prq.priority;
1442 if ( (GNUNET_YES == active_to_migration) &&
1443 (GNUNET_NO == test_put_load_too_high (prq.priority)) )
1446 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1447 "Replicating result for query `%s' with priority %u\n",
1448 GNUNET_h2s (&query),
1451 pmc = GNUNET_malloc (sizeof (struct PutMigrationContext));
1452 pmc->start = GNUNET_TIME_absolute_get ();
1453 pmc->requested = prq.request_found;
1454 GNUNET_PEER_resolve (GSF_get_peer_performance_data_ (cp)->pid,
1457 GNUNET_DATASTORE_put (GSF_dsh,
1458 0, &query, dsize, &put[1],
1459 type, prq.priority, 1 /* anonymity */,
1460 0 /* replication */,
1462 1 + prq.priority, MAX_DATASTORE_QUEUE,
1463 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1464 &put_migration_continuation,
1467 put_migration_continuation (pmc, GNUNET_NO, NULL);
1473 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1474 "Choosing not to keep content `%s' (%d/%d)\n",
1475 GNUNET_h2s (&query),
1476 active_to_migration,
1477 test_put_load_too_high (prq.priority));
1480 putl = GNUNET_LOAD_get_load (datastore_put_load);
1481 if ( (NULL != (cp = prq.sender)) &&
1482 (GNUNET_NO == prq.request_found) &&
1483 ( (GNUNET_YES != active_to_migration) ||
1484 (putl > 2.5 * (1 + prq.priority)) ) )
1486 if (GNUNET_YES != active_to_migration)
1487 putl = 1.0 + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 5);
1488 block_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1489 5000 + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1490 (unsigned int) (60000 * putl * putl)));
1491 GSF_block_peer_migration_ (cp, block_time);
1498 * Setup the subsystem.
1501 GSF_pending_request_init_ ()
1504 GNUNET_CONFIGURATION_get_value_number (GSF_cfg,
1506 "MAX_PENDING_REQUESTS",
1507 &max_pending_requests))
1509 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1510 _("Configuration fails to specify `%s', assuming default value."),
1511 "MAX_PENDING_REQUESTS");
1513 active_to_migration = GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
1516 datastore_put_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
1517 pr_map = GNUNET_CONTAINER_multihashmap_create (32 * 1024);
1518 requests_by_expiration_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1523 * Shutdown the subsystem.
1526 GSF_pending_request_done_ ()
1528 GNUNET_CONTAINER_multihashmap_iterate (pr_map,
1531 GNUNET_CONTAINER_multihashmap_destroy (pr_map);
1533 GNUNET_CONTAINER_heap_destroy (requests_by_expiration_heap);
1534 requests_by_expiration_heap = NULL;
1535 GNUNET_LOAD_value_free (datastore_put_load);
1536 datastore_put_load = NULL;
1540 /* end of gnunet-service-fs_pr.c */