src/dht/gnunet-service-dht_clients.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009, 2010, 2011 GNUnet e.V.
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file dht/gnunet-service-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    * // GNUNET_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 struct GNUNET_SCHEDULER_Task * 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  */
 454 static void
 455 transmit_next_request_task (void *cls)
 456 {
 457   struct ClientQueryRecord *cqr;
 458   struct GNUNET_TIME_Relative delay;
 459
 460   retry_task = NULL;
 461   while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
 462   {
 463     cqr->hnode = NULL;
 464     delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
 465     if (delay.rel_value_us > 0)
 466     {
 467       cqr->hnode =
 468           GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
 469                                         cqr->retry_time.abs_value_us);
 470       retry_task =
 471           GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
 472                                         NULL);
 473       return;
 474     }
 475     transmit_request (cqr);
 476     cqr->hnode =
 477         GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
 478                                       cqr->retry_time.abs_value_us);
 479   }
 480 }
 481
 482
 483 /**
 484  * Handler for PUT messages.
 485  *
 486  * @param cls closure for the service
 487  * @param client the client we received this message from
 488  * @param message the actual message received
 489  */
 490 static void
 491 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
 492                       const struct GNUNET_MessageHeader *message)
 493 {
 494   const struct GNUNET_DHT_ClientPutMessage *dht_msg;
 495   struct GNUNET_CONTAINER_BloomFilter *peer_bf;
 496   uint16_t size;
 497   struct PendingMessage *pm;
 498   struct GNUNET_DHT_ClientPutConfirmationMessage *conf;
 499
 500   size = ntohs (message->size);
 501   if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
 502   {
 503     GNUNET_break (0);
 504     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 505     return;
 506   }
 507   GNUNET_STATISTICS_update (GDS_stats,
 508                             gettext_noop
 509                             ("# PUT requests received from clients"), 1,
 510                             GNUNET_NO);
 511   dht_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
 512   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "R5N CLIENT-PUT %s\n",
 513                GNUNET_h2s_full (&dht_msg->key));
 514   /* give to local clients */
 515   LOG (GNUNET_ERROR_TYPE_DEBUG,
 516        "Handling local PUT of %u-bytes for query %s\n",
 517        size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 518        GNUNET_h2s (&dht_msg->key));
 519   GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 520                             &dht_msg->key, 0, NULL, 0, NULL,
 521                             ntohl (dht_msg->type),
 522                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 523                             &dht_msg[1]);
 524   /* store locally */
 525   GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 526                             &dht_msg->key, 0, NULL, ntohl (dht_msg->type),
 527                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 528                             &dht_msg[1]);
 529   /* route to other peers */
 530   peer_bf =
 531       GNUNET_CONTAINER_bloomfilter_init (NULL, DHT_BLOOM_SIZE,
 532                                          GNUNET_CONSTANTS_BLOOMFILTER_K);
 533   GDS_NEIGHBOURS_handle_put (ntohl (dht_msg->type), ntohl (dht_msg->options),
 534                              ntohl (dht_msg->desired_replication_level),
 535                              GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 536                              0 /* hop count */ ,
 537                              peer_bf, &dht_msg->key, 0, NULL, &dht_msg[1],
 538                              size -
 539                              sizeof (struct GNUNET_DHT_ClientPutMessage));
 540   GDS_CLIENTS_process_put (ntohl (dht_msg->options),
 541                            ntohl (dht_msg->type),
 542                            0,
 543                            ntohl (dht_msg->desired_replication_level),
 544                            1,
 545                            GDS_NEIGHBOURS_get_id(),
 546                            GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 547                            &dht_msg->key,
 548                            &dht_msg[1],
 549                            size - sizeof (struct GNUNET_DHT_ClientPutMessage));
 550   GNUNET_CONTAINER_bloomfilter_free (peer_bf);
 551   pm = GNUNET_malloc (sizeof (struct PendingMessage) +
 552                       sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
 553   conf = (struct GNUNET_DHT_ClientPutConfirmationMessage *) &pm[1];
 554   conf->header.size = htons (sizeof (struct GNUNET_DHT_ClientPutConfirmationMessage));
 555   conf->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT_OK);
 556   conf->reserved = htonl (0);
 557   conf->unique_id = dht_msg->unique_id;
 558   pm->msg = &conf->header;
 559   add_pending_message (find_active_client (client), pm);
 560   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 561 }
 562
 563
 564 /**
 565  * Handler for DHT GET messages from the client.
 566  *
 567  * @param cls closure for the service
 568  * @param client the client we received this message from
 569  * @param message the actual message received
 570  */
 571 static void
 572 handle_dht_local_get (void *cls, struct GNUNET_SERVER_Client *client,
 573                       const struct GNUNET_MessageHeader *message)
 574 {
 575   const struct GNUNET_DHT_ClientGetMessage *get;
 576   struct ClientQueryRecord *cqr;
 577   size_t xquery_size;
 578   const char *xquery;
 579   uint16_t size;
 580
 581   size = ntohs (message->size);
 582   if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
 583   {
 584     GNUNET_break (0);
 585     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 586     return;
 587   }
 588   xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
 589   get = (const struct GNUNET_DHT_ClientGetMessage *) message;
 590   xquery = (const char *) &get[1];
 591   GNUNET_STATISTICS_update (GDS_stats,
 592                             gettext_noop
 593                             ("# GET requests received from clients"), 1,
 594                             GNUNET_NO);
 595   LOG (GNUNET_ERROR_TYPE_DEBUG,
 596        "Received GET request for %s from local client %p, xq: %.*s\n",
 597        GNUNET_h2s (&get->key), client, xquery_size, xquery);
 598
 599   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG, "R5N CLIENT-GET %s\n",
 600                GNUNET_h2s_full (&get->key));
 601
 602
 603   cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
 604   cqr->key = get->key;
 605   cqr->client = find_active_client (client);
 606   cqr->xquery = (void *) &cqr[1];
 607   GNUNET_memcpy (&cqr[1], xquery, xquery_size);
 608   cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
 609   cqr->retry_frequency = GNUNET_TIME_UNIT_SECONDS;
 610   cqr->retry_time = GNUNET_TIME_absolute_get ();
 611   cqr->unique_id = get->unique_id;
 612   cqr->xquery_size = xquery_size;
 613   cqr->replication = ntohl (get->desired_replication_level);
 614   cqr->msg_options = ntohl (get->options);
 615   cqr->type = ntohl (get->type);
 616   // FIXME use cqr->key, set multihashmap create to GNUNET_YES
 617   GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
 618                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 619   GDS_CLIENTS_process_get (ntohl (get->options),
 620                            ntohl (get->type),
 621                            0,
 622                            ntohl (get->desired_replication_level),
 623                            1,
 624                            GDS_NEIGHBOURS_get_id(),
 625                            &get->key);
 626   /* start remote requests */
 627   if (NULL != retry_task)
 628     GNUNET_SCHEDULER_cancel (retry_task);
 629   retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task,
 630                                          NULL);
 631   /* perform local lookup */
 632   GDS_DATACACHE_handle_get (&get->key,
 633                             cqr->type,
 634                             cqr->xquery,
 635                             xquery_size,
 636                             NULL,
 637                             0);
 638   GNUNET_SERVER_receive_done (client,
 639                               GNUNET_OK);
 640 }
 641
 642
 643 /**
 644  * Closure for 'find_by_unique_id'.
 645  */
 646 struct FindByUniqueIdContext
 647 {
 648   /**
 649    * Where to store the result, if found.
 650    */
 651   struct ClientQueryRecord *cqr;
 652
 653   uint64_t unique_id;
 654 };
 655
 656
 657 /**
 658  * Function called for each existing DHT record for the given
 659  * query.  Checks if it matches the UID given in the closure
 660  * and if so returns the entry as a result.
 661  *
 662  * @param cls the search context
 663  * @param key query for the lookup (not used)
 664  * @param value the 'struct ClientQueryRecord'
 665  * @return GNUNET_YES to continue iteration (result not yet found)
 666  */
 667 static int
 668 find_by_unique_id (void *cls,
 669                    const struct GNUNET_HashCode *key,
 670                    void *value)
 671 {
 672   struct FindByUniqueIdContext *fui_ctx = cls;
 673   struct ClientQueryRecord *cqr = value;
 674
 675   if (cqr->unique_id != fui_ctx->unique_id)
 676     return GNUNET_YES;
 677   fui_ctx->cqr = cqr;
 678   return GNUNET_NO;
 679 }
 680
 681
 682 /**
 683  * Handler for "GET result seen" messages from the client.
 684  *
 685  * @param cls closure for the service
 686  * @param client the client we received this message from
 687  * @param message the actual message received
 688  */
 689 static void
 690 handle_dht_local_get_result_seen (void *cls, struct GNUNET_SERVER_Client *client,
 691                                   const struct GNUNET_MessageHeader *message)
 692 {
 693   const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
 694   uint16_t size;
 695   unsigned int hash_count;
 696   unsigned int old_count;
 697   const struct GNUNET_HashCode *hc;
 698   struct FindByUniqueIdContext fui_ctx;
 699   struct ClientQueryRecord *cqr;
 700
 701   size = ntohs (message->size);
 702   if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
 703   {
 704     GNUNET_break (0);
 705     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 706     return;
 707   }
 708   seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
 709   hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
 710   if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
 711   {
 712     GNUNET_break (0);
 713     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 714     return;
 715   }
 716   hc = (const struct GNUNET_HashCode*) &seen[1];
 717   fui_ctx.unique_id = seen->unique_id;
 718   fui_ctx.cqr = NULL;
 719   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
 720                                               &seen->key,
 721                                               &find_by_unique_id,
 722                                               &fui_ctx);
 723   if (NULL == (cqr = fui_ctx.cqr))
 724   {
 725     GNUNET_break (0);
 726     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 727     return;
 728   }
 729   /* finally, update 'seen' list */
 730   old_count = cqr->seen_replies_count;
 731   GNUNET_array_grow (cqr->seen_replies,
 732                      cqr->seen_replies_count,
 733                      cqr->seen_replies_count + hash_count);
 734   GNUNET_memcpy (&cqr->seen_replies[old_count],
 735           hc,
 736           sizeof (struct GNUNET_HashCode) * hash_count);
 737 }
 738
 739
 740 /**
 741  * Closure for 'remove_by_unique_id'.
 742  */
 743 struct RemoveByUniqueIdContext
 744 {
 745   /**
 746    * Client that issued the removal request.
 747    */
 748   struct ClientList *client;
 749
 750   /**
 751    * Unique ID of the request.
 752    */
 753   uint64_t unique_id;
 754 };
 755
 756
 757 /**
 758  * Iterator over hash map entries that frees all entries
 759  * that match the given client and unique ID.
 760  *
 761  * @param cls unique ID and client to search for in source routes
 762  * @param key current key code
 763  * @param value value in the hash map, a ClientQueryRecord
 764  * @return GNUNET_YES (we should continue to iterate)
 765  */
 766 static int
 767 remove_by_unique_id (void *cls, const struct GNUNET_HashCode * key, void *value)
 768 {
 769   const struct RemoveByUniqueIdContext *ctx = cls;
 770   struct ClientQueryRecord *record = value;
 771
 772   if (record->unique_id != ctx->unique_id)
 773     return GNUNET_YES;
 774   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 775               "Removing client %p's record for key %s (by unique id)\n",
 776               ctx->client->client_handle, GNUNET_h2s (key));
 777   return remove_client_records (ctx->client, key, record);
 778 }
 779
 780
 781 /**
 782  * Handler for any generic DHT stop messages, calls the appropriate handler
 783  * depending on message type (if processed locally)
 784  *
 785  * @param cls closure for the service
 786  * @param client the client we received this message from
 787  * @param message the actual message received
 788  *
 789  */
 790 static void
 791 handle_dht_local_get_stop (void *cls,
 792                            struct GNUNET_SERVER_Client *client,
 793                            const struct GNUNET_MessageHeader *message)
 794 {
 795   const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
 796       (const struct GNUNET_DHT_ClientGetStopMessage *) message;
 797   struct RemoveByUniqueIdContext ctx;
 798
 799   GNUNET_STATISTICS_update (GDS_stats,
 800                             gettext_noop
 801                             ("# GET STOP requests received from clients"), 1,
 802                             GNUNET_NO);
 803   LOG (GNUNET_ERROR_TYPE_DEBUG,
 804        "Received GET STOP request for %s from local client %p\n",
 805        GNUNET_h2s (&dht_stop_msg->key),
 806        client);
 807   ctx.client = find_active_client (client);
 808   ctx.unique_id = dht_stop_msg->unique_id;
 809   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
 810                                               &remove_by_unique_id, &ctx);
 811   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 812 }
 813
 814
 815 /**
 816  * Handler for monitor start messages
 817  *
 818  * @param cls closure for the service
 819  * @param client the client we received this message from
 820  * @param message the actual message received
 821  *
 822  */
 823 static void
 824 handle_dht_local_monitor (void *cls, struct GNUNET_SERVER_Client *client,
 825                           const struct GNUNET_MessageHeader *message)
 826 {
 827   struct ClientMonitorRecord *r;
 828   const struct GNUNET_DHT_MonitorStartStopMessage *msg;
 829
 830   msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
 831   r = GNUNET_new (struct ClientMonitorRecord);
 832
 833   r->client = find_active_client(client);
 834   r->type = ntohl(msg->type);
 835   r->get = ntohs(msg->get);
 836   r->get_resp = ntohs(msg->get_resp);
 837   r->put = ntohs(msg->put);
 838   if (0 == ntohs(msg->filter_key))
 839       r->key = NULL;
 840   else
 841   {
 842     r->key = GNUNET_new (struct GNUNET_HashCode);
 843     GNUNET_memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
 844   }
 845   GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
 846   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 847 }
 848
 849
 850 /**
 851  * Handler for monitor stop messages
 852  *
 853  * @param cls closure for the service
 854  * @param client the client we received this message from
 855  * @param message the actual message received
 856  *
 857  */
 858 static void
 859 handle_dht_local_monitor_stop (void *cls, struct GNUNET_SERVER_Client *client,
 860                                const struct GNUNET_MessageHeader *message)
 861 {
 862   struct ClientMonitorRecord *r;
 863   const struct GNUNET_DHT_MonitorStartStopMessage *msg;
 864   int keys_match;
 865
 866   msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
 867   r = monitor_head;
 868
 869   while (NULL != r)
 870   {
 871     if (NULL == r->key)
 872         keys_match = (0 == ntohs(msg->filter_key));
 873     else
 874     {
 875         keys_match = (0 != ntohs(msg->filter_key)
 876                       && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
 877     }
 878     if (find_active_client(client) == r->client
 879         && ntohl(msg->type) == r->type
 880         && r->get == msg->get
 881         && r->get_resp == msg->get_resp
 882         && r->put == msg->put
 883         && keys_match
 884         )
 885     {
 886         GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
 887         GNUNET_free_non_null (r->key);
 888         GNUNET_free (r);
 889         GNUNET_SERVER_receive_done (client, GNUNET_OK);
 890         return; /* Delete only ONE entry */
 891     }
 892     r = r->next;
 893   }
 894
 895   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 896 }
 897
 898
 899 /**
 900  * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
 901  * request.  A ClientList is passed as closure, take the head of the list
 902  * and copy it into buf, which has the result of sending the message to the
 903  * client.
 904  *
 905  * @param cls closure to this call
 906  * @param size maximum number of bytes available to send
 907  * @param buf where to copy the actual message to
 908  *
 909  * @return the number of bytes actually copied, 0 indicates failure
 910  */
 911 static size_t
 912 send_reply_to_client (void *cls, size_t size, void *buf)
 913 {
 914   struct ClientList *client = cls;
 915   char *cbuf = buf;
 916   struct PendingMessage *reply;
 917   size_t off;
 918   size_t msize;
 919
 920   client->transmit_handle = NULL;
 921   if (buf == NULL)
 922   {
 923     /* client disconnected */
 924     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 925                 "Client %p disconnected, pending messages will be discarded\n",
 926                 client->client_handle);
 927     return 0;
 928   }
 929   off = 0;
 930   while ((NULL != (reply = client->pending_head)) &&
 931          (size >= off + (msize = ntohs (reply->msg->size))))
 932   {
 933     GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
 934                                  reply);
 935     GNUNET_memcpy (&cbuf[off], reply->msg, msize);
 936     GNUNET_free (reply);
 937     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 938                 "Transmitting %u bytes to client %p\n",
 939                 (unsigned int) msize,
 940                 client->client_handle);
 941     off += msize;
 942   }
 943   process_pending_messages (client);
 944   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 945               "Transmitted %u/%u bytes to client %p\n",
 946               (unsigned int) off,
 947               (unsigned int) size,
 948               client->client_handle);
 949   return off;
 950 }
 951
 952
 953 /**
 954  * Task run to check for messages that need to be sent to a client.
 955  *
 956  * @param client a ClientList, containing the client and any messages to be sent to it
 957  */
 958 static void
 959 process_pending_messages (struct ClientList *client)
 960 {
 961   if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
 962   {
 963     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 964                 "Not asking for transmission to %p now: %s\n",
 965                 client->client_handle,
 966                 client->pending_head ==
 967                 NULL ? "no more messages" : "request already pending");
 968     return;
 969   }
 970   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 971               "Asking for transmission of %u bytes to client %p\n",
 972               ntohs (client->pending_head->msg->size), client->client_handle);
 973   client->transmit_handle =
 974       GNUNET_SERVER_notify_transmit_ready (client->client_handle,
 975                                            ntohs (client->pending_head->
 976                                                   msg->size),
 977                                            GNUNET_TIME_UNIT_FOREVER_REL,
 978                                            &send_reply_to_client, client);
 979 }
 980
 981
 982 /**
 983  * Closure for #forward_reply()
 984  */
 985 struct ForwardReplyContext
 986 {
 987
 988   /**
 989    * Actual message to send to matching clients.
 990    */
 991   struct PendingMessage *pm;
 992
 993   /**
 994    * Embedded payload.
 995    */
 996   const void *data;
 997
 998   /**
 999    * Type of the data.
1000    */
1001   enum GNUNET_BLOCK_Type type;
1002
1003   /**
1004    * Number of bytes in data.
1005    */
1006   size_t data_size;
1007
1008   /**
1009    * Do we need to copy @a pm because it was already used?
1010    */
1011   int do_copy;
1012
1013 };
1014
1015
1016 /**
1017  * Iterator over hash map entries that send a given reply to
1018  * each of the matching clients.  With some tricky recycling
1019  * of the buffer.
1020  *
1021  * @param cls the 'struct ForwardReplyContext'
1022  * @param key current key
1023  * @param value value in the hash map, a ClientQueryRecord
1024  * @return #GNUNET_YES (we should continue to iterate),
1025  *         if the result is mal-formed, #GNUNET_NO
1026  */
1027 static int
1028 forward_reply (void *cls,
1029                const struct GNUNET_HashCode *key,
1030                void *value)
1031 {
1032   struct ForwardReplyContext *frc = cls;
1033   struct ClientQueryRecord *record = value;
1034   struct PendingMessage *pm;
1035   struct GNUNET_DHT_ClientResultMessage *reply;
1036   enum GNUNET_BLOCK_EvaluationResult eval;
1037   int do_free;
1038   struct GNUNET_HashCode ch;
1039   unsigned int i;
1040
1041   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
1042                "R5N CLIENT-RESULT %s\n",
1043                GNUNET_h2s_full (key));
1044   if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
1045   {
1046     LOG (GNUNET_ERROR_TYPE_DEBUG,
1047          "Record type missmatch, not passing request for key %s to local client\n",
1048          GNUNET_h2s (key));
1049     GNUNET_STATISTICS_update (GDS_stats,
1050                               gettext_noop
1051                               ("# Key match, type mismatches in REPLY to CLIENT"),
1052                               1, GNUNET_NO);
1053     return GNUNET_YES;          /* type mismatch */
1054   }
1055   GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
1056   for (i = 0; i < record->seen_replies_count; i++)
1057     if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
1058     {
1059       LOG (GNUNET_ERROR_TYPE_DEBUG,
1060            "Duplicate reply, not passing request for key %s to local client\n",
1061            GNUNET_h2s (key));
1062       GNUNET_STATISTICS_update (GDS_stats,
1063                                 gettext_noop
1064                                 ("# Duplicate REPLIES to CLIENT request dropped"),
1065                                 1, GNUNET_NO);
1066       return GNUNET_YES;        /* duplicate */
1067     }
1068   eval =
1069       GNUNET_BLOCK_evaluate (GDS_block_context,
1070                              record->type,
1071                              GNUNET_BLOCK_EO_NONE,
1072                              key,
1073                              NULL,
1074                              0,
1075                              record->xquery,
1076                              record->xquery_size,
1077                              frc->data,
1078                              frc->data_size);
1079   LOG (GNUNET_ERROR_TYPE_DEBUG,
1080        "Evaluation result is %d for key %s for local client's query\n",
1081        (int) eval,
1082        GNUNET_h2s (key));
1083   switch (eval)
1084   {
1085   case GNUNET_BLOCK_EVALUATION_OK_LAST:
1086     do_free = GNUNET_YES;
1087     break;
1088   case GNUNET_BLOCK_EVALUATION_OK_MORE:
1089     GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
1090     do_free = GNUNET_NO;
1091     break;
1092   case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
1093     /* should be impossible to encounter here */
1094     GNUNET_break (0);
1095     return GNUNET_YES;
1096   case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
1097     GNUNET_break_op (0);
1098     return GNUNET_NO;
1099   case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
1100     GNUNET_break (0);
1101     return GNUNET_NO;
1102   case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
1103     GNUNET_break (0);
1104     return GNUNET_NO;
1105   case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
1106     return GNUNET_YES;
1107   case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
1108     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1109                 _("Unsupported block type (%u) in request!\n"), record->type);
1110     return GNUNET_NO;
1111   default:
1112     GNUNET_break (0);
1113     return GNUNET_NO;
1114   }
1115   if (GNUNET_NO == frc->do_copy)
1116   {
1117     /* first time, we can use the original data */
1118     pm = frc->pm;
1119     frc->do_copy = GNUNET_YES;
1120   }
1121   else
1122   {
1123     /* two clients waiting for same reply, must copy for queueing */
1124     pm = GNUNET_malloc (sizeof (struct PendingMessage) +
1125                         ntohs (frc->pm->msg->size));
1126     GNUNET_memcpy (pm, frc->pm,
1127             sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
1128     pm->next = pm->prev = NULL;
1129     pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
1130   }
1131   GNUNET_STATISTICS_update (GDS_stats,
1132                             gettext_noop ("# RESULTS queued for clients"), 1,
1133                             GNUNET_NO);
1134   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
1135   reply->unique_id = record->unique_id;
1136   LOG (GNUNET_ERROR_TYPE_DEBUG,
1137        "Queueing reply to query %s for client %p\n",
1138        GNUNET_h2s (key),
1139        record->client->client_handle);
1140   add_pending_message (record->client, pm);
1141   if (GNUNET_YES == do_free)
1142     remove_client_records (record->client, key, record);
1143   return GNUNET_YES;
1144 }
1145
1146
1147 /**
1148  * Handle a reply we've received from another peer.  If the reply
1149  * matches any of our pending queries, forward it to the respective
1150  * client(s).
1151  *
1152  * @param expiration when will the reply expire
1153  * @param key the query this reply is for
1154  * @param get_path_length number of peers in @a get_path
1155  * @param get_path path the reply took on get
1156  * @param put_path_length number of peers in @a put_path
1157  * @param put_path path the reply took on put
1158  * @param type type of the reply
1159  * @param data_size number of bytes in @a data
1160  * @param data application payload data
1161  */
1162 void
1163 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
1164                           const struct GNUNET_HashCode *key,
1165                           unsigned int get_path_length,
1166                           const struct GNUNET_PeerIdentity *get_path,
1167                           unsigned int put_path_length,
1168                           const struct GNUNET_PeerIdentity *put_path,
1169                           enum GNUNET_BLOCK_Type type, size_t data_size,
1170                           const void *data)
1171 {
1172   struct ForwardReplyContext frc;
1173   struct PendingMessage *pm;
1174   struct GNUNET_DHT_ClientResultMessage *reply;
1175   struct GNUNET_PeerIdentity *paths;
1176   size_t msize;
1177
1178   if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
1179   {
1180     LOG (GNUNET_ERROR_TYPE_DEBUG,
1181          "No matching client for reply for key %s\n",
1182          GNUNET_h2s (key));
1183     GNUNET_STATISTICS_update (GDS_stats,
1184                               gettext_noop
1185                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
1186                               GNUNET_NO);
1187     return;                     /* no matching request, fast exit! */
1188   }
1189   msize =
1190       sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
1191       (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
1192   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1193   {
1194     GNUNET_break (0);
1195     return;
1196   }
1197   LOG (GNUNET_ERROR_TYPE_DEBUG,
1198        "Forwarding reply for key %s to client\n",
1199        GNUNET_h2s (key));
1200
1201   pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
1202   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
1203   pm->msg = &reply->header;
1204   reply->header.size = htons ((uint16_t) msize);
1205   reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
1206   reply->type = htonl (type);
1207   reply->get_path_length = htonl (get_path_length);
1208   reply->put_path_length = htonl (put_path_length);
1209   reply->unique_id = 0;         /* filled in later */
1210   reply->expiration = GNUNET_TIME_absolute_hton (expiration);
1211   reply->key = *key;
1212   paths = (struct GNUNET_PeerIdentity *) &reply[1];
1213   GNUNET_memcpy (paths, put_path,
1214           sizeof (struct GNUNET_PeerIdentity) * put_path_length);
1215   GNUNET_memcpy (&paths[put_path_length], get_path,
1216           sizeof (struct GNUNET_PeerIdentity) * get_path_length);
1217   GNUNET_memcpy (&paths[get_path_length + put_path_length], data, data_size);
1218   frc.do_copy = GNUNET_NO;
1219   frc.pm = pm;
1220   frc.data = data;
1221   frc.data_size = data_size;
1222   frc.type = type;
1223   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
1224                                               key,
1225                                               &forward_reply,
1226                                               &frc);
1227
1228   if (GNUNET_NO == frc.do_copy)
1229   {
1230     /* did not match any of the requests, free! */
1231     GNUNET_STATISTICS_update (GDS_stats,
1232                               gettext_noop
1233                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
1234                               GNUNET_NO);
1235     GNUNET_free (pm);
1236   }
1237 }
1238
1239
1240 /**
1241  * Check if some client is monitoring GET messages and notify
1242  * them in that case.
1243  *
1244  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1245  * @param type The type of data in the request.
1246  * @param hop_count Hop count so far.
1247  * @param path_length number of entries in path (or 0 if not recorded).
1248  * @param path peers on the GET path (or NULL if not recorded).
1249  * @param desired_replication_level Desired replication level.
1250  * @param key Key of the requested data.
1251  */
1252 void
1253 GDS_CLIENTS_process_get (uint32_t options,
1254                          enum GNUNET_BLOCK_Type type,
1255                          uint32_t hop_count,
1256                          uint32_t desired_replication_level,
1257                          unsigned int path_length,
1258                          const struct GNUNET_PeerIdentity *path,
1259                          const struct GNUNET_HashCode * key)
1260 {
1261   struct ClientMonitorRecord *m;
1262   struct ClientList **cl;
1263   unsigned int cl_size;
1264
1265   cl = NULL;
1266   cl_size = 0;
1267   for (m = monitor_head; NULL != m; m = m->next)
1268   {
1269     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1270         (NULL == m->key ||
1271          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1272     {
1273       struct PendingMessage *pm;
1274       struct GNUNET_DHT_MonitorGetMessage *mmsg;
1275       struct GNUNET_PeerIdentity *msg_path;
1276       size_t msize;
1277       unsigned int i;
1278
1279       /* Don't send duplicates */
1280       for (i = 0; i < cl_size; i++)
1281         if (cl[i] == m->client)
1282           break;
1283       if (i < cl_size)
1284         continue;
1285       GNUNET_array_append (cl, cl_size, m->client);
1286
1287       msize = path_length * sizeof (struct GNUNET_PeerIdentity);
1288       msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
1289       msize += sizeof (struct PendingMessage);
1290       pm = GNUNET_malloc (msize);
1291       mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
1292       pm->msg = &mmsg->header;
1293       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1294       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
1295       mmsg->options = htonl(options);
1296       mmsg->type = htonl(type);
1297       mmsg->hop_count = htonl(hop_count);
1298       mmsg->desired_replication_level = htonl(desired_replication_level);
1299       mmsg->get_path_length = htonl(path_length);
1300       GNUNET_memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
1301       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1302       if (path_length > 0)
1303         GNUNET_memcpy (msg_path, path,
1304                 path_length * sizeof (struct GNUNET_PeerIdentity));
1305       add_pending_message (m->client, pm);
1306     }
1307   }
1308   GNUNET_free_non_null (cl);
1309 }
1310
1311
1312 /**
1313  * Check if some client is monitoring GET RESP messages and notify
1314  * them in that case.
1315  *
1316  * @param type The type of data in the result.
1317  * @param get_path Peers on GET path (or NULL if not recorded).
1318  * @param get_path_length number of entries in get_path.
1319  * @param put_path peers on the PUT path (or NULL if not recorded).
1320  * @param put_path_length number of entries in get_path.
1321  * @param exp Expiration time of the data.
1322  * @param key Key of the data.
1323  * @param data Pointer to the result data.
1324  * @param size Number of bytes in @a data.
1325  */
1326 void
1327 GDS_CLIENTS_process_get_resp (enum GNUNET_BLOCK_Type type,
1328                               const struct GNUNET_PeerIdentity *get_path,
1329                               unsigned int get_path_length,
1330                               const struct GNUNET_PeerIdentity *put_path,
1331                               unsigned int put_path_length,
1332                               struct GNUNET_TIME_Absolute exp,
1333                               const struct GNUNET_HashCode * key,
1334                               const void *data,
1335                               size_t size)
1336 {
1337   struct ClientMonitorRecord *m;
1338   struct ClientList **cl;
1339   unsigned int cl_size;
1340
1341   cl = NULL;
1342   cl_size = 0;
1343   for (m = monitor_head; NULL != m; m = m->next)
1344   {
1345     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1346         (NULL == m->key ||
1347          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1348     {
1349       struct PendingMessage *pm;
1350       struct GNUNET_DHT_MonitorGetRespMessage *mmsg;
1351       struct GNUNET_PeerIdentity *path;
1352       size_t msize;
1353       unsigned int i;
1354
1355       /* Don't send duplicates */
1356       for (i = 0; i < cl_size; i++)
1357         if (cl[i] == m->client)
1358           break;
1359       if (i < cl_size)
1360         continue;
1361       GNUNET_array_append (cl, cl_size, m->client);
1362
1363       msize = size;
1364       msize += (get_path_length + put_path_length)
1365                * sizeof (struct GNUNET_PeerIdentity);
1366       msize += sizeof (struct GNUNET_DHT_MonitorGetRespMessage);
1367       msize += sizeof (struct PendingMessage);
1368       pm = GNUNET_malloc (msize);
1369       mmsg = (struct GNUNET_DHT_MonitorGetRespMessage *) &pm[1];
1370       pm->msg = (struct GNUNET_MessageHeader *) mmsg;
1371       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1372       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET_RESP);
1373       mmsg->type = htonl(type);
1374       mmsg->put_path_length = htonl(put_path_length);
1375       mmsg->get_path_length = htonl(get_path_length);
1376       path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1377       if (put_path_length > 0)
1378       {
1379         GNUNET_memcpy (path, put_path,
1380                 put_path_length * sizeof (struct GNUNET_PeerIdentity));
1381         path = &path[put_path_length];
1382       }
1383       if (get_path_length > 0)
1384         GNUNET_memcpy (path, get_path,
1385                 get_path_length * sizeof (struct GNUNET_PeerIdentity));
1386       mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
1387       GNUNET_memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
1388       if (size > 0)
1389         GNUNET_memcpy (&path[get_path_length], data, size);
1390       add_pending_message (m->client, pm);
1391     }
1392   }
1393   GNUNET_free_non_null (cl);
1394 }
1395
1396
1397 /**
1398  * Check if some client is monitoring PUT messages and notify
1399  * them in that case.
1400  *
1401  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1402  * @param type The type of data in the request.
1403  * @param hop_count Hop count so far.
1404  * @param path_length number of entries in path (or 0 if not recorded).
1405  * @param path peers on the PUT path (or NULL if not recorded).
1406  * @param desired_replication_level Desired replication level.
1407  * @param exp Expiration time of the data.
1408  * @param key Key under which data is to be stored.
1409  * @param data Pointer to the data carried.
1410  * @param size Number of bytes in data.
1411  */
1412 void
1413 GDS_CLIENTS_process_put (uint32_t options,
1414                          enum GNUNET_BLOCK_Type type,
1415                          uint32_t hop_count,
1416                          uint32_t desired_replication_level,
1417                          unsigned int path_length,
1418                          const struct GNUNET_PeerIdentity *path,
1419                          struct GNUNET_TIME_Absolute exp,
1420                          const struct GNUNET_HashCode *key,
1421                          const void *data,
1422                          size_t size)
1423 {
1424   struct ClientMonitorRecord *m;
1425   struct ClientList **cl;
1426   unsigned int cl_size;
1427
1428   cl = NULL;
1429   cl_size = 0;
1430   for (m = monitor_head; NULL != m; m = m->next)
1431   {
1432     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1433         (NULL == m->key ||
1434          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1435     {
1436       struct PendingMessage *pm;
1437       struct GNUNET_DHT_MonitorPutMessage *mmsg;
1438       struct GNUNET_PeerIdentity *msg_path;
1439       size_t msize;
1440       unsigned int i;
1441
1442       /* Don't send duplicates */
1443       for (i = 0; i < cl_size; i++)
1444         if (cl[i] == m->client)
1445           break;
1446       if (i < cl_size)
1447         continue;
1448       GNUNET_array_append (cl, cl_size, m->client);
1449
1450       msize = size;
1451       msize += path_length * sizeof (struct GNUNET_PeerIdentity);
1452       msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
1453       msize += sizeof (struct PendingMessage);
1454       pm = GNUNET_malloc (msize);
1455       mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
1456       pm->msg = (struct GNUNET_MessageHeader *) mmsg;
1457       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1458       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
1459       mmsg->options = htonl(options);
1460       mmsg->type = htonl(type);
1461       mmsg->hop_count = htonl(hop_count);
1462       mmsg->desired_replication_level = htonl(desired_replication_level);
1463       mmsg->put_path_length = htonl(path_length);
1464       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1465       if (path_length > 0)
1466       {
1467         GNUNET_memcpy (msg_path,
1468                        path,
1469                        path_length * sizeof (struct GNUNET_PeerIdentity));
1470       }
1471       mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
1472       GNUNET_memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
1473       if (size > 0)
1474         GNUNET_memcpy (&msg_path[path_length], data, size);
1475       add_pending_message (m->client, pm);
1476     }
1477   }
1478   GNUNET_free_non_null (cl);
1479 }
1480
1481
1482 /**
1483  * Initialize client subsystem.
1484  *
1485  * @param server the initialized server
1486  */
1487 void
1488 GDS_CLIENTS_init ()
1489 {
1490   static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1491     {&handle_dht_local_put, NULL,
1492      GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1493     {&handle_dht_local_get, NULL,
1494      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1495     {&handle_dht_local_get_stop, NULL,
1496      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1497      sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1498     {&handle_dht_local_monitor, NULL,
1499      GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1500      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1501     {&handle_dht_local_monitor_stop, NULL,
1502      GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1503      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1504     {&handle_dht_local_get_result_seen, NULL,
1505      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1506     {NULL, NULL, 0, 0}
1507   };
1508
1509   forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1510   retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1511   GNUNET_SERVER_resume (GDS_server);
1512   GNUNET_SERVER_add_handlers (GDS_server,
1513                               plugin_handlers);
1514   GNUNET_SERVER_disconnect_notify (GDS_server,
1515                                    &handle_client_disconnect,
1516                                    NULL);
1517 }
1518
1519
1520 /**
1521  * Shutdown client subsystem.
1522  */
1523 void
1524 GDS_CLIENTS_stop ()
1525 {
1526   if (NULL != retry_task)
1527   {
1528     GNUNET_SCHEDULER_cancel (retry_task);
1529     retry_task = NULL;
1530   }
1531 }
1532
1533
1534 /**
1535  * Shutdown client subsystem.
1536  */
1537 void
1538 GDS_CLIENTS_done ()
1539 {
1540   GNUNET_assert (NULL == client_head);
1541   GNUNET_assert (NULL == client_tail);
1542   if (NULL != retry_heap)
1543   {
1544     GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1545     GNUNET_CONTAINER_heap_destroy (retry_heap);
1546     retry_heap = NULL;
1547   }
1548   if (NULL != forward_map)
1549   {
1550     GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1551     GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1552     forward_map = NULL;
1553   }
1554 }
1555
1556 /* end of gnunet-service-dht_clients.c */