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