src/dht/gnunet-service-wdht_clients.c

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