2 This file is part of GNUnet.
3 Copyright (C) 2009, 2010, 2011 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-wdht_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-wdht.h"
33 #include "gnunet-service-wdht_clients.h"
34 #include "gnunet-service-wdht_datacache.h"
35 #include "gnunet-service-wdht_neighbours.h"
40 * Should routing details be logged to stderr (for debugging)?
42 #define LOG_TRAFFIC(kind,...) GNUNET_log_from (kind, "dht-traffic",__VA_ARGS__)
44 #define LOG(kind,...) GNUNET_log_from (kind, "dht-clients",__VA_ARGS__)
47 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
50 * Linked list of messages to send to clients.
55 * Pointer to next item in the list
57 struct PendingMessage *next;
60 * Pointer to previous item in the list
62 struct PendingMessage *prev;
65 * Actual message to be sent, allocated at the end of the struct:
66 * // msg = (cast) &pm[1];
67 * // memcpy (&pm[1], data, len);
69 const struct GNUNET_MessageHeader *msg;
75 * Struct containing information about a client,
76 * handle to connect to it, and any pending messages
77 * that need to be sent to it.
82 * Linked list of active clients
84 struct ClientList *next;
87 * Linked list of active clients
89 struct ClientList *prev;
92 * The handle to this client
94 struct GNUNET_SERVER_Client *client_handle;
97 * Handle to the current transmission request, NULL
100 struct GNUNET_SERVER_TransmitHandle *transmit_handle;
103 * Linked list of pending messages for this client
105 struct PendingMessage *pending_head;
108 * Tail of linked list of pending messages for this client
110 struct PendingMessage *pending_tail;
116 * Entry in the local forwarding map for a client's GET request.
118 struct ClientQueryRecord
122 * The key this request was about
124 struct GNUNET_HashCode key;
127 * Client responsible for the request.
129 struct ClientList *client;
132 * Extended query (see gnunet_block_lib.h), allocated at the end of this struct.
137 * Replies we have already seen for this request.
139 struct GNUNET_HashCode *seen_replies;
142 * Pointer to this nodes heap location in the retry-heap (for fast removal)
144 struct GNUNET_CONTAINER_HeapNode *hnode;
147 * What's the delay between re-try operations that we currently use for this
150 struct GNUNET_TIME_Relative retry_frequency;
153 * What's the next time we should re-try this request?
155 struct GNUNET_TIME_Absolute retry_time;
158 * The unique identifier of this request
163 * Number of bytes in xquery.
168 * Number of entries in @e seen_replies.
170 unsigned int seen_replies_count;
173 * Desired replication level
175 uint32_t replication;
178 * Any message options for this request
180 uint32_t msg_options;
183 * The type for the data for the GET request.
185 enum GNUNET_BLOCK_Type type;
191 * Struct containing paremeters of monitoring requests.
193 struct ClientMonitorRecord
197 * Next element in DLL.
199 struct ClientMonitorRecord *next;
202 * Previous element in DLL.
204 struct ClientMonitorRecord *prev;
207 * Type of blocks that are of interest
209 enum GNUNET_BLOCK_Type type;
212 * Key of data of interest, NULL for all.
214 struct GNUNET_HashCode *key;
217 * Flag whether to notify about GET messages.
222 * Flag whether to notify about GET_REPONSE messages.
227 * Flag whether to notify about PUT messages.
232 * Client to notify of these requests.
234 struct ClientList *client;
239 * List of active clients.
241 static struct ClientList *client_head;
244 * List of active clients.
246 static struct ClientList *client_tail;
249 * List of active monitoring requests.
251 static struct ClientMonitorRecord *monitor_head;
254 * List of active monitoring requests.
256 static struct ClientMonitorRecord *monitor_tail;
259 * Hashmap for fast key based lookup, maps keys to `struct ClientQueryRecord` entries.
261 static struct GNUNET_CONTAINER_MultiHashMap *forward_map;
264 * Heap with all of our client's request, sorted by retry time (earliest on top).
266 static struct GNUNET_CONTAINER_Heap *retry_heap;
269 * Task that re-transmits requests (using retry_heap).
271 static struct GNUNET_SCHEDULER_Task * retry_task;
275 * Task run to check for messages that need to be sent to a client.
277 * @param client a ClientList, containing the client and any messages to be sent to it
280 process_pending_messages (struct ClientList *client);
284 * Callback called as a result of issuing a #GNUNET_SERVER_notify_transmit_ready()
285 * request. A ClientList is passed as closure, take the head of the list
286 * and copy it into buf, which has the result of sending the message to the
289 * @param cls closure to this call
290 * @param size maximum number of bytes available to send
291 * @param buf where to copy the actual message to
293 * @return the number of bytes actually copied, 0 indicates failure
296 send_reply_to_client (void *cls, size_t size, void *buf)
298 struct ClientList *client = cls;
300 struct PendingMessage *reply;
304 client->transmit_handle = NULL;
307 /* client disconnected */
308 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
309 "Client %p disconnected, pending messages will be discarded\n",
310 client->client_handle);
314 while ((NULL != (reply = client->pending_head)) &&
315 (size >= off + (msize = ntohs (reply->msg->size))))
317 GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
319 memcpy (&cbuf[off], reply->msg, msize);
321 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes to client %p\n",
322 msize, client->client_handle);
325 process_pending_messages (client);
326 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitted %u/%u bytes to client %p\n",
327 (unsigned int) off, (unsigned int) size, client->client_handle);
333 * Task run to check for messages that need to be sent to a client.
335 * @param client a ClientList, containing the client and any messages to be sent to it
338 process_pending_messages (struct ClientList *client)
340 if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
342 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
343 "Not asking for transmission to %p now: %s\n",
344 client->client_handle,
345 client->pending_head ==
346 NULL ? "no more messages" : "request already pending");
349 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
350 "Asking for transmission of %u bytes to client %p\n",
351 ntohs (client->pending_head->msg->size), client->client_handle);
352 client->transmit_handle =
353 GNUNET_SERVER_notify_transmit_ready (client->client_handle,
354 ntohs (client->pending_head->
356 GNUNET_TIME_UNIT_FOREVER_REL,
357 &send_reply_to_client, client);
362 * Add a PendingMessage to the clients list of messages to be sent
364 * @param client the active client to send the message to
365 * @param pending_message the actual message to send
368 add_pending_message (struct ClientList *client,
369 struct PendingMessage *pending_message)
371 GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
373 process_pending_messages (client);
378 * Closure for #forward_reply()
380 struct ForwardReplyContext
384 * Actual message to send to matching clients.
386 struct PendingMessage *pm;
396 enum GNUNET_BLOCK_Type type;
399 * Number of bytes in data.
404 * Do we need to copy @e pm because it was already used?
412 * Find a client if it exists, add it otherwise.
414 * @param client the server handle to the client
416 * @return the client if found, a new client otherwise
418 static struct ClientList *
419 find_active_client (struct GNUNET_SERVER_Client *client)
421 struct ClientList *pos = client_head;
422 struct ClientList *ret;
426 if (pos->client_handle == client)
430 ret = GNUNET_new (struct ClientList);
431 ret->client_handle = client;
432 GNUNET_CONTAINER_DLL_insert (client_head, client_tail, ret);
438 * Iterator over hash map entries that frees all entries
439 * associated with the given client.
441 * @param cls client to search for in source routes
442 * @param key current key code (ignored)
443 * @param value value in the hash map, a ClientQueryRecord
444 * @return #GNUNET_YES (we should continue to iterate)
447 remove_client_records (void *cls, const struct GNUNET_HashCode * key, void *value)
449 struct ClientList *client = cls;
450 struct ClientQueryRecord *record = value;
452 if (record->client != client)
454 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
455 "Removing client %p's record for key %s\n", client,
457 GNUNET_assert (GNUNET_YES ==
458 GNUNET_CONTAINER_multihashmap_remove (forward_map, key,
460 if (NULL != record->hnode)
461 GNUNET_CONTAINER_heap_remove_node (record->hnode);
462 GNUNET_array_grow (record->seen_replies, record->seen_replies_count, 0);
463 GNUNET_free (record);
469 * Iterator over hash map entries that send a given reply to
470 * each of the matching clients. With some tricky recycling
473 * @param cls the `struct ForwardReplyContext`
474 * @param key current key
475 * @param value value in the hash map, a ClientQueryRecord
476 * @return #GNUNET_YES (we should continue to iterate),
477 * if the result is mal-formed, #GNUNET_NO
480 forward_reply (void *cls,
481 const struct GNUNET_HashCode *key,
484 struct ForwardReplyContext *frc = cls;
485 struct ClientQueryRecord *record = value;
486 struct PendingMessage *pm;
487 struct GNUNET_DHT_ClientResultMessage *reply;
488 enum GNUNET_BLOCK_EvaluationResult eval;
490 struct GNUNET_HashCode ch;
493 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
494 "XVINE CLIENT-RESULT %s\n",
495 GNUNET_h2s_full (key));
497 if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
499 LOG (GNUNET_ERROR_TYPE_DEBUG,
500 "Record type missmatch, not passing request for key %s to local client\n",
503 GNUNET_STATISTICS_update (GDS_stats,
505 ("# Key match, type mismatches in REPLY to CLIENT"),
507 return GNUNET_YES; /* type mismatch */
510 GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
511 for (i = 0; i < record->seen_replies_count; i++)
512 if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
514 LOG (GNUNET_ERROR_TYPE_DEBUG,
515 "Duplicate reply, not passing request for key %s to local client\n",
517 GNUNET_STATISTICS_update (GDS_stats,
519 ("# Duplicate REPLIES to CLIENT request dropped"),
521 return GNUNET_YES; /* duplicate */
524 GNUNET_BLOCK_evaluate (GDS_block_context,
526 GNUNET_BLOCK_EO_NONE,
532 LOG (GNUNET_ERROR_TYPE_DEBUG,
533 "Evaluation result is %d for key %s for local client's query\n",
534 (int) eval, GNUNET_h2s (key));
537 case GNUNET_BLOCK_EVALUATION_OK_LAST:
538 do_free = GNUNET_YES;
540 case GNUNET_BLOCK_EVALUATION_OK_MORE:
541 GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
544 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
545 /* should be impossible to encounter here */
548 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
551 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
554 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
557 case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
559 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
560 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
561 _("Unsupported block type (%u) in request!\n"), record->type);
567 if (GNUNET_NO == frc->do_copy)
569 /* first time, we can use the original data */
571 frc->do_copy = GNUNET_YES;
575 /* two clients waiting for same reply, must copy for queueing */
576 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
577 ntohs (frc->pm->msg->size));
579 sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
580 pm->next = pm->prev = NULL;
581 pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
583 GNUNET_STATISTICS_update (GDS_stats,
584 gettext_noop ("# RESULTS queued for clients"), 1,
586 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
587 reply->unique_id = record->unique_id;
588 LOG (GNUNET_ERROR_TYPE_DEBUG,
589 "Queueing reply to query %s for client %p\n",
591 record->client->client_handle);
592 add_pending_message (record->client, pm);
593 if (GNUNET_YES == do_free)
594 remove_client_records (record->client, key, record);
600 * Handle a reply we've received from another peer. If the reply
601 * matches any of our pending queries, forward it to the respective
604 * @param expiration when will the reply expire
605 * @param key the query this reply is for
606 * @param get_path_length number of peers in @a get_path
607 * @param get_path path the reply took on get
608 * @param put_path_length number of peers in @a put_path
609 * @param put_path path the reply took on put
610 * @param type type of the reply
611 * @param data_size number of bytes in @a data
612 * @param data application payload data
615 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
616 const struct GNUNET_HashCode *key,
617 unsigned int get_path_length,
618 const struct GNUNET_PeerIdentity *get_path,
619 unsigned int put_path_length,
620 const struct GNUNET_PeerIdentity *put_path,
621 enum GNUNET_BLOCK_Type type, size_t data_size,
624 struct ForwardReplyContext frc;
625 struct PendingMessage *pm;
626 struct GNUNET_DHT_ClientResultMessage *reply;
627 struct GNUNET_PeerIdentity *paths;
630 LOG (GNUNET_ERROR_TYPE_DEBUG,
631 "reply for key %s\n",
634 if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
636 GNUNET_STATISTICS_update (GDS_stats,
638 ("# REPLIES ignored for CLIENTS (no match)"), 1,
640 return; /* no matching request, fast exit! */
643 sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
644 (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
645 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
647 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
648 _("Could not pass reply to client, message too big!\n"));
651 DEBUG("reply FOR DATA_SIZE = %lu\n",msize);
652 pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
653 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
654 pm->msg = &reply->header;
655 reply->header.size = htons ((uint16_t) msize);
656 reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
657 reply->type = htonl (type);
658 reply->get_path_length = htonl (get_path_length);
659 reply->put_path_length = htonl (put_path_length);
660 reply->unique_id = 0; /* filled in later */
661 reply->expiration = GNUNET_TIME_absolute_hton (expiration);
663 paths = (struct GNUNET_PeerIdentity *) &reply[1];
664 memcpy (paths, put_path,
665 sizeof (struct GNUNET_PeerIdentity) * put_path_length);
666 memcpy (&paths[put_path_length], get_path,
667 sizeof (struct GNUNET_PeerIdentity) * get_path_length);
668 memcpy (&paths[get_path_length + put_path_length], data, data_size);
669 frc.do_copy = GNUNET_NO;
672 frc.data_size = data_size;
674 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
676 if (GNUNET_NO == frc.do_copy)
678 /* did not match any of the requests, free! */
679 GNUNET_STATISTICS_update (GDS_stats,
681 ("# REPLIES ignored for CLIENTS (no match)"), 1,
689 * Check if some client is monitoring GET messages and notify
692 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
693 * @param type The type of data in the request.
694 * @param hop_count Hop count so far.
695 * @param path_length number of entries in path (or 0 if not recorded).
696 * @param path peers on the GET path (or NULL if not recorded).
697 * @param desired_replication_level Desired replication level.
698 * @param key Key of the requested data.
701 GDS_CLIENTS_process_get (uint32_t options,
702 enum GNUNET_BLOCK_Type type,
704 uint32_t desired_replication_level,
705 unsigned int path_length,
706 const struct GNUNET_PeerIdentity *path,
707 const struct GNUNET_HashCode *key)
709 struct ClientMonitorRecord *m;
710 struct ClientList **cl;
711 unsigned int cl_size;
715 for (m = monitor_head; NULL != m; m = m->next)
717 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
719 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
721 struct PendingMessage *pm;
722 struct GNUNET_DHT_MonitorGetMessage *mmsg;
723 struct GNUNET_PeerIdentity *msg_path;
727 /* Don't send duplicates */
728 for (i = 0; i < cl_size; i++)
729 if (cl[i] == m->client)
733 GNUNET_array_append (cl, cl_size, m->client);
735 msize = path_length * sizeof (struct GNUNET_PeerIdentity);
736 msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
737 msize += sizeof (struct PendingMessage);
738 pm = GNUNET_malloc (msize);
739 mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
740 pm->msg = &mmsg->header;
741 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
742 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
743 mmsg->options = htonl(options);
744 mmsg->type = htonl(type);
745 mmsg->hop_count = htonl(hop_count);
746 mmsg->desired_replication_level = htonl(desired_replication_level);
747 mmsg->get_path_length = htonl(path_length);
748 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
749 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
751 memcpy (msg_path, path,
752 path_length * sizeof (struct GNUNET_PeerIdentity));
753 add_pending_message (m->client, pm);
756 GNUNET_free_non_null (cl);
761 * Check if some client is monitoring PUT messages and notify
764 * @param options options, for instance RecordRoute, DemultiplexEverywhere.
765 * @param type type of data in the request.
766 * @param hop_count hop count so far.
767 * @param path_length number of entries in @a path (or 0 if not recorded).
768 * @param path peers on the PUT path (or NULL if not recorded).
769 * @param desired_replication_level desired replication level.
770 * @param exp expiration time of the data.
771 * @param key key under which @a data is to be stored.
772 * @param data pointer to the data carried.
773 * @param size number of bytes in @a data.
776 GDS_CLIENTS_process_put (uint32_t options,
777 enum GNUNET_BLOCK_Type type,
779 uint32_t desired_replication_level,
780 unsigned int path_length,
781 const struct GNUNET_PeerIdentity *path,
782 struct GNUNET_TIME_Absolute exp,
783 const struct GNUNET_HashCode *key,
787 struct ClientMonitorRecord *m;
788 struct ClientList **cl;
789 unsigned int cl_size;
793 for (m = monitor_head; NULL != m; m = m->next)
795 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
797 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
799 struct PendingMessage *pm;
800 struct GNUNET_DHT_MonitorPutMessage *mmsg;
801 struct GNUNET_PeerIdentity *msg_path;
805 /* Don't send duplicates */
806 for (i = 0; i < cl_size; i++)
807 if (cl[i] == m->client)
811 GNUNET_array_append (cl, cl_size, m->client);
814 msize += path_length * sizeof (struct GNUNET_PeerIdentity);
815 msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
816 msize += sizeof (struct PendingMessage);
817 pm = GNUNET_malloc (msize);
818 mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
819 pm->msg = (struct GNUNET_MessageHeader *) mmsg;
820 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
821 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
822 mmsg->options = htonl(options);
823 mmsg->type = htonl(type);
824 mmsg->hop_count = htonl(hop_count);
825 mmsg->desired_replication_level = htonl(desired_replication_level);
826 mmsg->put_path_length = htonl(path_length);
827 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
830 memcpy (msg_path, path,
831 path_length * sizeof (struct GNUNET_PeerIdentity));
833 mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
834 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
836 memcpy (&msg_path[path_length], data, size);
837 add_pending_message (m->client, pm);
840 GNUNET_free_non_null (cl);
845 * Route the given request via the DHT.
848 transmit_request (struct ClientQueryRecord *cqr)
850 GNUNET_STATISTICS_update (GDS_stats,
852 ("# GET requests from clients injected"), 1,
855 LOG (GNUNET_ERROR_TYPE_DEBUG,
856 "Initiating GET for %s, replication %u, already have %u replies\n",
857 GNUNET_h2s (&cqr->key),
859 cqr->seen_replies_count);
861 GDS_NEIGHBOURS_handle_get (&cqr->key, cqr->type, cqr->msg_options,
864 /* exponential back-off for retries.
865 * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
866 cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
867 cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
872 * Task that looks at the 'retry_heap' and transmits all of the requests
873 * on the heap that are ready for transmission. Then re-schedules
874 * itself (unless the heap is empty).
879 transmit_next_request_task (void *cls)
881 struct ClientQueryRecord *cqr;
882 struct GNUNET_TIME_Relative delay;
885 while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
888 delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
889 if (delay.rel_value_us > 0)
892 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
893 cqr->retry_time.abs_value_us);
895 GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
899 transmit_request (cqr);
901 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
902 cqr->retry_time.abs_value_us);
908 * Handler for PUT messages.
910 * @param cls closure for the service
911 * @param client the client we received this message from
912 * @param message the actual message received
915 handle_dht_local_put (void *cls,
916 struct GNUNET_SERVER_Client *client,
917 const struct GNUNET_MessageHeader *message)
919 const struct GNUNET_DHT_ClientPutMessage *put_msg;
920 struct PendingMessage *pm;
921 struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
924 size = ntohs (message->size);
925 if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
928 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
931 GNUNET_STATISTICS_update (GDS_stats,
933 ("# PUT requests received from clients"), 1,
935 put_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
936 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE DHT CLIENT-PUT %s\n",
937 GNUNET_h2s_full (&put_msg->key));
938 /* give to local clients */
939 LOG (GNUNET_ERROR_TYPE_DEBUG,
940 "Handling local PUT of %u-bytes for query %s\n",
941 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
942 GNUNET_h2s (&put_msg->key));
943 DEBUG("PUT doing put i = %s\n",GNUNET_h2s(&(put_msg->key)));
944 GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
945 &put_msg->key, 0, NULL, 0, NULL,
946 ntohl (put_msg->type),
947 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
950 GDS_NEIGHBOURS_handle_put (&put_msg->key,
951 ntohl (put_msg->type), ntohl (put_msg->options),
952 ntohl (put_msg->desired_replication_level),
953 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
955 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
956 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
957 sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
958 conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
959 conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
960 conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
961 conf->reserved = htonl (0);
962 conf->unique_id = put_msg->unique_id;
963 pm->msg = &conf->header;
964 add_pending_message (find_active_client (client), pm);
965 GNUNET_SERVER_receive_done (client, GNUNET_OK);
970 * Handler for DHT GET messages from the client.
972 * @param cls closure for the service
973 * @param client the client we received this message from
974 * @param message the actual message received
977 handle_dht_local_get (void *cls,
978 struct GNUNET_SERVER_Client *client,
979 const struct GNUNET_MessageHeader *message)
981 const struct GNUNET_DHT_ClientGetMessage *get;
982 struct ClientQueryRecord *cqr;
987 size = ntohs (message->size);
988 if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
991 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
994 xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
995 get = (const struct GNUNET_DHT_ClientGetMessage *) message;
996 xquery = (const char *) &get[1];
997 GNUNET_STATISTICS_update (GDS_stats,
999 ("# GET requests received from clients"), 1,
1001 LOG (GNUNET_ERROR_TYPE_DEBUG,
1002 "Received GET request for %s from local client %p, xq: %.*s\n",
1003 GNUNET_h2s (&get->key), client, xquery_size, xquery);
1005 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE CLIENT-GET %s\n",
1006 GNUNET_h2s_full (&get->key));
1009 cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
1010 cqr->key = get->key;
1011 cqr->client = find_active_client (client);
1012 cqr->xquery = (void *) &cqr[1];
1013 memcpy (&cqr[1], xquery, xquery_size);
1014 cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
1015 cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
1016 cqr->retry_time = GNUNET_TIME_absolute_get ();
1017 cqr->unique_id = get->unique_id;
1018 cqr->xquery_size = xquery_size;
1019 cqr->replication = ntohl (get->desired_replication_level);
1020 cqr->msg_options = ntohl (get->options);
1021 cqr->type = ntohl (get->type);
1023 // FIXME use cqr->key, set multihashmap create to GNUNET_YES
1024 GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
1025 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1027 struct GNUNET_PeerIdentity my_identity;
1028 my_identity = GDS_NEIGHBOURS_get_my_id();
1029 GDS_CLIENTS_process_get (ntohl (get->options),
1032 ntohl (get->desired_replication_level),
1036 /* start remote requests */
1037 if (NULL != retry_task)
1038 GNUNET_SCHEDULER_cancel (retry_task);
1039 retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
1040 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1045 * Closure for #find_by_unique_id().
1047 struct FindByUniqueIdContext
1050 * Where to store the result, if found.
1052 struct ClientQueryRecord *cqr;
1055 * Which ID are we looking for?
1062 * Function called for each existing DHT record for the given
1063 * query. Checks if it matches the UID given in the closure
1064 * and if so returns the entry as a result.
1066 * @param cls the search context
1067 * @param key query for the lookup (not used)
1068 * @param value the `struct ClientQueryRecord`
1069 * @return #GNUNET_YES to continue iteration (result not yet found)
1072 find_by_unique_id (void *cls,
1073 const struct GNUNET_HashCode *key,
1076 struct FindByUniqueIdContext *fui_ctx = cls;
1077 struct ClientQueryRecord *cqr = value;
1079 if (cqr->unique_id != fui_ctx->unique_id)
1087 * Handler for "GET result seen" messages from the client.
1089 * @param cls closure for the service
1090 * @param client the client we received this message from
1091 * @param message the actual message received
1094 handle_dht_local_get_result_seen (void *cls,
1095 struct GNUNET_SERVER_Client *client,
1096 const struct GNUNET_MessageHeader *message)
1098 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
1100 unsigned int hash_count;
1101 unsigned int old_count;
1102 const struct GNUNET_HashCode *hc;
1103 struct FindByUniqueIdContext fui_ctx;
1104 struct ClientQueryRecord *cqr;
1106 size = ntohs (message->size);
1107 if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
1110 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1113 seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
1114 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
1115 if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
1118 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1121 hc = (const struct GNUNET_HashCode*) &seen[1];
1122 fui_ctx.unique_id = seen->unique_id;
1124 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1128 if (NULL == (cqr = fui_ctx.cqr))
1131 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1134 /* finally, update 'seen' list */
1135 old_count = cqr->seen_replies_count;
1136 GNUNET_array_grow (cqr->seen_replies,
1137 cqr->seen_replies_count,
1138 cqr->seen_replies_count + hash_count);
1139 memcpy (&cqr->seen_replies[old_count],
1141 sizeof (struct GNUNET_HashCode) * hash_count);
1146 * Closure for #remove_by_unique_id().
1148 struct RemoveByUniqueIdContext
1151 * Client that issued the removal request.
1153 struct ClientList *client;
1156 * Unique ID of the request.
1163 * Iterator over hash map entries that frees all entries
1164 * that match the given client and unique ID.
1166 * @param cls unique ID and client to search for in source routes
1167 * @param key current key code
1168 * @param value value in the hash map, a ClientQueryRecord
1169 * @return #GNUNET_YES (we should continue to iterate)
1172 remove_by_unique_id (void *cls,
1173 const struct GNUNET_HashCode *key,
1176 const struct RemoveByUniqueIdContext *ctx = cls;
1177 struct ClientQueryRecord *record = value;
1179 if (record->unique_id != ctx->unique_id)
1181 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1182 "Removing client %p's record for key %s (by unique id)\n",
1183 ctx->client->client_handle, GNUNET_h2s (key));
1184 return remove_client_records (ctx->client, key, record);
1189 * Handler for any generic DHT stop messages, calls the appropriate handler
1190 * depending on message type (if processed locally)
1192 * @param cls closure for the service
1193 * @param client the client we received this message from
1194 * @param message the actual message received
1198 handle_dht_local_get_stop (void *cls,
1199 struct GNUNET_SERVER_Client *client,
1200 const struct GNUNET_MessageHeader *message)
1202 const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
1203 (const struct GNUNET_DHT_ClientGetStopMessage *) message;
1204 struct RemoveByUniqueIdContext ctx;
1206 GNUNET_STATISTICS_update (GDS_stats,
1208 ("# GET STOP requests received from clients"), 1,
1210 LOG (GNUNET_ERROR_TYPE_DEBUG,
1211 "Received GET STOP request for %s from local client %p\n",
1212 client, GNUNET_h2s (&dht_stop_msg->key));
1213 ctx.client = find_active_client (client);
1214 ctx.unique_id = dht_stop_msg->unique_id;
1215 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
1216 &remove_by_unique_id, &ctx);
1217 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1222 * Handler for monitor start messages
1224 * @param cls closure for the service
1225 * @param client the client we received this message from
1226 * @param message the actual message received
1230 handle_dht_local_monitor (void *cls,
1231 struct GNUNET_SERVER_Client *client,
1232 const struct GNUNET_MessageHeader *message)
1234 struct ClientMonitorRecord *r;
1235 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1237 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1238 r = GNUNET_new (struct ClientMonitorRecord);
1240 r->client = find_active_client(client);
1241 r->type = ntohl(msg->type);
1242 r->get = ntohs(msg->get);
1243 r->get_resp = ntohs(msg->get_resp);
1244 r->put = ntohs(msg->put);
1245 if (0 == ntohs(msg->filter_key))
1249 r->key = GNUNET_new (struct GNUNET_HashCode);
1250 memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
1252 GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
1253 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1258 * Handler for monitor stop messages
1260 * @param cls closure for the service
1261 * @param client the client we received this message from
1262 * @param message the actual message received
1265 handle_dht_local_monitor_stop (void *cls,
1266 struct GNUNET_SERVER_Client *client,
1267 const struct GNUNET_MessageHeader *message)
1269 struct ClientMonitorRecord *r;
1270 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1273 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1279 keys_match = (0 == ntohs(msg->filter_key));
1282 keys_match = (0 != ntohs(msg->filter_key)
1283 && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
1285 if (find_active_client(client) == r->client
1286 && ntohl(msg->type) == r->type
1287 && r->get == msg->get
1288 && r->get_resp == msg->get_resp
1289 && r->put == msg->put
1293 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
1294 GNUNET_free_non_null (r->key);
1296 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1297 return; /* Delete only ONE entry */
1301 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1306 * Functions with this signature are called whenever a client
1307 * is disconnected on the network level.
1309 * @param cls closure (NULL for dht)
1310 * @param client identification of the client; NULL
1311 * for the last call when the server is destroyed
1314 handle_client_disconnect (void *cls,
1315 struct GNUNET_SERVER_Client *client)
1317 struct ClientList *pos;
1318 struct PendingMessage *reply;
1319 struct ClientMonitorRecord *monitor;
1321 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1322 "Local client %p disconnects\n",
1324 pos = find_active_client (client);
1325 GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
1326 if (pos->transmit_handle != NULL)
1327 GNUNET_SERVER_notify_transmit_ready_cancel (pos->transmit_handle);
1328 while (NULL != (reply = pos->pending_head))
1330 GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
1331 GNUNET_free (reply);
1333 monitor = monitor_head;
1334 while (NULL != monitor)
1336 if (monitor->client == pos)
1338 struct ClientMonitorRecord *next;
1340 GNUNET_free_non_null (monitor->key);
1341 next = monitor->next;
1342 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
1343 GNUNET_free (monitor);
1347 monitor = monitor->next;
1349 GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
1356 * Initialize client subsystem.
1358 * @param server the initialized server
1361 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1363 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1364 {&handle_dht_local_put, NULL,
1365 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1366 {&handle_dht_local_get, NULL,
1367 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1368 {&handle_dht_local_get_stop, NULL,
1369 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1370 sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1371 {&handle_dht_local_monitor, NULL,
1372 GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1373 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1374 {&handle_dht_local_monitor_stop, NULL,
1375 GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1376 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1377 {&handle_dht_local_get_result_seen, NULL,
1378 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1381 forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1382 retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1383 GNUNET_SERVER_add_handlers (server, plugin_handlers);
1384 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1389 * Shutdown client subsystem.
1394 GNUNET_assert (client_head == NULL);
1395 GNUNET_assert (client_tail == NULL);
1396 if (NULL != retry_task)
1398 GNUNET_SCHEDULER_cancel (retry_task);
1401 if (NULL != retry_heap)
1403 GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1404 GNUNET_CONTAINER_heap_destroy (retry_heap);
1407 if (NULL != forward_map)
1409 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1410 GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1415 /* end of gnunet-service-wdht_clients.c */