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