src/dht/gnunet-service-dht_clients.c

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