src/dht/gnunet-service-dht_neighbours.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_neighbours.c
  23  * @brief GNUnet DHT service's bucket and neighbour management code
  24  * @author Christian Grothoff
  25  * @author Nathan Evans
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_block_lib.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_hello_lib.h"
  32 #include "gnunet_constants.h"
  33 #include "gnunet_protocols.h"
  34 #include "gnunet_nse_service.h"
  35 #include "gnunet_core_service.h"
  36 #include "gnunet_datacache_lib.h"
  37 #include "gnunet_transport_service.h"
  38 #include "gnunet_hello_lib.h"
  39 #include "gnunet_dht_service.h"
  40 #include "gnunet_statistics_service.h"
  41 #include "dht.h"
  42 #include "gnunet-service-dht.h"
  43 #include "gnunet-service-dht_clients.h"
  44 #include "gnunet-service-dht_datacache.h"
  45 #include "gnunet-service-dht_hello.h"
  46 #include "gnunet-service-dht_neighbours.h"
  47 #include "gnunet-service-dht_nse.h"
  48 #include "gnunet-service-dht_routing.h"
  49 #include <fenv.h>
  50
  51 /**
  52  * How many buckets will we allow total.
  53  */
  54 #define MAX_BUCKETS sizeof (GNUNET_HashCode) * 8
  55
  56 /**
  57  * What is the maximum number of peers in a given bucket.
  58  */
  59 #define DEFAULT_BUCKET_SIZE 4
  60
  61 /**
  62  * Size of the bloom filter the DHT uses to filter peers.
  63  */
  64 #define DHT_BLOOM_SIZE 128
  65
  66 /**
  67  * Desired replication level for FIND PEER requests
  68  */
  69 #define FIND_PEER_REPLICATION_LEVEL 4
  70
  71 /**
  72  * Maximum allowed replication level for all requests.
  73  */
  74 #define MAXIMUM_REPLICATION_LEVEL 16
  75
  76 /**
  77  * How often to update our preference levels for peers in our routing tables.
  78  */
  79 #define DHT_DEFAULT_PREFERENCE_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 2)
  80
  81 /**
  82  * How long at least to wait before sending another find peer request.
  83  */
  84 #define DHT_MINIMUM_FIND_PEER_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 2)
  85
  86 /**
  87  * How long at most to wait before sending another find peer request.
  88  */
  89 #define DHT_MAXIMUM_FIND_PEER_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 8)
  90
  91 /**
  92  * How long at most to wait for transmission of a GET request to another peer?
  93  */
  94 #define GET_TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 2)
  95
  96
  97 /**
  98  * P2P PUT message
  99  */
 100 struct PeerPutMessage
 101 {
 102   /**
 103    * Type: GNUNET_MESSAGE_TYPE_DHT_P2P_PUT
 104    */
 105   struct GNUNET_MessageHeader header;
 106
 107   /**
 108    * Processing options
 109    */
 110   uint32_t options GNUNET_PACKED;
 111
 112   /**
 113    * Content type.
 114    */
 115   uint32_t type GNUNET_PACKED;
 116
 117   /**
 118    * Hop count
 119    */
 120   uint32_t hop_count GNUNET_PACKED;
 121
 122   /**
 123    * Replication level for this message
 124    */
 125   uint32_t desired_replication_level GNUNET_PACKED;
 126
 127   /**
 128    * Length of the PUT path that follows (if tracked).
 129    */
 130   uint32_t put_path_length GNUNET_PACKED;
 131
 132   /**
 133    * When does the content expire?
 134    */
 135   struct GNUNET_TIME_AbsoluteNBO expiration_time;
 136
 137   /**
 138    * Bloomfilter (for peer identities) to stop circular routes
 139    */
 140   char bloomfilter[DHT_BLOOM_SIZE];
 141
 142   /**
 143    * The key we are storing under.
 144    */
 145   GNUNET_HashCode key;
 146
 147   /* put path (if tracked) */
 148
 149   /* Payload */
 150
 151 };
 152
 153
 154 /**
 155  * P2P Result message
 156  */
 157 struct PeerResultMessage
 158 {
 159   /**
 160    * Type: GNUNET_MESSAGE_TYPE_DHT_P2P_RESULT
 161    */
 162   struct GNUNET_MessageHeader header;
 163
 164   /**
 165    * Content type.
 166    */
 167   uint32_t type GNUNET_PACKED;
 168
 169   /**
 170    * Length of the PUT path that follows (if tracked).
 171    */
 172   uint32_t put_path_length GNUNET_PACKED;
 173
 174   /**
 175    * Length of the GET path that follows (if tracked).
 176    */
 177   uint32_t get_path_length GNUNET_PACKED;
 178
 179   /**
 180    * When does the content expire?
 181    */
 182   struct GNUNET_TIME_AbsoluteNBO expiration_time;
 183
 184   /**
 185    * The key of the corresponding GET request.
 186    */
 187   GNUNET_HashCode key;
 188
 189   /* put path (if tracked) */
 190
 191   /* get path (if tracked) */
 192
 193   /* Payload */
 194
 195 };
 196
 197
 198 /**
 199  * P2P GET message
 200  */
 201 struct PeerGetMessage
 202 {
 203   /**
 204    * Type: GNUNET_MESSAGE_TYPE_DHT_P2P_GET
 205    */
 206   struct GNUNET_MessageHeader header;
 207
 208   /**
 209    * Processing options
 210    */
 211   uint32_t options GNUNET_PACKED;
 212
 213   /**
 214    * Desired content type.
 215    */
 216   uint32_t type GNUNET_PACKED;
 217
 218   /**
 219    * Hop count
 220    */
 221   uint32_t hop_count GNUNET_PACKED;
 222
 223   /**
 224    * Desired replication level for this request.
 225    */
 226   uint32_t desired_replication_level GNUNET_PACKED;
 227
 228   /**
 229    * Size of the extended query.
 230    */
 231   uint32_t xquery_size;
 232
 233   /**
 234    * Bloomfilter mutator.
 235    */
 236   uint32_t bf_mutator;
 237
 238   /**
 239    * Bloomfilter (for peer identities) to stop circular routes
 240    */
 241   char bloomfilter[DHT_BLOOM_SIZE];
 242
 243   /**
 244    * The key we are looking for.
 245    */
 246   GNUNET_HashCode key;
 247
 248   /* xquery */
 249
 250   /* result bloomfilter */
 251
 252 };
 253
 254
 255 /**
 256  * Linked list of messages to send to a particular other peer.
 257  */
 258 struct P2PPendingMessage
 259 {
 260   /**
 261    * Pointer to next item in the list
 262    */
 263   struct P2PPendingMessage *next;
 264
 265   /**
 266    * Pointer to previous item in the list
 267    */
 268   struct P2PPendingMessage *prev;
 269
 270   /**
 271    * Message importance level.  FIXME: used? useful?
 272    */
 273   unsigned int importance;
 274
 275   /**
 276    * When does this message time out?
 277    */
 278   struct GNUNET_TIME_Absolute timeout;
 279
 280   /**
 281    * Actual message to be sent, allocated at the end of the struct:
 282    * // msg = (cast) &pm[1];
 283    * // memcpy (&pm[1], data, len);
 284    */
 285   const struct GNUNET_MessageHeader *msg;
 286
 287 };
 288
 289
 290 /**
 291  * Entry for a peer in a bucket.
 292  */
 293 struct PeerInfo
 294 {
 295   /**
 296    * Next peer entry (DLL)
 297    */
 298   struct PeerInfo *next;
 299
 300   /**
 301    *  Prev peer entry (DLL)
 302    */
 303   struct PeerInfo *prev;
 304
 305   /**
 306    * Count of outstanding messages for peer.  FIXME: NEEDED?
 307    * FIXME: bound queue size!?
 308    */
 309   unsigned int pending_count;
 310
 311   /**
 312    * Head of pending messages to be sent to this peer.
 313    */
 314   struct P2PPendingMessage *head;
 315
 316   /**
 317    * Tail of pending messages to be sent to this peer.
 318    */
 319   struct P2PPendingMessage *tail;
 320
 321   /**
 322    * Core handle for sending messages to this peer.
 323    */
 324   struct GNUNET_CORE_TransmitHandle *th;
 325
 326   /**
 327    * Preference update context
 328    */
 329   struct GNUNET_CORE_InformationRequestContext *info_ctx;
 330
 331   /**
 332    * Task for scheduling preference updates
 333    */
 334   GNUNET_SCHEDULER_TaskIdentifier preference_task;
 335
 336   /**
 337    * What is the identity of the peer?
 338    */
 339   struct GNUNET_PeerIdentity id;
 340
 341 #if 0
 342   /**
 343    * What is the average latency for replies received?
 344    */
 345   struct GNUNET_TIME_Relative latency;
 346
 347   /**
 348    * Transport level distance to peer.
 349    */
 350   unsigned int distance;
 351 #endif
 352
 353 };
 354
 355
 356 /**
 357  * Peers are grouped into buckets.
 358  */
 359 struct PeerBucket
 360 {
 361   /**
 362    * Head of DLL
 363    */
 364   struct PeerInfo *head;
 365
 366   /**
 367    * Tail of DLL
 368    */
 369   struct PeerInfo *tail;
 370
 371   /**
 372    * Number of peers in the bucket.
 373    */
 374   unsigned int peers_size;
 375 };
 376
 377
 378 /**
 379  * The lowest currently used bucket, initially 0 (for 0-bits matching bucket).
 380  */
 381 static unsigned int closest_bucket;
 382
 383 /**
 384  * How many peers have we added since we sent out our last
 385  * find peer request?
 386  */
 387 static unsigned int newly_found_peers;
 388
 389 /**
 390  * The buckets.  Array of size MAX_BUCKET_SIZE.  Offset 0 means 0 bits matching.
 391  */
 392 static struct PeerBucket k_buckets[MAX_BUCKETS];
 393
 394 /**
 395  * Hash map of all known peers, for easy removal from k_buckets on disconnect.
 396  */
 397 static struct GNUNET_CONTAINER_MultiHashMap *all_known_peers;
 398
 399 /**
 400  * Maximum size for each bucket.
 401  */
 402 static unsigned int bucket_size = DEFAULT_BUCKET_SIZE;
 403
 404 /**
 405  * Task that sends FIND PEER requests.
 406  */
 407 static GNUNET_SCHEDULER_TaskIdentifier find_peer_task;
 408
 409 /**
 410  * Identity of this peer.
 411  */
 412 static struct GNUNET_PeerIdentity my_identity;
 413
 414 /**
 415  * Handle to GNUnet core.
 416  */
 417 static struct GNUNET_CORE_Handle *coreAPI;
 418
 419
 420 /**
 421  * Find the optimal bucket for this key.
 422  *
 423  * @param hc the hashcode to compare our identity to
 424  * @return the proper bucket index, or GNUNET_SYSERR
 425  *         on error (same hashcode)
 426  */
 427 static int
 428 find_bucket (const GNUNET_HashCode * hc)
 429 {
 430   unsigned int bits;
 431
 432   bits = GNUNET_CRYPTO_hash_matching_bits (&my_identity.hashPubKey, hc);
 433   if (bits == MAX_BUCKETS)
 434     {
 435       /* How can all bits match? Got my own ID? */
 436       GNUNET_break (0);
 437       return GNUNET_SYSERR;
 438     }
 439   return MAX_BUCKETS - bits - 1;
 440 }
 441
 442
 443 /**
 444  * Let GNUnet core know that we like the given peer.
 445  *
 446  * @param cls the 'struct PeerInfo' of the peer
 447  * @param tc scheduler context.
 448  */
 449 static void
 450 update_core_preference (void *cls,
 451                         const struct GNUNET_SCHEDULER_TaskContext *tc);
 452
 453
 454 /**
 455  * Function called with statistics about the given peer.
 456  *
 457  * @param cls closure
 458  * @param peer identifies the peer
 459  * @param bpm_out set to the current bandwidth limit (sending) for this peer
 460  * @param amount set to the amount that was actually reserved or unreserved;
 461  *               either the full requested amount or zero (no partial reservations)
 462  * @param res_delay if the reservation could not be satisfied (amount was 0), how
 463  *        long should the client wait until re-trying?
 464  * @param preference current traffic preference for the given peer
 465  */
 466 static void
 467 update_core_preference_finish (void *cls,
 468                                const struct GNUNET_PeerIdentity *peer,
 469                                struct GNUNET_BANDWIDTH_Value32NBO bpm_out,
 470                                int32_t amount,
 471                                struct GNUNET_TIME_Relative res_delay,
 472                                uint64_t preference)
 473 {
 474   struct PeerInfo *peer_info = cls;
 475
 476   peer_info->info_ctx = NULL;
 477   peer_info->preference_task
 478     = GNUNET_SCHEDULER_add_delayed (DHT_DEFAULT_PREFERENCE_INTERVAL,
 479                                     &update_core_preference, peer_info);
 480 }
 481
 482
 483 /**
 484  * Let GNUnet core know that we like the given peer.
 485  *
 486  * @param cls the 'struct PeerInfo' of the peer
 487  * @param tc scheduler context.
 488  */
 489 static void
 490 update_core_preference (void *cls,
 491                         const struct GNUNET_SCHEDULER_TaskContext *tc)
 492 {
 493   struct PeerInfo *peer = cls;
 494   uint64_t preference;
 495   unsigned int matching;
 496   int bucket;
 497
 498   peer->preference_task = GNUNET_SCHEDULER_NO_TASK;
 499   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 500     return;
 501   matching =
 502     GNUNET_CRYPTO_hash_matching_bits (&my_identity.hashPubKey,
 503                                       &peer->id.hashPubKey);
 504   if (matching >= 64)
 505     matching = 63;
 506   bucket = find_bucket(&peer->id.hashPubKey);
 507   if (bucket == GNUNET_SYSERR)
 508     preference = 0;
 509   else
 510     preference = (1LL << matching) / k_buckets[bucket].peers_size;
 511   if (preference == 0)
 512     {
 513       peer->preference_task
 514         = GNUNET_SCHEDULER_add_delayed (DHT_DEFAULT_PREFERENCE_INTERVAL,
 515                                         &update_core_preference, peer);
 516       return;
 517     }
 518   GNUNET_STATISTICS_update (GDS_stats,
 519                             gettext_noop ("# Preference updates given to core"), 1,
 520                             GNUNET_NO);
 521   peer->info_ctx =
 522     GNUNET_CORE_peer_change_preference (coreAPI, &peer->id,
 523                                         GNUNET_TIME_UNIT_FOREVER_REL,
 524                                         GNUNET_BANDWIDTH_VALUE_MAX, 0,
 525                                         preference,
 526                                         &update_core_preference_finish, peer);
 527 }
 528
 529
 530 /**
 531  * Closure for 'add_known_to_bloom'.
 532  */
 533 struct BloomConstructorContext
 534 {
 535   /**
 536    * Bloom filter under construction.
 537    */
 538   struct GNUNET_CONTAINER_BloomFilter *bloom;
 539
 540   /**
 541    * Mutator to use.
 542    */
 543   uint32_t bf_mutator;
 544 };
 545
 546
 547 /**
 548  * Add each of the peers we already know to the bloom filter of
 549  * the request so that we don't get duplicate HELLOs.
 550  *
 551  * @param cls the 'struct BloomConstructorContext'.
 552  * @param key peer identity to add to the bloom filter
 553  * @param value value the peer information (unused)
 554  * @return GNUNET_YES (we should continue to iterate)
 555  */
 556 static int
 557 add_known_to_bloom (void *cls, const GNUNET_HashCode * key, void *value)
 558 {
 559   struct BloomConstructorContext *ctx = cls;
 560   GNUNET_HashCode mh;
 561
 562   GNUNET_BLOCK_mingle_hash (key, ctx->bf_mutator, &mh);
 563   GNUNET_CONTAINER_bloomfilter_add (ctx->bloom, &mh);
 564   return GNUNET_YES;
 565 }
 566
 567
 568 /**
 569  * Task to send a find peer message for our own peer identifier
 570  * so that we can find the closest peers in the network to ourselves
 571  * and attempt to connect to them.
 572  *
 573  * @param cls closure for this task
 574  * @param tc the context under which the task is running
 575  */
 576 static void
 577 send_find_peer_message (void *cls,
 578                         const struct GNUNET_SCHEDULER_TaskContext *tc)
 579 {
 580   struct GNUNET_TIME_Relative next_send_time;
 581   struct BloomConstructorContext bcc;
 582
 583   find_peer_task = GNUNET_SCHEDULER_NO_TASK;
 584   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 585     return;
 586   if (newly_found_peers > bucket_size)
 587   {
 588     /* If we are finding many peers already, no need to send out our request right now! */
 589     find_peer_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
 590                                                    &send_find_peer_message, NULL);
 591     newly_found_peers = 0;
 592     return;
 593   }
 594   bcc.bf_mutator = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, UINT32_MAX);
 595   bcc.bloom =
 596     GNUNET_CONTAINER_bloomfilter_init (NULL, DHT_BLOOM_SIZE, DHT_BLOOM_K);
 597   GNUNET_CONTAINER_multihashmap_iterate (all_known_peers,
 598                                          &add_known_to_bloom,
 599                                          &bcc);
 600   GNUNET_STATISTICS_update (GDS_stats,
 601                             gettext_noop ("# FIND PEER messages initiated"), 1,
 602                             GNUNET_NO);
 603   // FIXME: pass priority!?
 604   GDS_NEIGHBOURS_handle_get (GNUNET_BLOCK_TYPE_DHT_HELLO,
 605                              GNUNET_DHT_RO_FIND_PEER,
 606                              FIND_PEER_REPLICATION_LEVEL,
 607                              0,
 608                              &my_identity.hashPubKey,
 609                              NULL, 0,
 610                              bcc.bloom, bcc.bf_mutator, NULL);
 611   GNUNET_CONTAINER_bloomfilter_free (bcc.bloom);
 612   /* schedule next round */
 613   newly_found_peers = 0;
 614   next_send_time.rel_value =
 615     (DHT_MAXIMUM_FIND_PEER_INTERVAL.rel_value / 2) +
 616     GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
 617                               DHT_MAXIMUM_FIND_PEER_INTERVAL.rel_value / 2);
 618   find_peer_task = GNUNET_SCHEDULER_add_delayed (next_send_time,
 619                                                  &send_find_peer_message,
 620                                                  NULL);
 621 }
 622
 623
 624 /**
 625  * Method called whenever a peer connects.
 626  *
 627  * @param cls closure
 628  * @param peer peer identity this notification is about
 629  * @param atsi performance data
 630  */
 631 static void
 632 handle_core_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
 633                      const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 634 {
 635   struct PeerInfo *ret;
 636   int peer_bucket;
 637
 638   /* Check for connect to self message */
 639   if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
 640     return;
 641   if (GNUNET_YES ==
 642       GNUNET_CONTAINER_multihashmap_contains (all_known_peers,
 643                                               &peer->hashPubKey))
 644   {
 645     GNUNET_break (0);
 646     return;
 647   }
 648   GNUNET_STATISTICS_update (GDS_stats,
 649                             gettext_noop ("# Peers connected"), 1,
 650                             GNUNET_NO);
 651   peer_bucket = find_bucket (&peer->hashPubKey);
 652   GNUNET_assert ( (peer_bucket >= 0) && (peer_bucket < MAX_BUCKETS) );
 653   ret = GNUNET_malloc (sizeof (struct PeerInfo));
 654 #if 0
 655   ret->latency = latency;
 656   ret->distance = distance;
 657 #endif
 658   ret->id = *peer;
 659   GNUNET_CONTAINER_DLL_insert_tail (k_buckets[peer_bucket].head,
 660                                     k_buckets[peer_bucket].tail, ret);
 661   k_buckets[peer_bucket].peers_size++;
 662   closest_bucket = GNUNET_MAX (closest_bucket,
 663                                peer_bucket);
 664   if ( (peer_bucket > 0) &&
 665        (k_buckets[peer_bucket].peers_size <= bucket_size) )
 666     ret->preference_task = GNUNET_SCHEDULER_add_now (&update_core_preference, ret);
 667   newly_found_peers++;
 668   GNUNET_assert (GNUNET_OK ==
 669                  GNUNET_CONTAINER_multihashmap_put (all_known_peers,
 670                                                     &peer->hashPubKey, ret,
 671                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 672   if (1 == GNUNET_CONTAINER_multihashmap_size (all_known_peers))
 673   {
 674     /* got a first connection, good time to start with FIND PEER requests... */
 675     find_peer_task = GNUNET_SCHEDULER_add_now (&send_find_peer_message,
 676                                                NULL);
 677   }
 678 }
 679
 680
 681 /**
 682  * Method called whenever a peer disconnects.
 683  *
 684  * @param cls closure
 685  * @param peer peer identity this notification is about
 686  */
 687 static void
 688 handle_core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 689 {
 690   struct PeerInfo *to_remove;
 691   int current_bucket;
 692   struct P2PPendingMessage *pos;
 693
 694   /* Check for disconnect from self message */
 695   if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
 696     return;
 697   to_remove =
 698       GNUNET_CONTAINER_multihashmap_get (all_known_peers, &peer->hashPubKey);
 699   if (NULL == to_remove)
 700     {
 701       GNUNET_break (0);
 702       return;
 703     }
 704   GNUNET_STATISTICS_update (GDS_stats,
 705                             gettext_noop ("# Peers connected"), -1,
 706                             GNUNET_NO);
 707   GNUNET_assert (GNUNET_YES ==
 708                  GNUNET_CONTAINER_multihashmap_remove (all_known_peers,
 709                                                        &peer->hashPubKey,
 710                                                        to_remove));
 711   if (NULL != to_remove->info_ctx)
 712   {
 713     GNUNET_CORE_peer_change_preference_cancel (to_remove->info_ctx);
 714     to_remove->info_ctx = NULL;
 715   }
 716   current_bucket = find_bucket (&to_remove->id.hashPubKey);
 717   GNUNET_CONTAINER_DLL_remove (k_buckets[current_bucket].head,
 718                                k_buckets[current_bucket].tail,
 719                                to_remove);
 720   GNUNET_assert (k_buckets[current_bucket].peers_size > 0);
 721   k_buckets[current_bucket].peers_size--;
 722   while ( (closest_bucket > 0) &&
 723           (k_buckets[closest_bucket].peers_size == 0) )
 724     closest_bucket--;
 725
 726   if (to_remove->th != NULL)
 727   {
 728     GNUNET_CORE_notify_transmit_ready_cancel (to_remove->th);
 729     to_remove->th = NULL;
 730   }
 731   while (NULL != (pos = to_remove->head))
 732   {
 733     GNUNET_CONTAINER_DLL_remove (to_remove->head,
 734                                  to_remove->tail,
 735                                  pos);
 736     GNUNET_free (pos);
 737   }
 738 }
 739
 740
 741 /**
 742  * Called when core is ready to send a message we asked for
 743  * out to the destination.
 744  *
 745  * @param cls the 'struct PeerInfo' of the target peer
 746  * @param size number of bytes available in buf
 747  * @param buf where the callee should write the message
 748  * @return number of bytes written to buf
 749  */
 750 static size_t
 751 core_transmit_notify (void *cls, size_t size, void *buf)
 752 {
 753   struct PeerInfo *peer = cls;
 754   char *cbuf = buf;
 755   struct P2PPendingMessage *pending;
 756   size_t off;
 757   size_t msize;
 758
 759   peer->th = NULL;
 760   if (buf == NULL)
 761   {
 762     /* client disconnected */
 763     return 0;
 764   }
 765   if (peer->head == NULL)
 766   {
 767     /* no messages pending */
 768     return 0;
 769   }
 770   off = 0;
 771   while ( (NULL != (pending = peer->head)) &&
 772           (size - off >= (msize = ntohs (pending->msg->size))) )
 773   {
 774     GNUNET_STATISTICS_update (GDS_stats,
 775                               gettext_noop ("# Bytes transmitted to other peers"), msize,
 776                               GNUNET_NO);
 777     memcpy (&cbuf[off], pending->msg, msize);
 778     off += msize;
 779     peer->pending_count--;
 780     GNUNET_CONTAINER_DLL_remove (peer->head, peer->tail, pending);
 781     GNUNET_free (pending);
 782   }
 783   if (peer->head != NULL)
 784     peer->th
 785       = GNUNET_CORE_notify_transmit_ready (coreAPI, GNUNET_YES,
 786                                            pending->importance,
 787                                            GNUNET_TIME_absolute_get_remaining (pending->timeout),
 788                                            &peer->id, msize,
 789                                            &core_transmit_notify, peer);
 790   return off;
 791 }
 792
 793
 794 /**
 795  * Transmit all messages in the peer's message queue.
 796  *
 797  * @param peer message queue to process
 798  */
 799 static void
 800 process_peer_queue (struct PeerInfo *peer)
 801 {
 802   struct P2PPendingMessage *pending;
 803
 804   if (NULL != (pending = peer->head))
 805     return;
 806   if (NULL != peer->th)
 807     return;
 808   peer->th
 809     = GNUNET_CORE_notify_transmit_ready (coreAPI, GNUNET_YES,
 810                                          pending->importance,
 811                                          GNUNET_TIME_absolute_get_remaining (pending->timeout),
 812                                          &peer->id,
 813                                          ntohs (pending->msg->size),
 814                                          &core_transmit_notify, peer);
 815 }
 816
 817
 818 /**
 819  * To how many peers should we (on average) forward the request to
 820  * obtain the desired target_replication count (on average).
 821  *
 822  * @param hop_count number of hops the message has traversed
 823  * @param target_replication the number of total paths desired
 824  * @return Some number of peers to forward the message to
 825  */
 826 static unsigned int
 827 get_forward_count (uint32_t hop_count,
 828                    uint32_t target_replication)
 829 {
 830   uint32_t random_value;
 831   uint32_t forward_count;
 832   float target_value;
 833
 834   if (hop_count > GDS_NSE_get () * 4.0)
 835   {
 836     /* forcefully terminate */
 837     return 0;
 838   }
 839   if (hop_count > GDS_NSE_get () * 2.0)
 840   {
 841     /* Once we have reached our ideal number of hops, only forward to 1 peer */
 842     return 1;
 843   }
 844   /* bound by system-wide maximum */
 845   target_replication = GNUNET_MIN (MAXIMUM_REPLICATION_LEVEL,
 846                                    target_replication);
 847   target_value =
 848     1 + (target_replication - 1.0) / (GDS_NSE_get () +
 849                                       ((float) (target_replication - 1.0) *
 850                                        hop_count));
 851   /* Set forward count to floor of target_value */
 852   forward_count = (uint32_t) target_value;
 853   /* Subtract forward_count (floor) from target_value (yields value between 0 and 1) */
 854   target_value = target_value - forward_count;
 855   random_value =
 856     GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_STRONG, UINT32_MAX);
 857   if (random_value < (target_value * UINT32_MAX))
 858     forward_count++;
 859   return forward_count;
 860 }
 861
 862
 863 /**
 864  * Compute the distance between have and target as a 32-bit value.
 865  * Differences in the lower bits must count stronger than differences
 866  * in the higher bits.
 867  *
 868  * @return 0 if have==target, otherwise a number
 869  *           that is larger as the distance between
 870  *           the two hash codes increases
 871  */
 872 static unsigned int
 873 get_distance (const GNUNET_HashCode * target, const GNUNET_HashCode * have)
 874 {
 875   unsigned int bucket;
 876   unsigned int msb;
 877   unsigned int lsb;
 878   unsigned int i;
 879
 880   /* We have to represent the distance between two 2^9 (=512)-bit
 881    * numbers as a 2^5 (=32)-bit number with "0" being used for the
 882    * two numbers being identical; furthermore, we need to
 883    * guarantee that a difference in the number of matching
 884    * bits is always represented in the result.
 885    *
 886    * We use 2^32/2^9 numerical values to distinguish between
 887    * hash codes that have the same LSB bit distance and
 888    * use the highest 2^9 bits of the result to signify the
 889    * number of (mis)matching LSB bits; if we have 0 matching
 890    * and hence 512 mismatching LSB bits we return -1 (since
 891    * 512 itself cannot be represented with 9 bits) */
 892
 893   /* first, calculate the most significant 9 bits of our
 894    * result, aka the number of LSBs */
 895   bucket = GNUNET_CRYPTO_hash_matching_bits (target, have);
 896   /* bucket is now a value between 0 and 512 */
 897   if (bucket == 512)
 898     return 0;                   /* perfect match */
 899   if (bucket == 0)
 900     return (unsigned int) -1;   /* LSB differs; use max (if we did the bit-shifting
 901                                  * below, we'd end up with max+1 (overflow)) */
 902
 903   /* calculate the most significant bits of the final result */
 904   msb = (512 - bucket) << (32 - 9);
 905   /* calculate the 32-9 least significant bits of the final result by
 906    * looking at the differences in the 32-9 bits following the
 907    * mismatching bit at 'bucket' */
 908   lsb = 0;
 909   for (i = bucket + 1;
 910        (i < sizeof (GNUNET_HashCode) * 8) && (i < bucket + 1 + 32 - 9); i++)
 911   {
 912     if (GNUNET_CRYPTO_hash_get_bit (target, i) !=
 913         GNUNET_CRYPTO_hash_get_bit (have, i))
 914       lsb |= (1 << (bucket + 32 - 9 - i));      /* first bit set will be 10,
 915                                                  * last bit set will be 31 -- if
 916                                                  * i does not reach 512 first... */
 917   }
 918   return msb | lsb;
 919 }
 920
 921
 922 /**
 923  * Check whether my identity is closer than any known peers.  If a
 924  * non-null bloomfilter is given, check if this is the closest peer
 925  * that hasn't already been routed to.
 926  *
 927  * @param key hash code to check closeness to
 928  * @param bloom bloomfilter, exclude these entries from the decision
 929  * @return GNUNET_YES if node location is closest,
 930  *         GNUNET_NO otherwise.
 931  */
 932 static int
 933 am_closest_peer (const GNUNET_HashCode *key,
 934                  const struct GNUNET_CONTAINER_BloomFilter *bloom)
 935 {
 936   int bits;
 937   int other_bits;
 938   int bucket_num;
 939   int count;
 940   struct PeerInfo *pos;
 941
 942   if (0 == memcmp (&my_identity.hashPubKey, key, sizeof (GNUNET_HashCode)))
 943     return GNUNET_YES;
 944   bucket_num = find_bucket (key);
 945   bits = GNUNET_CRYPTO_hash_matching_bits (&my_identity.hashPubKey, key);
 946   pos = k_buckets[bucket_num].head;
 947   count = 0;
 948   while ((pos != NULL) && (count < bucket_size))
 949   {
 950     if ((bloom != NULL) &&
 951         (GNUNET_YES ==
 952          GNUNET_CONTAINER_bloomfilter_test (bloom, &pos->id.hashPubKey)))
 953     {
 954       pos = pos->next;
 955       continue;                 /* Skip already checked entries */
 956     }
 957     other_bits = GNUNET_CRYPTO_hash_matching_bits (&pos->id.hashPubKey, key);
 958     if (other_bits > bits)
 959       return GNUNET_NO;
 960     if (other_bits == bits)        /* We match the same number of bits */
 961       return GNUNET_YES;
 962     pos = pos->next;
 963   }
 964   /* No peers closer, we are the closest! */
 965   return GNUNET_YES;
 966 }
 967
 968
 969 /**
 970  * Select a peer from the routing table that would be a good routing
 971  * destination for sending a message for "key".  The resulting peer
 972  * must not be in the set of blocked peers.<p>
 973  *
 974  * Note that we should not ALWAYS select the closest peer to the
 975  * target, peers further away from the target should be chosen with
 976  * exponentially declining probability.
 977  *
 978  * FIXME: double-check that this is fine
 979  *
 980  *
 981  * @param key the key we are selecting a peer to route to
 982  * @param bloom a bloomfilter containing entries this request has seen already
 983  * @param hops how many hops has this message traversed thus far
 984  * @return Peer to route to, or NULL on error
 985  */
 986 static struct PeerInfo *
 987 select_peer (const GNUNET_HashCode *key,
 988              const struct GNUNET_CONTAINER_BloomFilter *bloom,
 989              uint32_t hops)
 990 {
 991   unsigned int bc;
 992   unsigned int count;
 993   unsigned int selected;
 994   struct PeerInfo *pos;
 995   unsigned int dist;
 996   unsigned int smallest_distance;
 997   struct PeerInfo *chosen;
 998
 999   if (hops >= GDS_NSE_get ())
1000   {
1001     /* greedy selection (closest peer that is not in bloomfilter) */
1002     smallest_distance = UINT_MAX;
1003     chosen = NULL;
1004     for (bc = closest_bucket; bc < MAX_BUCKETS; bc++)
1005     {
1006       pos = k_buckets[bc].head;
1007       count = 0;
1008       while ((pos != NULL) && (count < bucket_size))
1009       {
1010         if (GNUNET_NO ==
1011             GNUNET_CONTAINER_bloomfilter_test (bloom, &pos->id.hashPubKey))
1012         {
1013           dist = get_distance (key, &pos->id.hashPubKey);
1014           if (dist < smallest_distance)
1015           {
1016             chosen = pos;
1017             smallest_distance = dist;
1018           }
1019         }
1020         count++;
1021         pos = pos->next;
1022       }
1023     }
1024     return chosen;
1025   }
1026
1027   /* select "random" peer */
1028   /* count number of peers that are available and not filtered */
1029   count = 0;
1030   for (bc = closest_bucket; bc < MAX_BUCKETS; bc++)
1031   {
1032     pos = k_buckets[bc].head;
1033     while ((pos != NULL) && (count < bucket_size))
1034     {
1035       if (GNUNET_YES ==
1036           GNUNET_CONTAINER_bloomfilter_test (bloom, &pos->id.hashPubKey))
1037       {
1038         pos = pos->next;
1039         continue;               /* Ignore bloomfiltered peers */
1040       }
1041       count++;
1042       pos = pos->next;
1043     }
1044   }
1045   if (count == 0)               /* No peers to select from! */
1046   {
1047     return NULL;
1048   }
1049   /* Now actually choose a peer */
1050   selected = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, count);
1051   count = 0;
1052   for (bc = closest_bucket; bc < MAX_BUCKETS; bc++)
1053   {
1054     pos = k_buckets[bc].head;
1055     while ((pos != NULL) && (count < bucket_size))
1056     {
1057       if (GNUNET_YES ==
1058           GNUNET_CONTAINER_bloomfilter_test (bloom, &pos->id.hashPubKey))
1059       {
1060         pos = pos->next;
1061         continue;               /* Ignore bloomfiltered peers */
1062       }
1063       if (0 == selected--)
1064         return pos;
1065       pos = pos->next;
1066     }
1067   }
1068   GNUNET_break (0);
1069   return NULL;
1070 }
1071
1072
1073 /**
1074  * Compute the set of peers that the given request should be
1075  * forwarded to.
1076  *
1077  * @param key routing key
1078  * @param bloom bloom filter excluding peers as targets, all selected
1079  *        peers will be added to the bloom filter
1080  * @param hop_count number of hops the request has traversed so far
1081  * @param target_replication desired number of replicas
1082  * @param targets where to store an array of target peers (to be
1083  *         free'd by the caller)
1084  * @return number of peers returned in 'targets'.
1085  */
1086 static unsigned int
1087 get_target_peers (const GNUNET_HashCode *key,
1088                   struct GNUNET_CONTAINER_BloomFilter *bloom,
1089                   uint32_t hop_count,
1090                   uint32_t target_replication,
1091                   struct PeerInfo ***targets)
1092 {
1093   unsigned int ret;
1094   unsigned int off;
1095   struct PeerInfo **rtargets;
1096   struct PeerInfo *nxt;
1097
1098   ret = get_forward_count (hop_count, target_replication);
1099   if (ret == 0)
1100   {
1101     *targets = NULL;
1102     return 0;
1103   }
1104   rtargets = GNUNET_malloc (sizeof (struct PeerInfo*) * ret);
1105   off = 0;
1106   while (ret-- > 0)
1107   {
1108     nxt = select_peer (key, bloom, hop_count);
1109     if (nxt == NULL)
1110       break;
1111     rtargets[off++] = nxt;
1112     GNUNET_CONTAINER_bloomfilter_add (bloom, &nxt->id.hashPubKey);
1113   }
1114   if (0 == off)
1115   {
1116     GNUNET_free (rtargets);
1117     *targets = NULL;
1118     return 0;
1119   }
1120   *targets = rtargets;
1121   return off;
1122 }
1123
1124
1125 /**
1126  * Perform a PUT operation.   Forwards the given request to other
1127  * peers.   Does not store the data locally.  Does not give the
1128  * data to local clients.  May do nothing if this is the only
1129  * peer in the network (or if we are the closest peer in the
1130  * network).
1131  *
1132  * @param type type of the block
1133  * @param options routing options
1134  * @param desired_replication_level desired replication count
1135  * @param expiration_time when does the content expire
1136  * @param hop_count how many hops has this message traversed so far
1137  * @param bf Bloom filter of peers this PUT has already traversed
1138  * @param key key for the content
1139  * @param put_path_length number of entries in put_path
1140  * @param put_path peers this request has traversed so far (if tracked)
1141  * @param data payload to store
1142  * @param data_size number of bytes in data
1143  */
1144 void
1145 GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
1146                            enum GNUNET_DHT_RouteOption options,
1147                            uint32_t desired_replication_level,
1148                            struct GNUNET_TIME_Absolute expiration_time,
1149                            uint32_t hop_count,
1150                            struct GNUNET_CONTAINER_BloomFilter *bf,
1151                            const GNUNET_HashCode *key,
1152                            unsigned int put_path_length,
1153                            struct GNUNET_PeerIdentity *put_path,
1154                            const void *data,
1155                            size_t data_size)
1156 {
1157   unsigned int target_count;
1158   unsigned int i;
1159   struct PeerInfo **targets;
1160   struct PeerInfo *target;
1161   struct P2PPendingMessage *pending;
1162   size_t msize;
1163   struct PeerPutMessage *ppm;
1164   struct GNUNET_PeerIdentity *pp;
1165
1166   GNUNET_STATISTICS_update (GDS_stats,
1167                             gettext_noop ("# PUT requests routed"), 1,
1168                             GNUNET_NO);
1169   target_count = get_target_peers (key, bf, hop_count,
1170                                    desired_replication_level,
1171                                    &targets);
1172   if (0 == target_count)
1173     return;
1174   msize = put_path_length * sizeof (struct GNUNET_PeerIdentity) + data_size + sizeof (struct PeerPutMessage);
1175   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1176   {
1177     put_path_length = 0;
1178     msize = data_size + sizeof (struct PeerPutMessage);
1179   }
1180   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1181   {
1182     GNUNET_break (0);
1183     return;
1184   }
1185   GNUNET_STATISTICS_update (GDS_stats,
1186                             gettext_noop ("# Peers selected as targets for PUT requests"), target_count,
1187                             GNUNET_NO);
1188   for (i=0;i<target_count;i++)
1189   {
1190     target = targets[i];
1191     pending = GNUNET_malloc (sizeof (struct P2PPendingMessage) + msize);
1192     pending->importance = 0; /* FIXME */
1193     pending->timeout = expiration_time;
1194     ppm = (struct PeerPutMessage*) &pending[1];
1195     pending->msg = &ppm->header;
1196     ppm->header.size = htons (msize);
1197     ppm->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_P2P_PUT);
1198     ppm->options = htonl (options);
1199     ppm->type = htonl (type);
1200     ppm->hop_count = htonl (hop_count + 1);
1201     ppm->desired_replication_level = htonl (desired_replication_level);
1202     ppm->put_path_length = htonl (put_path_length);
1203     ppm->expiration_time = GNUNET_TIME_absolute_hton (expiration_time);
1204     GNUNET_assert (GNUNET_OK ==
1205                    GNUNET_CONTAINER_bloomfilter_get_raw_data (bf,
1206                                                               ppm->bloomfilter,
1207                                                               DHT_BLOOM_SIZE));
1208     ppm->key = *key;
1209     pp = (struct GNUNET_PeerIdentity*) &ppm[1];
1210     memcpy (pp, put_path, sizeof (struct GNUNET_PeerIdentity) * put_path_length);
1211     memcpy (&pp[put_path_length], data, data_size);
1212     GNUNET_CONTAINER_DLL_insert_tail (target->head,
1213                                       target->tail,
1214                                       pending);
1215     target->pending_count++;
1216     process_peer_queue (target);
1217   }
1218   GNUNET_free (targets);
1219 }
1220
1221
1222 /**
1223  * Perform a GET operation.  Forwards the given request to other
1224  * peers.  Does not lookup the key locally.  May do nothing if this is
1225  * the only peer in the network (or if we are the closest peer in the
1226  * network).
1227  *
1228  * @param type type of the block
1229  * @param options routing options
1230  * @param desired_replication_level desired replication count
1231  * @param hop_count how many hops did this request traverse so far?
1232  * @param key key for the content
1233  * @param xquery extended query
1234  * @param xquery_size number of bytes in xquery
1235  * @param reply_bf bloomfilter to filter duplicates
1236  * @param reply_bf_mutator mutator for reply_bf
1237  * @param peer_bf filter for peers not to select (again)
1238  */
1239 void
1240 GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type type,
1241                            enum GNUNET_DHT_RouteOption options,
1242                            uint32_t desired_replication_level,
1243                            uint32_t hop_count,
1244                            const GNUNET_HashCode *key,
1245                            const void *xquery,
1246                            size_t xquery_size,
1247                            const struct GNUNET_CONTAINER_BloomFilter *reply_bf,
1248                            uint32_t reply_bf_mutator,
1249                            struct GNUNET_CONTAINER_BloomFilter *peer_bf)
1250 {
1251   unsigned int target_count;
1252   unsigned int i;
1253   struct PeerInfo **targets;
1254   struct PeerInfo *target;
1255   struct P2PPendingMessage *pending;
1256   size_t msize;
1257   struct PeerGetMessage *pgm;
1258   char *xq;
1259   size_t reply_bf_size;
1260
1261   GNUNET_STATISTICS_update (GDS_stats,
1262                             gettext_noop ("# GET requests routed"), 1,
1263                             GNUNET_NO);
1264   target_count = get_target_peers (key, peer_bf, hop_count,
1265                                    desired_replication_level,
1266                                    &targets);
1267   if (0 == target_count)
1268     return;
1269   reply_bf_size = GNUNET_CONTAINER_bloomfilter_get_size (reply_bf);
1270   msize = xquery_size + sizeof (struct PeerGetMessage) + reply_bf_size;
1271   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1272   {
1273     GNUNET_break (0);
1274     return;
1275   }
1276   GNUNET_STATISTICS_update (GDS_stats,
1277                             gettext_noop ("# Peers selected as targets for GET requests"), target_count,
1278                             GNUNET_NO);
1279   /* forward request */
1280   for (i=0;i<target_count;i++)
1281   {
1282     target = targets[i];
1283     pending = GNUNET_malloc (sizeof (struct P2PPendingMessage) + msize);
1284     pending->importance = 0; /* FIXME */
1285     pending->timeout = GNUNET_TIME_relative_to_absolute (GET_TIMEOUT);
1286     pgm = (struct PeerGetMessage*) &pending[1];
1287     pending->msg = &pgm->header;
1288     pgm->header.size = htons (msize);
1289     pgm->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_P2P_GET);
1290     pgm->options = htonl (options);
1291     pgm->type = htonl (type);
1292     pgm->hop_count = htonl (hop_count + 1);
1293     pgm->desired_replication_level = htonl (desired_replication_level);
1294     pgm->xquery_size = htonl (xquery_size);
1295     pgm->bf_mutator = reply_bf_mutator;
1296     GNUNET_assert (GNUNET_OK ==
1297                    GNUNET_CONTAINER_bloomfilter_get_raw_data (peer_bf,
1298                                                               pgm->bloomfilter,
1299                                                               DHT_BLOOM_SIZE));
1300     pgm->key = *key;
1301     xq = (char *) &pgm[1];
1302     memcpy (xq, xquery, xquery_size);
1303     GNUNET_assert (GNUNET_OK ==
1304                    GNUNET_CONTAINER_bloomfilter_get_raw_data (reply_bf,
1305                                                               &xq[xquery_size],
1306                                                               reply_bf_size));
1307     GNUNET_CONTAINER_DLL_insert_tail (target->head,
1308                                       target->tail,
1309                                       pending);
1310     target->pending_count++;
1311     process_peer_queue (target);
1312   }
1313   GNUNET_free (targets);
1314 }
1315
1316
1317 /**
1318  * Handle a reply (route to origin).  Only forwards the reply back to
1319  * the given peer.  Does not do local caching or forwarding to local
1320  * clients.
1321  *
1322  * @param target neighbour that should receive the block (if still connected)
1323  * @param type type of the block
1324  * @param expiration_time when does the content expire
1325  * @param key key for the content
1326  * @param put_path_length number of entries in put_path
1327  * @param put_path peers the original PUT traversed (if tracked)
1328  * @param get_path_length number of entries in put_path
1329  * @param get_path peers this reply has traversed so far (if tracked)
1330  * @param data payload of the reply
1331  * @param data_size number of bytes in data
1332  */
1333 void
1334 GDS_NEIGHBOURS_handle_reply (const struct GNUNET_PeerIdentity *target,
1335                              enum GNUNET_BLOCK_Type type,
1336                              struct GNUNET_TIME_Absolute expiration_time,
1337                              const GNUNET_HashCode *key,
1338                              unsigned int put_path_length,
1339                              const struct GNUNET_PeerIdentity *put_path,
1340                              unsigned int get_path_length,
1341                              const struct GNUNET_PeerIdentity *get_path,
1342                              const void *data,
1343                              size_t data_size)
1344 {
1345   struct PeerInfo *pi;
1346   struct P2PPendingMessage *pending;
1347   size_t msize;
1348   struct PeerResultMessage *prm;
1349   struct GNUNET_PeerIdentity *paths;
1350
1351   msize = data_size + sizeof (struct PeerResultMessage) +
1352     (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity);
1353   if ( (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1354        (get_path_length > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_PeerIdentity)) ||
1355        (put_path_length > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_PeerIdentity)) ||
1356        (data_size > GNUNET_SERVER_MAX_MESSAGE_SIZE) )
1357   {
1358     GNUNET_break (0);
1359     return;
1360   }
1361   pi = GNUNET_CONTAINER_multihashmap_get (all_known_peers,
1362                                           &target->hashPubKey);
1363   if (NULL == pi)
1364   {
1365     /* peer disconnected in the meantime, drop reply */
1366     return;
1367   }
1368   GNUNET_STATISTICS_update (GDS_stats,
1369                             gettext_noop ("# REPLIES routed"), 1,
1370                             GNUNET_NO);
1371   pending = GNUNET_malloc (sizeof (struct P2PPendingMessage) + msize);
1372   pending->importance = 0; /* FIXME */
1373   pending->timeout = expiration_time;
1374   prm = (struct PeerResultMessage*) &pending[1];
1375   pending->msg = &prm->header;
1376   prm->header.size = htons (msize);
1377   prm->header.type = htons (GNUNET_MESSAGE_TYPE_DHT_P2P_RESULT);
1378   prm->type = htonl (type);
1379   prm->put_path_length = htonl (put_path_length);
1380   prm->get_path_length = htonl (get_path_length);
1381   prm->expiration_time = GNUNET_TIME_absolute_hton (expiration_time);
1382   prm->key = *key;
1383   paths = (struct GNUNET_PeerIdentity*) &prm[1];
1384   memcpy (paths, put_path, put_path_length * sizeof (struct GNUNET_PeerIdentity));
1385   memcpy (&paths[put_path_length],
1386           get_path, get_path_length * sizeof (struct GNUNET_PeerIdentity));
1387   memcpy (&paths[put_path_length + get_path_length],
1388           data, data_size);
1389   GNUNET_CONTAINER_DLL_insert (pi->head,
1390                                pi->tail,
1391                                pending);
1392   pi->pending_count++;
1393   process_peer_queue (pi);
1394 }
1395
1396
1397 /**
1398  * To be called on core init/fail.
1399  *
1400  * @param cls service closure
1401  * @param server handle to the server for this service
1402  * @param identity the public identity of this peer
1403  * @param publicKey the public key of this peer
1404  */
1405 static void
1406 core_init (void *cls, struct GNUNET_CORE_Handle *server,
1407            const struct GNUNET_PeerIdentity *identity,
1408            const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
1409 {
1410   GNUNET_assert (server != NULL);
1411   my_identity = *identity;
1412 }
1413
1414
1415 /**
1416  * Core handler for p2p put requests.
1417  *
1418  * @param cls closure
1419  * @param peer sender of the request
1420  * @param message message
1421  * @param peer peer identity this notification is about
1422  * @param atsi performance data
1423  * @return GNUNET_OK to keep the connection open,
1424  *         GNUNET_SYSERR to close it (signal serious error)
1425  */
1426 static int
1427 handle_dht_p2p_put (void *cls,
1428                     const struct GNUNET_PeerIdentity *peer,
1429                     const struct GNUNET_MessageHeader *message,
1430                     const struct GNUNET_TRANSPORT_ATS_Information
1431                     *atsi)
1432 {
1433   const struct PeerPutMessage *put;
1434   const struct GNUNET_PeerIdentity *put_path;
1435   const void *payload;
1436   uint32_t putlen;
1437   uint16_t msize;
1438   size_t payload_size;
1439   enum GNUNET_DHT_RouteOption options;
1440   struct GNUNET_CONTAINER_BloomFilter *bf;
1441   GNUNET_HashCode test_key;
1442
1443   msize = ntohs (message->size);
1444   if (msize < sizeof (struct PeerPutMessage))
1445   {
1446     GNUNET_break_op (0);
1447     return GNUNET_YES;
1448   }
1449   put = (const struct PeerPutMessage*) message;
1450   putlen = ntohl (put->put_path_length);
1451   if ( (msize < sizeof (struct PeerPutMessage) + putlen * sizeof (struct GNUNET_PeerIdentity)) ||
1452        (putlen > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_PeerIdentity)) )
1453     {
1454       GNUNET_break_op (0);
1455       return GNUNET_YES;
1456     }
1457   GNUNET_STATISTICS_update (GDS_stats,
1458                             gettext_noop ("# P2P PUT requests received"), 1,
1459                             GNUNET_NO);
1460   put_path = (const struct GNUNET_PeerIdentity*) &put[1];
1461   payload = &put_path[putlen];
1462   options = ntohl (put->options);
1463   payload_size = msize - (sizeof (struct PeerPutMessage) +
1464                           putlen * sizeof (struct GNUNET_PeerIdentity));
1465   switch (GNUNET_BLOCK_get_key (GDS_block_context,
1466                                 ntohl (put->type),
1467                                 payload, payload_size,
1468                                 &test_key))
1469   {
1470   case GNUNET_YES:
1471     if (0 != memcmp (&test_key, &put->key, sizeof (GNUNET_HashCode)))
1472     {
1473       GNUNET_break_op (0);
1474       return GNUNET_YES;
1475     }
1476     break;
1477   case GNUNET_NO:
1478     GNUNET_break_op (0);
1479     return GNUNET_YES;
1480   case GNUNET_SYSERR:
1481     /* cannot verify, good luck */
1482     break;
1483   }
1484   bf = GNUNET_CONTAINER_bloomfilter_init (put->bloomfilter,
1485                                           DHT_BLOOM_SIZE,
1486                                           DHT_BLOOM_K);
1487   {
1488     struct GNUNET_PeerIdentity pp[putlen+1];
1489
1490     /* extend 'put path' by sender */
1491     if (0 != (options & GNUNET_DHT_RO_RECORD_ROUTE))
1492     {
1493       memcpy (pp, put_path, putlen * sizeof (struct GNUNET_PeerIdentity));
1494       pp[putlen] = *peer;
1495       putlen++;
1496     }
1497     else
1498       putlen = 0;
1499
1500     /* give to local clients */
1501     GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (put->expiration_time),
1502                              &put->key,
1503                              0, NULL,
1504                              putlen,
1505                              pp,
1506                              ntohl (put->type),
1507                              payload_size,
1508                              payload);
1509     /* store locally */
1510     if ( (0 != (options & GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE)) ||
1511          (am_closest_peer (&put->key,
1512                            bf) ) )
1513       GDS_DATACACHE_handle_put (GNUNET_TIME_absolute_ntoh (put->expiration_time),
1514                                 &put->key,
1515                                 putlen, pp,
1516                                 ntohl (put->type),
1517                                 payload_size,
1518                                 payload);
1519     /* route to other peers */
1520     GDS_NEIGHBOURS_handle_put (ntohl (put->type),
1521                                options,
1522                                ntohl (put->desired_replication_level),
1523                                GNUNET_TIME_absolute_ntoh (put->expiration_time),
1524                                ntohl (put->hop_count) + 1 /* who adds +1? */,
1525                                bf,
1526                                &put->key,
1527                                putlen, pp,
1528                                payload,
1529                                payload_size);
1530   }
1531   GNUNET_CONTAINER_bloomfilter_free (bf);
1532   return GNUNET_YES;
1533 }
1534
1535
1536 /**
1537  * We have received a FIND PEER request.  Send matching
1538  * HELLOs back.
1539  *
1540  * @param sender sender of the FIND PEER request
1541  * @param key peers close to this key are desired
1542  * @param bf peers matching this bf are excluded
1543  * @param bf_mutator mutator for bf
1544  */
1545 static void
1546 handle_find_peer (const struct GNUNET_PeerIdentity *sender,
1547                   const GNUNET_HashCode *key,
1548                   struct GNUNET_CONTAINER_BloomFilter *bf,
1549                   uint32_t bf_mutator)
1550 {
1551   int bucket_idx;
1552   struct PeerBucket *bucket;
1553   struct PeerInfo *peer;
1554   unsigned int choice;
1555   GNUNET_HashCode mhash;
1556   const struct GNUNET_HELLO_Message *hello;
1557
1558   /* first, check about our own HELLO */
1559   if (NULL != GDS_my_hello)
1560   {
1561     GNUNET_BLOCK_mingle_hash (&my_identity.hashPubKey, bf_mutator, &mhash);
1562     if (GNUNET_YES != GNUNET_CONTAINER_bloomfilter_test (bf, &mhash))
1563
1564       GDS_NEIGHBOURS_handle_reply (sender,
1565                                    GNUNET_BLOCK_TYPE_DHT_HELLO,
1566                                    GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION),
1567                                    key,
1568                                    0, NULL,
1569                                    0, NULL,
1570                                    GDS_my_hello,
1571                                    GNUNET_HELLO_size ((const struct GNUNET_HELLO_Message*) GDS_my_hello));
1572   }
1573
1574   /* then, also consider sending a random HELLO from the closest bucket */
1575   bucket_idx = find_bucket (key);
1576   if (bucket_idx == GNUNET_SYSERR)
1577     return;
1578   bucket = &k_buckets[bucket_idx];
1579   if (bucket->peers_size == 0)
1580     return;
1581   choice = GNUNET_CRYPTO_random_u32 (bucket->peers_size,
1582                                      GNUNET_CRYPTO_QUALITY_WEAK);
1583   peer = bucket->head;
1584   while (choice > 0)
1585   {
1586     GNUNET_assert (peer != NULL);
1587     peer = peer->next;
1588   }
1589   choice = bucket->peers_size;
1590   do
1591     {
1592       peer = peer->next;
1593       if (choice-- == 0)
1594         return; /* no non-masked peer available */
1595       if (peer == NULL)
1596         peer = bucket->head;
1597       GNUNET_BLOCK_mingle_hash (&peer->id.hashPubKey, bf_mutator, &mhash);
1598       hello = GDS_HELLO_get (&peer->id);
1599     }
1600   while ( (hello == NULL) ||
1601           (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (bf, &mhash)) );
1602   GDS_NEIGHBOURS_handle_reply (sender,
1603                                GNUNET_BLOCK_TYPE_DHT_HELLO,
1604                                GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_HELLO_ADDRESS_EXPIRATION),
1605                                key,
1606                                0, NULL,
1607                                0, NULL,
1608                                hello,
1609                                GNUNET_HELLO_size (hello));
1610 }
1611
1612
1613 /**
1614  * Core handler for p2p get requests.
1615  *
1616  * @param cls closure
1617  * @param peer sender of the request
1618  * @param message message
1619  * @param peer peer identity this notification is about
1620  * @param atsi performance data
1621  * @return GNUNET_OK to keep the connection open,
1622  *         GNUNET_SYSERR to close it (signal serious error)
1623  */
1624 static int
1625 handle_dht_p2p_get (void *cls, const struct GNUNET_PeerIdentity *peer,
1626                     const struct GNUNET_MessageHeader *message,
1627                     const struct GNUNET_TRANSPORT_ATS_Information
1628                     *atsi)
1629 {
1630   struct PeerGetMessage *get;
1631   uint32_t xquery_size;
1632   size_t reply_bf_size;
1633   uint16_t msize;
1634   enum GNUNET_BLOCK_Type type;
1635   enum GNUNET_DHT_RouteOption options;
1636   enum GNUNET_BLOCK_EvaluationResult eval;
1637   struct GNUNET_CONTAINER_BloomFilter *reply_bf;
1638   struct GNUNET_CONTAINER_BloomFilter *peer_bf;
1639   const char *xquery;
1640
1641   /* parse and validate message */
1642   msize = ntohs (message->size);
1643   if (msize < sizeof (struct PeerGetMessage))
1644   {
1645     GNUNET_break_op (0);
1646     return GNUNET_YES;
1647   }
1648   get = (struct PeerGetMessage *) message;
1649   xquery_size = ntohl (get->xquery_size);
1650   if (msize < sizeof (struct PeerGetMessage) + xquery_size)
1651   {
1652     GNUNET_break_op (0);
1653     return GNUNET_YES;
1654   }
1655   GNUNET_STATISTICS_update (GDS_stats,
1656                             gettext_noop ("# P2P GET requests received"), 1,
1657                             GNUNET_NO);
1658   reply_bf_size = msize - (sizeof (struct PeerGetMessage) + xquery_size);
1659   type = ntohl (get->type);
1660   options = ntohl (get->options);
1661   xquery = (const char*) &get[1];
1662   reply_bf = NULL;
1663   if (reply_bf_size > 0)
1664     reply_bf = GNUNET_CONTAINER_bloomfilter_init (&xquery[xquery_size],
1665                                                   reply_bf_size,
1666                                                   GNUNET_DHT_GET_BLOOMFILTER_K);
1667   eval = GNUNET_BLOCK_evaluate (GDS_block_context,
1668                                 type,
1669                                 &get->key,
1670                                 &reply_bf,
1671                                 get->bf_mutator,
1672                                 xquery, xquery_size,
1673                                 NULL, 0);
1674   if (eval != GNUNET_BLOCK_EVALUATION_REQUEST_VALID)
1675   {
1676     /* request invalid or block type not supported */
1677     GNUNET_break_op (eval == GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED);
1678     if (NULL != reply_bf)
1679       GNUNET_CONTAINER_bloomfilter_free (reply_bf);
1680     return GNUNET_YES;
1681   }
1682   peer_bf =
1683     GNUNET_CONTAINER_bloomfilter_init (get->bloomfilter,
1684                                        DHT_BLOOM_SIZE,
1685                                        DHT_BLOOM_K);
1686
1687   /* remember request for routing replies */
1688   GDS_ROUTING_add (peer,
1689                    type,
1690                    options,
1691                    &get->key,
1692                    xquery, xquery_size,
1693                    reply_bf, get->bf_mutator);
1694
1695   /* local lookup (this may update the reply_bf) */
1696   if ( (0 != (options & GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE)) ||
1697        (am_closest_peer (&get->key,
1698                          peer_bf) ) )
1699   {
1700     if ( (0 != (options & GNUNET_DHT_RO_FIND_PEER)))
1701     {
1702       GNUNET_STATISTICS_update (GDS_stats,
1703                                 gettext_noop ("# P2P FIND PEER requests processed"), 1,
1704                                 GNUNET_NO);
1705       handle_find_peer (peer,
1706                         &get->key,
1707                         reply_bf,
1708                         get->bf_mutator);
1709     }
1710     else
1711     {
1712       eval = GDS_DATACACHE_handle_get (&get->key,
1713                                        type,
1714                                        xquery, xquery_size,
1715                                        &reply_bf,
1716                                        get->bf_mutator);
1717     }
1718   }
1719
1720   /* P2P forwarding */
1721   if (eval != GNUNET_BLOCK_EVALUATION_OK_LAST)
1722     GDS_NEIGHBOURS_handle_get (type,
1723                                options,
1724                                ntohl (get->desired_replication_level),
1725                                ntohl (get->hop_count) + 1, /* CHECK: where (else) do we do +1? */
1726                                &get->key,
1727                                xquery, xquery_size,
1728                                reply_bf,
1729                                get->bf_mutator,
1730                                peer_bf);
1731   /* clean up */
1732   if (NULL != reply_bf)
1733     GNUNET_CONTAINER_bloomfilter_free (reply_bf);
1734   GNUNET_CONTAINER_bloomfilter_free (peer_bf);
1735   return GNUNET_YES;
1736 }
1737
1738
1739 /**
1740  * Core handler for p2p result messages.
1741  *
1742  * @param cls closure
1743  * @param message message
1744  * @param peer peer identity this notification is about
1745  * @param atsi performance data
1746  * @return GNUNET_YES (do not cut p2p connection)
1747  */
1748 static int
1749 handle_dht_p2p_result (void *cls, const struct GNUNET_PeerIdentity *peer,
1750                        const struct GNUNET_MessageHeader *message,
1751                        const struct GNUNET_TRANSPORT_ATS_Information
1752                        *atsi)
1753 {
1754   const struct PeerResultMessage *prm;
1755   const struct GNUNET_PeerIdentity *put_path;
1756   const struct GNUNET_PeerIdentity *get_path;
1757   const void *data;
1758   uint32_t get_path_length;
1759   uint32_t put_path_length;
1760   uint16_t msize;
1761   size_t data_size;
1762   enum GNUNET_BLOCK_Type type;
1763
1764   /* parse and validate message */
1765   msize = ntohs (message->size);
1766   if (msize < sizeof (struct PeerResultMessage))
1767   {
1768     GNUNET_break_op (0);
1769     return GNUNET_YES;
1770   }
1771   prm = (struct PeerResultMessage *) message;
1772   put_path_length = ntohl (prm->put_path_length);
1773   get_path_length = ntohl (prm->get_path_length);
1774   if ( (msize < sizeof (struct PeerResultMessage) +
1775         (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity)) ||
1776        (get_path_length > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_PeerIdentity)) ||
1777        (put_path_length > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_PeerIdentity)) )
1778   {
1779     GNUNET_break_op (0);
1780     return GNUNET_YES;
1781   }
1782   GNUNET_STATISTICS_update (GDS_stats,
1783                             gettext_noop ("# P2P RESULTS received"), 1,
1784                             GNUNET_NO);
1785   put_path = (const struct GNUNET_PeerIdentity*) &prm[1];
1786   get_path = &put_path[put_path_length];
1787   type = ntohl (prm->type);
1788   data = (const void*) &get_path[get_path_length];
1789   data_size = msize - (sizeof (struct PeerResultMessage) +
1790                        (get_path_length + put_path_length) * sizeof (struct GNUNET_PeerIdentity));
1791
1792   /* if we got a HELLO, consider it for our own routing table */
1793   if (type == GNUNET_BLOCK_TYPE_DHT_HELLO)
1794   {
1795     const struct GNUNET_MessageHeader *h;
1796     struct GNUNET_PeerIdentity pid;
1797     int bucket;
1798
1799     /* Should be a HELLO, validate and consider using it! */
1800     if (data_size < sizeof (struct GNUNET_MessageHeader))
1801     {
1802       GNUNET_break_op (0);
1803       return GNUNET_YES;
1804     }
1805     h = data;
1806     if (data_size != ntohs (h->size))
1807     {
1808       GNUNET_break_op (0);
1809       return GNUNET_YES;
1810     }
1811     if (GNUNET_OK !=
1812         GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message*) h,
1813                              &pid))
1814     {
1815       GNUNET_break_op (0);
1816       return GNUNET_YES;
1817     }
1818     bucket = find_bucket (&pid.hashPubKey);
1819     if ( (bucket >= 0) &&
1820          (k_buckets[bucket].peers_size < bucket_size) )
1821     {
1822       if (NULL != GDS_transport_handle)
1823         GNUNET_TRANSPORT_offer_hello (GDS_transport_handle,
1824                                       h, NULL, NULL);
1825       (void) GNUNET_CORE_peer_request_connect (coreAPI,
1826                                                &pid,
1827                                                NULL, NULL);
1828     }
1829   }
1830
1831   /* append 'peer' to 'get_path' */
1832   {
1833     struct GNUNET_PeerIdentity xget_path[get_path_length+1];
1834
1835     memcpy (xget_path, get_path, get_path_length * sizeof (struct GNUNET_PeerIdentity));
1836     xget_path[get_path_length] = *peer;
1837     get_path_length++;
1838
1839     /* forward to local clients */
1840     GDS_CLIENTS_handle_reply (GNUNET_TIME_absolute_ntoh (prm->expiration_time),
1841                              &prm->key,
1842                              get_path_length,
1843                              xget_path,
1844                              put_path_length,
1845                              put_path,
1846                              type,
1847                              data_size,
1848                              data);
1849
1850     /* forward to other peers */
1851     GDS_ROUTING_process (type,
1852                          GNUNET_TIME_absolute_ntoh (prm->expiration_time),
1853                          &prm->key,
1854                          put_path_length,
1855                          put_path,
1856                          get_path_length,
1857                          xget_path,
1858                          data,
1859                          data_size);
1860   }
1861   return GNUNET_YES;
1862 }
1863
1864
1865 /**
1866  * Initialize neighbours subsystem.
1867  *
1868  * @return GNUNET_OK on success, GNUNET_SYSERR on error
1869  */
1870 int
1871 GDS_NEIGHBOURS_init ()
1872 {
1873   static struct GNUNET_CORE_MessageHandler core_handlers[] = {
1874     {&handle_dht_p2p_get, GNUNET_MESSAGE_TYPE_DHT_P2P_GET, 0},
1875     {&handle_dht_p2p_put, GNUNET_MESSAGE_TYPE_DHT_P2P_PUT, 0},
1876     {&handle_dht_p2p_result, GNUNET_MESSAGE_TYPE_DHT_P2P_RESULT, 0},
1877     {NULL, 0, 0}
1878   };
1879   unsigned long long temp_config_num;
1880
1881   if (GNUNET_OK ==
1882       GNUNET_CONFIGURATION_get_value_number (GDS_cfg, "DHT", "bucket_size",
1883                                              &temp_config_num))
1884     bucket_size = (unsigned int) temp_config_num;
1885   coreAPI = GNUNET_CORE_connect (GDS_cfg,
1886                                  1,
1887                                  NULL,
1888                                  &core_init,
1889                                  &handle_core_connect,
1890                                  &handle_core_disconnect,
1891                                  NULL,  /* Do we care about "status" updates? */
1892                                  NULL, GNUNET_NO,
1893                                  NULL, GNUNET_NO,
1894                                  core_handlers);
1895   if (coreAPI == NULL)
1896     return GNUNET_SYSERR;
1897   all_known_peers = GNUNET_CONTAINER_multihashmap_create (256);
1898   return GNUNET_OK;
1899 }
1900
1901
1902 /**
1903  * Shutdown neighbours subsystem.
1904  */
1905 void
1906 GDS_NEIGHBOURS_done ()
1907 {
1908   if (coreAPI == NULL)
1909     return;
1910   GNUNET_CORE_disconnect (coreAPI);
1911   coreAPI = NULL;
1912   GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (all_known_peers));
1913   GNUNET_CONTAINER_multihashmap_destroy (all_known_peers);
1914   all_known_peers = NULL;
1915   if (GNUNET_SCHEDULER_NO_TASK != find_peer_task)
1916   {
1917     GNUNET_SCHEDULER_cancel (find_peer_task);
1918     find_peer_task = GNUNET_SCHEDULER_NO_TASK;
1919   }
1920 }
1921
1922
1923 /* end of gnunet-service-dht_neighbours.c */