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  * List of active clients.
 182  */
 183 static struct ClientList *client_head;
 184
 185 /**
 186  * List of active clients.
 187  */
 188 static struct ClientList *client_tail;
 189
 190 /**
 191  * Hashmap for fast key based lookup, maps keys to 'struct ClientQueryRecord' entries.
 192  */
 193 static struct GNUNET_CONTAINER_MultiHashMap *forward_map;
 194
 195 /**
 196  * Heap with all of our client's request, sorted by retry time (earliest on top).
 197  */
 198 static struct GNUNET_CONTAINER_Heap *retry_heap;
 199
 200 /**
 201  * Task that re-transmits requests (using retry_heap).
 202  */
 203 static GNUNET_SCHEDULER_TaskIdentifier retry_task;
 204
 205
 206 /**
 207  * Find a client if it exists, add it otherwise.
 208  *
 209  * @param client the server handle to the client
 210  *
 211  * @return the client if found, a new client otherwise
 212  */
 213 static struct ClientList *
 214 find_active_client (struct GNUNET_SERVER_Client *client)
 215 {
 216   struct ClientList *pos = client_head;
 217   struct ClientList *ret;
 218
 219   while (pos != NULL)
 220   {
 221     if (pos->client_handle == client)
 222       return pos;
 223     pos = pos->next;
 224   }
 225   ret = GNUNET_malloc (sizeof (struct ClientList));
 226   ret->client_handle = client;
 227   GNUNET_CONTAINER_DLL_insert (client_head,
 228                                client_tail,
 229                                ret);
 230   return ret;
 231 }
 232
 233
 234 /**
 235  * Iterator over hash map entries that frees all entries
 236  * associated with the given client.
 237  *
 238  * @param cls client to search for in source routes
 239  * @param key current key code (ignored)
 240  * @param value value in the hash map, a ClientQueryRecord
 241  * @return GNUNET_YES (we should continue to iterate)
 242  */
 243 static int
 244 remove_client_records (void *cls, const GNUNET_HashCode * key, void *value)
 245 {
 246   struct ClientList *client = cls;
 247   struct ClientQueryRecord *record = value;
 248
 249   if (record->client != client)
 250     return GNUNET_YES;
 251   GNUNET_assert (GNUNET_YES ==
 252                  GNUNET_CONTAINER_multihashmap_remove (forward_map,
 253                                                        key, record));
 254   if (NULL != record->hnode)
 255     GNUNET_CONTAINER_heap_remove_node (record->hnode);
 256   GNUNET_array_grow (record->seen_replies,
 257                      record->seen_replies_count,
 258                      0);
 259   GNUNET_free (record);
 260   return GNUNET_YES;
 261 }
 262
 263
 264 /**
 265  * Functions with this signature are called whenever a client
 266  * is disconnected on the network level.
 267  *
 268  * @param cls closure (NULL for dht)
 269  * @param client identification of the client; NULL
 270  *        for the last call when the server is destroyed
 271  */
 272 static void
 273 handle_client_disconnect (void *cls,
 274                           struct GNUNET_SERVER_Client *client)
 275 {
 276   struct ClientList *pos;
 277   struct PendingMessage *reply;
 278
 279   pos = find_active_client (client);
 280   GNUNET_CONTAINER_DLL_remove (client_head,
 281                                client_tail,
 282                                pos);
 283   if (pos->transmit_handle != NULL)
 284     GNUNET_CONNECTION_notify_transmit_ready_cancel (pos->transmit_handle);
 285   while (NULL != (reply = pos->pending_head))
 286     {
 287       GNUNET_CONTAINER_DLL_remove (pos->pending_head, pos->pending_tail,
 288                                    reply);
 289       GNUNET_free (reply);
 290     }
 291   GNUNET_CONTAINER_multihashmap_iterate (forward_map,
 292                                          &remove_client_records, pos);
 293   GNUNET_free (pos);
 294 }
 295
 296
 297 /**
 298  * Route the given request via the DHT.  This includes updating
 299  * the bloom filter and retransmission times, building the P2P
 300  * message and initiating the routing operation.
 301  */
 302 static void
 303 transmit_request (struct ClientQueryRecord *cqr)
 304 {
 305   int32_t reply_bf_mutator;
 306   struct GNUNET_CONTAINER_BloomFilter *reply_bf;
 307   struct GNUNET_CONTAINER_BloomFilter *peer_bf;
 308
 309   GNUNET_STATISTICS_update (GDS_stats,
 310                             gettext_noop ("# GET requests from clients injected"), 1,
 311                             GNUNET_NO);
 312   reply_bf_mutator = (int32_t) GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 313                                                          UINT32_MAX);
 314   reply_bf = GNUNET_BLOCK_construct_bloomfilter (reply_bf_mutator,
 315                                                  cqr->seen_replies,
 316                                                  cqr->seen_replies_count);
 317   peer_bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
 318                                                DHT_BLOOM_SIZE,
 319                                                GNUNET_CONSTANTS_BLOOMFILTER_K);
 320   GDS_NEIGHBOURS_handle_get (cqr->type,
 321                              cqr->msg_options,
 322                              cqr->replication,
 323                              0 /* hop count */,
 324                              &cqr->key,
 325                              cqr->xquery,
 326                              cqr->xquery_size,
 327                              reply_bf,
 328                              reply_bf_mutator,
 329                              peer_bf);
 330   GNUNET_CONTAINER_bloomfilter_free (reply_bf);
 331   GNUNET_CONTAINER_bloomfilter_free (peer_bf);
 332
 333   /* exponential back-off for retries, max 1h */
 334   cqr->retry_frequency =
 335     GNUNET_TIME_relative_max (GNUNET_TIME_UNIT_HOURS,
 336                               GNUNET_TIME_relative_multiply (cqr->retry_frequency, 2));
 337   cqr->retry_time = GNUNET_TIME_relative_to_absolute (cqr->retry_frequency);
 338 }
 339
 340
 341 /**
 342  * Task that looks at the 'retry_heap' and transmits all of the requests
 343  * on the heap that are ready for transmission.  Then re-schedules
 344  * itself (unless the heap is empty).
 345  *
 346  * @param cls unused
 347  * @param tc scheduler context
 348  */
 349 static void
 350 transmit_next_request_task (void *cls,
 351                             const struct GNUNET_SCHEDULER_TaskContext *tc)
 352 {
 353   struct ClientQueryRecord *cqr;
 354   struct GNUNET_TIME_Relative delay;
 355
 356   retry_task = GNUNET_SCHEDULER_NO_TASK;
 357   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 358     return;
 359   while (NULL != (cqr = GNUNET_CONTAINER_heap_remove_root (retry_heap)))
 360     {
 361       cqr->hnode = NULL;
 362       delay = GNUNET_TIME_absolute_get_remaining (cqr->retry_time);
 363       if (delay.rel_value > 0)
 364         {
 365           cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr,
 366                                                      cqr->retry_time.abs_value);
 367           retry_task = GNUNET_SCHEDULER_add_delayed (delay,
 368                                                      &transmit_next_request_task,
 369                                                      NULL);
 370           return;
 371         }
 372       transmit_request (cqr);
 373     }
 374 }
 375
 376
 377 /**
 378  * Handler for PUT messages.
 379  *
 380  * @param cls closure for the service
 381  * @param client the client we received this message from
 382  * @param message the actual message received
 383  */
 384 static void
 385 handle_dht_local_put (void *cls, struct GNUNET_SERVER_Client *client,
 386                       const struct GNUNET_MessageHeader *message)
 387 {
 388   const struct GNUNET_DHT_ClientPutMessage *dht_msg;
 389   struct GNUNET_CONTAINER_BloomFilter *peer_bf;
 390   uint16_t size;
 391
 392   size = ntohs (message->size);
 393   if (size < sizeof (struct GNUNET_DHT_ClientPutMessage))
 394     {
 395       GNUNET_break (0);
 396       GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 397       return;
 398     }
 399   GNUNET_STATISTICS_update (GDS_stats,
 400                             gettext_noop ("# PUT requests received from clients"), 1,
 401                             GNUNET_NO);
 402   dht_msg = (const struct GNUNET_DHT_ClientPutMessage *) message;
 403   /* give to local clients */
 404   GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 405                            &dht_msg->key,
 406                            0, NULL,
 407                            0, NULL,
 408                            ntohl (dht_msg->type),
 409                            size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 410                            &dht_msg[1]);
 411   /* store locally */
 412   GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 413                             &dht_msg->key,
 414                             0, NULL,
 415                             ntohl (dht_msg->type),
 416                             size - sizeof (struct GNUNET_DHT_ClientPutMessage),
 417                             &dht_msg[1]);
 418   /* route to other peers */
 419   peer_bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
 420                                                DHT_BLOOM_SIZE,
 421                                                GNUNET_CONSTANTS_BLOOMFILTER_K);
 422   GDS_NEIGHBOURS_handle_put (ntohl (dht_msg->type),
 423                              ntohl (dht_msg->options),
 424                              ntohl (dht_msg->desired_replication_level),
 425                              GNUNET_TIME_absolute_ntoh (dht_msg->expiration),
 426                              0 /* hop count */,
 427                              peer_bf,
 428                              &dht_msg->key,
 429                              0, NULL,
 430                              &dht_msg[1],
 431                              size - sizeof (struct GNUNET_DHT_ClientPutMessage));
 432   GNUNET_CONTAINER_bloomfilter_free (peer_bf);
 433   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 434 }
 435
 436
 437 /**
 438  * Handler for any generic DHT messages, calls the appropriate handler
 439  * depending on message type, sends confirmation if responses aren't otherwise
 440  * expected.
 441  *
 442  * @param cls closure for the service
 443  * @param client the client we received this message from
 444  * @param message the actual message received
 445  */
 446 static void
 447 handle_dht_local_get (void *cls, struct GNUNET_SERVER_Client *client,
 448                       const struct GNUNET_MessageHeader *message)
 449 {
 450   const struct GNUNET_DHT_ClientGetMessage *get;
 451   struct ClientQueryRecord *cqr;
 452   size_t xquery_size;
 453   const char* xquery;
 454   uint16_t size;
 455
 456   size = ntohs (message->size);
 457   if (size < sizeof (struct GNUNET_DHT_ClientGetMessage))
 458     {
 459       GNUNET_break (0);
 460       GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 461       return;
 462     }
 463   xquery_size = size - sizeof (struct GNUNET_DHT_ClientGetMessage);
 464   get = (const struct GNUNET_DHT_ClientGetMessage *) message;
 465   xquery = (const char*) &get[1];
 466   GNUNET_STATISTICS_update (GDS_stats,
 467                             gettext_noop ("# GET requests received from clients"), 1,
 468                             GNUNET_NO);
 469
 470   cqr = GNUNET_malloc (sizeof (struct ClientQueryRecord) + xquery_size);
 471   cqr->key = get->key;
 472   cqr->client = find_active_client (client);
 473   cqr->xquery = (void*) &cqr[1];
 474   memcpy (&cqr[1], xquery, xquery_size);
 475   cqr->hnode = GNUNET_CONTAINER_heap_insert (retry_heap, cqr, 0);
 476   cqr->retry_frequency = GNUNET_TIME_UNIT_MILLISECONDS;
 477   cqr->retry_time = GNUNET_TIME_absolute_get ();
 478   cqr->unique_id = get->unique_id;
 479   cqr->xquery_size = xquery_size;
 480   cqr->replication = ntohl (get->desired_replication_level);
 481   cqr->msg_options = ntohl (get->options);
 482   cqr->type = ntohl (get->type);
 483   GNUNET_CONTAINER_multihashmap_put (forward_map, &get->key, cqr,
 484                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 485   /* start remote requests */
 486   if (GNUNET_SCHEDULER_NO_TASK != retry_task)
 487     GNUNET_SCHEDULER_cancel (retry_task);
 488   retry_task = GNUNET_SCHEDULER_add_now (&transmit_next_request_task, NULL);
 489   /* perform local lookup */
 490   GDS_DATACACHE_handle_get (&get->key,
 491                             cqr->type,
 492                             cqr->xquery,
 493                             xquery_size,
 494                             NULL, 0);
 495   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 496 }
 497
 498
 499 /**
 500  * Closure for 'remove_by_unique_id'.
 501  */
 502 struct RemoveByUniqueIdContext
 503 {
 504   /**
 505    * Client that issued the removal request.
 506    */
 507   struct ClientList *client;
 508
 509   /**
 510    * Unique ID of the request.
 511    */
 512   uint64_t unique_id;
 513 };
 514
 515
 516 /**
 517  * Iterator over hash map entries that frees all entries
 518  * that match the given client and unique ID.
 519  *
 520  * @param cls unique ID and client to search for in source routes
 521  * @param key current key code
 522  * @param value value in the hash map, a ClientQueryRecord
 523  * @return GNUNET_YES (we should continue to iterate)
 524  */
 525 static int
 526 remove_by_unique_id (void *cls, const GNUNET_HashCode * key, void *value)
 527 {
 528   const struct RemoveByUniqueIdContext *ctx = cls;
 529   struct ClientQueryRecord *record = value;
 530
 531   if (record->unique_id != ctx->unique_id)
 532     return GNUNET_YES;
 533   return remove_client_records (ctx->client, key, record);
 534 }
 535
 536
 537 /**
 538  * Handler for any generic DHT stop messages, calls the appropriate handler
 539  * depending on message type (if processed locally)
 540  *
 541  * @param cls closure for the service
 542  * @param client the client we received this message from
 543  * @param message the actual message received
 544  *
 545  */
 546 static void
 547 handle_dht_local_get_stop (void *cls, struct GNUNET_SERVER_Client *client,
 548                            const struct GNUNET_MessageHeader *message)
 549 {
 550   const struct GNUNET_DHT_ClientGetStopMessage *dht_stop_msg =
 551     (const struct GNUNET_DHT_ClientGetStopMessage *) message;
 552   struct RemoveByUniqueIdContext ctx;
 553
 554   GNUNET_STATISTICS_update (GDS_stats,
 555                             gettext_noop ("# GET STOP requests received from clients"), 1,
 556                             GNUNET_NO);
 557   ctx.client = find_active_client (client);
 558   ctx.unique_id = dht_stop_msg->unique_id;
 559   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map,
 560                                               &dht_stop_msg->key,
 561                                               &remove_by_unique_id,
 562                                               &ctx);
 563   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 564 }
 565
 566
 567 /**
 568  * Task run to check for messages that need to be sent to a client.
 569  *
 570  * @param client a ClientList, containing the client and any messages to be sent to it
 571  */
 572 static void
 573 process_pending_messages (struct ClientList *client);
 574
 575
 576 /**
 577  * Callback called as a result of issuing a GNUNET_SERVER_notify_transmit_ready
 578  * request.  A ClientList is passed as closure, take the head of the list
 579  * and copy it into buf, which has the result of sending the message to the
 580  * client.
 581  *
 582  * @param cls closure to this call
 583  * @param size maximum number of bytes available to send
 584  * @param buf where to copy the actual message to
 585  *
 586  * @return the number of bytes actually copied, 0 indicates failure
 587  */
 588 static size_t
 589 send_reply_to_client (void *cls, size_t size, void *buf)
 590 {
 591   struct ClientList *client = cls;
 592   char *cbuf = buf;
 593   struct PendingMessage *reply;
 594   size_t off;
 595   size_t msize;
 596
 597   client->transmit_handle = NULL;
 598   if (buf == NULL)
 599   {
 600     /* client disconnected */
 601     return 0;
 602   }
 603   off = 0;
 604   while ((NULL != (reply = client->pending_head)) &&
 605          (size >= off + (msize = ntohs (reply->msg->size))))
 606   {
 607     GNUNET_CONTAINER_DLL_remove (client->pending_head, client->pending_tail,
 608                                  reply);
 609     memcpy (&cbuf[off], reply->msg, msize);
 610     GNUNET_free (reply);
 611     off += msize;
 612   }
 613   process_pending_messages (client);
 614   return off;
 615 }
 616
 617
 618 /**
 619  * Task run to check for messages that need to be sent to a client.
 620  *
 621  * @param client a ClientList, containing the client and any messages to be sent to it
 622  */
 623 static void
 624 process_pending_messages (struct ClientList *client)
 625 {
 626   if ((client->pending_head == NULL) || (client->transmit_handle != NULL))
 627     return;
 628   client->transmit_handle =
 629       GNUNET_SERVER_notify_transmit_ready (client->client_handle,
 630                                            ntohs (client->pending_head->
 631                                                   msg->size),
 632                                            GNUNET_TIME_UNIT_FOREVER_REL,
 633                                            &send_reply_to_client, client);
 634 }
 635
 636
 637 /**
 638  * Add a PendingMessage to the clients list of messages to be sent
 639  *
 640  * @param client the active client to send the message to
 641  * @param pending_message the actual message to send
 642  */
 643 static void
 644 add_pending_message (struct ClientList *client,
 645                      struct PendingMessage *pending_message)
 646 {
 647   GNUNET_CONTAINER_DLL_insert_tail (client->pending_head, client->pending_tail,
 648                                     pending_message);
 649   process_pending_messages (client);
 650 }
 651
 652
 653 /**
 654  * Closure for 'forward_reply'
 655  */
 656 struct ForwardReplyContext
 657 {
 658
 659   /**
 660    * Actual message to send to matching clients.
 661    */
 662   struct PendingMessage *pm;
 663
 664   /**
 665    * Embedded payload.
 666    */
 667   const void *data;
 668
 669   /**
 670    * Type of the data.
 671    */
 672   enum GNUNET_BLOCK_Type type;
 673
 674   /**
 675    * Number of bytes in data.
 676    */
 677   size_t data_size;
 678
 679   /**
 680    * Do we need to copy 'pm' because it was already used?
 681    */
 682   int do_copy;
 683
 684 };
 685
 686
 687 /**
 688  * Iterator over hash map entries that send a given reply to
 689  * each of the matching clients.  With some tricky recycling
 690  * of the buffer.
 691  *
 692  * @param cls the 'struct ForwardReplyContext'
 693  * @param key current key
 694  * @param value value in the hash map, a ClientQueryRecord
 695  * @return GNUNET_YES (we should continue to iterate),
 696  *         if the result is mal-formed, GNUNET_NO
 697  */
 698 static int
 699 forward_reply (void *cls, const GNUNET_HashCode * key, void *value)
 700 {
 701   struct ForwardReplyContext *frc = cls;
 702   struct ClientQueryRecord *record = value;
 703   struct PendingMessage *pm;
 704   struct GNUNET_DHT_ClientResultMessage *reply;
 705   enum GNUNET_BLOCK_EvaluationResult eval;
 706   int do_free;
 707   GNUNET_HashCode ch;
 708   unsigned int i;
 709
 710   if ( (record->type != GNUNET_BLOCK_TYPE_ANY) &&
 711        (record->type != frc->type) )
 712     {
 713       GNUNET_STATISTICS_update (GDS_stats,
 714                                 gettext_noop ("# Key match, type mismatches in REPLY to CLIENT"), 1,
 715                                 GNUNET_NO);
 716       return GNUNET_YES; /* type mismatch */
 717     }
 718   GNUNET_CRYPTO_hash (frc->data,
 719                       frc->data_size,
 720                       &ch);
 721   for (i=0;i<record->seen_replies_count;i++)
 722     if (0 == memcmp (&record->seen_replies[i],
 723                      &ch,
 724                      sizeof (GNUNET_HashCode)))
 725       {
 726         GNUNET_STATISTICS_update (GDS_stats,
 727                                   gettext_noop ("# Duplicate REPLIES to CLIENT request dropped"), 1,
 728                                   GNUNET_NO);
 729         return GNUNET_YES; /* duplicate */
 730       }
 731   eval =
 732     GNUNET_BLOCK_evaluate (GDS_block_context,
 733                            record->type, key,
 734                            NULL, 0,
 735                            record->xquery,
 736                            record->xquery_size,
 737                            frc->data,
 738                            frc->data_size);
 739   switch (eval)
 740   {
 741   case GNUNET_BLOCK_EVALUATION_OK_LAST:
 742     do_free = GNUNET_YES;
 743     break;
 744   case GNUNET_BLOCK_EVALUATION_OK_MORE:
 745     GNUNET_array_append (record->seen_replies,
 746                          record->seen_replies_count,
 747                          ch);
 748     do_free = GNUNET_NO;
 749     break;
 750   case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
 751     /* should be impossible to encounter here */
 752     GNUNET_break (0);
 753     return GNUNET_YES;
 754   case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
 755     GNUNET_break_op (0);
 756     return GNUNET_NO;
 757   case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
 758     GNUNET_break (0);
 759     return GNUNET_NO;
 760   case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
 761     GNUNET_break (0);
 762     return GNUNET_NO;
 763   case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
 764     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 765                 _("Unsupported block type (%u) in request!\n"),
 766                 record->type);
 767     return GNUNET_NO;
 768   }
 769   if (GNUNET_NO == frc->do_copy)
 770     {
 771       /* first time, we can use the original data */
 772       pm = frc->pm;
 773       frc->do_copy = GNUNET_YES;
 774     }
 775   else
 776     {
 777       /* two clients waiting for same reply, must copy for queueing */
 778       pm = GNUNET_malloc (sizeof (struct PendingMessage) +
 779                           ntohs (frc->pm->msg->size));
 780       memcpy (pm, frc->pm,
 781               sizeof (struct PendingMessage) + ntohs (frc->pm->msg->size));
 782       pm->next = pm->prev = NULL;
 783     }
 784   GNUNET_STATISTICS_update (GDS_stats,
 785                             gettext_noop ("# RESULTS queued for clients"), 1,
 786                             GNUNET_NO);
 787   reply = (struct GNUNET_DHT_ClientResultMessage*) &pm[1];
 788   reply->unique_id = record->unique_id;
 789   add_pending_message (record->client, pm);
 790   if (GNUNET_YES == do_free)
 791     remove_client_records (record->client, key, record);
 792   return GNUNET_YES;
 793 }
 794
 795
 796 /**
 797  * Handle a reply we've received from another peer.  If the reply
 798  * matches any of our pending queries, forward it to the respective
 799  * client(s).
 800  *
 801  * @param expiration when will the reply expire
 802  * @param key the query this reply is for
 803  * @param get_path_length number of peers in 'get_path'
 804  * @param get_path path the reply took on get
 805  * @param put_path_length number of peers in 'put_path'
 806  * @param put_path path the reply took on put
 807  * @param type type of the reply
 808  * @param data_size number of bytes in 'data'
 809  * @param data application payload data
 810  */
 811 void
 812 GDS_CLIENTS_handle_reply (struct GNUNET_TIME_Absolute expiration,
 813                          const GNUNET_HashCode *key,
 814                          unsigned int get_path_length,
 815                          const struct GNUNET_PeerIdentity *get_path,
 816                          unsigned int put_path_length,
 817                          const struct GNUNET_PeerIdentity *put_path,
 818                          enum GNUNET_BLOCK_Type type,
 819                          size_t data_size,
 820                          const void *data)
 821 {
 822   struct ForwardReplyContext frc;
 823   struct PendingMessage *pm;
 824   struct GNUNET_DHT_ClientResultMessage *reply;
 825   struct GNUNET_PeerIdentity *paths;
 826   size_t msize;
 827
 828   if (NULL ==
 829       GNUNET_CONTAINER_multihashmap_get (forward_map, key))
 830   {
 831     GNUNET_STATISTICS_update (GDS_stats,
 832                               gettext_noop ("# REPLIES ignored for CLIENTS (no match)"), 1,
 833                               GNUNET_NO);
 834     return; /* no matching request, fast exit! */
 835   }
 836   msize = sizeof(struct GNUNET_DHT_ClientResultMessage) + data_size +
 837     (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
 838   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 839     {
 840       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 841                   _("Could not pass reply to client, message too big!\n"));
 842       return;
 843     }
 844   pm = (struct PendingMessage *) GNUNET_malloc (msize + sizeof (struct PendingMessage));
 845   reply = (struct GNUNET_DHT_ClientResultMessage*) &pm[1];
 846   pm->msg = &reply->header;
 847   reply->header.size = htons ((uint16_t) msize);
 848   reply->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_CLIENT_RESULT);
 849   reply->type = htonl (type);
 850   reply->get_path_length = htonl (get_path_length);
 851   reply->put_path_length = htonl (put_path_length);
 852   reply->unique_id = 0; /* filled in later */
 853   reply->expiration = GNUNET_TIME_absolute_hton (expiration);
 854   reply->key = *key;
 855   paths = (struct GNUNET_PeerIdentity*) &reply[1];
 856   memcpy (paths, get_path,
 857           sizeof (struct GNUNET_PeerIdentity) * get_path_length);
 858   memcpy (&paths[get_path_length],
 859           put_path, sizeof (struct GNUNET_PeerIdentity) * put_path_length);
 860   memcpy (&paths[get_path_length + put_path_length],
 861           data,
 862           data_size);
 863   frc.do_copy = GNUNET_NO;
 864   frc.pm = pm;
 865   frc.data = data;
 866   frc.data_size = data_size;
 867   frc.type = type;
 868   GNUNET_CONTAINER_multihashmap_get_multiple (forward_map, key,
 869                                               &forward_reply,
 870                                               &frc);
 871   if (GNUNET_NO == frc.do_copy)
 872     {
 873       /* did not match any of the requests, free! */
 874       GNUNET_free (pm);
 875     }
 876 }
 877
 878
 879 /**
 880  * Initialize client subsystem.
 881  *
 882  * @param server the initialized server
 883  */
 884 void
 885 GDS_CLIENTS_init (struct GNUNET_SERVER_Handle *server)
 886 {
 887   static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
 888     {&handle_dht_local_put, NULL,
 889      GNUNET_MESSAGE_TYPE_DHT_CLIENT_PUT, 0},
 890     {&handle_dht_local_get, NULL,
 891      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET, 0},
 892     {&handle_dht_local_get_stop, NULL,
 893      GNUNET_MESSAGE_TYPE_DHT_CLIENT_GET_STOP,
 894      sizeof (struct GNUNET_DHT_ClientGetStopMessage) },
 895     {NULL, NULL, 0, 0}
 896   };
 897   forward_map = GNUNET_CONTAINER_multihashmap_create (1024);
 898   retry_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
 899   GNUNET_SERVER_add_handlers (server, plugin_handlers);
 900   GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
 901 }
 902
 903
 904 /**
 905  * Shutdown client subsystem.
 906  */
 907 void
 908 GDS_CLIENTS_done ()
 909 {
 910   GNUNET_assert (client_head == NULL);
 911   GNUNET_assert (client_tail == NULL);
 912   if (GNUNET_SCHEDULER_NO_TASK != retry_task)
 913     {
 914       GNUNET_SCHEDULER_cancel (retry_task);
 915       retry_task = GNUNET_SCHEDULER_NO_TASK;
 916     }
 917   GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (retry_heap));
 918   GNUNET_CONTAINER_heap_destroy (retry_heap);
 919   retry_heap = NULL;
 920   GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (forward_map));
 921   GNUNET_CONTAINER_multihashmap_destroy (forward_map);
 922   forward_map = NULL;
 923 }
 924
 925 /* end of gnunet-service-dht_clients.c */
 926