2 This file is part of GNUnet.
3 Copyright (C) 2009, 2010, 2011, 2016 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 int32_t reply_bf_mutator;
366 struct GNUNET_CONTAINER_BloomFilter *reply_bf;
367 struct GNUNET_CONTAINER_BloomFilter *peer_bf;
369 GNUNET_STATISTICS_update (GDS_stats,
370 gettext_noop ("# GET requests from clients injected"),
374 (int32_t) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
377 = GNUNET_BLOCK_construct_bloomfilter (reply_bf_mutator,
379 cqr->seen_replies_count);
381 = GNUNET_CONTAINER_bloomfilter_init (NULL,
383 GNUNET_CONSTANTS_BLOOMFILTER_K);
384 LOG (GNUNET_ERROR_TYPE_DEBUG,
385 "Initiating GET for %s, replication %u, already have %u replies\n",
386 GNUNET_h2s (&cqr->key),
388 cqr->seen_replies_count);
389 GDS_NEIGHBOURS_handle_get (cqr->type,
399 GNUNET_CONTAINER_bloomfilter_free (reply_bf);
400 GNUNET_CONTAINER_bloomfilter_free (peer_bf);
402 /* exponential back-off for retries.
403 * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
404 cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
405 cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
410 * Task that looks at the #retry_heap and transmits all of the requests
411 * on the heap that are ready for transmission. Then re-schedules
412 * itself (unless the heap is empty).
417 transmit_next_request_task (void *cls)
419 struct ClientQueryRecord *cqr;
420 struct GNUNET_TIME_Relative delay;
423 while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
426 delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
427 if (delay.rel_value_us > 0)
430 = GNUNET_CONTAINER_heap_insert (retry_heap,
432 cqr->retry_time.abs_value_us);
434 = GNUNET_SCHEDULER_add_at (cqr->retry_time,
435 &transmit_next_request_task,
439 transmit_request (cqr);
441 = GNUNET_CONTAINER_heap_insert (retry_heap,
443 cqr->retry_time.abs_value_us);
449 * Check DHT PUT messages from the client.
451 * @param cls the client we received this message from
452 * @param dht_msg the actual message received
453 * @return #GNUNET_OK (always)
456 check_dht_local_put (void *cls,
457 const struct GNUNET_DHT_ClientPutMessage *dht_msg)
459 /* always well-formed */
465 * Handler for PUT messages.
467 * @param cls the client we received this message from
468 * @param dht_msg the actual message received
471 handle_dht_local_put (void *cls,
472 const struct GNUNET_DHT_ClientPutMessage *dht_msg)
474 struct ClientHandle *ch = cls;
475 struct GNUNET_CONTAINER_BloomFilter *peer_bf;
477 struct GNUNET_MQ_Envelope *env;
478 struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
480 size = ntohs (dht_msg->header.size);
481 GNUNET_STATISTICS_update (GDS_stats,
482 gettext_noop ("# PUT requests received from clients"),
485 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
487 GNUNET_h2s_full (&dht_msg->key));
488 /* give to local clients */
489 LOG (GNUNET_ERROR_TYPE_DEBUG,
490 "Handling local PUT of %u-bytes for query %s\n",
491 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
492 GNUNET_h2s (&dht_msg->key));
493 GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
499 ntohl (dht_msg->type),
500 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
503 GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
507 ntohl (dht_msg->type),
508 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
510 /* route to other peers */
512 = GNUNET_CONTAINER_bloomfilter_init (NULL,
514 GNUNET_CONSTANTS_BLOOMFILTER_K);
515 GDS_NEIGHBOURS_handle_put (ntohl (dht_msg->type),
516 ntohl (dht_msg->options),
517 ntohl (dht_msg->desired_replication_level),
518 GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
525 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
526 GDS_CLIENTS_process_put (ntohl (dht_msg->options),
527 ntohl (dht_msg->type),
529 ntohl (dht_msg->desired_replication_level),
531 GDS_NEIGHBOURS_get_id(),
532 GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
535 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
536 GNUNET_CONTAINER_bloomfilter_free (peer_bf);
537 env = GNUNET_MQ_msg (conf,
538 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
539 conf->reserved = htonl (0);
540 conf->unique_id = dht_msg->unique_id;
541 GNUNET_MQ_send (ch->mq,
543 GNUNET_SERVICE_client_continue (ch->client);
548 * Check DHT GET messages from the client.
550 * @param cls the client we received this message from
551 * @param message the actual message received
552 * @return #GNUNET_OK (always)
555 check_dht_local_get (void *cls,
556 const struct GNUNET_DHT_ClientGetMessage *get)
558 /* always well-formed */
564 * Handle a result from local datacache for a GET operation.
566 * @param cls the `struct ClientHandle` of the client doing the query
567 * @param type type of the block
568 * @param expiration_time when does the content expire
569 * @param key key for the content
570 * @param put_path_length number of entries in @a put_path
571 * @param put_path peers the original PUT traversed (if tracked)
572 * @param get_path_length number of entries in @a get_path
573 * @param get_path peers this reply has traversed so far (if tracked)
574 * @param data payload of the reply
575 * @param data_size number of bytes in @a data
578 handle_local_result (void *cls,
579 enum GNUNET_BLOCK_Type type,
580 struct GNUNET_TIME_Absolute expiration_time,
581 const struct GNUNET_HashCode *key,
582 unsigned int put_path_length,
583 const struct GNUNET_PeerIdentity *put_path,
584 unsigned int get_path_length,
585 const struct GNUNET_PeerIdentity *get_path,
589 // FIXME: this needs some clean up: inline the function,
590 // possibly avoid even looking up the client!
591 GDS_CLIENTS_handle_reply (expiration_time,
594 put_path_length, put_path,
601 * Handler for DHT GET messages from the client.
603 * @param cls the client we received this message from
604 * @param message the actual message received
607 handle_dht_local_get (void *cls,
608 const struct GNUNET_DHT_ClientGetMessage *get)
610 struct ClientHandle *ch = cls;
611 struct ClientQueryRecord *cqr;
616 size = ntohs (get->header.size);
617 xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
618 xquery = (const char *) &get[1];
619 GNUNET_STATISTICS_update (GDS_stats,
621 ("# GET requests received from clients"), 1,
623 LOG (GNUNET_ERROR_TYPE_DEBUG,
624 "Received GET request for %s from local client %p, xq: %.*s\n",
625 GNUNET_h2s (&get->key),
629 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
631 GNUNET_h2s_full (&get->key));
633 cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
636 cqr->xquery = (void *) &cqr[1];
637 GNUNET_memcpy (&cqr[1], xquery, xquery_size);
638 cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
639 cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
640 cqr->retry_time = GNUNET_TIME_absolute_get ();
641 cqr->unique_id = get->unique_id;
642 cqr->xquery_size = xquery_size;
643 cqr->replication = ntohl (get->desired_replication_level);
644 cqr->msg_options = ntohl (get->options);
645 cqr->type = ntohl (get->type);
646 GNUNET_CONTAINER_DLL_insert (ch->cqr_head,
649 GNUNET_CONTAINER_multihashmap_put (forward_map,
652 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
653 GDS_CLIENTS_process_get (ntohl (get->options),
656 ntohl (get->desired_replication_level),
658 GDS_NEIGHBOURS_get_id(),
660 /* start remote requests */
661 if (NULL != retry_task)
662 GNUNET_SCHEDULER_cancel (retry_task);
663 retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task,
665 /* perform local lookup */
666 GDS_DATACACHE_handle_get (&get->key,
672 &handle_local_result,
674 GNUNET_SERVICE_client_continue (ch->client);
679 * Closure for #find_by_unique_id().
681 struct FindByUniqueIdContext
684 * Where to store the result, if found.
686 struct ClientQueryRecord *cqr;
693 * Function called for each existing DHT record for the given
694 * query. Checks if it matches the UID given in the closure
695 * and if so returns the entry as a result.
697 * @param cls the search context
698 * @param key query for the lookup (not used)
699 * @param value the `struct ClientQueryRecord`
700 * @return #GNUNET_YES to continue iteration (result not yet found)
703 find_by_unique_id (void *cls,
704 const struct GNUNET_HashCode *key,
707 struct FindByUniqueIdContext *fui_ctx = cls;
708 struct ClientQueryRecord *cqr = value;
710 if (cqr->unique_id != fui_ctx->unique_id)
718 * Check "GET result seen" messages from the client.
720 * @param cls the client we received this message from
721 * @param message the actual message received
722 * @return #GNUNET_OK if @a seen is well-formed
725 check_dht_local_get_result_seen (void *cls,
726 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen)
729 unsigned int hash_count;
731 size = ntohs (seen->header.size);
732 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
733 if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
736 return GNUNET_SYSERR;
743 * Handler for "GET result seen" messages from the client.
745 * @param cls the client we received this message from
746 * @param message the actual message received
749 handle_dht_local_get_result_seen (void *cls,
750 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen)
752 struct ClientHandle *ch = cls;
754 unsigned int hash_count;
755 unsigned int old_count;
756 const struct GNUNET_HashCode *hc;
757 struct FindByUniqueIdContext fui_ctx;
758 struct ClientQueryRecord *cqr;
760 size = ntohs (seen->header.size);
761 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
762 hc = (const struct GNUNET_HashCode*) &seen[1];
763 fui_ctx.unique_id = seen->unique_id;
765 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
769 if (NULL == (cqr = fui_ctx.cqr))
772 GNUNET_SERVICE_client_drop (ch->client);
775 /* finally, update 'seen' list */
776 old_count = cqr->seen_replies_count;
777 GNUNET_array_grow (cqr->seen_replies,
778 cqr->seen_replies_count,
779 cqr->seen_replies_count + hash_count);
780 GNUNET_memcpy (&cqr->seen_replies[old_count],
782 sizeof (struct GNUNET_HashCode) * hash_count);
787 * Closure for #remove_by_unique_id().
789 struct RemoveByUniqueIdContext
792 * Client that issued the removal request.
794 struct ClientHandle *ch;
797 * Unique ID of the request.
804 * Iterator over hash map entries that frees all entries
805 * that match the given client and unique ID.
807 * @param cls unique ID and client to search for in source routes
808 * @param key current key code
809 * @param value value in the hash map, a ClientQueryRecord
810 * @return #GNUNET_YES (we should continue to iterate)
813 remove_by_unique_id (void *cls,
814 const struct GNUNET_HashCode *key,
817 const struct RemoveByUniqueIdContext *ctx = cls;
818 struct ClientQueryRecord *cqr = value;
820 if (cqr->unique_id != ctx->unique_id)
822 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
823 "Removing client %p's record for key %s (by unique id)\n",
826 remove_client_record (cqr);
832 * Handler for any generic DHT stop messages, calls the appropriate handler
833 * depending on message type (if processed locally)
835 * @param cls client we received this message from
836 * @param message the actual message received
840 handle_dht_local_get_stop (void *cls,
841 const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg)
843 struct ClientHandle *ch = cls;
844 struct RemoveByUniqueIdContext ctx;
846 GNUNET_STATISTICS_update (GDS_stats,
848 ("# GET STOP requests received from clients"), 1,
850 LOG (GNUNET_ERROR_TYPE_DEBUG,
851 "Received GET STOP request for %s from local client %p\n",
852 GNUNET_h2s (&dht_stop_msg->key),
855 ctx.unique_id = dht_stop_msg->unique_id;
856 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
858 &remove_by_unique_id,
860 GNUNET_SERVICE_client_continue (ch->client);
865 * Handler for monitor start messages
867 * @param cls the client we received this message from
868 * @param msg the actual message received
872 handle_dht_local_monitor (void *cls,
873 const struct GNUNET_DHT_MonitorStartStopMessage *msg)
875 struct ClientHandle *ch = cls;
876 struct ClientMonitorRecord *r;
878 r = GNUNET_new (struct ClientMonitorRecord);
880 r->type = ntohl (msg->type);
881 r->get = ntohs (msg->get);
882 r->get_resp = ntohs (msg->get_resp);
883 r->put = ntohs (msg->put);
884 if (0 == ntohs (msg->filter_key))
890 r->key = GNUNET_new (struct GNUNET_HashCode);
891 GNUNET_memcpy (r->key,
893 sizeof (struct GNUNET_HashCode));
895 GNUNET_CONTAINER_DLL_insert (monitor_head,
898 GNUNET_SERVICE_client_continue (ch->client);
903 * Handler for monitor stop messages
905 * @param cls the client we received this message from
906 * @param msg the actual message received
909 handle_dht_local_monitor_stop (void *cls,
910 const struct GNUNET_DHT_MonitorStartStopMessage *msg)
912 struct ClientHandle *ch = cls;
913 struct ClientMonitorRecord *r;
916 GNUNET_SERVICE_client_continue (ch->client);
917 for (r = monitor_head; NULL != r; r = r->next)
921 keys_match = (0 == ntohs(msg->filter_key));
925 keys_match = ( (0 != ntohs(msg->filter_key)) &&
928 sizeof(struct GNUNET_HashCode))) );
930 if ( (ch == r->ch) &&
931 (ntohl(msg->type) == r->type) &&
932 (r->get == msg->get) &&
933 (r->get_resp == msg->get_resp) &&
934 (r->put == msg->put) &&
937 GNUNET_CONTAINER_DLL_remove (monitor_head,
940 GNUNET_free_non_null (r->key);
942 return; /* Delete only ONE entry */
949 * Closure for #forward_reply()
951 struct ForwardReplyContext
955 * Expiration time of the reply.
957 struct GNUNET_TIME_Absolute expiration;
962 const struct GNUNET_PeerIdentity *get_path;
967 const struct GNUNET_PeerIdentity *put_path;
975 * Number of bytes in data.
980 * Number of entries in @e get_path.
982 unsigned int get_path_length;
985 * Number of entries in @e put_path.
987 unsigned int put_path_length;
992 enum GNUNET_BLOCK_Type type;
998 * Iterator over hash map entries that send a given reply to
999 * each of the matching clients. With some tricky recycling
1002 * @param cls the 'struct ForwardReplyContext'
1003 * @param key current key
1004 * @param value value in the hash map, a ClientQueryRecord
1005 * @return #GNUNET_YES (we should continue to iterate),
1006 * if the result is mal-formed, #GNUNET_NO
1009 forward_reply (void *cls,
1010 const struct GNUNET_HashCode *key,
1013 struct ForwardReplyContext *frc = cls;
1014 struct ClientQueryRecord *record = value;
1015 struct GNUNET_MQ_Envelope *env;
1016 struct GNUNET_DHT_ClientResultMessage *reply;
1017 enum GNUNET_BLOCK_EvaluationResult eval;
1019 struct GNUNET_HashCode ch;
1020 struct GNUNET_PeerIdentity *paths;
1022 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
1023 "CLIENT-RESULT %s\n",
1024 GNUNET_h2s_full (key));
1025 if ( (record->type != GNUNET_BLOCK_TYPE_ANY) &&
1026 (record->type != frc->type))
1028 LOG (GNUNET_ERROR_TYPE_DEBUG,
1029 "Record type missmatch, not passing request for key %s to local client\n",
1031 GNUNET_STATISTICS_update (GDS_stats,
1033 ("# Key match, type mismatches in REPLY to CLIENT"),
1035 return GNUNET_YES; /* type mismatch */
1037 GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
1038 for (unsigned int i = 0; i < record->seen_replies_count; i++)
1039 if (0 == memcmp (&record->seen_replies[i],
1041 sizeof (struct GNUNET_HashCode)))
1043 LOG (GNUNET_ERROR_TYPE_DEBUG,
1044 "Duplicate reply, not passing request for key %s to local client\n",
1046 GNUNET_STATISTICS_update (GDS_stats,
1048 ("# Duplicate REPLIES to CLIENT request dropped"),
1050 return GNUNET_YES; /* duplicate */
1053 = GNUNET_BLOCK_evaluate (GDS_block_context,
1055 GNUNET_BLOCK_EO_NONE,
1060 record->xquery_size,
1063 LOG (GNUNET_ERROR_TYPE_DEBUG,
1064 "Evaluation result is %d for key %s for local client's query\n",
1069 case GNUNET_BLOCK_EVALUATION_OK_LAST:
1070 do_free = GNUNET_YES;
1072 case GNUNET_BLOCK_EVALUATION_OK_MORE:
1073 GNUNET_array_append (record->seen_replies,
1074 record->seen_replies_count,
1076 do_free = GNUNET_NO;
1078 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
1079 /* should be impossible to encounter here */
1082 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
1083 GNUNET_break_op (0);
1085 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
1088 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
1091 case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
1093 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
1094 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1095 _("Unsupported block type (%u) in request!\n"), record->type);
1101 GNUNET_STATISTICS_update (GDS_stats,
1102 gettext_noop ("# RESULTS queued for clients"),
1105 env = GNUNET_MQ_msg_extra (reply,
1107 (frc->get_path_length + frc->put_path_length) * sizeof (struct GNUNET_PeerIdentity),
1108 GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
1109 reply->type = htonl (frc->type);
1110 reply->get_path_length = htonl (frc->get_path_length);
1111 reply->put_path_length = htonl (frc->put_path_length);
1112 reply->unique_id = record->unique_id;
1113 reply->expiration = GNUNET_TIME_absolute_hton (frc->expiration);
1115 paths = (struct GNUNET_PeerIdentity *) &reply[1];
1116 GNUNET_memcpy (paths,
1118 sizeof (struct GNUNET_PeerIdentity) * frc->put_path_length);
1119 GNUNET_memcpy (&paths[frc->put_path_length],
1121 sizeof (struct GNUNET_PeerIdentity) * frc->get_path_length);
1122 GNUNET_memcpy (&paths[frc->get_path_length + frc->put_path_length],
1125 LOG (GNUNET_ERROR_TYPE_DEBUG,
1126 "Sending reply to query %s for client %p\n",
1128 record->ch->client);
1129 GNUNET_MQ_send (record->ch->mq,
1131 if (GNUNET_YES == do_free)
1132 remove_client_record (record);
1138 * Handle a reply we've received from another peer. If the reply
1139 * matches any of our pending queries, forward it to the respective
1142 * @param expiration when will the reply expire
1143 * @param key the query this reply is for
1144 * @param get_path_length number of peers in @a get_path
1145 * @param get_path path the reply took on get
1146 * @param put_path_length number of peers in @a put_path
1147 * @param put_path path the reply took on put
1148 * @param type type of the reply
1149 * @param data_size number of bytes in @a data
1150 * @param data application payload data
1153 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
1154 const struct GNUNET_HashCode *key,
1155 unsigned int get_path_length,
1156 const struct GNUNET_PeerIdentity *get_path,
1157 unsigned int put_path_length,
1158 const struct GNUNET_PeerIdentity *put_path,
1159 enum GNUNET_BLOCK_Type type,
1163 struct ForwardReplyContext frc;
1166 msize = sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
1167 (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
1168 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1173 if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map,
1176 LOG (GNUNET_ERROR_TYPE_DEBUG,
1177 "No matching client for reply for key %s\n",
1179 GNUNET_STATISTICS_update (GDS_stats,
1180 gettext_noop ("# REPLIES ignored for CLIENTS (no match)"),
1183 return; /* no matching request, fast exit! */
1185 frc.expiration = expiration;
1186 frc.get_path = get_path;
1187 frc.put_path = put_path;
1189 frc.data_size = data_size;
1190 frc.get_path_length = get_path_length;
1191 frc.put_path_length = put_path_length;
1193 LOG (GNUNET_ERROR_TYPE_DEBUG,
1194 "Forwarding reply for key %s to client\n",
1196 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1205 * Check if some client is monitoring GET messages and notify
1206 * them in that case.
1208 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1209 * @param type The type of data in the request.
1210 * @param hop_count Hop count so far.
1211 * @param path_length number of entries in path (or 0 if not recorded).
1212 * @param path peers on the GET path (or NULL if not recorded).
1213 * @param desired_replication_level Desired replication level.
1214 * @param key Key of the requested data.
1217 GDS_CLIENTS_process_get (uint32_t options,
1218 enum GNUNET_BLOCK_Type type,
1220 uint32_t desired_replication_level,
1221 unsigned int path_length,
1222 const struct GNUNET_PeerIdentity *path,
1223 const struct GNUNET_HashCode * key)
1225 struct ClientMonitorRecord *m;
1226 struct ClientHandle **cl;
1227 unsigned int cl_size;
1231 for (m = monitor_head; NULL != m; m = m->next)
1233 if ( ( (GNUNET_BLOCK_TYPE_ANY == m->type) ||
1234 (m->type == type) ) &&
1235 ( (NULL == m->key) ||
1238 sizeof(struct GNUNET_HashCode))) ) )
1240 struct GNUNET_MQ_Envelope *env;
1241 struct GNUNET_DHT_MonitorGetMessage *mmsg;
1242 struct GNUNET_PeerIdentity *msg_path;
1246 /* Don't send duplicates */
1247 for (i = 0; i < cl_size; i++)
1252 GNUNET_array_append (cl,
1256 msize = path_length * sizeof (struct GNUNET_PeerIdentity);
1257 env = GNUNET_MQ_msg_extra (mmsg,
1259 GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
1260 mmsg->options = htonl(options);
1261 mmsg->type = htonl(type);
1262 mmsg->hop_count = htonl(hop_count);
1263 mmsg->desired_replication_level = htonl(desired_replication_level);
1264 mmsg->get_path_length = htonl(path_length);
1266 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1267 GNUNET_memcpy (msg_path,
1269 path_length * sizeof (struct GNUNET_PeerIdentity));
1270 GNUNET_MQ_send (m->ch->mq,
1274 GNUNET_free_non_null (cl);
1279 * Check if some client is monitoring GET RESP messages and notify
1280 * them in that case.
1282 * @param type The type of data in the result.
1283 * @param get_path Peers on GET path (or NULL if not recorded).
1284 * @param get_path_length number of entries in get_path.
1285 * @param put_path peers on the PUT path (or NULL if not recorded).
1286 * @param put_path_length number of entries in get_path.
1287 * @param exp Expiration time of the data.
1288 * @param key Key of the data.
1289 * @param data Pointer to the result data.
1290 * @param size Number of bytes in @a data.
1293 GDS_CLIENTS_process_get_resp (enum GNUNET_BLOCK_Type type,
1294 const struct GNUNET_PeerIdentity *get_path,
1295 unsigned int get_path_length,
1296 const struct GNUNET_PeerIdentity *put_path,
1297 unsigned int put_path_length,
1298 struct GNUNET_TIME_Absolute exp,
1299 const struct GNUNET_HashCode * key,
1303 struct ClientMonitorRecord *m;
1304 struct ClientHandle **cl;
1305 unsigned int cl_size;
1309 for (m = monitor_head; NULL != m; m = m->next)
1311 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1313 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1315 struct GNUNET_MQ_Envelope *env;
1316 struct GNUNET_DHT_MonitorGetRespMessage *mmsg;
1317 struct GNUNET_PeerIdentity *path;
1321 /* Don't send duplicates */
1322 for (i = 0; i < cl_size; i++)
1327 GNUNET_array_append (cl,
1332 msize += (get_path_length + put_path_length)
1333 * sizeof (struct GNUNET_PeerIdentity);
1334 env = GNUNET_MQ_msg_extra (mmsg,
1336 GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET_RESP);
1337 mmsg->type = htonl(type);
1338 mmsg->put_path_length = htonl(put_path_length);
1339 mmsg->get_path_length = htonl(get_path_length);
1340 mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
1342 path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1343 GNUNET_memcpy (path,
1345 put_path_length * sizeof (struct GNUNET_PeerIdentity));
1346 GNUNET_memcpy (path,
1348 get_path_length * sizeof (struct GNUNET_PeerIdentity));
1349 GNUNET_memcpy (&path[get_path_length],
1352 GNUNET_MQ_send (m->ch->mq,
1356 GNUNET_free_non_null (cl);
1361 * Check if some client is monitoring PUT messages and notify
1362 * them in that case.
1364 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1365 * @param type The type of data in the request.
1366 * @param hop_count Hop count so far.
1367 * @param path_length number of entries in path (or 0 if not recorded).
1368 * @param path peers on the PUT path (or NULL if not recorded).
1369 * @param desired_replication_level Desired replication level.
1370 * @param exp Expiration time of the data.
1371 * @param key Key under which data is to be stored.
1372 * @param data Pointer to the data carried.
1373 * @param size Number of bytes in data.
1376 GDS_CLIENTS_process_put (uint32_t options,
1377 enum GNUNET_BLOCK_Type type,
1379 uint32_t desired_replication_level,
1380 unsigned int path_length,
1381 const struct GNUNET_PeerIdentity *path,
1382 struct GNUNET_TIME_Absolute exp,
1383 const struct GNUNET_HashCode *key,
1387 struct ClientMonitorRecord *m;
1388 struct ClientHandle **cl;
1389 unsigned int cl_size;
1393 for (m = monitor_head; NULL != m; m = m->next)
1395 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1397 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1399 struct GNUNET_MQ_Envelope *env;
1400 struct GNUNET_DHT_MonitorPutMessage *mmsg;
1401 struct GNUNET_PeerIdentity *msg_path;
1405 /* Don't send duplicates */
1406 for (i = 0; i < cl_size; i++)
1411 GNUNET_array_append (cl,
1416 msize += path_length * sizeof (struct GNUNET_PeerIdentity);
1417 env = GNUNET_MQ_msg_extra (mmsg,
1419 GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
1420 mmsg->options = htonl(options);
1421 mmsg->type = htonl(type);
1422 mmsg->hop_count = htonl(hop_count);
1423 mmsg->desired_replication_level = htonl (desired_replication_level);
1424 mmsg->put_path_length = htonl (path_length);
1426 mmsg->expiration_time = GNUNET_TIME_absolute_hton (exp);
1427 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1428 GNUNET_memcpy (msg_path,
1430 path_length * sizeof (struct GNUNET_PeerIdentity));
1431 GNUNET_memcpy (&msg_path[path_length],
1434 GNUNET_MQ_send (m->ch->mq,
1438 GNUNET_free_non_null (cl);
1443 * Initialize client subsystem.
1445 * @param server the initialized server
1451 = GNUNET_CONTAINER_multihashmap_create (1024,
1454 = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1459 * Shutdown client subsystem.
1464 if (NULL != retry_task)
1466 GNUNET_SCHEDULER_cancel (retry_task);
1473 * Define "main" method using service macro.
1475 * @param name name of the service, i.e. "dht" or "xdht"
1476 * @param run name of the initializaton method for the service
1478 #define GDS_DHT_SERVICE_INIT(name,run) \
1479 GNUNET_SERVICE_MAIN \
1481 GNUNET_SERVICE_OPTION_NONE, \
1483 &client_connect_cb, \
1484 &client_disconnect_cb, \
1486 GNUNET_MQ_hd_var_size (dht_local_put, \
1487 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, \
1488 struct GNUNET_DHT_ClientPutMessage, \
1490 GNUNET_MQ_hd_var_size (dht_local_get, \
1491 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, \
1492 struct GNUNET_DHT_ClientGetMessage, \
1494 GNUNET_MQ_hd_fixed_size (dht_local_get_stop, \
1495 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP, \
1496 struct GNUNET_DHT_ClientGetStopMessage, \
1498 GNUNET_MQ_hd_fixed_size (dht_local_monitor, \
1499 GNUNET_MESSAGE_TYPE_DHT_MONITOR_START, \
1500 struct GNUNET_DHT_MonitorStartStopMessage, \
1502 GNUNET_MQ_hd_fixed_size (dht_local_monitor_stop, \
1503 GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP, \
1504 struct GNUNET_DHT_MonitorStartStopMessage, \
1506 GNUNET_MQ_hd_var_size (dht_local_get_result_seen, \
1507 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, \
1508 struct GNUNET_DHT_ClientGetResultSeenMessage , \
1510 GNUNET_MQ_handler_end ())
1514 * MINIMIZE heap size (way below 128k) since this process doesn't need much.
1516 void __attribute__ ((destructor))
1519 if (NULL != retry_heap)
1521 GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1522 GNUNET_CONTAINER_heap_destroy (retry_heap);
1525 if (NULL != forward_map)
1527 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1528 GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1533 /* end of gnunet-service-dht_clients.c */