-allow caller ID to differ from zone used for resolution
[oweals/gnunet.git] / src / dht / gnunet-service-xdht_clients.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
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
26  */
27
28 #include "platform.h"
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"
36 #include "dht.h"
37
38
39 /**
40  * Should routing details be logged to stderr (for debugging)?
41  */
42 #define LOG_TRAFFIC(kind,...) GNUNET_log_from (kind, "dht-traffic",__VA_ARGS__)
43
44 #define LOG(kind,...) GNUNET_log_from (kind, "dht-clients",__VA_ARGS__)
45
46 /**
47  * Linked list of messages to send to clients.
48  */
49 struct PendingMessage
50 {
51   /**
52    * Pointer to next item in the list
53    */
54   struct PendingMessage *next;
55
56   /**
57    * Pointer to previous item in the list
58    */
59   struct PendingMessage *prev;
60
61   /**
62    * Actual message to be sent, allocated at the end of the struct:
63    * // msg = (cast) &pm[1];
64    * // memcpy (&pm[1], data, len);
65    */
66   const struct GNUNET_MessageHeader *msg;
67
68 };
69
70
71 /**
72  * Struct containing information about a client,
73  * handle to connect to it, and any pending messages
74  * that need to be sent to it.
75  */
76 struct ClientList
77 {
78   /**
79    * Linked list of active clients
80    */
81   struct ClientList *next;
82
83   /**
84    * Linked list of active clients
85    */
86   struct ClientList *prev;
87
88   /**
89    * The handle to this client
90    */
91   struct GNUNET_SERVER_Client *client_handle;
92
93   /**
94    * Handle to the current transmission request, NULL
95    * if none pending.
96    */
97   struct GNUNET_SERVER_TransmitHandle *transmit_handle;
98
99   /**
100    * Linked list of pending messages for this client
101    */
102   struct PendingMessage *pending_head;
103
104   /**
105    * Tail of linked list of pending messages for this client
106    */
107   struct PendingMessage *pending_tail;
108
109 };
110
111
112 /**
113  * Entry in the local forwarding map for a client's GET request.
114  */
115 struct ClientQueryRecord
116 {
117
118   /**
119    * The key this request was about
120    */
121   struct GNUNET_HashCode key;
122
123   /**
124    * Client responsible for the request.
125    */
126   struct ClientList *client;
127
128   /**
129    * Extended query (see gnunet_block_lib.h), allocated at the end of this struct.
130    */
131   const void *xquery;
132
133   /**
134    * Replies we have already seen for this request.
135    */
136   struct GNUNET_HashCode *seen_replies;
137
138   /**
139    * Pointer to this nodes heap location in the retry-heap (for fast removal)
140    */
141   struct GNUNET_CONTAINER_HeapNode *hnode;
142
143   /**
144    * What's the delay between re-try operations that we currently use for this
145    * request?
146    */
147   struct GNUNET_TIME_Relative retry_frequency;
148
149   /**
150    * What's the next time we should re-try this request?
151    */
152   struct GNUNET_TIME_Absolute retry_time;
153
154   /**
155    * The unique identifier of this request
156    */
157   uint64_t unique_id;
158
159   /**
160    * Number of bytes in xquery.
161    */
162   size_t xquery_size;
163
164   /**
165    * Number of entries in 'seen_replies'.
166    */
167   unsigned int seen_replies_count;
168
169   /**
170    * Desired replication level
171    */
172   uint32_t replication;
173
174   /**
175    * Any message options for this request
176    */
177   uint32_t msg_options;
178
179   /**
180    * The type for the data for the GET request.
181    */
182   enum GNUNET_BLOCK_Type type;
183
184 };
185
186
187 /**
188  * Struct containing paremeters of monitoring requests.
189  */
190 struct ClientMonitorRecord
191 {
192
193   /**
194    * Next element in DLL.
195    */
196   struct ClientMonitorRecord    *next;
197
198   /**
199    * Previous element in DLL.
200    */
201   struct ClientMonitorRecord    *prev;
202
203   /**
204    * Type of blocks that are of interest
205    */
206   enum GNUNET_BLOCK_Type        type;
207
208   /**
209    * Key of data of interest, NULL for all.
210    */
211   struct GNUNET_HashCode         *key;
212
213   /**
214    * Flag whether to notify about GET messages.
215    */
216   int16_t get;
217
218   /**
219    * Flag whether to notify about GET_REPONSE messages.
220    */
221   int16_t get_resp;
222
223   /**
224    * Flag whether to notify about PUT messages.
225    */
226   uint16_t put;
227
228   /**
229    * Client to notify of these requests.
230    */
231   struct ClientList             *client;
232 };
233
234
235 /**
236  * List of active clients.
237  */
238 static struct ClientList *client_head;
239
240 /**
241  * List of active clients.
242  */
243 static struct ClientList *client_tail;
244
245 /**
246  * List of active monitoring requests.
247  */
248 static struct ClientMonitorRecord *monitor_head;
249
250 /**
251  * List of active monitoring requests.
252  */
253 static struct ClientMonitorRecord *monitor_tail;
254
255 /**
256  * Hashmap for fast key based lookup, maps keys to `struct ClientQueryRecord` entries.
257  */
258 static struct GNUNET_CONTAINER_MultiHashMap *forward_map;
259
260 /**
261  * Heap with all of our client's request, sorted by retry time (earliest on top).
262  */
263 static struct GNUNET_CONTAINER_Heap *retry_heap;
264
265 /**
266  * Task that re-transmits requests (using retry_heap).
267  */
268 static GNUNET_SCHEDULER_TaskIdentifier retry_task;
269
270
271 /**
272  * Task run to check for messages that need to be sent to a client.
273  *
274  * @param client a ClientList, containing the client and any messages to be sent to it
275  */
276 static void
277 process_pending_messages (struct ClientList *client);
278
279
280 /**
281  * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
282  * request.  A ClientList is passed as closure, take the head of the list
283  * and copy it into buf, which has the result of sending the message to the
284  * client.
285  *
286  * @param cls closure to this call
287  * @param size maximum number of bytes available to send
288  * @param buf where to copy the actual message to
289  *
290  * @return the number of bytes actually copied, 0 indicates failure
291  */
292 static size_t
293 send_reply_to_client (void *cls, size_t size, void *buf)
294 {
295   struct ClientList *client = cls;
296   char *cbuf = buf;
297   struct PendingMessage *reply;
298   size_t off;
299   size_t msize;
300
301   client->transmit_handle = NULL;
302   if (buf == NULL)
303   {
304     /* client disconnected */
305     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
306                 "Client %p disconnected, pending messages will be discarded\n",
307                 client->client_handle);
308     return 0;
309   }
310   off = 0;
311   while ((NULL != (reply = client->pending_head)) &&
312          (size >= off + (msize = ntohs (reply->msg->size))))
313   {
314     GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
315                                  reply);
316     memcpy (&cbuf[off], reply->msg, msize);
317     GNUNET_free (reply);
318     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes to client %p\n",
319                 msize, client->client_handle);
320     off += msize;
321   }
322   process_pending_messages (client);
323   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitted %u/%u bytes to client %p\n",
324               (unsigned int) off, (unsigned int) size, client->client_handle);
325   return off;
326 }
327
328
329 /**
330  * Task run to check for messages that need to be sent to a client.
331  *
332  * @param client a ClientList, containing the client and any messages to be sent to it
333  */
334 static void
335 process_pending_messages (struct ClientList *client)
336 {
337   if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
338   {
339     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
340                 "Not asking for transmission to %p now: %s\n",
341                 client->client_handle,
342                 client->pending_head ==
343                 NULL ? "no more messages" : "request already pending");
344     return;
345   }
346   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
347               "Asking for transmission of %u bytes to client %p\n",
348               ntohs (client->pending_head->msg->size), client->client_handle);
349   client->transmit_handle =
350       GNUNET_SERVER_notify_transmit_ready (client->client_handle,
351                                            ntohs (client->pending_head->
352                                                   msg->size),
353                                            GNUNET_TIME_UNIT_FOREVER_REL,
354                                            &send_reply_to_client, client);
355 }
356
357
358 /**
359  * Add a PendingMessage to the clients list of messages to be sent
360  *
361  * @param client the active client to send the message to
362  * @param pending_message the actual message to send
363  */
364 static void
365 add_pending_message (struct ClientList *client,
366                      struct PendingMessage *pending_message)
367 {
368   GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
369                                     pending_message);
370   process_pending_messages (client);
371 }
372
373
374 /**
375  * Closure for 'forward_reply'
376  */
377 struct ForwardReplyContext
378 {
379
380   /**
381    * Actual message to send to matching clients.
382    */
383   struct PendingMessage *pm;
384
385   /**
386    * Embedded payload.
387    */
388   const void *data;
389
390   /**
391    * Type of the data.
392    */
393   enum GNUNET_BLOCK_Type type;
394
395   /**
396    * Number of bytes in data.
397    */
398   size_t data_size;
399
400   /**
401    * Do we need to copy 'pm' because it was already used?
402    */
403   int do_copy;
404
405 };
406
407
408 /**
409  * Find a client if it exists, add it otherwise.
410  *
411  * @param client the server handle to the client
412  *
413  * @return the client if found, a new client otherwise
414  */
415 static struct ClientList *
416 find_active_client (struct GNUNET_SERVER_Client *client)
417 {
418   struct ClientList *pos = client_head;
419   struct ClientList *ret;
420
421   while (pos != NULL)
422   {
423     if (pos->client_handle == client)
424       return pos;
425     pos = pos->next;
426   }
427   ret = GNUNET_new (struct ClientList);
428   ret->client_handle = client;
429   GNUNET_CONTAINER_DLL_insert (client_head, client_tail, ret);
430   return ret;
431 }
432
433
434 /**
435  * Iterator over hash map entries that frees all entries
436  * associated with the given client.
437  *
438  * @param cls client to search for in source routes
439  * @param key current key code (ignored)
440  * @param value value in the hash map, a ClientQueryRecord
441  * @return #GNUNET_YES (we should continue to iterate)
442  */
443 static int
444 remove_client_records (void *cls, const struct GNUNET_HashCode * key, void *value)
445 {
446   struct ClientList *client = cls;
447   struct ClientQueryRecord *record = value;
448
449   if (record->client != client)
450     return GNUNET_YES;
451   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
452               "Removing client %p's record for key %s\n", client,
453               GNUNET_h2s (key));
454   GNUNET_assert (GNUNET_YES ==
455                  GNUNET_CONTAINER_multihashmap_remove (forward_map, key,
456                                                        record));
457   if (NULL != record->hnode)
458     GNUNET_CONTAINER_heap_remove_node (record->hnode);
459   GNUNET_array_grow (record->seen_replies, record->seen_replies_count, 0);
460   GNUNET_free (record);
461   return GNUNET_YES;
462 }
463
464
465 /**
466  * Iterator over hash map entries that send a given reply to
467  * each of the matching clients.  With some tricky recycling
468  * of the buffer.
469  *
470  * @param cls the 'struct ForwardReplyContext'
471  * @param key current key
472  * @param value value in the hash map, a ClientQueryRecord
473  * @return GNUNET_YES (we should continue to iterate),
474  *         if the result is mal-formed, GNUNET_NO
475  */
476 static int
477 forward_reply (void *cls, const struct GNUNET_HashCode * key, void *value)
478 {
479   struct ForwardReplyContext *frc = cls;
480   struct ClientQueryRecord *record = value;
481   struct PendingMessage *pm;
482   struct GNUNET_DHT_ClientResultMessage *reply;
483   enum GNUNET_BLOCK_EvaluationResult eval;
484   int do_free;
485   struct GNUNET_HashCode ch;
486   unsigned int i;
487
488   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
489                "R5N CLIENT-RESULT %s\n",
490                GNUNET_h2s_full (key));
491   if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
492   {
493     LOG (GNUNET_ERROR_TYPE_DEBUG,
494          "Record type missmatch, not passing request for key %s to local client\n",
495          GNUNET_h2s (key));
496     GNUNET_STATISTICS_update (GDS_stats,
497                               gettext_noop
498                               ("# Key match, type mismatches in REPLY to CLIENT"),
499                               1, GNUNET_NO);
500     return GNUNET_YES;          /* type mismatch */
501   }
502   GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
503   for (i = 0; i < record->seen_replies_count; i++)
504     if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
505     {
506       LOG (GNUNET_ERROR_TYPE_DEBUG,
507            "Duplicate reply, not passing request for key %s to local client\n",
508            GNUNET_h2s (key));
509       GNUNET_STATISTICS_update (GDS_stats,
510                                 gettext_noop
511                                 ("# Duplicate REPLIES to CLIENT request dropped"),
512                                 1, GNUNET_NO);
513       return GNUNET_YES;        /* duplicate */
514     }
515   eval =
516       GNUNET_BLOCK_evaluate (GDS_block_context, record->type, key, NULL, 0,
517                              record->xquery, record->xquery_size, frc->data,
518                              frc->data_size);
519   LOG (GNUNET_ERROR_TYPE_DEBUG,
520        "Evaluation result is %d for key %s for local client's query\n",
521        (int) eval, GNUNET_h2s (key));
522   switch (eval)
523   {
524   case GNUNET_BLOCK_EVALUATION_OK_LAST:
525     do_free = GNUNET_YES;
526     break;
527   case GNUNET_BLOCK_EVALUATION_OK_MORE:
528     GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
529     do_free = GNUNET_NO;
530     break;
531   case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
532     /* should be impossible to encounter here */
533     GNUNET_break (0);
534     return GNUNET_YES;
535   case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
536     GNUNET_break_op (0);
537     return GNUNET_NO;
538   case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
539     GNUNET_break (0);
540     return GNUNET_NO;
541   case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
542     GNUNET_break (0);
543     return GNUNET_NO;
544   case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
545     return GNUNET_YES;
546   case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
547     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
548                 _("Unsupported block type (%u) in request!\n"), record->type);
549     return GNUNET_NO;
550   default:
551     GNUNET_break (0);
552     return GNUNET_NO;
553   }
554   if (GNUNET_NO == frc->do_copy)
555   {
556     /* first time, we can use the original data */
557     pm = frc->pm;
558     frc->do_copy = GNUNET_YES;
559   }
560   else
561   {
562     /* two clients waiting for same reply, must copy for queueing */
563     pm = GNUNET_malloc (sizeof (struct PendingMessage) +
564                         ntohs (frc->pm->msg->size));
565     memcpy (pm, frc->pm,
566             sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
567     pm->next = pm->prev = NULL;
568     pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
569   }
570   GNUNET_STATISTICS_update (GDS_stats,
571                             gettext_noop ("# RESULTS queued for clients"), 1,
572                             GNUNET_NO);
573   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
574   reply->unique_id = record->unique_id;
575   LOG (GNUNET_ERROR_TYPE_DEBUG,
576        "Queueing reply to query %s for client %p\n",
577        GNUNET_h2s (key),
578        record->client->client_handle);
579   add_pending_message (record->client, pm);
580   if (GNUNET_YES == do_free)
581     remove_client_records (record->client, key, record);
582   return GNUNET_YES;
583 }
584
585
586 /**
587  * Handle a reply we've received from another peer.  If the reply
588  * matches any of our pending queries, forward it to the respective
589  * client(s).
590  *
591  * @param expiration when will the reply expire
592  * @param key the query this reply is for
593  * @param get_path_length number of peers in @a get_path
594  * @param get_path path the reply took on get
595  * @param put_path_length number of peers in @a put_path
596  * @param put_path path the reply took on put
597  * @param type type of the reply
598  * @param data_size number of bytes in @a data
599  * @param data application payload data
600  */
601 void
602 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
603                           const struct GNUNET_HashCode *key,
604                           unsigned int get_path_length,
605                           const struct GNUNET_PeerIdentity *get_path,
606                           unsigned int put_path_length,
607                           const struct GNUNET_PeerIdentity *put_path,
608                           enum GNUNET_BLOCK_Type type, size_t data_size,
609                           const void *data)
610 {
611   struct ForwardReplyContext frc;
612   struct PendingMessage *pm;
613   struct GNUNET_DHT_ClientResultMessage *reply;
614   struct GNUNET_PeerIdentity *paths;
615   size_t msize;
616
617   LOG (GNUNET_ERROR_TYPE_DEBUG,
618        "reply for key %s\n",
619        GNUNET_h2s (key));
620
621   if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
622   {
623     GNUNET_STATISTICS_update (GDS_stats,
624                               gettext_noop
625                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
626                               GNUNET_NO);
627     return;                     /* no matching request, fast exit! */
628   }
629   msize =
630       sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
631       (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
632   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
633   {
634     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
635                 _("Could not pass reply to client, message too big!\n"));
636     return;
637   }
638   pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
639   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
640   pm->msg = &reply->header;
641   reply->header.size = htons ((uint16_t) msize);
642   reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
643   reply->type = htonl (type);
644   reply->get_path_length = htonl (get_path_length);
645   reply->put_path_length = htonl (put_path_length);
646   reply->unique_id = 0;         /* filled in later */
647   reply->expiration = GNUNET_TIME_absolute_hton (expiration);
648   reply->key = *key;
649   paths = (struct GNUNET_PeerIdentity *) &reply[1];
650   memcpy (paths, put_path,
651           sizeof (struct GNUNET_PeerIdentity) * put_path_length);
652   memcpy (&paths[put_path_length], get_path,
653           sizeof (struct GNUNET_PeerIdentity) * get_path_length);
654   memcpy (&paths[get_path_length + put_path_length], data, data_size);
655   frc.do_copy = GNUNET_NO;
656   frc.pm = pm;
657   frc.data = data;
658   frc.data_size = data_size;
659   frc.type = type;
660   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
661                                               &frc);
662
663   if (GNUNET_NO == frc.do_copy)
664   {
665     /* did not match any of the requests, free! */
666     GNUNET_STATISTICS_update (GDS_stats,
667                               gettext_noop
668                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
669                               GNUNET_NO);
670     GNUNET_free (pm);
671   }
672 }
673
674 /**
675  * Check if some client is monitoring GET messages and notify
676  * them in that case.
677  *
678  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
679  * @param type The type of data in the request.
680  * @param hop_count Hop count so far.
681  * @param path_length number of entries in path (or 0 if not recorded).
682  * @param path peers on the GET path (or NULL if not recorded).
683  * @param desired_replication_level Desired replication level.
684  * @param key Key of the requested data.
685  */
686 void
687 GDS_CLIENTS_process_get (uint32_t options,
688                          enum GNUNET_BLOCK_Type type,
689                          uint32_t hop_count,
690                          uint32_t desired_replication_level,
691                          unsigned int path_length,
692                          const struct GNUNET_PeerIdentity *path,
693                          const struct GNUNET_HashCode * key)
694 {
695   struct ClientMonitorRecord *m;
696   struct ClientList **cl;
697   unsigned int cl_size;
698
699   cl = NULL;
700   cl_size = 0;
701   for (m = monitor_head; NULL != m; m = m->next)
702   {
703     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
704         (NULL == m->key ||
705          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
706     {
707       struct PendingMessage *pm;
708       struct GNUNET_DHT_MonitorGetMessage *mmsg;
709       struct GNUNET_PeerIdentity *msg_path;
710       size_t msize;
711       unsigned int i;
712
713       /* Don't send duplicates */
714       for (i = 0; i < cl_size; i++)
715         if (cl[i] == m->client)
716           break;
717       if (i < cl_size)
718         continue;
719       GNUNET_array_append (cl, cl_size, m->client);
720
721       msize = path_length * sizeof (struct GNUNET_PeerIdentity);
722       msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
723       msize += sizeof (struct PendingMessage);
724       pm = GNUNET_malloc (msize);
725       mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
726       pm->msg = &mmsg->header;
727       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
728       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
729       mmsg->options = htonl(options);
730       mmsg->type = htonl(type);
731       mmsg->hop_count = htonl(hop_count);
732       mmsg->desired_replication_level = htonl(desired_replication_level);
733       mmsg->get_path_length = htonl(path_length);
734       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
735       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
736       if (path_length > 0)
737         memcpy (msg_path, path,
738                 path_length * sizeof (struct GNUNET_PeerIdentity));
739       add_pending_message (m->client, pm);
740     }
741   }
742   GNUNET_free_non_null (cl);
743 }
744
745
746 /**
747  * Check if some client is monitoring PUT messages and notify
748  * them in that case.
749  *
750  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
751  * @param type The type of data in the request.
752  * @param hop_count Hop count so far.
753  * @param path_length number of entries in path (or 0 if not recorded).
754  * @param path peers on the PUT path (or NULL if not recorded).
755  * @param desired_replication_level Desired replication level.
756  * @param exp Expiration time of the data.
757  * @param key Key under which data is to be stored.
758  * @param data Pointer to the data carried.
759  * @param size Number of bytes in data.
760  */
761 void
762 GDS_CLIENTS_process_put (uint32_t options,
763                          enum GNUNET_BLOCK_Type type,
764                          uint32_t hop_count,
765                          uint32_t desired_replication_level,
766                          unsigned int path_length,
767                          const struct GNUNET_PeerIdentity *path,
768                          struct GNUNET_TIME_Absolute exp,
769                          const struct GNUNET_HashCode * key,
770                          const void *data,
771                          size_t size)
772 {
773   struct ClientMonitorRecord *m;
774   struct ClientList **cl;
775   unsigned int cl_size;
776
777   cl = NULL;
778   cl_size = 0;
779   for (m = monitor_head; NULL != m; m = m->next)
780   {
781     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
782         (NULL == m->key ||
783          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
784     {
785       struct PendingMessage *pm;
786       struct GNUNET_DHT_MonitorPutMessage *mmsg;
787       struct GNUNET_PeerIdentity *msg_path;
788       size_t msize;
789       unsigned int i;
790
791       /* Don't send duplicates */
792       for (i = 0; i < cl_size; i++)
793         if (cl[i] == m->client)
794           break;
795       if (i < cl_size)
796         continue;
797       GNUNET_array_append (cl, cl_size, m->client);
798
799       msize = size;
800       msize += path_length * sizeof (struct GNUNET_PeerIdentity);
801       msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
802       msize += sizeof (struct PendingMessage);
803       pm = GNUNET_malloc (msize);
804       mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
805       pm->msg = (struct GNUNET_MessageHeader *) mmsg;
806       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
807       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
808       mmsg->options = htonl(options);
809       mmsg->type = htonl(type);
810       mmsg->hop_count = htonl(hop_count);
811       mmsg->desired_replication_level = htonl(desired_replication_level);
812       mmsg->put_path_length = htonl(path_length);
813       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
814       if (path_length > 0)
815       {
816         memcpy (msg_path, path,
817                 path_length * sizeof (struct GNUNET_PeerIdentity));
818       }
819       mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
820       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
821       if (size > 0)
822         memcpy (&msg_path[path_length], data, size);
823       add_pending_message (m->client, pm);
824     }
825   }
826   GNUNET_free_non_null (cl);
827 }
828
829
830 /**
831  * Route the given request via the DHT.  
832  */
833 static void
834 transmit_request (struct ClientQueryRecord *cqr)
835 {
836   GNUNET_STATISTICS_update (GDS_stats,
837                             gettext_noop
838                             ("# GET requests from clients injected"), 1,
839                             GNUNET_NO);
840   
841   LOG (GNUNET_ERROR_TYPE_DEBUG,
842        "Initiating GET for %s, replication %u, already have %u replies\n",
843        GNUNET_h2s (&cqr->key),
844        cqr->replication,
845        cqr->seen_replies_count);
846
847   GDS_NEIGHBOURS_send_get (&cqr->key, cqr->type, cqr->msg_options, 
848                            cqr->replication, NULL, NULL , NULL,
849                            0, 0, NULL);
850   
851   /* exponential back-off for retries.
852    * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
853   cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
854   cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
855 }
856
857
858 /**
859  * Task that looks at the 'retry_heap' and transmits all of the requests
860  * on the heap that are ready for transmission.  Then re-schedules
861  * itself (unless the heap is empty).
862  *
863  * @param cls unused
864  * @param tc scheduler context
865  */
866 static void
867 transmit_next_request_task (void *cls,
868                             const struct GNUNET_SCHEDULER_TaskContext *tc)
869 {
870   struct ClientQueryRecord *cqr;
871   struct GNUNET_TIME_Relative delay;
872
873   retry_task = GNUNET_SCHEDULER_NO_TASK;
874   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
875     return;
876   while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
877   {
878     cqr->hnode = NULL;
879     delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
880     if (delay.rel_value_us > 0)
881     {
882       cqr->hnode =
883           GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
884                                         cqr->retry_time.abs_value_us);
885       retry_task =
886           GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
887                                         NULL);
888       return;
889     }
890     transmit_request (cqr);
891     cqr->hnode =
892         GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
893                                       cqr->retry_time.abs_value_us);
894   }
895 }
896
897
898 /**
899  * Handler for PUT messages.
900  *
901  * @param cls closure for the service
902  * @param client the client we received this message from
903  * @param message the actual message received
904  */
905 static void
906 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
907                       const struct GNUNET_MessageHeader *message)
908 {
909   const struct GNUNET_DHT_ClientPutMessage *put_msg;
910   struct PendingMessage *pm;
911   struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
912   uint16_t size;
913
914   size = ntohs (message->size);
915   if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
916   {
917     GNUNET_break (0);
918     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
919     return;
920   }
921   GNUNET_STATISTICS_update (GDS_stats,
922                             gettext_noop
923                             ("# PUT requests received from clients"), 1,
924                             GNUNET_NO);
925   put_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
926   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE DHT CLIENT-PUT %s\n",
927                GNUNET_h2s_full (&put_msg->key));
928   /* give to local clients */
929   LOG (GNUNET_ERROR_TYPE_DEBUG,
930        "Handling local PUT of %u-bytes for query %s\n",
931        size - sizeof (struct GNUNET_DHT_ClientPutMessage),
932        GNUNET_h2s (&put_msg->key));
933   
934   GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
935                             &put_msg->key, 0, NULL, 0, NULL,
936                             ntohl (put_msg->type),
937                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
938                             &put_msg[1]);
939   /* FIXME: Should we store locally? */
940   GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
941                             &put_msg->key, 0, NULL, ntohl (put_msg->type),
942                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
943                             &put_msg[1]);
944  
945   struct GNUNET_PeerIdentity my_identity =  GDS_NEIGHBOURS_get_my_id();
946   GDS_NEIGHBOURS_send_put (&put_msg->key, 
947                            ntohl (put_msg->type), ntohl (put_msg->options),
948                            ntohl (put_msg->desired_replication_level), NULL,
949                            NULL, NULL, 0, 0, NULL,
950                            GNUNET_TIME_absolute_ntoh (put_msg->expiration),
951                            &put_msg[1],
952                            size - sizeof (struct GNUNET_DHT_ClientPutMessage));
953   
954
955   GDS_CLIENTS_process_put (ntohl (put_msg->options),
956                            ntohl (put_msg->type),
957                            0,
958                            ntohl (put_msg->desired_replication_level),
959                            1,
960                            &my_identity,
961                            GNUNET_TIME_absolute_ntoh (put_msg->expiration),
962                            &put_msg->key,
963                            &put_msg[1],
964                            size - sizeof (struct GNUNET_DHT_ClientPutMessage));
965   
966   pm = GNUNET_malloc (sizeof (struct PendingMessage) +
967                       sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
968   conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
969   conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
970   conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
971   conf->reserved = htonl (0);
972   conf->unique_id = put_msg->unique_id;
973   pm->msg = &conf->header;
974   add_pending_message (find_active_client (client), pm);
975   GNUNET_SERVER_receive_done (client, GNUNET_OK);
976 }
977
978
979 /**
980  * Handler for DHT GET messages from the client.
981  *
982  * @param cls closure for the service
983  * @param client the client we received this message from
984  * @param message the actual message received
985  */
986 static void
987 handle_dht_local_get (void *cls, struct GNUNET_SERVER_Client *client,
988                       const struct GNUNET_MessageHeader *message)
989 {
990   const struct GNUNET_DHT_ClientGetMessage *get;
991   struct ClientQueryRecord *cqr;
992   size_t xquery_size;
993   const char *xquery;
994   uint16_t size;
995
996   size = ntohs (message->size);
997   if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
998   {
999     GNUNET_break (0);
1000     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1001     return;
1002   }
1003   xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
1004   get = (const struct GNUNET_DHT_ClientGetMessage *) message;
1005   xquery = (const char *) &get[1];
1006   GNUNET_STATISTICS_update (GDS_stats,
1007                             gettext_noop
1008                             ("# GET requests received from clients"), 1,
1009                             GNUNET_NO);
1010   LOG (GNUNET_ERROR_TYPE_DEBUG,
1011        "Received GET request for %s from local client %p, xq: %.*s\n",
1012        GNUNET_h2s (&get->key), client, xquery_size, xquery);
1013
1014   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE CLIENT-GET %s\n",
1015                GNUNET_h2s_full (&get->key));
1016
1017
1018   cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
1019   cqr->key = get->key;
1020   cqr->client = find_active_client (client);
1021   cqr->xquery = (void *) &cqr[1];
1022   memcpy (&cqr[1], xquery, xquery_size);
1023   cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
1024   cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
1025   cqr->retry_time = GNUNET_TIME_absolute_get ();
1026   cqr->unique_id = get->unique_id;
1027   cqr->xquery_size = xquery_size;
1028   cqr->replication = ntohl (get->desired_replication_level);
1029   cqr->msg_options = ntohl (get->options);
1030   cqr->type = ntohl (get->type);
1031   // FIXME use cqr->key, set multihashmap create to GNUNET_YES
1032   GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
1033                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1034   
1035   struct GNUNET_PeerIdentity my_identity;
1036   my_identity = GDS_NEIGHBOURS_get_my_id();
1037   GDS_CLIENTS_process_get (ntohl (get->options),
1038                            ntohl (get->type),
1039                            0,
1040                            ntohl (get->desired_replication_level),
1041                            1,
1042                            &my_identity,
1043                            &get->key);
1044   /* start remote requests */
1045   if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1046     GNUNET_SCHEDULER_cancel (retry_task);
1047   retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
1048   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1049 }
1050
1051
1052 /**
1053  * Closure for 'find_by_unique_id'.
1054  */
1055 struct FindByUniqueIdContext
1056 {
1057   /**
1058    * Where to store the result, if found.
1059    */
1060   struct ClientQueryRecord *cqr;
1061
1062   uint64_t unique_id;
1063 };
1064
1065
1066 /**
1067  * Function called for each existing DHT record for the given
1068  * query.  Checks if it matches the UID given in the closure
1069  * and if so returns the entry as a result.
1070  *
1071  * @param cls the search context
1072  * @param key query for the lookup (not used)
1073  * @param value the 'struct ClientQueryRecord'
1074  * @return GNUNET_YES to continue iteration (result not yet found)
1075  */
1076 static int
1077 find_by_unique_id (void *cls,
1078                    const struct GNUNET_HashCode *key,
1079                    void *value)
1080 {
1081   struct FindByUniqueIdContext *fui_ctx = cls;
1082   struct ClientQueryRecord *cqr = value;
1083
1084   if (cqr->unique_id != fui_ctx->unique_id)
1085     return GNUNET_YES;
1086   fui_ctx->cqr = cqr;
1087   return GNUNET_NO;
1088 }
1089
1090
1091 /**
1092  * Handler for "GET result seen" messages from the client.
1093  *
1094  * @param cls closure for the service
1095  * @param client the client we received this message from
1096  * @param message the actual message received
1097  */
1098 static void
1099 handle_dht_local_get_result_seen (void *cls, struct GNUNET_SERVER_Client *client,
1100                                   const struct GNUNET_MessageHeader *message)
1101 {
1102   const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
1103   uint16_t size;
1104   unsigned int hash_count;
1105   unsigned int old_count;
1106   const struct GNUNET_HashCode *hc;
1107   struct FindByUniqueIdContext fui_ctx;
1108   struct ClientQueryRecord *cqr;
1109
1110   size = ntohs (message->size);
1111   if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
1112   {
1113     GNUNET_break (0);
1114     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1115     return;
1116   }
1117   seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
1118   hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
1119   if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
1120   {
1121     GNUNET_break (0);
1122     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1123     return;
1124   }
1125   hc = (const struct GNUNET_HashCode*) &seen[1];
1126   fui_ctx.unique_id = seen->unique_id;
1127   fui_ctx.cqr = NULL;
1128   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1129                                               &seen->key,
1130                                               &find_by_unique_id,
1131                                               &fui_ctx);
1132   if (NULL == (cqr = fui_ctx.cqr))
1133   {
1134     GNUNET_break (0);
1135     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1136     return;
1137   }
1138   /* finally, update 'seen' list */
1139   old_count = cqr->seen_replies_count;
1140   GNUNET_array_grow (cqr->seen_replies,
1141                      cqr->seen_replies_count,
1142                      cqr->seen_replies_count + hash_count);
1143   memcpy (&cqr->seen_replies[old_count],
1144           hc,
1145           sizeof (struct GNUNET_HashCode) * hash_count);
1146 }
1147
1148
1149 /**
1150  * Closure for 'remove_by_unique_id'.
1151  */
1152 struct RemoveByUniqueIdContext
1153 {
1154   /**
1155    * Client that issued the removal request.
1156    */
1157   struct ClientList *client;
1158
1159   /**
1160    * Unique ID of the request.
1161    */
1162   uint64_t unique_id;
1163 };
1164
1165
1166 /**
1167  * Iterator over hash map entries that frees all entries
1168  * that match the given client and unique ID.
1169  *
1170  * @param cls unique ID and client to search for in source routes
1171  * @param key current key code
1172  * @param value value in the hash map, a ClientQueryRecord
1173  * @return GNUNET_YES (we should continue to iterate)
1174  */
1175 static int
1176 remove_by_unique_id (void *cls, const struct GNUNET_HashCode * key, void *value)
1177 {
1178   const struct RemoveByUniqueIdContext *ctx = cls;
1179   struct ClientQueryRecord *record = value;
1180
1181   if (record->unique_id != ctx->unique_id)
1182     return GNUNET_YES;
1183   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1184               "Removing client %p's record for key %s (by unique id)\n",
1185               ctx->client->client_handle, GNUNET_h2s (key));
1186   return remove_client_records (ctx->client, key, record);
1187 }
1188
1189
1190 /**
1191  * Handler for any generic DHT stop messages, calls the appropriate handler
1192  * depending on message type (if processed locally)
1193  *
1194  * @param cls closure for the service
1195  * @param client the client we received this message from
1196  * @param message the actual message received
1197  *
1198  */
1199 static void
1200 handle_dht_local_get_stop (void *cls, struct GNUNET_SERVER_Client *client,
1201                            const struct GNUNET_MessageHeader *message)
1202 {
1203   const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
1204       (const struct GNUNET_DHT_ClientGetStopMessage *) message;
1205   struct RemoveByUniqueIdContext ctx;
1206
1207   GNUNET_STATISTICS_update (GDS_stats,
1208                             gettext_noop
1209                             ("# GET STOP requests received from clients"), 1,
1210                             GNUNET_NO);
1211   LOG (GNUNET_ERROR_TYPE_DEBUG,
1212        "Received GET STOP request for %s from local client %p\n",
1213        client, GNUNET_h2s (&dht_stop_msg->key));
1214   ctx.client = find_active_client (client);
1215   ctx.unique_id = dht_stop_msg->unique_id;
1216   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
1217                                               &remove_by_unique_id, &ctx);
1218   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1219 }
1220
1221
1222 /**
1223  * Handler for monitor start messages
1224  *
1225  * @param cls closure for the service
1226  * @param client the client we received this message from
1227  * @param message the actual message received
1228  *
1229  */
1230 static void
1231 handle_dht_local_monitor (void *cls, struct GNUNET_SERVER_Client *client,
1232                           const struct GNUNET_MessageHeader *message)
1233 {
1234   struct ClientMonitorRecord *r;
1235   const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1236
1237   msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1238   r = GNUNET_new (struct ClientMonitorRecord);
1239
1240   r->client = find_active_client(client);
1241   r->type = ntohl(msg->type);
1242   r->get = ntohs(msg->get);
1243   r->get_resp = ntohs(msg->get_resp);
1244   r->put = ntohs(msg->put);
1245   if (0 == ntohs(msg->filter_key))
1246       r->key = NULL;
1247   else
1248   {
1249     r->key = GNUNET_new (struct GNUNET_HashCode);
1250     memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
1251   }
1252   GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
1253   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1254 }
1255
1256
1257 /**
1258  * Handler for monitor stop messages
1259  *
1260  * @param cls closure for the service
1261  * @param client the client we received this message from
1262  * @param message the actual message received
1263  *
1264  */
1265 static void
1266 handle_dht_local_monitor_stop (void *cls, struct GNUNET_SERVER_Client *client,
1267                                const struct GNUNET_MessageHeader *message)
1268 {
1269   struct ClientMonitorRecord *r;
1270   const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1271   int keys_match;
1272
1273   msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1274   r = monitor_head;
1275
1276   while (NULL != r)
1277   {
1278     if (NULL == r->key)
1279         keys_match = (0 == ntohs(msg->filter_key));
1280     else
1281     {
1282         keys_match = (0 != ntohs(msg->filter_key)
1283                       && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
1284     }
1285     if (find_active_client(client) == r->client
1286         && ntohl(msg->type) == r->type
1287         && r->get == msg->get
1288         && r->get_resp == msg->get_resp
1289         && r->put == msg->put
1290         && keys_match
1291         )
1292     {
1293         GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
1294         GNUNET_free_non_null (r->key);
1295         GNUNET_free (r);
1296         GNUNET_SERVER_receive_done (client, GNUNET_OK);
1297         return; /* Delete only ONE entry */
1298     }
1299     r = r->next;
1300   }
1301
1302   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1303 }
1304
1305
1306 /**
1307  * Functions with this signature are called whenever a client
1308  * is disconnected on the network level.
1309  *
1310  * @param cls closure (NULL for dht)
1311  * @param client identification of the client; NULL
1312  *        for the last call when the server is destroyed
1313  */
1314 static void
1315 handle_client_disconnect (void *cls,
1316                           struct GNUNET_SERVER_Client *client)
1317 {
1318   struct ClientList *pos;
1319   struct PendingMessage *reply;
1320   struct ClientMonitorRecord *monitor;
1321
1322   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1323               "Local client %p disconnects\n",
1324               client);
1325   pos = find_active_client (client);
1326   GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
1327   if (pos->transmit_handle != NULL)
1328     GNUNET_SERVER_notify_transmit_ready_cancel (pos->transmit_handle);
1329   while (NULL != (reply = pos->pending_head))
1330   {
1331     GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
1332     GNUNET_free (reply);
1333   }
1334   monitor = monitor_head;
1335   while (NULL != monitor)
1336   {
1337     if (monitor->client == pos)
1338     {
1339       struct ClientMonitorRecord *next;
1340
1341       GNUNET_free_non_null (monitor->key);
1342       next = monitor->next;
1343       GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
1344       GNUNET_free (monitor);
1345       monitor = next;
1346     }
1347     else
1348       monitor = monitor->next;
1349   }
1350   GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
1351                                          pos);
1352   GNUNET_free (pos);
1353 }
1354
1355
1356
1357 /**
1358  * Initialize client subsystem.
1359  *
1360  * @param server the initialized server
1361  */
1362 void
1363 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1364 {
1365   static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1366     {&handle_dht_local_put, NULL,
1367      GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1368     {&handle_dht_local_get, NULL,
1369      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1370     {&handle_dht_local_get_stop, NULL,
1371      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1372      sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1373     {&handle_dht_local_monitor, NULL,
1374      GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1375      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1376     {&handle_dht_local_monitor_stop, NULL,
1377      GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1378      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1379     {&handle_dht_local_get_result_seen, NULL,
1380      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1381     {NULL, NULL, 0, 0}
1382   };
1383   forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1384   retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1385   GNUNET_SERVER_add_handlers (server, plugin_handlers);
1386   GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1387 }
1388
1389
1390 /**
1391  * Shutdown client subsystem.
1392  */
1393 void
1394 GDS_CLIENTS_done ()
1395 {
1396   GNUNET_assert (client_head == NULL);
1397   GNUNET_assert (client_tail == NULL);
1398   if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1399   {
1400     GNUNET_SCHEDULER_cancel (retry_task);
1401     retry_task = GNUNET_SCHEDULER_NO_TASK;
1402   }
1403   if (NULL != retry_heap)
1404   {
1405     GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1406     GNUNET_CONTAINER_heap_destroy (retry_heap);
1407     retry_heap = NULL;
1408   }
1409   if (NULL != forward_map)
1410   {
1411     GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1412     GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1413     forward_map = NULL;
1414   }
1415 }
1416
1417 /* end of gnunet-service-dht_clients.c */