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,
 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 @e 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,
 486                const struct GNUNET_HashCode *key,
 487                void *value)
 488 {
 489   struct ForwardReplyContext *frc = cls;
 490   struct ClientQueryRecord *record = value;
 491   struct PendingMessage *pm;
 492   struct GNUNET_DHT_ClientResultMessage *reply;
 493   enum GNUNET_BLOCK_EvaluationResult eval;
 494   int do_free;
 495   struct GNUNET_HashCode ch;
 496   unsigned int i;
 497
 498   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
 499                "XVINE CLIENT-RESULT %s\n",
 500                GNUNET_h2s_full (key));
 501 #if 0
 502   if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
 503   {
 504     LOG (GNUNET_ERROR_TYPE_DEBUG,
 505          "Record type missmatch, not passing request for key %s to local client\n",
 506          GNUNET_h2s (key));
 507
 508     GNUNET_STATISTICS_update (GDS_stats,
 509                               gettext_noop
 510                               ("# Key match, type mismatches in REPLY to CLIENT"),
 511                               1, GNUNET_NO);
 512     return GNUNET_YES;          /* type mismatch */
 513   }
 514 #endif
 515   GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
 516   for (i = 0; i < record->seen_replies_count; i++)
 517     if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
 518     {
 519       LOG (GNUNET_ERROR_TYPE_DEBUG,
 520            "Duplicate reply, not passing request for key %s to local client\n",
 521            GNUNET_h2s (key));
 522       GNUNET_STATISTICS_update (GDS_stats,
 523                                 gettext_noop
 524                                 ("# Duplicate REPLIES to CLIENT request dropped"),
 525                                 1, GNUNET_NO);
 526       return GNUNET_YES;        /* duplicate */
 527     }
 528   eval =
 529       GNUNET_BLOCK_evaluate (GDS_block_context,
 530                              record->type,
 531                              GNUNET_BLOCK_EO_NONE,
 532                              key, NULL, 0,
 533                              record->xquery,
 534                              record->xquery_size,
 535                              frc->data,
 536                              frc->data_size);
 537   LOG (GNUNET_ERROR_TYPE_DEBUG,
 538        "Evaluation result is %d for key %s for local client's query\n",
 539        (int) eval, GNUNET_h2s (key));
 540   switch (eval)
 541   {
 542   case GNUNET_BLOCK_EVALUATION_OK_LAST:
 543     do_free = GNUNET_YES;
 544     break;
 545   case GNUNET_BLOCK_EVALUATION_OK_MORE:
 546     GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
 547     do_free = GNUNET_NO;
 548     break;
 549   case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
 550     /* should be impossible to encounter here */
 551     GNUNET_break (0);
 552     return GNUNET_YES;
 553   case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
 554     GNUNET_break_op (0);
 555     return GNUNET_NO;
 556   case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
 557     GNUNET_break (0);
 558     return GNUNET_NO;
 559   case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
 560     GNUNET_break (0);
 561     return GNUNET_NO;
 562   case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
 563     return GNUNET_YES;
 564   case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
 565     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 566                 _("Unsupported block type (%u) in request!\n"), record->type);
 567     return GNUNET_NO;
 568   default:
 569     GNUNET_break (0);
 570     return GNUNET_NO;
 571   }
 572   if (GNUNET_NO == frc->do_copy)
 573   {
 574     /* first time, we can use the original data */
 575     pm = frc->pm;
 576     frc->do_copy = GNUNET_YES;
 577   }
 578   else
 579   {
 580     /* two clients waiting for same reply, must copy for queueing */
 581     pm = GNUNET_malloc (sizeof (struct PendingMessage) +
 582                         ntohs (frc->pm->msg->size));
 583     memcpy (pm, frc->pm,
 584             sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
 585     pm->next = pm->prev = NULL;
 586     pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
 587   }
 588   GNUNET_STATISTICS_update (GDS_stats,
 589                             gettext_noop ("# RESULTS queued for clients"), 1,
 590                             GNUNET_NO);
 591   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
 592   reply->unique_id = record->unique_id;
 593   LOG (GNUNET_ERROR_TYPE_DEBUG,
 594        "Queueing reply to query %s for client %p\n",
 595        GNUNET_h2s (key),
 596        record->client->client_handle);
 597   add_pending_message (record->client, pm);
 598   if (GNUNET_YES == do_free)
 599     remove_client_records (record->client, key, record);
 600   return GNUNET_YES;
 601 }
 602
 603
 604 /**
 605  * Handle a reply we've received from another peer.  If the reply
 606  * matches any of our pending queries, forward it to the respective
 607  * client(s).
 608  *
 609  * @param expiration when will the reply expire
 610  * @param key the query this reply is for
 611  * @param get_path_length number of peers in @a get_path
 612  * @param get_path path the reply took on get
 613  * @param put_path_length number of peers in @a put_path
 614  * @param put_path path the reply took on put
 615  * @param type type of the reply
 616  * @param data_size number of bytes in @a data
 617  * @param data application payload data
 618  */
 619 void
 620 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
 621                           const struct GNUNET_HashCode *key,
 622                           unsigned int get_path_length,
 623                           const struct GNUNET_PeerIdentity *get_path,
 624                           unsigned int put_path_length,
 625                           const struct GNUNET_PeerIdentity *put_path,
 626                           enum GNUNET_BLOCK_Type type, size_t data_size,
 627                           const void *data)
 628 {
 629   struct ForwardReplyContext frc;
 630   struct PendingMessage *pm;
 631   struct GNUNET_DHT_ClientResultMessage *reply;
 632   struct GNUNET_PeerIdentity *paths;
 633   size_t msize;
 634
 635   LOG (GNUNET_ERROR_TYPE_DEBUG,
 636        "reply for key %s\n",
 637        GNUNET_h2s (key));
 638
 639   if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
 640   {
 641     GNUNET_STATISTICS_update (GDS_stats,
 642                               gettext_noop
 643                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
 644                               GNUNET_NO);
 645     return;                     /* no matching request, fast exit! */
 646   }
 647   msize =
 648       sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
 649       (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
 650   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 651   {
 652     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 653                 _("Could not pass reply to client, message too big!\n"));
 654     return;
 655   }
 656   DEBUG("reply FOR DATA_SIZE = %lu\n",msize);
 657   pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
 658   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
 659   pm->msg = &reply->header;
 660   reply->header.size = htons ((uint16_t) msize);
 661   reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
 662   reply->type = htonl (type);
 663   reply->get_path_length = htonl (get_path_length);
 664   reply->put_path_length = htonl (put_path_length);
 665   reply->unique_id = 0;         /* filled in later */
 666   reply->expiration = GNUNET_TIME_absolute_hton (expiration);
 667   reply->key = *key;
 668   paths = (struct GNUNET_PeerIdentity *) &reply[1];
 669   memcpy (paths, put_path,
 670           sizeof (struct GNUNET_PeerIdentity) * put_path_length);
 671   memcpy (&paths[put_path_length], get_path,
 672           sizeof (struct GNUNET_PeerIdentity) * get_path_length);
 673   memcpy (&paths[get_path_length + put_path_length], data, data_size);
 674   frc.do_copy = GNUNET_NO;
 675   frc.pm = pm;
 676   frc.data = data;
 677   frc.data_size = data_size;
 678   frc.type = type;
 679   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
 680                                               &frc);
 681   if (GNUNET_NO == frc.do_copy)
 682   {
 683     /* did not match any of the requests, free! */
 684     GNUNET_STATISTICS_update (GDS_stats,
 685                               gettext_noop
 686                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
 687                               GNUNET_NO);
 688     GNUNET_free (pm);
 689   }
 690 }
 691
 692
 693 /**
 694  * Check if some client is monitoring GET messages and notify
 695  * them in that case.
 696  *
 697  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
 698  * @param type The type of data in the request.
 699  * @param hop_count Hop count so far.
 700  * @param path_length number of entries in path (or 0 if not recorded).
 701  * @param path peers on the GET path (or NULL if not recorded).
 702  * @param desired_replication_level Desired replication level.
 703  * @param key Key of the requested data.
 704  */
 705 void
 706 GDS_CLIENTS_process_get (uint32_t options,
 707                          enum GNUNET_BLOCK_Type type,
 708                          uint32_t hop_count,
 709                          uint32_t desired_replication_level,
 710                          unsigned int path_length,
 711                          const struct GNUNET_PeerIdentity *path,
 712                          const struct GNUNET_HashCode *key)
 713 {
 714   struct ClientMonitorRecord *m;
 715   struct ClientList **cl;
 716   unsigned int cl_size;
 717
 718   cl = NULL;
 719   cl_size = 0;
 720   for (m = monitor_head; NULL != m; m = m->next)
 721   {
 722     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
 723         (NULL == m->key ||
 724          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
 725     {
 726       struct PendingMessage *pm;
 727       struct GNUNET_DHT_MonitorGetMessage *mmsg;
 728       struct GNUNET_PeerIdentity *msg_path;
 729       size_t msize;
 730       unsigned int i;
 731
 732       /* Don't send duplicates */
 733       for (i = 0; i < cl_size; i++)
 734         if (cl[i] == m->client)
 735           break;
 736       if (i < cl_size)
 737         continue;
 738       GNUNET_array_append (cl, cl_size, m->client);
 739
 740       msize = path_length * sizeof (struct GNUNET_PeerIdentity);
 741       msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
 742       msize += sizeof (struct PendingMessage);
 743       pm = GNUNET_malloc (msize);
 744       mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
 745       pm->msg = &mmsg->header;
 746       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
 747       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
 748       mmsg->options = htonl(options);
 749       mmsg->type = htonl(type);
 750       mmsg->hop_count = htonl(hop_count);
 751       mmsg->desired_replication_level = htonl(desired_replication_level);
 752       mmsg->get_path_length = htonl(path_length);
 753       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
 754       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
 755       if (path_length > 0)
 756         memcpy (msg_path, path,
 757                 path_length * sizeof (struct GNUNET_PeerIdentity));
 758       add_pending_message (m->client, pm);
 759     }
 760   }
 761   GNUNET_free_non_null (cl);
 762 }
 763
 764
 765 /**
 766  * Check if some client is monitoring PUT messages and notify
 767  * them in that case.
 768  *
 769  * @param options options, for instance RecordRoute, DemultiplexEverywhere.
 770  * @param type type of data in the request.
 771  * @param hop_count hop count so far.
 772  * @param path_length number of entries in @a path (or 0 if not recorded).
 773  * @param path peers on the PUT path (or NULL if not recorded).
 774  * @param desired_replication_level desired replication level.
 775  * @param exp expiration time of the data.
 776  * @param key key under which @a data is to be stored.
 777  * @param data pointer to the data carried.
 778  * @param size number of bytes in @a data.
 779  */
 780 void
 781 GDS_CLIENTS_process_put (uint32_t options,
 782                          enum GNUNET_BLOCK_Type type,
 783                          uint32_t hop_count,
 784                          uint32_t desired_replication_level,
 785                          unsigned int path_length,
 786                          const struct GNUNET_PeerIdentity *path,
 787                          struct GNUNET_TIME_Absolute exp,
 788                          const struct GNUNET_HashCode *key,
 789                          const void *data,
 790                          size_t size)
 791 {
 792   struct ClientMonitorRecord *m;
 793   struct ClientList **cl;
 794   unsigned int cl_size;
 795
 796   cl = NULL;
 797   cl_size = 0;
 798   for (m = monitor_head; NULL != m; m = m->next)
 799   {
 800     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
 801         (NULL == m->key ||
 802          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
 803     {
 804       struct PendingMessage *pm;
 805       struct GNUNET_DHT_MonitorPutMessage *mmsg;
 806       struct GNUNET_PeerIdentity *msg_path;
 807       size_t msize;
 808       unsigned int i;
 809
 810       /* Don't send duplicates */
 811       for (i = 0; i < cl_size; i++)
 812         if (cl[i] == m->client)
 813           break;
 814       if (i < cl_size)
 815         continue;
 816       GNUNET_array_append (cl, cl_size, m->client);
 817
 818       msize = size;
 819       msize += path_length * sizeof (struct GNUNET_PeerIdentity);
 820       msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
 821       msize += sizeof (struct PendingMessage);
 822       pm = GNUNET_malloc (msize);
 823       mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
 824       pm->msg = (struct GNUNET_MessageHeader *) mmsg;
 825       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
 826       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
 827       mmsg->options = htonl(options);
 828       mmsg->type = htonl(type);
 829       mmsg->hop_count = htonl(hop_count);
 830       mmsg->desired_replication_level = htonl(desired_replication_level);
 831       mmsg->put_path_length = htonl(path_length);
 832       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
 833       if (path_length > 0)
 834       {
 835         memcpy (msg_path, path,
 836                 path_length * sizeof (struct GNUNET_PeerIdentity));
 837       }
 838       mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
 839       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
 840       if (size > 0)
 841         memcpy (&msg_path[path_length], data, size);
 842       add_pending_message (m->client, pm);
 843     }
 844   }
 845   GNUNET_free_non_null (cl);
 846 }
 847
 848
 849 /**
 850  * Route the given request via the DHT.
 851  */
 852 static void
 853 transmit_request (struct ClientQueryRecord *cqr)
 854 {
 855   GNUNET_STATISTICS_update (GDS_stats,
 856                             gettext_noop
 857                             ("# GET requests from clients injected"), 1,
 858                             GNUNET_NO);
 859
 860   LOG (GNUNET_ERROR_TYPE_DEBUG,
 861        "Initiating GET for %s, replication %u, already have %u replies\n",
 862        GNUNET_h2s (&cqr->key),
 863        cqr->replication,
 864        cqr->seen_replies_count);
 865
 866   GDS_NEIGHBOURS_handle_get (&cqr->key, cqr->type, cqr->msg_options,
 867                               cqr->replication);
 868
 869   /* exponential back-off for retries.
 870    * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
 871   cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
 872   cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
 873 }
 874
 875
 876 /**
 877  * Task that looks at the 'retry_heap' and transmits all of the requests
 878  * on the heap that are ready for transmission.  Then re-schedules
 879  * itself (unless the heap is empty).
 880  *
 881  * @param cls unused
 882  */
 883 static void
 884 transmit_next_request_task (void *cls)
 885 {
 886   struct ClientQueryRecord *cqr;
 887   struct GNUNET_TIME_Relative delay;
 888
 889   retry_task = NULL;
 890   while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
 891   {
 892     cqr->hnode = NULL;
 893     delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
 894     if (delay.rel_value_us > 0)
 895     {
 896       cqr->hnode =
 897           GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
 898                                         cqr->retry_time.abs_value_us);
 899       retry_task =
 900           GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
 901                                         NULL);
 902       return;
 903     }
 904     transmit_request (cqr);
 905     cqr->hnode =
 906         GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
 907                                       cqr->retry_time.abs_value_us);
 908   }
 909 }
 910
 911
 912 /**
 913  * Handler for PUT messages.
 914  *
 915  * @param cls closure for the service
 916  * @param client the client we received this message from
 917  * @param message the actual message received
 918  */
 919 static void
 920 handle_dht_local_put (void *cls,
 921                       struct GNUNET_SERVER_Client *client,
 922                       const struct GNUNET_MessageHeader *message)
 923 {
 924   const struct GNUNET_DHT_ClientPutMessage *put_msg;
 925   struct PendingMessage *pm;
 926   struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
 927   uint16_t size;
 928
 929   size = ntohs (message->size);
 930   if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
 931   {
 932     GNUNET_break (0);
 933     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 934     return;
 935   }
 936   GNUNET_STATISTICS_update (GDS_stats,
 937                             gettext_noop
 938                             ("# PUT requests received from clients"), 1,
 939                             GNUNET_NO);
 940   put_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
 941   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE DHT CLIENT-PUT %s\n",
 942                GNUNET_h2s_full (&put_msg->key));
 943   /* give to local clients */
 944   LOG (GNUNET_ERROR_TYPE_DEBUG,
 945        "Handling local PUT of %u-bytes for query %s\n",
 946        size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 947        GNUNET_h2s (&put_msg->key));
 948   DEBUG("PUT doing put i = %s\n",GNUNET_h2s(&(put_msg->key)));
 949   GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put_msg->expiration),
 950                             &put_msg->key, 0, NULL, 0, NULL,
 951                             ntohl (put_msg->type),
 952                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 953                             &put_msg[1]);
 954
 955   GDS_NEIGHBOURS_handle_put (&put_msg->key,
 956                               ntohl (put_msg->type), ntohl (put_msg->options),
 957                               ntohl (put_msg->desired_replication_level),
 958                               GNUNET_TIME_absolute_ntoh (put_msg->expiration),
 959                               &put_msg[1],
 960                               size - sizeof (struct GNUNET_DHT_ClientPutMessage));
 961   pm = GNUNET_malloc (sizeof (struct PendingMessage) +
 962                       sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
 963   conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
 964   conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
 965   conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
 966   conf->reserved = htonl (0);
 967   conf->unique_id = put_msg->unique_id;
 968   pm->msg = &conf->header;
 969   add_pending_message (find_active_client (client), pm);
 970   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 971 }
 972
 973
 974 /**
 975  * Handler for DHT GET messages from the client.
 976  *
 977  * @param cls closure for the service
 978  * @param client the client we received this message from
 979  * @param message the actual message received
 980  */
 981 static void
 982 handle_dht_local_get (void *cls,
 983                       struct GNUNET_SERVER_Client *client,
 984                       const struct GNUNET_MessageHeader *message)
 985 {
 986   const struct GNUNET_DHT_ClientGetMessage *get;
 987   struct ClientQueryRecord *cqr;
 988   size_t xquery_size;
 989   const char *xquery;
 990   uint16_t size;
 991
 992   size = ntohs (message->size);
 993   if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
 994   {
 995     GNUNET_break (0);
 996     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 997     return;
 998   }
 999   xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
1000   get = (const struct GNUNET_DHT_ClientGetMessage *) message;
1001   xquery = (const char *) &get[1];
1002   GNUNET_STATISTICS_update (GDS_stats,
1003                             gettext_noop
1004                             ("# GET requests received from clients"), 1,
1005                             GNUNET_NO);
1006   LOG (GNUNET_ERROR_TYPE_DEBUG,
1007        "Received GET request for %s from local client %p, xq: %.*s\n",
1008        GNUNET_h2s (&get->key), client, xquery_size, xquery);
1009
1010   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "X-VINE CLIENT-GET %s\n",
1011                GNUNET_h2s_full (&get->key));
1012
1013
1014   cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
1015   cqr->key = get->key;
1016   cqr->client = find_active_client (client);
1017   cqr->xquery = (void *) &cqr[1];
1018   memcpy (&cqr[1], xquery, xquery_size);
1019   cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
1020   cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
1021   cqr->retry_time = GNUNET_TIME_absolute_get ();
1022   cqr->unique_id = get->unique_id;
1023   cqr->xquery_size = xquery_size;
1024   cqr->replication = ntohl (get->desired_replication_level);
1025   cqr->msg_options = ntohl (get->options);
1026   cqr->type = ntohl (get->type);
1027
1028   // FIXME use cqr->key, set multihashmap create to GNUNET_YES
1029   GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
1030                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1031
1032   struct GNUNET_PeerIdentity my_identity;
1033   my_identity = GDS_NEIGHBOURS_get_my_id();
1034   GDS_CLIENTS_process_get (ntohl (get->options),
1035                            ntohl (get->type),
1036                            0,
1037                            ntohl (get->desired_replication_level),
1038                            1,
1039                            &my_identity,
1040                            &get->key);
1041   /* start remote requests */
1042   if (NULL != retry_task)
1043     GNUNET_SCHEDULER_cancel (retry_task);
1044   retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
1045   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1046 }
1047
1048
1049 /**
1050  * Closure for #find_by_unique_id().
1051  */
1052 struct FindByUniqueIdContext
1053 {
1054   /**
1055    * Where to store the result, if found.
1056    */
1057   struct ClientQueryRecord *cqr;
1058
1059   /**
1060    * Which ID are we looking for?
1061    */
1062   uint64_t unique_id;
1063 };
1064
1065
1066 /**
1067  * Function called for each existing DHT record for the given
1068  * query.  Checks if it matches the UID given in the closure
1069  * and if so returns the entry as a result.
1070  *
1071  * @param cls the search context
1072  * @param key query for the lookup (not used)
1073  * @param value the `struct ClientQueryRecord`
1074  * @return #GNUNET_YES to continue iteration (result not yet found)
1075  */
1076 static int
1077 find_by_unique_id (void *cls,
1078                    const struct GNUNET_HashCode *key,
1079                    void *value)
1080 {
1081   struct FindByUniqueIdContext *fui_ctx = cls;
1082   struct ClientQueryRecord *cqr = value;
1083
1084   if (cqr->unique_id != fui_ctx->unique_id)
1085     return GNUNET_YES;
1086   fui_ctx->cqr = cqr;
1087   return GNUNET_NO;
1088 }
1089
1090
1091 /**
1092  * Handler for "GET result seen" messages from the client.
1093  *
1094  * @param cls closure for the service
1095  * @param client the client we received this message from
1096  * @param message the actual message received
1097  */
1098 static void
1099 handle_dht_local_get_result_seen (void *cls,
1100                                   struct GNUNET_SERVER_Client *client,
1101                                   const struct GNUNET_MessageHeader *message)
1102 {
1103   const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
1104   uint16_t size;
1105   unsigned int hash_count;
1106   unsigned int old_count;
1107   const struct GNUNET_HashCode *hc;
1108   struct FindByUniqueIdContext fui_ctx;
1109   struct ClientQueryRecord *cqr;
1110
1111   size = ntohs (message->size);
1112   if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
1113   {
1114     GNUNET_break (0);
1115     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1116     return;
1117   }
1118   seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
1119   hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
1120   if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
1121   {
1122     GNUNET_break (0);
1123     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1124     return;
1125   }
1126   hc = (const struct GNUNET_HashCode*) &seen[1];
1127   fui_ctx.unique_id = seen->unique_id;
1128   fui_ctx.cqr = NULL;
1129   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1130                                               &seen->key,
1131                                               &find_by_unique_id,
1132                                               &fui_ctx);
1133   if (NULL == (cqr = fui_ctx.cqr))
1134   {
1135     GNUNET_break (0);
1136     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1137     return;
1138   }
1139   /* finally, update 'seen' list */
1140   old_count = cqr->seen_replies_count;
1141   GNUNET_array_grow (cqr->seen_replies,
1142                      cqr->seen_replies_count,
1143                      cqr->seen_replies_count + hash_count);
1144   memcpy (&cqr->seen_replies[old_count],
1145           hc,
1146           sizeof (struct GNUNET_HashCode) * hash_count);
1147 }
1148
1149
1150 /**
1151  * Closure for #remove_by_unique_id().
1152  */
1153 struct RemoveByUniqueIdContext
1154 {
1155   /**
1156    * Client that issued the removal request.
1157    */
1158   struct ClientList *client;
1159
1160   /**
1161    * Unique ID of the request.
1162    */
1163   uint64_t unique_id;
1164 };
1165
1166
1167 /**
1168  * Iterator over hash map entries that frees all entries
1169  * that match the given client and unique ID.
1170  *
1171  * @param cls unique ID and client to search for in source routes
1172  * @param key current key code
1173  * @param value value in the hash map, a ClientQueryRecord
1174  * @return #GNUNET_YES (we should continue to iterate)
1175  */
1176 static int
1177 remove_by_unique_id (void *cls,
1178                      const struct GNUNET_HashCode *key,
1179                      void *value)
1180 {
1181   const struct RemoveByUniqueIdContext *ctx = cls;
1182   struct ClientQueryRecord *record = value;
1183
1184   if (record->unique_id != ctx->unique_id)
1185     return GNUNET_YES;
1186   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1187               "Removing client %p's record for key %s (by unique id)\n",
1188               ctx->client->client_handle, GNUNET_h2s (key));
1189   return remove_client_records (ctx->client, key, record);
1190 }
1191
1192
1193 /**
1194  * Handler for any generic DHT stop messages, calls the appropriate handler
1195  * depending on message type (if processed locally)
1196  *
1197  * @param cls closure for the service
1198  * @param client the client we received this message from
1199  * @param message the actual message received
1200  *
1201  */
1202 static void
1203 handle_dht_local_get_stop (void *cls,
1204                            struct GNUNET_SERVER_Client *client,
1205                            const struct GNUNET_MessageHeader *message)
1206 {
1207   const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
1208       (const struct GNUNET_DHT_ClientGetStopMessage *) message;
1209   struct RemoveByUniqueIdContext ctx;
1210
1211   GNUNET_STATISTICS_update (GDS_stats,
1212                             gettext_noop
1213                             ("# GET STOP requests received from clients"), 1,
1214                             GNUNET_NO);
1215   LOG (GNUNET_ERROR_TYPE_DEBUG,
1216        "Received GET STOP request for %s from local client %p\n",
1217        client, GNUNET_h2s (&dht_stop_msg->key));
1218   ctx.client = find_active_client (client);
1219   ctx.unique_id = dht_stop_msg->unique_id;
1220   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
1221                                               &remove_by_unique_id, &ctx);
1222   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1223 }
1224
1225
1226 /**
1227  * Handler for monitor start messages
1228  *
1229  * @param cls closure for the service
1230  * @param client the client we received this message from
1231  * @param message the actual message received
1232  *
1233  */
1234 static void
1235 handle_dht_local_monitor (void *cls,
1236                           struct GNUNET_SERVER_Client *client,
1237                           const struct GNUNET_MessageHeader *message)
1238 {
1239   struct ClientMonitorRecord *r;
1240   const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1241
1242   msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1243   r = GNUNET_new (struct ClientMonitorRecord);
1244
1245   r->client = find_active_client(client);
1246   r->type = ntohl(msg->type);
1247   r->get = ntohs(msg->get);
1248   r->get_resp = ntohs(msg->get_resp);
1249   r->put = ntohs(msg->put);
1250   if (0 == ntohs(msg->filter_key))
1251       r->key = NULL;
1252   else
1253   {
1254     r->key = GNUNET_new (struct GNUNET_HashCode);
1255     memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
1256   }
1257   GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
1258   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1259 }
1260
1261
1262 /**
1263  * Handler for monitor stop messages
1264  *
1265  * @param cls closure for the service
1266  * @param client the client we received this message from
1267  * @param message the actual message received
1268  */
1269 static void
1270 handle_dht_local_monitor_stop (void *cls,
1271                                struct GNUNET_SERVER_Client *client,
1272                                const struct GNUNET_MessageHeader *message)
1273 {
1274   struct ClientMonitorRecord *r;
1275   const struct GNUNET_DHT_MonitorStartStopMessage *msg;
1276   int keys_match;
1277
1278   msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
1279   r = monitor_head;
1280
1281   while (NULL != r)
1282   {
1283     if (NULL == r->key)
1284         keys_match = (0 == ntohs(msg->filter_key));
1285     else
1286     {
1287         keys_match = (0 != ntohs(msg->filter_key)
1288                       && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
1289     }
1290     if (find_active_client(client) == r->client
1291         && ntohl(msg->type) == r->type
1292         && r->get == msg->get
1293         && r->get_resp == msg->get_resp
1294         && r->put == msg->put
1295         && keys_match
1296         )
1297     {
1298         GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
1299         GNUNET_free_non_null (r->key);
1300         GNUNET_free (r);
1301         GNUNET_SERVER_receive_done (client, GNUNET_OK);
1302         return; /* Delete only ONE entry */
1303     }
1304     r = r->next;
1305   }
1306   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1307 }
1308
1309
1310 /**
1311  * Functions with this signature are called whenever a client
1312  * is disconnected on the network level.
1313  *
1314  * @param cls closure (NULL for dht)
1315  * @param client identification of the client; NULL
1316  *        for the last call when the server is destroyed
1317  */
1318 static void
1319 handle_client_disconnect (void *cls,
1320                           struct GNUNET_SERVER_Client *client)
1321 {
1322   struct ClientList *pos;
1323   struct PendingMessage *reply;
1324   struct ClientMonitorRecord *monitor;
1325
1326   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1327               "Local client %p disconnects\n",
1328               client);
1329   pos = find_active_client (client);
1330   GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
1331   if (pos->transmit_handle != NULL)
1332     GNUNET_SERVER_notify_transmit_ready_cancel (pos->transmit_handle);
1333   while (NULL != (reply = pos->pending_head))
1334   {
1335     GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
1336     GNUNET_free (reply);
1337   }
1338   monitor = monitor_head;
1339   while (NULL != monitor)
1340   {
1341     if (monitor->client == pos)
1342     {
1343       struct ClientMonitorRecord *next;
1344
1345       GNUNET_free_non_null (monitor->key);
1346       next = monitor->next;
1347       GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
1348       GNUNET_free (monitor);
1349       monitor = next;
1350     }
1351     else
1352       monitor = monitor->next;
1353   }
1354   GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
1355                                          pos);
1356   GNUNET_free (pos);
1357 }
1358
1359
1360 /**
1361  * Initialize client subsystem.
1362  *
1363  * @param server the initialized server
1364  */
1365 void
1366 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1367 {
1368   static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1369     {&handle_dht_local_put, NULL,
1370      GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1371     {&handle_dht_local_get, NULL,
1372      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1373     {&handle_dht_local_get_stop, NULL,
1374      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1375      sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1376     {&handle_dht_local_monitor, NULL,
1377      GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1378      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1379     {&handle_dht_local_monitor_stop, NULL,
1380      GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1381      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1382     {&handle_dht_local_get_result_seen, NULL,
1383      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1384     {NULL, NULL, 0, 0}
1385   };
1386   forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1387   retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1388   GNUNET_SERVER_add_handlers (server, plugin_handlers);
1389   GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1390 }
1391
1392
1393 /**
1394  * Shutdown client subsystem.
1395  */
1396 void
1397 GDS_CLIENTS_done ()
1398 {
1399   GNUNET_assert (client_head == NULL);
1400   GNUNET_assert (client_tail == NULL);
1401   if (NULL != retry_task)
1402   {
1403     GNUNET_SCHEDULER_cancel (retry_task);
1404     retry_task = NULL;
1405   }
1406   if (NULL != retry_heap)
1407   {
1408     GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1409     GNUNET_CONTAINER_heap_destroy (retry_heap);
1410     retry_heap = NULL;
1411   }
1412   if (NULL != forward_map)
1413   {
1414     GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1415     GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1416     forward_map = NULL;
1417   }
1418 }
1419
1420 /* end of gnunet-service-wdht_clients.c */