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    * // 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   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, NULL);
 630   /* perform local lookup */
 631   GDS_DATACACHE_handle_get (&get->key, cqr->type, cqr->xquery, xquery_size,
 632                             NULL, 0);
 633   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 634 }
 635
 636
 637 /**
 638  * Closure for 'find_by_unique_id'.
 639  */
 640 struct FindByUniqueIdContext
 641 {
 642   /**
 643    * Where to store the result, if found.
 644    */
 645   struct ClientQueryRecord *cqr;
 646
 647   uint64_t unique_id;
 648 };
 649
 650
 651 /**
 652  * Function called for each existing DHT record for the given
 653  * query.  Checks if it matches the UID given in the closure
 654  * and if so returns the entry as a result.
 655  *
 656  * @param cls the search context
 657  * @param key query for the lookup (not used)
 658  * @param value the 'struct ClientQueryRecord'
 659  * @return GNUNET_YES to continue iteration (result not yet found)
 660  */
 661 static int
 662 find_by_unique_id (void *cls,
 663                    const struct GNUNET_HashCode *key,
 664                    void *value)
 665 {
 666   struct FindByUniqueIdContext *fui_ctx = cls;
 667   struct ClientQueryRecord *cqr = value;
 668
 669   if (cqr->unique_id != fui_ctx->unique_id)
 670     return GNUNET_YES;
 671   fui_ctx->cqr = cqr;
 672   return GNUNET_NO;
 673 }
 674
 675
 676 /**
 677  * Handler for "GET result seen" messages from the client.
 678  *
 679  * @param cls closure for the service
 680  * @param client the client we received this message from
 681  * @param message the actual message received
 682  */
 683 static void
 684 handle_dht_local_get_result_seen (void *cls, struct GNUNET_SERVER_Client *client,
 685                                   const struct GNUNET_MessageHeader *message)
 686 {
 687   const struct GNUNET_DHT_ClientGetResultSeenMessage *seen;
 688   uint16_t size;
 689   unsigned int hash_count;
 690   unsigned int old_count;
 691   const struct GNUNET_HashCode *hc;
 692   struct FindByUniqueIdContext fui_ctx;
 693   struct ClientQueryRecord *cqr;
 694
 695   size = ntohs (message->size);
 696   if (size < sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage))
 697   {
 698     GNUNET_break (0);
 699     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 700     return;
 701   }
 702   seen = (const struct GNUNET_DHT_ClientGetResultSeenMessage *) message;
 703   hash_count = (size - sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage)) / sizeof (struct GNUNET_HashCode);
 704   if (size != sizeof (struct GNUNET_DHT_ClientGetResultSeenMessage) + hash_count * sizeof (struct GNUNET_HashCode))
 705   {
 706     GNUNET_break (0);
 707     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 708     return;
 709   }
 710   hc = (const struct GNUNET_HashCode*) &seen[1];
 711   fui_ctx.unique_id = seen->unique_id;
 712   fui_ctx.cqr = NULL;
 713   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
 714                                               &seen->key,
 715                                               &find_by_unique_id,
 716                                               &fui_ctx);
 717   if (NULL == (cqr = fui_ctx.cqr))
 718   {
 719     GNUNET_break (0);
 720     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 721     return;
 722   }
 723   /* finally, update 'seen' list */
 724   old_count = cqr->seen_replies_count;
 725   GNUNET_array_grow (cqr->seen_replies,
 726                      cqr->seen_replies_count,
 727                      cqr->seen_replies_count + hash_count);
 728   memcpy (&cqr->seen_replies[old_count],
 729           hc,
 730           sizeof (struct GNUNET_HashCode) * hash_count);
 731 }
 732
 733
 734 /**
 735  * Closure for 'remove_by_unique_id'.
 736  */
 737 struct RemoveByUniqueIdContext
 738 {
 739   /**
 740    * Client that issued the removal request.
 741    */
 742   struct ClientList *client;
 743
 744   /**
 745    * Unique ID of the request.
 746    */
 747   uint64_t unique_id;
 748 };
 749
 750
 751 /**
 752  * Iterator over hash map entries that frees all entries
 753  * that match the given client and unique ID.
 754  *
 755  * @param cls unique ID and client to search for in source routes
 756  * @param key current key code
 757  * @param value value in the hash map, a ClientQueryRecord
 758  * @return GNUNET_YES (we should continue to iterate)
 759  */
 760 static int
 761 remove_by_unique_id (void *cls, const struct GNUNET_HashCode * key, void *value)
 762 {
 763   const struct RemoveByUniqueIdContext *ctx = cls;
 764   struct ClientQueryRecord *record = value;
 765
 766   if (record->unique_id != ctx->unique_id)
 767     return GNUNET_YES;
 768   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 769               "Removing client %p's record for key %s (by unique id)\n",
 770               ctx->client->client_handle, GNUNET_h2s (key));
 771   return remove_client_records (ctx->client, key, record);
 772 }
 773
 774
 775 /**
 776  * Handler for any generic DHT stop messages, calls the appropriate handler
 777  * depending on message type (if processed locally)
 778  *
 779  * @param cls closure for the service
 780  * @param client the client we received this message from
 781  * @param message the actual message received
 782  *
 783  */
 784 static void
 785 handle_dht_local_get_stop (void *cls, struct GNUNET_SERVER_Client *client,
 786                            const struct GNUNET_MessageHeader *message)
 787 {
 788   const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
 789       (const struct GNUNET_DHT_ClientGetStopMessage *) message;
 790   struct RemoveByUniqueIdContext ctx;
 791
 792   GNUNET_STATISTICS_update (GDS_stats,
 793                             gettext_noop
 794                             ("# GET STOP requests received from clients"), 1,
 795                             GNUNET_NO);
 796   LOG (GNUNET_ERROR_TYPE_DEBUG,
 797        "Received GET STOP request for %s from local client %p\n",
 798        client, GNUNET_h2s (&dht_stop_msg->key));
 799   ctx.client = find_active_client (client);
 800   ctx.unique_id = dht_stop_msg->unique_id;
 801   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
 802                                               &remove_by_unique_id, &ctx);
 803   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 804 }
 805
 806
 807 /**
 808  * Handler for monitor start messages
 809  *
 810  * @param cls closure for the service
 811  * @param client the client we received this message from
 812  * @param message the actual message received
 813  *
 814  */
 815 static void
 816 handle_dht_local_monitor (void *cls, struct GNUNET_SERVER_Client *client,
 817                           const struct GNUNET_MessageHeader *message)
 818 {
 819   struct ClientMonitorRecord *r;
 820   const struct GNUNET_DHT_MonitorStartStopMessage *msg;
 821
 822   msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
 823   r = GNUNET_new (struct ClientMonitorRecord);
 824
 825   r->client = find_active_client(client);
 826   r->type = ntohl(msg->type);
 827   r->get = ntohs(msg->get);
 828   r->get_resp = ntohs(msg->get_resp);
 829   r->put = ntohs(msg->put);
 830   if (0 == ntohs(msg->filter_key))
 831       r->key = NULL;
 832   else
 833   {
 834     r->key = GNUNET_new (struct GNUNET_HashCode);
 835     memcpy (r->key, &msg->key, sizeof (struct GNUNET_HashCode));
 836   }
 837   GNUNET_CONTAINER_DLL_insert (monitor_head, monitor_tail, r);
 838   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 839 }
 840
 841
 842 /**
 843  * Handler for monitor stop messages
 844  *
 845  * @param cls closure for the service
 846  * @param client the client we received this message from
 847  * @param message the actual message received
 848  *
 849  */
 850 static void
 851 handle_dht_local_monitor_stop (void *cls, struct GNUNET_SERVER_Client *client,
 852                                const struct GNUNET_MessageHeader *message)
 853 {
 854   struct ClientMonitorRecord *r;
 855   const struct GNUNET_DHT_MonitorStartStopMessage *msg;
 856   int keys_match;
 857
 858   msg = (struct GNUNET_DHT_MonitorStartStopMessage *) message;
 859   r = monitor_head;
 860
 861   while (NULL != r)
 862   {
 863     if (NULL == r->key)
 864         keys_match = (0 == ntohs(msg->filter_key));
 865     else
 866     {
 867         keys_match = (0 != ntohs(msg->filter_key)
 868                       && !memcmp(r->key, &msg->key, sizeof(struct GNUNET_HashCode)));
 869     }
 870     if (find_active_client(client) == r->client
 871         && ntohl(msg->type) == r->type
 872         && r->get == msg->get
 873         && r->get_resp == msg->get_resp
 874         && r->put == msg->put
 875         && keys_match
 876         )
 877     {
 878         GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, r);
 879         GNUNET_free_non_null (r->key);
 880         GNUNET_free (r);
 881         GNUNET_SERVER_receive_done (client, GNUNET_OK);
 882         return; /* Delete only ONE entry */
 883     }
 884     r = r->next;
 885   }
 886
 887   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 888 }
 889
 890
 891 /**
 892  * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
 893  * request.  A ClientList is passed as closure, take the head of the list
 894  * and copy it into buf, which has the result of sending the message to the
 895  * client.
 896  *
 897  * @param cls closure to this call
 898  * @param size maximum number of bytes available to send
 899  * @param buf where to copy the actual message to
 900  *
 901  * @return the number of bytes actually copied, 0 indicates failure
 902  */
 903 static size_t
 904 send_reply_to_client (void *cls, size_t size, void *buf)
 905 {
 906   struct ClientList *client = cls;
 907   char *cbuf = buf;
 908   struct PendingMessage *reply;
 909   size_t off;
 910   size_t msize;
 911
 912   client->transmit_handle = NULL;
 913   if (buf == NULL)
 914   {
 915     /* client disconnected */
 916     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 917                 "Client %p disconnected, pending messages will be discarded\n",
 918                 client->client_handle);
 919     return 0;
 920   }
 921   off = 0;
 922   while ((NULL != (reply = client->pending_head)) &&
 923          (size >= off + (msize = ntohs (reply->msg->size))))
 924   {
 925     GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
 926                                  reply);
 927     memcpy (&cbuf[off], reply->msg, msize);
 928     GNUNET_free (reply);
 929     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 930                 "Transmitting %u bytes to client %p\n",
 931                 (unsigned int) msize,
 932                 client->client_handle);
 933     off += msize;
 934   }
 935   process_pending_messages (client);
 936   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 937               "Transmitted %u/%u bytes to client %p\n",
 938               (unsigned int) off,
 939               (unsigned int) size,
 940               client->client_handle);
 941   return off;
 942 }
 943
 944
 945 /**
 946  * Task run to check for messages that need to be sent to a client.
 947  *
 948  * @param client a ClientList, containing the client and any messages to be sent to it
 949  */
 950 static void
 951 process_pending_messages (struct ClientList *client)
 952 {
 953   if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
 954   {
 955     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 956                 "Not asking for transmission to %p now: %s\n",
 957                 client->client_handle,
 958                 client->pending_head ==
 959                 NULL ? "no more messages" : "request already pending");
 960     return;
 961   }
 962   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 963               "Asking for transmission of %u bytes to client %p\n",
 964               ntohs (client->pending_head->msg->size), client->client_handle);
 965   client->transmit_handle =
 966       GNUNET_SERVER_notify_transmit_ready (client->client_handle,
 967                                            ntohs (client->pending_head->
 968                                                   msg->size),
 969                                            GNUNET_TIME_UNIT_FOREVER_REL,
 970                                            &send_reply_to_client, client);
 971 }
 972
 973
 974 /**
 975  * Closure for 'forward_reply'
 976  */
 977 struct ForwardReplyContext
 978 {
 979
 980   /**
 981    * Actual message to send to matching clients.
 982    */
 983   struct PendingMessage *pm;
 984
 985   /**
 986    * Embedded payload.
 987    */
 988   const void *data;
 989
 990   /**
 991    * Type of the data.
 992    */
 993   enum GNUNET_BLOCK_Type type;
 994
 995   /**
 996    * Number of bytes in data.
 997    */
 998   size_t data_size;
 999
1000   /**
1001    * Do we need to copy 'pm' because it was already used?
1002    */
1003   int do_copy;
1004
1005 };
1006
1007
1008 /**
1009  * Iterator over hash map entries that send a given reply to
1010  * each of the matching clients.  With some tricky recycling
1011  * of the buffer.
1012  *
1013  * @param cls the 'struct ForwardReplyContext'
1014  * @param key current key
1015  * @param value value in the hash map, a ClientQueryRecord
1016  * @return GNUNET_YES (we should continue to iterate),
1017  *         if the result is mal-formed, GNUNET_NO
1018  */
1019 static int
1020 forward_reply (void *cls, const struct GNUNET_HashCode * key, void *value)
1021 {
1022   struct ForwardReplyContext *frc = cls;
1023   struct ClientQueryRecord *record = value;
1024   struct PendingMessage *pm;
1025   struct GNUNET_DHT_ClientResultMessage *reply;
1026   enum GNUNET_BLOCK_EvaluationResult eval;
1027   int do_free;
1028   struct GNUNET_HashCode ch;
1029   unsigned int i;
1030
1031   LOG_TRAFFIC (GNUNET_ERROR_TYPE_DEBUG,
1032                "R5N CLIENT-RESULT %s\n",
1033                GNUNET_h2s_full (key));
1034   if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
1035   {
1036     LOG (GNUNET_ERROR_TYPE_DEBUG,
1037          "Record type missmatch, not passing request for key %s to local client\n",
1038          GNUNET_h2s (key));
1039     GNUNET_STATISTICS_update (GDS_stats,
1040                               gettext_noop
1041                               ("# Key match, type mismatches in REPLY to CLIENT"),
1042                               1, GNUNET_NO);
1043     return GNUNET_YES;          /* type mismatch */
1044   }
1045   GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
1046   for (i = 0; i < record->seen_replies_count; i++)
1047     if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (struct GNUNET_HashCode)))
1048     {
1049       LOG (GNUNET_ERROR_TYPE_DEBUG,
1050            "Duplicate reply, not passing request for key %s to local client\n",
1051            GNUNET_h2s (key));
1052       GNUNET_STATISTICS_update (GDS_stats,
1053                                 gettext_noop
1054                                 ("# Duplicate REPLIES to CLIENT request dropped"),
1055                                 1, GNUNET_NO);
1056       return GNUNET_YES;        /* duplicate */
1057     }
1058   eval =
1059       GNUNET_BLOCK_evaluate (GDS_block_context,
1060                              record->type,
1061                              GNUNET_BLOCK_EO_NONE,
1062                              key,
1063                              NULL,
1064                              0,
1065                              record->xquery,
1066                              record->xquery_size,
1067                              frc->data,
1068                              frc->data_size);
1069   LOG (GNUNET_ERROR_TYPE_DEBUG,
1070        "Evaluation result is %d for key %s for local client's query\n",
1071        (int) eval,
1072        GNUNET_h2s (key));
1073   switch (eval)
1074   {
1075   case GNUNET_BLOCK_EVALUATION_OK_LAST:
1076     do_free = GNUNET_YES;
1077     break;
1078   case GNUNET_BLOCK_EVALUATION_OK_MORE:
1079     GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
1080     do_free = GNUNET_NO;
1081     break;
1082   case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
1083     /* should be impossible to encounter here */
1084     GNUNET_break (0);
1085     return GNUNET_YES;
1086   case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
1087     GNUNET_break_op (0);
1088     return GNUNET_NO;
1089   case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
1090     GNUNET_break (0);
1091     return GNUNET_NO;
1092   case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
1093     GNUNET_break (0);
1094     return GNUNET_NO;
1095   case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
1096     return GNUNET_YES;
1097   case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
1098     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1099                 _("Unsupported block type (%u) in request!\n"), record->type);
1100     return GNUNET_NO;
1101   default:
1102     GNUNET_break (0);
1103     return GNUNET_NO;
1104   }
1105   if (GNUNET_NO == frc->do_copy)
1106   {
1107     /* first time, we can use the original data */
1108     pm = frc->pm;
1109     frc->do_copy = GNUNET_YES;
1110   }
1111   else
1112   {
1113     /* two clients waiting for same reply, must copy for queueing */
1114     pm = GNUNET_malloc (sizeof (struct PendingMessage) +
1115                         ntohs (frc->pm->msg->size));
1116     memcpy (pm, frc->pm,
1117             sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
1118     pm->next = pm->prev = NULL;
1119     pm->msg = (struct GNUNET_MessageHeader *) &pm[1];
1120   }
1121   GNUNET_STATISTICS_update (GDS_stats,
1122                             gettext_noop ("# RESULTS queued for clients"), 1,
1123                             GNUNET_NO);
1124   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
1125   reply->unique_id = record->unique_id;
1126   LOG (GNUNET_ERROR_TYPE_DEBUG,
1127        "Queueing reply to query %s for client %p\n",
1128        GNUNET_h2s (key),
1129        record->client->client_handle);
1130   add_pending_message (record->client, pm);
1131   if (GNUNET_YES == do_free)
1132     remove_client_records (record->client, key, record);
1133   return GNUNET_YES;
1134 }
1135
1136
1137 /**
1138  * Handle a reply we've received from another peer.  If the reply
1139  * matches any of our pending queries, forward it to the respective
1140  * client(s).
1141  *
1142  * @param expiration when will the reply expire
1143  * @param key the query this reply is for
1144  * @param get_path_length number of peers in @a get_path
1145  * @param get_path path the reply took on get
1146  * @param put_path_length number of peers in @a put_path
1147  * @param put_path path the reply took on put
1148  * @param type type of the reply
1149  * @param data_size number of bytes in @a data
1150  * @param data application payload data
1151  */
1152 void
1153 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
1154                           const struct GNUNET_HashCode *key,
1155                           unsigned int get_path_length,
1156                           const struct GNUNET_PeerIdentity *get_path,
1157                           unsigned int put_path_length,
1158                           const struct GNUNET_PeerIdentity *put_path,
1159                           enum GNUNET_BLOCK_Type type, size_t data_size,
1160                           const void *data)
1161 {
1162   struct ForwardReplyContext frc;
1163   struct PendingMessage *pm;
1164   struct GNUNET_DHT_ClientResultMessage *reply;
1165   struct GNUNET_PeerIdentity *paths;
1166   size_t msize;
1167
1168   LOG (GNUNET_ERROR_TYPE_DEBUG,
1169        "reply for key %s\n",
1170        GNUNET_h2s (key));
1171
1172   if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
1173   {
1174     GNUNET_STATISTICS_update (GDS_stats,
1175                               gettext_noop
1176                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
1177                               GNUNET_NO);
1178     return;                     /* no matching request, fast exit! */
1179   }
1180   msize =
1181       sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
1182       (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
1183   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1184   {
1185     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1186                 _("Could not pass reply to client, message too big!\n"));
1187     return;
1188   }
1189   pm = GNUNET_malloc (msize + sizeof (struct PendingMessage));
1190   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
1191   pm->msg = &reply->header;
1192   reply->header.size = htons ((uint16_t) msize);
1193   reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
1194   reply->type = htonl (type);
1195   reply->get_path_length = htonl (get_path_length);
1196   reply->put_path_length = htonl (put_path_length);
1197   reply->unique_id = 0;         /* filled in later */
1198   reply->expiration = GNUNET_TIME_absolute_hton (expiration);
1199   reply->key = *key;
1200   paths = (struct GNUNET_PeerIdentity *) &reply[1];
1201   memcpy (paths, put_path,
1202           sizeof (struct GNUNET_PeerIdentity) * put_path_length);
1203   memcpy (&paths[put_path_length], get_path,
1204           sizeof (struct GNUNET_PeerIdentity) * get_path_length);
1205   memcpy (&paths[get_path_length + put_path_length], data, data_size);
1206   frc.do_copy = GNUNET_NO;
1207   frc.pm = pm;
1208   frc.data = data;
1209   frc.data_size = data_size;
1210   frc.type = type;
1211   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
1212                                               &frc);
1213
1214   if (GNUNET_NO == frc.do_copy)
1215   {
1216     /* did not match any of the requests, free! */
1217     GNUNET_STATISTICS_update (GDS_stats,
1218                               gettext_noop
1219                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
1220                               GNUNET_NO);
1221     GNUNET_free (pm);
1222   }
1223 }
1224
1225
1226 /**
1227  * Check if some client is monitoring GET messages and notify
1228  * them in that case.
1229  *
1230  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1231  * @param type The type of data in the request.
1232  * @param hop_count Hop count so far.
1233  * @param path_length number of entries in path (or 0 if not recorded).
1234  * @param path peers on the GET path (or NULL if not recorded).
1235  * @param desired_replication_level Desired replication level.
1236  * @param key Key of the requested data.
1237  */
1238 void
1239 GDS_CLIENTS_process_get (uint32_t options,
1240                          enum GNUNET_BLOCK_Type type,
1241                          uint32_t hop_count,
1242                          uint32_t desired_replication_level,
1243                          unsigned int path_length,
1244                          const struct GNUNET_PeerIdentity *path,
1245                          const struct GNUNET_HashCode * key)
1246 {
1247   struct ClientMonitorRecord *m;
1248   struct ClientList **cl;
1249   unsigned int cl_size;
1250
1251   cl = NULL;
1252   cl_size = 0;
1253   for (m = monitor_head; NULL != m; m = m->next)
1254   {
1255     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1256         (NULL == m->key ||
1257          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1258     {
1259       struct PendingMessage *pm;
1260       struct GNUNET_DHT_MonitorGetMessage *mmsg;
1261       struct GNUNET_PeerIdentity *msg_path;
1262       size_t msize;
1263       unsigned int i;
1264
1265       /* Don't send duplicates */
1266       for (i = 0; i < cl_size; i++)
1267         if (cl[i] == m->client)
1268           break;
1269       if (i < cl_size)
1270         continue;
1271       GNUNET_array_append (cl, cl_size, m->client);
1272
1273       msize = path_length * sizeof (struct GNUNET_PeerIdentity);
1274       msize += sizeof (struct GNUNET_DHT_MonitorGetMessage);
1275       msize += sizeof (struct PendingMessage);
1276       pm = GNUNET_malloc (msize);
1277       mmsg = (struct GNUNET_DHT_MonitorGetMessage *) &pm[1];
1278       pm->msg = &mmsg->header;
1279       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1280       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET);
1281       mmsg->options = htonl(options);
1282       mmsg->type = htonl(type);
1283       mmsg->hop_count = htonl(hop_count);
1284       mmsg->desired_replication_level = htonl(desired_replication_level);
1285       mmsg->get_path_length = htonl(path_length);
1286       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
1287       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1288       if (path_length > 0)
1289         memcpy (msg_path, path,
1290                 path_length * sizeof (struct GNUNET_PeerIdentity));
1291       add_pending_message (m->client, pm);
1292     }
1293   }
1294   GNUNET_free_non_null (cl);
1295 }
1296
1297
1298 /**
1299  * Check if some client is monitoring GET RESP messages and notify
1300  * them in that case.
1301  *
1302  * @param type The type of data in the result.
1303  * @param get_path Peers on GET path (or NULL if not recorded).
1304  * @param get_path_length number of entries in get_path.
1305  * @param put_path peers on the PUT path (or NULL if not recorded).
1306  * @param put_path_length number of entries in get_path.
1307  * @param exp Expiration time of the data.
1308  * @param key Key of the data.
1309  * @param data Pointer to the result data.
1310  * @param size Number of bytes in data.
1311  */
1312 void
1313 GDS_CLIENTS_process_get_resp (enum GNUNET_BLOCK_Type type,
1314                               const struct GNUNET_PeerIdentity *get_path,
1315                               unsigned int get_path_length,
1316                               const struct GNUNET_PeerIdentity *put_path,
1317                               unsigned int put_path_length,
1318                               struct GNUNET_TIME_Absolute exp,
1319                               const struct GNUNET_HashCode * key,
1320                               const void *data,
1321                               size_t size)
1322 {
1323   struct ClientMonitorRecord *m;
1324   struct ClientList **cl;
1325   unsigned int cl_size;
1326
1327   cl = NULL;
1328   cl_size = 0;
1329   for (m = monitor_head; NULL != m; m = m->next)
1330   {
1331     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1332         (NULL == m->key ||
1333          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1334     {
1335       struct PendingMessage *pm;
1336       struct GNUNET_DHT_MonitorGetRespMessage *mmsg;
1337       struct GNUNET_PeerIdentity *path;
1338       size_t msize;
1339       unsigned int i;
1340
1341       /* Don't send duplicates */
1342       for (i = 0; i < cl_size; i++)
1343         if (cl[i] == m->client)
1344           break;
1345       if (i < cl_size)
1346         continue;
1347       GNUNET_array_append (cl, cl_size, m->client);
1348
1349       msize = size;
1350       msize += (get_path_length + put_path_length)
1351                * sizeof (struct GNUNET_PeerIdentity);
1352       msize += sizeof (struct GNUNET_DHT_MonitorGetRespMessage);
1353       msize += sizeof (struct PendingMessage);
1354       pm = GNUNET_malloc (msize);
1355       mmsg = (struct GNUNET_DHT_MonitorGetRespMessage *) &pm[1];
1356       pm->msg = (struct GNUNET_MessageHeader *) mmsg;
1357       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1358       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET_RESP);
1359       mmsg->type = htonl(type);
1360       mmsg->put_path_length = htonl(put_path_length);
1361       mmsg->get_path_length = htonl(get_path_length);
1362       path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1363       if (put_path_length > 0)
1364       {
1365         memcpy (path, put_path,
1366                 put_path_length * sizeof (struct GNUNET_PeerIdentity));
1367         path = &path[put_path_length];
1368       }
1369       if (get_path_length > 0)
1370         memcpy (path, get_path,
1371                 get_path_length * sizeof (struct GNUNET_PeerIdentity));
1372       mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
1373       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
1374       if (size > 0)
1375         memcpy (&path[get_path_length], data, size);
1376       add_pending_message (m->client, pm);
1377     }
1378   }
1379   GNUNET_free_non_null (cl);
1380 }
1381
1382
1383 /**
1384  * Check if some client is monitoring PUT messages and notify
1385  * them in that case.
1386  *
1387  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
1388  * @param type The type of data in the request.
1389  * @param hop_count Hop count so far.
1390  * @param path_length number of entries in path (or 0 if not recorded).
1391  * @param path peers on the PUT path (or NULL if not recorded).
1392  * @param desired_replication_level Desired replication level.
1393  * @param exp Expiration time of the data.
1394  * @param key Key under which data is to be stored.
1395  * @param data Pointer to the data carried.
1396  * @param size Number of bytes in data.
1397  */
1398 void
1399 GDS_CLIENTS_process_put (uint32_t options,
1400                          enum GNUNET_BLOCK_Type type,
1401                          uint32_t hop_count,
1402                          uint32_t desired_replication_level,
1403                          unsigned int path_length,
1404                          const struct GNUNET_PeerIdentity *path,
1405                          struct GNUNET_TIME_Absolute exp,
1406                          const struct GNUNET_HashCode * key,
1407                          const void *data,
1408                          size_t size)
1409 {
1410   struct ClientMonitorRecord *m;
1411   struct ClientList **cl;
1412   unsigned int cl_size;
1413
1414   cl = NULL;
1415   cl_size = 0;
1416   for (m = monitor_head; NULL != m; m = m->next)
1417   {
1418     if ((GNUNET_BLOCK_TYPE_ANY == m->type || m->type == type) &&
1419         (NULL == m->key ||
1420          memcmp (key, m->key, sizeof(struct GNUNET_HashCode)) == 0))
1421     {
1422       struct PendingMessage *pm;
1423       struct GNUNET_DHT_MonitorPutMessage *mmsg;
1424       struct GNUNET_PeerIdentity *msg_path;
1425       size_t msize;
1426       unsigned int i;
1427
1428       /* Don't send duplicates */
1429       for (i = 0; i < cl_size; i++)
1430         if (cl[i] == m->client)
1431           break;
1432       if (i < cl_size)
1433         continue;
1434       GNUNET_array_append (cl, cl_size, m->client);
1435
1436       msize = size;
1437       msize += path_length * sizeof (struct GNUNET_PeerIdentity);
1438       msize += sizeof (struct GNUNET_DHT_MonitorPutMessage);
1439       msize += sizeof (struct PendingMessage);
1440       pm = GNUNET_malloc (msize);
1441       mmsg = (struct GNUNET_DHT_MonitorPutMessage *) &pm[1];
1442       pm->msg = (struct GNUNET_MessageHeader *) mmsg;
1443       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1444       mmsg->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_MONITOR_PUT);
1445       mmsg->options = htonl(options);
1446       mmsg->type = htonl(type);
1447       mmsg->hop_count = htonl(hop_count);
1448       mmsg->desired_replication_level = htonl(desired_replication_level);
1449       mmsg->put_path_length = htonl(path_length);
1450       msg_path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1451       if (path_length > 0)
1452       {
1453         memcpy (msg_path, path,
1454                 path_length * sizeof (struct GNUNET_PeerIdentity));
1455       }
1456       mmsg->expiration_time = GNUNET_TIME_absolute_hton(exp);
1457       memcpy (&mmsg->key, key, sizeof (struct GNUNET_HashCode));
1458       if (size > 0)
1459         memcpy (&msg_path[path_length], data, size);
1460       add_pending_message (m->client, pm);
1461     }
1462   }
1463   GNUNET_free_non_null (cl);
1464 }
1465
1466
1467 /**
1468  * Initialize client subsystem.
1469  *
1470  * @param server the initialized server
1471  */
1472 void
1473 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1474 {
1475   static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1476     {&handle_dht_local_put, NULL,
1477      GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1478     {&handle_dht_local_get, NULL,
1479      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1480     {&handle_dht_local_get_stop, NULL,
1481      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1482      sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1483     {&handle_dht_local_monitor, NULL,
1484      GNUNET_MESSAGE_TYPE_DHT_MONITOR_START,
1485      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1486     {&handle_dht_local_monitor_stop, NULL,
1487      GNUNET_MESSAGE_TYPE_DHT_MONITOR_STOP,
1488      sizeof (struct GNUNET_DHT_MonitorStartStopMessage)},
1489     {&handle_dht_local_get_result_seen, NULL,
1490      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_RESULTS_KNOWN, 0},
1491     {NULL, NULL, 0, 0}
1492   };
1493   forward_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
1494   retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1495   GNUNET_SERVER_add_handlers (server, plugin_handlers);
1496   GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1497 }
1498
1499
1500 /**
1501  * Shutdown client subsystem.
1502  */
1503 void
1504 GDS_CLIENTS_done ()
1505 {
1506   GNUNET_assert (client_head == NULL);
1507   GNUNET_assert (client_tail == NULL);
1508   if (NULL != retry_task)
1509   {
1510     GNUNET_SCHEDULER_cancel (retry_task);
1511     retry_task = NULL;
1512   }
1513   if (NULL != retry_heap)
1514   {
1515     GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1516     GNUNET_CONTAINER_heap_destroy (retry_heap);
1517     retry_heap = NULL;
1518   }
1519   if (NULL != forward_map)
1520   {
1521     GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1522     GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1523     forward_map = NULL;
1524   }
1525 }
1526
1527 /* end of gnunet-service-dht_clients.c */