2 This file is part of GNUnet.
3 Copyright (C) 2009, 2010, 2011, 2016 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file dht/gnunet-service-wdht_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-wdht.h"
33 #include "gnunet-service-wdht_clients.h"
34 #include "gnunet-service-dht_datacache.h"
35 #include "gnunet-service-wdht_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 * // GNUNET_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 @e 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 struct GNUNET_SCHEDULER_Task * 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 GNUNET_memcpy (&cbuf[off], reply->msg, msize);
321 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
322 "Transmitting %u bytes to client %p\n",
323 (unsigned int) msize,
324 client->client_handle);
327 process_pending_messages (client);
328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
329 "Transmitted %u/%u bytes to client %p\n",
332 client->client_handle);
338 * Task run to check for messages that need to be sent to a client.
340 * @param client a ClientList, containing the client and any messages to be sent to it
343 process_pending_messages (struct ClientList *client)
345 if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
347 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
348 "Not asking for transmission to %p now: %s\n",
349 client->client_handle,
350 client->pending_head ==
351 NULL ? "no more messages" : "request already pending");
354 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
355 "Asking for transmission of %u bytes to client %p\n",
356 ntohs (client->pending_head->msg->size), client->client_handle);
357 client->transmit_handle =
358 GNUNET_SERVER_notify_transmit_ready (client->client_handle,
359 ntohs (client->pending_head->
361 GNUNET_TIME_UNIT_FOREVER_REL,
362 &send_reply_to_client, client);
367 * Add a PendingMessage to the clients list of messages to be sent
369 * @param client the active client to send the message to
370 * @param pending_message the actual message to send
373 add_pending_message (struct ClientList *client,
374 struct PendingMessage *pending_message)
376 GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
378 process_pending_messages (client);
383 * Closure for #forward_reply()
385 struct ForwardReplyContext
389 * Actual message to send to matching clients.
391 struct PendingMessage *pm;
401 enum GNUNET_BLOCK_Type type;
404 * Number of bytes in data.
409 * Do we need to copy @e pm because it was already used?
417 * Find a client if it exists, add it otherwise.
419 * @param client the server handle to the client
421 * @return the client if found, a new client otherwise
423 static struct ClientList *
424 find_active_client (struct GNUNET_SERVER_Client *client)
426 struct ClientList *pos = client_head;
427 struct ClientList *ret;
431 if (pos->client_handle == client)
435 ret = GNUNET_new (struct ClientList);
436 ret->client_handle = client;
437 GNUNET_CONTAINER_DLL_insert (client_head, client_tail, ret);
443 * Iterator over hash map entries that frees all entries
444 * associated with the given client.
446 * @param cls client to search for in source routes
447 * @param key current key code (ignored)
448 * @param value value in the hash map, a ClientQueryRecord
449 * @return #GNUNET_YES (we should continue to iterate)
452 remove_client_records (void *cls, const struct GNUNET_HashCode * key, void *value)
454 struct ClientList *client = cls;
455 struct ClientQueryRecord *record = value;
457 if (record->client != client)
459 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
460 "Removing client %p's record for key %s\n", client,
462 GNUNET_assert (GNUNET_YES ==
463 GNUNET_CONTAINER_multihashmap_remove (forward_map, key,
465 if (NULL != record->hnode)
466 GNUNET_CONTAINER_heap_remove_node (record->hnode);
467 GNUNET_array_grow (record->seen_replies, record->seen_replies_count, 0);
468 GNUNET_free (record);
474 * Iterator over hash map entries that send a given reply to
475 * each of the matching clients. With some tricky recycling
478 * @param cls the `struct ForwardReplyContext`
479 * @param key current key
480 * @param value value in the hash map, a ClientQueryRecord
481 * @return #GNUNET_YES (we should continue to iterate),
482 * if the result is mal-formed, #GNUNET_NO
485 forward_reply (void *cls,
486 const struct GNUNET_HashCode *key,
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,
531 GNUNET_BLOCK_EO_NONE,
537 LOG (GNUNET_ERROR_TYPE_DEBUG,
538 "Evaluation result is %d for key %s for local client's query\n",
539 (int) eval, GNUNET_h2s (key));
542 case GNUNET_BLOCK_EVALUATION_OK_LAST:
543 do_free = GNUNET_YES;
545 case GNUNET_BLOCK_EVALUATION_OK_MORE:
546 GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
549 case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
550 /* should be impossible to encounter here */
553 case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
556 case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
559 case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
562 case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
564 case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
565 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
566 _("Unsupported block type (%u) in request!\n"), record->type);
572 if (GNUNET_NO == frc->do_copy)
574 /* first time, we can use the original data */
576 frc->do_copy = GNUNET_YES;
580 /* two clients waiting for same reply, must copy for queueing */
581 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
582 ntohs (frc->pm->msg->size));
583 GNUNET_memcpy (pm, frc->pm,
584 sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
585 pm->next = pm->prev = NULL;
586 pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
588 GNUNET_STATISTICS_update (GDS_stats,
589 gettext_noop ("# RESULTS queued for clients"), 1,
591 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
592 reply->unique_id = record->unique_id;
593 LOG (GNUNET_ERROR_TYPE_DEBUG,
594 "Queueing reply to query %s for client %p\n",
596 record->client->client_handle);
597 add_pending_message (record->client, pm);
598 if (GNUNET_YES == do_free)
599 remove_client_records (record->client, key, record);
605 * Handle a reply we've received from another peer. If the reply
606 * matches any of our pending queries, forward it to the respective
609 * @param expiration when will the reply expire
610 * @param key the query this reply is for
611 * @param get_path_length number of peers in @a get_path
612 * @param get_path path the reply took on get
613 * @param put_path_length number of peers in @a put_path
614 * @param put_path path the reply took on put
615 * @param type type of the reply
616 * @param data_size number of bytes in @a data
617 * @param data application payload data
620 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
621 const struct GNUNET_HashCode *key,
622 unsigned int get_path_length,
623 const struct GNUNET_PeerIdentity *get_path,
624 unsigned int put_path_length,
625 const struct GNUNET_PeerIdentity *put_path,
626 enum GNUNET_BLOCK_Type type, size_t data_size,
629 struct ForwardReplyContext frc;
630 struct PendingMessage *pm;
631 struct GNUNET_DHT_ClientResultMessage *reply;
632 struct GNUNET_PeerIdentity *paths;
635 LOG (GNUNET_ERROR_TYPE_DEBUG,
636 "reply for key %s\n",
639 if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
641 GNUNET_STATISTICS_update (GDS_stats,
643 ("# REPLIES ignored for CLIENTS (no match)"), 1,
645 return; /* no matching request, fast exit! */
648 sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
649 (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
650 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
652 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
653 _("Could not pass reply to client, message too big!\n"));
656 DEBUG ("reply FOR DATA_SIZE = %u\n",
657 (unsigned int) msize);
658 pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
659 reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
660 pm->msg = &reply->header;
661 reply->header.size = htons ((uint16_t) msize);
662 reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
663 reply->type = htonl (type);
664 reply->get_path_length = htonl (get_path_length);
665 reply->put_path_length = htonl (put_path_length);
666 reply->unique_id = 0; /* filled in later */
667 reply->expiration = GNUNET_TIME_absolute_hton (expiration);
669 paths = (struct GNUNET_PeerIdentity *) &reply[1];
670 GNUNET_memcpy (paths,
672 sizeof (struct GNUNET_PeerIdentity) * put_path_length);
673 GNUNET_memcpy (&paths[put_path_length],
675 sizeof (struct GNUNET_PeerIdentity) * get_path_length);
676 GNUNET_memcpy (&paths[get_path_length + put_path_length],
679 frc.do_copy = GNUNET_NO;
682 frc.data_size = data_size;
684 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
688 if (GNUNET_NO == frc.do_copy)
690 /* did not match any of the requests, free! */
691 GNUNET_STATISTICS_update (GDS_stats,
693 ("# REPLIES ignored for CLIENTS (no match)"), 1,
701 * Check if some client is monitoring GET messages and notify
704 * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
705 * @param type The type of data in the request.
706 * @param hop_count Hop count so far.
707 * @param path_length number of entries in path (or 0 if not recorded).
708 * @param path peers on the GET path (or NULL if not recorded).
709 * @param desired_replication_level Desired replication level.
710 * @param key Key of the requested data.
713 GDS_CLIENTS_process_get (uint32_t options,
714 enum GNUNET_BLOCK_Type type,
716 uint32_t desired_replication_level,
717 unsigned int path_length,
718 const struct GNUNET_PeerIdentity *path,
719 const struct GNUNET_HashCode *key)
721 struct ClientMonitorRecord *m;
722 struct ClientList **cl;
723 unsigned int cl_size;
727 for (m = monitor_head; NULL != m; m = m->next)
729 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
731 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
733 struct PendingMessage *pm;
734 struct GNUNET_DHT_MonitorGetMessage *mmsg;
735 struct GNUNET_PeerIdentity *msg_path;
739 /* Don't send duplicates */
740 for (i = 0; i < cl_size; i++)
741 if (cl[i] == m->client)
745 GNUNET_array_append (cl, cl_size, m->client);
747 msize = path_length * sizeof (struct GNUNET_PeerIdentity);
748 msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
749 msize += sizeof (struct PendingMessage);
750 pm = GNUNET_malloc (msize);
751 mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
752 pm->msg = &mmsg->header;
753 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
754 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
755 mmsg->options = htonl(options);
756 mmsg->type = htonl(type);
757 mmsg->hop_count = htonl(hop_count);
758 mmsg->desired_replication_level = htonl(desired_replication_level);
759 mmsg->get_path_length = htonl(path_length);
760 GNUNET_memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
761 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
763 GNUNET_memcpy (msg_path, path,
764 path_length * sizeof (struct GNUNET_PeerIdentity));
765 add_pending_message (m->client, pm);
768 GNUNET_free_non_null (cl);
773 * Check if some client is monitoring PUT messages and notify
776 * @param options options, for instance RecordRoute, DemultiplexEverywhere.
777 * @param type type of data in the request.
778 * @param hop_count hop count so far.
779 * @param path_length number of entries in @a path (or 0 if not recorded).
780 * @param path peers on the PUT path (or NULL if not recorded).
781 * @param desired_replication_level desired replication level.
782 * @param exp expiration time of the data.
783 * @param key key under which @a data is to be stored.
784 * @param data pointer to the data carried.
785 * @param size number of bytes in @a data.
788 GDS_CLIENTS_process_put (uint32_t options,
789 enum GNUNET_BLOCK_Type type,
791 uint32_t desired_replication_level,
792 unsigned int path_length,
793 const struct GNUNET_PeerIdentity *path,
794 struct GNUNET_TIME_Absolute exp,
795 const struct GNUNET_HashCode *key,
799 struct ClientMonitorRecord *m;
800 struct ClientList **cl;
801 unsigned int cl_size;
805 for (m = monitor_head; NULL != m; m = m->next)
807 if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
809 memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
811 struct PendingMessage *pm;
812 struct GNUNET_DHT_MonitorPutMessage *mmsg;
813 struct GNUNET_PeerIdentity *msg_path;
817 /* Don't send duplicates */
818 for (i = 0; i < cl_size; i++)
819 if (cl[i] == m->client)
823 GNUNET_array_append (cl, cl_size, m->client);
826 msize += path_length * sizeof (struct GNUNET_PeerIdentity);
827 msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
828 msize += sizeof (struct PendingMessage);
829 pm = GNUNET_malloc (msize);
830 mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
831 pm->msg = (struct GNUNET_MessageHeader *) mmsg;
832 mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
833 mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
834 mmsg->options = htonl(options);
835 mmsg->type = htonl(type);
836 mmsg->hop_count = htonl(hop_count);
837 mmsg->desired_replication_level = htonl(desired_replication_level);
838 mmsg->put_path_length = htonl(path_length);
839 msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
842 GNUNET_memcpy (msg_path, path,
843 path_length * sizeof (struct GNUNET_PeerIdentity));
845 mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
846 GNUNET_memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
848 GNUNET_memcpy (&msg_path[path_length], data, size);
849 add_pending_message (m->client, pm);
852 GNUNET_free_non_null (cl);
857 * Route the given request via the DHT.
860 transmit_request (struct ClientQueryRecord *cqr)
862 GNUNET_STATISTICS_update (GDS_stats,
864 ("# GET requests from clients injected"), 1,
867 LOG (GNUNET_ERROR_TYPE_DEBUG,
868 "Initiating GET for %s, replication %u, already have %u replies\n",
869 GNUNET_h2s (&cqr->key),
871 cqr->seen_replies_count);
873 GDS_NEIGHBOURS_handle_get (&cqr->key, cqr->type, cqr->msg_options,
876 /* exponential back-off for retries.
877 * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
878 cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
879 cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
884 * Task that looks at the 'retry_heap' and transmits all of the requests
885 * on the heap that are ready for transmission. Then re-schedules
886 * itself (unless the heap is empty).
891 transmit_next_request_task (void *cls)
893 struct ClientQueryRecord *cqr;
894 struct GNUNET_TIME_Relative delay;
897 while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
900 delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
901 if (delay.rel_value_us > 0)
904 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
905 cqr->retry_time.abs_value_us);
907 GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
911 transmit_request (cqr);
913 GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
914 cqr->retry_time.abs_value_us);
920 * Handler for PUT messages.
922 * @param cls closure for the service
923 * @param client the client we received this message from
924 * @param message the actual message received
927 handle_dht_local_put (void *cls,
928 struct GNUNET_SERVER_Client *client,
929 const struct GNUNET_MessageHeader *message)
931 const struct GNUNET_DHT_ClientPutMessage *put_msg;
932 struct PendingMessage *pm;
933 struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
936 size = ntohs (message->size);
937 if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
940 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
943 GNUNET_STATISTICS_update (GDS_stats,
945 ("# PUT requests received from clients"), 1,
947 put_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
948 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE DHT CLIENT-PUT %s\n",
949 GNUNET_h2s_full (&put_msg->key));
950 /* give to local clients */
951 LOG (GNUNET_ERROR_TYPE_DEBUG,
952 "Handling local PUT of %u-bytes for query %s\n",
953 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
954 GNUNET_h2s (&put_msg->key));
955 DEBUG("PUT doing put i = %s\n",GNUNET_h2s(&(put_msg->key)));
956 GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
957 &put_msg->key, 0, NULL, 0, NULL,
958 ntohl (put_msg->type),
959 size - sizeof (struct GNUNET_DHT_ClientPutMessage),
962 GDS_NEIGHBOURS_handle_put (&put_msg->key,
963 ntohl (put_msg->type), ntohl (put_msg->options),
964 ntohl (put_msg->desired_replication_level),
965 GNUNET_TIME_absolute_ntoh (put_msg->expiration),
967 size - sizeof (struct GNUNET_DHT_ClientPutMessage));
968 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
969 sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
970 conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
971 conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
972 conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
973 conf->reserved = htonl (0);
974 conf->unique_id = put_msg->unique_id;
975 pm->msg = &conf->header;
976 add_pending_message (find_active_client (client), pm);
977 GNUNET_SERVER_receive_done (client, GNUNET_OK);
982 * Handler for DHT GET messages from the client.
984 * @param cls closure for the service
985 * @param client the client we received this message from
986 * @param message the actual message received
989 handle_dht_local_get (void *cls,
990 struct GNUNET_SERVER_Client *client,
991 const struct GNUNET_MessageHeader *message)
993 const struct GNUNET_DHT_ClientGetMessage *get;
994 struct ClientQueryRecord *cqr;
999 size = ntohs (message->size);
1000 if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
1003 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1006 xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
1007 get = (const struct GNUNET_DHT_ClientGetMessage *) message;
1008 xquery = (const char *) &get[1];
1009 GNUNET_STATISTICS_update (GDS_stats,
1011 ("# GET requests received from clients"), 1,
1013 LOG (GNUNET_ERROR_TYPE_DEBUG,
1014 "Received GET request for %s from local client %p, xq: %.*s\n",
1015 GNUNET_h2s (&get->key), client, xquery_size, xquery);
1017 LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE CLIENT-GET %s\n",
1018 GNUNET_h2s_full (&get->key));
1021 cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
1022 cqr->key = get->key;
1023 cqr->client = find_active_client (client);
1024 cqr->xquery = (void *) &cqr[1];
1025 GNUNET_memcpy (&cqr[1], xquery, xquery_size);
1026 cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
1027 cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
1028 cqr->retry_time = GNUNET_TIME_absolute_get ();
1029 cqr->unique_id = get->unique_id;
1030 cqr->xquery_size = xquery_size;
1031 cqr->replication = ntohl (get->desired_replication_level);
1032 cqr->msg_options = ntohl (get->options);
1033 cqr->type = ntohl (get->type);
1035 // FIXME use cqr->key, set multihashmap create to GNUNET_YES
1036 GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
1037 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1039 struct GNUNET_PeerIdentity my_identity;
1040 my_identity = GDS_NEIGHBOURS_get_my_id();
1041 GDS_CLIENTS_process_get (ntohl (get->options),
1044 ntohl (get->desired_replication_level),
1048 /* start remote requests */
1049 if (NULL != retry_task)
1050 GNUNET_SCHEDULER_cancel (retry_task);
1051 retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
1052 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1057 * Closure for #find_by_unique_id().
1059 struct FindByUniqueIdContext
1062 * Where to store the result, if found.
1064 struct ClientQueryRecord *cqr;
1067 * Which ID are we looking for?
1074 * Function called for each existing DHT record for the given
1075 * query. Checks if it matches the UID given in the closure
1076 * and if so returns the entry as a result.
1078 * @param cls the search context
1079 * @param key query for the lookup (not used)
1080 * @param value the `struct ClientQueryRecord`
1081 * @return #GNUNET_YES to continue iteration (result not yet found)
1084 find_by_unique_id (void *cls,
1085 const struct GNUNET_HashCode *key,
1088 struct FindByUniqueIdContext *fui_ctx = cls;
1089 struct ClientQueryRecord *cqr = value;
1091 if (cqr->unique_id != fui_ctx->unique_id)
1099 * Handler for "GET result seen" messages from the client.
1101 * @param cls closure for the service
1102 * @param client the client we received this message from
1103 * @param message the actual message received
1106 handle_dht_local_get_result_seen (void *cls,
1107 struct GNUNET_SERVER_Client *client,
1108 const struct GNUNET_MessageHeader *message)
1110 const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
1112 unsigned int hash_count;
1113 unsigned int old_count;
1114 const struct GNUNET_HashCode *hc;
1115 struct FindByUniqueIdContext fui_ctx;
1116 struct ClientQueryRecord *cqr;
1118 size = ntohs (message->size);
1119 if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
1122 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1125 seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
1126 hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
1127 if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
1130 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1133 hc = (const struct GNUNET_HashCode*) &seen[1];
1134 fui_ctx.unique_id = seen->unique_id;
1136 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1140 if (NULL == (cqr = fui_ctx.cqr))
1143 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1146 /* finally, update 'seen' list */
1147 old_count = cqr->seen_replies_count;
1148 GNUNET_array_grow (cqr->seen_replies,
1149 cqr->seen_replies_count,
1150 cqr->seen_replies_count + hash_count);
1151 GNUNET_memcpy (&cqr->seen_replies[old_count],
1153 sizeof (struct GNUNET_HashCode) * hash_count);
1158 * Closure for #remove_by_unique_id().
1160 struct RemoveByUniqueIdContext
1163 * Client that issued the removal request.
1165 struct ClientList *client;
1168 * Unique ID of the request.
1175 * Iterator over hash map entries that frees all entries
1176 * that match the given client and unique ID.
1178 * @param cls unique ID and client to search for in source routes
1179 * @param key current key code
1180 * @param value value in the hash map, a ClientQueryRecord
1181 * @return #GNUNET_YES (we should continue to iterate)
1184 remove_by_unique_id (void *cls,
1185 const struct GNUNET_HashCode *key,
1188 const struct RemoveByUniqueIdContext *ctx = cls;
1189 struct ClientQueryRecord *record = value;
1191 if (record->unique_id != ctx->unique_id)
1193 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1194 "Removing client %p's record for key %s (by unique id)\n",
1195 ctx->client->client_handle, GNUNET_h2s (key));
1196 return remove_client_records (ctx->client, key, record);
1201 * Handler for any generic DHT stop messages, calls the appropriate handler
1202 * depending on message type (if processed locally)
1204 * @param cls closure for the service
1205 * @param client the client we received this message from
1206 * @param message the actual message received
1210 handle_dht_local_get_stop (void *cls,
1211 struct GNUNET_SERVER_Client *client,
1212 const struct GNUNET_MessageHeader *message)
1214 const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
1215 (const struct GNUNET_DHT_ClientGetStopMessage *) message;
1216 struct RemoveByUniqueIdContext ctx;
1218 GNUNET_STATISTICS_update (GDS_stats,
1220 ("# GET STOP requests received from clients"), 1,
1222 LOG (GNUNET_ERROR_TYPE_DEBUG,
1223 "Received GET STOP request for %s from local client %p\n",
1224 GNUNET_h2s (&dht_stop_msg->key),
1226 ctx.client = find_active_client (client);
1227 ctx.unique_id = dht_stop_msg->unique_id;
1228 GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
1229 &remove_by_unique_id, &ctx);
1230 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1235 * Handler for monitor start messages
1237 * @param cls closure for the service
1238 * @param client the client we received this message from
1239 * @param message the actual message received
1243 handle_dht_local_monitor (void *cls,
1244 struct GNUNET_SERVER_Client *client,
1245 const struct GNUNET_MessageHeader *message)
1247 struct ClientMonitorRecord *r;
1248 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1250 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1251 r = GNUNET_new (struct ClientMonitorRecord);
1253 r->client = find_active_client(client);
1254 r->type = ntohl(msg->type);
1255 r->get = ntohs(msg->get);
1256 r->get_resp = ntohs(msg->get_resp);
1257 r->put = ntohs(msg->put);
1258 if (0 == ntohs(msg->filter_key))
1262 r->key = GNUNET_new (struct GNUNET_HashCode);
1263 GNUNET_memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
1265 GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
1266 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1271 * Handler for monitor stop messages
1273 * @param cls closure for the service
1274 * @param client the client we received this message from
1275 * @param message the actual message received
1278 handle_dht_local_monitor_stop (void *cls,
1279 struct GNUNET_SERVER_Client *client,
1280 const struct GNUNET_MessageHeader *message)
1282 struct ClientMonitorRecord *r;
1283 const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1286 msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1292 keys_match = (0 == ntohs(msg->filter_key));
1295 keys_match = (0 != ntohs(msg->filter_key)
1296 && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
1298 if (find_active_client(client) == r->client
1299 && ntohl(msg->type) == r->type
1300 && r->get == msg->get
1301 && r->get_resp == msg->get_resp
1302 && r->put == msg->put
1306 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
1307 GNUNET_free_non_null (r->key);
1309 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1310 return; /* Delete only ONE entry */
1314 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1319 * Functions with this signature are called whenever a client
1320 * is disconnected on the network level.
1322 * @param cls closure (NULL for dht)
1323 * @param client identification of the client; NULL
1324 * for the last call when the server is destroyed
1327 handle_client_disconnect (void *cls,
1328 struct GNUNET_SERVER_Client *client)
1330 struct ClientList *pos;
1331 struct PendingMessage *reply;
1332 struct ClientMonitorRecord *monitor;
1334 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1335 "Local client %p disconnects\n",
1337 pos = find_active_client (client);
1338 GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
1339 if (pos->transmit_handle != NULL)
1340 GNUNET_SERVER_notify_transmit_ready_cancel (pos->transmit_handle);
1341 while (NULL != (reply = pos->pending_head))
1343 GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
1344 GNUNET_free (reply);
1346 monitor = monitor_head;
1347 while (NULL != monitor)
1349 if (monitor->client == pos)
1351 struct ClientMonitorRecord *next;
1353 GNUNET_free_non_null (monitor->key);
1354 next = monitor->next;
1355 GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
1356 GNUNET_free (monitor);
1360 monitor = monitor->next;
1362 GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
1369 * Initialize client subsystem.
1371 * @param server the initialized server
1374 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1376 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1377 {&handle_dht_local_put, NULL,
1378 GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1379 {&handle_dht_local_get, NULL,
1380 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1381 {&handle_dht_local_get_stop, NULL,
1382 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1383 sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1384 {&handle_dht_local_monitor, NULL,
1385 GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1386 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1387 {&handle_dht_local_monitor_stop, NULL,
1388 GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1389 sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1390 {&handle_dht_local_get_result_seen, NULL,
1391 GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1394 forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1395 retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1396 GNUNET_SERVER_add_handlers (server, plugin_handlers);
1397 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1402 * Shutdown client subsystem.
1407 GNUNET_assert (client_head == NULL);
1408 GNUNET_assert (client_tail == NULL);
1409 if (NULL != retry_task)
1411 GNUNET_SCHEDULER_cancel (retry_task);
1414 if (NULL != retry_heap)
1416 GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1417 GNUNET_CONTAINER_heap_destroy (retry_heap);
1420 if (NULL != forward_map)
1422 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1423 GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1428 /* end of gnunet-service-wdht_clients.c */