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  * Linked list of messages to send to clients.
  41  */
  42 struct PendingMessage
  43 {
  44   /**
  45    * Pointer to next item in the list
  46    */
  47   struct PendingMessage *next;
  48
  49   /**
  50    * Pointer to previous item in the list
  51    */
  52   struct PendingMessage *prev;
  53
  54   /**
  55    * Actual message to be sent, allocated at the end of the struct:
  56    * // msg = (cast) &pm[1];
  57    * // memcpy (&pm[1], data, len);
  58    */
  59   const struct GNUNET_MessageHeader *msg;
  60
  61 };
  62
  63
  64 /**
  65  * Struct containing information about a client,
  66  * handle to connect to it, and any pending messages
  67  * that need to be sent to it.
  68  */
  69 struct ClientList
  70 {
  71   /**
  72    * Linked list of active clients
  73    */
  74   struct ClientList *next;
  75
  76   /**
  77    * Linked list of active clients
  78    */
  79   struct ClientList *prev;
  80
  81   /**
  82    * The handle to this client
  83    */
  84   struct GNUNET_SERVER_Client *client_handle;
  85
  86   /**
  87    * Handle to the current transmission request, NULL
  88    * if none pending.
  89    */
  90   struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
  91
  92   /**
  93    * Linked list of pending messages for this client
  94    */
  95   struct PendingMessage *pending_head;
  96
  97   /**
  98    * Tail of linked list of pending messages for this client
  99    */
 100   struct PendingMessage *pending_tail;
 101
 102 };
 103
 104
 105 /**
 106  * Entry in the DHT routing table for a client's GET request.
 107  */
 108 struct ClientQueryRecord
 109 {
 110
 111   /**
 112    * The key this request was about
 113    */
 114   GNUNET_HashCode key;
 115
 116   /**
 117    * Client responsible for the request.
 118    */
 119   struct ClientList *client;
 120
 121   /**
 122    * Extended query (see gnunet_block_lib.h), allocated at the end of this struct.
 123    */
 124   const void *xquery;
 125
 126   /**
 127    * Replies we have already seen for this request.
 128    */
 129   GNUNET_HashCode *seen_replies;
 130
 131   /**
 132    * Pointer to this nodes heap location in the retry-heap (for fast removal)
 133    */
 134   struct GNUNET_CONTAINER_HeapNode *hnode;
 135
 136   /**
 137    * What's the delay between re-try operations that we currently use for this
 138    * request?
 139    */
 140   struct GNUNET_TIME_Relative retry_frequency;
 141
 142   /**
 143    * What's the next time we should re-try this request?
 144    */
 145   struct GNUNET_TIME_Absolute retry_time;
 146
 147   /**
 148    * The unique identifier of this request
 149    */
 150   uint64_t unique_id;
 151
 152   /**
 153    * Number of bytes in xquery.
 154    */
 155   size_t xquery_size;
 156
 157   /**
 158    * Number of entries in 'seen_replies'.
 159    */
 160   unsigned int seen_replies_count;
 161
 162   /**
 163    * Desired replication level
 164    */
 165   uint32_t replication;
 166
 167   /**
 168    * Any message options for this request
 169    */
 170   uint32_t msg_options;
 171
 172   /**
 173    * The type for the data for the GET request.
 174    */
 175   enum GNUNET_BLOCK_Type type;
 176
 177 };
 178
 179
 180 /**
 181  * Struct containing paremeters of monitoring requests.
 182  */
 183 struct ClientMonitorRecord
 184 {
 185
 186   /**
 187    * Next element in DLL.
 188    */
 189   struct ClientMonitorRecord    *next;
 190
 191   /**
 192    * Previous element in DLL.
 193    */
 194   struct ClientMonitorRecord    *prev;
 195
 196   /**
 197    * Type of blocks that are of interest
 198    */
 199   enum GNUNET_BLOCK_Type        type;
 200
 201   /**
 202    * Key of data of interest, NULL for all.
 203    */
 204   GNUNET_HashCode         *key;
 205
 206   /**
 207    * Client to notify of these requests.
 208    */
 209   struct ClientList             *client;
 210 };
 211
 212
 213 /**
 214  * List of active clients.
 215  */
 216 static struct ClientList *client_head;
 217
 218 /**
 219  * List of active clients.
 220  */
 221 static struct ClientList *client_tail;
 222
 223 /**
 224  * List of active monitoring requests.
 225  */
 226 static struct ClientMonitorRecord *monitor_head;
 227
 228 /**
 229  * List of active monitoring requests..
 230  */
 231 static struct ClientMonitorRecord *monitor_tail;
 232
 233 /**
 234  * Hashmap for fast key based lookup, maps keys to 'struct ClientQueryRecord' entries.
 235  */
 236 static struct GNUNET_CONTAINER_MultiHashMap *forward_map;
 237
 238 /**
 239  * Heap with all of our client's request, sorted by retry time (earliest on top).
 240  */
 241 static struct GNUNET_CONTAINER_Heap *retry_heap;
 242
 243 /**
 244  * Task that re-transmits requests (using retry_heap).
 245  */
 246 static GNUNET_SCHEDULER_TaskIdentifier retry_task;
 247
 248
 249 /**
 250  * Find a client if it exists, add it otherwise.
 251  *
 252  * @param client the server handle to the client
 253  *
 254  * @return the client if found, a new client otherwise
 255  */
 256 static struct ClientList *
 257 find_active_client (struct GNUNET_SERVER_Client *client)
 258 {
 259   struct ClientList *pos = client_head;
 260   struct ClientList *ret;
 261
 262   while (pos != NULL)
 263   {
 264     if (pos->client_handle == client)
 265       return pos;
 266     pos = pos->next;
 267   }
 268   ret = GNUNET_malloc (sizeof (struct ClientList));
 269   ret->client_handle = client;
 270   GNUNET_CONTAINER_DLL_insert (client_head, client_tail, ret);
 271   return ret;
 272 }
 273
 274
 275 /**
 276  * Iterator over hash map entries that frees all entries
 277  * associated with the given client.
 278  *
 279  * @param cls client to search for in source routes
 280  * @param key current key code (ignored)
 281  * @param value value in the hash map, a ClientQueryRecord
 282  * @return GNUNET_YES (we should continue to iterate)
 283  */
 284 static int
 285 remove_client_records (void *cls, const GNUNET_HashCode * key, void *value)
 286 {
 287   struct ClientList *client = cls;
 288   struct ClientQueryRecord *record = value;
 289
 290   if (record->client != client)
 291     return GNUNET_YES;
 292 #if DEBUG_DHT
 293   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 294               "Removing client %p's record for key %s\n", client,
 295               GNUNET_h2s (key));
 296 #endif
 297   GNUNET_assert (GNUNET_YES ==
 298                  GNUNET_CONTAINER_multihashmap_remove (forward_map, key,
 299                                                        record));
 300   if (NULL != record->hnode)
 301     GNUNET_CONTAINER_heap_remove_node (record->hnode);
 302   GNUNET_array_grow (record->seen_replies, record->seen_replies_count, 0);
 303   GNUNET_free (record);
 304   return GNUNET_YES;
 305 }
 306
 307
 308 /**
 309  * Functions with this signature are called whenever a client
 310  * is disconnected on the network level.
 311  *
 312  * @param cls closure (NULL for dht)
 313  * @param client identification of the client; NULL
 314  *        for the last call when the server is destroyed
 315  */
 316 static void
 317 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
 318 {
 319   struct ClientList *pos;
 320   struct PendingMessage *reply;
 321   struct ClientMonitorRecord *monitor;
 322
 323 #if DEBUG_DHT
 324   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Local client %p disconnects\n", client);
 325 #endif
 326   pos = find_active_client (client);
 327   GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
 328   if (pos->transmit_handle != NULL)
 329     GNUNET_CONNECTION_notify_transmit_ready_cancel (pos->transmit_handle);
 330   while (NULL != (reply = pos->pending_head))
 331   {
 332     GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail, reply);
 333     GNUNET_free (reply);
 334   }
 335   monitor = monitor_head;
 336   while (NULL != monitor)
 337   {
 338     if (monitor->client == pos)
 339     {
 340       struct ClientMonitorRecord *next;
 341
 342       GNUNET_free_non_null (monitor->key);
 343       next = monitor->next;
 344       GNUNET_CONTAINER_DLL_remove (monitor_head, monitor_tail, monitor);
 345       GNUNET_free (monitor);
 346       monitor = next;
 347     }
 348     else
 349       monitor = monitor->next;
 350   }
 351   GNUNET_CONTAINER_multihashmap_iterate (forward_map, &remove_client_records,
 352                                          pos);
 353   GNUNET_free (pos);
 354 }
 355
 356
 357 /**
 358  * Route the given request via the DHT.  This includes updating
 359  * the bloom filter and retransmission times, building the P2P
 360  * message and initiating the routing operation.
 361  */
 362 static void
 363 transmit_request (struct ClientQueryRecord *cqr)
 364 {
 365   int32_t reply_bf_mutator;
 366   struct GNUNET_CONTAINER_BloomFilter *reply_bf;
 367   struct GNUNET_CONTAINER_BloomFilter *peer_bf;
 368
 369   GNUNET_STATISTICS_update (GDS_stats,
 370                             gettext_noop
 371                             ("# GET requests from clients injected"), 1,
 372                             GNUNET_NO);
 373   reply_bf_mutator =
 374       (int32_t) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 375                                           UINT32_MAX);
 376   reply_bf =
 377       GNUNET_BLOCK_construct_bloomfilter (reply_bf_mutator, cqr->seen_replies,
 378                                           cqr->seen_replies_count);
 379   peer_bf =
 380       GNUNET_CONTAINER_bloomfilter_init (NULL, DHT_BLOOM_SIZE,
 381                                          GNUNET_CONSTANTS_BLOOMFILTER_K);
 382   GDS_NEIGHBOURS_handle_get (cqr->type, cqr->msg_options, cqr->replication,
 383                              0 /* hop count */ ,
 384                              &cqr->key, cqr->xquery, cqr->xquery_size, reply_bf,
 385                              reply_bf_mutator, peer_bf);
 386   GNUNET_CONTAINER_bloomfilter_free (reply_bf);
 387   GNUNET_CONTAINER_bloomfilter_free (peer_bf);
 388
 389   /* exponential back-off for retries, max 1h */
 390   cqr->retry_frequency =
 391       GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_HOURS,
 392                                 GNUNET_TIME_relative_multiply
 393                                 (cqr->retry_frequency, 2));
 394   cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
 395 }
 396
 397
 398 /**
 399  * Task that looks at the 'retry_heap' and transmits all of the requests
 400  * on the heap that are ready for transmission.  Then re-schedules
 401  * itself (unless the heap is empty).
 402  *
 403  * @param cls unused
 404  * @param tc scheduler context
 405  */
 406 static void
 407 transmit_next_request_task (void *cls,
 408                             const struct GNUNET_SCHEDULER_TaskContext *tc)
 409 {
 410   struct ClientQueryRecord *cqr;
 411   struct GNUNET_TIME_Relative delay;
 412
 413   retry_task = GNUNET_SCHEDULER_NO_TASK;
 414   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 415     return;
 416   while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
 417   {
 418     cqr->hnode = NULL;
 419     delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
 420     if (delay.rel_value > 0)
 421     {
 422       cqr->hnode =
 423           GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
 424                                         cqr->retry_time.abs_value);
 425       retry_task =
 426           GNUNET_SCHEDULER_add_delayed (delay, &transmit_next_request_task,
 427                                         NULL);
 428       return;
 429     }
 430     transmit_request (cqr);
 431     cqr->hnode =
 432         GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
 433                                       cqr->retry_time.abs_value);
 434   }
 435 }
 436
 437
 438 /**
 439  * Handler for PUT messages.
 440  *
 441  * @param cls closure for the service
 442  * @param client the client we received this message from
 443  * @param message the actual message received
 444  */
 445 static void
 446 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
 447                       const struct GNUNET_MessageHeader *message)
 448 {
 449   const struct GNUNET_DHT_ClientPutMessage *dht_msg;
 450   struct GNUNET_CONTAINER_BloomFilter *peer_bf;
 451   uint16_t size;
 452
 453   size = ntohs (message->size);
 454   if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
 455   {
 456     GNUNET_break (0);
 457     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 458     return;
 459   }
 460   GNUNET_STATISTICS_update (GDS_stats,
 461                             gettext_noop
 462                             ("# PUT requests received from clients"), 1,
 463                             GNUNET_NO);
 464   dht_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
 465   /* give to local clients */
 466 #if DEBUG_DHT
 467   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 468               "Handling local PUT of %u-bytes for query %s\n",
 469               size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 470               GNUNET_h2s (&dht_msg->key));
 471 #endif
 472   GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 473                             &dht_msg->key, 0, NULL, 0, NULL,
 474                             ntohl (dht_msg->type),
 475                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 476                             &dht_msg[1]);
 477   /* store locally */
 478   GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 479                             &dht_msg->key, 0, NULL, ntohl (dht_msg->type),
 480                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 481                             &dht_msg[1]);
 482   /* route to other peers */
 483   peer_bf =
 484       GNUNET_CONTAINER_bloomfilter_init (NULL, DHT_BLOOM_SIZE,
 485                                          GNUNET_CONSTANTS_BLOOMFILTER_K);
 486   GDS_NEIGHBOURS_handle_put (ntohl (dht_msg->type), ntohl (dht_msg->options),
 487                              ntohl (dht_msg->desired_replication_level),
 488                              GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 489                              0 /* hop count */ ,
 490                              peer_bf, &dht_msg->key, 0, NULL, &dht_msg[1],
 491                              size -
 492                              sizeof (struct GNUNET_DHT_ClientPutMessage));
 493   GNUNET_CONTAINER_bloomfilter_free (peer_bf);
 494   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 495 }
 496
 497
 498 /**
 499  * Handler for any generic DHT messages, calls the appropriate handler
 500  * depending on message type, sends confirmation if responses aren't otherwise
 501  * expected.
 502  *
 503  * @param cls closure for the service
 504  * @param client the client we received this message from
 505  * @param message the actual message received
 506  */
 507 static void
 508 handle_dht_local_get (void *cls, struct GNUNET_SERVER_Client *client,
 509                       const struct GNUNET_MessageHeader *message)
 510 {
 511   const struct GNUNET_DHT_ClientGetMessage *get;
 512   struct ClientQueryRecord *cqr;
 513   size_t xquery_size;
 514   const char *xquery;
 515   uint16_t size;
 516
 517   size = ntohs (message->size);
 518   if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
 519   {
 520     GNUNET_break (0);
 521     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 522     return;
 523   }
 524   xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
 525   get = (const struct GNUNET_DHT_ClientGetMessage *) message;
 526   xquery = (const char *) &get[1];
 527   GNUNET_STATISTICS_update (GDS_stats,
 528                             gettext_noop
 529                             ("# GET requests received from clients"), 1,
 530                             GNUNET_NO);
 531 #if DEBUG_DHT
 532   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 533               "Received request for %s from local client %p\n",
 534               GNUNET_h2s (&get->key), client);
 535 #endif
 536   cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
 537   cqr->key = get->key;
 538   cqr->client = find_active_client (client);
 539   cqr->xquery = (void *) &cqr[1];
 540   memcpy (&cqr[1], xquery, xquery_size);
 541   cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
 542   cqr->retry_frequency = GNUNET_TIME_UNIT_MILLISECONDS;
 543   cqr->retry_time = GNUNET_TIME_absolute_get ();
 544   cqr->unique_id = get->unique_id;
 545   cqr->xquery_size = xquery_size;
 546   cqr->replication = ntohl (get->desired_replication_level);
 547   cqr->msg_options = ntohl (get->options);
 548   cqr->type = ntohl (get->type);
 549   GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
 550                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 551   /* start remote requests */
 552   if (GNUNET_SCHEDULER_NO_TASK != retry_task)
 553     GNUNET_SCHEDULER_cancel (retry_task);
 554   retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
 555   /* perform local lookup */
 556   GDS_DATACACHE_handle_get (&get->key, cqr->type, cqr->xquery, xquery_size,
 557                             NULL, 0);
 558   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 559 }
 560
 561
 562 /**
 563  * Closure for 'remove_by_unique_id'.
 564  */
 565 struct RemoveByUniqueIdContext
 566 {
 567   /**
 568    * Client that issued the removal request.
 569    */
 570   struct ClientList *client;
 571
 572   /**
 573    * Unique ID of the request.
 574    */
 575   uint64_t unique_id;
 576 };
 577
 578
 579 /**
 580  * Iterator over hash map entries that frees all entries
 581  * that match the given client and unique ID.
 582  *
 583  * @param cls unique ID and client to search for in source routes
 584  * @param key current key code
 585  * @param value value in the hash map, a ClientQueryRecord
 586  * @return GNUNET_YES (we should continue to iterate)
 587  */
 588 static int
 589 remove_by_unique_id (void *cls, const GNUNET_HashCode * key, void *value)
 590 {
 591   const struct RemoveByUniqueIdContext *ctx = cls;
 592   struct ClientQueryRecord *record = value;
 593
 594   if (record->unique_id != ctx->unique_id)
 595     return GNUNET_YES;
 596 #if DEBUG_DHT
 597   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 598               "Removing client %p's record for key %s (by unique id)\n",
 599               ctx->client->client_handle, GNUNET_h2s (key));
 600 #endif
 601   return remove_client_records (ctx->client, key, record);
 602 }
 603
 604
 605 /**
 606  * Handler for any generic DHT stop messages, calls the appropriate handler
 607  * depending on message type (if processed locally)
 608  *
 609  * @param cls closure for the service
 610  * @param client the client we received this message from
 611  * @param message the actual message received
 612  *
 613  */
 614 static void
 615 handle_dht_local_get_stop (void *cls, struct GNUNET_SERVER_Client *client,
 616                            const struct GNUNET_MessageHeader *message)
 617 {
 618   const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
 619       (const struct GNUNET_DHT_ClientGetStopMessage *) message;
 620   struct RemoveByUniqueIdContext ctx;
 621
 622   GNUNET_STATISTICS_update (GDS_stats,
 623                             gettext_noop
 624                             ("# GET STOP requests received from clients"), 1,
 625                             GNUNET_NO);
 626 #if DEBUG_DHT
 627   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Client %p stopped request for key %s\n",
 628               client, GNUNET_h2s (&dht_stop_msg->key));
 629 #endif
 630   ctx.client = find_active_client (client);
 631   ctx.unique_id = dht_stop_msg->unique_id;
 632   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, &dht_stop_msg->key,
 633                                               &remove_by_unique_id, &ctx);
 634   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 635 }
 636
 637
 638 /**
 639  * Handler for monitor messages
 640  *
 641  * @param cls closure for the service
 642  * @param client the client we received this message from
 643  * @param message the actual message received
 644  *
 645  */
 646 static void
 647 handle_dht_local_monitor (void *cls, struct GNUNET_SERVER_Client *client,
 648                           const struct GNUNET_MessageHeader *message)
 649 {
 650   struct ClientMonitorRecord *r;
 651   const struct GNUNET_DHT_MonitorMessage *msg;
 652   unsigned int i;
 653   char *c;
 654
 655   msg = (struct GNUNET_DHT_MonitorMessage *) message;
 656   r = GNUNET_malloc (sizeof(struct ClientMonitorRecord));
 657
 658   r->client = find_active_client(client);
 659   r->type = ntohl(msg->type);
 660   c = (char *) &msg->key;
 661   for (i = 0; i < sizeof (GNUNET_HashCode) && c[i] == 0; i++);
 662   if (sizeof (GNUNET_HashCode) == i)
 663     r->key = NULL;
 664   else
 665   {
 666     r->key = GNUNET_malloc (sizeof (GNUNET_HashCode));
 667     memcpy (r->key, &msg->key, sizeof (GNUNET_HashCode));
 668   }
 669
 670 }
 671
 672
 673 /**
 674  * Task run to check for messages that need to be sent to a client.
 675  *
 676  * @param client a ClientList, containing the client and any messages to be sent to it
 677  */
 678 static void
 679 process_pending_messages (struct ClientList *client);
 680
 681
 682 /**
 683  * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
 684  * request.  A ClientList is passed as closure, take the head of the list
 685  * and copy it into buf, which has the result of sending the message to the
 686  * client.
 687  *
 688  * @param cls closure to this call
 689  * @param size maximum number of bytes available to send
 690  * @param buf where to copy the actual message to
 691  *
 692  * @return the number of bytes actually copied, 0 indicates failure
 693  */
 694 static size_t
 695 send_reply_to_client (void *cls, size_t size, void *buf)
 696 {
 697   struct ClientList *client = cls;
 698   char *cbuf = buf;
 699   struct PendingMessage *reply;
 700   size_t off;
 701   size_t msize;
 702
 703   client->transmit_handle = NULL;
 704   if (buf == NULL)
 705   {
 706     /* client disconnected */
 707 #if DEBUG_DHT
 708     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 709                 "Client %p disconnected, pending messages will be discarded\n",
 710                 client->client_handle);
 711 #endif
 712     return 0;
 713   }
 714   off = 0;
 715   while ((NULL != (reply = client->pending_head)) &&
 716          (size >= off + (msize = ntohs (reply->msg->size))))
 717   {
 718     GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
 719                                  reply);
 720     memcpy (&cbuf[off], reply->msg, msize);
 721     GNUNET_free (reply);
 722 #if DEBUG_DHT
 723     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitting %u bytes to client %p\n",
 724                 msize, client->client_handle);
 725 #endif
 726     off += msize;
 727   }
 728   process_pending_messages (client);
 729 #if DEBUG_DHT
 730   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transmitted %u/%u bytes to client %p\n",
 731               (unsigned int) off, (unsigned int) size, client->client_handle);
 732 #endif
 733   return off;
 734 }
 735
 736
 737 /**
 738  * Task run to check for messages that need to be sent to a client.
 739  *
 740  * @param client a ClientList, containing the client and any messages to be sent to it
 741  */
 742 static void
 743 process_pending_messages (struct ClientList *client)
 744 {
 745   if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
 746   {
 747 #if DEBUG_DHT
 748     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 749                 "Not asking for transmission to %p now: %s\n",
 750                 client->client_handle,
 751                 client->pending_head ==
 752                 NULL ? "no more messages" : "request already pending");
 753 #endif
 754     return;
 755   }
 756 #if DEBUG_DHT
 757   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 758               "Asking for transmission of %u bytes to client %p\n",
 759               ntohs (client->pending_head->msg->size), client->client_handle);
 760 #endif
 761   client->transmit_handle =
 762       GNUNET_SERVER_notify_transmit_ready (client->client_handle,
 763                                            ntohs (client->pending_head->
 764                                                   msg->size),
 765                                            GNUNET_TIME_UNIT_FOREVER_REL,
 766                                            &send_reply_to_client, client);
 767 }
 768
 769
 770 /**
 771  * Add a PendingMessage to the clients list of messages to be sent
 772  *
 773  * @param client the active client to send the message to
 774  * @param pending_message the actual message to send
 775  */
 776 static void
 777 add_pending_message (struct ClientList *client,
 778                      struct PendingMessage *pending_message)
 779 {
 780   GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
 781                                     pending_message);
 782   process_pending_messages (client);
 783 }
 784
 785
 786 /**
 787  * Closure for 'forward_reply'
 788  */
 789 struct ForwardReplyContext
 790 {
 791
 792   /**
 793    * Actual message to send to matching clients.
 794    */
 795   struct PendingMessage *pm;
 796
 797   /**
 798    * Embedded payload.
 799    */
 800   const void *data;
 801
 802   /**
 803    * Type of the data.
 804    */
 805   enum GNUNET_BLOCK_Type type;
 806
 807   /**
 808    * Number of bytes in data.
 809    */
 810   size_t data_size;
 811
 812   /**
 813    * Do we need to copy 'pm' because it was already used?
 814    */
 815   int do_copy;
 816
 817 };
 818
 819
 820 /**
 821  * Iterator over hash map entries that send a given reply to
 822  * each of the matching clients.  With some tricky recycling
 823  * of the buffer.
 824  *
 825  * @param cls the 'struct ForwardReplyContext'
 826  * @param key current key
 827  * @param value value in the hash map, a ClientQueryRecord
 828  * @return GNUNET_YES (we should continue to iterate),
 829  *         if the result is mal-formed, GNUNET_NO
 830  */
 831 static int
 832 forward_reply (void *cls, const GNUNET_HashCode * key, void *value)
 833 {
 834   struct ForwardReplyContext *frc = cls;
 835   struct ClientQueryRecord *record = value;
 836   struct PendingMessage *pm;
 837   struct GNUNET_DHT_ClientResultMessage *reply;
 838   enum GNUNET_BLOCK_EvaluationResult eval;
 839   int do_free;
 840   GNUNET_HashCode ch;
 841   unsigned int i;
 842
 843   if ((record->type != GNUNET_BLOCK_TYPE_ANY) && (record->type != frc->type))
 844   {
 845 #if DEBUG_DHT
 846     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 847                 "Record type missmatch, not passing request for key %s to local client\n",
 848                 GNUNET_h2s (key));
 849 #endif
 850     GNUNET_STATISTICS_update (GDS_stats,
 851                               gettext_noop
 852                               ("# Key match, type mismatches in REPLY to CLIENT"),
 853                               1, GNUNET_NO);
 854     return GNUNET_YES;          /* type mismatch */
 855   }
 856   GNUNET_CRYPTO_hash (frc->data, frc->data_size, &ch);
 857   for (i = 0; i < record->seen_replies_count; i++)
 858     if (0 == memcmp (&record->seen_replies[i], &ch, sizeof (GNUNET_HashCode)))
 859     {
 860 #if DEBUG_DHT
 861       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 862                   "Duplicate reply, not passing request for key %s to local client\n",
 863                   GNUNET_h2s (key));
 864 #endif
 865       GNUNET_STATISTICS_update (GDS_stats,
 866                                 gettext_noop
 867                                 ("# Duplicate REPLIES to CLIENT request dropped"),
 868                                 1, GNUNET_NO);
 869       return GNUNET_YES;        /* duplicate */
 870     }
 871   eval =
 872       GNUNET_BLOCK_evaluate (GDS_block_context, record->type, key, NULL, 0,
 873                              record->xquery, record->xquery_size, frc->data,
 874                              frc->data_size);
 875 #if DEBUG_DHT
 876   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 877               "Evaluation result is %d for key %s for local client's query\n",
 878               (int) eval, GNUNET_h2s (key));
 879 #endif
 880   switch (eval)
 881   {
 882   case GNUNET_BLOCK_EVALUATION_OK_LAST:
 883     do_free = GNUNET_YES;
 884     break;
 885   case GNUNET_BLOCK_EVALUATION_OK_MORE:
 886     GNUNET_array_append (record->seen_replies, record->seen_replies_count, ch);
 887     do_free = GNUNET_NO;
 888     break;
 889   case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
 890     /* should be impossible to encounter here */
 891     GNUNET_break (0);
 892     return GNUNET_YES;
 893   case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
 894     GNUNET_break_op (0);
 895     return GNUNET_NO;
 896   case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
 897     GNUNET_break (0);
 898     return GNUNET_NO;
 899   case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
 900     GNUNET_break (0);
 901     return GNUNET_NO;
 902   case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
 903     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 904                 _("Unsupported block type (%u) in request!\n"), record->type);
 905     return GNUNET_NO;
 906   default:
 907     GNUNET_break (0);
 908     return GNUNET_NO;
 909   }
 910   if (GNUNET_NO == frc->do_copy)
 911   {
 912     /* first time, we can use the original data */
 913     pm = frc->pm;
 914     frc->do_copy = GNUNET_YES;
 915   }
 916   else
 917   {
 918     /* two clients waiting for same reply, must copy for queueing */
 919     pm = GNUNET_malloc (sizeof (struct PendingMessage) +
 920                         ntohs (frc->pm->msg->size));
 921     memcpy (pm, frc->pm,
 922             sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
 923     pm->next = pm->prev = NULL;
 924   }
 925   GNUNET_STATISTICS_update (GDS_stats,
 926                             gettext_noop ("# RESULTS queued for clients"), 1,
 927                             GNUNET_NO);
 928   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
 929   reply->unique_id = record->unique_id;
 930 #if DEBUG_DHT
 931   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 932               "Queueing reply to query %s for client %p\n", GNUNET_h2s (key),
 933               record->client->client_handle);
 934 #endif
 935   add_pending_message (record->client, pm);
 936   if (GNUNET_YES == do_free)
 937     remove_client_records (record->client, key, record);
 938   return GNUNET_YES;
 939 }
 940
 941
 942 /**
 943  * Handle a reply we've received from another peer.  If the reply
 944  * matches any of our pending queries, forward it to the respective
 945  * client(s).
 946  *
 947  * @param expiration when will the reply expire
 948  * @param key the query this reply is for
 949  * @param get_path_length number of peers in 'get_path'
 950  * @param get_path path the reply took on get
 951  * @param put_path_length number of peers in 'put_path'
 952  * @param put_path path the reply took on put
 953  * @param type type of the reply
 954  * @param data_size number of bytes in 'data'
 955  * @param data application payload data
 956  */
 957 void
 958 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
 959                           const GNUNET_HashCode * key,
 960                           unsigned int get_path_length,
 961                           const struct GNUNET_PeerIdentity *get_path,
 962                           unsigned int put_path_length,
 963                           const struct GNUNET_PeerIdentity *put_path,
 964                           enum GNUNET_BLOCK_Type type, size_t data_size,
 965                           const void *data)
 966 {
 967   struct ForwardReplyContext frc;
 968   struct PendingMessage *pm;
 969   struct GNUNET_DHT_ClientResultMessage *reply;
 970   struct GNUNET_PeerIdentity *paths;
 971   size_t msize;
 972
 973   if (NULL == GNUNET_CONTAINER_multihashmap_get (forward_map, key))
 974   {
 975     GNUNET_STATISTICS_update (GDS_stats,
 976                               gettext_noop
 977                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
 978                               GNUNET_NO);
 979     return;                     /* no matching request, fast exit! */
 980   }
 981   msize =
 982       sizeof (struct GNUNET_DHT_ClientResultMessage) + data_size +
 983       (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
 984   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 985   {
 986     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 987                 _("Could not pass reply to client, message too big!\n"));
 988     return;
 989   }
 990   pm = (struct PendingMessage *) GNUNET_malloc (msize +
 991                                                 sizeof (struct PendingMessage));
 992   reply = (struct GNUNET_DHT_ClientResultMessage *) &pm[1];
 993   pm->msg = &reply->header;
 994   reply->header.size = htons ((uint16_t) msize);
 995   reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
 996   reply->type = htonl (type);
 997   reply->get_path_length = htonl (get_path_length);
 998   reply->put_path_length = htonl (put_path_length);
 999   reply->unique_id = 0;         /* filled in later */
1000   reply->expiration = GNUNET_TIME_absolute_hton (expiration);
1001   reply->key = *key;
1002   paths = (struct GNUNET_PeerIdentity *) &reply[1];
1003   memcpy (paths, put_path,
1004           sizeof (struct GNUNET_PeerIdentity) * put_path_length);
1005   memcpy (&paths[put_path_length], get_path,
1006           sizeof (struct GNUNET_PeerIdentity) * get_path_length);
1007   memcpy (&paths[get_path_length + put_path_length], data, data_size);
1008   frc.do_copy = GNUNET_NO;
1009   frc.pm = pm;
1010   frc.data = data;
1011   frc.data_size = data_size;
1012   frc.type = type;
1013   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key, &forward_reply,
1014                                               &frc);
1015   if (GNUNET_NO == frc.do_copy)
1016   {
1017     /* did not match any of the requests, free! */
1018     GNUNET_STATISTICS_update (GDS_stats,
1019                               gettext_noop
1020                               ("# REPLIES ignored for CLIENTS (no match)"), 1,
1021                               GNUNET_NO);
1022     GNUNET_free (pm);
1023   }
1024 }
1025
1026
1027 /**
1028  * Check if some client is monitoring messages of this type and notify
1029  * him in that case.
1030  *
1031  * @param mtype Type of the DHT message.
1032  * @param exp When will this value expire.
1033  * @param key Key of the result/request.
1034  * @param get_path Peers on reply path (or NULL if not recorded).
1035  * @param get_path_length number of entries in get_path.
1036  * @param put_path peers on the PUT path (or NULL if not recorded).
1037  * @param put_path_length number of entries in get_path.
1038  * @param desired_replication_level Desired replication level.
1039  * @param type Type of the result/request.
1040  * @param data Pointer to the result data.
1041  * @param size Number of bytes in data.
1042  */
1043 void
1044 GDS_CLIENTS_process_monitor (uint16_t mtype,
1045                              const struct GNUNET_TIME_Absolute exp,
1046                              const GNUNET_HashCode *key,
1047                              uint32_t putl,
1048                              const struct GNUNET_PeerIdentity *put_path,
1049                              uint32_t getl,
1050                              const struct GNUNET_PeerIdentity *get_path,
1051                              uint32_t replevel,
1052                              enum GNUNET_BLOCK_Type type,
1053                              const struct GNUNET_MessageHeader *data,
1054                              uint16_t size)
1055 {
1056   struct ClientMonitorRecord *m;
1057   struct ClientList **cl;
1058   unsigned int cl_size;
1059
1060   cl = NULL;
1061   cl_size = 0;
1062   for (m = monitor_head; NULL != m; m = m->next)
1063   {
1064     if (m->type == type &&
1065         (NULL == m->key ||
1066          memcmp (key, m->key, sizeof(GNUNET_HashCode)) == 0))
1067     {
1068       struct PendingMessage *pm;
1069       struct GNUNET_DHT_MonitorMessage *mmsg;
1070       struct GNUNET_PeerIdentity *path;
1071       size_t msize;
1072       unsigned int i;
1073
1074       /* Don't send duplicates */
1075       for (i = 0; i < cl_size; i++)
1076         if (cl[i] == m->client)
1077           break;
1078       if (i < cl_size)
1079         continue;
1080       GNUNET_array_append (cl, cl_size, m->client);
1081
1082       msize = size;
1083       msize += (getl + putl) * sizeof (struct GNUNET_PeerIdentity);
1084       msize += sizeof (struct GNUNET_DHT_MonitorMessage);
1085       msize += sizeof (struct PendingMessage);
1086       pm = (struct PendingMessage *) GNUNET_malloc (msize);
1087       mmsg = (struct GNUNET_DHT_MonitorMessage *) &pm[1];
1088       pm->msg = (struct GNUNET_MessageHeader *) mmsg;
1089       mmsg->header.size = htons (msize - sizeof (struct PendingMessage));
1090       mmsg->header.type = htons (mtype);
1091       mmsg->expiration = GNUNET_TIME_absolute_hton(exp);
1092       path = (struct GNUNET_PeerIdentity *) &mmsg[1];
1093       memcpy (path, put_path, putl * sizeof (struct GNUNET_PeerIdentity));
1094       path = &path[putl];
1095       memcpy (path, get_path, getl * sizeof (struct GNUNET_PeerIdentity));
1096       memcpy (&path[getl], data, size);
1097       add_pending_message (m->client, pm);
1098     }
1099   }
1100   GNUNET_free_non_null (cl);
1101 }
1102
1103
1104 /**
1105  * Initialize client subsystem.
1106  *
1107  * @param server the initialized server
1108  */
1109 void
1110 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
1111 {
1112   static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1113     {&handle_dht_local_put, NULL,
1114      GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
1115     {&handle_dht_local_get, NULL,
1116      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
1117     {&handle_dht_local_get_stop, NULL,
1118      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
1119      sizeof (struct GNUNET_DHT_ClientGetStopMessage)},
1120     {&handle_dht_local_monitor, NULL,
1121      GNUNET_MESSAGE_TYPE_DHT_MONITOR_GET,
1122      sizeof (struct GNUNET_DHT_MonitorMessage)},
1123     {NULL, NULL, 0, 0}
1124   };
1125   forward_map = GNUNET_CONTAINER_multihashmap_create (1024);
1126   retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1127   GNUNET_SERVER_add_handlers (server, plugin_handlers);
1128   GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1129 }
1130
1131
1132 /**
1133  * Shutdown client subsystem.
1134  */
1135 void
1136 GDS_CLIENTS_done ()
1137 {
1138   GNUNET_assert (client_head == NULL);
1139   GNUNET_assert (client_tail == NULL);
1140   if (GNUNET_SCHEDULER_NO_TASK != retry_task)
1141   {
1142     GNUNET_SCHEDULER_cancel (retry_task);
1143     retry_task = GNUNET_SCHEDULER_NO_TASK;
1144   }
1145   GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
1146   GNUNET_CONTAINER_heap_destroy (retry_heap);
1147   retry_heap = NULL;
1148   GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
1149   GNUNET_CONTAINER_multihashmap_destroy (forward_map);
1150   forward_map = NULL;
1151 }
1152
1153 /* end of gnunet-service-dht_clients.c */