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 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
51 * Should this peer act malicious?
53 extern unsigned int malicious;
57 * Linked list of messages to send to clients.
62 * Pointer to next item in the list
64 struct PendingMessage *next;
67 * Pointer to previous item in the list
69 struct PendingMessage *prev;
72 * Actual message to be sent, allocated at the end of the struct:
73 * // msg = (cast) &pm[1];
74 * // memcpy (&pm[1], data, len);
76 const struct GNUNET_MessageHeader *msg;
82 * Struct containing information about a client,
83 * handle to connect to it, and any pending messages
84 * that need to be sent to it.
89 * Linked list of active clients
91 struct ClientList *next;
94 * Linked list of active clients
96 struct ClientList *prev;
99 * The handle to this client
101 struct GNUNET_SERVER_Client *client_handle;
104 * Handle to the current transmission request, NULL
107 struct GNUNET_SERVER_TransmitHandle *transmit_handle;
110 * Linked list of pending messages for this client
112 struct PendingMessage *pending_head;
115 * Tail of linked list of pending messages for this client
117 struct PendingMessage *pending_tail;
123 * Entry in the local forwarding map for a client's GET request.
125 struct ClientQueryRecord
129 * The key this request was about
131 struct GNUNET_HashCode key;
134 * Client responsible for the request.
136 struct ClientList *client;
139 * Extended query (see gnunet_block_lib.h), allocated at the end of this struct.
144 * Replies we have already seen for this request.
146 struct GNUNET_HashCode *seen_replies;
149 * Pointer to this nodes heap location in the retry-heap (for fast removal)
151 struct GNUNET_CONTAINER_HeapNode *hnode;
154 * What's the delay between re-try operations that we currently use for this
157 struct GNUNET_TIME_Relative retry_frequency;
160 * What's the next time we should re-try this request?
162 struct GNUNET_TIME_Absolute retry_time;
165 * The unique identifier of this request
170 * Number of bytes in xquery.
175 * Number of entries in 'seen_replies'.
177 unsigned int seen_replies_count;
180 * Desired replication level
182 uint32_t replication;
185 * Any message options for this request
187 uint32_t msg_options;
190 * The type for the data for the GET request.
192 enum GNUNET_BLOCK_Type type;
198 * Struct containing paremeters of monitoring requests.
200 struct ClientMonitorRecord
204 * Next element in DLL.
206 struct ClientMonitorRecord *next;
209 * Previous element in DLL.
211 struct ClientMonitorRecord *prev;
214 * Type of blocks that are of interest
216 enum GNUNET_BLOCK_Type type;
219 * Key of data of interest, NULL for all.
221 struct GNUNET_HashCode *key;
224 * Flag whether to notify about GET messages.
229 * Flag whether to notify about GET_REPONSE messages.
234 * Flag whether to notify about PUT messages.
239 * Client to notify of these requests.
241 struct ClientList *client;
246 * List of active clients.
248 static struct ClientList *client_head;
251 * List of active clients.
253 static struct ClientList *client_tail;
256 * List of active monitoring requests.
258 static struct ClientMonitorRecord *monitor_head;
261 * List of active monitoring requests.
263 static struct ClientMonitorRecord *monitor_tail;
266 * Hashmap for fast key based lookup, maps keys to `struct ClientQueryRecord` entries.
268 static struct GNUNET_CONTAINER_MultiHashMap *forward_map;
271 * Heap with all of our client's request, sorted by retry time (earliest on top).
273 static struct GNUNET_CONTAINER_Heap *retry_heap;
276 * Task that re-transmits requests (using retry_heap).
278 static GNUNET_SCHEDULER_TaskIdentifier retry_task;
282 * Task run to check for messages that need to be sent to a client.
284 * @param client a ClientList, containing the client and any messages to be sent to it
287 process_pending_messages (struct ClientList *client);
291 * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
292 * request. A ClientList is passed as closure, take the head of the list
293 * and copy it into buf, which has the result of sending the message to the
296 * @param cls closure to this call
297 * @param size maximum number of bytes available to send
298 * @param buf where to copy the actual message to
300 * @return the number of bytes actually copied, 0 indicates failure
303 send_reply_to_client (void *cls, size_t size, void *buf)
305 struct ClientList *client = cls;
307 struct PendingMessage *reply;
311 client->transmit_handle = NULL;
314 /* client disconnected */
315 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
316 "Client %p disconnected, pending messages will be discarded\n",
317 client->client_handle);
321 while ((NULL != (reply = client->pending_head)) &&
322 (size >= off + (msize = ntohs (reply->msg->size))))
324 GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
326 memcpy (&cbuf[off], reply->msg, msize);
328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes to client %p\n",
329 msize, client->client_handle);
332 process_pending_messages (client);
333 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitted %u/%u bytes to client %p\n",
334 (unsigned int) off, (unsigned int) size, client->client_handle);
340 * Task run to check for messages that need to be sent to a client.
342 * @param client a ClientList, containing the client and any messages to be sent to it
345 process_pending_messages (struct ClientList *client)
347 if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
349 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
350 "Not asking for transmission to %p now: %s\n",
351 client->client_handle,
352 client->pending_head ==
353 NULL ? "no more messages" : "request already pending");
356 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
357 "Asking for transmission of %u bytes to client %p\n",
358 ntohs (client->pending_head->msg->size), client->client_handle);
359 client->transmit_handle =
360 GNUNET_SERVER_notify_transmit_ready (client->client_handle,
361 ntohs (client->pending_head->
363 GNUNET_TIME_UNIT_FOREVER_REL,
364 &send_reply_to_client, client);
369 * Add a PendingMessage to the clients list of messages to be sent
371 * @param client the active client to send the message to
372 * @param pending_message the actual message to send
375 add_pending_message (struct ClientList *client,
376 struct PendingMessage *pending_message)
378 GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
380 process_pending_messages (client);
385 * Closure for 'forward_reply'
387 struct ForwardReplyContext
391 * Actual message to send to matching clients.
393 struct PendingMessage *pm;
403 enum GNUNET_BLOCK_Type type;
406 * Number of bytes in data.
411 * Do we need to copy 'pm' because it was already used?
419 * Find a client if it exists, add it otherwise.
421 * @param client the server handle to the client
423 * @return the client if found, a new client otherwise
425 static struct ClientList *
426 find_active_client (struct GNUNET_SERVER_Client *client)
428 struct ClientList *pos = client_head;
429 struct ClientList *ret;
433 if (pos->client_handle == client)
437 ret = GNUNET_new (struct ClientList);
438 ret->client_handle = client;
439 GNUNET_CONTAINER_DLL_insert (client_head, client_tail, ret);
445 * Iterator over hash map entries that frees all entries
446 * associated with the given client.
448 * @param cls client to search for in source routes
449 * @param key current key code (ignored)
450 * @param value value in the hash map, a ClientQueryRecord
451 * @return #GNUNET_YES (we should continue to iterate)
454 remove_client_records (void *cls, const struct GNUNET_HashCode * key, void *value)
456 struct ClientList *client = cls;
457 struct ClientQueryRecord *record = value;
459 if (record->client != client)
461 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
462 "Removing client %p's record for key %s\n", client,
464 GNUNET_assert (GNUNET_YES ==
465 GNUNET_CONTAINER_multihashmap_remove (forward_map, key,
467 if (NULL != record->hnode)
468 GNUNET_CONTAINER_heap_remove_node (record->hnode);
469 GNUNET_array_grow (record->seen_replies, record->seen_replies_count, 0);
470 GNUNET_free (record);
476 * Iterator over hash map entries that send a given reply to
477 * each of the matching clients. With some tricky recycling
480 * @param cls the 'struct ForwardReplyContext'
481 * @param key current key
482 * @param value value in the hash map, a ClientQueryRecord
483 * @return GNUNET_YES (we should continue to iterate),
484 * if the result is mal-formed, GNUNET_NO
487 forward_reply (void *cls, const struct GNUNET_HashCode * key, void *value)
489 struct ForwardReplyContext *frc = cls;
490 struct ClientQueryRecord *record = value;
491 struct PendingMessage *pm;
492 struct GNUNET_DHT_ClientResultMessage *reply;
493 enum GNUNET_BLOCK_EvaluationResult eval;
495 struct GNUNET_HashCode ch;
498 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
499 "XVINE CLIENT-RESULT %s\n",
500 GNUNET_h2s_full (key));
502 if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
504 LOG (GNUNET_ERROR_TYPE_DEBUG,
505 "Record type missmatch, not passing request for key %s to local client\n",
508 GNUNET_STATISTICS_update (GDS_stats,
510 ("# Key match, type mismatches in REPLY to CLIENT"),
512 return GNUNET_YES; /* type mismatch */
515 GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
516 for (i = 0; i < record->seen_replies_count; i++)
517 if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
519 LOG (GNUNET_ERROR_TYPE_DEBUG,
520 "Duplicate reply, not passing request for key %s to local client\n",
522 GNUNET_STATISTICS_update (GDS_stats,
524 ("# Duplicate REPLIES to CLIENT request dropped"),
526 return GNUNET_YES; /* duplicate */
529 GNUNET_BLOCK_evaluate (GDS_block_context, record->type, key, NULL, 0,
530 record->xquery, record->xquery_size, frc->data,
532 LOG (GNUNET_ERROR_TYPE_DEBUG,
533 "Evaluation result is %d for key %s for local client's query\n",
534 (int) eval, GNUNET_h2s (key));
537 case GNUNET_BLOCK_EVALUATION_OK_LAST:
538 do_free = GNUNET_YES;
540 case GNUNET_BLOCK_EVALUATION_OK_MORE:
541 GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
544 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
545 /* should be impossible to encounter here */
548 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
551 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
554 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
557 case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
559 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
560 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
561 _("Unsupported block type (%u) in request!\n"), record->type);
567 if (GNUNET_NO == frc->do_copy)
569 /* first time, we can use the original data */
571 frc->do_copy = GNUNET_YES;
575 /* two clients waiting for same reply, must copy for queueing */
576 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
577 ntohs (frc->pm->msg->size));
579 sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
580 pm->next = pm->prev = NULL;
581 pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
583 GNUNET_STATISTICS_update (GDS_stats,
584 gettext_noop ("# RESULTS queued for clients"), 1,
586 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
587 reply->unique_id = record->unique_id;
588 LOG (GNUNET_ERROR_TYPE_DEBUG,
589 "Queueing reply to query %s for client %p\n",
591 record->client->client_handle);
592 add_pending_message (record->client, pm);
593 if (GNUNET_YES == do_free)
594 remove_client_records (record->client, key, record);
600 * Handle a reply we've received from another peer. If the reply
601 * matches any of our pending queries, forward it to the respective
604 * @param expiration when will the reply expire
605 * @param key the query this reply is for
606 * @param get_path_length number of peers in @a get_path
607 * @param get_path path the reply took on get
608 * @param put_path_length number of peers in @a put_path
609 * @param put_path path the reply took on put
610 * @param type type of the reply
611 * @param data_size number of bytes in @a data
612 * @param data application payload data
615 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
616 const struct GNUNET_HashCode *key,
617 unsigned int get_path_length,
618 const struct GNUNET_PeerIdentity *get_path,
619 unsigned int put_path_length,
620 const struct GNUNET_PeerIdentity *put_path,
621 enum GNUNET_BLOCK_Type type, size_t data_size,
624 struct ForwardReplyContext frc;
625 struct PendingMessage *pm;
626 struct GNUNET_DHT_ClientResultMessage *reply;
627 struct GNUNET_PeerIdentity *paths;
630 LOG (GNUNET_ERROR_TYPE_DEBUG,
631 "reply for key %s\n",
634 if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
636 GNUNET_STATISTICS_update (GDS_stats,
638 ("# REPLIES ignored for CLIENTS (no match)"), 1,
640 return; /* no matching request, fast exit! */
643 sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
644 (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
645 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
647 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
648 _("Could not pass reply to client, message too big!\n"));
651 DEBUG("reply FOR DATA_SIZE = %lu\n",msize);
652 pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
653 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
654 pm->msg = &reply->header;
655 reply->header.size = htons ((uint16_t) msize);
656 reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
657 reply->type = htonl (type);
658 reply->get_path_length = htonl (get_path_length);
659 reply->put_path_length = htonl (put_path_length);
660 reply->unique_id = 0; /* filled in later */
661 reply->expiration = GNUNET_TIME_absolute_hton (expiration);
663 paths = (struct GNUNET_PeerIdentity *) &reply[1];
664 memcpy (paths, put_path,
665 sizeof (struct GNUNET_PeerIdentity) * put_path_length);
666 memcpy (&paths[put_path_length], get_path,
667 sizeof (struct GNUNET_PeerIdentity) * get_path_length);
668 memcpy (&paths[get_path_length + put_path_length], data, data_size);
669 frc.do_copy = GNUNET_NO;
672 frc.data_size = data_size;
674 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
676 if (GNUNET_NO == frc.do_copy)
678 /* did not match any of the requests, free! */
679 GNUNET_STATISTICS_update (GDS_stats,
681 ("# REPLIES ignored for CLIENTS (no match)"), 1,
688 * Check if some client is monitoring GET messages and notify
691 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
692 * @param type The type of data in the request.
693 * @param hop_count Hop count so far.
694 * @param path_length number of entries in path (or 0 if not recorded).
695 * @param path peers on the GET path (or NULL if not recorded).
696 * @param desired_replication_level Desired replication level.
697 * @param key Key of the requested data.
700 GDS_CLIENTS_process_get (uint32_t options,
701 enum GNUNET_BLOCK_Type type,
703 uint32_t desired_replication_level,
704 unsigned int path_length,
705 const struct GNUNET_PeerIdentity *path,
706 const struct GNUNET_HashCode * key)
708 struct ClientMonitorRecord *m;
709 struct ClientList **cl;
710 unsigned int cl_size;
714 for (m = monitor_head; NULL != m; m = m->next)
716 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
718 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
720 struct PendingMessage *pm;
721 struct GNUNET_DHT_MonitorGetMessage *mmsg;
722 struct GNUNET_PeerIdentity *msg_path;
726 /* Don't send duplicates */
727 for (i = 0; i < cl_size; i++)
728 if (cl[i] == m->client)
732 GNUNET_array_append (cl, cl_size, m->client);
734 msize = path_length * sizeof (struct GNUNET_PeerIdentity);
735 msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
736 msize += sizeof (struct PendingMessage);
737 pm = GNUNET_malloc (msize);
738 mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
739 pm->msg = &mmsg->header;
740 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
741 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
742 mmsg->options = htonl(options);
743 mmsg->type = htonl(type);
744 mmsg->hop_count = htonl(hop_count);
745 mmsg->desired_replication_level = htonl(desired_replication_level);
746 mmsg->get_path_length = htonl(path_length);
747 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
748 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
750 memcpy (msg_path, path,
751 path_length * sizeof (struct GNUNET_PeerIdentity));
752 add_pending_message (m->client, pm);
755 GNUNET_free_non_null (cl);
760 * Check if some client is monitoring PUT messages and notify
763 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
764 * @param type The type of data in the request.
765 * @param hop_count Hop count so far.
766 * @param path_length number of entries in path (or 0 if not recorded).
767 * @param path peers on the PUT path (or NULL if not recorded).
768 * @param desired_replication_level Desired replication level.
769 * @param exp Expiration time of the data.
770 * @param key Key under which data is to be stored.
771 * @param data Pointer to the data carried.
772 * @param size Number of bytes in data.
775 GDS_CLIENTS_process_put (uint32_t options,
776 enum GNUNET_BLOCK_Type type,
778 uint32_t desired_replication_level,
779 unsigned int path_length,
780 const struct GNUNET_PeerIdentity *path,
781 struct GNUNET_TIME_Absolute exp,
782 const struct GNUNET_HashCode * key,
786 struct ClientMonitorRecord *m;
787 struct ClientList **cl;
788 unsigned int cl_size;
792 for (m = monitor_head; NULL != m; m = m->next)
794 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
796 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
798 struct PendingMessage *pm;
799 struct GNUNET_DHT_MonitorPutMessage *mmsg;
800 struct GNUNET_PeerIdentity *msg_path;
804 /* Don't send duplicates */
805 for (i = 0; i < cl_size; i++)
806 if (cl[i] == m->client)
810 GNUNET_array_append (cl, cl_size, m->client);
813 msize += path_length * sizeof (struct GNUNET_PeerIdentity);
814 msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
815 msize += sizeof (struct PendingMessage);
816 pm = GNUNET_malloc (msize);
817 mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
818 pm->msg = (struct GNUNET_MessageHeader *) mmsg;
819 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
820 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
821 mmsg->options = htonl(options);
822 mmsg->type = htonl(type);
823 mmsg->hop_count = htonl(hop_count);
824 mmsg->desired_replication_level = htonl(desired_replication_level);
825 mmsg->put_path_length = htonl(path_length);
826 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
829 memcpy (msg_path, path,
830 path_length * sizeof (struct GNUNET_PeerIdentity));
832 mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
833 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
835 memcpy (&msg_path[path_length], data, size);
836 add_pending_message (m->client, pm);
839 GNUNET_free_non_null (cl);
844 * Route the given request via the DHT.
847 transmit_request (struct ClientQueryRecord *cqr)
849 GNUNET_STATISTICS_update (GDS_stats,
851 ("# GET requests from clients injected"), 1,
854 LOG (GNUNET_ERROR_TYPE_DEBUG,
855 "Initiating GET for %s, replication %u, already have %u replies\n",
856 GNUNET_h2s (&cqr->key),
858 cqr->seen_replies_count);
860 GDS_NEIGHBOURS_handle_get (&cqr->key, cqr->type, cqr->msg_options,
863 /* exponential back-off for retries.
864 * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
865 cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
866 cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
871 * Task that looks at the 'retry_heap' and transmits all of the requests
872 * on the heap that are ready for transmission. Then re-schedules
873 * itself (unless the heap is empty).
876 * @param tc scheduler context
879 transmit_next_request_task (void *cls,
880 const struct GNUNET_SCHEDULER_TaskContext *tc)
882 struct ClientQueryRecord *cqr;
883 struct GNUNET_TIME_Relative delay;
885 retry_task = GNUNET_SCHEDULER_NO_TASK;
886 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
888 while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
891 delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
892 if (delay.rel_value_us > 0)
895 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
896 cqr->retry_time.abs_value_us);
898 GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
902 transmit_request (cqr);
904 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
905 cqr->retry_time.abs_value_us);
911 * Handler for PUT messages.
913 * @param cls closure for the service
914 * @param client the client we received this message from
915 * @param message the actual message received
918 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
919 const struct GNUNET_MessageHeader *message)
921 const struct GNUNET_DHT_ClientPutMessage *put_msg;
922 struct PendingMessage *pm;
923 struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
926 size = ntohs (message->size);
927 if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
930 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
933 GNUNET_STATISTICS_update (GDS_stats,
935 ("# PUT requests received from clients"), 1,
937 put_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
938 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE DHT CLIENT-PUT %s\n",
939 GNUNET_h2s_full (&put_msg->key));
940 /* give to local clients */
941 LOG (GNUNET_ERROR_TYPE_DEBUG,
942 "Handling local PUT of %u-bytes for query %s\n",
943 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
944 GNUNET_h2s (&put_msg->key));
945 DEBUG("PUT doing put i = %s\n",GNUNET_h2s(&(put_msg->key)));
946 GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
947 &put_msg->key, 0, NULL, 0, NULL,
948 ntohl (put_msg->type),
949 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
952 GDS_NEIGHBOURS_handle_put (&put_msg->key,
953 ntohl (put_msg->type), ntohl (put_msg->options),
954 ntohl (put_msg->desired_replication_level),
955 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
957 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
958 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
959 sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
960 conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
961 conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
962 conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
963 conf->reserved = htonl (0);
964 conf->unique_id = put_msg->unique_id;
965 pm->msg = &conf->header;
966 add_pending_message (find_active_client (client), pm);
967 GNUNET_SERVER_receive_done (client, GNUNET_OK);
972 * Handler for DHT GET messages from the client.
974 * @param cls closure for the service
975 * @param client the client we received this message from
976 * @param message the actual message received
979 handle_dht_local_get (void *cls, struct GNUNET_SERVER_Client *client,
980 const struct GNUNET_MessageHeader *message)
982 const struct GNUNET_DHT_ClientGetMessage *get;
983 struct ClientQueryRecord *cqr;
988 size = ntohs (message->size);
989 if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
992 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
995 xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
996 get = (const struct GNUNET_DHT_ClientGetMessage *) message;
997 xquery = (const char *) &get[1];
998 GNUNET_STATISTICS_update (GDS_stats,
1000 ("# GET requests received from clients"), 1,
1002 LOG (GNUNET_ERROR_TYPE_DEBUG,
1003 "Received GET request for %s from local client %p, xq: %.*s\n",
1004 GNUNET_h2s (&get->key), client, xquery_size, xquery);
1006 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE CLIENT-GET %s\n",
1007 GNUNET_h2s_full (&get->key));
1010 cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
1011 cqr->key = get->key;
1012 cqr->client = find_active_client (client);
1013 cqr->xquery = (void *) &cqr[1];
1014 memcpy (&cqr[1], xquery, xquery_size);
1015 cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
1016 cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
1017 cqr->retry_time = GNUNET_TIME_absolute_get ();
1018 cqr->unique_id = get->unique_id;
1019 cqr->xquery_size = xquery_size;
1020 cqr->replication = ntohl (get->desired_replication_level);
1021 cqr->msg_options = ntohl (get->options);
1022 cqr->type = ntohl (get->type);
1024 // FIXME use cqr->key, set multihashmap create to GNUNET_YES
1025 GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
1026 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1028 struct GNUNET_PeerIdentity my_identity;
1029 my_identity = GDS_NEIGHBOURS_get_my_id();
1030 GDS_CLIENTS_process_get (ntohl (get->options),
1033 ntohl (get->desired_replication_level),
1037 /* start remote requests */
1038 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1039 GNUNET_SCHEDULER_cancel (retry_task);
1040 retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
1041 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1046 * Closure for 'find_by_unique_id'.
1048 struct FindByUniqueIdContext
1051 * Where to store the result, if found.
1053 struct ClientQueryRecord *cqr;
1060 * Function called for each existing DHT record for the given
1061 * query. Checks if it matches the UID given in the closure
1062 * and if so returns the entry as a result.
1064 * @param cls the search context
1065 * @param key query for the lookup (not used)
1066 * @param value the 'struct ClientQueryRecord'
1067 * @return GNUNET_YES to continue iteration (result not yet found)
1070 find_by_unique_id (void *cls,
1071 const struct GNUNET_HashCode *key,
1074 struct FindByUniqueIdContext *fui_ctx = cls;
1075 struct ClientQueryRecord *cqr = value;
1077 if (cqr->unique_id != fui_ctx->unique_id)
1085 * Handler for "GET result seen" messages from the client.
1087 * @param cls closure for the service
1088 * @param client the client we received this message from
1089 * @param message the actual message received
1092 handle_dht_local_get_result_seen (void *cls, struct GNUNET_SERVER_Client *client,
1093 const struct GNUNET_MessageHeader *message)
1095 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
1097 unsigned int hash_count;
1098 unsigned int old_count;
1099 const struct GNUNET_HashCode *hc;
1100 struct FindByUniqueIdContext fui_ctx;
1101 struct ClientQueryRecord *cqr;
1103 size = ntohs (message->size);
1104 if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
1107 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1110 seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
1111 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
1112 if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
1115 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1118 hc = (const struct GNUNET_HashCode*) &seen[1];
1119 fui_ctx.unique_id = seen->unique_id;
1121 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1125 if (NULL == (cqr = fui_ctx.cqr))
1128 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1131 /* finally, update 'seen' list */
1132 old_count = cqr->seen_replies_count;
1133 GNUNET_array_grow (cqr->seen_replies,
1134 cqr->seen_replies_count,
1135 cqr->seen_replies_count + hash_count);
1136 memcpy (&cqr->seen_replies[old_count],
1138 sizeof (struct GNUNET_HashCode) * hash_count);
1143 * Closure for 'remove_by_unique_id'.
1145 struct RemoveByUniqueIdContext
1148 * Client that issued the removal request.
1150 struct ClientList *client;
1153 * Unique ID of the request.
1160 * Iterator over hash map entries that frees all entries
1161 * that match the given client and unique ID.
1163 * @param cls unique ID and client to search for in source routes
1164 * @param key current key code
1165 * @param value value in the hash map, a ClientQueryRecord
1166 * @return GNUNET_YES (we should continue to iterate)
1169 remove_by_unique_id (void *cls, const struct GNUNET_HashCode * key, void *value)
1171 const struct RemoveByUniqueIdContext *ctx = cls;
1172 struct ClientQueryRecord *record = value;
1174 if (record->unique_id != ctx->unique_id)
1176 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1177 "Removing client %p's record for key %s (by unique id)\n",
1178 ctx->client->client_handle, GNUNET_h2s (key));
1179 return remove_client_records (ctx->client, key, record);
1184 * Handler for any generic DHT stop messages, calls the appropriate handler
1185 * depending on message type (if processed locally)
1187 * @param cls closure for the service
1188 * @param client the client we received this message from
1189 * @param message the actual message received
1193 handle_dht_local_get_stop (void *cls, struct GNUNET_SERVER_Client *client,
1194 const struct GNUNET_MessageHeader *message)
1196 const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
1197 (const struct GNUNET_DHT_ClientGetStopMessage *) message;
1198 struct RemoveByUniqueIdContext ctx;
1200 GNUNET_STATISTICS_update (GDS_stats,
1202 ("# GET STOP requests received from clients"), 1,
1204 LOG (GNUNET_ERROR_TYPE_DEBUG,
1205 "Received GET STOP request for %s from local client %p\n",
1206 client, GNUNET_h2s (&dht_stop_msg->key));
1207 ctx.client = find_active_client (client);
1208 ctx.unique_id = dht_stop_msg->unique_id;
1209 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
1210 &remove_by_unique_id, &ctx);
1211 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1216 * Handler for monitor start messages
1218 * @param cls closure for the service
1219 * @param client the client we received this message from
1220 * @param message the actual message received
1224 handle_dht_local_monitor (void *cls, struct GNUNET_SERVER_Client *client,
1225 const struct GNUNET_MessageHeader *message)
1227 struct ClientMonitorRecord *r;
1228 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1230 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1231 r = GNUNET_new (struct ClientMonitorRecord);
1233 r->client = find_active_client(client);
1234 r->type = ntohl(msg->type);
1235 r->get = ntohs(msg->get);
1236 r->get_resp = ntohs(msg->get_resp);
1237 r->put = ntohs(msg->put);
1238 if (0 == ntohs(msg->filter_key))
1242 r->key = GNUNET_new (struct GNUNET_HashCode);
1243 memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
1245 GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
1246 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1251 * Handler for monitor stop messages
1253 * @param cls closure for the service
1254 * @param client the client we received this message from
1255 * @param message the actual message received
1259 handle_dht_local_monitor_stop (void *cls, struct GNUNET_SERVER_Client *client,
1260 const struct GNUNET_MessageHeader *message)
1262 struct ClientMonitorRecord *r;
1263 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1266 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1272 keys_match = (0 == ntohs(msg->filter_key));
1275 keys_match = (0 != ntohs(msg->filter_key)
1276 && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
1278 if (find_active_client(client) == r->client
1279 && ntohl(msg->type) == r->type
1280 && r->get == msg->get
1281 && r->get_resp == msg->get_resp
1282 && r->put == msg->put
1286 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
1287 GNUNET_free_non_null (r->key);
1289 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1290 return; /* Delete only ONE entry */
1295 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1299 #if ENABLE_MALICIOUS
1301 * Handler for act malicous message.
1303 * @param cls closure for the service
1304 * @param client the client we received this message from
1305 * @param message the actual message received
1309 handle_dht_act_malicious (void *cls, struct GNUNET_SERVER_Client *client,
1310 const struct GNUNET_MessageHeader *message)
1312 const struct GNUNET_DHT_ActMaliciousMessage *msg;
1313 unsigned int malicious;
1315 msg = (const struct GNUNET_DHT_ActMaliciousMessage *)message;
1316 malicious = msg->action;
1317 GDS_NEIGHBOURS_act_malicious(malicious);
1323 * Functions with this signature are called whenever a client
1324 * is disconnected on the network level.
1326 * @param cls closure (NULL for dht)
1327 * @param client identification of the client; NULL
1328 * for the last call when the server is destroyed
1331 handle_client_disconnect (void *cls,
1332 struct GNUNET_SERVER_Client *client)
1334 struct ClientList *pos;
1335 struct PendingMessage *reply;
1336 struct ClientMonitorRecord *monitor;
1338 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1339 "Local client %p disconnects\n",
1341 pos = find_active_client (client);
1342 GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
1343 if (pos->transmit_handle != NULL)
1344 GNUNET_SERVER_notify_transmit_ready_cancel (pos->transmit_handle);
1345 while (NULL != (reply = pos->pending_head))
1347 GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
1348 GNUNET_free (reply);
1350 monitor = monitor_head;
1351 while (NULL != monitor)
1353 if (monitor->client == pos)
1355 struct ClientMonitorRecord *next;
1357 GNUNET_free_non_null (monitor->key);
1358 next = monitor->next;
1359 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
1360 GNUNET_free (monitor);
1364 monitor = monitor->next;
1366 GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
1374 * Initialize client subsystem.
1376 * @param server the initialized server
1379 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1381 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1382 {&handle_dht_local_put, NULL,
1383 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1384 {&handle_dht_local_get, NULL,
1385 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1386 {&handle_dht_local_get_stop, NULL,
1387 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1388 sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1389 {&handle_dht_local_monitor, NULL,
1390 GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1391 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1392 {&handle_dht_local_monitor_stop, NULL,
1393 GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1394 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1395 {&handle_dht_local_get_result_seen, NULL,
1396 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1397 #if ENABLE_MALICIOUS
1398 {&handle_dht_act_malicious, NULL,
1399 GNUNET_MESSAGE_TYPE_DHT_ACT_MALICIOUS,
1400 sizeof (struct GNUNET_DHT_ActMaliciousMessage)},
1404 forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1405 retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1406 GNUNET_SERVER_add_handlers (server, plugin_handlers);
1407 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1412 * Shutdown client subsystem.
1417 GNUNET_assert (client_head == NULL);
1418 GNUNET_assert (client_tail == NULL);
1419 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1421 GNUNET_SCHEDULER_cancel (retry_task);
1422 retry_task = GNUNET_SCHEDULER_NO_TASK;
1424 if (NULL != retry_heap)
1426 GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1427 GNUNET_CONTAINER_heap_destroy (retry_heap);
1430 if (NULL != forward_map)
1432 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1433 GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1438 /* end of gnunet-service-dht_clients.c */