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<pr->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 GNUNET_PEER_resolve (pr->sender_pid,
541 (struct GNUNET_PeerIdentity*) &ext[k++]);
543 GNUNET_CONTAINER_bloomfilter_get_raw_data (pr->bf,
546 memcpy (buf, gm, msize);
552 * Iterator to free pending requests.
554 * @param cls closure, unused
555 * @param key current key code
556 * @param value value in the hash map (pending request)
557 * @return GNUNET_YES (we should continue to iterate)
560 clean_request (void *cls,
561 const GNUNET_HashCode * key,
564 struct GSF_PendingRequest *pr = value;
565 GSF_LocalLookupContinuation cont;
568 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
569 "Cleaning up pending request for `%s'.\n",
572 if (NULL != (cont = pr->llc_cont))
575 cont (pr->llc_cont_cls,
579 GSF_plan_notify_request_done_ (pr);
580 GNUNET_free_non_null (pr->replies_seen);
583 GNUNET_CONTAINER_bloomfilter_free (pr->bf);
586 GNUNET_PEER_change_rc (pr->sender_pid, -1);
587 if (NULL != pr->hnode)
589 GNUNET_CONTAINER_heap_remove_node (pr->hnode);
594 GNUNET_DATASTORE_cancel (pr->qe);
599 GNUNET_DHT_get_stop (pr->gh);
602 if (GNUNET_SCHEDULER_NO_TASK != pr->warn_task)
604 GNUNET_SCHEDULER_cancel (pr->warn_task);
605 pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
613 * Explicitly cancel a pending request.
615 * @param pr request to cancel
618 GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr)
621 return; /* already cleaned up! */
622 GNUNET_assert (GNUNET_OK ==
623 GNUNET_CONTAINER_multihashmap_remove (pr_map,
624 &pr->public_data.query,
626 GNUNET_assert (GNUNET_YES ==
627 clean_request (NULL, &pr->public_data.query, pr));
632 * Iterate over all pending requests.
634 * @param it function to call for each request
635 * @param cls closure for it
638 GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
641 GNUNET_CONTAINER_multihashmap_iterate (pr_map,
642 (GNUNET_CONTAINER_HashMapIterator) it,
650 * Closure for "process_reply" function.
652 struct ProcessReplyClosure
655 * The data for the reply.
660 * Who gave us this reply? NULL for local host (or DHT)
662 struct GSF_ConnectedPeer *sender;
665 * When the reply expires.
667 struct GNUNET_TIME_Absolute expiration;
677 enum GNUNET_BLOCK_Type type;
680 * How much was this reply worth to us?
685 * Anonymity requirements for this reply.
687 uint32_t anonymity_level;
690 * Evaluation result (returned).
692 enum GNUNET_BLOCK_EvaluationResult eval;
695 * Did we find a matching request?
702 * Update the performance data for the sender (if any) since
703 * the sender successfully answered one of our queries.
705 * @param prq information about the sender
706 * @param pr request that was satisfied
709 update_request_performance_data (struct ProcessReplyClosure *prq,
710 struct GSF_PendingRequest *pr)
712 if (prq->sender == NULL)
714 GSF_peer_update_performance_ (prq->sender,
715 pr->public_data.start_time,
721 * We have received a reply; handle it!
723 * @param cls response (struct ProcessReplyClosure)
724 * @param key our query
725 * @param value value in the hash map (info about the query)
726 * @return GNUNET_YES (we should continue to iterate)
729 process_reply (void *cls,
730 const GNUNET_HashCode *key,
733 struct ProcessReplyClosure *prq = cls;
734 struct GSF_PendingRequest *pr = value;
735 GNUNET_HashCode chash;
738 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
739 "Matched result (type %u) for query `%s' with pending request\n",
740 (unsigned int) prq->type,
743 GNUNET_STATISTICS_update (GSF_stats,
744 gettext_noop ("# replies received and matched"),
747 prq->eval = GNUNET_BLOCK_evaluate (GSF_block_ctx,
752 &pr->public_data.namespace,
753 (prq->type == GNUNET_BLOCK_TYPE_FS_SBLOCK) ? sizeof (GNUNET_HashCode) : 0,
758 case GNUNET_BLOCK_EVALUATION_OK_MORE:
759 update_request_performance_data (prq, pr);
761 case GNUNET_BLOCK_EVALUATION_OK_LAST:
762 /* short cut: stop processing early, no BF-update, etc. */
763 update_request_performance_data (prq, pr);
764 GNUNET_LOAD_update (GSF_rt_entry_lifetime,
765 GNUNET_TIME_absolute_get_duration (pr->public_data.start_time).rel_value);
766 /* pass on to other peers / local clients */
770 prq->anonymity_level,
773 prq->data, prq->size);
775 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
776 GNUNET_STATISTICS_update (GSF_stats,
777 gettext_noop ("# duplicate replies discarded (bloomfilter)"),
781 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
782 "Duplicate response `%s', discarding.\n",
783 GNUNET_h2s (&mhash));
785 return GNUNET_YES; /* duplicate */
786 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
787 return GNUNET_YES; /* wrong namespace */
788 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
791 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
794 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
795 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
796 _("Unsupported block type %u\n"),
800 /* update bloomfilter */
801 GNUNET_CRYPTO_hash (prq->data,
804 GSF_pending_request_update_ (pr, &chash, 1);
805 if (NULL == prq->sender)
808 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
809 "Found result for query `%s' in local datastore\n",
812 GNUNET_STATISTICS_update (GSF_stats,
813 gettext_noop ("# results found locally"),
819 GSF_dht_lookup_ (pr);
821 prq->priority += pr->public_data.original_priority;
822 pr->public_data.priority = 0;
823 pr->public_data.original_priority = 0;
824 pr->public_data.results_found++;
825 prq->request_found = GNUNET_YES;
826 /* finally, pass on to other peer / local client */
830 prq->anonymity_level,
833 prq->data, prq->size);
839 * Context for the 'put_migration_continuation'.
841 struct PutMigrationContext
845 * Start time for the operation.
847 struct GNUNET_TIME_Absolute start;
852 struct GNUNET_PeerIdentity origin;
855 * GNUNET_YES if we had a matching request for this block,
863 * Continuation called to notify client about result of the
867 * @param success GNUNET_SYSERR on failure
868 * @param msg NULL on success, otherwise an error message
871 put_migration_continuation (void *cls,
875 struct PutMigrationContext *pmc = cls;
876 struct GNUNET_TIME_Relative delay;
877 struct GNUNET_TIME_Relative block_time;
878 struct GSF_ConnectedPeer *cp;
879 struct GSF_PeerPerformanceData *ppd;
881 delay = GNUNET_TIME_absolute_get_duration (pmc->start);
882 cp = GSF_peer_get_ (&pmc->origin);
883 if ( (GNUNET_OK != success) &&
884 (GNUNET_NO == pmc->requested) )
886 /* block migration for a bit... */
889 ppd = GSF_get_peer_performance_data_ (cp);
890 ppd->migration_duplication++;
891 block_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
892 5 * ppd->migration_duplication +
893 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 5));
894 GSF_block_peer_migration_ (cp, block_time);
901 ppd = GSF_get_peer_performance_data_ (cp);
902 ppd->migration_duplication = 0; /* reset counter */
906 /* FIXME: should we really update the load value on failure? */
907 GNUNET_LOAD_update (datastore_put_load,
909 if (GNUNET_OK == success)
911 GNUNET_STATISTICS_update (GSF_stats,
912 gettext_noop ("# datastore 'put' failures"),
919 * Test if the DATABASE (PUT) load on this peer is too high
920 * to even consider processing the query at
923 * @return GNUNET_YES if the load is too high to do anything (load high)
924 * GNUNET_NO to process normally (load normal or low)
927 test_put_load_too_high (uint32_t priority)
931 if (GNUNET_LOAD_get_average (datastore_put_load) < 50)
932 return GNUNET_NO; /* very fast */
933 ld = GNUNET_LOAD_get_load (datastore_put_load);
934 if (ld < 2.0 * (1 + priority))
936 GNUNET_STATISTICS_update (GSF_stats,
937 gettext_noop ("# storage requests dropped due to high load"),
945 * Iterator called on each result obtained for a DHT
946 * operation that expects a reply
949 * @param exp when will this value expire
950 * @param key key of the result
951 * @param get_path NULL-terminated array of pointers
952 * to the peers on reverse GET path (or NULL if not recorded)
953 * @param put_path NULL-terminated array of pointers
954 * to the peers on the PUT path (or NULL if not recorded)
955 * @param type type of the result
956 * @param size number of bytes in data
957 * @param data pointer to the result data
960 handle_dht_reply (void *cls,
961 struct GNUNET_TIME_Absolute exp,
962 const GNUNET_HashCode *key,
963 const struct GNUNET_PeerIdentity * const *get_path,
964 const struct GNUNET_PeerIdentity * const *put_path,
965 enum GNUNET_BLOCK_Type type,
969 struct GSF_PendingRequest *pr = cls;
970 struct ProcessReplyClosure prq;
971 struct PutMigrationContext *pmc;
973 memset (&prq, 0, sizeof (prq));
975 prq.expiration = exp;
978 process_reply (&prq, key, pr);
979 if ( (GNUNET_YES == active_to_migration) &&
980 (GNUNET_NO == test_put_load_too_high (prq.priority)) )
983 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
984 "Replicating result for query `%s' with priority %u\n",
988 pmc = GNUNET_malloc (sizeof (struct PutMigrationContext));
989 pmc->start = GNUNET_TIME_absolute_get ();
990 pmc->requested = GNUNET_YES;
992 GNUNET_DATASTORE_put (GSF_dsh,
994 type, prq.priority, 1 /* anonymity */,
997 1 + prq.priority, MAX_DATASTORE_QUEUE,
998 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
999 &put_migration_continuation,
1002 put_migration_continuation (pmc, GNUNET_NO, NULL);
1009 * Consider looking up the data in the DHT (anonymity-level permitting).
1011 * @param pr the pending request to process
1014 GSF_dht_lookup_ (struct GSF_PendingRequest *pr)
1018 struct GNUNET_PeerIdentity pi;
1019 char buf[sizeof (GNUNET_HashCode) * 2];
1021 if (0 != pr->public_data.anonymity_level)
1025 GNUNET_DHT_get_stop (pr->gh);
1030 if (GNUNET_BLOCK_TYPE_FS_SBLOCK == pr->public_data.type)
1033 memcpy (buf, &pr->public_data.namespace, sizeof (GNUNET_HashCode));
1034 xquery_size = sizeof (GNUNET_HashCode);
1036 if (0 != (pr->public_data.options & GSF_PRO_FORWARD_ONLY))
1038 GNUNET_PEER_resolve (pr->sender_pid,
1040 memcpy (&buf[xquery_size], &pi, sizeof (struct GNUNET_PeerIdentity));
1041 xquery_size += sizeof (struct GNUNET_PeerIdentity);
1043 pr->gh = GNUNET_DHT_get_start (GSF_dht,
1044 GNUNET_TIME_UNIT_FOREVER_REL,
1045 pr->public_data.type,
1046 &pr->public_data.query,
1047 DEFAULT_GET_REPLICATION,
1048 GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE,
1059 * Task that issues a warning if the datastore lookup takes too long.
1061 * @param cls the 'struct GSF_PendingRequest'
1062 * @param tc task context
1065 warn_delay_task (void *cls,
1066 const struct GNUNET_SCHEDULER_TaskContext *tc)
1068 struct GSF_PendingRequest *pr = cls;
1070 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1071 _("Datastore lookup already took %llu ms!\n"),
1072 (unsigned long long) GNUNET_TIME_absolute_get_duration (pr->qe_start).rel_value);
1073 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1080 * Task that issues a warning if the datastore lookup takes too long.
1082 * @param cls the 'struct GSF_PendingRequest'
1083 * @param tc task context
1086 odc_warn_delay_task (void *cls,
1087 const struct GNUNET_SCHEDULER_TaskContext *tc)
1089 struct GSF_PendingRequest *pr = cls;
1091 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1092 _("On-demand lookup already took %llu ms!\n"),
1093 (unsigned long long) GNUNET_TIME_absolute_get_duration (pr->qe_start).rel_value);
1094 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1095 &odc_warn_delay_task,
1101 * We're processing (local) results for a search request
1102 * from another peer. Pass applicable results to the
1103 * peer and if we are done either clean up (operation
1104 * complete) or forward to other peers (more results possible).
1106 * @param cls our closure (struct PendingRequest)
1107 * @param key key for the content
1108 * @param size number of bytes in data
1109 * @param data content stored
1110 * @param type type of the content
1111 * @param priority priority of the content
1112 * @param anonymity anonymity-level for the content
1113 * @param expiration expiration time for the content
1114 * @param uid unique identifier for the datum;
1115 * maybe 0 if no unique identifier is available
1118 process_local_reply (void *cls,
1119 const GNUNET_HashCode *key,
1122 enum GNUNET_BLOCK_Type type,
1125 struct GNUNET_TIME_Absolute expiration,
1128 struct GSF_PendingRequest *pr = cls;
1129 GSF_LocalLookupContinuation cont;
1130 struct ProcessReplyClosure prq;
1131 GNUNET_HashCode query;
1132 unsigned int old_rf;
1135 GNUNET_SCHEDULER_cancel (pr->warn_task);
1136 pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1137 if (0 == pr->replies_seen_count)
1139 pr->first_uid = uid;
1143 if (uid == pr->first_uid)
1144 key = NULL; /* all replies seen! */
1149 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1150 "No further local responses available.\n");
1152 if ( (pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK) ||
1153 (pr->public_data.type == GNUNET_BLOCK_TYPE_FS_IBLOCK) )
1154 GNUNET_STATISTICS_update (GSF_stats,
1155 gettext_noop ("# requested DBLOCK or IBLOCK not found"),
1158 goto check_error_and_continue;
1161 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1162 "Received reply for `%s' of type %d with UID %llu from datastore.\n",
1165 (unsigned long long) uid);
1167 if (type == GNUNET_BLOCK_TYPE_FS_ONDEMAND)
1170 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1171 "Found ONDEMAND block, performing on-demand encoding\n");
1173 GNUNET_STATISTICS_update (GSF_stats,
1174 gettext_noop ("# on-demand blocks matched requests"),
1177 pr->qe_start = GNUNET_TIME_absolute_get ();
1178 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1179 &odc_warn_delay_task,
1182 GNUNET_FS_handle_on_demand_block (key, size, data, type, priority,
1183 anonymity, expiration, uid,
1184 &process_local_reply,
1187 GNUNET_STATISTICS_update (GSF_stats,
1188 gettext_noop ("# on-demand lookups performed successfully"),
1191 return; /* we're done */
1193 GNUNET_STATISTICS_update (GSF_stats,
1194 gettext_noop ("# on-demand lookups failed"),
1197 GNUNET_SCHEDULER_cancel (pr->warn_task);
1198 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1201 pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1202 pr->local_result_offset - 1,
1203 &pr->public_data.query,
1204 pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK
1205 ? GNUNET_BLOCK_TYPE_ANY
1206 : pr->public_data.type,
1207 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1209 : 1 /* queue priority */,
1210 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1212 : 1 /* max queue size */,
1213 GNUNET_TIME_UNIT_FOREVER_REL,
1214 &process_local_reply,
1217 return; /* we're done */
1218 goto check_error_and_continue;
1220 old_rf = pr->public_data.results_found;
1221 memset (&prq, 0, sizeof (prq));
1223 prq.expiration = expiration;
1226 GNUNET_BLOCK_get_key (GSF_block_ctx,
1233 GNUNET_DATASTORE_remove (GSF_dsh,
1237 GNUNET_TIME_UNIT_FOREVER_REL,
1239 pr->qe_start = GNUNET_TIME_absolute_get ();
1240 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1243 pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1244 pr->local_result_offset - 1,
1245 &pr->public_data.query,
1246 pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK
1247 ? GNUNET_BLOCK_TYPE_ANY
1248 : pr->public_data.type,
1249 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1251 : 1 /* queue priority */,
1252 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1254 : 1 /* max queue size */,
1255 GNUNET_TIME_UNIT_FOREVER_REL,
1256 &process_local_reply,
1259 goto check_error_and_continue;
1263 prq.priority = priority;
1264 prq.request_found = GNUNET_NO;
1265 prq.anonymity_level = anonymity;
1266 if ( (old_rf == 0) &&
1267 (pr->public_data.results_found == 0) )
1268 GSF_update_datastore_delay_ (pr->public_data.start_time);
1269 process_reply (&prq, key, pr);
1270 pr->local_result = prq.eval;
1271 if (prq.eval == GNUNET_BLOCK_EVALUATION_OK_LAST)
1272 goto check_error_and_continue;
1273 if ( (0 == (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options)) &&
1274 ( (GNUNET_YES == GSF_test_get_load_too_high_ (0)) ||
1275 (pr->public_data.results_found > 5 + 2 * pr->public_data.priority) ) )
1278 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1279 "Load too high, done with request\n");
1281 GNUNET_STATISTICS_update (GSF_stats,
1282 gettext_noop ("# processing result set cut short due to load"),
1285 goto check_error_and_continue;
1287 pr->qe_start = GNUNET_TIME_absolute_get ();
1288 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1291 pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1292 pr->local_result_offset++,
1293 &pr->public_data.query,
1294 pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK
1295 ? GNUNET_BLOCK_TYPE_ANY
1296 : pr->public_data.type,
1297 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1299 : 1 /* queue priority */,
1300 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1302 : 1 /* max queue size */,
1303 GNUNET_TIME_UNIT_FOREVER_REL,
1304 &process_local_reply,
1306 /* check if we successfully queued another datastore request;
1307 if so, return, otherwise call our continuation (if we have
1309 check_error_and_continue:
1312 if (GNUNET_SCHEDULER_NO_TASK != pr->warn_task)
1314 GNUNET_SCHEDULER_cancel (pr->warn_task);
1315 pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1317 if (NULL == (cont = pr->llc_cont))
1318 return; /* no continuation */
1319 pr->llc_cont = NULL;
1320 cont (pr->llc_cont_cls,
1327 * Look up the request in the local datastore.
1329 * @param pr the pending request to process
1330 * @param cont function to call at the end
1331 * @param cont_cls closure for cont
1334 GSF_local_lookup_ (struct GSF_PendingRequest *pr,
1335 GSF_LocalLookupContinuation cont,
1338 GNUNET_assert (NULL == pr->gh);
1339 GNUNET_assert (NULL == pr->llc_cont);
1340 pr->llc_cont = cont;
1341 pr->llc_cont_cls = cont_cls;
1342 pr->qe_start = GNUNET_TIME_absolute_get ();
1343 pr->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
1346 pr->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
1347 pr->local_result_offset++,
1348 &pr->public_data.query,
1349 pr->public_data.type == GNUNET_BLOCK_TYPE_FS_DBLOCK
1350 ? GNUNET_BLOCK_TYPE_ANY
1351 : pr->public_data.type,
1352 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1354 : 1 /* queue priority */,
1355 (0 != (GSF_PRO_PRIORITY_UNLIMITED & pr->public_data.options))
1357 : 1 /* max queue size */,
1358 GNUNET_TIME_UNIT_FOREVER_REL,
1359 &process_local_reply,
1363 GNUNET_SCHEDULER_cancel (pr->warn_task);
1364 pr->warn_task = GNUNET_SCHEDULER_NO_TASK;
1365 pr->llc_cont = NULL;
1367 cont (cont_cls, pr, pr->local_result);
1373 * Handle P2P "CONTENT" message. Checks that the message is
1374 * well-formed and then checks if there are any pending requests for
1375 * this content and possibly passes it on (to local clients or other
1376 * peers). Does NOT perform migration (content caching at this peer).
1378 * @param cp the other peer involved (sender or receiver, NULL
1379 * for loopback messages where we are both sender and receiver)
1380 * @param message the actual message
1381 * @return GNUNET_OK if the message was well-formed,
1382 * GNUNET_SYSERR if the message was malformed (close connection,
1383 * do not cache under any circumstances)
1386 GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
1387 const struct GNUNET_MessageHeader *message)
1389 const struct PutMessage *put;
1392 enum GNUNET_BLOCK_Type type;
1393 struct GNUNET_TIME_Absolute expiration;
1394 GNUNET_HashCode query;
1395 struct ProcessReplyClosure prq;
1396 struct GNUNET_TIME_Relative block_time;
1398 struct PutMigrationContext *pmc;
1400 msize = ntohs (message->size);
1401 if (msize < sizeof (struct PutMessage))
1404 return GNUNET_SYSERR;
1406 put = (const struct PutMessage*) message;
1407 dsize = msize - sizeof (struct PutMessage);
1408 type = ntohl (put->type);
1409 expiration = GNUNET_TIME_absolute_ntoh (put->expiration);
1410 if (type == GNUNET_BLOCK_TYPE_FS_ONDEMAND)
1411 return GNUNET_SYSERR;
1413 GNUNET_BLOCK_get_key (GSF_block_ctx,
1419 GNUNET_break_op (0);
1420 return GNUNET_SYSERR;
1422 /* now, lookup 'query' */
1423 prq.data = (const void*) &put[1];
1430 prq.expiration = expiration;
1432 prq.anonymity_level = UINT32_MAX;
1433 prq.request_found = GNUNET_NO;
1434 GNUNET_CONTAINER_multihashmap_get_multiple (pr_map,
1440 GSF_connected_peer_change_preference_ (cp, CONTENT_BANDWIDTH_VALUE + 1000 * prq.priority);
1441 GSF_get_peer_performance_data_ (cp)->trust += prq.priority;
1443 if ( (GNUNET_YES == active_to_migration) &&
1444 (GNUNET_NO == test_put_load_too_high (prq.priority)) )
1447 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1448 "Replicating result for query `%s' with priority %u\n",
1449 GNUNET_h2s (&query),
1452 pmc = GNUNET_malloc (sizeof (struct PutMigrationContext));
1453 pmc->start = GNUNET_TIME_absolute_get ();
1454 pmc->requested = prq.request_found;
1455 GNUNET_PEER_resolve (GSF_get_peer_performance_data_ (cp)->pid,
1458 GNUNET_DATASTORE_put (GSF_dsh,
1459 0, &query, dsize, &put[1],
1460 type, prq.priority, 1 /* anonymity */,
1461 0 /* replication */,
1463 1 + prq.priority, MAX_DATASTORE_QUEUE,
1464 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1465 &put_migration_continuation,
1468 put_migration_continuation (pmc, GNUNET_NO, NULL);
1474 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1475 "Choosing not to keep content `%s' (%d/%d)\n",
1476 GNUNET_h2s (&query),
1477 active_to_migration,
1478 test_put_load_too_high (prq.priority));
1481 putl = GNUNET_LOAD_get_load (datastore_put_load);
1482 if ( (NULL != (cp = prq.sender)) &&
1483 (GNUNET_NO == prq.request_found) &&
1484 ( (GNUNET_YES != active_to_migration) ||
1485 (putl > 2.5 * (1 + prq.priority)) ) )
1487 if (GNUNET_YES != active_to_migration)
1488 putl = 1.0 + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 5);
1489 block_time = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1490 5000 + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1491 (unsigned int) (60000 * putl * putl)));
1492 GSF_block_peer_migration_ (cp, block_time);
1499 * Setup the subsystem.
1502 GSF_pending_request_init_ ()
1505 GNUNET_CONFIGURATION_get_value_number (GSF_cfg,
1507 "MAX_PENDING_REQUESTS",
1508 &max_pending_requests))
1510 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1511 _("Configuration fails to specify `%s', assuming default value."),
1512 "MAX_PENDING_REQUESTS");
1514 active_to_migration = GNUNET_CONFIGURATION_get_value_yesno (GSF_cfg,
1517 datastore_put_load = GNUNET_LOAD_value_init (DATASTORE_LOAD_AUTODECLINE);
1518 pr_map = GNUNET_CONTAINER_multihashmap_create (32 * 1024);
1519 requests_by_expiration_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1524 * Shutdown the subsystem.
1527 GSF_pending_request_done_ ()
1529 GNUNET_CONTAINER_multihashmap_iterate (pr_map,
1532 GNUNET_CONTAINER_multihashmap_destroy (pr_map);
1534 GNUNET_CONTAINER_heap_destroy (requests_by_expiration_heap);
1535 requests_by_expiration_heap = NULL;
1536 GNUNET_LOAD_value_free (datastore_put_load);
1537 datastore_put_load = NULL;
1541 /* end of gnunet-service-fs_pr.c */