src/dht/gnunet-service-dht_clients.c

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