2 This file is part of GNUnet.
3 (C) 2009, 2010 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 2, 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.c
23 * @brief gnunet anonymity protocol implementation
24 * @author Christian Grothoff
27 * - have non-zero preference / priority for requests we initiate!
28 * - track stats for hot-path routing
29 * - implement hot-path routing decision procedure
30 * - implement: bound_priority, test_load_too_high, validate_skblock
31 * - add content migration support (store locally)
36 #include "gnunet_constants.h"
37 #include "gnunet_core_service.h"
38 #include "gnunet_datastore_service.h"
39 #include "gnunet_peer_lib.h"
40 #include "gnunet_protocols.h"
41 #include "gnunet_signatures.h"
42 #include "gnunet_util_lib.h"
43 #include "gnunet-service-fs_drq.h"
44 #include "gnunet-service-fs_indexing.h"
47 #define DEBUG_FS GNUNET_YES
50 * Maximum number of outgoing messages we queue per peer.
51 * FIXME: set to a tiny value for testing; make configurable.
53 #define MAX_QUEUE_PER_PEER 2
57 * Maximum number of requests (from other peers) that we're
58 * willing to have pending at any given point in time.
59 * FIXME: set from configuration (and 32 is a tiny value for testing only).
61 static uint64_t max_pending_requests = 32;
65 * Information we keep for each pending reply. The
66 * actual message follows at the end of this struct.
68 struct PendingMessage;
72 * Function called upon completion of a transmission.
75 * @param pid ID of receiving peer, 0 on transmission error
77 typedef void (*TransmissionContinuation)(void * cls,
82 * Information we keep for each pending message (GET/PUT). The
83 * actual message follows at the end of this struct.
88 * This is a doubly-linked list of messages to the same peer.
90 struct PendingMessage *next;
93 * This is a doubly-linked list of messages to the same peer.
95 struct PendingMessage *prev;
98 * Entry in pending message list for this pending message.
100 struct PendingMessageList *pml;
103 * Function to call immediately once we have transmitted this
106 TransmissionContinuation cont;
114 * Size of the reply; actual reply message follows
115 * at the end of this struct.
120 * How important is this message for us?
128 * Information about a peer that we are connected to.
129 * We track data that is useful for determining which
130 * peers should receive our requests. We also keep
131 * a list of messages to transmit to this peer.
137 * List of the last clients for which this peer successfully
140 struct GNUNET_SERVER_Client *last_client_replies[CS2P_SUCCESS_LIST_SIZE];
143 * List of the last PIDs for which
144 * this peer successfully answered a query;
145 * We use 0 to indicate no successful reply.
147 GNUNET_PEER_Id last_p2p_replies[P2P_SUCCESS_LIST_SIZE];
150 * Average delay between sending the peer a request and
151 * getting a reply (only calculated over the requests for
152 * which we actually got a reply). Calculated
153 * as a moving average: new_delay = ((n-1)*last_delay+curr_delay) / n
155 struct GNUNET_TIME_Relative avg_delay;
158 * Handle for an active request for transmission to this
161 struct GNUNET_CORE_TransmitHandle *cth;
164 * Messages (replies, queries, content migration) we would like to
165 * send to this peer in the near future. Sorted by priority, head.
167 struct PendingMessage *pending_messages_head;
170 * Messages (replies, queries, content migration) we would like to
171 * send to this peer in the near future. Sorted by priority, tail.
173 struct PendingMessage *pending_messages_tail;
176 * Average priority of successful replies. Calculated
177 * as a moving average: new_avg = ((n-1)*last_avg+curr_prio) / n
182 * Increase in traffic preference still to be submitted
183 * to the core service for this peer. FIXME: double or 'uint64_t'?
185 double inc_preference;
188 * The peer's identity.
193 * Size of the linked list of 'pending_messages'.
195 unsigned int pending_requests;
198 * Which offset in "last_p2p_replies" will be updated next?
199 * (we go round-robin).
201 unsigned int last_p2p_replies_woff;
204 * Which offset in "last_client_replies" will be updated next?
205 * (we go round-robin).
207 unsigned int last_client_replies_woff;
213 * Information we keep for each pending request. We should try to
214 * keep this struct as small as possible since its memory consumption
215 * is key to how many requests we can have pending at once.
217 struct PendingRequest;
221 * Doubly-linked list of requests we are performing
222 * on behalf of the same client.
224 struct ClientRequestList
228 * This is a doubly-linked list.
230 struct ClientRequestList *next;
233 * This is a doubly-linked list.
235 struct ClientRequestList *prev;
238 * Request this entry represents.
240 struct PendingRequest *req;
243 * Client list this request belongs to.
245 struct ClientList *client_list;
251 * Replies to be transmitted to the client. The actual
252 * response message is allocated after this struct.
254 struct ClientResponseMessage
257 * This is a doubly-linked list.
259 struct ClientResponseMessage *next;
262 * This is a doubly-linked list.
264 struct ClientResponseMessage *prev;
267 * Client list entry this response belongs to.
269 struct ClientList *client_list;
272 * Number of bytes in the response.
279 * Linked list of clients we are performing requests
285 * This is a linked list.
287 struct ClientList *next;
290 * ID of a client making a request, NULL if this entry is for a
293 struct GNUNET_SERVER_Client *client;
296 * Head of list of requests performed on behalf
297 * of this client right now.
299 struct ClientRequestList *rl_head;
302 * Tail of list of requests performed on behalf
303 * of this client right now.
305 struct ClientRequestList *rl_tail;
308 * Head of linked list of responses.
310 struct ClientResponseMessage *res_head;
313 * Tail of linked list of responses.
315 struct ClientResponseMessage *res_tail;
318 * Context for sending replies.
320 struct GNUNET_CONNECTION_TransmitHandle *th;
326 * Doubly-linked list of messages we are performing
327 * due to a pending request.
329 struct PendingMessageList
333 * This is a doubly-linked list of messages on behalf of the same request.
335 struct PendingMessageList *next;
338 * This is a doubly-linked list of messages on behalf of the same request.
340 struct PendingMessageList *prev;
343 * Message this entry represents.
345 struct PendingMessage *pm;
348 * Request this entry belongs to.
350 struct PendingRequest *req;
353 * Peer this message is targeted for.
355 struct ConnectedPeer *target;
361 * Information we keep for each pending request. We should try to
362 * keep this struct as small as possible since its memory consumption
363 * is key to how many requests we can have pending at once.
365 struct PendingRequest
369 * If this request was made by a client, this is our entry in the
370 * client request list; otherwise NULL.
372 struct ClientRequestList *client_request_list;
375 * Entry of peer responsible for this entry (if this request
376 * was made by a peer).
378 struct ConnectedPeer *cp;
381 * If this is a namespace query, pointer to the hash of the public
382 * key of the namespace; otherwise NULL. Pointer will be to the
383 * end of this struct (so no need to free it).
385 const GNUNET_HashCode *namespace;
388 * Bloomfilter we use to filter out replies that we don't care about
389 * (anymore). NULL as long as we are interested in all replies.
391 struct GNUNET_CONTAINER_BloomFilter *bf;
394 * Context of our GNUNET_CORE_peer_change_preference call.
396 struct GNUNET_CORE_InformationRequestContext *irc;
399 * Hash code of all replies that we have seen so far (only valid
400 * if client is not NULL since we only track replies like this for
403 GNUNET_HashCode *replies_seen;
406 * Node in the heap representing this entry; NULL
407 * if we have no heap node.
409 struct GNUNET_CONTAINER_HeapNode *hnode;
412 * Head of list of messages being performed on behalf of this
415 struct PendingMessageList *pending_head;
418 * Tail of list of messages being performed on behalf of this
421 struct PendingMessageList *pending_tail;
424 * When did we first see this request (form this peer), or, if our
425 * client is initiating, when did we last initiate a search?
427 struct GNUNET_TIME_Absolute start_time;
430 * The query that this request is for.
432 GNUNET_HashCode query;
435 * The task responsible for transmitting queries
438 GNUNET_SCHEDULER_TaskIdentifier task;
441 * (Interned) Peer identifier that identifies a preferred target
444 GNUNET_PEER_Id target_pid;
447 * (Interned) Peer identifiers of peers that have already
448 * received our query for this content.
450 GNUNET_PEER_Id *used_pids;
453 * Our entry in the DRQ (non-NULL while we wait for our
454 * turn to interact with the local database).
456 struct DatastoreRequestQueue *drq;
459 * Size of the 'bf' (in bytes).
464 * Desired anonymity level; only valid for requests from a local client.
466 uint32_t anonymity_level;
469 * How many entries in "used_pids" are actually valid?
471 unsigned int used_pids_off;
474 * How long is the "used_pids" array?
476 unsigned int used_pids_size;
479 * Number of results found for this request.
481 unsigned int results_found;
484 * How many entries in "replies_seen" are actually valid?
486 unsigned int replies_seen_off;
489 * How long is the "replies_seen" array?
491 unsigned int replies_seen_size;
494 * Priority with which this request was made. If one of our clients
495 * made the request, then this is the current priority that we are
496 * using when initiating the request. This value is used when
497 * we decide to reward other peers with trust for providing a reply.
502 * Priority points left for us to spend when forwarding this request
505 uint32_t remaining_priority;
508 * Number to mingle hashes for bloom-filter tests with.
513 * TTL with which we saw this request (or, if we initiated, TTL that
514 * we used for the request).
519 * Type of the content that this request is for.
529 static struct GNUNET_SCHEDULER_Handle *sched;
534 static const struct GNUNET_CONFIGURATION_Handle *cfg;
537 * Map of peer identifiers to "struct ConnectedPeer" (for that peer).
539 static struct GNUNET_CONTAINER_MultiHashMap *connected_peers;
542 * Map of peer identifiers to "struct PendingRequest" (for that peer).
544 static struct GNUNET_CONTAINER_MultiHashMap *peer_request_map;
547 * Map of query identifiers to "struct PendingRequest" (for that query).
549 static struct GNUNET_CONTAINER_MultiHashMap *query_request_map;
552 * Heap with the request that will expire next at the top. Contains
553 * pointers of type "struct PendingRequest*"; these will *also* be
554 * aliased from the "requests_by_peer" data structures and the
555 * "requests_by_query" table. Note that requests from our clients
556 * don't expire and are thus NOT in the "requests_by_expiration"
557 * (or the "requests_by_peer" tables).
559 static struct GNUNET_CONTAINER_Heap *requests_by_expiration_heap;
562 * Linked list of clients we are currently processing requests for.
564 struct ClientList *client_list;
567 * Pointer to handle to the core service (points to NULL until we've
570 struct GNUNET_CORE_Handle *core;
573 /* ******************* clean up functions ************************ */
577 * We're done with a particular message list entry.
578 * Free all associated resources.
580 * @param pml entry to destroy
583 destroy_pending_message_list_entry (struct PendingMessageList *pml)
585 GNUNET_CONTAINER_DLL_remove (pml->req->pending_head,
586 pml->req->pending_tail,
588 GNUNET_CONTAINER_DLL_remove (pml->target->pending_messages_head,
589 pml->target->pending_messages_tail,
591 pml->target->pending_requests--;
592 GNUNET_free (pml->pm);
598 * Destroy the given pending message (and call the respective
601 * @param pm message to destroy
602 * @param tpid id of peer that the message was delivered to, or 0 for none
605 destroy_pending_message (struct PendingMessage *pm,
608 struct PendingMessageList *pml = pm->pml;
609 TransmissionContinuation cont;
612 GNUNET_assert (pml->pm == pm);
613 GNUNET_assert ( (tpid == 0) || (tpid == pml->target->pid) );
615 cont_cls = pm->cont_cls;
616 destroy_pending_message_list_entry (pml);
622 * We're done processing a particular request.
623 * Free all associated resources.
625 * @param pr request to destroy
628 destroy_pending_request (struct PendingRequest *pr)
630 struct GNUNET_PeerIdentity pid;
632 if (pr->hnode != NULL)
634 GNUNET_CONTAINER_heap_remove_node (requests_by_expiration_heap,
638 /* might have already been removed from map in 'process_reply' (if
639 there was a unique reply) or never inserted if it was a
640 duplicate; hence ignore the return value here */
641 (void) GNUNET_CONTAINER_multihashmap_remove (query_request_map,
646 GNUNET_FS_drq_get_cancel (pr->drq);
649 if (pr->client_request_list != NULL)
651 GNUNET_CONTAINER_DLL_remove (pr->client_request_list->client_list->rl_head,
652 pr->client_request_list->client_list->rl_tail,
653 pr->client_request_list);
654 GNUNET_free (pr->client_request_list);
655 pr->client_request_list = NULL;
659 GNUNET_PEER_resolve (pr->cp->pid,
661 (void) GNUNET_CONTAINER_multihashmap_remove (peer_request_map,
668 GNUNET_CONTAINER_bloomfilter_free (pr->bf);
673 GNUNET_CORE_peer_change_preference_cancel (pr->irc);
676 if (pr->replies_seen != NULL)
678 GNUNET_free (pr->replies_seen);
679 pr->replies_seen = NULL;
681 if (pr->task != GNUNET_SCHEDULER_NO_TASK)
683 GNUNET_SCHEDULER_cancel (sched,
685 pr->task = GNUNET_SCHEDULER_NO_TASK;
687 while (NULL != pr->pending_head)
688 destroy_pending_message_list_entry (pr->pending_head);
689 GNUNET_PEER_change_rc (pr->target_pid, -1);
690 if (pr->used_pids != NULL)
692 GNUNET_PEER_decrement_rcs (pr->used_pids, pr->used_pids_off);
693 GNUNET_free (pr->used_pids);
694 pr->used_pids_off = 0;
695 pr->used_pids_size = 0;
696 pr->used_pids = NULL;
703 * Method called whenever a given peer connects.
705 * @param cls closure, not used
706 * @param peer peer identity this notification is about
707 * @param latency reported latency of the connection with 'other'
708 * @param distance reported distance (DV) to 'other'
711 peer_connect_handler (void *cls,
713 GNUNET_PeerIdentity * peer,
714 struct GNUNET_TIME_Relative latency,
717 struct ConnectedPeer *cp;
719 cp = GNUNET_malloc (sizeof (struct ConnectedPeer));
720 cp->pid = GNUNET_PEER_intern (peer);
721 GNUNET_CONTAINER_multihashmap_put (connected_peers,
724 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
729 * Free (each) request made by the peer.
731 * @param cls closure, points to peer that the request belongs to
732 * @param key current key code
733 * @param value value in the hash map
734 * @return GNUNET_YES (we should continue to iterate)
737 destroy_request (void *cls,
738 const GNUNET_HashCode * key,
741 const struct GNUNET_PeerIdentity * peer = cls;
742 struct PendingRequest *pr = value;
744 GNUNET_CONTAINER_multihashmap_remove (peer_request_map,
747 destroy_pending_request (pr);
753 * Method called whenever a peer disconnects.
755 * @param cls closure, not used
756 * @param peer peer identity this notification is about
759 peer_disconnect_handler (void *cls,
761 GNUNET_PeerIdentity * peer)
763 struct ConnectedPeer *cp;
764 struct PendingMessage *pm;
767 GNUNET_CONTAINER_multihashmap_get_multiple (peer_request_map,
771 cp = GNUNET_CONTAINER_multihashmap_get (connected_peers,
775 for (i=0;i<CS2P_SUCCESS_LIST_SIZE;i++)
777 if (NULL != cp->last_client_replies[i])
779 GNUNET_SERVER_client_drop (cp->last_client_replies[i]);
780 cp->last_client_replies[i] = NULL;
783 GNUNET_CONTAINER_multihashmap_remove (connected_peers,
786 GNUNET_PEER_change_rc (cp->pid, -1);
787 GNUNET_PEER_decrement_rcs (cp->last_p2p_replies, P2P_SUCCESS_LIST_SIZE);
789 GNUNET_CORE_notify_transmit_ready_cancel (cp->cth);
790 while (NULL != (pm = cp->pending_messages_head))
791 destroy_pending_message (pm, 0 /* delivery failed */);
792 GNUNET_break (0 == cp->pending_requests);
798 * Iterator over hash map entries that removes all occurences
799 * of the given 'client' from the 'last_client_replies' of the
800 * given connected peer.
802 * @param cls closure, the 'struct GNUNET_SERVER_Client*' to remove
803 * @param key current key code (unused)
804 * @param value value in the hash map (the 'struct ConnectedPeer*' to change)
805 * @return GNUNET_YES (we should continue to iterate)
808 remove_client_from_last_client_replies (void *cls,
809 const GNUNET_HashCode * key,
812 struct GNUNET_SERVER_Client *client = cls;
813 struct ConnectedPeer *cp = value;
816 for (i=0;i<CS2P_SUCCESS_LIST_SIZE;i++)
818 if (cp->last_client_replies[i] == client)
820 GNUNET_SERVER_client_drop (cp->last_client_replies[i]);
821 cp->last_client_replies[i] = NULL;
829 * A client disconnected. Remove all of its pending queries.
831 * @param cls closure, NULL
832 * @param client identification of the client
835 handle_client_disconnect (void *cls,
836 struct GNUNET_SERVER_Client
839 struct ClientList *pos;
840 struct ClientList *prev;
841 struct ClientRequestList *rcl;
842 struct ClientResponseMessage *creply;
848 while ( (NULL != pos) &&
849 (pos->client != client) )
855 return; /* no requests pending for this client */
856 while (NULL != (rcl = pos->rl_head))
857 destroy_pending_request (rcl->req);
859 client_list = pos->next;
861 prev->next = pos->next;
864 GNUNET_CONNECTION_notify_transmit_ready_cancel (pos->th);
867 while (NULL != (creply = pos->res_head))
869 GNUNET_CONTAINER_DLL_remove (pos->res_head,
872 GNUNET_free (creply);
874 GNUNET_SERVER_client_drop (pos->client);
876 GNUNET_CONTAINER_multihashmap_iterate (connected_peers,
877 &remove_client_from_last_client_replies,
883 * Iterator to free peer entries.
885 * @param cls closure, unused
886 * @param key current key code
887 * @param value value in the hash map (peer entry)
888 * @return GNUNET_YES (we should continue to iterate)
891 clean_peer (void *cls,
892 const GNUNET_HashCode * key,
895 peer_disconnect_handler (NULL, (const struct GNUNET_PeerIdentity*) key);
901 * Task run during shutdown.
907 shutdown_task (void *cls,
908 const struct GNUNET_SCHEDULER_TaskContext *tc)
910 while (client_list != NULL)
911 handle_client_disconnect (NULL,
912 client_list->client);
913 GNUNET_CONTAINER_multihashmap_iterate (connected_peers,
916 GNUNET_break (0 == GNUNET_CONTAINER_heap_get_size (requests_by_expiration_heap));
917 GNUNET_CONTAINER_heap_destroy (requests_by_expiration_heap);
918 requests_by_expiration_heap = 0;
919 GNUNET_CONTAINER_multihashmap_destroy (connected_peers);
920 connected_peers = NULL;
921 GNUNET_break (0 == GNUNET_CONTAINER_multihashmap_size (query_request_map));
922 GNUNET_CONTAINER_multihashmap_destroy (query_request_map);
923 query_request_map = NULL;
924 GNUNET_break (0 == GNUNET_CONTAINER_multihashmap_size (peer_request_map));
925 GNUNET_CONTAINER_multihashmap_destroy (peer_request_map);
926 peer_request_map = NULL;
927 GNUNET_assert (NULL != core);
928 GNUNET_CORE_disconnect (core);
935 /* ******************* Utility functions ******************** */
939 * Transmit the given message by copying it to the target buffer
940 * "buf". "buf" will be NULL and "size" zero if the socket was closed
941 * for writing in the meantime. In that case, do nothing
942 * (the disconnect or shutdown handler will take care of the rest).
943 * If we were able to transmit messages and there are still more
944 * pending, ask core again for further calls to this function.
946 * @param cls closure, pointer to the 'struct ConnectedPeer*'
947 * @param size number of bytes available in buf
948 * @param buf where the callee should write the message
949 * @return number of bytes written to buf
952 transmit_to_peer (void *cls,
953 size_t size, void *buf)
955 struct ConnectedPeer *cp = cls;
957 struct GNUNET_PeerIdentity pid;
958 struct PendingMessage *pm;
965 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
966 "Dropping message, core too busy.\n");
971 while ( (NULL != (pm = cp->pending_messages_head) ) &&
972 (pm->msize <= size) )
974 memcpy (&cbuf[msize], &pm[1], pm->msize);
977 destroy_pending_message (pm, cp->pid);
981 GNUNET_PEER_resolve (cp->pid,
983 cp->cth = GNUNET_CORE_notify_transmit_ready (core,
985 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
992 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
993 "Transmitting %u bytes to peer %u.\n",
1002 * Add a message to the set of pending messages for the given peer.
1004 * @param cp peer to send message to
1005 * @param pm message to queue
1006 * @param pr request on which behalf this message is being queued
1009 add_to_pending_messages_for_peer (struct ConnectedPeer *cp,
1010 struct PendingMessage *pm,
1011 struct PendingRequest *pr)
1013 struct PendingMessage *pos;
1014 struct PendingMessageList *pml;
1015 struct GNUNET_PeerIdentity pid;
1017 GNUNET_assert (pm->next == NULL);
1018 GNUNET_assert (pm->pml == NULL);
1019 pml = GNUNET_malloc (sizeof (struct PendingMessageList));
1024 GNUNET_CONTAINER_DLL_insert (pr->pending_head,
1027 pos = cp->pending_messages_head;
1028 while ( (pos != NULL) &&
1029 (pm->priority < pos->priority) )
1031 GNUNET_CONTAINER_DLL_insert_after (cp->pending_messages_head,
1032 cp->pending_messages_tail,
1035 cp->pending_requests++;
1036 if (cp->pending_requests > MAX_QUEUE_PER_PEER)
1037 destroy_pending_message (cp->pending_messages_tail, 0);
1038 if (cp->cth == NULL)
1040 /* need to schedule transmission */
1041 GNUNET_PEER_resolve (cp->pid, &pid);
1042 cp->cth = GNUNET_CORE_notify_transmit_ready (core,
1043 cp->pending_messages_head->priority,
1044 GNUNET_TIME_UNIT_FOREVER_REL,
1046 cp->pending_messages_head->msize,
1050 if (cp->cth == NULL)
1053 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1054 "Failed to schedule transmission with core!\n");
1056 /* FIXME: call stats (rare, bad case) */
1062 * Mingle hash with the mingle_number to produce different bits.
1065 mingle_hash (const GNUNET_HashCode * in,
1066 int32_t mingle_number,
1067 GNUNET_HashCode * hc)
1071 GNUNET_CRYPTO_hash (&mingle_number,
1074 GNUNET_CRYPTO_hash_xor (&m, in, hc);
1079 * Test if the load on this peer is too high
1080 * to even consider processing the query at
1083 * @return GNUNET_YES if the load is too high, GNUNET_NO otherwise
1086 test_load_too_high ()
1088 return GNUNET_NO; // FIXME
1092 /* ******************* Pending Request Refresh Task ******************** */
1096 * Function called after we either failed or succeeded
1097 * at transmitting a query to a peer.
1099 * @param cls the requests "struct PendingRequest*"
1100 * @param tpid ID of receiving peer, 0 on transmission error
1103 transmit_query_continuation (void *cls,
1104 GNUNET_PEER_Id tpid)
1106 struct PendingRequest *pr = cls;
1110 GNUNET_PEER_change_rc (tpid, 1);
1111 if (pr->used_pids_off == pr->used_pids_size)
1112 GNUNET_array_grow (pr->used_pids,
1114 pr->used_pids_size * 2 + 2);
1115 pr->used_pids[pr->used_pids_off++] = tpid;
1120 * How many bytes should a bloomfilter be if we have already seen
1121 * entry_count responses? Note that BLOOMFILTER_K gives us the number
1122 * of bits set per entry. Furthermore, we should not re-size the
1123 * filter too often (to keep it cheap).
1125 * Since other peers will also add entries but not resize the filter,
1126 * we should generally pick a slightly larger size than what the
1127 * strict math would suggest.
1129 * @return must be a power of two and smaller or equal to 2^15.
1132 compute_bloomfilter_size (unsigned int entry_count)
1135 unsigned int ideal = (entry_count * BLOOMFILTER_K) / 4;
1136 uint16_t max = 1 << 15;
1138 if (entry_count > max)
1141 while ((size < max) && (size < ideal))
1150 * Recalculate our bloom filter for filtering replies.
1152 * @param count number of entries we are filtering right now
1153 * @param mingle set to our new mingling value
1154 * @param bf_size set to the size of the bloomfilter
1155 * @param entries the entries to filter
1156 * @return updated bloomfilter, NULL for none
1158 static struct GNUNET_CONTAINER_BloomFilter *
1159 refresh_bloomfilter (unsigned int count,
1162 const GNUNET_HashCode *entries)
1164 struct GNUNET_CONTAINER_BloomFilter *bf;
1167 GNUNET_HashCode mhash;
1171 nsize = compute_bloomfilter_size (count);
1172 *mingle = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, -1);
1174 bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
1177 for (i=0;i<count;i++)
1179 mingle_hash (&entries[i], *mingle, &mhash);
1180 GNUNET_CONTAINER_bloomfilter_add (bf, &mhash);
1187 * We use a random delay to make the timing of requests less
1188 * predictable. This function returns such a random delay.
1190 * FIXME: make schedule dependent on the specifics of the request?
1191 * Or bandwidth and number of connected peers and load?
1193 * @return random delay to use for some request, between 0 and TTL_DECREMENT ms
1195 static struct GNUNET_TIME_Relative
1196 get_processing_delay ()
1198 return GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1199 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1205 * Function called after we've tried to reserve a certain amount of
1206 * bandwidth for a reply. Check if we succeeded and if so send our
1209 * @param cls the requests "struct PendingRequest*"
1210 * @param peer identifies the peer
1211 * @param bpm_in set to the current bandwidth limit (receiving) for this peer
1212 * @param bpm_out set to the current bandwidth limit (sending) for this peer
1213 * @param amount set to the amount that was actually reserved or unreserved
1214 * @param preference current traffic preference for the given peer
1217 target_reservation_cb (void *cls,
1219 GNUNET_PeerIdentity * peer,
1220 unsigned int bpm_in,
1221 unsigned int bpm_out,
1223 uint64_t preference)
1225 struct PendingRequest *pr = cls;
1226 struct ConnectedPeer *cp;
1227 struct PendingMessage *pm;
1228 struct GetMessage *gm;
1229 GNUNET_HashCode *ext;
1237 GNUNET_assert (peer != NULL);
1238 // (3) transmit, update ttl/priority
1239 cp = GNUNET_CONTAINER_multihashmap_get (connected_peers,
1243 /* Peer must have just left */
1245 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1246 "Selected peer disconnected!\n");
1250 no_route = GNUNET_NO;
1251 /* FIXME: check against DBLOCK_SIZE and possibly return
1252 amount to reserve; however, this also needs to work
1253 with testcases which currently start out with a far
1254 too low per-peer bw limit, so they would never send
1255 anything. Big issue. */
1261 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1262 "Failed to reserve bandwidth for reply (got %d/%u bytes only)!\n",
1266 return; /* this target round failed */
1268 /* FIXME: if we are "quite" busy, we may still want to skip
1269 this round; need more load detection code! */
1270 no_route = GNUNET_YES;
1273 /* build message and insert message into priority queue */
1275 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1276 "Forwarding request `%s' to `%4s'!\n",
1277 GNUNET_h2s (&pr->query),
1282 if (GNUNET_YES == no_route)
1284 bm |= GET_MESSAGE_BIT_RETURN_TO;
1287 if (pr->namespace != NULL)
1289 bm |= GET_MESSAGE_BIT_SKS_NAMESPACE;
1292 if (pr->target_pid != 0)
1294 bm |= GET_MESSAGE_BIT_TRANSMIT_TO;
1297 msize = sizeof (struct GetMessage) + pr->bf_size + k * sizeof(GNUNET_HashCode);
1298 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
1299 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1301 gm = (struct GetMessage*) &pm[1];
1302 gm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_GET);
1303 gm->header.size = htons (msize);
1304 gm->type = htonl (pr->type);
1305 pr->remaining_priority /= 2;
1306 gm->priority = htonl (pr->remaining_priority);
1307 gm->ttl = htonl (pr->ttl);
1308 gm->filter_mutator = htonl(pr->mingle);
1309 gm->hash_bitmap = htonl (bm);
1310 gm->query = pr->query;
1311 ext = (GNUNET_HashCode*) &gm[1];
1313 if (GNUNET_YES == no_route)
1314 GNUNET_PEER_resolve (pr->cp->pid, (struct GNUNET_PeerIdentity*) &ext[k++]);
1315 if (pr->namespace != NULL)
1316 memcpy (&ext[k++], pr->namespace, sizeof (GNUNET_HashCode));
1317 if (pr->target_pid != 0)
1318 GNUNET_PEER_resolve (pr->target_pid, (struct GNUNET_PeerIdentity*) &ext[k++]);
1319 bfdata = (char *) &ext[k];
1321 GNUNET_CONTAINER_bloomfilter_get_raw_data (pr->bf,
1324 pm->cont = &transmit_query_continuation;
1326 add_to_pending_messages_for_peer (cp, pm, pr);
1331 * Closure used for "target_peer_select_cb".
1333 struct PeerSelectionContext
1336 * The request for which we are selecting
1339 struct PendingRequest *pr;
1342 * Current "prime" target.
1344 struct GNUNET_PeerIdentity target;
1347 * How much do we like this target?
1349 double target_score;
1355 * Function called for each connected peer to determine
1356 * which one(s) would make good targets for forwarding.
1358 * @param cls closure (struct PeerSelectionContext)
1359 * @param key current key code (peer identity)
1360 * @param value value in the hash map (struct ConnectedPeer)
1361 * @return GNUNET_YES if we should continue to
1366 target_peer_select_cb (void *cls,
1367 const GNUNET_HashCode * key,
1370 struct PeerSelectionContext *psc = cls;
1371 struct ConnectedPeer *cp = value;
1372 struct PendingRequest *pr = psc->pr;
1376 /* 1) check if we have already (recently) forwarded to this peer */
1377 for (i=0;i<pr->used_pids_off;i++)
1378 if (pr->used_pids[i] == cp->pid)
1379 return GNUNET_YES; /* skip */
1380 // 2) calculate how much we'd like to forward to this peer
1381 score = 42; // FIXME!
1382 // FIXME: also need API to gather data on responsiveness
1383 // of this peer (we have fields for that in 'cp', but
1384 // they are never set!)
1386 /* store best-fit in closure */
1387 if (score > psc->target_score)
1389 psc->target_score = score;
1390 psc->target.hashPubKey = *key;
1397 * We're processing a GET request from another peer and have decided
1398 * to forward it to other peers. This function is called periodically
1399 * and should forward the request to other peers until we have all
1400 * possible replies. If we have transmitted the *only* reply to
1401 * the initiator we should destroy the pending request. If we have
1402 * many replies in the queue to the initiator, we should delay sending
1403 * out more queries until the reply queue has shrunk some.
1405 * @param cls our "struct ProcessGetContext *"
1409 forward_request_task (void *cls,
1410 const struct GNUNET_SCHEDULER_TaskContext *tc)
1412 struct PendingRequest *pr = cls;
1413 struct PeerSelectionContext psc;
1414 struct ConnectedPeer *cp;
1416 pr->task = GNUNET_SCHEDULER_add_delayed (sched,
1417 get_processing_delay (),
1418 &forward_request_task,
1420 if (pr->irc != NULL)
1421 return; /* previous request still pending */
1422 /* (1) select target */
1424 psc.target_score = DBL_MIN;
1425 GNUNET_CONTAINER_multihashmap_iterate (connected_peers,
1426 &target_peer_select_cb,
1428 if (psc.target_score == DBL_MIN)
1431 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1432 "No peer selected for forwarding!\n");
1434 return; /* nobody selected */
1437 /* (2) reserve reply bandwidth */
1438 cp = GNUNET_CONTAINER_multihashmap_get (connected_peers,
1439 &psc.target.hashPubKey);
1440 pr->irc = GNUNET_CORE_peer_change_preference (sched, cfg,
1442 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1443 (uint32_t) -1 /* no limit */,
1445 (uint64_t) cp->inc_preference,
1446 &target_reservation_cb,
1448 cp->inc_preference = 0.0;
1452 /* **************************** P2P PUT Handling ************************ */
1456 * Function called after we either failed or succeeded
1457 * at transmitting a reply to a peer.
1459 * @param cls the requests "struct PendingRequest*"
1460 * @param tpid ID of receiving peer, 0 on transmission error
1463 transmit_reply_continuation (void *cls,
1464 GNUNET_PEER_Id tpid)
1466 struct PendingRequest *pr = cls;
1470 case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
1471 case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
1472 /* only one reply expected, done with the request! */
1473 destroy_pending_request (pr);
1475 case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
1476 case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
1486 * Check if the given KBlock is well-formed.
1488 * @param kb the kblock data (or at least "dsize" bytes claiming to be one)
1489 * @param dsize size of "kb" in bytes; check for < sizeof(struct KBlock)!
1490 * @param query where to store the query that this block answers
1491 * @return GNUNET_OK if this is actually a well-formed KBlock
1494 check_kblock (const struct KBlock *kb,
1496 GNUNET_HashCode *query)
1498 if (dsize < sizeof (struct KBlock))
1500 GNUNET_break_op (0);
1501 return GNUNET_SYSERR;
1503 if (dsize - sizeof (struct KBlock) !=
1504 ntohs (kb->purpose.size)
1505 - sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose)
1506 - sizeof(struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) )
1508 GNUNET_break_op (0);
1509 return GNUNET_SYSERR;
1512 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_KBLOCK,
1517 GNUNET_break_op (0);
1518 return GNUNET_SYSERR;
1521 GNUNET_CRYPTO_hash (&kb->keyspace,
1522 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1529 * Check if the given SBlock is well-formed.
1531 * @param sb the sblock data (or at least "dsize" bytes claiming to be one)
1532 * @param dsize size of "kb" in bytes; check for < sizeof(struct SBlock)!
1533 * @param query where to store the query that this block answers
1534 * @param namespace where to store the namespace that this block belongs to
1535 * @return GNUNET_OK if this is actually a well-formed SBlock
1538 check_sblock (const struct SBlock *sb,
1540 GNUNET_HashCode *query,
1541 GNUNET_HashCode *namespace)
1543 if (dsize < sizeof (struct SBlock))
1545 GNUNET_break_op (0);
1546 return GNUNET_SYSERR;
1549 ntohs (sb->purpose.size) + sizeof (struct GNUNET_CRYPTO_RsaSignature))
1551 GNUNET_break_op (0);
1552 return GNUNET_SYSERR;
1555 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_SBLOCK,
1560 GNUNET_break_op (0);
1561 return GNUNET_SYSERR;
1564 *query = sb->identifier;
1565 if (namespace != NULL)
1566 GNUNET_CRYPTO_hash (&sb->subspace,
1567 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1574 * Transmit the given message by copying it to the target buffer
1575 * "buf". "buf" will be NULL and "size" zero if the socket was closed
1576 * for writing in the meantime. In that case, do nothing
1577 * (the disconnect or shutdown handler will take care of the rest).
1578 * If we were able to transmit messages and there are still more
1579 * pending, ask core again for further calls to this function.
1581 * @param cls closure, pointer to the 'struct ClientList*'
1582 * @param size number of bytes available in buf
1583 * @param buf where the callee should write the message
1584 * @return number of bytes written to buf
1587 transmit_to_client (void *cls,
1588 size_t size, void *buf)
1590 struct ClientList *cl = cls;
1592 struct ClientResponseMessage *creply;
1599 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1600 "Not sending reply, client communication problem.\n");
1605 while ( (NULL != (creply = cl->res_head) ) &&
1606 (creply->msize <= size) )
1608 memcpy (&cbuf[msize], &creply[1], creply->msize);
1609 msize += creply->msize;
1610 size -= creply->msize;
1611 GNUNET_CONTAINER_DLL_remove (cl->res_head,
1614 GNUNET_free (creply);
1617 cl->th = GNUNET_SERVER_notify_transmit_ready (cl->client,
1619 GNUNET_TIME_UNIT_FOREVER_REL,
1620 &transmit_to_client,
1623 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1624 "Transmitted %u bytes to client\n",
1625 (unsigned int) msize);
1632 * Closure for "process_reply" function.
1634 struct ProcessReplyClosure
1637 * The data for the reply.
1641 // FIXME: add 'struct ConnectedPeer' to track 'last_xxx_replies' here!
1644 * When the reply expires.
1646 struct GNUNET_TIME_Absolute expiration;
1654 * Namespace that this reply belongs to
1655 * (if it is of type SBLOCK).
1657 GNUNET_HashCode namespace;
1660 * Type of the block.
1665 * How much was this reply worth to us?
1672 * We have received a reply; handle it!
1674 * @param cls response (struct ProcessReplyClosure)
1675 * @param key our query
1676 * @param value value in the hash map (info about the query)
1677 * @return GNUNET_YES (we should continue to iterate)
1680 process_reply (void *cls,
1681 const GNUNET_HashCode * key,
1684 struct ProcessReplyClosure *prq = cls;
1685 struct PendingRequest *pr = value;
1686 struct PendingMessage *reply;
1687 struct ClientResponseMessage *creply;
1688 struct ClientList *cl;
1689 struct PutMessage *pm;
1690 struct ConnectedPeer *cp;
1691 GNUNET_HashCode chash;
1692 GNUNET_HashCode mhash;
1697 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1698 "Matched result (type %u) for query `%s' with pending request\n",
1699 (unsigned int) prq->type,
1702 do_remove = GNUNET_NO;
1703 GNUNET_CRYPTO_hash (prq->data,
1708 case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
1709 case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
1710 /* only possible reply, stop requesting! */
1711 while (NULL != pr->pending_head)
1712 destroy_pending_message_list_entry (pr->pending_head);
1713 if (pr->drq != NULL)
1715 if (pr->client_request_list != NULL)
1716 GNUNET_SERVER_receive_done (pr->client_request_list->client_list->client,
1718 GNUNET_FS_drq_get_cancel (pr->drq);
1721 do_remove = GNUNET_YES;
1723 case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
1724 if (0 != memcmp (pr->namespace,
1726 sizeof (GNUNET_HashCode)))
1727 return GNUNET_YES; /* wrong namespace */
1728 /* then: fall-through! */
1729 case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
1732 mingle_hash (&chash, pr->mingle, &mhash);
1733 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (pr->bf,
1735 return GNUNET_YES; /* duplicate */
1736 GNUNET_CONTAINER_bloomfilter_add (pr->bf,
1739 if (pr->client_request_list != NULL)
1741 if (pr->replies_seen_size == pr->replies_seen_off)
1743 GNUNET_array_grow (pr->replies_seen,
1744 pr->replies_seen_size,
1745 pr->replies_seen_size * 2 + 4);
1747 GNUNET_CONTAINER_bloomfilter_free (pr->bf);
1748 pr->bf = refresh_bloomfilter (pr->replies_seen_off,
1753 pr->replies_seen[pr->replies_seen_off++] = chash;
1757 case GNUNET_DATASTORE_BLOCKTYPE_SKBLOCK:
1758 // FIXME: any checks against duplicates for SKBlocks?
1764 prq->priority += pr->remaining_priority;
1765 pr->remaining_priority = 0;
1766 if (pr->client_request_list != NULL)
1769 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1770 "Transmitting result for query `%s' to local client\n",
1773 cl = pr->client_request_list->client_list;
1774 msize = sizeof (struct PutMessage) + prq->size;
1775 creply = GNUNET_malloc (msize + sizeof (struct ClientResponseMessage));
1776 creply->msize = msize;
1777 creply->client_list = cl;
1778 GNUNET_CONTAINER_DLL_insert_after (cl->res_head,
1782 pm = (struct PutMessage*) &creply[1];
1783 pm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_PUT);
1784 pm->header.size = htons (msize);
1785 pm->type = htonl (prq->type);
1786 pm->expiration = GNUNET_TIME_absolute_hton (prq->expiration);
1787 memcpy (&pm[1], prq->data, prq->size);
1789 cl->th = GNUNET_SERVER_notify_transmit_ready (cl->client,
1791 GNUNET_TIME_UNIT_FOREVER_REL,
1792 &transmit_to_client,
1794 GNUNET_break (cl->th != NULL);
1800 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1801 "Transmitting result for query `%s' to other peer (PID=%u)\n",
1803 (unsigned int) cp->pid);
1805 msize = sizeof (struct PutMessage) + prq->size;
1806 reply = GNUNET_malloc (msize + sizeof (struct PendingMessage));
1807 reply->cont = &transmit_reply_continuation;
1808 reply->cont_cls = pr;
1809 reply->msize = msize;
1810 reply->priority = (uint32_t) -1; /* send replies first! */
1811 pm = (struct PutMessage*) &reply[1];
1812 pm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_PUT);
1813 pm->header.size = htons (msize);
1814 pm->type = htonl (prq->type);
1815 pm->expiration = GNUNET_TIME_absolute_hton (prq->expiration);
1816 memcpy (&pm[1], prq->data, prq->size);
1817 add_to_pending_messages_for_peer (cp, reply, pr);
1819 if (GNUNET_YES == do_remove)
1821 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1822 "Removing request `%s' from request map (has been satisfied)\n",
1824 GNUNET_break (GNUNET_YES ==
1825 GNUNET_CONTAINER_multihashmap_remove (query_request_map,
1828 // FIXME: request somehow does not fully
1829 // disappear; how to fix?
1830 // destroy_pending_request (pr); (not like this!)
1833 // FIXME: implement hot-path routing statistics keeping!
1839 * Handle P2P "PUT" message.
1841 * @param cls closure, always NULL
1842 * @param other the other peer involved (sender or receiver, NULL
1843 * for loopback messages where we are both sender and receiver)
1844 * @param message the actual message
1845 * @param latency reported latency of the connection with 'other'
1846 * @param distance reported distance (DV) to 'other'
1847 * @return GNUNET_OK to keep the connection open,
1848 * GNUNET_SYSERR to close it (signal serious error)
1851 handle_p2p_put (void *cls,
1852 const struct GNUNET_PeerIdentity *other,
1853 const struct GNUNET_MessageHeader *message,
1854 struct GNUNET_TIME_Relative latency,
1857 const struct PutMessage *put;
1861 struct GNUNET_TIME_Absolute expiration;
1862 GNUNET_HashCode query;
1863 struct ProcessReplyClosure prq;
1865 msize = ntohs (message->size);
1866 if (msize < sizeof (struct PutMessage))
1869 return GNUNET_SYSERR;
1871 put = (const struct PutMessage*) message;
1872 dsize = msize - sizeof (struct PutMessage);
1873 type = ntohl (put->type);
1874 expiration = GNUNET_TIME_absolute_ntoh (put->expiration);
1876 /* first, validate! */
1879 case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
1880 case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
1881 GNUNET_CRYPTO_hash (&put[1], dsize, &query);
1883 case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
1885 check_kblock ((const struct KBlock*) &put[1],
1888 return GNUNET_SYSERR;
1890 case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
1892 check_sblock ((const struct SBlock*) &put[1],
1896 return GNUNET_SYSERR;
1898 case GNUNET_DATASTORE_BLOCKTYPE_SKBLOCK:
1899 // FIXME -- validate SKBLOCK!
1903 /* unknown block type */
1904 GNUNET_break_op (0);
1905 return GNUNET_SYSERR;
1909 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1910 "Received result for query `%s' from peer `%4s'\n",
1911 GNUNET_h2s (&query),
1912 GNUNET_i2s (other));
1914 /* now, lookup 'query' */
1915 prq.data = (const void*) &put[1];
1918 prq.expiration = expiration;
1920 GNUNET_CONTAINER_multihashmap_get_multiple (query_request_map,
1924 // FIXME: if migration is on and load is low,
1925 // queue to store data in datastore;
1926 // use "prq.priority" for that!
1931 /* **************************** P2P GET Handling ************************ */
1935 * Closure for 'check_duplicate_request_{peer,client}'.
1937 struct CheckDuplicateRequestClosure
1940 * The new request we should check if it already exists.
1942 const struct PendingRequest *pr;
1945 * Existing request found by the checker, NULL if none.
1947 struct PendingRequest *have;
1952 * Iterator over entries in the 'query_request_map' that
1953 * tries to see if we have the same request pending from
1954 * the same client already.
1956 * @param cls closure (our 'struct CheckDuplicateRequestClosure')
1957 * @param key current key code (query, ignored, must match)
1958 * @param value value in the hash map (a 'struct PendingRequest'
1959 * that already exists)
1960 * @return GNUNET_YES if we should continue to
1961 * iterate (no match yet)
1962 * GNUNET_NO if not (match found).
1965 check_duplicate_request_client (void *cls,
1966 const GNUNET_HashCode * key,
1969 struct CheckDuplicateRequestClosure *cdc = cls;
1970 struct PendingRequest *have = value;
1972 if (have->client_request_list == NULL)
1974 if ( (cdc->pr->client_request_list->client_list->client == have->client_request_list->client_list->client) &&
1985 * We're processing (local) results for a search request
1986 * from another peer. Pass applicable results to the
1987 * peer and if we are done either clean up (operation
1988 * complete) or forward to other peers (more results possible).
1990 * @param cls our closure (struct LocalGetContext)
1991 * @param key key for the content
1992 * @param size number of bytes in data
1993 * @param data content stored
1994 * @param type type of the content
1995 * @param priority priority of the content
1996 * @param anonymity anonymity-level for the content
1997 * @param expiration expiration time for the content
1998 * @param uid unique identifier for the datum;
1999 * maybe 0 if no unique identifier is available
2002 process_local_reply (void *cls,
2003 const GNUNET_HashCode * key,
2009 struct GNUNET_TIME_Absolute
2013 struct PendingRequest *pr = cls;
2014 struct ProcessReplyClosure prq;
2015 struct CheckDuplicateRequestClosure cdrc;
2016 GNUNET_HashCode dhash;
2017 GNUNET_HashCode mhash;
2018 GNUNET_HashCode query;
2023 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2024 "Done processing local replies, forwarding request to other peers.\n");
2027 if (pr->client_request_list != NULL)
2029 GNUNET_SERVER_receive_done (pr->client_request_list->client_list->client,
2031 /* Figure out if this is a duplicate request and possibly
2032 merge 'struct PendingRequest' entries */
2035 GNUNET_CONTAINER_multihashmap_get_multiple (query_request_map,
2037 &check_duplicate_request_client,
2039 if (cdrc.have != NULL)
2042 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2043 "Received request for block `%s' twice from client, will only request once.\n",
2044 GNUNET_h2s (&pr->query));
2047 destroy_pending_request (pr);
2052 /* no more results */
2053 if (pr->task == GNUNET_SCHEDULER_NO_TASK)
2054 pr->task = GNUNET_SCHEDULER_add_now (sched,
2055 &forward_request_task,
2059 if (type == GNUNET_DATASTORE_BLOCKTYPE_ONDEMAND)
2062 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2063 "Found ONDEMAND block, performing on-demand encoding\n");
2066 GNUNET_FS_handle_on_demand_block (key, size, data, type, priority,
2067 anonymity, expiration, uid,
2068 &process_local_reply,
2070 GNUNET_FS_drq_get_next (GNUNET_YES);
2073 /* check for duplicates */
2074 GNUNET_CRYPTO_hash (data, size, &dhash);
2075 mingle_hash (&dhash,
2078 if ( (pr->bf != NULL) &&
2080 GNUNET_CONTAINER_bloomfilter_test (pr->bf,
2084 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2085 "Result from datastore filtered by bloomfilter (duplicate).\n");
2087 GNUNET_FS_drq_get_next (GNUNET_YES);
2091 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2092 "Found result for query `%s' in local datastore\n",
2095 pr->results_found++;
2096 if ( (pr->type == GNUNET_DATASTORE_BLOCKTYPE_KBLOCK) ||
2097 (pr->type == GNUNET_DATASTORE_BLOCKTYPE_SBLOCK) ||
2098 (pr->type == GNUNET_DATASTORE_BLOCKTYPE_SKBLOCK) )
2103 pr->bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
2107 GNUNET_CONTAINER_bloomfilter_add (pr->bf,
2110 memset (&prq, 0, sizeof (prq));
2112 prq.expiration = expiration;
2114 if ( (type == GNUNET_DATASTORE_BLOCKTYPE_SBLOCK) &&
2115 (GNUNET_OK != check_sblock ((const struct SBlock*) data,
2121 /* FIXME: consider removing the block? */
2122 GNUNET_FS_drq_get_next (GNUNET_YES);
2126 prq.priority = priority;
2127 process_reply (&prq, key, pr);
2129 if ( ( (pr->client_request_list == NULL) &&
2130 ( (GNUNET_YES == test_load_too_high()) ||
2131 (pr->results_found > 5 + 2 * pr->priority) ) ) ||
2132 (type == GNUNET_DATASTORE_BLOCKTYPE_DBLOCK) )
2135 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2136 "Unique reply found or load too high, done with request\n");
2138 GNUNET_FS_drq_get_next (GNUNET_NO);
2141 GNUNET_FS_drq_get_next (GNUNET_YES);
2146 * The priority level imposes a bound on the maximum
2147 * value for the ttl that can be requested.
2149 * @param ttl_in requested ttl
2150 * @param prio given priority
2151 * @return ttl_in if ttl_in is below the limit,
2152 * otherwise the ttl-limit for the given priority
2155 bound_ttl (int32_t ttl_in, uint32_t prio)
2157 unsigned long long allowed;
2161 allowed = ((unsigned long long) prio) * TTL_DECREMENT / 1000;
2162 if (ttl_in > allowed)
2164 if (allowed >= (1 << 30))
2173 * We've received a request with the specified priority. Bound it
2174 * according to how much we trust the given peer.
2176 * @param prio_in requested priority
2177 * @param cp the peer making the request
2178 * @return effective priority
2181 bound_priority (uint32_t prio_in,
2182 struct ConnectedPeer *cp)
2189 * Iterator over entries in the 'query_request_map' that
2190 * tries to see if we have the same request pending from
2191 * the same peer already.
2193 * @param cls closure (our 'struct CheckDuplicateRequestClosure')
2194 * @param key current key code (query, ignored, must match)
2195 * @param value value in the hash map (a 'struct PendingRequest'
2196 * that already exists)
2197 * @return GNUNET_YES if we should continue to
2198 * iterate (no match yet)
2199 * GNUNET_NO if not (match found).
2202 check_duplicate_request_peer (void *cls,
2203 const GNUNET_HashCode * key,
2206 struct CheckDuplicateRequestClosure *cdc = cls;
2207 struct PendingRequest *have = value;
2209 if (cdc->pr->target_pid == have->target_pid)
2219 * Handle P2P "GET" request.
2221 * @param cls closure, always NULL
2222 * @param other the other peer involved (sender or receiver, NULL
2223 * for loopback messages where we are both sender and receiver)
2224 * @param message the actual message
2225 * @param latency reported latency of the connection with 'other'
2226 * @param distance reported distance (DV) to 'other'
2227 * @return GNUNET_OK to keep the connection open,
2228 * GNUNET_SYSERR to close it (signal serious error)
2231 handle_p2p_get (void *cls,
2232 const struct GNUNET_PeerIdentity *other,
2233 const struct GNUNET_MessageHeader *message,
2234 struct GNUNET_TIME_Relative latency,
2237 struct PendingRequest *pr;
2238 struct ConnectedPeer *cp;
2239 struct ConnectedPeer *cps;
2240 struct CheckDuplicateRequestClosure cdc;
2241 struct GNUNET_TIME_Relative timeout;
2243 const struct GetMessage *gm;
2245 const GNUNET_HashCode *opt;
2248 uint32_t ttl_decrement;
2253 msize = ntohs(message->size);
2254 if (msize < sizeof (struct GetMessage))
2256 GNUNET_break_op (0);
2257 return GNUNET_SYSERR;
2259 gm = (const struct GetMessage*) message;
2260 type = ntohl (gm->type);
2263 case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
2264 case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
2265 case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
2266 case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
2269 GNUNET_break_op (0);
2270 return GNUNET_SYSERR;
2272 bm = ntohl (gm->hash_bitmap);
2280 if (msize < sizeof (struct GetMessage) + bits * sizeof (GNUNET_HashCode))
2282 GNUNET_break_op (0);
2283 return GNUNET_SYSERR;
2285 opt = (const GNUNET_HashCode*) &gm[1];
2286 bfsize = msize - sizeof (struct GetMessage) + bits * sizeof (GNUNET_HashCode);
2287 bm = ntohl (gm->hash_bitmap);
2288 if ( (0 != (bm & GET_MESSAGE_BIT_SKS_NAMESPACE)) &&
2289 (ntohl (gm->type) == GNUNET_DATASTORE_BLOCKTYPE_SBLOCK) )
2291 GNUNET_break_op (0);
2292 return GNUNET_SYSERR;
2295 cps = GNUNET_CONTAINER_multihashmap_get (connected_peers,
2296 &other->hashPubKey);
2297 GNUNET_assert (NULL != cps);
2298 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
2299 cp = GNUNET_CONTAINER_multihashmap_get (connected_peers,
2306 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
2307 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2308 "Failed to find RETURN-TO peer `%4s' in connection set. Dropping query.\n",
2309 GNUNET_i2s ((const struct GNUNET_PeerIdentity*) &opt[bits-1]));
2312 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2313 "Failed to find peer `%4s' in connection set. Dropping query.\n",
2314 GNUNET_i2s (other));
2316 /* FIXME: try connect? */
2319 /* note that we can really only check load here since otherwise
2320 peers could find out that we are overloaded by not being
2321 disconnected after sending us a malformed query... */
2322 if (GNUNET_YES == test_load_too_high ())
2325 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2326 "Dropping query from `%s', this peer is too busy.\n",
2327 GNUNET_i2s (other));
2333 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2334 "Received request for `%s' of type %u from peer `%4s'\n",
2335 GNUNET_h2s (&gm->query),
2336 (unsigned int) ntohl (gm->type),
2337 GNUNET_i2s (other));
2339 have_ns = (0 != (bm & GET_MESSAGE_BIT_SKS_NAMESPACE));
2340 pr = GNUNET_malloc (sizeof (struct PendingRequest) +
2341 (have_ns ? sizeof(GNUNET_HashCode) : 0));
2343 pr->namespace = (GNUNET_HashCode*) &pr[1];
2345 pr->mingle = ntohl (gm->filter_mutator);
2346 if (0 != (bm & GET_MESSAGE_BIT_SKS_NAMESPACE))
2347 memcpy (&pr[1], &opt[bits++], sizeof (GNUNET_HashCode));
2348 else if (pr->type == GNUNET_DATASTORE_BLOCKTYPE_SBLOCK)
2350 GNUNET_break_op (0);
2352 return GNUNET_SYSERR;
2354 if (0 != (bm & GET_MESSAGE_BIT_TRANSMIT_TO))
2355 pr->target_pid = GNUNET_PEER_intern ((const struct GNUNET_PeerIdentity*) &opt[bits++]);
2357 pr->anonymity_level = 1;
2358 pr->priority = bound_priority (ntohl (gm->priority), cps);
2359 pr->ttl = bound_ttl (ntohl (gm->ttl), pr->priority);
2360 pr->query = gm->query;
2361 /* decrement ttl (always) */
2362 ttl_decrement = 2 * TTL_DECREMENT +
2363 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
2365 if ( (pr->ttl < 0) &&
2366 (pr->ttl - ttl_decrement > 0) )
2369 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2370 "Dropping query from `%s' due to TTL underflow.\n",
2371 GNUNET_i2s (other));
2373 /* integer underflow => drop (should be very rare)! */
2377 pr->ttl -= ttl_decrement;
2378 pr->start_time = GNUNET_TIME_absolute_get ();
2380 /* get bloom filter */
2383 pr->bf = GNUNET_CONTAINER_bloomfilter_init ((const char*) &opt[bits],
2386 pr->bf_size = bfsize;
2391 GNUNET_CONTAINER_multihashmap_get_multiple (query_request_map,
2393 &check_duplicate_request_peer,
2395 if (cdc.have != NULL)
2397 if (cdc.have->start_time.value + cdc.have->ttl >=
2398 pr->start_time.value + pr->ttl)
2400 /* existing request has higher TTL, drop new one! */
2401 cdc.have->priority += pr->priority;
2402 destroy_pending_request (pr);
2404 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2405 "Have existing request with higher TTL, dropping new request.\n",
2406 GNUNET_i2s (other));
2412 /* existing request has lower TTL, drop old one! */
2413 pr->priority += cdc.have->priority;
2414 /* Possible optimization: if we have applicable pending
2415 replies in 'cdc.have', we might want to move those over
2416 (this is a really rare special-case, so it is not clear
2417 that this would be worth it) */
2418 destroy_pending_request (cdc.have);
2419 /* keep processing 'pr'! */
2424 GNUNET_CONTAINER_multihashmap_put (query_request_map,
2427 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2428 GNUNET_CONTAINER_multihashmap_put (peer_request_map,
2431 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2433 pr->hnode = GNUNET_CONTAINER_heap_insert (requests_by_expiration_heap,
2435 pr->start_time.value + pr->ttl);
2438 /* calculate change in traffic preference */
2439 preference = (double) pr->priority;
2440 if (preference < QUERY_BANDWIDTH_VALUE)
2441 preference = QUERY_BANDWIDTH_VALUE;
2442 cps->inc_preference += preference;
2444 /* process locally */
2445 if (type == GNUNET_DATASTORE_BLOCKTYPE_DBLOCK)
2446 type = GNUNET_DATASTORE_BLOCKTYPE_ANY; /* to get on-demand as well */
2447 timeout = GNUNET_TIME_relative_multiply (BASIC_DATASTORE_REQUEST_DELAY,
2448 (pr->priority + 1));
2449 pr->drq = GNUNET_FS_drq_get (&gm->query,
2451 &process_local_reply,
2456 /* Are multiple results possible? If so, start processing remotely now! */
2459 case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
2460 case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
2461 /* only one result, wait for datastore */
2464 pr->task = GNUNET_SCHEDULER_add_now (sched,
2465 &forward_request_task,
2469 /* make sure we don't track too many requests */
2470 if (GNUNET_CONTAINER_heap_get_size (requests_by_expiration_heap) > max_pending_requests)
2472 pr = GNUNET_CONTAINER_heap_peek (requests_by_expiration_heap);
2473 destroy_pending_request (pr);
2479 /* **************************** CS GET Handling ************************ */
2483 * Handle START_SEARCH-message (search request from client).
2485 * @param cls closure
2486 * @param client identification of the client
2487 * @param message the actual message
2490 handle_start_search (void *cls,
2491 struct GNUNET_SERVER_Client *client,
2492 const struct GNUNET_MessageHeader *message)
2494 static GNUNET_HashCode all_zeros;
2495 const struct SearchMessage *sm;
2496 struct ClientList *cl;
2497 struct ClientRequestList *crl;
2498 struct PendingRequest *pr;
2503 msize = ntohs (message->size);
2504 if ( (msize < sizeof (struct SearchMessage)) ||
2505 (0 != (msize - sizeof (struct SearchMessage)) % sizeof (GNUNET_HashCode)) )
2508 GNUNET_SERVER_receive_done (client,
2512 sc = (msize - sizeof (struct SearchMessage)) / sizeof (GNUNET_HashCode);
2513 sm = (const struct SearchMessage*) message;
2516 while ( (cl != NULL) &&
2517 (cl->client != client) )
2521 cl = GNUNET_malloc (sizeof (struct ClientList));
2522 cl->client = client;
2523 GNUNET_SERVER_client_keep (client);
2524 cl->next = client_list;
2527 type = ntohl (sm->type);
2530 case GNUNET_DATASTORE_BLOCKTYPE_ANY:
2531 case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
2532 case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
2533 case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
2534 case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
2538 GNUNET_SERVER_receive_done (client,
2543 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2544 "Received request for `%s' of type %u from local client\n",
2545 GNUNET_h2s (&sm->query),
2546 (unsigned int) type);
2549 /* detect duplicate KBLOCK requests */
2550 if (type == GNUNET_DATASTORE_BLOCKTYPE_KBLOCK)
2553 while ( (crl != NULL) &&
2554 ( (0 != memcmp (&crl->req->query,
2556 sizeof (GNUNET_HashCode))) ||
2557 (crl->req->type != type) ) )
2562 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2563 "Have existing request, merging content-seen lists.\n");
2566 /* Duplicate request (used to send long list of
2567 known/blocked results); merge 'pr->replies_seen'
2568 and update bloom filter */
2569 GNUNET_array_grow (pr->replies_seen,
2570 pr->replies_seen_size,
2571 pr->replies_seen_off + sc);
2572 memcpy (&pr->replies_seen[pr->replies_seen_off],
2574 sc * sizeof (GNUNET_HashCode));
2575 pr->replies_seen_off += sc;
2577 GNUNET_CONTAINER_bloomfilter_free (pr->bf);
2578 pr->bf = refresh_bloomfilter (pr->replies_seen_off,
2582 GNUNET_SERVER_receive_done (client,
2587 pr = GNUNET_malloc (sizeof (struct PendingRequest) +
2588 ((type == GNUNET_DATASTORE_BLOCKTYPE_SBLOCK)?sizeof(GNUNET_HashCode):0));
2589 crl = GNUNET_malloc (sizeof (struct ClientRequestList));
2590 memset (crl, 0, sizeof (struct ClientRequestList));
2591 crl->client_list = cl;
2592 GNUNET_CONTAINER_DLL_insert (cl->rl_head,
2597 pr->client_request_list = crl;
2598 GNUNET_array_grow (pr->replies_seen,
2599 pr->replies_seen_size,
2601 memcpy (pr->replies_seen,
2603 sc * sizeof (GNUNET_HashCode));
2604 pr->replies_seen_off = sc;
2605 pr->anonymity_level = ntohl (sm->anonymity_level);
2606 pr->bf = refresh_bloomfilter (pr->replies_seen_off,
2610 pr->query = sm->query;
2613 case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
2614 case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
2615 if (0 != memcmp (&sm->target,
2617 sizeof (GNUNET_HashCode)))
2618 pr->target_pid = GNUNET_PEER_intern ((const struct GNUNET_PeerIdentity*) &sm->target);
2620 case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
2621 pr->namespace = (GNUNET_HashCode*) &pr[1];
2622 memcpy (&pr[1], &sm->target, sizeof (GNUNET_HashCode));
2627 GNUNET_CONTAINER_multihashmap_put (query_request_map,
2630 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2631 if (type == GNUNET_DATASTORE_BLOCKTYPE_DBLOCK)
2632 type = GNUNET_DATASTORE_BLOCKTYPE_ANY; /* get on-demand blocks too! */
2633 pr->drq = GNUNET_FS_drq_get (&sm->query,
2635 &process_local_reply,
2637 GNUNET_TIME_UNIT_FOREVER_REL,
2642 /* **************************** Startup ************************ */
2646 * List of handlers for P2P messages
2647 * that we care about.
2649 static struct GNUNET_CORE_MessageHandler p2p_handlers[] =
2652 GNUNET_MESSAGE_TYPE_FS_GET, 0 },
2654 GNUNET_MESSAGE_TYPE_FS_PUT, 0 },
2660 * List of handlers for the messages understood by this
2663 static struct GNUNET_SERVER_MessageHandler handlers[] = {
2664 {&GNUNET_FS_handle_index_start, NULL,
2665 GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0},
2666 {&GNUNET_FS_handle_index_list_get, NULL,
2667 GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET, sizeof(struct GNUNET_MessageHeader) },
2668 {&GNUNET_FS_handle_unindex, NULL, GNUNET_MESSAGE_TYPE_FS_UNINDEX,
2669 sizeof (struct UnindexMessage) },
2670 {&handle_start_search, NULL, GNUNET_MESSAGE_TYPE_FS_START_SEARCH,
2677 * Process fs requests.
2679 * @param s scheduler to use
2680 * @param server the initialized server
2681 * @param c configuration to use
2684 main_init (struct GNUNET_SCHEDULER_Handle *s,
2685 struct GNUNET_SERVER_Handle *server,
2686 const struct GNUNET_CONFIGURATION_Handle *c)
2690 connected_peers = GNUNET_CONTAINER_multihashmap_create (128); // FIXME: get size from config
2691 query_request_map = GNUNET_CONTAINER_multihashmap_create (128); // FIXME: get size from config
2692 peer_request_map = GNUNET_CONTAINER_multihashmap_create (128); // FIXME: get size from config
2693 requests_by_expiration_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
2694 core = GNUNET_CORE_connect (sched,
2696 GNUNET_TIME_UNIT_FOREVER_REL,
2700 &peer_connect_handler,
2701 &peer_disconnect_handler,
2707 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2708 _("Failed to connect to `%s' service.\n"),
2710 GNUNET_CONTAINER_multihashmap_destroy (connected_peers);
2711 connected_peers = NULL;
2712 GNUNET_CONTAINER_multihashmap_destroy (query_request_map);
2713 query_request_map = NULL;
2714 GNUNET_CONTAINER_heap_destroy (requests_by_expiration_heap);
2715 requests_by_expiration_heap = NULL;
2716 GNUNET_CONTAINER_multihashmap_destroy (peer_request_map);
2717 peer_request_map = NULL;
2719 return GNUNET_SYSERR;
2721 GNUNET_SERVER_disconnect_notify (server,
2722 &handle_client_disconnect,
2724 GNUNET_SERVER_add_handlers (server, handlers);
2725 GNUNET_SCHEDULER_add_delayed (sched,
2726 GNUNET_TIME_UNIT_FOREVER_REL,
2734 * Process fs requests.
2736 * @param cls closure
2737 * @param sched scheduler to use
2738 * @param server the initialized server
2739 * @param cfg configuration to use
2743 struct GNUNET_SCHEDULER_Handle *sched,
2744 struct GNUNET_SERVER_Handle *server,
2745 const struct GNUNET_CONFIGURATION_Handle *cfg)
2747 if ( (GNUNET_OK != GNUNET_FS_drq_init (sched, cfg)) ||
2748 (GNUNET_OK != GNUNET_FS_indexing_init (sched, cfg)) ||
2749 (GNUNET_OK != main_init (sched, server, cfg)) )
2751 GNUNET_SCHEDULER_shutdown (sched);
2758 * The main function for the fs service.
2760 * @param argc number of arguments from the command line
2761 * @param argv command line arguments
2762 * @return 0 ok, 1 on error
2765 main (int argc, char *const *argv)
2767 return (GNUNET_OK ==
2768 GNUNET_SERVICE_run (argc,
2771 GNUNET_SERVICE_OPTION_NONE,
2772 &run, NULL)) ? 0 : 1;
2775 /* end of gnunet-service-fs.c */