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__)
50 * Linked list of messages to send to clients.
55 * Pointer to next item in the list
57 struct PendingMessage *next;
60 * Pointer to previous item in the list
62 struct PendingMessage *prev;
65 * Actual message to be sent, allocated at the end of the struct:
66 * // msg = (cast) &pm[1];
67 * // memcpy (&pm[1], data, len);
69 const struct GNUNET_MessageHeader *msg;
75 * Struct containing information about a client,
76 * handle to connect to it, and any pending messages
77 * that need to be sent to it.
82 * Linked list of active clients
84 struct ClientList *next;
87 * Linked list of active clients
89 struct ClientList *prev;
92 * The handle to this client
94 struct GNUNET_SERVER_Client *client_handle;
97 * Handle to the current transmission request, NULL
100 struct GNUNET_SERVER_TransmitHandle *transmit_handle;
103 * Linked list of pending messages for this client
105 struct PendingMessage *pending_head;
108 * Tail of linked list of pending messages for this client
110 struct PendingMessage *pending_tail;
116 * Entry in the local forwarding map for a client's GET request.
118 struct ClientQueryRecord
122 * The key this request was about
124 struct GNUNET_HashCode key;
127 * Client responsible for the request.
129 struct ClientList *client;
132 * Extended query (see gnunet_block_lib.h), allocated at the end of this struct.
137 * Replies we have already seen for this request.
139 struct GNUNET_HashCode *seen_replies;
142 * Pointer to this nodes heap location in the retry-heap (for fast removal)
144 struct GNUNET_CONTAINER_HeapNode *hnode;
147 * What's the delay between re-try operations that we currently use for this
150 struct GNUNET_TIME_Relative retry_frequency;
153 * What's the next time we should re-try this request?
155 struct GNUNET_TIME_Absolute retry_time;
158 * The unique identifier of this request
163 * Number of bytes in xquery.
168 * Number of entries in 'seen_replies'.
170 unsigned int seen_replies_count;
173 * Desired replication level
175 uint32_t replication;
178 * Any message options for this request
180 uint32_t msg_options;
183 * The type for the data for the GET request.
185 enum GNUNET_BLOCK_Type type;
191 * Struct containing paremeters of monitoring requests.
193 struct ClientMonitorRecord
197 * Next element in DLL.
199 struct ClientMonitorRecord *next;
202 * Previous element in DLL.
204 struct ClientMonitorRecord *prev;
207 * Type of blocks that are of interest
209 enum GNUNET_BLOCK_Type type;
212 * Key of data of interest, NULL for all.
214 struct GNUNET_HashCode *key;
217 * Flag whether to notify about GET messages.
222 * Flag whether to notify about GET_REPONSE messages.
227 * Flag whether to notify about PUT messages.
232 * Client to notify of these requests.
234 struct ClientList *client;
239 * List of active clients.
241 static struct ClientList *client_head;
244 * List of active clients.
246 static struct ClientList *client_tail;
249 * List of active monitoring requests.
251 static struct ClientMonitorRecord *monitor_head;
254 * List of active monitoring requests.
256 static struct ClientMonitorRecord *monitor_tail;
259 * Hashmap for fast key based lookup, maps keys to `struct ClientQueryRecord` entries.
261 static struct GNUNET_CONTAINER_MultiHashMap *forward_map;
264 * Heap with all of our client's request, sorted by retry time (earliest on top).
266 static struct GNUNET_CONTAINER_Heap *retry_heap;
269 * Task that re-transmits requests (using retry_heap).
271 static GNUNET_SCHEDULER_TaskIdentifier retry_task;
275 * Task run to check for messages that need to be sent to a client.
277 * @param client a ClientList, containing the client and any messages to be sent to it
280 process_pending_messages (struct ClientList *client);
284 * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
285 * request. A ClientList is passed as closure, take the head of the list
286 * and copy it into buf, which has the result of sending the message to the
289 * @param cls closure to this call
290 * @param size maximum number of bytes available to send
291 * @param buf where to copy the actual message to
293 * @return the number of bytes actually copied, 0 indicates failure
296 send_reply_to_client (void *cls, size_t size, void *buf)
298 struct ClientList *client = cls;
300 struct PendingMessage *reply;
304 client->transmit_handle = NULL;
307 /* client disconnected */
308 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
309 "Client %p disconnected, pending messages will be discarded\n",
310 client->client_handle);
314 while ((NULL != (reply = client->pending_head)) &&
315 (size >= off + (msize = ntohs (reply->msg->size))))
317 GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
319 memcpy (&cbuf[off], reply->msg, msize);
321 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes to client %p\n",
322 msize, client->client_handle);
325 process_pending_messages (client);
326 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitted %u/%u bytes to client %p\n",
327 (unsigned int) off, (unsigned int) size, client->client_handle);
333 * Task run to check for messages that need to be sent to a client.
335 * @param client a ClientList, containing the client and any messages to be sent to it
338 process_pending_messages (struct ClientList *client)
340 if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
342 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
343 "Not asking for transmission to %p now: %s\n",
344 client->client_handle,
345 client->pending_head ==
346 NULL ? "no more messages" : "request already pending");
349 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
350 "Asking for transmission of %u bytes to client %p\n",
351 ntohs (client->pending_head->msg->size), client->client_handle);
352 client->transmit_handle =
353 GNUNET_SERVER_notify_transmit_ready (client->client_handle,
354 ntohs (client->pending_head->
356 GNUNET_TIME_UNIT_FOREVER_REL,
357 &send_reply_to_client, client);
362 * Add a PendingMessage to the clients list of messages to be sent
364 * @param client the active client to send the message to
365 * @param pending_message the actual message to send
368 add_pending_message (struct ClientList *client,
369 struct PendingMessage *pending_message)
371 GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
373 process_pending_messages (client);
378 * Closure for 'forward_reply'
380 struct ForwardReplyContext
384 * Actual message to send to matching clients.
386 struct PendingMessage *pm;
396 enum GNUNET_BLOCK_Type type;
399 * Number of bytes in data.
404 * Do we need to copy 'pm' because it was already used?
412 * Find a client if it exists, add it otherwise.
414 * @param client the server handle to the client
416 * @return the client if found, a new client otherwise
418 static struct ClientList *
419 find_active_client (struct GNUNET_SERVER_Client *client)
421 struct ClientList *pos = client_head;
422 struct ClientList *ret;
426 if (pos->client_handle == client)
430 ret = GNUNET_new (struct ClientList);
431 ret->client_handle = client;
432 GNUNET_CONTAINER_DLL_insert (client_head, client_tail, ret);
438 * Iterator over hash map entries that frees all entries
439 * associated with the given client.
441 * @param cls client to search for in source routes
442 * @param key current key code (ignored)
443 * @param value value in the hash map, a ClientQueryRecord
444 * @return #GNUNET_YES (we should continue to iterate)
447 remove_client_records (void *cls, const struct GNUNET_HashCode * key, void *value)
449 struct ClientList *client = cls;
450 struct ClientQueryRecord *record = value;
452 if (record->client != client)
454 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
455 "Removing client %p's record for key %s\n", client,
457 GNUNET_assert (GNUNET_YES ==
458 GNUNET_CONTAINER_multihashmap_remove (forward_map, key,
460 if (NULL != record->hnode)
461 GNUNET_CONTAINER_heap_remove_node (record->hnode);
462 GNUNET_array_grow (record->seen_replies, record->seen_replies_count, 0);
463 GNUNET_free (record);
469 * Iterator over hash map entries that send a given reply to
470 * each of the matching clients. With some tricky recycling
473 * @param cls the 'struct ForwardReplyContext'
474 * @param key current key
475 * @param value value in the hash map, a ClientQueryRecord
476 * @return GNUNET_YES (we should continue to iterate),
477 * if the result is mal-formed, GNUNET_NO
480 forward_reply (void *cls, const struct GNUNET_HashCode * key, void *value)
482 struct ForwardReplyContext *frc = cls;
483 struct ClientQueryRecord *record = value;
484 struct PendingMessage *pm;
485 struct GNUNET_DHT_ClientResultMessage *reply;
486 enum GNUNET_BLOCK_EvaluationResult eval;
488 struct GNUNET_HashCode ch;
491 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
492 "XVINE CLIENT-RESULT %s\n",
493 GNUNET_h2s_full (key));
495 if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
497 LOG (GNUNET_ERROR_TYPE_DEBUG,
498 "Record type missmatch, not passing request for key %s to local client\n",
501 GNUNET_STATISTICS_update (GDS_stats,
503 ("# Key match, type mismatches in REPLY to CLIENT"),
505 return GNUNET_YES; /* type mismatch */
508 GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
509 for (i = 0; i < record->seen_replies_count; i++)
510 if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
512 LOG (GNUNET_ERROR_TYPE_DEBUG,
513 "Duplicate reply, not passing request for key %s to local client\n",
515 GNUNET_STATISTICS_update (GDS_stats,
517 ("# Duplicate REPLIES to CLIENT request dropped"),
519 return GNUNET_YES; /* duplicate */
522 GNUNET_BLOCK_evaluate (GDS_block_context, record->type, key, NULL, 0,
523 record->xquery, record->xquery_size, frc->data,
525 LOG (GNUNET_ERROR_TYPE_DEBUG,
526 "Evaluation result is %d for key %s for local client's query\n",
527 (int) eval, GNUNET_h2s (key));
530 case GNUNET_BLOCK_EVALUATION_OK_LAST:
531 do_free = GNUNET_YES;
533 case GNUNET_BLOCK_EVALUATION_OK_MORE:
534 GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
537 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
538 /* should be impossible to encounter here */
541 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
544 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
547 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
550 case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
552 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
553 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
554 _("Unsupported block type (%u) in request!\n"), record->type);
560 if (GNUNET_NO == frc->do_copy)
562 /* first time, we can use the original data */
564 frc->do_copy = GNUNET_YES;
568 /* two clients waiting for same reply, must copy for queueing */
569 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
570 ntohs (frc->pm->msg->size));
572 sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
573 pm->next = pm->prev = NULL;
574 pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
576 GNUNET_STATISTICS_update (GDS_stats,
577 gettext_noop ("# RESULTS queued for clients"), 1,
579 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
580 reply->unique_id = record->unique_id;
581 LOG (GNUNET_ERROR_TYPE_DEBUG,
582 "Queueing reply to query %s for client %p\n",
584 record->client->client_handle);
585 add_pending_message (record->client, pm);
586 if (GNUNET_YES == do_free)
587 remove_client_records (record->client, key, record);
593 * Handle a reply we've received from another peer. If the reply
594 * matches any of our pending queries, forward it to the respective
597 * @param expiration when will the reply expire
598 * @param key the query this reply is for
599 * @param get_path_length number of peers in @a get_path
600 * @param get_path path the reply took on get
601 * @param put_path_length number of peers in @a put_path
602 * @param put_path path the reply took on put
603 * @param type type of the reply
604 * @param data_size number of bytes in @a data
605 * @param data application payload data
608 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
609 const struct GNUNET_HashCode *key,
610 unsigned int get_path_length,
611 const struct GNUNET_PeerIdentity *get_path,
612 unsigned int put_path_length,
613 const struct GNUNET_PeerIdentity *put_path,
614 enum GNUNET_BLOCK_Type type, size_t data_size,
617 struct ForwardReplyContext frc;
618 struct PendingMessage *pm;
619 struct GNUNET_DHT_ClientResultMessage *reply;
620 struct GNUNET_PeerIdentity *paths;
623 LOG (GNUNET_ERROR_TYPE_DEBUG,
624 "reply for key %s\n",
627 if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
629 GNUNET_STATISTICS_update (GDS_stats,
631 ("# REPLIES ignored for CLIENTS (no match)"), 1,
633 return; /* no matching request, fast exit! */
636 sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
637 (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
638 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
640 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
641 _("Could not pass reply to client, message too big!\n"));
644 DEBUG("reply FOR DATA_SIZE = %lu\n",msize);
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,
669 if (GNUNET_NO == frc.do_copy)
671 /* did not match any of the requests, free! */
672 GNUNET_STATISTICS_update (GDS_stats,
674 ("# REPLIES ignored for CLIENTS (no match)"), 1,
681 * Check if some client is monitoring GET messages and notify
684 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
685 * @param type The type of data in the request.
686 * @param hop_count Hop count so far.
687 * @param path_length number of entries in path (or 0 if not recorded).
688 * @param path peers on the GET path (or NULL if not recorded).
689 * @param desired_replication_level Desired replication level.
690 * @param key Key of the requested data.
693 GDS_CLIENTS_process_get (uint32_t options,
694 enum GNUNET_BLOCK_Type type,
696 uint32_t desired_replication_level,
697 unsigned int path_length,
698 const struct GNUNET_PeerIdentity *path,
699 const struct GNUNET_HashCode * key)
701 struct ClientMonitorRecord *m;
702 struct ClientList **cl;
703 unsigned int cl_size;
707 for (m = monitor_head; NULL != m; m = m->next)
709 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
711 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
713 struct PendingMessage *pm;
714 struct GNUNET_DHT_MonitorGetMessage *mmsg;
715 struct GNUNET_PeerIdentity *msg_path;
719 /* Don't send duplicates */
720 for (i = 0; i < cl_size; i++)
721 if (cl[i] == m->client)
725 GNUNET_array_append (cl, cl_size, m->client);
727 msize = path_length * sizeof (struct GNUNET_PeerIdentity);
728 msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
729 msize += sizeof (struct PendingMessage);
730 pm = GNUNET_malloc (msize);
731 mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
732 pm->msg = &mmsg->header;
733 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
734 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
735 mmsg->options = htonl(options);
736 mmsg->type = htonl(type);
737 mmsg->hop_count = htonl(hop_count);
738 mmsg->desired_replication_level = htonl(desired_replication_level);
739 mmsg->get_path_length = htonl(path_length);
740 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
741 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
743 memcpy (msg_path, path,
744 path_length * sizeof (struct GNUNET_PeerIdentity));
745 add_pending_message (m->client, pm);
748 GNUNET_free_non_null (cl);
753 * Check if some client is monitoring PUT messages and notify
756 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
757 * @param type The type of data in the request.
758 * @param hop_count Hop count so far.
759 * @param path_length number of entries in path (or 0 if not recorded).
760 * @param path peers on the PUT path (or NULL if not recorded).
761 * @param desired_replication_level Desired replication level.
762 * @param exp Expiration time of the data.
763 * @param key Key under which data is to be stored.
764 * @param data Pointer to the data carried.
765 * @param size Number of bytes in data.
768 GDS_CLIENTS_process_put (uint32_t options,
769 enum GNUNET_BLOCK_Type type,
771 uint32_t desired_replication_level,
772 unsigned int path_length,
773 const struct GNUNET_PeerIdentity *path,
774 struct GNUNET_TIME_Absolute exp,
775 const struct GNUNET_HashCode * key,
779 struct ClientMonitorRecord *m;
780 struct ClientList **cl;
781 unsigned int cl_size;
785 for (m = monitor_head; NULL != m; m = m->next)
787 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
789 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
791 struct PendingMessage *pm;
792 struct GNUNET_DHT_MonitorPutMessage *mmsg;
793 struct GNUNET_PeerIdentity *msg_path;
797 /* Don't send duplicates */
798 for (i = 0; i < cl_size; i++)
799 if (cl[i] == m->client)
803 GNUNET_array_append (cl, cl_size, m->client);
806 msize += path_length * sizeof (struct GNUNET_PeerIdentity);
807 msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
808 msize += sizeof (struct PendingMessage);
809 pm = GNUNET_malloc (msize);
810 mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
811 pm->msg = (struct GNUNET_MessageHeader *) mmsg;
812 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
813 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
814 mmsg->options = htonl(options);
815 mmsg->type = htonl(type);
816 mmsg->hop_count = htonl(hop_count);
817 mmsg->desired_replication_level = htonl(desired_replication_level);
818 mmsg->put_path_length = htonl(path_length);
819 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
822 memcpy (msg_path, path,
823 path_length * sizeof (struct GNUNET_PeerIdentity));
825 mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
826 memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
828 memcpy (&msg_path[path_length], data, size);
829 add_pending_message (m->client, pm);
832 GNUNET_free_non_null (cl);
837 * Route the given request via the DHT.
840 transmit_request (struct ClientQueryRecord *cqr)
842 GNUNET_STATISTICS_update (GDS_stats,
844 ("# GET requests from clients injected"), 1,
847 LOG (GNUNET_ERROR_TYPE_DEBUG,
848 "Initiating GET for %s, replication %u, already have %u replies\n",
849 GNUNET_h2s (&cqr->key),
851 cqr->seen_replies_count);
853 GDS_NEIGHBOURS_handle_get (&cqr->key, cqr->type, cqr->msg_options,
856 /* exponential back-off for retries.
857 * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
858 cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
859 cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
864 * Task that looks at the 'retry_heap' and transmits all of the requests
865 * on the heap that are ready for transmission. Then re-schedules
866 * itself (unless the heap is empty).
869 * @param tc scheduler context
872 transmit_next_request_task (void *cls,
873 const struct GNUNET_SCHEDULER_TaskContext *tc)
875 struct ClientQueryRecord *cqr;
876 struct GNUNET_TIME_Relative delay;
878 retry_task = GNUNET_SCHEDULER_NO_TASK;
879 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
881 while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
884 delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
885 if (delay.rel_value_us > 0)
888 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
889 cqr->retry_time.abs_value_us);
891 GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
895 transmit_request (cqr);
897 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
898 cqr->retry_time.abs_value_us);
904 * Handler for PUT messages.
906 * @param cls closure for the service
907 * @param client the client we received this message from
908 * @param message the actual message received
911 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
912 const struct GNUNET_MessageHeader *message)
914 const struct GNUNET_DHT_ClientPutMessage *put_msg;
915 struct PendingMessage *pm;
916 struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
919 size = ntohs (message->size);
920 if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
923 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
926 GNUNET_STATISTICS_update (GDS_stats,
928 ("# PUT requests received from clients"), 1,
930 put_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
931 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE DHT CLIENT-PUT %s\n",
932 GNUNET_h2s_full (&put_msg->key));
933 /* give to local clients */
934 LOG (GNUNET_ERROR_TYPE_DEBUG,
935 "Handling local PUT of %u-bytes for query %s\n",
936 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
937 GNUNET_h2s (&put_msg->key));
938 DEBUG("PUT doing put i = %s\n",GNUNET_h2s(&(put_msg->key)));
939 GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
940 &put_msg->key, 0, NULL, 0, NULL,
941 ntohl (put_msg->type),
942 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
945 GDS_NEIGHBOURS_handle_put (&put_msg->key,
946 ntohl (put_msg->type), ntohl (put_msg->options),
947 ntohl (put_msg->desired_replication_level),
948 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
950 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
951 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
952 sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
953 conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
954 conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
955 conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
956 conf->reserved = htonl (0);
957 conf->unique_id = put_msg->unique_id;
958 pm->msg = &conf->header;
959 add_pending_message (find_active_client (client), pm);
960 GNUNET_SERVER_receive_done (client, GNUNET_OK);
965 * Handler for DHT GET messages from the client.
967 * @param cls closure for the service
968 * @param client the client we received this message from
969 * @param message the actual message received
972 handle_dht_local_get (void *cls, struct GNUNET_SERVER_Client *client,
973 const struct GNUNET_MessageHeader *message)
975 const struct GNUNET_DHT_ClientGetMessage *get;
976 struct ClientQueryRecord *cqr;
981 size = ntohs (message->size);
982 if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
985 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
988 xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
989 get = (const struct GNUNET_DHT_ClientGetMessage *) message;
990 xquery = (const char *) &get[1];
991 GNUNET_STATISTICS_update (GDS_stats,
993 ("# GET requests received from clients"), 1,
995 LOG (GNUNET_ERROR_TYPE_DEBUG,
996 "Received GET request for %s from local client %p, xq: %.*s\n",
997 GNUNET_h2s (&get->key), client, xquery_size, xquery);
999 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE CLIENT-GET %s\n",
1000 GNUNET_h2s_full (&get->key));
1003 cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
1004 cqr->key = get->key;
1005 cqr->client = find_active_client (client);
1006 cqr->xquery = (void *) &cqr[1];
1007 memcpy (&cqr[1], xquery, xquery_size);
1008 cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
1009 cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
1010 cqr->retry_time = GNUNET_TIME_absolute_get ();
1011 cqr->unique_id = get->unique_id;
1012 cqr->xquery_size = xquery_size;
1013 cqr->replication = ntohl (get->desired_replication_level);
1014 cqr->msg_options = ntohl (get->options);
1015 cqr->type = ntohl (get->type);
1017 // FIXME use cqr->key, set multihashmap create to GNUNET_YES
1018 GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
1019 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1021 struct GNUNET_PeerIdentity my_identity;
1022 my_identity = GDS_NEIGHBOURS_get_my_id();
1023 GDS_CLIENTS_process_get (ntohl (get->options),
1026 ntohl (get->desired_replication_level),
1030 /* start remote requests */
1031 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1032 GNUNET_SCHEDULER_cancel (retry_task);
1033 retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
1034 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1039 * Closure for 'find_by_unique_id'.
1041 struct FindByUniqueIdContext
1044 * Where to store the result, if found.
1046 struct ClientQueryRecord *cqr;
1053 * Function called for each existing DHT record for the given
1054 * query. Checks if it matches the UID given in the closure
1055 * and if so returns the entry as a result.
1057 * @param cls the search context
1058 * @param key query for the lookup (not used)
1059 * @param value the 'struct ClientQueryRecord'
1060 * @return GNUNET_YES to continue iteration (result not yet found)
1063 find_by_unique_id (void *cls,
1064 const struct GNUNET_HashCode *key,
1067 struct FindByUniqueIdContext *fui_ctx = cls;
1068 struct ClientQueryRecord *cqr = value;
1070 if (cqr->unique_id != fui_ctx->unique_id)
1078 * Handler for "GET result seen" messages from the client.
1080 * @param cls closure for the service
1081 * @param client the client we received this message from
1082 * @param message the actual message received
1085 handle_dht_local_get_result_seen (void *cls, struct GNUNET_SERVER_Client *client,
1086 const struct GNUNET_MessageHeader *message)
1088 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
1090 unsigned int hash_count;
1091 unsigned int old_count;
1092 const struct GNUNET_HashCode *hc;
1093 struct FindByUniqueIdContext fui_ctx;
1094 struct ClientQueryRecord *cqr;
1096 size = ntohs (message->size);
1097 if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
1100 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1103 seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
1104 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
1105 if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
1108 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1111 hc = (const struct GNUNET_HashCode*) &seen[1];
1112 fui_ctx.unique_id = seen->unique_id;
1114 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1118 if (NULL == (cqr = fui_ctx.cqr))
1121 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1124 /* finally, update 'seen' list */
1125 old_count = cqr->seen_replies_count;
1126 GNUNET_array_grow (cqr->seen_replies,
1127 cqr->seen_replies_count,
1128 cqr->seen_replies_count + hash_count);
1129 memcpy (&cqr->seen_replies[old_count],
1131 sizeof (struct GNUNET_HashCode) * hash_count);
1136 * Closure for 'remove_by_unique_id'.
1138 struct RemoveByUniqueIdContext
1141 * Client that issued the removal request.
1143 struct ClientList *client;
1146 * Unique ID of the request.
1153 * Iterator over hash map entries that frees all entries
1154 * that match the given client and unique ID.
1156 * @param cls unique ID and client to search for in source routes
1157 * @param key current key code
1158 * @param value value in the hash map, a ClientQueryRecord
1159 * @return GNUNET_YES (we should continue to iterate)
1162 remove_by_unique_id (void *cls, const struct GNUNET_HashCode * key, void *value)
1164 const struct RemoveByUniqueIdContext *ctx = cls;
1165 struct ClientQueryRecord *record = value;
1167 if (record->unique_id != ctx->unique_id)
1169 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1170 "Removing client %p's record for key %s (by unique id)\n",
1171 ctx->client->client_handle, GNUNET_h2s (key));
1172 return remove_client_records (ctx->client, key, record);
1177 * Handler for any generic DHT stop messages, calls the appropriate handler
1178 * depending on message type (if processed locally)
1180 * @param cls closure for the service
1181 * @param client the client we received this message from
1182 * @param message the actual message received
1186 handle_dht_local_get_stop (void *cls, struct GNUNET_SERVER_Client *client,
1187 const struct GNUNET_MessageHeader *message)
1189 const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
1190 (const struct GNUNET_DHT_ClientGetStopMessage *) message;
1191 struct RemoveByUniqueIdContext ctx;
1193 GNUNET_STATISTICS_update (GDS_stats,
1195 ("# GET STOP requests received from clients"), 1,
1197 LOG (GNUNET_ERROR_TYPE_DEBUG,
1198 "Received GET STOP request for %s from local client %p\n",
1199 client, GNUNET_h2s (&dht_stop_msg->key));
1200 ctx.client = find_active_client (client);
1201 ctx.unique_id = dht_stop_msg->unique_id;
1202 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
1203 &remove_by_unique_id, &ctx);
1204 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1209 * Handler for monitor start messages
1211 * @param cls closure for the service
1212 * @param client the client we received this message from
1213 * @param message the actual message received
1217 handle_dht_local_monitor (void *cls, struct GNUNET_SERVER_Client *client,
1218 const struct GNUNET_MessageHeader *message)
1220 struct ClientMonitorRecord *r;
1221 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1223 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1224 r = GNUNET_new (struct ClientMonitorRecord);
1226 r->client = find_active_client(client);
1227 r->type = ntohl(msg->type);
1228 r->get = ntohs(msg->get);
1229 r->get_resp = ntohs(msg->get_resp);
1230 r->put = ntohs(msg->put);
1231 if (0 == ntohs(msg->filter_key))
1235 r->key = GNUNET_new (struct GNUNET_HashCode);
1236 memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
1238 GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
1239 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1244 * Handler for monitor stop messages
1246 * @param cls closure for the service
1247 * @param client the client we received this message from
1248 * @param message the actual message received
1252 handle_dht_local_monitor_stop (void *cls, struct GNUNET_SERVER_Client *client,
1253 const struct GNUNET_MessageHeader *message)
1255 struct ClientMonitorRecord *r;
1256 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1259 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1265 keys_match = (0 == ntohs(msg->filter_key));
1268 keys_match = (0 != ntohs(msg->filter_key)
1269 && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
1271 if (find_active_client(client) == r->client
1272 && ntohl(msg->type) == r->type
1273 && r->get == msg->get
1274 && r->get_resp == msg->get_resp
1275 && r->put == msg->put
1279 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
1280 GNUNET_free_non_null (r->key);
1282 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1283 return; /* Delete only ONE entry */
1288 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1292 #if ENABLE_MALICIOUS
1294 * Handler for act malicious message.
1296 * @param cls closure for the service
1297 * @param client the client we received this message from
1298 * @param message the actual message received
1302 handle_dht_act_malicious (void *cls, struct GNUNET_SERVER_Client *client,
1303 const struct GNUNET_MessageHeader *message)
1305 const struct GNUNET_DHT_ActMaliciousMessage *msg;
1306 struct PendingMessage *pm;
1307 struct GNUNET_DHT_ClientActMaliciousConfirmationMessage *conf;
1308 unsigned int malicious_action;
1310 msg = (const struct GNUNET_DHT_ActMaliciousMessage *)message;
1311 malicious_action = msg->action;
1313 if(GNUNET_OK == GDS_NEIGHBOURS_act_malicious (malicious_action))
1315 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
1316 sizeof (struct GNUNET_DHT_ClientActMaliciousConfirmationMessage));
1317 conf = (struct GNUNET_DHT_ClientActMaliciousConfirmationMessage *) &pm[1];
1318 conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientActMaliciousConfirmationMessage));
1319 conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_ACT_MALICIOUS_OK);
1320 pm->msg = &conf->header;
1321 add_pending_message (find_active_client (client), pm);
1322 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1329 * Functions with this signature are called whenever a client
1330 * is disconnected on the network level.
1332 * @param cls closure (NULL for dht)
1333 * @param client identification of the client; NULL
1334 * for the last call when the server is destroyed
1337 handle_client_disconnect (void *cls,
1338 struct GNUNET_SERVER_Client *client)
1340 struct ClientList *pos;
1341 struct PendingMessage *reply;
1342 struct ClientMonitorRecord *monitor;
1344 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1345 "Local client %p disconnects\n",
1347 pos = find_active_client (client);
1348 GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
1349 if (pos->transmit_handle != NULL)
1350 GNUNET_SERVER_notify_transmit_ready_cancel (pos->transmit_handle);
1351 while (NULL != (reply = pos->pending_head))
1353 GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
1354 GNUNET_free (reply);
1356 monitor = monitor_head;
1357 while (NULL != monitor)
1359 if (monitor->client == pos)
1361 struct ClientMonitorRecord *next;
1363 GNUNET_free_non_null (monitor->key);
1364 next = monitor->next;
1365 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
1366 GNUNET_free (monitor);
1370 monitor = monitor->next;
1372 GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
1380 * Initialize client subsystem.
1382 * @param server the initialized server
1385 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1387 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1388 {&handle_dht_local_put, NULL,
1389 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1390 {&handle_dht_local_get, NULL,
1391 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1392 {&handle_dht_local_get_stop, NULL,
1393 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1394 sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1395 {&handle_dht_local_monitor, NULL,
1396 GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1397 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1398 {&handle_dht_local_monitor_stop, NULL,
1399 GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1400 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1401 {&handle_dht_local_get_result_seen, NULL,
1402 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1403 #if ENABLE_MALICIOUS
1404 {&handle_dht_act_malicious, NULL,
1405 GNUNET_MESSAGE_TYPE_DHT_ACT_MALICIOUS,
1406 sizeof (struct GNUNET_DHT_ActMaliciousMessage)},
1410 forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1411 retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1412 GNUNET_SERVER_add_handlers (server, plugin_handlers);
1413 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1418 * Shutdown client subsystem.
1423 GNUNET_assert (client_head == NULL);
1424 GNUNET_assert (client_tail == NULL);
1425 if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1427 GNUNET_SCHEDULER_cancel (retry_task);
1428 retry_task = GNUNET_SCHEDULER_NO_TASK;
1430 if (NULL != retry_heap)
1432 GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1433 GNUNET_CONTAINER_heap_destroy (retry_heap);
1436 if (NULL != forward_map)
1438 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1439 GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1444 /* end of gnunet-service-dht_clients.c */