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