2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file 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-xdht.h"
33 #include "gnunet-service-xdht_clients.h"
34 #include "gnunet-service-xdht_datacache.h"
35 #include "gnunet-service-xdht_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 * Linked list of messages to send to clients.
52 * Pointer to next item in the list
54 struct PendingMessage *next;
57 * Pointer to previous item in the list
59 struct PendingMessage *prev;
62 * Actual message to be sent, allocated at the end of the struct:
63 * // msg = (cast) &pm[1];
64 * // memcpy (&pm[1], data, len);
66 const struct GNUNET_MessageHeader *msg;
72 * Struct containing information about a client,
73 * handle to connect to it, and any pending messages
74 * that need to be sent to it.
79 * Linked list of active clients
81 struct ClientList *next;
84 * Linked list of active clients
86 struct ClientList *prev;
89 * The handle to this client
91 struct GNUNET_SERVER_Client *client_handle;
94 * Handle to the current transmission request, NULL
97 struct GNUNET_SERVER_TransmitHandle *transmit_handle;
100 * Linked list of pending messages for this client
102 struct PendingMessage *pending_head;
105 * Tail of linked list of pending messages for this client
107 struct PendingMessage *pending_tail;
113 * Entry in the local forwarding map for a client's GET request.
115 struct ClientQueryRecord
119 * The key this request was about
121 struct GNUNET_HashCode key;
124 * Client responsible for the request.
126 struct ClientList *client;
129 * Extended query (see gnunet_block_lib.h), allocated at the end of this struct.
134 * Replies we have already seen for this request.
136 struct GNUNET_HashCode *seen_replies;
139 * Pointer to this nodes heap location in the retry-heap (for fast removal)
141 struct GNUNET_CONTAINER_HeapNode *hnode;
144 * What's the delay between re-try operations that we currently use for this
147 struct GNUNET_TIME_Relative retry_frequency;
150 * What's the next time we should re-try this request?
152 struct GNUNET_TIME_Absolute retry_time;
155 * The unique identifier of this request
160 * Number of bytes in xquery.
165 * Number of entries in 'seen_replies'.
167 unsigned int seen_replies_count;
170 * Desired replication level
172 uint32_t replication;
175 * Any message options for this request
177 uint32_t msg_options;
180 * The type for the data for the GET request.
182 enum GNUNET_BLOCK_Type type;
188 * Struct containing paremeters of monitoring requests.
190 struct ClientMonitorRecord
194 * Next element in DLL.
196 struct ClientMonitorRecord *next;
199 * Previous element in DLL.
201 struct ClientMonitorRecord *prev;
204 * Type of blocks that are of interest
206 enum GNUNET_BLOCK_Type type;
209 * Key of data of interest, NULL for all.
211 struct GNUNET_HashCode *key;
214 * Flag whether to notify about GET messages.
219 * Flag whether to notify about GET_REPONSE messages.
224 * Flag whether to notify about PUT messages.
229 * Client to notify of these requests.
231 struct ClientList *client;
236 * List of active clients.
238 static struct ClientList *client_head;
241 * List of active clients.
243 static struct ClientList *client_tail;
246 * List of active monitoring requests.
248 static struct ClientMonitorRecord *monitor_head;
251 * List of active monitoring requests.
253 static struct ClientMonitorRecord *monitor_tail;
256 * Hashmap for fast key based lookup, maps keys to `struct ClientQueryRecord` entries.
258 static struct GNUNET_CONTAINER_MultiHashMap *forward_map;
261 * Heap with all of our client's request, sorted by retry time (earliest on top).
263 static struct GNUNET_CONTAINER_Heap *retry_heap;
266 * Task that re-transmits requests (using retry_heap).
268 static GNUNET_SCHEDULER_TaskIdentifier retry_task;
272 * Task run to check for messages that need to be sent to a client.
274 * @param client a ClientList, containing the client and any messages to be sent to it
277 process_pending_messages (struct ClientList *client);
281 * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
282 * request. A ClientList is passed as closure, take the head of the list
283 * and copy it into buf, which has the result of sending the message to the
286 * @param cls closure to this call
287 * @param size maximum number of bytes available to send
288 * @param buf where to copy the actual message to
290 * @return the number of bytes actually copied, 0 indicates failure
293 send_reply_to_client (void *cls, size_t size, void *buf)
295 struct ClientList *client = cls;
297 struct PendingMessage *reply;
301 client->transmit_handle = NULL;
304 /* client disconnected */
305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
306 "Client %p disconnected, pending messages will be discarded\n",
307 client->client_handle);
311 while ((NULL != (reply = client->pending_head)) &&
312 (size >= off + (msize = ntohs (reply->msg->size))))
314 GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
316 memcpy (&cbuf[off], reply->msg, msize);
318 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes to client %p\n",
319 msize, client->client_handle);
322 process_pending_messages (client);
323 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitted %u/%u bytes to client %p\n",
324 (unsigned int) off, (unsigned int) size, client->client_handle);
330 * Task run to check for messages that need to be sent to a client.
332 * @param client a ClientList, containing the client and any messages to be sent to it
335 process_pending_messages (struct ClientList *client)
337 if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
339 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
340 "Not asking for transmission to %p now: %s\n",
341 client->client_handle,
342 client->pending_head ==
343 NULL ? "no more messages" : "request already pending");
346 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
347 "Asking for transmission of %u bytes to client %p\n",
348 ntohs (client->pending_head->msg->size), client->client_handle);
349 client->transmit_handle =
350 GNUNET_SERVER_notify_transmit_ready (client->client_handle,
351 ntohs (client->pending_head->
353 GNUNET_TIME_UNIT_FOREVER_REL,
354 &send_reply_to_client, client);
359 * Add a PendingMessage to the clients list of messages to be sent
361 * @param client the active client to send the message to
362 * @param pending_message the actual message to send
365 add_pending_message (struct ClientList *client,
366 struct PendingMessage *pending_message)
368 GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
370 process_pending_messages (client);
375 * Closure for 'forward_reply'
377 struct ForwardReplyContext
381 * Actual message to send to matching clients.
383 struct PendingMessage *pm;
393 enum GNUNET_BLOCK_Type type;
396 * Number of bytes in data.
401 * Do we need to copy 'pm' because it was already used?
409 * Find a client if it exists, add it otherwise.
411 * @param client the server handle to the client
413 * @return the client if found, a new client otherwise
415 static struct ClientList *
416 find_active_client (struct GNUNET_SERVER_Client *client)
418 struct ClientList *pos = client_head;
419 struct ClientList *ret;
423 if (pos->client_handle == client)
427 ret = GNUNET_new (struct ClientList);
428 ret->client_handle = client;
429 GNUNET_CONTAINER_DLL_insert (client_head, client_tail, ret);
435 * Iterator over hash map entries that frees all entries
436 * associated with the given client.
438 * @param cls client to search for in source routes
439 * @param key current key code (ignored)
440 * @param value value in the hash map, a ClientQueryRecord
441 * @return #GNUNET_YES (we should continue to iterate)
444 remove_client_records (void *cls, const struct GNUNET_HashCode * key, void *value)
446 struct ClientList *client = cls;
447 struct ClientQueryRecord *record = value;
449 if (record->client != client)
451 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
452 "Removing client %p's record for key %s\n", client,
454 GNUNET_assert (GNUNET_YES ==
455 GNUNET_CONTAINER_multihashmap_remove (forward_map, key,
457 if (NULL != record->hnode)
458 GNUNET_CONTAINER_heap_remove_node (record->hnode);
459 GNUNET_array_grow (record->seen_replies, record->seen_replies_count, 0);
460 GNUNET_free (record);
466 * Iterator over hash map entries that send a given reply to
467 * each of the matching clients. With some tricky recycling
470 * @param cls the 'struct ForwardReplyContext'
471 * @param key current key
472 * @param value value in the hash map, a ClientQueryRecord
473 * @return GNUNET_YES (we should continue to iterate),
474 * if the result is mal-formed, GNUNET_NO
477 forward_reply (void *cls, const struct GNUNET_HashCode * key, void *value)
479 struct ForwardReplyContext *frc = cls;
480 struct ClientQueryRecord *record = value;
481 struct PendingMessage *pm;
482 struct GNUNET_DHT_ClientResultMessage *reply;
483 enum GNUNET_BLOCK_EvaluationResult eval;
485 struct GNUNET_HashCode ch;
488 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
489 "R5N CLIENT-RESULT %s\n",
490 GNUNET_h2s_full (key));
491 if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
493 LOG (GNUNET_ERROR_TYPE_DEBUG,
494 "Record type missmatch, not passing request for key %s to local client\n",
496 GNUNET_STATISTICS_update (GDS_stats,
498 ("# Key match, type mismatches in REPLY to CLIENT"),
500 return GNUNET_YES; /* type mismatch */
502 GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
503 for (i = 0; i < record->seen_replies_count; i++)
504 if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
506 LOG (GNUNET_ERROR_TYPE_DEBUG,
507 "Duplicate reply, not passing request for key %s to local client\n",
509 GNUNET_STATISTICS_update (GDS_stats,
511 ("# Duplicate REPLIES to CLIENT request dropped"),
513 return GNUNET_YES; /* duplicate */
516 GNUNET_BLOCK_evaluate (GDS_block_context, record->type, key, NULL, 0,
517 record->xquery, record->xquery_size, frc->data,
519 LOG (GNUNET_ERROR_TYPE_DEBUG,
520 "Evaluation result is %d for key %s for local client's query\n",
521 (int) eval, GNUNET_h2s (key));
524 case GNUNET_BLOCK_EVALUATION_OK_LAST:
525 do_free = GNUNET_YES;
527 case GNUNET_BLOCK_EVALUATION_OK_MORE:
528 GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
531 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
532 /* should be impossible to encounter here */
535 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
538 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
541 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
544 case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
546 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
547 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
548 _("Unsupported block type (%u) in request!\n"), record->type);
554 if (GNUNET_NO == frc->do_copy)
556 /* first time, we can use the original data */
558 frc->do_copy = GNUNET_YES;
562 /* two clients waiting for same reply, must copy for queueing */
563 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
564 ntohs (frc->pm->msg->size));
566 sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
567 pm->next = pm->prev = NULL;
568 pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
570 GNUNET_STATISTICS_update (GDS_stats,
571 gettext_noop ("# RESULTS queued for clients"), 1,
573 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
574 reply->unique_id = record->unique_id;
575 LOG (GNUNET_ERROR_TYPE_DEBUG,
576 "Queueing reply to query %s for client %p\n",
578 record->client->client_handle);
579 add_pending_message (record->client, pm);
580 if (GNUNET_YES == do_free)
581 remove_client_records (record->client, key, record);
587 * Handle a reply we've received from another peer. If the reply
588 * matches any of our pending queries, forward it to the respective
591 * @param expiration when will the reply expire
592 * @param key the query this reply is for
593 * @param get_path_length number of peers in @a get_path
594 * @param get_path path the reply took on get
595 * @param put_path_length number of peers in @a put_path
596 * @param put_path path the reply took on put
597 * @param type type of the reply
598 * @param data_size number of bytes in @a data
599 * @param data application payload data
602 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
603 const struct GNUNET_HashCode *key,
604 unsigned int get_path_length,
605 const struct GNUNET_PeerIdentity *get_path,
606 unsigned int put_path_length,
607 const struct GNUNET_PeerIdentity *put_path,
608 enum GNUNET_BLOCK_Type type, size_t data_size,
611 struct ForwardReplyContext frc;
612 struct PendingMessage *pm;
613 struct GNUNET_DHT_ClientResultMessage *reply;
614 struct GNUNET_PeerIdentity *paths;
617 LOG (GNUNET_ERROR_TYPE_DEBUG,
618 "reply for key %s\n",
621 if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
623 GNUNET_STATISTICS_update (GDS_stats,
625 ("# REPLIES ignored for CLIENTS (no match)"), 1,
627 return; /* no matching request, fast exit! */
630 sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
631 (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
632 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
634 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
635 _("Could not pass reply to client, message too big!\n"));
638 pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
639 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
640 pm->msg = &reply->header;
641 reply->header.size = htons ((uint16_t) msize);
642 reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
643 reply->type = htonl (type);
644 reply->get_path_length = htonl (get_path_length);
645 reply->put_path_length = htonl (put_path_length);
646 reply->unique_id = 0; /* filled in later */
647 reply->expiration = GNUNET_TIME_absolute_hton (expiration);
649 paths = (struct GNUNET_PeerIdentity *) &reply[1];
650 memcpy (paths, put_path,
651 sizeof (struct GNUNET_PeerIdentity) * put_path_length);
652 memcpy (&paths[put_path_length], get_path,
653 sizeof (struct GNUNET_PeerIdentity) * get_path_length);
654 memcpy (&paths[get_path_length + put_path_length], data, data_size);
655 frc.do_copy = GNUNET_NO;
658 frc.data_size = data_size;
660 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
663 if (GNUNET_NO == frc.do_copy)
665 /* did not match any of the requests, free! */
666 GNUNET_STATISTICS_update (GDS_stats,
668 ("# REPLIES ignored for CLIENTS (no match)"), 1,
675 * Check if some client is monitoring GET messages and notify
678 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
679 * @param type The type of data in the request.
680 * @param hop_count Hop count so far.
681 * @param path_length number of entries in path (or 0 if not recorded).
682 * @param path peers on the GET path (or NULL if not recorded).
683 * @param desired_replication_level Desired replication level.
684 * @param key Key of the requested data.
687 GDS_CLIENTS_process_get (uint32_t options,
688 enum GNUNET_BLOCK_Type type,
690 uint32_t desired_replication_level,
691 unsigned int path_length,
692 const struct GNUNET_PeerIdentity *path,
693 const struct GNUNET_HashCode * key)
695 struct ClientMonitorRecord *m;
696 struct ClientList **cl;
697 unsigned int cl_size;
701 for (m = monitor_head; NULL != m; m = m->next)
703 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
705 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
707 struct PendingMessage *pm;
708 struct GNUNET_DHT_MonitorGetMessage *mmsg;
709 struct GNUNET_PeerIdentity *msg_path;
713 /* Don't send duplicates */
714 for (i = 0; i < cl_size; i++)
715 if (cl[i] == m->client)
719 GNUNET_array_append (cl, cl_size, m->client);
721 msize = path_length * sizeof (struct GNUNET_PeerIdentity);
722 msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
723 msize += sizeof (struct PendingMessage);
724 pm = GNUNET_malloc (msize);
725 mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
726 pm->msg = &mmsg->header;
727 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
728 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
729 mmsg->options = htonl(options);
730 mmsg->type = htonl(type);
731 mmsg->hop_count = htonl(hop_count);
732 mmsg->desired_replication_level = htonl(desired_replication_level);
733 mmsg->get_path_length = htonl(path_length);
734 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
735 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
737 memcpy (msg_path, path,
738 path_length * sizeof (struct GNUNET_PeerIdentity));
739 add_pending_message (m->client, pm);
742 GNUNET_free_non_null (cl);
747 * Check if some client is monitoring PUT messages and notify
750 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
751 * @param type The type of data in the request.
752 * @param hop_count Hop count so far.
753 * @param path_length number of entries in path (or 0 if not recorded).
754 * @param path peers on the PUT path (or NULL if not recorded).
755 * @param desired_replication_level Desired replication level.
756 * @param exp Expiration time of the data.
757 * @param key Key under which data is to be stored.
758 * @param data Pointer to the data carried.
759 * @param size Number of bytes in data.
762 GDS_CLIENTS_process_put (uint32_t options,
763 enum GNUNET_BLOCK_Type type,
765 uint32_t desired_replication_level,
766 unsigned int path_length,
767 const struct GNUNET_PeerIdentity *path,
768 struct GNUNET_TIME_Absolute exp,
769 const struct GNUNET_HashCode * key,
773 struct ClientMonitorRecord *m;
774 struct ClientList **cl;
775 unsigned int cl_size;
779 for (m = monitor_head; NULL != m; m = m->next)
781 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
783 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
785 struct PendingMessage *pm;
786 struct GNUNET_DHT_MonitorPutMessage *mmsg;
787 struct GNUNET_PeerIdentity *msg_path;
791 /* Don't send duplicates */
792 for (i = 0; i < cl_size; i++)
793 if (cl[i] == m->client)
797 GNUNET_array_append (cl, cl_size, m->client);
800 msize += path_length * sizeof (struct GNUNET_PeerIdentity);
801 msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
802 msize += sizeof (struct PendingMessage);
803 pm = GNUNET_malloc (msize);
804 mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
805 pm->msg = (struct GNUNET_MessageHeader *) mmsg;
806 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
807 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
808 mmsg->options = htonl(options);
809 mmsg->type = htonl(type);
810 mmsg->hop_count = htonl(hop_count);
811 mmsg->desired_replication_level = htonl(desired_replication_level);
812 mmsg->put_path_length = htonl(path_length);
813 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
816 memcpy (msg_path, path,
817 path_length * sizeof (struct GNUNET_PeerIdentity));
819 mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
820 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
822 memcpy (&msg_path[path_length], data, size);
823 add_pending_message (m->client, pm);
826 GNUNET_free_non_null (cl);
831 * Route the given request via the DHT.
834 transmit_request (struct ClientQueryRecord *cqr)
836 GNUNET_STATISTICS_update (GDS_stats,
838 ("# GET requests from clients injected"), 1,
841 LOG (GNUNET_ERROR_TYPE_DEBUG,
842 "Initiating GET for %s, replication %u, already have %u replies\n",
843 GNUNET_h2s (&cqr->key),
845 cqr->seen_replies_count);
847 /* FIXME: Change it to your own handle_get. */
848 GDS_NEIGHBOURS_handle_get (cqr->type, cqr->msg_options, cqr->replication,
850 &cqr->key, cqr->xquery, cqr->xquery_size, reply_bf,
851 reply_bf_mutator, peer_bf);
855 /* exponential back-off for retries.
856 * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
857 cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
858 cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
863 * Task that looks at the 'retry_heap' and transmits all of the requests
864 * on the heap that are ready for transmission. Then re-schedules
865 * itself (unless the heap is empty).
868 * @param tc scheduler context
871 transmit_next_request_task (void *cls,
872 const struct GNUNET_SCHEDULER_TaskContext *tc)
874 struct ClientQueryRecord *cqr;
875 struct GNUNET_TIME_Relative delay;
877 retry_task = GNUNET_SCHEDULER_NO_TASK;
878 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
880 while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
883 delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
884 if (delay.rel_value_us > 0)
887 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
888 cqr->retry_time.abs_value_us);
890 GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
894 transmit_request (cqr);
896 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
897 cqr->retry_time.abs_value_us);
903 * Handler for PUT messages.
905 * @param cls closure for the service
906 * @param client the client we received this message from
907 * @param message the actual message received
910 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
911 const struct GNUNET_MessageHeader *message)
913 const struct GNUNET_DHT_ClientPutMessage *put_msg;
914 struct PendingMessage *pm;
915 struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
918 size = ntohs (message->size);
919 if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
922 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
925 GNUNET_STATISTICS_update (GDS_stats,
927 ("# PUT requests received from clients"), 1,
929 put_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
930 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "R5N CLIENT-PUT %s\n",
931 GNUNET_h2s_full (&put_msg->key));
932 /* give to local clients */
933 LOG (GNUNET_ERROR_TYPE_DEBUG,
934 "Handling local PUT of %u-bytes for query %s\n",
935 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
936 GNUNET_h2s (&put_msg->key));
938 GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
939 &put_msg->key, 0, NULL, 0, NULL,
940 ntohl (put_msg->type),
941 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
944 GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
945 &put_msg->key, 0, NULL, ntohl (put_msg->type),
946 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
949 /* FIXME: At the moment we don't use replication in x-vine. But keep it for
950 time being. Check all the fields again. */
951 GDS_NEIGHBOURS_handle_put (ntohl (put_msg->type), ntohl (put_msg->options),
952 ntohl (put_msg->desired_replication_level),
953 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
955 &put_msg->key, 0, NULL, &put_msg[1],
957 sizeof (struct GNUNET_DHT_ClientPutMessage),
960 GDS_CLIENTS_process_put (ntohl (put_msg->options),
961 ntohl (put_msg->type),
963 ntohl (put_msg->desired_replication_level),
965 GDS_NEIGHBOURS_get_id(),
966 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
969 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
971 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
972 sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
973 conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
974 conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
975 conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
976 conf->reserved = htonl (0);
977 conf->unique_id = put_msg->unique_id;
978 pm->msg = &conf->header;
979 add_pending_message (find_active_client (client), pm);
980 GNUNET_SERVER_receive_done (client, GNUNET_OK);
985 * Handler for DHT GET messages from the client.
987 * @param cls closure for the service
988 * @param client the client we received this message from
989 * @param message the actual message received
992 handle_dht_local_get (void *cls, struct GNUNET_SERVER_Client *client,
993 const struct GNUNET_MessageHeader *message)
995 const struct GNUNET_DHT_ClientGetMessage *get;
996 struct ClientQueryRecord *cqr;
1001 size = ntohs (message->size);
1002 if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
1005 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1008 xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
1009 get = (const struct GNUNET_DHT_ClientGetMessage *) message;
1010 xquery = (const char *) &get[1];
1011 GNUNET_STATISTICS_update (GDS_stats,
1013 ("# GET requests received from clients"), 1,
1015 LOG (GNUNET_ERROR_TYPE_DEBUG,
1016 "Received GET request for %s from local client %p, xq: %.*s\n",
1017 GNUNET_h2s (&get->key), client, xquery_size, xquery);
1019 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "R5N CLIENT-GET %s\n",
1020 GNUNET_h2s_full (&get->key));
1023 cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
1024 cqr->key = get->key;
1025 cqr->client = find_active_client (client);
1026 cqr->xquery = (void *) &cqr[1];
1027 memcpy (&cqr[1], xquery, xquery_size);
1028 cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
1029 cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
1030 cqr->retry_time = GNUNET_TIME_absolute_get ();
1031 cqr->unique_id = get->unique_id;
1032 cqr->xquery_size = xquery_size;
1033 cqr->replication = ntohl (get->desired_replication_level);
1034 cqr->msg_options = ntohl (get->options);
1035 cqr->type = ntohl (get->type);
1036 // FIXME use cqr->key, set multihashmap create to GNUNET_YES
1037 GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
1038 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1039 GDS_CLIENTS_process_get (ntohl (get->options),
1042 ntohl (get->desired_replication_level),
1044 GDS_NEIGHBOURS_get_id(),
1046 /* start remote requests */
1047 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1048 GNUNET_SCHEDULER_cancel (retry_task);
1049 retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
1050 /* perform local lookup */
1051 GDS_DATACACHE_handle_get (&get->key, cqr->type, cqr->xquery, xquery_size,
1053 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1058 * Closure for 'find_by_unique_id'.
1060 struct FindByUniqueIdContext
1063 * Where to store the result, if found.
1065 struct ClientQueryRecord *cqr;
1072 * Function called for each existing DHT record for the given
1073 * query. Checks if it matches the UID given in the closure
1074 * and if so returns the entry as a result.
1076 * @param cls the search context
1077 * @param key query for the lookup (not used)
1078 * @param value the 'struct ClientQueryRecord'
1079 * @return GNUNET_YES to continue iteration (result not yet found)
1082 find_by_unique_id (void *cls,
1083 const struct GNUNET_HashCode *key,
1086 struct FindByUniqueIdContext *fui_ctx = cls;
1087 struct ClientQueryRecord *cqr = value;
1089 if (cqr->unique_id != fui_ctx->unique_id)
1097 * Handler for "GET result seen" messages from the client.
1099 * @param cls closure for the service
1100 * @param client the client we received this message from
1101 * @param message the actual message received
1104 handle_dht_local_get_result_seen (void *cls, struct GNUNET_SERVER_Client *client,
1105 const struct GNUNET_MessageHeader *message)
1107 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
1109 unsigned int hash_count;
1110 unsigned int old_count;
1111 const struct GNUNET_HashCode *hc;
1112 struct FindByUniqueIdContext fui_ctx;
1113 struct ClientQueryRecord *cqr;
1115 size = ntohs (message->size);
1116 if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
1119 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1122 seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
1123 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
1124 if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
1127 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1130 hc = (const struct GNUNET_HashCode*) &seen[1];
1131 fui_ctx.unique_id = seen->unique_id;
1133 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1137 if (NULL == (cqr = fui_ctx.cqr))
1140 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1143 /* finally, update 'seen' list */
1144 old_count = cqr->seen_replies_count;
1145 GNUNET_array_grow (cqr->seen_replies,
1146 cqr->seen_replies_count,
1147 cqr->seen_replies_count + hash_count);
1148 memcpy (&cqr->seen_replies[old_count],
1150 sizeof (struct GNUNET_HashCode) * hash_count);
1155 * Closure for 'remove_by_unique_id'.
1157 struct RemoveByUniqueIdContext
1160 * Client that issued the removal request.
1162 struct ClientList *client;
1165 * Unique ID of the request.
1172 * Iterator over hash map entries that frees all entries
1173 * that match the given client and unique ID.
1175 * @param cls unique ID and client to search for in source routes
1176 * @param key current key code
1177 * @param value value in the hash map, a ClientQueryRecord
1178 * @return GNUNET_YES (we should continue to iterate)
1181 remove_by_unique_id (void *cls, const struct GNUNET_HashCode * key, void *value)
1183 const struct RemoveByUniqueIdContext *ctx = cls;
1184 struct ClientQueryRecord *record = value;
1186 if (record->unique_id != ctx->unique_id)
1188 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1189 "Removing client %p's record for key %s (by unique id)\n",
1190 ctx->client->client_handle, GNUNET_h2s (key));
1191 return remove_client_records (ctx->client, key, record);
1196 * Handler for any generic DHT stop messages, calls the appropriate handler
1197 * depending on message type (if processed locally)
1199 * @param cls closure for the service
1200 * @param client the client we received this message from
1201 * @param message the actual message received
1205 handle_dht_local_get_stop (void *cls, struct GNUNET_SERVER_Client *client,
1206 const struct GNUNET_MessageHeader *message)
1208 const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
1209 (const struct GNUNET_DHT_ClientGetStopMessage *) message;
1210 struct RemoveByUniqueIdContext ctx;
1212 GNUNET_STATISTICS_update (GDS_stats,
1214 ("# GET STOP requests received from clients"), 1,
1216 LOG (GNUNET_ERROR_TYPE_DEBUG,
1217 "Received GET STOP request for %s from local client %p\n",
1218 client, GNUNET_h2s (&dht_stop_msg->key));
1219 ctx.client = find_active_client (client);
1220 ctx.unique_id = dht_stop_msg->unique_id;
1221 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
1222 &remove_by_unique_id, &ctx);
1223 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1228 * Handler for monitor start messages
1230 * @param cls closure for the service
1231 * @param client the client we received this message from
1232 * @param message the actual message received
1236 handle_dht_local_monitor (void *cls, struct GNUNET_SERVER_Client *client,
1237 const struct GNUNET_MessageHeader *message)
1239 struct ClientMonitorRecord *r;
1240 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1242 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1243 r = GNUNET_new (struct ClientMonitorRecord);
1245 r->client = find_active_client(client);
1246 r->type = ntohl(msg->type);
1247 r->get = ntohs(msg->get);
1248 r->get_resp = ntohs(msg->get_resp);
1249 r->put = ntohs(msg->put);
1250 if (0 == ntohs(msg->filter_key))
1254 r->key = GNUNET_new (struct GNUNET_HashCode);
1255 memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
1257 GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
1258 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1263 * Handler for monitor stop messages
1265 * @param cls closure for the service
1266 * @param client the client we received this message from
1267 * @param message the actual message received
1271 handle_dht_local_monitor_stop (void *cls, struct GNUNET_SERVER_Client *client,
1272 const struct GNUNET_MessageHeader *message)
1274 struct ClientMonitorRecord *r;
1275 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1278 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1284 keys_match = (0 == ntohs(msg->filter_key));
1287 keys_match = (0 != ntohs(msg->filter_key)
1288 && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
1290 if (find_active_client(client) == r->client
1291 && ntohl(msg->type) == r->type
1292 && r->get == msg->get
1293 && r->get_resp == msg->get_resp
1294 && r->put == msg->put
1298 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
1299 GNUNET_free_non_null (r->key);
1301 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1302 return; /* Delete only ONE entry */
1307 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1312 * Functions with this signature are called whenever a client
1313 * is disconnected on the network level.
1315 * @param cls closure (NULL for dht)
1316 * @param client identification of the client; NULL
1317 * for the last call when the server is destroyed
1320 handle_client_disconnect (void *cls,
1321 struct GNUNET_SERVER_Client *client)
1323 struct ClientList *pos;
1324 struct PendingMessage *reply;
1325 struct ClientMonitorRecord *monitor;
1327 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1328 "Local client %p disconnects\n",
1330 pos = find_active_client (client);
1331 GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
1332 if (pos->transmit_handle != NULL)
1333 GNUNET_SERVER_notify_transmit_ready_cancel (pos->transmit_handle);
1334 while (NULL != (reply = pos->pending_head))
1336 GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
1337 GNUNET_free (reply);
1339 monitor = monitor_head;
1340 while (NULL != monitor)
1342 if (monitor->client == pos)
1344 struct ClientMonitorRecord *next;
1346 GNUNET_free_non_null (monitor->key);
1347 next = monitor->next;
1348 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
1349 GNUNET_free (monitor);
1353 monitor = monitor->next;
1355 GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
1363 * Initialize client subsystem.
1365 * @param server the initialized server
1368 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1370 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1371 {&handle_dht_local_put, NULL,
1372 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1373 {&handle_dht_local_get, NULL,
1374 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1375 {&handle_dht_local_get_stop, NULL,
1376 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1377 sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1378 {&handle_dht_local_monitor, NULL,
1379 GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1380 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1381 {&handle_dht_local_monitor_stop, NULL,
1382 GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1383 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1384 {&handle_dht_local_get_result_seen, NULL,
1385 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1388 forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1389 retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1390 GNUNET_SERVER_add_handlers (server, plugin_handlers);
1391 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1396 * Shutdown client subsystem.
1401 GNUNET_assert (client_head == NULL);
1402 GNUNET_assert (client_tail == NULL);
1403 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1405 GNUNET_SCHEDULER_cancel (retry_task);
1406 retry_task = GNUNET_SCHEDULER_NO_TASK;
1408 if (NULL != retry_heap)
1410 GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1411 GNUNET_CONTAINER_heap_destroy (retry_heap);
1414 if (NULL != forward_map)
1416 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1417 GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1422 /* end of gnunet-service-dht_clients.c */