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__)
48 * Should this peer act malicious?
50 extern unsigned int malicious;
54 * Linked list of messages to send to clients.
59 * Pointer to next item in the list
61 struct PendingMessage *next;
64 * Pointer to previous item in the list
66 struct PendingMessage *prev;
69 * Actual message to be sent, allocated at the end of the struct:
70 * // msg = (cast) &pm[1];
71 * // memcpy (&pm[1], data, len);
73 const struct GNUNET_MessageHeader *msg;
79 * Struct containing information about a client,
80 * handle to connect to it, and any pending messages
81 * that need to be sent to it.
86 * Linked list of active clients
88 struct ClientList *next;
91 * Linked list of active clients
93 struct ClientList *prev;
96 * The handle to this client
98 struct GNUNET_SERVER_Client *client_handle;
101 * Handle to the current transmission request, NULL
104 struct GNUNET_SERVER_TransmitHandle *transmit_handle;
107 * Linked list of pending messages for this client
109 struct PendingMessage *pending_head;
112 * Tail of linked list of pending messages for this client
114 struct PendingMessage *pending_tail;
120 * Entry in the local forwarding map for a client's GET request.
122 struct ClientQueryRecord
126 * The key this request was about
128 struct GNUNET_HashCode key;
131 * Client responsible for the request.
133 struct ClientList *client;
136 * Extended query (see gnunet_block_lib.h), allocated at the end of this struct.
141 * Replies we have already seen for this request.
143 struct GNUNET_HashCode *seen_replies;
146 * Pointer to this nodes heap location in the retry-heap (for fast removal)
148 struct GNUNET_CONTAINER_HeapNode *hnode;
151 * What's the delay between re-try operations that we currently use for this
154 struct GNUNET_TIME_Relative retry_frequency;
157 * What's the next time we should re-try this request?
159 struct GNUNET_TIME_Absolute retry_time;
162 * The unique identifier of this request
167 * Number of bytes in xquery.
172 * Number of entries in 'seen_replies'.
174 unsigned int seen_replies_count;
177 * Desired replication level
179 uint32_t replication;
182 * Any message options for this request
184 uint32_t msg_options;
187 * The type for the data for the GET request.
189 enum GNUNET_BLOCK_Type type;
195 * Struct containing paremeters of monitoring requests.
197 struct ClientMonitorRecord
201 * Next element in DLL.
203 struct ClientMonitorRecord *next;
206 * Previous element in DLL.
208 struct ClientMonitorRecord *prev;
211 * Type of blocks that are of interest
213 enum GNUNET_BLOCK_Type type;
216 * Key of data of interest, NULL for all.
218 struct GNUNET_HashCode *key;
221 * Flag whether to notify about GET messages.
226 * Flag whether to notify about GET_REPONSE messages.
231 * Flag whether to notify about PUT messages.
236 * Client to notify of these requests.
238 struct ClientList *client;
243 * List of active clients.
245 static struct ClientList *client_head;
248 * List of active clients.
250 static struct ClientList *client_tail;
253 * List of active monitoring requests.
255 static struct ClientMonitorRecord *monitor_head;
258 * List of active monitoring requests.
260 static struct ClientMonitorRecord *monitor_tail;
263 * Hashmap for fast key based lookup, maps keys to `struct ClientQueryRecord` entries.
265 static struct GNUNET_CONTAINER_MultiHashMap *forward_map;
268 * Heap with all of our client's request, sorted by retry time (earliest on top).
270 static struct GNUNET_CONTAINER_Heap *retry_heap;
273 * Task that re-transmits requests (using retry_heap).
275 static GNUNET_SCHEDULER_TaskIdentifier retry_task;
279 * Task run to check for messages that need to be sent to a client.
281 * @param client a ClientList, containing the client and any messages to be sent to it
284 process_pending_messages (struct ClientList *client);
288 * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
289 * request. A ClientList is passed as closure, take the head of the list
290 * and copy it into buf, which has the result of sending the message to the
293 * @param cls closure to this call
294 * @param size maximum number of bytes available to send
295 * @param buf where to copy the actual message to
297 * @return the number of bytes actually copied, 0 indicates failure
300 send_reply_to_client (void *cls, size_t size, void *buf)
302 struct ClientList *client = cls;
304 struct PendingMessage *reply;
308 client->transmit_handle = NULL;
311 /* client disconnected */
312 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
313 "Client %p disconnected, pending messages will be discarded\n",
314 client->client_handle);
318 while ((NULL != (reply = client->pending_head)) &&
319 (size >= off + (msize = ntohs (reply->msg->size))))
321 GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
323 memcpy (&cbuf[off], reply->msg, msize);
325 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes to client %p\n",
326 msize, client->client_handle);
329 process_pending_messages (client);
330 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitted %u/%u bytes to client %p\n",
331 (unsigned int) off, (unsigned int) size, client->client_handle);
337 * Task run to check for messages that need to be sent to a client.
339 * @param client a ClientList, containing the client and any messages to be sent to it
342 process_pending_messages (struct ClientList *client)
344 if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
346 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
347 "Not asking for transmission to %p now: %s\n",
348 client->client_handle,
349 client->pending_head ==
350 NULL ? "no more messages" : "request already pending");
353 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
354 "Asking for transmission of %u bytes to client %p\n",
355 ntohs (client->pending_head->msg->size), client->client_handle);
356 client->transmit_handle =
357 GNUNET_SERVER_notify_transmit_ready (client->client_handle,
358 ntohs (client->pending_head->
360 GNUNET_TIME_UNIT_FOREVER_REL,
361 &send_reply_to_client, client);
366 * Add a PendingMessage to the clients list of messages to be sent
368 * @param client the active client to send the message to
369 * @param pending_message the actual message to send
372 add_pending_message (struct ClientList *client,
373 struct PendingMessage *pending_message)
375 GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
377 process_pending_messages (client);
382 * Closure for 'forward_reply'
384 struct ForwardReplyContext
388 * Actual message to send to matching clients.
390 struct PendingMessage *pm;
400 enum GNUNET_BLOCK_Type type;
403 * Number of bytes in data.
408 * Do we need to copy 'pm' because it was already used?
416 * Find a client if it exists, add it otherwise.
418 * @param client the server handle to the client
420 * @return the client if found, a new client otherwise
422 static struct ClientList *
423 find_active_client (struct GNUNET_SERVER_Client *client)
425 struct ClientList *pos = client_head;
426 struct ClientList *ret;
430 if (pos->client_handle == client)
434 ret = GNUNET_new (struct ClientList);
435 ret->client_handle = client;
436 GNUNET_CONTAINER_DLL_insert (client_head, client_tail, ret);
442 * Iterator over hash map entries that frees all entries
443 * associated with the given client.
445 * @param cls client to search for in source routes
446 * @param key current key code (ignored)
447 * @param value value in the hash map, a ClientQueryRecord
448 * @return #GNUNET_YES (we should continue to iterate)
451 remove_client_records (void *cls, const struct GNUNET_HashCode * key, void *value)
453 struct ClientList *client = cls;
454 struct ClientQueryRecord *record = value;
456 if (record->client != client)
458 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
459 "Removing client %p's record for key %s\n", client,
461 GNUNET_assert (GNUNET_YES ==
462 GNUNET_CONTAINER_multihashmap_remove (forward_map, key,
464 if (NULL != record->hnode)
465 GNUNET_CONTAINER_heap_remove_node (record->hnode);
466 GNUNET_array_grow (record->seen_replies, record->seen_replies_count, 0);
467 GNUNET_free (record);
473 * Iterator over hash map entries that send a given reply to
474 * each of the matching clients. With some tricky recycling
477 * @param cls the 'struct ForwardReplyContext'
478 * @param key current key
479 * @param value value in the hash map, a ClientQueryRecord
480 * @return GNUNET_YES (we should continue to iterate),
481 * if the result is mal-formed, GNUNET_NO
484 forward_reply (void *cls, const struct GNUNET_HashCode * key, void *value)
486 struct ForwardReplyContext *frc = cls;
487 struct ClientQueryRecord *record = value;
488 struct PendingMessage *pm;
489 struct GNUNET_DHT_ClientResultMessage *reply;
490 enum GNUNET_BLOCK_EvaluationResult eval;
492 struct GNUNET_HashCode ch;
495 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
496 "R5N CLIENT-RESULT %s\n",
497 GNUNET_h2s_full (key));
498 if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
500 LOG (GNUNET_ERROR_TYPE_DEBUG,
501 "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 */
509 GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
510 for (i = 0; i < record->seen_replies_count; i++)
511 if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
513 LOG (GNUNET_ERROR_TYPE_DEBUG,
514 "Duplicate reply, not passing request for key %s to local client\n",
516 GNUNET_STATISTICS_update (GDS_stats,
518 ("# Duplicate REPLIES to CLIENT request dropped"),
520 return GNUNET_YES; /* duplicate */
523 GNUNET_BLOCK_evaluate (GDS_block_context, record->type, key, NULL, 0,
524 record->xquery, record->xquery_size, frc->data,
526 LOG (GNUNET_ERROR_TYPE_DEBUG,
527 "Evaluation result is %d for key %s for local client's query\n",
528 (int) eval, GNUNET_h2s (key));
531 case GNUNET_BLOCK_EVALUATION_OK_LAST:
532 do_free = GNUNET_YES;
534 case GNUNET_BLOCK_EVALUATION_OK_MORE:
535 GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
538 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
539 /* should be impossible to encounter here */
542 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
545 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
548 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
551 case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
553 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
554 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
555 _("Unsupported block type (%u) in request!\n"), record->type);
561 if (GNUNET_NO == frc->do_copy)
563 /* first time, we can use the original data */
565 frc->do_copy = GNUNET_YES;
569 /* two clients waiting for same reply, must copy for queueing */
570 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
571 ntohs (frc->pm->msg->size));
573 sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
574 pm->next = pm->prev = NULL;
575 pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
577 GNUNET_STATISTICS_update (GDS_stats,
578 gettext_noop ("# RESULTS queued for clients"), 1,
580 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
581 reply->unique_id = record->unique_id;
582 LOG (GNUNET_ERROR_TYPE_DEBUG,
583 "Queueing reply to query %s for client %p\n",
585 record->client->client_handle);
586 add_pending_message (record->client, pm);
587 if (GNUNET_YES == do_free)
588 remove_client_records (record->client, key, record);
594 * Handle a reply we've received from another peer. If the reply
595 * matches any of our pending queries, forward it to the respective
598 * @param expiration when will the reply expire
599 * @param key the query this reply is for
600 * @param get_path_length number of peers in @a get_path
601 * @param get_path path the reply took on get
602 * @param put_path_length number of peers in @a put_path
603 * @param put_path path the reply took on put
604 * @param type type of the reply
605 * @param data_size number of bytes in @a data
606 * @param data application payload data
609 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
610 const struct GNUNET_HashCode *key,
611 unsigned int get_path_length,
612 const struct GNUNET_PeerIdentity *get_path,
613 unsigned int put_path_length,
614 const struct GNUNET_PeerIdentity *put_path,
615 enum GNUNET_BLOCK_Type type, size_t data_size,
618 struct ForwardReplyContext frc;
619 struct PendingMessage *pm;
620 struct GNUNET_DHT_ClientResultMessage *reply;
621 struct GNUNET_PeerIdentity *paths;
624 LOG (GNUNET_ERROR_TYPE_DEBUG,
625 "reply for key %s\n",
628 if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
630 GNUNET_STATISTICS_update (GDS_stats,
632 ("# REPLIES ignored for CLIENTS (no match)"), 1,
634 return; /* no matching request, fast exit! */
637 sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
638 (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
639 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
641 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
642 _("Could not pass reply to client, message too big!\n"));
645 pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
646 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
647 pm->msg = &reply->header;
648 reply->header.size = htons ((uint16_t) msize);
649 reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
650 reply->type = htonl (type);
651 reply->get_path_length = htonl (get_path_length);
652 reply->put_path_length = htonl (put_path_length);
653 reply->unique_id = 0; /* filled in later */
654 reply->expiration = GNUNET_TIME_absolute_hton (expiration);
656 paths = (struct GNUNET_PeerIdentity *) &reply[1];
657 memcpy (paths, put_path,
658 sizeof (struct GNUNET_PeerIdentity) * put_path_length);
659 memcpy (&paths[put_path_length], get_path,
660 sizeof (struct GNUNET_PeerIdentity) * get_path_length);
661 memcpy (&paths[get_path_length + put_path_length], data, data_size);
662 frc.do_copy = GNUNET_NO;
665 frc.data_size = data_size;
667 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
670 if (GNUNET_NO == frc.do_copy)
672 /* did not match any of the requests, free! */
673 GNUNET_STATISTICS_update (GDS_stats,
675 ("# REPLIES ignored for CLIENTS (no match)"), 1,
682 * Check if some client is monitoring GET messages and notify
685 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
686 * @param type The type of data in the request.
687 * @param hop_count Hop count so far.
688 * @param path_length number of entries in path (or 0 if not recorded).
689 * @param path peers on the GET path (or NULL if not recorded).
690 * @param desired_replication_level Desired replication level.
691 * @param key Key of the requested data.
694 GDS_CLIENTS_process_get (uint32_t options,
695 enum GNUNET_BLOCK_Type type,
697 uint32_t desired_replication_level,
698 unsigned int path_length,
699 const struct GNUNET_PeerIdentity *path,
700 const struct GNUNET_HashCode * key)
702 struct ClientMonitorRecord *m;
703 struct ClientList **cl;
704 unsigned int cl_size;
708 for (m = monitor_head; NULL != m; m = m->next)
710 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
712 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
714 struct PendingMessage *pm;
715 struct GNUNET_DHT_MonitorGetMessage *mmsg;
716 struct GNUNET_PeerIdentity *msg_path;
720 /* Don't send duplicates */
721 for (i = 0; i < cl_size; i++)
722 if (cl[i] == m->client)
726 GNUNET_array_append (cl, cl_size, m->client);
728 msize = path_length * sizeof (struct GNUNET_PeerIdentity);
729 msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
730 msize += sizeof (struct PendingMessage);
731 pm = GNUNET_malloc (msize);
732 mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
733 pm->msg = &mmsg->header;
734 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
735 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
736 mmsg->options = htonl(options);
737 mmsg->type = htonl(type);
738 mmsg->hop_count = htonl(hop_count);
739 mmsg->desired_replication_level = htonl(desired_replication_level);
740 mmsg->get_path_length = htonl(path_length);
741 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
742 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
744 memcpy (msg_path, path,
745 path_length * sizeof (struct GNUNET_PeerIdentity));
746 add_pending_message (m->client, pm);
749 GNUNET_free_non_null (cl);
754 * Check if some client is monitoring PUT messages and notify
757 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
758 * @param type The type of data in the request.
759 * @param hop_count Hop count so far.
760 * @param path_length number of entries in path (or 0 if not recorded).
761 * @param path peers on the PUT path (or NULL if not recorded).
762 * @param desired_replication_level Desired replication level.
763 * @param exp Expiration time of the data.
764 * @param key Key under which data is to be stored.
765 * @param data Pointer to the data carried.
766 * @param size Number of bytes in data.
769 GDS_CLIENTS_process_put (uint32_t options,
770 enum GNUNET_BLOCK_Type type,
772 uint32_t desired_replication_level,
773 unsigned int path_length,
774 const struct GNUNET_PeerIdentity *path,
775 struct GNUNET_TIME_Absolute exp,
776 const struct GNUNET_HashCode * key,
780 struct ClientMonitorRecord *m;
781 struct ClientList **cl;
782 unsigned int cl_size;
786 for (m = monitor_head; NULL != m; m = m->next)
788 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
790 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
792 struct PendingMessage *pm;
793 struct GNUNET_DHT_MonitorPutMessage *mmsg;
794 struct GNUNET_PeerIdentity *msg_path;
798 /* Don't send duplicates */
799 for (i = 0; i < cl_size; i++)
800 if (cl[i] == m->client)
804 GNUNET_array_append (cl, cl_size, m->client);
807 msize += path_length * sizeof (struct GNUNET_PeerIdentity);
808 msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
809 msize += sizeof (struct PendingMessage);
810 pm = GNUNET_malloc (msize);
811 mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
812 pm->msg = (struct GNUNET_MessageHeader *) mmsg;
813 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
814 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
815 mmsg->options = htonl(options);
816 mmsg->type = htonl(type);
817 mmsg->hop_count = htonl(hop_count);
818 mmsg->desired_replication_level = htonl(desired_replication_level);
819 mmsg->put_path_length = htonl(path_length);
820 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
823 memcpy (msg_path, path,
824 path_length * sizeof (struct GNUNET_PeerIdentity));
826 mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
827 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
829 memcpy (&msg_path[path_length], data, size);
830 add_pending_message (m->client, pm);
833 GNUNET_free_non_null (cl);
838 * Route the given request via the DHT.
841 transmit_request (struct ClientQueryRecord *cqr)
843 GNUNET_STATISTICS_update (GDS_stats,
845 ("# GET requests from clients injected"), 1,
848 LOG (GNUNET_ERROR_TYPE_DEBUG,
849 "Initiating GET for %s, replication %u, already have %u replies\n",
850 GNUNET_h2s (&cqr->key),
852 cqr->seen_replies_count);
854 GDS_NEIGHBOURS_send_get (&cqr->key, cqr->type, cqr->msg_options,
855 cqr->replication, NULL, NULL , NULL,
858 /* exponential back-off for retries.
859 * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
860 cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
861 cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
866 * Task that looks at the 'retry_heap' and transmits all of the requests
867 * on the heap that are ready for transmission. Then re-schedules
868 * itself (unless the heap is empty).
871 * @param tc scheduler context
874 transmit_next_request_task (void *cls,
875 const struct GNUNET_SCHEDULER_TaskContext *tc)
877 struct ClientQueryRecord *cqr;
878 struct GNUNET_TIME_Relative delay;
880 retry_task = GNUNET_SCHEDULER_NO_TASK;
881 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
883 while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
886 delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
887 if (delay.rel_value_us > 0)
890 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
891 cqr->retry_time.abs_value_us);
893 GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
897 transmit_request (cqr);
899 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
900 cqr->retry_time.abs_value_us);
906 * Handler for PUT messages.
908 * @param cls closure for the service
909 * @param client the client we received this message from
910 * @param message the actual message received
913 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
914 const struct GNUNET_MessageHeader *message)
916 const struct GNUNET_DHT_ClientPutMessage *put_msg;
917 struct PendingMessage *pm;
918 struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
921 size = ntohs (message->size);
922 if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
925 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
928 GNUNET_STATISTICS_update (GDS_stats,
930 ("# PUT requests received from clients"), 1,
932 put_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
933 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE DHT CLIENT-PUT %s\n",
934 GNUNET_h2s_full (&put_msg->key));
935 /* give to local clients */
936 LOG (GNUNET_ERROR_TYPE_DEBUG,
937 "Handling local PUT of %u-bytes for query %s\n",
938 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
939 GNUNET_h2s (&put_msg->key));
941 GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
942 &put_msg->key, 0, NULL, 0, NULL,
943 ntohl (put_msg->type),
944 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
946 /* FIXME: Should we store locally? */
947 GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
948 &put_msg->key, 0, NULL, ntohl (put_msg->type),
949 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
952 struct GNUNET_PeerIdentity my_identity = GDS_NEIGHBOURS_get_my_id();
953 GDS_NEIGHBOURS_send_put (&put_msg->key,
954 ntohl (put_msg->type), ntohl (put_msg->options),
955 ntohl (put_msg->desired_replication_level), NULL,
956 NULL, NULL, 0, 0, NULL,
957 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
959 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
962 GDS_CLIENTS_process_put (ntohl (put_msg->options),
963 ntohl (put_msg->type),
965 ntohl (put_msg->desired_replication_level),
968 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
971 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
973 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
974 sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
975 conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
976 conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
977 conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
978 conf->reserved = htonl (0);
979 conf->unique_id = put_msg->unique_id;
980 pm->msg = &conf->header;
981 add_pending_message (find_active_client (client), pm);
982 GNUNET_SERVER_receive_done (client, GNUNET_OK);
987 * Handler for DHT GET messages from the client.
989 * @param cls closure for the service
990 * @param client the client we received this message from
991 * @param message the actual message received
994 handle_dht_local_get (void *cls, struct GNUNET_SERVER_Client *client,
995 const struct GNUNET_MessageHeader *message)
997 const struct GNUNET_DHT_ClientGetMessage *get;
998 struct ClientQueryRecord *cqr;
1003 size = ntohs (message->size);
1004 if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
1007 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1010 xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
1011 get = (const struct GNUNET_DHT_ClientGetMessage *) message;
1012 xquery = (const char *) &get[1];
1013 GNUNET_STATISTICS_update (GDS_stats,
1015 ("# GET requests received from clients"), 1,
1017 LOG (GNUNET_ERROR_TYPE_DEBUG,
1018 "Received GET request for %s from local client %p, xq: %.*s\n",
1019 GNUNET_h2s (&get->key), client, xquery_size, xquery);
1021 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE CLIENT-GET %s\n",
1022 GNUNET_h2s_full (&get->key));
1025 cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
1026 cqr->key = get->key;
1027 cqr->client = find_active_client (client);
1028 cqr->xquery = (void *) &cqr[1];
1029 memcpy (&cqr[1], xquery, xquery_size);
1030 cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
1031 cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
1032 cqr->retry_time = GNUNET_TIME_absolute_get ();
1033 cqr->unique_id = get->unique_id;
1034 cqr->xquery_size = xquery_size;
1035 cqr->replication = ntohl (get->desired_replication_level);
1036 cqr->msg_options = ntohl (get->options);
1037 cqr->type = ntohl (get->type);
1038 // FIXME use cqr->key, set multihashmap create to GNUNET_YES
1039 GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
1040 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1042 struct GNUNET_PeerIdentity my_identity;
1043 my_identity = GDS_NEIGHBOURS_get_my_id();
1044 GDS_CLIENTS_process_get (ntohl (get->options),
1047 ntohl (get->desired_replication_level),
1051 /* start remote requests */
1052 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1053 GNUNET_SCHEDULER_cancel (retry_task);
1054 retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
1055 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1060 * Closure for 'find_by_unique_id'.
1062 struct FindByUniqueIdContext
1065 * Where to store the result, if found.
1067 struct ClientQueryRecord *cqr;
1074 * Function called for each existing DHT record for the given
1075 * query. Checks if it matches the UID given in the closure
1076 * and if so returns the entry as a result.
1078 * @param cls the search context
1079 * @param key query for the lookup (not used)
1080 * @param value the 'struct ClientQueryRecord'
1081 * @return GNUNET_YES to continue iteration (result not yet found)
1084 find_by_unique_id (void *cls,
1085 const struct GNUNET_HashCode *key,
1088 struct FindByUniqueIdContext *fui_ctx = cls;
1089 struct ClientQueryRecord *cqr = value;
1091 if (cqr->unique_id != fui_ctx->unique_id)
1099 * Handler for "GET result seen" messages from the client.
1101 * @param cls closure for the service
1102 * @param client the client we received this message from
1103 * @param message the actual message received
1106 handle_dht_local_get_result_seen (void *cls, struct GNUNET_SERVER_Client *client,
1107 const struct GNUNET_MessageHeader *message)
1109 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
1111 unsigned int hash_count;
1112 unsigned int old_count;
1113 const struct GNUNET_HashCode *hc;
1114 struct FindByUniqueIdContext fui_ctx;
1115 struct ClientQueryRecord *cqr;
1117 size = ntohs (message->size);
1118 if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
1121 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1124 seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
1125 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
1126 if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
1129 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1132 hc = (const struct GNUNET_HashCode*) &seen[1];
1133 fui_ctx.unique_id = seen->unique_id;
1135 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1139 if (NULL == (cqr = fui_ctx.cqr))
1142 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1145 /* finally, update 'seen' list */
1146 old_count = cqr->seen_replies_count;
1147 GNUNET_array_grow (cqr->seen_replies,
1148 cqr->seen_replies_count,
1149 cqr->seen_replies_count + hash_count);
1150 memcpy (&cqr->seen_replies[old_count],
1152 sizeof (struct GNUNET_HashCode) * hash_count);
1157 * Closure for 'remove_by_unique_id'.
1159 struct RemoveByUniqueIdContext
1162 * Client that issued the removal request.
1164 struct ClientList *client;
1167 * Unique ID of the request.
1174 * Iterator over hash map entries that frees all entries
1175 * that match the given client and unique ID.
1177 * @param cls unique ID and client to search for in source routes
1178 * @param key current key code
1179 * @param value value in the hash map, a ClientQueryRecord
1180 * @return GNUNET_YES (we should continue to iterate)
1183 remove_by_unique_id (void *cls, const struct GNUNET_HashCode * key, void *value)
1185 const struct RemoveByUniqueIdContext *ctx = cls;
1186 struct ClientQueryRecord *record = value;
1188 if (record->unique_id != ctx->unique_id)
1190 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1191 "Removing client %p's record for key %s (by unique id)\n",
1192 ctx->client->client_handle, GNUNET_h2s (key));
1193 return remove_client_records (ctx->client, key, record);
1198 * Handler for any generic DHT stop messages, calls the appropriate handler
1199 * depending on message type (if processed locally)
1201 * @param cls closure for the service
1202 * @param client the client we received this message from
1203 * @param message the actual message received
1207 handle_dht_local_get_stop (void *cls, struct GNUNET_SERVER_Client *client,
1208 const struct GNUNET_MessageHeader *message)
1210 const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
1211 (const struct GNUNET_DHT_ClientGetStopMessage *) message;
1212 struct RemoveByUniqueIdContext ctx;
1214 GNUNET_STATISTICS_update (GDS_stats,
1216 ("# GET STOP requests received from clients"), 1,
1218 LOG (GNUNET_ERROR_TYPE_DEBUG,
1219 "Received GET STOP request for %s from local client %p\n",
1220 client, GNUNET_h2s (&dht_stop_msg->key));
1221 ctx.client = find_active_client (client);
1222 ctx.unique_id = dht_stop_msg->unique_id;
1223 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
1224 &remove_by_unique_id, &ctx);
1225 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1230 * Handler for monitor start messages
1232 * @param cls closure for the service
1233 * @param client the client we received this message from
1234 * @param message the actual message received
1238 handle_dht_local_monitor (void *cls, struct GNUNET_SERVER_Client *client,
1239 const struct GNUNET_MessageHeader *message)
1241 struct ClientMonitorRecord *r;
1242 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1244 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1245 r = GNUNET_new (struct ClientMonitorRecord);
1247 r->client = find_active_client(client);
1248 r->type = ntohl(msg->type);
1249 r->get = ntohs(msg->get);
1250 r->get_resp = ntohs(msg->get_resp);
1251 r->put = ntohs(msg->put);
1252 if (0 == ntohs(msg->filter_key))
1256 r->key = GNUNET_new (struct GNUNET_HashCode);
1257 memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
1259 GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
1260 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1265 * Handler for monitor stop messages
1267 * @param cls closure for the service
1268 * @param client the client we received this message from
1269 * @param message the actual message received
1273 handle_dht_local_monitor_stop (void *cls, struct GNUNET_SERVER_Client *client,
1274 const struct GNUNET_MessageHeader *message)
1276 struct ClientMonitorRecord *r;
1277 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1280 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1286 keys_match = (0 == ntohs(msg->filter_key));
1289 keys_match = (0 != ntohs(msg->filter_key)
1290 && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
1292 if (find_active_client(client) == r->client
1293 && ntohl(msg->type) == r->type
1294 && r->get == msg->get
1295 && r->get_resp == msg->get_resp
1296 && r->put == msg->put
1300 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
1301 GNUNET_free_non_null (r->key);
1303 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1304 return; /* Delete only ONE entry */
1309 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1313 #if ENABLE_MALICIOUS
1315 * Handler for monitor stop messages
1317 * @param cls closure for the service
1318 * @param client the client we received this message from
1319 * @param message the actual message received
1323 handle_dht_act_malicious (void *cls, struct GNUNET_SERVER_Client *client,
1324 const struct GNUNET_MessageHeader *message)
1326 /* FIXME: parse message and set malicious */
1333 * Functions with this signature are called whenever a client
1334 * is disconnected on the network level.
1336 * @param cls closure (NULL for dht)
1337 * @param client identification of the client; NULL
1338 * for the last call when the server is destroyed
1341 handle_client_disconnect (void *cls,
1342 struct GNUNET_SERVER_Client *client)
1344 struct ClientList *pos;
1345 struct PendingMessage *reply;
1346 struct ClientMonitorRecord *monitor;
1348 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1349 "Local client %p disconnects\n",
1351 pos = find_active_client (client);
1352 GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
1353 if (pos->transmit_handle != NULL)
1354 GNUNET_SERVER_notify_transmit_ready_cancel (pos->transmit_handle);
1355 while (NULL != (reply = pos->pending_head))
1357 GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
1358 GNUNET_free (reply);
1360 monitor = monitor_head;
1361 while (NULL != monitor)
1363 if (monitor->client == pos)
1365 struct ClientMonitorRecord *next;
1367 GNUNET_free_non_null (monitor->key);
1368 next = monitor->next;
1369 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
1370 GNUNET_free (monitor);
1374 monitor = monitor->next;
1376 GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
1384 * Initialize client subsystem.
1386 * @param server the initialized server
1389 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1391 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1392 {&handle_dht_local_put, NULL,
1393 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1394 {&handle_dht_local_get, NULL,
1395 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1396 {&handle_dht_local_get_stop, NULL,
1397 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1398 sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1399 {&handle_dht_local_monitor, NULL,
1400 GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1401 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1402 {&handle_dht_local_monitor_stop, NULL,
1403 GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1404 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1405 {&handle_dht_local_get_result_seen, NULL,
1406 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1407 #if ENABLE_MALICIOUS
1408 {&handle_dht_act_malicious, NULL,
1409 GNUNET_MESSAGE_TYPE_DHT_ACT_MALICIOUS,
1410 sizeof (struct GNUNET_DHT_ActMaliciousMessage)},
1414 forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1415 retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1416 GNUNET_SERVER_add_handlers (server, plugin_handlers);
1417 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1422 * Shutdown client subsystem.
1427 GNUNET_assert (client_head == NULL);
1428 GNUNET_assert (client_tail == NULL);
1429 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1431 GNUNET_SCHEDULER_cancel (retry_task);
1432 retry_task = GNUNET_SCHEDULER_NO_TASK;
1434 if (NULL != retry_heap)
1436 GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1437 GNUNET_CONTAINER_heap_destroy (retry_heap);
1440 if (NULL != forward_map)
1442 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1443 GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1448 /* end of gnunet-service-dht_clients.c */