src/dht/gnunet-service-xdht_clients.c

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