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 local forwarding map 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_new (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,
 363                           struct GNUNET_SERVER_Client *client)
 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),
 431        cqr->replication,
 432        cqr->seen_replies_count);
 433   GDS_NEIGHBOURS_handle_get (cqr->type, cqr->msg_options, cqr->replication,
 434                              0 /* hop count */ ,
 435                              &cqr->key, cqr->xquery, cqr->xquery_size, reply_bf,
 436                              reply_bf_mutator, peer_bf);
 437   GNUNET_CONTAINER_bloomfilter_free (reply_bf);
 438   GNUNET_CONTAINER_bloomfilter_free (peer_bf);
 439
 440   /* exponential back-off for retries.
 441    * max GNUNET_TIME_STD_EXPONENTIAL_BACKOFF_THRESHOLD (15 min) */
 442   cqr->retry_frequency = GNUNET_TIME_STD_BACKOFF (cqr->retry_frequency);
 443   cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
 444 }
 445
 446
 447 /**
 448  * Task that looks at the 'retry_heap' and transmits all of the requests
 449  * on the heap that are ready for transmission.  Then re-schedules
 450  * itself (unless the heap is empty).
 451  *
 452  * @param cls unused
 453  * @param tc scheduler context
 454  */
 455 static void
 456 transmit_next_request_task (void *cls,
 457                             const struct GNUNET_SCHEDULER_TaskContext *tc)
 458 {
 459   struct ClientQueryRecord *cqr;
 460   struct GNUNET_TIME_Relative delay;
 461
 462   retry_task = GNUNET_SCHEDULER_NO_TASK;
 463   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 464     return;
 465   while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
 466   {
 467     cqr->hnode = NULL;
 468     delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
 469     if (delay.rel_value_us > 0)
 470     {
 471       cqr->hnode =
 472           GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
 473                                         cqr->retry_time.abs_value_us);
 474       retry_task =
 475           GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
 476                                         NULL);
 477       return;
 478     }
 479     transmit_request (cqr);
 480     cqr->hnode =
 481         GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
 482                                       cqr->retry_time.abs_value_us);
 483   }
 484 }
 485
 486
 487 /**
 488  * Handler for PUT messages.
 489  *
 490  * @param cls closure for the service
 491  * @param client the client we received this message from
 492  * @param message the actual message received
 493  */
 494 static void
 495 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
 496                       const struct GNUNET_MessageHeader *message)
 497 {
 498   const struct GNUNET_DHT_ClientPutMessage *dht_msg;
 499   struct GNUNET_CONTAINER_BloomFilter *peer_bf;
 500   uint16_t size;
 501   struct PendingMessage *pm;
 502   struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
 503
 504   size = ntohs (message->size);
 505   if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
 506   {
 507     GNUNET_break (0);
 508     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 509     return;
 510   }
 511   GNUNET_STATISTICS_update (GDS_stats,
 512                             gettext_noop
 513                             ("# PUT requests received from clients"), 1,
 514                             GNUNET_NO);
 515   dht_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
 516   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "R5N CLIENT-PUT %s\n",
 517                GNUNET_h2s_full (&dht_msg->key));
 518   /* give to local clients */
 519   LOG (GNUNET_ERROR_TYPE_DEBUG,
 520        "Handling local PUT of %u-bytes for query %s\n",
 521        size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 522        GNUNET_h2s (&dht_msg->key));
 523   GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 524                             &dht_msg->key, 0, NULL, 0, NULL,
 525                             ntohl (dht_msg->type),
 526                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 527                             &dht_msg[1]);
 528   /* store locally */
 529   GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 530                             &dht_msg->key, 0, NULL, ntohl (dht_msg->type),
 531                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 532                             &dht_msg[1]);
 533   /* route to other peers */
 534   peer_bf =
 535       GNUNET_CONTAINER_bloomfilter_init (NULL, DHT_BLOOM_SIZE,
 536                                          GNUNET_CONSTANTS_BLOOMFILTER_K);
 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, "R5N CLIENT-GET %s\n",
 604                GNUNET_h2s_full (&get->key));
 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 /**
 847  * Handler for monitor stop messages
 848  *
 849  * @param cls closure for the service
 850  * @param client the client we received this message from
 851  * @param message the actual message received
 852  *
 853  */
 854 static void
 855 handle_dht_local_monitor_stop (void *cls, struct GNUNET_SERVER_Client *client,
 856                                const struct GNUNET_MessageHeader *message)
 857 {
 858   struct ClientMonitorRecord *r;
 859   const struct GNUNET_DHT_MonitorStartStopMessage *msg;
 860   int keys_match;
 861
 862   msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
 863   r = monitor_head;
 864
 865   while (NULL != r)
 866   {
 867     if (NULL == r->key)
 868         keys_match = (0 == ntohs(msg->filter_key));
 869     else
 870     {
 871         keys_match = (0 != ntohs(msg->filter_key)
 872                       && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
 873     }
 874     if (find_active_client(client) == r->client
 875         && ntohl(msg->type) == r->type
 876         && r->get == msg->get
 877         && r->get_resp == msg->get_resp
 878         && r->put == msg->put
 879         && keys_match
 880         )
 881     {
 882         GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
 883         GNUNET_free_non_null (r->key);
 884         GNUNET_free (r);
 885         GNUNET_SERVER_receive_done (client, GNUNET_OK);
 886         return; /* Delete only ONE entry */
 887     }
 888     r = r->next;
 889   }
 890
 891   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 892 }
 893
 894
 895 /**
 896  * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
 897  * request.  A ClientList is passed as closure, take the head of the list
 898  * and copy it into buf, which has the result of sending the message to the
 899  * client.
 900  *
 901  * @param cls closure to this call
 902  * @param size maximum number of bytes available to send
 903  * @param buf where to copy the actual message to
 904  *
 905  * @return the number of bytes actually copied, 0 indicates failure
 906  */
 907 static size_t
 908 send_reply_to_client (void *cls, size_t size, void *buf)
 909 {
 910   struct ClientList *client = cls;
 911   char *cbuf = buf;
 912   struct PendingMessage *reply;
 913   size_t off;
 914   size_t msize;
 915
 916   client->transmit_handle = NULL;
 917   if (buf == NULL)
 918   {
 919     /* client disconnected */
 920     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 921                 "Client %p disconnected, pending messages will be discarded\n",
 922                 client->client_handle);
 923     return 0;
 924   }
 925   off = 0;
 926   while ((NULL != (reply = client->pending_head)) &&
 927          (size >= off + (msize = ntohs (reply->msg->size))))
 928   {
 929     GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
 930                                  reply);
 931     memcpy (&cbuf[off], reply->msg, msize);
 932     GNUNET_free (reply);
 933     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes to client %p\n",
 934                 msize, client->client_handle);
 935     off += msize;
 936   }
 937   process_pending_messages (client);
 938   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitted %u/%u bytes to client %p\n",
 939               (unsigned int) off, (unsigned int) size, client->client_handle);
 940   return off;
 941 }
 942
 943
 944 /**
 945  * Task run to check for messages that need to be sent to a client.
 946  *
 947  * @param client a ClientList, containing the client and any messages to be sent to it
 948  */
 949 static void
 950 process_pending_messages (struct ClientList *client)
 951 {
 952   if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
 953   {
 954     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 955                 "Not asking for transmission to %p now: %s\n",
 956                 client->client_handle,
 957                 client->pending_head ==
 958                 NULL ? "no more messages" : "request already pending");
 959     return;
 960   }
 961   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 962               "Asking for transmission of %u bytes to client %p\n",
 963               ntohs (client->pending_head->msg->size), client->client_handle);
 964   client->transmit_handle =
 965       GNUNET_SERVER_notify_transmit_ready (client->client_handle,
 966                                            ntohs (client->pending_head->
 967                                                   msg->size),
 968                                            GNUNET_TIME_UNIT_FOREVER_REL,
 969                                            &send_reply_to_client, client);
 970 }
 971
 972
 973 /**
 974  * Closure for 'forward_reply'
 975  */
 976 struct ForwardReplyContext
 977 {
 978
 979   /**
 980    * Actual message to send to matching clients.
 981    */
 982   struct PendingMessage *pm;
 983
 984   /**
 985    * Embedded payload.
 986    */
 987   const void *data;
 988
 989   /**
 990    * Type of the data.
 991    */
 992   enum GNUNET_BLOCK_Type type;
 993
 994   /**
 995    * Number of bytes in data.
 996    */
 997   size_t data_size;
 998
 999   /**
1000    * Do we need to copy 'pm' because it was already used?
1001    */
1002   int do_copy;
1003
1004 };
1005
1006
1007 /**
1008  * Iterator over hash map entries that send a given reply to
1009  * each of the matching clients.  With some tricky recycling
1010  * of the buffer.
1011  *
1012  * @param cls the 'struct ForwardReplyContext'
1013  * @param key current key
1014  * @param value value in the hash map, a ClientQueryRecord
1015  * @return GNUNET_YES (we should continue to iterate),
1016  *         if the result is mal-formed, GNUNET_NO
1017  */
1018 static int
1019 forward_reply (void *cls, const struct GNUNET_HashCode * key, void *value)
1020 {
1021   struct ForwardReplyContext *frc = cls;
1022   struct ClientQueryRecord *record = value;
1023   struct PendingMessage *pm;
1024   struct GNUNET_DHT_ClientResultMessage *reply;
1025   enum GNUNET_BLOCK_EvaluationResult eval;
1026   int do_free;
1027   struct GNUNET_HashCode ch;
1028   unsigned int i;
1029
1030   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
1031                "R5N CLIENT-RESULT %s\n",
1032                GNUNET_h2s_full (key));
1033   if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
1034   {
1035     LOG (GNUNET_ERROR_TYPE_DEBUG,
1036          "Record type missmatch, not passing request for key %s to local client\n",
1037          GNUNET_h2s (key));
1038     GNUNET_STATISTICS_update (GDS_stats,
1039                               gettext_noop
1040                               ("# Key match, type mismatches in REPLY to CLIENT"),
1041                               1, GNUNET_NO);
1042     return GNUNET_YES;          /* type mismatch */
1043   }
1044   GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
1045   for (i = 0; i < record->seen_replies_count; i++)
1046     if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
1047     {
1048       LOG (GNUNET_ERROR_TYPE_DEBUG,
1049            "Duplicate reply, not passing request for key %s to local client\n",
1050            GNUNET_h2s (key));
1051       GNUNET_STATISTICS_update (GDS_stats,
1052                                 gettext_noop
1053                                 ("# Duplicate REPLIES to CLIENT request dropped"),
1054                                 1, GNUNET_NO);
1055       return GNUNET_YES;        /* duplicate */
1056     }
1057   eval =
1058       GNUNET_BLOCK_evaluate (GDS_block_context, record->type, key, NULL, 0,
1059                              record->xquery, record->xquery_size, frc->data,
1060                              frc->data_size);
1061   LOG (GNUNET_ERROR_TYPE_DEBUG,
1062        "Evaluation result is %d for key %s for local client's query\n",
1063        (int) eval, GNUNET_h2s (key));
1064   switch (eval)
1065   {
1066   case GNUNET_BLOCK_EVALUATION_OK_LAST:
1067     do_free = GNUNET_YES;
1068     break;
1069   case GNUNET_BLOCK_EVALUATION_OK_MORE:
1070     GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
1071     do_free = GNUNET_NO;
1072     break;
1073   case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
1074     /* should be impossible to encounter here */
1075     GNUNET_break (0);
1076     return GNUNET_YES;
1077   case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
1078     GNUNET_break_op (0);
1079     return GNUNET_NO;
1080   case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
1081     GNUNET_break (0);
1082     return GNUNET_NO;
1083   case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
1084     GNUNET_break (0);
1085     return GNUNET_NO;
1086   case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
1087     return GNUNET_YES;
1088   case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
1089     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1090                 _("Unsupported block type (%u) in request!\n"), record->type);
1091     return GNUNET_NO;
1092   default:
1093     GNUNET_break (0);
1094     return GNUNET_NO;
1095   }
1096   if (GNUNET_NO == frc->do_copy)
1097   {
1098     /* first time, we can use the original data */
1099     pm = frc->pm;
1100     frc->do_copy = GNUNET_YES;
1101   }
1102   else
1103   {
1104     /* two clients waiting for same reply, must copy for queueing */
1105     pm = GNUNET_malloc (sizeof (struct PendingMessage) +
1106                         ntohs (frc->pm->msg->size));
1107     memcpy (pm, frc->pm,
1108             sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
1109     pm->next = pm->prev = NULL;
1110     pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
1111   }
1112   GNUNET_STATISTICS_update (GDS_stats,
1113                             gettext_noop ("# RESULTS queued for clients"), 1,
1114                             GNUNET_NO);
1115   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
1116   reply->unique_id = record->unique_id;
1117   LOG (GNUNET_ERROR_TYPE_DEBUG,
1118        "Queueing reply to query %s for client %p\n",
1119        GNUNET_h2s (key),
1120        record->client->client_handle);
1121   add_pending_message (record->client, pm);
1122   if (GNUNET_YES == do_free)
1123     remove_client_records (record->client, key, record);
1124   return GNUNET_YES;
1125 }
1126
1127
1128 /**
1129  * Handle a reply we've received from another peer.  If the reply
1130  * matches any of our pending queries, forward it to the respective
1131  * client(s).
1132  *
1133  * @param expiration when will the reply expire
1134  * @param key the query this reply is for
1135  * @param get_path_length number of peers in @a get_path
1136  * @param get_path path the reply took on get
1137  * @param put_path_length number of peers in @a put_path
1138  * @param put_path path the reply took on put
1139  * @param type type of the reply
1140  * @param data_size number of bytes in @a data
1141  * @param data application payload data
1142  */
1143 void
1144 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
1145                           const struct GNUNET_HashCode *key,
1146                           unsigned int get_path_length,
1147                           const struct GNUNET_PeerIdentity *get_path,
1148                           unsigned int put_path_length,
1149                           const struct GNUNET_PeerIdentity *put_path,
1150                           enum GNUNET_BLOCK_Type type, size_t data_size,
1151                           const void *data)
1152 {
1153   struct ForwardReplyContext frc;
1154   struct PendingMessage *pm;
1155   struct GNUNET_DHT_ClientResultMessage *reply;
1156   struct GNUNET_PeerIdentity *paths;
1157   size_t msize;
1158
1159   LOG (GNUNET_ERROR_TYPE_DEBUG,
1160        "reply for key %s\n",
1161        GNUNET_h2s (key));
1162
1163   if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
1164   {
1165     GNUNET_STATISTICS_update (GDS_stats,
1166                               gettext_noop
1167                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
1168                               GNUNET_NO);
1169     return;                     /* no matching request, fast exit! */
1170   }
1171   msize =
1172       sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
1173       (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
1174   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1175   {
1176     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1177                 _("Could not pass reply to client, message too big!\n"));
1178     return;
1179   }
1180   pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
1181   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
1182   pm->msg = &reply->header;
1183   reply->header.size = htons ((uint16_t) msize);
1184   reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
1185   reply->type = htonl (type);
1186   reply->get_path_length = htonl (get_path_length);
1187   reply->put_path_length = htonl (put_path_length);
1188   reply->unique_id = 0;         /* filled in later */
1189   reply->expiration = GNUNET_TIME_absolute_hton (expiration);
1190   reply->key = *key;
1191   paths = (struct GNUNET_PeerIdentity *) &reply[1];
1192   memcpy (paths, put_path,
1193           sizeof (struct GNUNET_PeerIdentity) * put_path_length);
1194   memcpy (&paths[put_path_length], get_path,
1195           sizeof (struct GNUNET_PeerIdentity) * get_path_length);
1196   memcpy (&paths[get_path_length + put_path_length], data, data_size);
1197   frc.do_copy = GNUNET_NO;
1198   frc.pm = pm;
1199   frc.data = data;
1200   frc.data_size = data_size;
1201   frc.type = type;
1202   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
1203                                               &frc);
1204
1205   if (GNUNET_NO == frc.do_copy)
1206   {
1207     /* did not match any of the requests, free! */
1208     GNUNET_STATISTICS_update (GDS_stats,
1209                               gettext_noop
1210                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
1211                               GNUNET_NO);
1212     GNUNET_free (pm);
1213   }
1214 }
1215
1216
1217 /**
1218  * Check if some client is monitoring GET messages and notify
1219  * them in that case.
1220  *
1221  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1222  * @param type The type of data in the request.
1223  * @param hop_count Hop count so far.
1224  * @param path_length number of entries in path (or 0 if not recorded).
1225  * @param path peers on the GET path (or NULL if not recorded).
1226  * @param desired_replication_level Desired replication level.
1227  * @param key Key of the requested data.
1228  */
1229 void
1230 GDS_CLIENTS_process_get (uint32_t options,
1231                          enum GNUNET_BLOCK_Type type,
1232                          uint32_t hop_count,
1233                          uint32_t desired_replication_level,
1234                          unsigned int path_length,
1235                          const struct GNUNET_PeerIdentity *path,
1236                          const struct GNUNET_HashCode * key)
1237 {
1238   struct ClientMonitorRecord *m;
1239   struct ClientList **cl;
1240   unsigned int cl_size;
1241
1242   cl = NULL;
1243   cl_size = 0;
1244   for (m = monitor_head; NULL != m; m = m->next)
1245   {
1246     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1247         (NULL == m->key ||
1248          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1249     {
1250       struct PendingMessage *pm;
1251       struct GNUNET_DHT_MonitorGetMessage *mmsg;
1252       struct GNUNET_PeerIdentity *msg_path;
1253       size_t msize;
1254       unsigned int i;
1255
1256       /* Don't send duplicates */
1257       for (i = 0; i < cl_size; i++)
1258         if (cl[i] == m->client)
1259           break;
1260       if (i < cl_size)
1261         continue;
1262       GNUNET_array_append (cl, cl_size, m->client);
1263
1264       msize = path_length * sizeof (struct GNUNET_PeerIdentity);
1265       msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
1266       msize += sizeof (struct PendingMessage);
1267       pm = GNUNET_malloc (msize);
1268       mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
1269       pm->msg = &mmsg->header;
1270       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1271       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
1272       mmsg->options = htonl(options);
1273       mmsg->type = htonl(type);
1274       mmsg->hop_count = htonl(hop_count);
1275       mmsg->desired_replication_level = htonl(desired_replication_level);
1276       mmsg->get_path_length = htonl(path_length);
1277       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
1278       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1279       if (path_length > 0)
1280         memcpy (msg_path, path,
1281                 path_length * sizeof (struct GNUNET_PeerIdentity));
1282       add_pending_message (m->client, pm);
1283     }
1284   }
1285   GNUNET_free_non_null (cl);
1286 }
1287
1288
1289 /**
1290  * Check if some client is monitoring GET RESP messages and notify
1291  * them in that case.
1292  *
1293  * @param type The type of data in the result.
1294  * @param get_path Peers on GET path (or NULL if not recorded).
1295  * @param get_path_length number of entries in get_path.
1296  * @param put_path peers on the PUT path (or NULL if not recorded).
1297  * @param put_path_length number of entries in get_path.
1298  * @param exp Expiration time of the data.
1299  * @param key Key of the data.
1300  * @param data Pointer to the result data.
1301  * @param size Number of bytes in data.
1302  */
1303 void
1304 GDS_CLIENTS_process_get_resp (enum GNUNET_BLOCK_Type type,
1305                               const struct GNUNET_PeerIdentity *get_path,
1306                               unsigned int get_path_length,
1307                               const struct GNUNET_PeerIdentity *put_path,
1308                               unsigned int put_path_length,
1309                               struct GNUNET_TIME_Absolute exp,
1310                               const struct GNUNET_HashCode * key,
1311                               const void *data,
1312                               size_t size)
1313 {
1314   struct ClientMonitorRecord *m;
1315   struct ClientList **cl;
1316   unsigned int cl_size;
1317
1318   cl = NULL;
1319   cl_size = 0;
1320   for (m = monitor_head; NULL != m; m = m->next)
1321   {
1322     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1323         (NULL == m->key ||
1324          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1325     {
1326       struct PendingMessage *pm;
1327       struct GNUNET_DHT_MonitorGetRespMessage *mmsg;
1328       struct GNUNET_PeerIdentity *path;
1329       size_t msize;
1330       unsigned int i;
1331
1332       /* Don't send duplicates */
1333       for (i = 0; i < cl_size; i++)
1334         if (cl[i] == m->client)
1335           break;
1336       if (i < cl_size)
1337         continue;
1338       GNUNET_array_append (cl, cl_size, m->client);
1339
1340       msize = size;
1341       msize += (get_path_length + put_path_length)
1342                * sizeof (struct GNUNET_PeerIdentity);
1343       msize += sizeof (struct GNUNET_DHT_MonitorGetRespMessage);
1344       msize += sizeof (struct PendingMessage);
1345       pm = GNUNET_malloc (msize);
1346       mmsg = (struct GNUNET_DHT_MonitorGetRespMessage *) &pm[1];
1347       pm->msg = (struct GNUNET_MessageHeader *) mmsg;
1348       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1349       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET_RESP);
1350       mmsg->type = htonl(type);
1351       mmsg->put_path_length = htonl(put_path_length);
1352       mmsg->get_path_length = htonl(get_path_length);
1353       path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1354       if (put_path_length > 0)
1355       {
1356         memcpy (path, put_path,
1357                 put_path_length * sizeof (struct GNUNET_PeerIdentity));
1358         path = &path[put_path_length];
1359       }
1360       if (get_path_length > 0)
1361         memcpy (path, get_path,
1362                 get_path_length * sizeof (struct GNUNET_PeerIdentity));
1363       mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
1364       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
1365       if (size > 0)
1366         memcpy (&path[get_path_length], data, size);
1367       add_pending_message (m->client, pm);
1368     }
1369   }
1370   GNUNET_free_non_null (cl);
1371 }
1372
1373
1374 /**
1375  * Check if some client is monitoring PUT messages and notify
1376  * them in that case.
1377  *
1378  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1379  * @param type The type of data in the request.
1380  * @param hop_count Hop count so far.
1381  * @param path_length number of entries in path (or 0 if not recorded).
1382  * @param path peers on the PUT path (or NULL if not recorded).
1383  * @param desired_replication_level Desired replication level.
1384  * @param exp Expiration time of the data.
1385  * @param key Key under which data is to be stored.
1386  * @param data Pointer to the data carried.
1387  * @param size Number of bytes in data.
1388  */
1389 void
1390 GDS_CLIENTS_process_put (uint32_t options,
1391                          enum GNUNET_BLOCK_Type type,
1392                          uint32_t hop_count,
1393                          uint32_t desired_replication_level,
1394                          unsigned int path_length,
1395                          const struct GNUNET_PeerIdentity *path,
1396                          struct GNUNET_TIME_Absolute exp,
1397                          const struct GNUNET_HashCode * key,
1398                          const void *data,
1399                          size_t size)
1400 {
1401   struct ClientMonitorRecord *m;
1402   struct ClientList **cl;
1403   unsigned int cl_size;
1404
1405   cl = NULL;
1406   cl_size = 0;
1407   for (m = monitor_head; NULL != m; m = m->next)
1408   {
1409     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1410         (NULL == m->key ||
1411          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1412     {
1413       struct PendingMessage *pm;
1414       struct GNUNET_DHT_MonitorPutMessage *mmsg;
1415       struct GNUNET_PeerIdentity *msg_path;
1416       size_t msize;
1417       unsigned int i;
1418
1419       /* Don't send duplicates */
1420       for (i = 0; i < cl_size; i++)
1421         if (cl[i] == m->client)
1422           break;
1423       if (i < cl_size)
1424         continue;
1425       GNUNET_array_append (cl, cl_size, m->client);
1426
1427       msize = size;
1428       msize += path_length * sizeof (struct GNUNET_PeerIdentity);
1429       msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
1430       msize += sizeof (struct PendingMessage);
1431       pm = GNUNET_malloc (msize);
1432       mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
1433       pm->msg = (struct GNUNET_MessageHeader *) mmsg;
1434       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1435       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
1436       mmsg->options = htonl(options);
1437       mmsg->type = htonl(type);
1438       mmsg->hop_count = htonl(hop_count);
1439       mmsg->desired_replication_level = htonl(desired_replication_level);
1440       mmsg->put_path_length = htonl(path_length);
1441       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1442       if (path_length > 0)
1443       {
1444         memcpy (msg_path, path,
1445                 path_length * sizeof (struct GNUNET_PeerIdentity));
1446       }
1447       mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
1448       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
1449       if (size > 0)
1450         memcpy (&msg_path[path_length], data, size);
1451       add_pending_message (m->client, pm);
1452     }
1453   }
1454   GNUNET_free_non_null (cl);
1455 }
1456
1457
1458 /**
1459  * Initialize client subsystem.
1460  *
1461  * @param server the initialized server
1462  */
1463 void
1464 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1465 {
1466   static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1467     {&handle_dht_local_put, NULL,
1468      GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1469     {&handle_dht_local_get, NULL,
1470      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1471     {&handle_dht_local_get_stop, NULL,
1472      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1473      sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1474     {&handle_dht_local_monitor, NULL,
1475      GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1476      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1477     {&handle_dht_local_monitor_stop, NULL,
1478      GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1479      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1480     {&handle_dht_local_get_result_seen, NULL,
1481      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1482     {NULL, NULL, 0, 0}
1483   };
1484   forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1485   retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1486   GNUNET_SERVER_add_handlers (server, plugin_handlers);
1487   GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1488 }
1489
1490
1491 /**
1492  * Shutdown client subsystem.
1493  */
1494 void
1495 GDS_CLIENTS_done ()
1496 {
1497   GNUNET_assert (client_head == NULL);
1498   GNUNET_assert (client_tail == NULL);
1499   if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1500   {
1501     GNUNET_SCHEDULER_cancel (retry_task);
1502     retry_task = GNUNET_SCHEDULER_NO_TASK;
1503   }
1504   if (NULL != retry_heap)
1505   {
1506     GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1507     GNUNET_CONTAINER_heap_destroy (retry_heap);
1508     retry_heap = NULL;
1509   }
1510   if (NULL != forward_map)
1511   {
1512     GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1513     GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1514     forward_map = NULL;
1515   }
1516 }
1517
1518 /* end of gnunet-service-dht_clients.c */