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 "XVINE CLIENT-RESULT %s\n",
497 GNUNET_h2s_full (key));
499 if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
501 LOG (GNUNET_ERROR_TYPE_DEBUG,
502 "Record type missmatch, not passing request for key %s to local client\n",
504 GNUNET_STATISTICS_update (GDS_stats,
506 ("# Key match, type mismatches in REPLY to CLIENT"),
508 return GNUNET_YES; /* type mismatch */
511 GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
512 for (i = 0; i < record->seen_replies_count; i++)
513 if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
515 LOG (GNUNET_ERROR_TYPE_DEBUG,
516 "Duplicate reply, not passing request for key %s to local client\n",
518 GNUNET_STATISTICS_update (GDS_stats,
520 ("# Duplicate REPLIES to CLIENT request dropped"),
522 return GNUNET_YES; /* duplicate */
525 GNUNET_BLOCK_evaluate (GDS_block_context, record->type, key, NULL, 0,
526 record->xquery, record->xquery_size, frc->data,
528 LOG (GNUNET_ERROR_TYPE_DEBUG,
529 "Evaluation result is %d for key %s for local client's query\n",
530 (int) eval, GNUNET_h2s (key));
533 case GNUNET_BLOCK_EVALUATION_OK_LAST:
534 do_free = GNUNET_YES;
536 case GNUNET_BLOCK_EVALUATION_OK_MORE:
537 GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
540 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
541 /* should be impossible to encounter here */
544 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
547 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
550 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
553 case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
555 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
556 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
557 _("Unsupported block type (%u) in request!\n"), record->type);
563 if (GNUNET_NO == frc->do_copy)
565 /* first time, we can use the original data */
567 frc->do_copy = GNUNET_YES;
571 /* two clients waiting for same reply, must copy for queueing */
572 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
573 ntohs (frc->pm->msg->size));
575 sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
576 pm->next = pm->prev = NULL;
577 pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
579 GNUNET_STATISTICS_update (GDS_stats,
580 gettext_noop ("# RESULTS queued for clients"), 1,
582 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
583 reply->unique_id = record->unique_id;
584 LOG (GNUNET_ERROR_TYPE_DEBUG,
585 "Queueing reply to query %s for client %p\n",
587 record->client->client_handle);
588 add_pending_message (record->client, pm);
589 if (GNUNET_YES == do_free)
590 remove_client_records (record->client, key, record);
596 * Handle a reply we've received from another peer. If the reply
597 * matches any of our pending queries, forward it to the respective
600 * @param expiration when will the reply expire
601 * @param key the query this reply is for
602 * @param get_path_length number of peers in @a get_path
603 * @param get_path path the reply took on get
604 * @param put_path_length number of peers in @a put_path
605 * @param put_path path the reply took on put
606 * @param type type of the reply
607 * @param data_size number of bytes in @a data
608 * @param data application payload data
611 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
612 const struct GNUNET_HashCode *key,
613 unsigned int get_path_length,
614 const struct GNUNET_PeerIdentity *get_path,
615 unsigned int put_path_length,
616 const struct GNUNET_PeerIdentity *put_path,
617 enum GNUNET_BLOCK_Type type, size_t data_size,
620 struct ForwardReplyContext frc;
621 struct PendingMessage *pm;
622 struct GNUNET_DHT_ClientResultMessage *reply;
623 struct GNUNET_PeerIdentity *paths;
626 LOG (GNUNET_ERROR_TYPE_DEBUG,
627 "reply for key %s\n",
630 if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
632 GNUNET_STATISTICS_update (GDS_stats,
634 ("# REPLIES ignored for CLIENTS (no match)"), 1,
636 return; /* no matching request, fast exit! */
639 sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
640 (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
641 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
643 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
644 _("Could not pass reply to client, message too big!\n"));
647 pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
648 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
649 pm->msg = &reply->header;
650 reply->header.size = htons ((uint16_t) msize);
651 reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
652 reply->type = htonl (type);
653 reply->get_path_length = htonl (get_path_length);
654 reply->put_path_length = htonl (put_path_length);
655 reply->unique_id = 0; /* filled in later */
656 reply->expiration = GNUNET_TIME_absolute_hton (expiration);
658 paths = (struct GNUNET_PeerIdentity *) &reply[1];
659 memcpy (paths, put_path,
660 sizeof (struct GNUNET_PeerIdentity) * put_path_length);
661 memcpy (&paths[put_path_length], get_path,
662 sizeof (struct GNUNET_PeerIdentity) * get_path_length);
663 memcpy (&paths[get_path_length + put_path_length], data, data_size);
664 frc.do_copy = GNUNET_NO;
667 frc.data_size = data_size;
669 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
671 if (GNUNET_NO == frc.do_copy)
673 /* did not match any of the requests, free! */
674 GNUNET_STATISTICS_update (GDS_stats,
676 ("# REPLIES ignored for CLIENTS (no match)"), 1,
683 * Check if some client is monitoring GET messages and notify
686 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
687 * @param type The type of data in the request.
688 * @param hop_count Hop count so far.
689 * @param path_length number of entries in path (or 0 if not recorded).
690 * @param path peers on the GET path (or NULL if not recorded).
691 * @param desired_replication_level Desired replication level.
692 * @param key Key of the requested data.
695 GDS_CLIENTS_process_get (uint32_t options,
696 enum GNUNET_BLOCK_Type type,
698 uint32_t desired_replication_level,
699 unsigned int path_length,
700 const struct GNUNET_PeerIdentity *path,
701 const struct GNUNET_HashCode * key)
703 struct ClientMonitorRecord *m;
704 struct ClientList **cl;
705 unsigned int cl_size;
709 for (m = monitor_head; NULL != m; m = m->next)
711 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
713 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
715 struct PendingMessage *pm;
716 struct GNUNET_DHT_MonitorGetMessage *mmsg;
717 struct GNUNET_PeerIdentity *msg_path;
721 /* Don't send duplicates */
722 for (i = 0; i < cl_size; i++)
723 if (cl[i] == m->client)
727 GNUNET_array_append (cl, cl_size, m->client);
729 msize = path_length * sizeof (struct GNUNET_PeerIdentity);
730 msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
731 msize += sizeof (struct PendingMessage);
732 pm = GNUNET_malloc (msize);
733 mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
734 pm->msg = &mmsg->header;
735 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
736 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
737 mmsg->options = htonl(options);
738 mmsg->type = htonl(type);
739 mmsg->hop_count = htonl(hop_count);
740 mmsg->desired_replication_level = htonl(desired_replication_level);
741 mmsg->get_path_length = htonl(path_length);
742 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
743 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
745 memcpy (msg_path, path,
746 path_length * sizeof (struct GNUNET_PeerIdentity));
747 add_pending_message (m->client, pm);
750 GNUNET_free_non_null (cl);
755 * Check if some client is monitoring PUT messages and notify
758 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
759 * @param type The type of data in the request.
760 * @param hop_count Hop count so far.
761 * @param path_length number of entries in path (or 0 if not recorded).
762 * @param path peers on the PUT path (or NULL if not recorded).
763 * @param desired_replication_level Desired replication level.
764 * @param exp Expiration time of the data.
765 * @param key Key under which data is to be stored.
766 * @param data Pointer to the data carried.
767 * @param size Number of bytes in data.
770 GDS_CLIENTS_process_put (uint32_t options,
771 enum GNUNET_BLOCK_Type type,
773 uint32_t desired_replication_level,
774 unsigned int path_length,
775 const struct GNUNET_PeerIdentity *path,
776 struct GNUNET_TIME_Absolute exp,
777 const struct GNUNET_HashCode * key,
781 struct ClientMonitorRecord *m;
782 struct ClientList **cl;
783 unsigned int cl_size;
787 for (m = monitor_head; NULL != m; m = m->next)
789 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
791 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
793 struct PendingMessage *pm;
794 struct GNUNET_DHT_MonitorPutMessage *mmsg;
795 struct GNUNET_PeerIdentity *msg_path;
799 /* Don't send duplicates */
800 for (i = 0; i < cl_size; i++)
801 if (cl[i] == m->client)
805 GNUNET_array_append (cl, cl_size, m->client);
808 msize += path_length * sizeof (struct GNUNET_PeerIdentity);
809 msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
810 msize += sizeof (struct PendingMessage);
811 pm = GNUNET_malloc (msize);
812 mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
813 pm->msg = (struct GNUNET_MessageHeader *) mmsg;
814 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
815 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
816 mmsg->options = htonl(options);
817 mmsg->type = htonl(type);
818 mmsg->hop_count = htonl(hop_count);
819 mmsg->desired_replication_level = htonl(desired_replication_level);
820 mmsg->put_path_length = htonl(path_length);
821 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
824 memcpy (msg_path, path,
825 path_length * sizeof (struct GNUNET_PeerIdentity));
827 mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
828 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
830 memcpy (&msg_path[path_length], data, size);
831 add_pending_message (m->client, pm);
834 GNUNET_free_non_null (cl);
839 * Route the given request via the DHT.
842 transmit_request (struct ClientQueryRecord *cqr)
844 GNUNET_STATISTICS_update (GDS_stats,
846 ("# GET requests from clients injected"), 1,
849 LOG (GNUNET_ERROR_TYPE_DEBUG,
850 "Initiating GET for %s, replication %u, already have %u replies\n",
851 GNUNET_h2s (&cqr->key),
853 cqr->seen_replies_count);
854 struct GNUNET_PeerIdentity best_known_dest;
855 struct GNUNET_HashCode intermediate_trail_id;
857 memset (&best_known_dest, 0, sizeof (struct GNUNET_PeerIdentity));
858 memset (&intermediate_trail_id, 0, sizeof (struct GNUNET_HashCode));
860 GDS_NEIGHBOURS_send_get (&cqr->key, cqr->type, cqr->msg_options,
861 cqr->replication, best_known_dest,
862 intermediate_trail_id , NULL,
865 GDS_NEIGHBOURS_send_get (&cqr->key, cqr->type, cqr->msg_options,
866 cqr->replication, NULL, NULL , NULL,
869 /* exponential back-off for retries.
870 * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
871 cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
872 cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
877 * Task that looks at the 'retry_heap' and transmits all of the requests
878 * on the heap that are ready for transmission. Then re-schedules
879 * itself (unless the heap is empty).
882 * @param tc scheduler context
885 transmit_next_request_task (void *cls,
886 const struct GNUNET_SCHEDULER_TaskContext *tc)
888 struct ClientQueryRecord *cqr;
889 struct GNUNET_TIME_Relative delay;
891 retry_task = GNUNET_SCHEDULER_NO_TASK;
892 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
894 while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
897 delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
898 if (delay.rel_value_us > 0)
901 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
902 cqr->retry_time.abs_value_us);
904 GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
908 transmit_request (cqr);
910 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
911 cqr->retry_time.abs_value_us);
917 * Handler for PUT messages.
919 * @param cls closure for the service
920 * @param client the client we received this message from
921 * @param message the actual message received
924 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
925 const struct GNUNET_MessageHeader *message)
927 const struct GNUNET_DHT_ClientPutMessage *put_msg;
928 struct PendingMessage *pm;
929 struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
932 size = ntohs (message->size);
933 if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
936 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
939 GNUNET_STATISTICS_update (GDS_stats,
941 ("# PUT requests received from clients"), 1,
943 put_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
944 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE DHT CLIENT-PUT %s\n",
945 GNUNET_h2s_full (&put_msg->key));
946 /* give to local clients */
947 LOG (GNUNET_ERROR_TYPE_DEBUG,
948 "Handling local PUT of %u-bytes for query %s\n",
949 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
950 GNUNET_h2s (&put_msg->key));
952 GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
953 &put_msg->key, 0, NULL, 0, NULL,
954 ntohl (put_msg->type),
955 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
957 /* FIXME: Should we store locally? */
958 GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
959 &put_msg->key, 0, NULL, ntohl (put_msg->type),
960 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
963 struct GNUNET_PeerIdentity my_identity = GDS_NEIGHBOURS_get_my_id();
964 struct GNUNET_PeerIdentity best_known_destination;
965 struct GNUNET_HashCode intermediate_trail_id;
967 memset(&best_known_destination, 0 , sizeof (struct GNUNET_PeerIdentity));
968 memset(&intermediate_trail_id, 0, sizeof (struct GNUNET_HashCode));
969 GDS_NEIGHBOURS_send_put (&put_msg->key,
970 ntohl (put_msg->type), ntohl (put_msg->options),
971 ntohl (put_msg->desired_replication_level),
972 best_known_destination,
973 intermediate_trail_id, NULL, 0, 0, NULL,
974 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
976 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
978 GDS_NEIGHBOURS_send_put (&put_msg->key,
979 ntohl (put_msg->type), ntohl (put_msg->options),
980 ntohl (put_msg->desired_replication_level), NULL,
981 NULL, NULL, 0, 0, NULL,
982 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
984 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
987 GDS_CLIENTS_process_put (ntohl (put_msg->options),
988 ntohl (put_msg->type),
990 ntohl (put_msg->desired_replication_level),
993 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
996 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
998 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
999 sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
1000 conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
1001 conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
1002 conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
1003 conf->reserved = htonl (0);
1004 conf->unique_id = put_msg->unique_id;
1005 pm->msg = &conf->header;
1006 add_pending_message (find_active_client (client), pm);
1007 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1012 * Handler for DHT GET messages from the client.
1014 * @param cls closure for the service
1015 * @param client the client we received this message from
1016 * @param message the actual message received
1019 handle_dht_local_get (void *cls, struct GNUNET_SERVER_Client *client,
1020 const struct GNUNET_MessageHeader *message)
1022 const struct GNUNET_DHT_ClientGetMessage *get;
1023 struct ClientQueryRecord *cqr;
1028 size = ntohs (message->size);
1029 if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
1032 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1035 xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
1036 get = (const struct GNUNET_DHT_ClientGetMessage *) message;
1037 xquery = (const char *) &get[1];
1038 GNUNET_STATISTICS_update (GDS_stats,
1040 ("# GET requests received from clients"), 1,
1042 LOG (GNUNET_ERROR_TYPE_DEBUG,
1043 "Received GET request for %s from local client %p, xq: %.*s\n",
1044 GNUNET_h2s (&get->key), client, xquery_size, xquery);
1046 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE CLIENT-GET %s\n",
1047 GNUNET_h2s_full (&get->key));
1050 cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
1051 cqr->key = get->key;
1052 cqr->client = find_active_client (client);
1053 cqr->xquery = (void *) &cqr[1];
1054 memcpy (&cqr[1], xquery, xquery_size);
1055 cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
1056 cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
1057 cqr->retry_time = GNUNET_TIME_absolute_get ();
1058 cqr->unique_id = get->unique_id;
1059 cqr->xquery_size = xquery_size;
1060 cqr->replication = ntohl (get->desired_replication_level);
1061 cqr->msg_options = ntohl (get->options);
1062 cqr->type = ntohl (get->type);
1064 // FIXME use cqr->key, set multihashmap create to GNUNET_YES
1065 GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
1066 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1068 struct GNUNET_PeerIdentity my_identity;
1069 my_identity = GDS_NEIGHBOURS_get_my_id();
1070 GDS_CLIENTS_process_get (ntohl (get->options),
1073 ntohl (get->desired_replication_level),
1077 /* start remote requests */
1078 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1079 GNUNET_SCHEDULER_cancel (retry_task);
1080 retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
1081 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1086 * Closure for 'find_by_unique_id'.
1088 struct FindByUniqueIdContext
1091 * Where to store the result, if found.
1093 struct ClientQueryRecord *cqr;
1100 * Function called for each existing DHT record for the given
1101 * query. Checks if it matches the UID given in the closure
1102 * and if so returns the entry as a result.
1104 * @param cls the search context
1105 * @param key query for the lookup (not used)
1106 * @param value the 'struct ClientQueryRecord'
1107 * @return GNUNET_YES to continue iteration (result not yet found)
1110 find_by_unique_id (void *cls,
1111 const struct GNUNET_HashCode *key,
1114 struct FindByUniqueIdContext *fui_ctx = cls;
1115 struct ClientQueryRecord *cqr = value;
1117 if (cqr->unique_id != fui_ctx->unique_id)
1125 * Handler for "GET result seen" messages from the client.
1127 * @param cls closure for the service
1128 * @param client the client we received this message from
1129 * @param message the actual message received
1132 handle_dht_local_get_result_seen (void *cls, struct GNUNET_SERVER_Client *client,
1133 const struct GNUNET_MessageHeader *message)
1135 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
1137 unsigned int hash_count;
1138 unsigned int old_count;
1139 const struct GNUNET_HashCode *hc;
1140 struct FindByUniqueIdContext fui_ctx;
1141 struct ClientQueryRecord *cqr;
1143 size = ntohs (message->size);
1144 if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
1147 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1150 seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
1151 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
1152 if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
1155 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1158 hc = (const struct GNUNET_HashCode*) &seen[1];
1159 fui_ctx.unique_id = seen->unique_id;
1161 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1165 if (NULL == (cqr = fui_ctx.cqr))
1168 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1171 /* finally, update 'seen' list */
1172 old_count = cqr->seen_replies_count;
1173 GNUNET_array_grow (cqr->seen_replies,
1174 cqr->seen_replies_count,
1175 cqr->seen_replies_count + hash_count);
1176 memcpy (&cqr->seen_replies[old_count],
1178 sizeof (struct GNUNET_HashCode) * hash_count);
1183 * Closure for 'remove_by_unique_id'.
1185 struct RemoveByUniqueIdContext
1188 * Client that issued the removal request.
1190 struct ClientList *client;
1193 * Unique ID of the request.
1200 * Iterator over hash map entries that frees all entries
1201 * that match the given client and unique ID.
1203 * @param cls unique ID and client to search for in source routes
1204 * @param key current key code
1205 * @param value value in the hash map, a ClientQueryRecord
1206 * @return GNUNET_YES (we should continue to iterate)
1209 remove_by_unique_id (void *cls, const struct GNUNET_HashCode * key, void *value)
1211 const struct RemoveByUniqueIdContext *ctx = cls;
1212 struct ClientQueryRecord *record = value;
1214 if (record->unique_id != ctx->unique_id)
1216 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1217 "Removing client %p's record for key %s (by unique id)\n",
1218 ctx->client->client_handle, GNUNET_h2s (key));
1219 return remove_client_records (ctx->client, key, record);
1224 * Handler for any generic DHT stop messages, calls the appropriate handler
1225 * depending on message type (if processed locally)
1227 * @param cls closure for the service
1228 * @param client the client we received this message from
1229 * @param message the actual message received
1233 handle_dht_local_get_stop (void *cls, struct GNUNET_SERVER_Client *client,
1234 const struct GNUNET_MessageHeader *message)
1236 const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
1237 (const struct GNUNET_DHT_ClientGetStopMessage *) message;
1238 struct RemoveByUniqueIdContext ctx;
1240 GNUNET_STATISTICS_update (GDS_stats,
1242 ("# GET STOP requests received from clients"), 1,
1244 LOG (GNUNET_ERROR_TYPE_DEBUG,
1245 "Received GET STOP request for %s from local client %p\n",
1246 client, GNUNET_h2s (&dht_stop_msg->key));
1247 ctx.client = find_active_client (client);
1248 ctx.unique_id = dht_stop_msg->unique_id;
1249 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
1250 &remove_by_unique_id, &ctx);
1251 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1256 * Handler for monitor start messages
1258 * @param cls closure for the service
1259 * @param client the client we received this message from
1260 * @param message the actual message received
1264 handle_dht_local_monitor (void *cls, struct GNUNET_SERVER_Client *client,
1265 const struct GNUNET_MessageHeader *message)
1267 struct ClientMonitorRecord *r;
1268 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1270 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1271 r = GNUNET_new (struct ClientMonitorRecord);
1273 r->client = find_active_client(client);
1274 r->type = ntohl(msg->type);
1275 r->get = ntohs(msg->get);
1276 r->get_resp = ntohs(msg->get_resp);
1277 r->put = ntohs(msg->put);
1278 if (0 == ntohs(msg->filter_key))
1282 r->key = GNUNET_new (struct GNUNET_HashCode);
1283 memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
1285 GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
1286 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1291 * Handler for monitor stop messages
1293 * @param cls closure for the service
1294 * @param client the client we received this message from
1295 * @param message the actual message received
1299 handle_dht_local_monitor_stop (void *cls, struct GNUNET_SERVER_Client *client,
1300 const struct GNUNET_MessageHeader *message)
1302 struct ClientMonitorRecord *r;
1303 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1306 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1312 keys_match = (0 == ntohs(msg->filter_key));
1315 keys_match = (0 != ntohs(msg->filter_key)
1316 && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
1318 if (find_active_client(client) == r->client
1319 && ntohl(msg->type) == r->type
1320 && r->get == msg->get
1321 && r->get_resp == msg->get_resp
1322 && r->put == msg->put
1326 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
1327 GNUNET_free_non_null (r->key);
1329 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1330 return; /* Delete only ONE entry */
1335 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1339 #if ENABLE_MALICIOUS
1341 * Handler for monitor stop messages
1343 * @param cls closure for the service
1344 * @param client the client we received this message from
1345 * @param message the actual message received
1349 handle_dht_act_malicious (void *cls, struct GNUNET_SERVER_Client *client,
1350 const struct GNUNET_MessageHeader *message)
1352 /* FIXME: parse message and set malicious */
1359 * Functions with this signature are called whenever a client
1360 * is disconnected on the network level.
1362 * @param cls closure (NULL for dht)
1363 * @param client identification of the client; NULL
1364 * for the last call when the server is destroyed
1367 handle_client_disconnect (void *cls,
1368 struct GNUNET_SERVER_Client *client)
1370 struct ClientList *pos;
1371 struct PendingMessage *reply;
1372 struct ClientMonitorRecord *monitor;
1374 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1375 "Local client %p disconnects\n",
1377 pos = find_active_client (client);
1378 GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
1379 if (pos->transmit_handle != NULL)
1380 GNUNET_SERVER_notify_transmit_ready_cancel (pos->transmit_handle);
1381 while (NULL != (reply = pos->pending_head))
1383 GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
1384 GNUNET_free (reply);
1386 monitor = monitor_head;
1387 while (NULL != monitor)
1389 if (monitor->client == pos)
1391 struct ClientMonitorRecord *next;
1393 GNUNET_free_non_null (monitor->key);
1394 next = monitor->next;
1395 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
1396 GNUNET_free (monitor);
1400 monitor = monitor->next;
1402 GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
1410 * Initialize client subsystem.
1412 * @param server the initialized server
1415 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1417 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1418 {&handle_dht_local_put, NULL,
1419 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1420 {&handle_dht_local_get, NULL,
1421 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1422 {&handle_dht_local_get_stop, NULL,
1423 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1424 sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1425 {&handle_dht_local_monitor, NULL,
1426 GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1427 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1428 {&handle_dht_local_monitor_stop, NULL,
1429 GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1430 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1431 {&handle_dht_local_get_result_seen, NULL,
1432 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1433 #if ENABLE_MALICIOUS
1434 {&handle_dht_act_malicious, NULL,
1435 GNUNET_MESSAGE_TYPE_DHT_ACT_MALICIOUS,
1436 sizeof (struct GNUNET_DHT_ActMaliciousMessage)},
1440 forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1441 retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1442 GNUNET_SERVER_add_handlers (server, plugin_handlers);
1443 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1448 * Shutdown client subsystem.
1453 GNUNET_assert (client_head == NULL);
1454 GNUNET_assert (client_tail == NULL);
1455 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1457 GNUNET_SCHEDULER_cancel (retry_task);
1458 retry_task = GNUNET_SCHEDULER_NO_TASK;
1460 if (NULL != retry_heap)
1462 GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1463 GNUNET_CONTAINER_heap_destroy (retry_heap);
1466 if (NULL != forward_map)
1468 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1469 GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1474 /* end of gnunet-service-dht_clients.c */