src/dht/gnunet-service-xdht_clients.c

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