2 This file is part of GNUnet.
3 Copyright (C) 2009, 2010, 2011, 2016, 2017 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file dht/gnunet-service-dht_clients.c
23 * @brief GNUnet DHT service's client management code
24 * @author Christian Grothoff
25 * @author Nathan Evans
29 #include "gnunet_constants.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_statistics_service.h"
32 #include "gnunet-service-dht.h"
33 #include "gnunet-service-dht_datacache.h"
34 #include "gnunet-service-dht_neighbours.h"
39 * Should routing details be logged to stderr (for debugging)?
41 #define LOG_TRAFFIC(kind,...) GNUNET_log_from (kind, "dht-traffic",__VA_ARGS__)
43 #define LOG(kind,...) GNUNET_log_from (kind, "dht-clients",__VA_ARGS__)
47 * Struct containing information about a client,
48 * handle to connect to it, and any pending messages
49 * that need to be sent to it.
55 * Entry in the local forwarding map for a client's GET request.
57 struct ClientQueryRecord
61 * The key this request was about
63 struct GNUNET_HashCode key;
66 * Kept in a DLL with @e client.
68 struct ClientQueryRecord *next;
71 * Kept in a DLL with @e client.
73 struct ClientQueryRecord *prev;
76 * Client responsible for the request.
78 struct ClientHandle *ch;
81 * Extended query (see gnunet_block_lib.h), allocated at the end of this struct.
86 * Replies we have already seen for this request.
88 struct GNUNET_HashCode *seen_replies;
91 * Pointer to this nodes heap location in the retry-heap (for fast removal)
93 struct GNUNET_CONTAINER_HeapNode *hnode;
96 * What's the delay between re-try operations that we currently use for this
99 struct GNUNET_TIME_Relative retry_frequency;
102 * What's the next time we should re-try this request?
104 struct GNUNET_TIME_Absolute retry_time;
107 * The unique identifier of this request
112 * Number of bytes in xquery.
117 * Number of entries in 'seen_replies'.
119 unsigned int seen_replies_count;
122 * Desired replication level
124 uint32_t replication;
127 * Any message options for this request
129 uint32_t msg_options;
132 * The type for the data for the GET request.
134 enum GNUNET_BLOCK_Type type;
140 * Struct containing paremeters of monitoring requests.
142 struct ClientMonitorRecord
146 * Next element in DLL.
148 struct ClientMonitorRecord *next;
151 * Previous element in DLL.
153 struct ClientMonitorRecord *prev;
156 * Type of blocks that are of interest
158 enum GNUNET_BLOCK_Type type;
161 * Key of data of interest, NULL for all.
163 struct GNUNET_HashCode *key;
166 * Flag whether to notify about GET messages.
171 * Flag whether to notify about GET_REPONSE messages.
176 * Flag whether to notify about PUT messages.
181 * Client to notify of these requests.
183 struct ClientHandle *ch;
188 * Struct containing information about a client,
189 * handle to connect to it, and any pending messages
190 * that need to be sent to it.
195 * Linked list of active queries of this client.
197 struct ClientQueryRecord *cqr_head;
200 * Linked list of active queries of this client.
202 struct ClientQueryRecord *cqr_tail;
205 * The handle to this client
207 struct GNUNET_SERVICE_Client *client;
210 * The message queue to this client
212 struct GNUNET_MQ_Handle *mq;
217 * Our handle to the BLOCK library.
219 struct GNUNET_BLOCK_Context *GDS_block_context;
222 * Handle for the statistics service.
224 struct GNUNET_STATISTICS_Handle *GDS_stats;
227 * Handle for the service.
229 struct GNUNET_SERVICE_Handle *GDS_service;
232 * The configuration the DHT service is running with
234 const struct GNUNET_CONFIGURATION_Handle *GDS_cfg;
237 * List of active monitoring requests.
239 static struct ClientMonitorRecord *monitor_head;
242 * List of active monitoring requests.
244 static struct ClientMonitorRecord *monitor_tail;
247 * Hashmap for fast key based lookup, maps keys to `struct ClientQueryRecord` entries.
249 static struct GNUNET_CONTAINER_MultiHashMap *forward_map;
252 * Heap with all of our client's request, sorted by retry time (earliest on top).
254 static struct GNUNET_CONTAINER_Heap *retry_heap;
257 * Task that re-transmits requests (using retry_heap).
259 static struct GNUNET_SCHEDULER_Task *retry_task;
263 * Free data structures associated with the given query.
265 * @param record record to remove
268 remove_client_record (struct ClientQueryRecord *record)
270 struct ClientHandle *ch = record->ch;
272 GNUNET_CONTAINER_DLL_remove (ch->cqr_head,
275 GNUNET_assert (GNUNET_YES ==
276 GNUNET_CONTAINER_multihashmap_remove (forward_map,
279 if (NULL != record->hnode)
280 GNUNET_CONTAINER_heap_remove_node (record->hnode);
281 GNUNET_array_grow (record->seen_replies,
282 record->seen_replies_count,
284 GNUNET_free (record);
289 * Functions with this signature are called whenever a local client is
292 * @param cls closure (NULL for dht)
293 * @param client identification of the client
294 * @param mq message queue for talking to @a client
295 * @return our `struct ClientHandle` for @a client
298 client_connect_cb (void *cls,
299 struct GNUNET_SERVICE_Client *client,
300 struct GNUNET_MQ_Handle *mq)
302 struct ClientHandle *ch;
304 ch = GNUNET_new (struct ClientHandle);
312 * Functions with this signature are called whenever a client
313 * is disconnected on the network level.
315 * @param cls closure (NULL for dht)
316 * @param client identification of the client
317 * @param app_ctx our `struct ClientHandle` for @a client
320 client_disconnect_cb (void *cls,
321 struct GNUNET_SERVICE_Client *client,
324 struct ClientHandle *ch = app_ctx;
325 struct ClientQueryRecord *cqr;
326 struct ClientMonitorRecord *monitor;
328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
329 "Local client %p disconnects\n",
331 monitor = monitor_head;
332 while (NULL != monitor)
334 if (monitor->ch == ch)
336 struct ClientMonitorRecord *next;
338 next = monitor->next;
339 GNUNET_free_non_null (monitor->key);
340 GNUNET_CONTAINER_DLL_remove (monitor_head,
343 GNUNET_free (monitor);
348 monitor = monitor->next;
351 while (NULL != (cqr = ch->cqr_head))
352 remove_client_record (cqr);
358 * Route the given request via the DHT. This includes updating
359 * the bloom filter and retransmission times, building the P2P
360 * message and initiating the routing operation.
363 transmit_request (struct ClientQueryRecord *cqr)
365 struct GNUNET_BLOCK_Group *bg;
366 struct GNUNET_CONTAINER_BloomFilter *peer_bf;
368 GNUNET_STATISTICS_update (GDS_stats,
369 gettext_noop ("# GET requests from clients injected"),
372 bg = GNUNET_BLOCK_group_create (GDS_block_context,
374 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
379 cqr->seen_replies_count,
381 GNUNET_BLOCK_group_set_seen (bg,
383 cqr->seen_replies_count);
385 = GNUNET_CONTAINER_bloomfilter_init (NULL,
387 GNUNET_CONSTANTS_BLOOMFILTER_K);
388 LOG (GNUNET_ERROR_TYPE_DEBUG,
389 "Initiating GET for %s, replication %u, already have %u replies\n",
390 GNUNET_h2s (&cqr->key),
392 cqr->seen_replies_count);
393 GDS_NEIGHBOURS_handle_get (cqr->type,
402 GNUNET_BLOCK_group_destroy (bg);
403 GNUNET_CONTAINER_bloomfilter_free (peer_bf);
405 /* exponential back-off for retries.
406 * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
407 cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
408 cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
413 * Task that looks at the #retry_heap and transmits all of the requests
414 * on the heap that are ready for transmission. Then re-schedules
415 * itself (unless the heap is empty).
420 transmit_next_request_task (void *cls)
422 struct ClientQueryRecord *cqr;
423 struct GNUNET_TIME_Relative delay;
426 while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
429 delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
430 if (delay.rel_value_us > 0)
433 = GNUNET_CONTAINER_heap_insert (retry_heap,
435 cqr->retry_time.abs_value_us);
437 = GNUNET_SCHEDULER_add_at (cqr->retry_time,
438 &transmit_next_request_task,
442 transmit_request (cqr);
444 = GNUNET_CONTAINER_heap_insert (retry_heap,
446 cqr->retry_time.abs_value_us);
452 * Check DHT PUT messages from the client.
454 * @param cls the client we received this message from
455 * @param dht_msg the actual message received
456 * @return #GNUNET_OK (always)
459 check_dht_local_put (void *cls,
460 const struct GNUNET_DHT_ClientPutMessage *dht_msg)
462 /* always well-formed */
468 * Handler for PUT messages.
470 * @param cls the client we received this message from
471 * @param dht_msg the actual message received
474 handle_dht_local_put (void *cls,
475 const struct GNUNET_DHT_ClientPutMessage *dht_msg)
477 struct ClientHandle *ch = cls;
478 struct GNUNET_CONTAINER_BloomFilter *peer_bf;
480 struct GNUNET_MQ_Envelope *env;
481 struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
483 size = ntohs (dht_msg->header.size);
484 GNUNET_STATISTICS_update (GDS_stats,
485 gettext_noop ("# PUT requests received from clients"),
488 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
490 GNUNET_h2s_full (&dht_msg->key));
491 /* give to local clients */
492 LOG (GNUNET_ERROR_TYPE_DEBUG,
493 "Handling local PUT of %u-bytes for query %s\n",
494 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
495 GNUNET_h2s (&dht_msg->key));
496 GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
502 ntohl (dht_msg->type),
503 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
506 GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
510 ntohl (dht_msg->type),
511 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
513 /* route to other peers */
515 = GNUNET_CONTAINER_bloomfilter_init (NULL,
517 GNUNET_CONSTANTS_BLOOMFILTER_K);
518 GDS_NEIGHBOURS_handle_put (ntohl (dht_msg->type),
519 ntohl (dht_msg->options),
520 ntohl (dht_msg->desired_replication_level),
521 GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
528 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
529 GDS_CLIENTS_process_put (ntohl (dht_msg->options),
530 ntohl (dht_msg->type),
532 ntohl (dht_msg->desired_replication_level),
534 GDS_NEIGHBOURS_get_id(),
535 GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
538 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
539 GNUNET_CONTAINER_bloomfilter_free (peer_bf);
540 env = GNUNET_MQ_msg (conf,
541 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
542 conf->reserved = htonl (0);
543 conf->unique_id = dht_msg->unique_id;
544 GNUNET_MQ_send (ch->mq,
546 GNUNET_SERVICE_client_continue (ch->client);
551 * Check DHT GET messages from the client.
553 * @param cls the client we received this message from
554 * @param message the actual message received
555 * @return #GNUNET_OK (always)
558 check_dht_local_get (void *cls,
559 const struct GNUNET_DHT_ClientGetMessage *get)
561 /* always well-formed */
567 * Handle a result from local datacache for a GET operation.
569 * @param cls the `struct ClientHandle` of the client doing the query
570 * @param type type of the block
571 * @param expiration_time when does the content expire
572 * @param key key for the content
573 * @param put_path_length number of entries in @a put_path
574 * @param put_path peers the original PUT traversed (if tracked)
575 * @param get_path_length number of entries in @a get_path
576 * @param get_path peers this reply has traversed so far (if tracked)
577 * @param data payload of the reply
578 * @param data_size number of bytes in @a data
581 handle_local_result (void *cls,
582 enum GNUNET_BLOCK_Type type,
583 struct GNUNET_TIME_Absolute expiration_time,
584 const struct GNUNET_HashCode *key,
585 unsigned int put_path_length,
586 const struct GNUNET_PeerIdentity *put_path,
587 unsigned int get_path_length,
588 const struct GNUNET_PeerIdentity *get_path,
592 // FIXME: this needs some clean up: inline the function,
593 // possibly avoid even looking up the client!
594 GDS_CLIENTS_handle_reply (expiration_time,
597 put_path_length, put_path,
604 * Handler for DHT GET messages from the client.
606 * @param cls the client we received this message from
607 * @param message the actual message received
610 handle_dht_local_get (void *cls,
611 const struct GNUNET_DHT_ClientGetMessage *get)
613 struct ClientHandle *ch = cls;
614 struct ClientQueryRecord *cqr;
619 size = ntohs (get->header.size);
620 xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
621 xquery = (const char *) &get[1];
622 GNUNET_STATISTICS_update (GDS_stats,
624 ("# GET requests received from clients"), 1,
626 LOG (GNUNET_ERROR_TYPE_DEBUG,
627 "Received GET request for %s from local client %p, xq: %.*s\n",
628 GNUNET_h2s (&get->key),
632 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
634 GNUNET_h2s_full (&get->key));
636 cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
639 cqr->xquery = (void *) &cqr[1];
640 GNUNET_memcpy (&cqr[1], xquery, xquery_size);
641 cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
642 cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
643 cqr->retry_time = GNUNET_TIME_absolute_get ();
644 cqr->unique_id = get->unique_id;
645 cqr->xquery_size = xquery_size;
646 cqr->replication = ntohl (get->desired_replication_level);
647 cqr->msg_options = ntohl (get->options);
648 cqr->type = ntohl (get->type);
649 GNUNET_CONTAINER_DLL_insert (ch->cqr_head,
652 GNUNET_CONTAINER_multihashmap_put (forward_map,
655 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
656 GDS_CLIENTS_process_get (ntohl (get->options),
659 ntohl (get->desired_replication_level),
661 GDS_NEIGHBOURS_get_id(),
663 /* start remote requests */
664 if (NULL != retry_task)
665 GNUNET_SCHEDULER_cancel (retry_task);
666 retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task,
668 /* perform local lookup */
669 GDS_DATACACHE_handle_get (&get->key,
674 &handle_local_result,
676 GNUNET_SERVICE_client_continue (ch->client);
681 * Closure for #find_by_unique_id().
683 struct FindByUniqueIdContext
686 * Where to store the result, if found.
688 struct ClientQueryRecord *cqr;
695 * Function called for each existing DHT record for the given
696 * query. Checks if it matches the UID given in the closure
697 * and if so returns the entry as a result.
699 * @param cls the search context
700 * @param key query for the lookup (not used)
701 * @param value the `struct ClientQueryRecord`
702 * @return #GNUNET_YES to continue iteration (result not yet found)
705 find_by_unique_id (void *cls,
706 const struct GNUNET_HashCode *key,
709 struct FindByUniqueIdContext *fui_ctx = cls;
710 struct ClientQueryRecord *cqr = value;
712 if (cqr->unique_id != fui_ctx->unique_id)
720 * Check "GET result seen" messages from the client.
722 * @param cls the client we received this message from
723 * @param message the actual message received
724 * @return #GNUNET_OK if @a seen is well-formed
727 check_dht_local_get_result_seen (void *cls,
728 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen)
731 unsigned int hash_count;
733 size = ntohs (seen->header.size);
734 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
735 if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
738 return GNUNET_SYSERR;
745 * Handler for "GET result seen" messages from the client.
747 * @param cls the client we received this message from
748 * @param message the actual message received
751 handle_dht_local_get_result_seen (void *cls,
752 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen)
754 struct ClientHandle *ch = cls;
756 unsigned int hash_count;
757 unsigned int old_count;
758 const struct GNUNET_HashCode *hc;
759 struct FindByUniqueIdContext fui_ctx;
760 struct ClientQueryRecord *cqr;
762 size = ntohs (seen->header.size);
763 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
764 hc = (const struct GNUNET_HashCode*) &seen[1];
765 fui_ctx.unique_id = seen->unique_id;
767 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
771 if (NULL == (cqr = fui_ctx.cqr))
774 GNUNET_SERVICE_client_drop (ch->client);
777 /* finally, update 'seen' list */
778 old_count = cqr->seen_replies_count;
779 GNUNET_array_grow (cqr->seen_replies,
780 cqr->seen_replies_count,
781 cqr->seen_replies_count + hash_count);
782 GNUNET_memcpy (&cqr->seen_replies[old_count],
784 sizeof (struct GNUNET_HashCode) * hash_count);
789 * Closure for #remove_by_unique_id().
791 struct RemoveByUniqueIdContext
794 * Client that issued the removal request.
796 struct ClientHandle *ch;
799 * Unique ID of the request.
806 * Iterator over hash map entries that frees all entries
807 * that match the given client and unique ID.
809 * @param cls unique ID and client to search for in source routes
810 * @param key current key code
811 * @param value value in the hash map, a ClientQueryRecord
812 * @return #GNUNET_YES (we should continue to iterate)
815 remove_by_unique_id (void *cls,
816 const struct GNUNET_HashCode *key,
819 const struct RemoveByUniqueIdContext *ctx = cls;
820 struct ClientQueryRecord *cqr = value;
822 if (cqr->unique_id != ctx->unique_id)
824 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
825 "Removing client %p's record for key %s (by unique id)\n",
828 remove_client_record (cqr);
834 * Handler for any generic DHT stop messages, calls the appropriate handler
835 * depending on message type (if processed locally)
837 * @param cls client we received this message from
838 * @param message the actual message received
842 handle_dht_local_get_stop (void *cls,
843 const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg)
845 struct ClientHandle *ch = cls;
846 struct RemoveByUniqueIdContext ctx;
848 GNUNET_STATISTICS_update (GDS_stats,
850 ("# GET STOP requests received from clients"), 1,
852 LOG (GNUNET_ERROR_TYPE_DEBUG,
853 "Received GET STOP request for %s from local client %p\n",
854 GNUNET_h2s (&dht_stop_msg->key),
857 ctx.unique_id = dht_stop_msg->unique_id;
858 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
860 &remove_by_unique_id,
862 GNUNET_SERVICE_client_continue (ch->client);
867 * Handler for monitor start messages
869 * @param cls the client we received this message from
870 * @param msg the actual message received
874 handle_dht_local_monitor (void *cls,
875 const struct GNUNET_DHT_MonitorStartStopMessage *msg)
877 struct ClientHandle *ch = cls;
878 struct ClientMonitorRecord *r;
880 r = GNUNET_new (struct ClientMonitorRecord);
882 r->type = ntohl (msg->type);
883 r->get = ntohs (msg->get);
884 r->get_resp = ntohs (msg->get_resp);
885 r->put = ntohs (msg->put);
886 if (0 == ntohs (msg->filter_key))
892 r->key = GNUNET_new (struct GNUNET_HashCode);
893 GNUNET_memcpy (r->key,
895 sizeof (struct GNUNET_HashCode));
897 GNUNET_CONTAINER_DLL_insert (monitor_head,
900 GNUNET_SERVICE_client_continue (ch->client);
905 * Handler for monitor stop messages
907 * @param cls the client we received this message from
908 * @param msg the actual message received
911 handle_dht_local_monitor_stop (void *cls,
912 const struct GNUNET_DHT_MonitorStartStopMessage *msg)
914 struct ClientHandle *ch = cls;
915 struct ClientMonitorRecord *r;
918 GNUNET_SERVICE_client_continue (ch->client);
919 for (r = monitor_head; NULL != r; r = r->next)
923 keys_match = (0 == ntohs(msg->filter_key));
927 keys_match = ( (0 != ntohs(msg->filter_key)) &&
930 sizeof(struct GNUNET_HashCode))) );
932 if ( (ch == r->ch) &&
933 (ntohl(msg->type) == r->type) &&
934 (r->get == msg->get) &&
935 (r->get_resp == msg->get_resp) &&
936 (r->put == msg->put) &&
939 GNUNET_CONTAINER_DLL_remove (monitor_head,
942 GNUNET_free_non_null (r->key);
944 return; /* Delete only ONE entry */
951 * Closure for #forward_reply()
953 struct ForwardReplyContext
957 * Expiration time of the reply.
959 struct GNUNET_TIME_Absolute expiration;
964 const struct GNUNET_PeerIdentity *get_path;
969 const struct GNUNET_PeerIdentity *put_path;
977 * Number of bytes in data.
982 * Number of entries in @e get_path.
984 unsigned int get_path_length;
987 * Number of entries in @e put_path.
989 unsigned int put_path_length;
994 enum GNUNET_BLOCK_Type type;
1000 * Iterator over hash map entries that send a given reply to
1001 * each of the matching clients. With some tricky recycling
1004 * @param cls the 'struct ForwardReplyContext'
1005 * @param key current key
1006 * @param value value in the hash map, a ClientQueryRecord
1007 * @return #GNUNET_YES (we should continue to iterate),
1008 * if the result is mal-formed, #GNUNET_NO
1011 forward_reply (void *cls,
1012 const struct GNUNET_HashCode *key,
1015 struct ForwardReplyContext *frc = cls;
1016 struct ClientQueryRecord *record = value;
1017 struct GNUNET_MQ_Envelope *env;
1018 struct GNUNET_DHT_ClientResultMessage *reply;
1019 enum GNUNET_BLOCK_EvaluationResult eval;
1021 struct GNUNET_HashCode ch;
1022 struct GNUNET_PeerIdentity *paths;
1024 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
1025 "CLIENT-RESULT %s\n",
1026 GNUNET_h2s_full (key));
1027 if ( (record->type != GNUNET_BLOCK_TYPE_ANY) &&
1028 (record->type != frc->type))
1030 LOG (GNUNET_ERROR_TYPE_DEBUG,
1031 "Record type missmatch, not passing request for key %s to local client\n",
1033 GNUNET_STATISTICS_update (GDS_stats,
1035 ("# Key match, type mismatches in REPLY to CLIENT"),
1037 return GNUNET_YES; /* type mismatch */
1039 GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
1040 for (unsigned int i = 0; i < record->seen_replies_count; i++)
1041 if (0 == memcmp (&record->seen_replies[i],
1043 sizeof (struct GNUNET_HashCode)))
1045 LOG (GNUNET_ERROR_TYPE_DEBUG,
1046 "Duplicate reply, not passing request for key %s to local client\n",
1048 GNUNET_STATISTICS_update (GDS_stats,
1050 ("# Duplicate REPLIES to CLIENT request dropped"),
1052 return GNUNET_YES; /* duplicate */
1055 = GNUNET_BLOCK_evaluate (GDS_block_context,
1058 GNUNET_BLOCK_EO_NONE,
1061 record->xquery_size,
1064 LOG (GNUNET_ERROR_TYPE_DEBUG,
1065 "Evaluation result is %d for key %s for local client's query\n",
1070 case GNUNET_BLOCK_EVALUATION_OK_LAST:
1071 do_free = GNUNET_YES;
1073 case GNUNET_BLOCK_EVALUATION_OK_MORE:
1074 GNUNET_array_append (record->seen_replies,
1075 record->seen_replies_count,
1077 do_free = GNUNET_NO;
1079 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
1080 /* should be impossible to encounter here */
1083 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
1084 GNUNET_break_op (0);
1086 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
1089 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
1092 case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
1094 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
1095 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1096 _("Unsupported block type (%u) in request!\n"), record->type);
1102 GNUNET_STATISTICS_update (GDS_stats,
1103 gettext_noop ("# RESULTS queued for clients"),
1106 env = GNUNET_MQ_msg_extra (reply,
1108 (frc->get_path_length + frc->put_path_length) * sizeof (struct GNUNET_PeerIdentity),
1109 GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
1110 reply->type = htonl (frc->type);
1111 reply->get_path_length = htonl (frc->get_path_length);
1112 reply->put_path_length = htonl (frc->put_path_length);
1113 reply->unique_id = record->unique_id;
1114 reply->expiration = GNUNET_TIME_absolute_hton (frc->expiration);
1116 paths = (struct GNUNET_PeerIdentity *) &reply[1];
1117 GNUNET_memcpy (paths,
1119 sizeof (struct GNUNET_PeerIdentity) * frc->put_path_length);
1120 GNUNET_memcpy (&paths[frc->put_path_length],
1122 sizeof (struct GNUNET_PeerIdentity) * frc->get_path_length);
1123 GNUNET_memcpy (&paths[frc->get_path_length + frc->put_path_length],
1126 LOG (GNUNET_ERROR_TYPE_DEBUG,
1127 "Sending reply to query %s for client %p\n",
1129 record->ch->client);
1130 GNUNET_MQ_send (record->ch->mq,
1132 if (GNUNET_YES == do_free)
1133 remove_client_record (record);
1139 * Handle a reply we've received from another peer. If the reply
1140 * matches any of our pending queries, forward it to the respective
1143 * @param expiration when will the reply expire
1144 * @param key the query this reply is for
1145 * @param get_path_length number of peers in @a get_path
1146 * @param get_path path the reply took on get
1147 * @param put_path_length number of peers in @a put_path
1148 * @param put_path path the reply took on put
1149 * @param type type of the reply
1150 * @param data_size number of bytes in @a data
1151 * @param data application payload data
1154 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
1155 const struct GNUNET_HashCode *key,
1156 unsigned int get_path_length,
1157 const struct GNUNET_PeerIdentity *get_path,
1158 unsigned int put_path_length,
1159 const struct GNUNET_PeerIdentity *put_path,
1160 enum GNUNET_BLOCK_Type type,
1164 struct ForwardReplyContext frc;
1167 msize = sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
1168 (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
1169 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1174 if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map,
1177 LOG (GNUNET_ERROR_TYPE_DEBUG,
1178 "No matching client for reply for key %s\n",
1180 GNUNET_STATISTICS_update (GDS_stats,
1181 gettext_noop ("# REPLIES ignored for CLIENTS (no match)"),
1184 return; /* no matching request, fast exit! */
1186 frc.expiration = expiration;
1187 frc.get_path = get_path;
1188 frc.put_path = put_path;
1190 frc.data_size = data_size;
1191 frc.get_path_length = get_path_length;
1192 frc.put_path_length = put_path_length;
1194 LOG (GNUNET_ERROR_TYPE_DEBUG,
1195 "Forwarding reply for key %s to client\n",
1197 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1206 * Check if some client is monitoring GET messages and notify
1207 * them in that case.
1209 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1210 * @param type The type of data in the request.
1211 * @param hop_count Hop count so far.
1212 * @param path_length number of entries in path (or 0 if not recorded).
1213 * @param path peers on the GET path (or NULL if not recorded).
1214 * @param desired_replication_level Desired replication level.
1215 * @param key Key of the requested data.
1218 GDS_CLIENTS_process_get (uint32_t options,
1219 enum GNUNET_BLOCK_Type type,
1221 uint32_t desired_replication_level,
1222 unsigned int path_length,
1223 const struct GNUNET_PeerIdentity *path,
1224 const struct GNUNET_HashCode * key)
1226 struct ClientMonitorRecord *m;
1227 struct ClientHandle **cl;
1228 unsigned int cl_size;
1232 for (m = monitor_head; NULL != m; m = m->next)
1234 if ( ( (GNUNET_BLOCK_TYPE_ANY == m->type) ||
1235 (m->type == type) ) &&
1236 ( (NULL == m->key) ||
1239 sizeof(struct GNUNET_HashCode))) ) )
1241 struct GNUNET_MQ_Envelope *env;
1242 struct GNUNET_DHT_MonitorGetMessage *mmsg;
1243 struct GNUNET_PeerIdentity *msg_path;
1247 /* Don't send duplicates */
1248 for (i = 0; i < cl_size; i++)
1253 GNUNET_array_append (cl,
1257 msize = path_length * sizeof (struct GNUNET_PeerIdentity);
1258 env = GNUNET_MQ_msg_extra (mmsg,
1260 GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
1261 mmsg->options = htonl(options);
1262 mmsg->type = htonl(type);
1263 mmsg->hop_count = htonl(hop_count);
1264 mmsg->desired_replication_level = htonl(desired_replication_level);
1265 mmsg->get_path_length = htonl(path_length);
1267 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1268 GNUNET_memcpy (msg_path,
1270 path_length * sizeof (struct GNUNET_PeerIdentity));
1271 GNUNET_MQ_send (m->ch->mq,
1275 GNUNET_free_non_null (cl);
1280 * Check if some client is monitoring GET RESP messages and notify
1281 * them in that case.
1283 * @param type The type of data in the result.
1284 * @param get_path Peers on GET path (or NULL if not recorded).
1285 * @param get_path_length number of entries in get_path.
1286 * @param put_path peers on the PUT path (or NULL if not recorded).
1287 * @param put_path_length number of entries in get_path.
1288 * @param exp Expiration time of the data.
1289 * @param key Key of the data.
1290 * @param data Pointer to the result data.
1291 * @param size Number of bytes in @a data.
1294 GDS_CLIENTS_process_get_resp (enum GNUNET_BLOCK_Type type,
1295 const struct GNUNET_PeerIdentity *get_path,
1296 unsigned int get_path_length,
1297 const struct GNUNET_PeerIdentity *put_path,
1298 unsigned int put_path_length,
1299 struct GNUNET_TIME_Absolute exp,
1300 const struct GNUNET_HashCode * key,
1304 struct ClientMonitorRecord *m;
1305 struct ClientHandle **cl;
1306 unsigned int cl_size;
1310 for (m = monitor_head; NULL != m; m = m->next)
1312 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1314 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1316 struct GNUNET_MQ_Envelope *env;
1317 struct GNUNET_DHT_MonitorGetRespMessage *mmsg;
1318 struct GNUNET_PeerIdentity *path;
1322 /* Don't send duplicates */
1323 for (i = 0; i < cl_size; i++)
1328 GNUNET_array_append (cl,
1333 msize += (get_path_length + put_path_length)
1334 * sizeof (struct GNUNET_PeerIdentity);
1335 env = GNUNET_MQ_msg_extra (mmsg,
1337 GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET_RESP);
1338 mmsg->type = htonl(type);
1339 mmsg->put_path_length = htonl(put_path_length);
1340 mmsg->get_path_length = htonl(get_path_length);
1341 mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
1343 path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1344 GNUNET_memcpy (path,
1346 put_path_length * sizeof (struct GNUNET_PeerIdentity));
1347 GNUNET_memcpy (path,
1349 get_path_length * sizeof (struct GNUNET_PeerIdentity));
1350 GNUNET_memcpy (&path[get_path_length],
1353 GNUNET_MQ_send (m->ch->mq,
1357 GNUNET_free_non_null (cl);
1362 * Check if some client is monitoring PUT messages and notify
1363 * them in that case.
1365 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1366 * @param type The type of data in the request.
1367 * @param hop_count Hop count so far.
1368 * @param path_length number of entries in path (or 0 if not recorded).
1369 * @param path peers on the PUT path (or NULL if not recorded).
1370 * @param desired_replication_level Desired replication level.
1371 * @param exp Expiration time of the data.
1372 * @param key Key under which data is to be stored.
1373 * @param data Pointer to the data carried.
1374 * @param size Number of bytes in data.
1377 GDS_CLIENTS_process_put (uint32_t options,
1378 enum GNUNET_BLOCK_Type type,
1380 uint32_t desired_replication_level,
1381 unsigned int path_length,
1382 const struct GNUNET_PeerIdentity *path,
1383 struct GNUNET_TIME_Absolute exp,
1384 const struct GNUNET_HashCode *key,
1388 struct ClientMonitorRecord *m;
1389 struct ClientHandle **cl;
1390 unsigned int cl_size;
1394 for (m = monitor_head; NULL != m; m = m->next)
1396 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1398 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1400 struct GNUNET_MQ_Envelope *env;
1401 struct GNUNET_DHT_MonitorPutMessage *mmsg;
1402 struct GNUNET_PeerIdentity *msg_path;
1406 /* Don't send duplicates */
1407 for (i = 0; i < cl_size; i++)
1412 GNUNET_array_append (cl,
1417 msize += path_length * sizeof (struct GNUNET_PeerIdentity);
1418 env = GNUNET_MQ_msg_extra (mmsg,
1420 GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
1421 mmsg->options = htonl(options);
1422 mmsg->type = htonl(type);
1423 mmsg->hop_count = htonl(hop_count);
1424 mmsg->desired_replication_level = htonl (desired_replication_level);
1425 mmsg->put_path_length = htonl (path_length);
1427 mmsg->expiration_time = GNUNET_TIME_absolute_hton (exp);
1428 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1429 GNUNET_memcpy (msg_path,
1431 path_length * sizeof (struct GNUNET_PeerIdentity));
1432 GNUNET_memcpy (&msg_path[path_length],
1435 GNUNET_MQ_send (m->ch->mq,
1439 GNUNET_free_non_null (cl);
1444 * Initialize client subsystem.
1446 * @param server the initialized server
1452 = GNUNET_CONTAINER_multihashmap_create (1024,
1455 = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1460 * Shutdown client subsystem.
1465 if (NULL != retry_task)
1467 GNUNET_SCHEDULER_cancel (retry_task);
1474 * Define "main" method using service macro.
1476 * @param name name of the service, i.e. "dht" or "xdht"
1477 * @param run name of the initializaton method for the service
1479 #define GDS_DHT_SERVICE_INIT(name,run) \
1480 GNUNET_SERVICE_MAIN \
1482 GNUNET_SERVICE_OPTION_NONE, \
1484 &client_connect_cb, \
1485 &client_disconnect_cb, \
1487 GNUNET_MQ_hd_var_size (dht_local_put, \
1488 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, \
1489 struct GNUNET_DHT_ClientPutMessage, \
1491 GNUNET_MQ_hd_var_size (dht_local_get, \
1492 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, \
1493 struct GNUNET_DHT_ClientGetMessage, \
1495 GNUNET_MQ_hd_fixed_size (dht_local_get_stop, \
1496 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP, \
1497 struct GNUNET_DHT_ClientGetStopMessage, \
1499 GNUNET_MQ_hd_fixed_size (dht_local_monitor, \
1500 GNUNET_MESSAGE_TYPE_DHT_MONITOR_START, \
1501 struct GNUNET_DHT_MonitorStartStopMessage, \
1503 GNUNET_MQ_hd_fixed_size (dht_local_monitor_stop, \
1504 GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP, \
1505 struct GNUNET_DHT_MonitorStartStopMessage, \
1507 GNUNET_MQ_hd_var_size (dht_local_get_result_seen, \
1508 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, \
1509 struct GNUNET_DHT_ClientGetResultSeenMessage , \
1511 GNUNET_MQ_handler_end ())
1515 * MINIMIZE heap size (way below 128k) since this process doesn't need much.
1517 void __attribute__ ((destructor))
1520 if (NULL != retry_heap)
1522 GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1523 GNUNET_CONTAINER_heap_destroy (retry_heap);
1526 if (NULL != forward_map)
1528 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1529 GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1534 /* end of gnunet-service-dht_clients.c */