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