src/dv/gnunet-service-dv.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2013 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 dv/gnunet-service-dv.c
  23  * @brief the distance vector service, primarily handles gossip of nearby
  24  * peers and sending/receiving DV messages from core and decapsulating
  25  * them
  26  *
  27  * @author Christian Grothoff
  28  * @author Nathan Evans
  29  */
  30 #include "platform.h"
  31 #include "gnunet_util_lib.h"
  32 #include "gnunet_protocols.h"
  33 #include "gnunet_core_service.h"
  34 #include "gnunet_hello_lib.h"
  35 #include "gnunet_peerinfo_service.h"
  36 #include "gnunet_statistics_service.h"
  37 #include "gnunet_set_service.h"
  38 #include "gnunet_ats_service.h"
  39 #include "dv.h"
  40 #include <gcrypt.h>
  41
  42
  43 /**
  44  * How often do we establish the consensu?
  45  */
  46 #define GNUNET_DV_CONSENSUS_FREQUENCY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 5)
  47
  48 /**
  49  * Maximum number of messages we queue per peer.
  50  */
  51 #define MAX_QUEUE_SIZE 16
  52
  53 /**
  54  * Maximum number of messages we queue towards the clients/plugin.
  55  */
  56 #define MAX_QUEUE_SIZE_PLUGIN 1024
  57
  58 /**
  59  * The default fisheye depth, from how many hops away will
  60  * we keep peers?
  61  */
  62 #define DEFAULT_FISHEYE_DEPTH 3
  63
  64 /**
  65  * How many hops is a direct neighbor away?
  66  */
  67 #define DIRECT_NEIGHBOR_COST 1
  68
  69
  70 GNUNET_NETWORK_STRUCT_BEGIN
  71
  72 /**
  73  * Information about a peer DV can route to.  These entries are what
  74  * we use as the binary format to establish consensus to create our
  75  * routing table and as the address format in the HELLOs.
  76  */
  77 struct Target
  78 {
  79
  80   /**
  81    * Identity of the peer we can reach.
  82    */
  83   struct GNUNET_PeerIdentity peer;
  84
  85   /**
  86    * How many hops (1-3) is this peer away? in network byte order
  87    */
  88   uint32_t distance GNUNET_PACKED;
  89
  90 };
  91
  92
  93 /**
  94  * Message exchanged between DV services (via core), requesting a
  95  * message to be routed.
  96  */
  97 struct RouteMessage
  98 {
  99   /**
 100    * Type: GNUNET_MESSAGE_TYPE_DV_ROUTE
 101    */
 102   struct GNUNET_MessageHeader header;
 103
 104   /**
 105    * Expected (remaining) distance.  Must be always smaller than
 106    * DEFAULT_FISHEYE_DEPTH, should be zero at the target.  Must
 107    * be decremented by one at each hop.  Peers must not forward
 108    * these messages further once the counter has reached zero.
 109    */
 110   uint32_t distance GNUNET_PACKED;
 111
 112   /**
 113    * The (actual) target of the message (this peer, if distance is zero).
 114    */
 115   struct GNUNET_PeerIdentity target;
 116
 117   /**
 118    * The (actual) sender of the message.
 119    */
 120   struct GNUNET_PeerIdentity sender;
 121
 122 };
 123
 124 GNUNET_NETWORK_STRUCT_END
 125
 126
 127 /**
 128  * Linked list of messages to send to clients.
 129  */
 130 struct PendingMessage
 131 {
 132   /**
 133    * Pointer to next item in the list
 134    */
 135   struct PendingMessage *next;
 136
 137   /**
 138    * Pointer to previous item in the list
 139    */
 140   struct PendingMessage *prev;
 141
 142   /**
 143    * Actual message to be sent, allocated after this struct.
 144    */
 145   const struct GNUNET_MessageHeader *msg;
 146
 147   /**
 148    * Ultimate target for the message.
 149    */
 150   struct GNUNET_PeerIdentity ultimate_target;
 151
 152   /**
 153    * Unique ID of the message.
 154    */
 155   uint32_t uid;
 156
 157 };
 158
 159
 160 /**
 161  * Information about a direct neighbor (core-level, excluding
 162  * DV-links, only DV-enabled peers).
 163  */
 164 struct DirectNeighbor
 165 {
 166
 167   /**
 168    * Identity of the peer.
 169    */
 170   struct GNUNET_PeerIdentity peer;
 171
 172   /**
 173    * Session ID we use whenever we create a set union with
 174    * this neighbor; constructed from the XOR of our peer
 175    * IDs and then salted with "DV-SALT" to avoid conflicts
 176    * with other applications.
 177    */
 178   struct GNUNET_HashCode real_session_id;
 179
 180   /**
 181    * Head of linked list of messages to send to this peer.
 182    */
 183   struct PendingMessage *pm_head;
 184
 185   /**
 186    * Tail of linked list of messages to send to this peer.
 187    */
 188   struct PendingMessage *pm_tail;
 189
 190   /**
 191    * Transmit handle to core service.
 192    */
 193   struct GNUNET_CORE_TransmitHandle *cth;
 194
 195   /**
 196    * Routing table of the neighbor, NULL if not yet established.
 197    * Keys are peer identities, values are 'struct Target' entries.
 198    * Note that the distances in the targets are from the point-of-view
 199    * of the peer, not from us!
 200    */
 201   struct GNUNET_CONTAINER_MultiHashMap *neighbor_table;
 202
 203   /**
 204    * Updated routing table of the neighbor, under construction,
 205    * NULL if we are not currently building it.
 206    * Keys are peer identities, values are 'struct Target' entries.
 207    * Note that the distances in the targets are from the point-of-view
 208    * of the peer, not from us!
 209    */
 210   struct GNUNET_CONTAINER_MultiHashMap *neighbor_table_consensus;
 211
 212   /**
 213    * Our current (exposed) routing table as a set.
 214    */
 215   struct GNUNET_SET_Handle *my_set;
 216
 217   /**
 218    * Handle for our current active set union operation.
 219    */
 220   struct GNUNET_SET_OperationHandle *set_op;
 221
 222   /**
 223    * Handle used if we are listening for this peer, waiting for the
 224    * other peer to initiate construction of the set union.  NULL if
 225    * we ar the initiating peer.
 226    */
 227   struct GNUNET_SET_ListenHandle *listen_handle;
 228
 229   /**
 230    * ID of the task we use to (periodically) update our consensus
 231    * with this peer.  Used if we are the initiating peer.
 232    */
 233   GNUNET_SCHEDULER_TaskIdentifier initiate_task;
 234
 235   /**
 236    * At what offset are we, with respect to inserting our own routes
 237    * into the consensus?
 238    */
 239   unsigned int consensus_insertion_offset;
 240
 241   /**
 242    * At what distance are we, with respect to inserting our own routes
 243    * into the consensus?
 244    */
 245   unsigned int consensus_insertion_distance;
 246
 247   /**
 248    * Number of messages currently in the 'pm_XXXX'-DLL.
 249    */
 250   unsigned int pm_queue_size;
 251
 252   /**
 253    * Flag set within 'check_target_removed' to trigger full global route refresh.
 254    */
 255   int target_removed;
 256
 257   /**
 258    * Our distance to this peer, 0 for unknown.
 259    */
 260   uint32_t distance;
 261
 262   /**
 263    * Is this neighbor connected at the core level?
 264    */
 265   int connected;
 266
 267 };
 268
 269
 270 /**
 271  * A route includes information about the next hop,
 272  * the target, and the ultimate distance to the
 273  * target.
 274  */
 275 struct Route
 276 {
 277
 278   /**
 279    * Which peer do we need to forward the message to?
 280    */
 281   struct DirectNeighbor *next_hop;
 282
 283   /**
 284    * What would be the target, and how far is it away?
 285    */
 286   struct Target target;
 287
 288   /**
 289    * Offset of this target in the respective consensus set.
 290    */
 291   unsigned int set_offset;
 292
 293 };
 294
 295
 296 /**
 297  * Set of targets we bring to a consensus; all targets in a set have a
 298  * distance equal to the sets distance (which is implied by the array
 299  * index of the set).
 300  */
 301 struct ConsensusSet
 302 {
 303
 304   /**
 305    * Array of targets in the set, may include NULL entries if a
 306    * neighbor has disconnected; the targets are allocated with the
 307    * respective container (all_routes), not here.
 308    */
 309   struct Route **targets;
 310
 311   /**
 312    * Size of the 'targets' array.
 313    */
 314   unsigned int array_length;
 315
 316 };
 317
 318
 319 /**
 320  * Hashmap of all of our neighbors; processing these usually requires
 321  * first checking to see if the peer is core-connected and if the
 322  * distance is 1, in which case they are direct neighbors.
 323  */
 324 static struct GNUNET_CONTAINER_MultiHashMap *direct_neighbors;
 325
 326 /**
 327  * Hashmap with all routes that we currently support; contains
 328  * routing information for all peers from distance 2
 329  * up to distance DEFAULT_FISHEYE_DEPTH.
 330  */
 331 static struct GNUNET_CONTAINER_MultiHashMap *all_routes;
 332
 333 /**
 334  * Array of consensus sets we expose to the outside world.  Sets
 335  * are structured by the distance to the target.
 336  */
 337 static struct ConsensusSet consensi[DEFAULT_FISHEYE_DEPTH - 1];
 338
 339 /**
 340  * Handle to the core service api.
 341  */
 342 static struct GNUNET_CORE_Handle *core_api;
 343
 344 /**
 345  * The identity of our peer.
 346  */
 347 static struct GNUNET_PeerIdentity my_identity;
 348
 349 /**
 350  * The configuration for this service.
 351  */
 352 static const struct GNUNET_CONFIGURATION_Handle *cfg;
 353
 354 /**
 355  * The client, the DV plugin connected to us (or an event monitor).
 356  * Hopefully this client will never change, although if the plugin
 357  * dies and returns for some reason it may happen.
 358  */
 359 static struct GNUNET_SERVER_NotificationContext *nc;
 360
 361 /**
 362  * Handle for the statistics service.
 363  */
 364 static struct GNUNET_STATISTICS_Handle *stats;
 365
 366 /**
 367  * Handle to ATS service.
 368  */
 369 static struct GNUNET_ATS_PerformanceHandle *ats;
 370
 371
 372 /**
 373  * Start creating a new DV set union by initiating the connection.
 374  *
 375  * @param cls the 'struct DirectNeighbor' of the peer we're building
 376  *        a routing consensus with
 377  * @param tc scheduler context
 378  */
 379 static void
 380 initiate_set_union (void *cls,
 381                     const struct GNUNET_SCHEDULER_TaskContext *tc);
 382
 383
 384 /**
 385  * Start creating a new DV set union construction, our neighbour has
 386  * asked for it (callback for listening peer).
 387  *
 388  * @param cls the 'struct DirectNeighbor' of the peer we're building
 389  *        a routing consensus with
 390  * @param other_peer the other peer
 391  * @param context_msg message with application specific information from
 392  *        the other peer
 393  * @param request request from the other peer, use GNUNET_SET_accept
 394  *        to accept it, otherwise the request will be refused
 395  *        Note that we don't use a return value here, as it is also
 396  *        necessary to specify the set we want to do the operation with,
 397  *        whith sometimes can be derived from the context message.
 398  *        Also necessary to specify the timeout.
 399  */
 400 static void
 401 listen_set_union (void *cls,
 402                   const struct GNUNET_PeerIdentity *other_peer,
 403                   const struct GNUNET_MessageHeader *context_msg,
 404                   struct GNUNET_SET_Request *request);
 405
 406
 407 /**
 408  * Forward a message from another peer to the plugin.
 409  *
 410  * @param message the message to send to the plugin
 411  * @param origin the original sender of the message
 412  * @param distance distance to the original sender of the message
 413  */
 414 static void
 415 send_data_to_plugin (const struct GNUNET_MessageHeader *message,
 416                      const struct GNUNET_PeerIdentity *origin,
 417                      uint32_t distance)
 418 {
 419   struct GNUNET_DV_ReceivedMessage *received_msg;
 420   size_t size;
 421
 422   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 423               "Delivering message from peer `%s'\n",
 424               GNUNET_i2s (origin));
 425   size = sizeof (struct GNUNET_DV_ReceivedMessage) +
 426     ntohs (message->size);
 427   if (size >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 428   {
 429     GNUNET_break (0); /* too big */
 430     return;
 431   }
 432   received_msg = GNUNET_malloc (size);
 433   received_msg->header.size = htons (size);
 434   received_msg->header.type = htons (GNUNET_MESSAGE_TYPE_DV_RECV);
 435   received_msg->distance = htonl (distance);
 436   received_msg->sender = *origin;
 437   memcpy (&received_msg[1], message, ntohs (message->size));
 438   GNUNET_SERVER_notification_context_broadcast (nc,
 439                                                 &received_msg->header,
 440                                                 GNUNET_YES);
 441   GNUNET_free (received_msg);
 442 }
 443
 444
 445 /**
 446  * Forward a control message to the plugin.
 447  *
 448  * @param message the message to send to the plugin
 449  */
 450 static void
 451 send_control_to_plugin (const struct GNUNET_MessageHeader *message)
 452 {
 453   GNUNET_SERVER_notification_context_broadcast (nc,
 454                                                 message,
 455                                                 GNUNET_NO);
 456 }
 457
 458
 459 /**
 460  * Give an (N)ACK message to the plugin, we transmitted a message for it.
 461  *
 462  * @param target peer that received the message
 463  * @param uid plugin-chosen UID for the message
 464  * @param nack GNUNET_NO to send ACK, GNUNET_YES to send NACK
 465  */
 466 static void
 467 send_ack_to_plugin (const struct GNUNET_PeerIdentity *target,
 468                     uint32_t uid,
 469                     int nack)
 470 {
 471   struct GNUNET_DV_AckMessage ack_msg;
 472
 473   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 474               "Delivering ACK for message to peer `%s'\n",
 475               GNUNET_i2s (target));
 476   ack_msg.header.size = htons (sizeof (ack_msg));
 477   ack_msg.header.type = htons ((GNUNET_YES == nack)
 478                                ? GNUNET_MESSAGE_TYPE_DV_SEND_NACK
 479                                : GNUNET_MESSAGE_TYPE_DV_SEND_ACK);
 480   ack_msg.uid = htonl (uid);
 481   ack_msg.target = *target;
 482   send_control_to_plugin (&ack_msg.header);
 483 }
 484
 485
 486 /**
 487  * Send a DISTANCE_CHANGED message to the plugin.
 488  *
 489  * @param peer peer with a changed distance
 490  * @param distance new distance to the peer
 491  */
 492 static void
 493 send_distance_change_to_plugin (const struct GNUNET_PeerIdentity *peer,
 494                                 uint32_t distance)
 495 {
 496   struct GNUNET_DV_DistanceUpdateMessage du_msg;
 497
 498   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 499               "Delivering DISTANCE_CHANGED for message about peer `%s'\n",
 500               GNUNET_i2s (peer));
 501   du_msg.header.size = htons (sizeof (du_msg));
 502   du_msg.header.type = htons (GNUNET_MESSAGE_TYPE_DV_DISTANCE_CHANGED);
 503   du_msg.distance = htonl (distance);
 504   du_msg.peer = *peer;
 505   send_control_to_plugin (&du_msg.header);
 506 }
 507
 508
 509 /**
 510  * Give a CONNECT message to the plugin.
 511  *
 512  * @param target peer that connected
 513  * @param distance distance to the target
 514  */
 515 static void
 516 send_connect_to_plugin (const struct GNUNET_PeerIdentity *target,
 517                         uint32_t distance)
 518 {
 519   struct GNUNET_DV_ConnectMessage cm;
 520
 521   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 522               "Delivering CONNECT about peer `%s'\n",
 523               GNUNET_i2s (target));
 524   cm.header.size = htons (sizeof (cm));
 525   cm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_CONNECT);
 526   cm.distance = htonl (distance);
 527   cm.peer = *target;
 528   send_control_to_plugin (&cm.header);
 529 }
 530
 531
 532 /**
 533  * Give a DISCONNECT message to the plugin.
 534  *
 535  * @param target peer that disconnected
 536  */
 537 static void
 538 send_disconnect_to_plugin (const struct GNUNET_PeerIdentity *target)
 539 {
 540   struct GNUNET_DV_DisconnectMessage dm;
 541
 542   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 543               "Delivering DISCONNECT about peer `%s'\n",
 544               GNUNET_i2s (target));
 545   dm.header.size = htons (sizeof (dm));
 546   dm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_DISCONNECT);
 547   dm.reserved = htonl (0);
 548   dm.peer = *target;
 549   send_control_to_plugin (&dm.header);
 550 }
 551
 552
 553 /**
 554  * Function called to transfer a message to another peer
 555  * via core.
 556  *
 557  * @param cls closure with the direct neighbor
 558  * @param size number of bytes available in buf
 559  * @param buf where the callee should write the message
 560  * @return number of bytes written to buf
 561  */
 562 static size_t
 563 core_transmit_notify (void *cls, size_t size, void *buf)
 564 {
 565   struct DirectNeighbor *dn = cls;
 566   char *cbuf = buf;
 567   struct PendingMessage *pending;
 568   size_t off;
 569   size_t msize;
 570
 571   dn->cth = NULL;
 572   if (NULL == buf)
 573   {
 574     /* peer disconnected */
 575     return 0;
 576   }
 577   off = 0;
 578   pending = dn->pm_head;
 579   off = 0;
 580   while ( (NULL != (pending = dn->pm_head)) &&
 581           (size >= off + (msize = ntohs (pending->msg->size))))
 582   {
 583     dn->pm_queue_size--;
 584     GNUNET_CONTAINER_DLL_remove (dn->pm_head,
 585                                  dn->pm_tail,
 586                                  pending);
 587     memcpy (&cbuf[off], pending->msg, msize);
 588     if (0 != pending->uid)
 589       send_ack_to_plugin (&pending->ultimate_target,
 590                           pending->uid,
 591                           GNUNET_NO);
 592     GNUNET_free (pending);
 593     off += msize;
 594   }
 595   if (NULL != dn->pm_head)
 596     dn->cth =
 597       GNUNET_CORE_notify_transmit_ready (core_api,
 598                                          GNUNET_YES /* cork */,
 599                                          0 /* priority */,
 600                                          GNUNET_TIME_UNIT_FOREVER_REL,
 601                                          &dn->peer,
 602                                          msize,
 603                                          &core_transmit_notify, dn);
 604   return off;
 605 }
 606
 607
 608 /**
 609  * Forward the given payload to the given target.
 610  *
 611  * @param target where to send the message
 612  * @param uid unique ID for the message
 613  * @param ultimate_target ultimate recipient for the message
 614  * @param distance expected (remaining) distance to the target
 615  * @param sender original sender of the message
 616  * @param payload payload of the message
 617  */
 618 static void
 619 forward_payload (struct DirectNeighbor *target,
 620                  uint32_t distance,
 621                  uint32_t uid,
 622                  const struct GNUNET_PeerIdentity *sender,
 623                  const struct GNUNET_PeerIdentity *ultimate_target,
 624                  const struct GNUNET_MessageHeader *payload)
 625 {
 626   struct PendingMessage *pm;
 627   struct RouteMessage *rm;
 628   size_t msize;
 629
 630   if ( (target->pm_queue_size >= MAX_QUEUE_SIZE) &&
 631        (0 != memcmp (sender,
 632                      &my_identity,
 633                      sizeof (struct GNUNET_PeerIdentity))) )
 634   {
 635     GNUNET_break (0 == uid);
 636     return;
 637   }
 638   msize = sizeof (struct RouteMessage) + ntohs (payload->size);
 639   if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 640   {
 641     GNUNET_break (0);
 642     return;
 643   }
 644   pm = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
 645   pm->ultimate_target = *ultimate_target;
 646   pm->uid = uid;
 647   pm->msg = (const struct GNUNET_MessageHeader *) &pm[1];
 648   rm = (struct RouteMessage *) &pm[1];
 649   rm->header.size = htons ((uint16_t) msize);
 650   rm->header.type = htons (GNUNET_MESSAGE_TYPE_DV_ROUTE);
 651   rm->distance = htonl (distance);
 652   rm->target = target->peer;
 653   rm->sender = *sender;
 654   memcpy (&rm[1], payload, ntohs (payload->size));
 655   GNUNET_CONTAINER_DLL_insert_tail (target->pm_head,
 656                                     target->pm_tail,
 657                                     pm);
 658   target->pm_queue_size++;
 659   if (NULL == target->cth)
 660     target->cth = GNUNET_CORE_notify_transmit_ready (core_api,
 661                                                      GNUNET_YES /* cork */,
 662                                                      0 /* priority */,
 663                                                      GNUNET_TIME_UNIT_FOREVER_REL,
 664                                                      &target->peer,
 665                                                      msize,
 666                                                      &core_transmit_notify, target);
 667 }
 668
 669
 670 /**
 671  * Find a free slot for storing a 'route' in the 'consensi'
 672  * set at the given distance.
 673  *
 674  * @param distance distance to use for the set slot
 675  */
 676 static unsigned int
 677 get_consensus_slot (uint32_t distance)
 678 {
 679   struct ConsensusSet *cs;
 680   unsigned int i;
 681
 682   cs = &consensi[distance];
 683   i = 0;
 684   while ( (i < cs->array_length) &&
 685           (NULL != cs->targets[i]) ) i++;
 686   if (i == cs->array_length)
 687     GNUNET_array_grow (cs->targets,
 688                        cs->array_length,
 689                        cs->array_length * 2 + 2);
 690   return i;
 691 }
 692
 693
 694 /**
 695  * Allocate a slot in the consensus set for a route.
 696  *
 697  * @param route route to initialize
 698  * @param distance which consensus set to use
 699  */
 700 static void
 701 allocate_route (struct Route *route,
 702                 uint32_t distance)
 703 {
 704   unsigned int i;
 705
 706   i = get_consensus_slot (distance);
 707   route->set_offset = i;
 708   consensi[distance].targets[i] = route;
 709   route->target.distance = htonl (distance);
 710 }
 711
 712
 713 /**
 714  * Release a slot in the consensus set for a route.
 715  *
 716  * @param route route to release the slot from
 717  */
 718 static void
 719 release_route (struct Route *route)
 720 {
 721   consensi[ntohl (route->target.distance)].targets[route->set_offset] = NULL;
 722   route->set_offset = UINT_MAX; /* indicate invalid slot */
 723 }
 724
 725
 726 /**
 727  * Move a route from one consensus set to another.
 728  *
 729  * @param route route to move
 730  * @param new_distance new distance for the route (destination set)
 731  */
 732 static void
 733 move_route (struct Route *route,
 734             uint32_t new_distance)
 735 {
 736   unsigned int i;
 737
 738   release_route (route);
 739   i = get_consensus_slot (new_distance);
 740   route->set_offset = i;
 741   consensi[new_distance].targets[i] = route;
 742   route->target.distance = htonl (new_distance);
 743 }
 744
 745
 746 /**
 747  * Initialize this neighbors 'my_set' and when done give
 748  * it to the pending set operation for execution.
 749  *
 750  * @param cls the neighbor for which we are building the set
 751  */
 752 static void
 753 build_set (void *cls)
 754 {
 755   struct DirectNeighbor *neighbor = cls;
 756   struct GNUNET_SET_Element element;
 757
 758   while ( (DEFAULT_FISHEYE_DEPTH - 1 > neighbor->consensus_insertion_distance) &&
 759           (consensi[neighbor->consensus_insertion_distance].array_length == neighbor->consensus_insertion_offset) )
 760   {
 761     neighbor->consensus_insertion_offset = 0;
 762     neighbor->consensus_insertion_distance++;
 763     /* skip over NULL entries */
 764     while ( (DEFAULT_FISHEYE_DEPTH - 1 > neighbor->consensus_insertion_distance) &&
 765             (consensi[neighbor->consensus_insertion_distance].array_length < neighbor->consensus_insertion_offset) &&
 766             (NULL == consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset]) )
 767       neighbor->consensus_insertion_offset++;
 768   }
 769   if (DEFAULT_FISHEYE_DEPTH - 1 == neighbor->consensus_insertion_distance)
 770   {
 771     /* we have added all elements to the set, run the operation */
 772     GNUNET_SET_conclude (neighbor->set_op,
 773                          neighbor->my_set);
 774     GNUNET_SET_destroy (neighbor->my_set);
 775     neighbor->my_set = NULL;
 776     return;
 777   }
 778   element.size = sizeof (struct Target);
 779   element.data = &consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset++]->target;
 780
 781   /* skip over NULL entries */
 782   while ( (DEFAULT_FISHEYE_DEPTH - 1 > neighbor->consensus_insertion_distance) &&
 783           (consensi[neighbor->consensus_insertion_distance].array_length < neighbor->consensus_insertion_offset) &&
 784           (NULL == consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset]) )
 785     neighbor->consensus_insertion_offset++;
 786   GNUNET_SET_add_element (neighbor->my_set,
 787                           &element,
 788                           &build_set, neighbor);
 789
 790 }
 791
 792
 793 /**
 794  * A peer is now connected to us at distance 1.  Initiate DV exchange.
 795  *
 796  * @param neighbor entry for the neighbor at distance 1
 797  */
 798 static void
 799 handle_direct_connect (struct DirectNeighbor *neighbor)
 800 {
 801   struct Route *route;
 802   struct GNUNET_HashCode session_id;
 803
 804   GNUNET_STATISTICS_update (stats,
 805                             "# peers connected (1-hop)",
 806                             1, GNUNET_NO);
 807   route = GNUNET_CONTAINER_multihashmap_get (all_routes,
 808                                              &neighbor->peer.hashPubKey);
 809   if (NULL != route)
 810   {
 811     send_disconnect_to_plugin (&neighbor->peer);
 812     release_route (route);
 813     GNUNET_free (route);
 814   }
 815   /* construct session ID seed as XOR of both peer's identities */
 816   GNUNET_CRYPTO_hash_xor (&my_identity.hashPubKey,
 817                           &neighbor->peer.hashPubKey,
 818                           &session_id);
 819   /* make sure session ID is unique across applications by salting it with 'DV' */
 820   GNUNET_CRYPTO_hkdf (&neighbor->real_session_id, sizeof (struct GNUNET_HashCode),
 821                       GCRY_MD_SHA512, GCRY_MD_SHA256,
 822                       "DV-SALT", 2,
 823                       &session_id, sizeof (session_id),
 824                       NULL, 0);
 825   if (1 == GNUNET_CRYPTO_hash_cmp (&neighbor->peer.hashPubKey,
 826                                    &my_identity.hashPubKey))
 827     neighbor->initiate_task = GNUNET_SCHEDULER_add_now (&initiate_set_union,
 828                                                         neighbor);
 829   else
 830     neighbor->listen_handle = GNUNET_SET_listen (cfg,
 831                                                  GNUNET_SET_OPERATION_UNION,
 832                                                  &neighbor->real_session_id,
 833                                                  &listen_set_union,
 834                                                  neighbor);
 835 }
 836
 837
 838 /**
 839  * Method called whenever a peer connects.
 840  *
 841  * @param cls closure
 842  * @param peer peer identity this notification is about
 843  */
 844 static void
 845 handle_core_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
 846 {
 847   struct DirectNeighbor *neighbor;
 848
 849   /* Check for connect to self message */
 850   if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
 851     return;
 852   /* check if entry exists */
 853   neighbor = GNUNET_CONTAINER_multihashmap_get (direct_neighbors,
 854                                                 &peer->hashPubKey);
 855   if (NULL != neighbor)
 856   {
 857     GNUNET_break (GNUNET_YES != neighbor->connected);
 858     neighbor->connected = GNUNET_YES;
 859     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 860                 "Core connected to %s (distance %u)\n",
 861                 GNUNET_i2s (peer),
 862                 (unsigned int) neighbor->distance);
 863     if (DIRECT_NEIGHBOR_COST != neighbor->distance)
 864       return;
 865     handle_direct_connect (neighbor);
 866     return;
 867   }
 868   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 869               "Core connected to %s (distance unknown)\n",
 870               GNUNET_i2s (peer));
 871   neighbor = GNUNET_malloc (sizeof (struct DirectNeighbor));
 872   neighbor->peer = *peer;
 873   GNUNET_assert (GNUNET_YES ==
 874                  GNUNET_CONTAINER_multihashmap_put (direct_neighbors,
 875                                                     &peer->hashPubKey,
 876                                                     neighbor,
 877                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 878   neighbor->connected = GNUNET_YES;
 879   neighbor->distance = 0; /* unknown */
 880 }
 881
 882
 883 /**
 884  * Called for each 'target' in a neighbor table to free the associated memory.
 885  *
 886  * @param cls NULL
 887  * @param key key of the value
 888  * @param value value to free
 889  * @return GNUNET_OK to continue to iterate
 890  */
 891 static int
 892 free_targets (void *cls,
 893               const struct GNUNET_HashCode *key,
 894               void *value)
 895 {
 896   GNUNET_free (value);
 897   return GNUNET_OK;
 898 }
 899
 900
 901 /**
 902  * Multihashmap iterator for checking if a given route is
 903  * (now) useful to this peer.
 904  *
 905  * @param cls the direct neighbor for the given route
 906  * @param key key value stored under
 907  * @param value a 'struct Target' that may or may not be useful; not that
 908  *        the distance in 'target' does not include the first hop yet
 909  * @return GNUNET_YES to continue iteration, GNUNET_NO to stop
 910  */
 911 static int
 912 check_possible_route (void *cls, const struct GNUNET_HashCode * key, void *value)
 913 {
 914   struct DirectNeighbor *neighbor = cls;
 915   struct Target *target = value;
 916   struct Route *route;
 917
 918   route = GNUNET_CONTAINER_multihashmap_get (all_routes,
 919                                            key);
 920   if (NULL != route)
 921   {
 922     if (ntohl (route->target.distance) > ntohl (target->distance) + 1)
 923     {
 924       /* this 'target' is cheaper than the existing route; switch to alternative route! */
 925       move_route (route, ntohl (target->distance) + 1);
 926       route->next_hop = neighbor;
 927       send_distance_change_to_plugin (&target->peer, ntohl (target->distance) + 1);
 928     }
 929     return GNUNET_YES; /* got a route to this target already */
 930   }
 931   route = GNUNET_malloc (sizeof (struct Route));
 932   route->next_hop = neighbor;
 933   route->target.distance = htonl (ntohl (target->distance) + 1);
 934   route->target.peer = target->peer;
 935   allocate_route (route, ntohl (route->target.distance));
 936   GNUNET_assert (GNUNET_YES ==
 937                  GNUNET_CONTAINER_multihashmap_put (all_routes,
 938                                                     &route->target.peer.hashPubKey,
 939                                                     route,
 940                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 941   send_connect_to_plugin (&route->target.peer, ntohl (target->distance));
 942   return GNUNET_YES;
 943 }
 944
 945
 946 /**
 947  * Multihashmap iterator for finding routes that were previously
 948  * "hidden" due to a better route (called after a disconnect event).
 949  *
 950  * @param cls NULL
 951  * @param key peer identity of the given direct neighbor
 952  * @param value a 'struct DirectNeighbor' to check for additional routes
 953  * @return GNUNET_YES to continue iteration
 954  */
 955 static int
 956 refresh_routes (void *cls, const struct GNUNET_HashCode * key, void *value)
 957 {
 958   struct DirectNeighbor *neighbor = value;
 959
 960   if ( (GNUNET_YES != neighbor->connected) ||
 961        (DIRECT_NEIGHBOR_COST != neighbor->distance) )
 962     return GNUNET_YES;
 963   if (NULL != neighbor->neighbor_table)
 964     GNUNET_CONTAINER_multihashmap_iterate (neighbor->neighbor_table,
 965                                            &check_possible_route,
 966                                            neighbor);
 967   return GNUNET_YES;
 968 }
 969
 970
 971 /**
 972  * Get distance information from 'atsi'.
 973  *
 974  * @param atsi performance data
 975  * @param atsi_count number of entries in atsi
 976  * @return connected transport distance
 977  */
 978 static uint32_t
 979 get_atsi_distance (const struct GNUNET_ATS_Information *atsi,
 980                    uint32_t atsi_count)
 981 {
 982   uint32_t i;
 983
 984   for (i = 0; i < atsi_count; i++)
 985     if (ntohl (atsi[i].type) == GNUNET_ATS_QUALITY_NET_DISTANCE)
 986       return (0 == ntohl (atsi->value)) ? DIRECT_NEIGHBOR_COST : ntohl (atsi->value); // FIXME: 0 check should not be required once ATS is fixed!
 987   /* If we do not have explicit distance data, assume direct neighbor. */
 988   return DIRECT_NEIGHBOR_COST;
 989 }
 990
 991
 992 /**
 993  * Multihashmap iterator for freeing routes that go via a particular
 994  * neighbor that disconnected and is thus no longer available.
 995  *
 996  * @param cls the direct neighbor that is now unavailable
 997  * @param key key value stored under
 998  * @param value a 'struct Route' that may or may not go via neighbor
 999  *
1000  * @return GNUNET_YES to continue iteration, GNUNET_NO to stop
1001  */
1002 static int
1003 cull_routes (void *cls, const struct GNUNET_HashCode * key, void *value)
1004 {
1005   struct DirectNeighbor *neighbor = cls;
1006   struct Route *route = value;
1007
1008   if (route->next_hop != neighbor)
1009     return GNUNET_YES; /* not affected */
1010   GNUNET_assert (GNUNET_YES ==
1011                  GNUNET_CONTAINER_multihashmap_remove (all_routes, key, value));
1012   release_route (route);
1013   send_disconnect_to_plugin (&route->target.peer);
1014   GNUNET_free (route);
1015   return GNUNET_YES;
1016 }
1017
1018
1019 /**
1020  * Handle the case that a direct connection to a peer is
1021  * disrupted.  Remove all routes via that peer and
1022  * stop the consensus with it.
1023  *
1024  * @param neighbor peer that was disconnected (or at least is no
1025  *    longer at distance 1)
1026  */
1027 static void
1028 handle_direct_disconnect (struct DirectNeighbor *neighbor)
1029 {
1030   GNUNET_CONTAINER_multihashmap_iterate (all_routes,
1031                                          &cull_routes,
1032                                          neighbor);
1033   if (NULL != neighbor->cth)
1034   {
1035     GNUNET_CORE_notify_transmit_ready_cancel (neighbor->cth);
1036     neighbor->cth = NULL;
1037   }
1038   if (NULL != neighbor->neighbor_table_consensus)
1039   {
1040     GNUNET_CONTAINER_multihashmap_iterate (neighbor->neighbor_table_consensus,
1041                                            &free_targets,
1042                                            NULL);
1043     GNUNET_CONTAINER_multihashmap_destroy (neighbor->neighbor_table_consensus);
1044     neighbor->neighbor_table_consensus = NULL;
1045   }
1046   if (NULL != neighbor->neighbor_table)
1047   {
1048     GNUNET_CONTAINER_multihashmap_iterate (neighbor->neighbor_table,
1049                                            &free_targets,
1050                                            NULL);
1051     GNUNET_CONTAINER_multihashmap_destroy (neighbor->neighbor_table);
1052     neighbor->neighbor_table = NULL;
1053   }
1054   if (NULL != neighbor->set_op)
1055   {
1056     GNUNET_SET_operation_cancel (neighbor->set_op);
1057     neighbor->set_op = NULL;
1058   }
1059   if (NULL != neighbor->my_set)
1060   {
1061     GNUNET_SET_destroy (neighbor->my_set);
1062     neighbor->my_set = NULL;
1063   }
1064   if (NULL != neighbor->listen_handle)
1065   {
1066     GNUNET_SET_listen_cancel (neighbor->listen_handle);
1067     neighbor->listen_handle = NULL;
1068   }
1069   if (GNUNET_SCHEDULER_NO_TASK != neighbor->initiate_task)
1070   {
1071     GNUNET_SCHEDULER_cancel (neighbor->initiate_task);
1072     neighbor->initiate_task = GNUNET_SCHEDULER_NO_TASK;
1073   }
1074 }
1075
1076
1077 /**
1078  * Function that is called with QoS information about an address; used
1079  * to update our current distance to another peer.
1080  *
1081  * @param cls closure
1082  * @param address the address
1083  * @param active is this address in active use
1084  * @param bandwidth_out assigned outbound bandwidth for the connection
1085  * @param bandwidth_in assigned inbound bandwidth for the connection
1086  * @param ats performance data for the address (as far as known)
1087  * @param ats_count number of performance records in 'ats'
1088  */
1089 static void
1090 handle_ats_update (void *cls,
1091                    const struct GNUNET_HELLO_Address *address,
1092                    int active,
1093                    struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
1094                    struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1095                    const struct GNUNET_ATS_Information *ats,
1096                    uint32_t ats_count)
1097 {
1098   struct DirectNeighbor *neighbor;
1099   uint32_t distance;
1100
1101   if (GNUNET_NO == active)
1102         return;
1103   distance = get_atsi_distance (ats, ats_count);
1104   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1105               "ATS says distance to %s is %u\n",
1106               GNUNET_i2s (&address->peer),
1107               (unsigned int) distance);
1108   /* check if entry exists */
1109   neighbor = GNUNET_CONTAINER_multihashmap_get (direct_neighbors,
1110                                                 &address->peer.hashPubKey);
1111   if (NULL != neighbor)
1112   {
1113     if ( (DIRECT_NEIGHBOR_COST == neighbor->distance) &&
1114          (DIRECT_NEIGHBOR_COST == distance) )
1115       return; /* no change */
1116     if (DIRECT_NEIGHBOR_COST == neighbor->distance)
1117     {
1118       neighbor->distance = distance;
1119       GNUNET_STATISTICS_update (stats,
1120                                 "# peers connected (1-hop)",
1121                                 -1, GNUNET_NO);
1122       handle_direct_disconnect (neighbor);
1123       GNUNET_CONTAINER_multihashmap_iterate (direct_neighbors,
1124                                              &refresh_routes,
1125                                              NULL);
1126       return;
1127     }
1128     neighbor->distance = distance;
1129     if (DIRECT_NEIGHBOR_COST != neighbor->distance)
1130       return;
1131     if (GNUNET_YES != neighbor->connected)
1132       return;
1133     handle_direct_connect (neighbor);
1134     return;
1135   }
1136   neighbor = GNUNET_malloc (sizeof (struct DirectNeighbor));
1137   neighbor->peer = address->peer;
1138   GNUNET_assert (GNUNET_YES ==
1139                  GNUNET_CONTAINER_multihashmap_put (direct_neighbors,
1140                                                     &address->peer.hashPubKey,
1141                                                     neighbor,
1142                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1143   neighbor->connected = GNUNET_NO; /* not yet */
1144   neighbor->distance = distance;
1145 }
1146
1147
1148 /**
1149  * Check if a target was removed from the set of the other peer; if so,
1150  * if we also used it for our route, we need to remove it from our
1151  * 'all_routes' set (and later check if an alternative path now exists).
1152  *
1153  * @param cls the 'struct DirectNeighbor'
1154  * @param key peer identity for the target
1155  * @param value a 'struct Target' previously reachable via the given neighbor
1156  */
1157 static int
1158 check_target_removed (void *cls,
1159                       const struct GNUNET_HashCode *key,
1160                       void *value)
1161 {
1162   struct DirectNeighbor *neighbor = cls;
1163   struct Target *new_target;
1164   struct Route *current_route;
1165
1166   new_target = GNUNET_CONTAINER_multihashmap_get (neighbor->neighbor_table_consensus,
1167                                                   key);
1168   if (NULL == new_target)
1169   {
1170     /* target was revoked, check if it was used */
1171     current_route = GNUNET_CONTAINER_multihashmap_get (all_routes,
1172                                                        key);
1173     if ( (NULL == current_route) ||
1174          (current_route->next_hop != neighbor) )
1175     {
1176       /* didn't matter, wasn't used */
1177       return GNUNET_OK;
1178     }
1179     /* remove existing route */
1180     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1181                 "Lost route to %s\n",
1182                 GNUNET_i2s (&current_route->target.peer));
1183     GNUNET_assert (GNUNET_YES ==
1184                    GNUNET_CONTAINER_multihashmap_remove (all_routes, key, current_route));
1185     send_disconnect_to_plugin (&current_route->target.peer);
1186     GNUNET_free (current_route);
1187     neighbor->target_removed = GNUNET_YES;
1188     return GNUNET_OK;
1189   }
1190   return GNUNET_OK;
1191 }
1192
1193
1194 /**
1195  * Check if a target was added to the set of the other peer; if it
1196  * was added or impoves the existing route, do the needed updates.
1197  *
1198  * @param cls the 'struct DirectNeighbor'
1199  * @param key peer identity for the target
1200  * @param value a 'struct Target' now reachable via the given neighbor
1201  */
1202 static int
1203 check_target_added (void *cls,
1204                       const struct GNUNET_HashCode *key,
1205                       void *value)
1206 {
1207   struct DirectNeighbor *neighbor = cls;
1208   struct Target *target = value;
1209   struct Route *current_route;
1210
1211   /* target was revoked, check if it was used */
1212   current_route = GNUNET_CONTAINER_multihashmap_get (all_routes,
1213                                                      key);
1214   if (NULL != current_route)
1215   {
1216     /* route exists */
1217     if (current_route->next_hop == neighbor)
1218     {
1219       /* we had the same route before, no change */
1220       if (ntohl (target->distance) + 1 != ntohl (current_route->target.distance))
1221       {
1222         current_route->target.distance = htonl (ntohl (target->distance) + 1);
1223         send_distance_change_to_plugin (&target->peer, ntohl (target->distance) + 1);
1224       }
1225       return GNUNET_OK;
1226     }
1227     if (ntohl (current_route->target.distance) >= ntohl (target->distance) + 1)
1228     {
1229       /* alternative, shorter route exists, ignore */
1230       return GNUNET_OK;
1231     }
1232     /* new route is better than the existing one, take over! */
1233     /* NOTE: minor security issue: malicious peers may advertise
1234        very short routes to take over longer paths; as we don't
1235        check that the shorter routes actually work, a malicious
1236        direct neighbor can use this to DoS our long routes */
1237     current_route->next_hop = neighbor;
1238     current_route->target.distance = htonl (ntohl (target->distance) + 1);
1239     send_distance_change_to_plugin (&target->peer, ntohl (target->distance) + 1);
1240     return GNUNET_OK;
1241   }
1242   /* new route */
1243   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1244               "Discovered new route to %s using %u hops\n",
1245               GNUNET_i2s (&target->peer),
1246               (unsigned int) (ntohl (target->distance) + 1));
1247   current_route = GNUNET_malloc (sizeof (struct Route));
1248   current_route->next_hop = neighbor;
1249   current_route->target.peer = target->peer;
1250   current_route->target.distance = htonl (ntohl (target->distance) + 1);
1251   GNUNET_assert (GNUNET_YES ==
1252                  GNUNET_CONTAINER_multihashmap_put (all_routes,
1253                                                     &current_route->target.peer.hashPubKey,
1254                                                     current_route,
1255                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1256   send_connect_to_plugin (&current_route->target.peer,
1257                           ntohl (current_route->target.distance));
1258   return GNUNET_OK;
1259 }
1260
1261
1262 /**
1263  * Callback for set operation results. Called for each element
1264  * in the result set.
1265  * We have learned a new route from the other peer.  Add it to the
1266  * route set we're building.
1267  *
1268  * @param cls the 'struct DirectNeighbor' we're building the consensus with
1269  * @param element a result element, only valid if status is GNUNET_SET_STATUS_OK
1270  * @param status see enum GNUNET_SET_Status
1271  */
1272 static void
1273 handle_set_union_result (void *cls,
1274                          const struct GNUNET_SET_Element *element,
1275                          enum GNUNET_SET_Status status)
1276 {
1277   struct DirectNeighbor *neighbor = cls;
1278   struct Target *target;
1279
1280   switch (status)
1281   {
1282   case GNUNET_SET_STATUS_OK:
1283     if (sizeof (struct Target) != element->size)
1284     {
1285       GNUNET_break_op (0);
1286       return;
1287     }
1288     target = GNUNET_malloc (sizeof (struct Target));
1289     memcpy (target, element->data, sizeof (struct Target));
1290     if (GNUNET_YES !=
1291         GNUNET_CONTAINER_multihashmap_put (neighbor->neighbor_table_consensus,
1292                                            &target->peer.hashPubKey,
1293                                            target,
1294                                            GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1295     {
1296       GNUNET_break_op (0);
1297       GNUNET_free (target);
1298     }
1299     break;
1300   case GNUNET_SET_STATUS_TIMEOUT:
1301   case GNUNET_SET_STATUS_FAILURE:
1302     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1303                 "Failed to establish DV union, will try again later\n");
1304     GNUNET_SET_operation_cancel (neighbor->set_op); /* FIXME: needed? */
1305     neighbor->set_op = NULL;
1306     if (NULL != neighbor->neighbor_table_consensus)
1307     {
1308       GNUNET_CONTAINER_multihashmap_iterate (neighbor->neighbor_table_consensus,
1309                                              &free_targets,
1310                                              NULL);
1311       GNUNET_CONTAINER_multihashmap_destroy (neighbor->neighbor_table_consensus);
1312       neighbor->neighbor_table_consensus = NULL;
1313     }
1314     if (1 == GNUNET_CRYPTO_hash_cmp (&neighbor->peer.hashPubKey,
1315                                      &my_identity.hashPubKey))
1316       neighbor->initiate_task = GNUNET_SCHEDULER_add_delayed (GNUNET_DV_CONSENSUS_FREQUENCY,
1317                                                               &initiate_set_union,
1318                                                               neighbor);
1319     break;
1320   case GNUNET_SET_STATUS_HALF_DONE:
1321     /* we got all of our updates; integrate routing table! */
1322     neighbor->target_removed = GNUNET_NO;
1323     GNUNET_CONTAINER_multihashmap_iterate (neighbor->neighbor_table,
1324                                            &check_target_removed,
1325                                            neighbor);
1326     if (GNUNET_YES == neighbor->target_removed)
1327     {
1328       /* check if we got an alternative for the removed routes */
1329       GNUNET_CONTAINER_multihashmap_iterate (direct_neighbors,
1330                                              &refresh_routes,
1331                                              NULL);
1332     }
1333     /* add targets that appeared (and check for improved routes) */
1334     GNUNET_CONTAINER_multihashmap_iterate (neighbor->neighbor_table_consensus,
1335                                            &check_target_added,
1336                                            neighbor);
1337     if (NULL != neighbor->neighbor_table)
1338     {
1339       GNUNET_CONTAINER_multihashmap_iterate (neighbor->neighbor_table,
1340                                              &free_targets,
1341                                              NULL);
1342       GNUNET_CONTAINER_multihashmap_destroy (neighbor->neighbor_table);
1343       neighbor->neighbor_table = NULL;
1344     }
1345     neighbor->neighbor_table = neighbor->neighbor_table_consensus;
1346     neighbor->neighbor_table_consensus = NULL;
1347     break;
1348   case GNUNET_SET_STATUS_DONE:
1349     /* operation done, schedule next run! */
1350     GNUNET_SET_operation_cancel (neighbor->set_op); /* FIXME: needed? */
1351     neighbor->set_op = NULL;
1352     if (1 == GNUNET_CRYPTO_hash_cmp (&neighbor->peer.hashPubKey,
1353                                      &my_identity.hashPubKey))
1354       neighbor->initiate_task = GNUNET_SCHEDULER_add_delayed (GNUNET_DV_CONSENSUS_FREQUENCY,
1355                                                               &initiate_set_union,
1356                                                               neighbor);
1357     break;
1358   default:
1359     GNUNET_break (0);
1360     return;
1361   }
1362 }
1363
1364
1365 /**
1366  * Start creating a new DV set union construction, our neighbour has
1367  * asked for it (callback for listening peer).
1368  *
1369  * @param cls the 'struct DirectNeighbor' of the peer we're building
1370  *        a routing consensus with
1371  * @param other_peer the other peer
1372  * @param context_msg message with application specific information from
1373  *        the other peer
1374  * @param request request from the other peer, use GNUNET_SET_accept
1375  *        to accept it, otherwise the request will be refused
1376  *        Note that we don't use a return value here, as it is also
1377  *        necessary to specify the set we want to do the operation with,
1378  *        whith sometimes can be derived from the context message.
1379  *        Also necessary to specify the timeout.
1380  */
1381 static void
1382 listen_set_union (void *cls,
1383                   const struct GNUNET_PeerIdentity *other_peer,
1384                   const struct GNUNET_MessageHeader *context_msg,
1385                   struct GNUNET_SET_Request *request)
1386 {
1387   struct DirectNeighbor *neighbor = cls;
1388
1389   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1390               "Starting to create consensus with %s!\n",
1391               GNUNET_i2s (&neighbor->peer));
1392   if (NULL != neighbor->set_op)
1393   {
1394     GNUNET_SET_operation_cancel (neighbor->set_op);
1395     neighbor->set_op = NULL;
1396   }
1397   if (NULL != neighbor->my_set)
1398   {
1399     GNUNET_SET_destroy (neighbor->my_set);
1400     neighbor->my_set = NULL;
1401   }
1402   neighbor->my_set = GNUNET_SET_create (cfg,
1403                                         GNUNET_SET_OPERATION_UNION);
1404   neighbor->set_op = GNUNET_SET_accept (request,
1405                                         GNUNET_SET_RESULT_ADDED,
1406                                         &handle_set_union_result,
1407                                         neighbor);
1408   build_set (neighbor);
1409 }
1410
1411
1412 /**
1413  * Start creating a new DV set union by initiating the connection.
1414  *
1415  * @param cls the 'struct DirectNeighbor' of the peer we're building
1416  *        a routing consensus with
1417  * @param tc scheduler context
1418  */
1419 static void
1420 initiate_set_union (void *cls,
1421                     const struct GNUNET_SCHEDULER_TaskContext *tc)
1422 {
1423   struct DirectNeighbor *neighbor = cls;
1424
1425   neighbor->initiate_task = GNUNET_SCHEDULER_NO_TASK;
1426   neighbor->my_set = GNUNET_SET_create (cfg,
1427                                         GNUNET_SET_OPERATION_UNION);
1428   neighbor->set_op = GNUNET_SET_evaluate (&neighbor->peer,
1429                                           &neighbor->real_session_id,
1430                                           NULL,
1431                                           0 /* FIXME: salt */,
1432                                           GNUNET_SET_RESULT_ADDED,
1433                                           &handle_set_union_result,
1434                                           neighbor);
1435   build_set (neighbor);
1436 }
1437
1438
1439 /**
1440  * Core handler for DV data messages.  Whatever this message
1441  * contains all we really have to do is rip it out of its
1442  * DV layering and give it to our pal the DV plugin to report
1443  * in with.
1444  *
1445  * @param cls closure
1446  * @param peer peer which sent the message (immediate sender)
1447  * @param message the message
1448  * @return GNUNET_OK on success, GNUNET_SYSERR if the other peer violated the protocol
1449  */
1450 static int
1451 handle_dv_route_message (void *cls, const struct GNUNET_PeerIdentity *peer,
1452                          const struct GNUNET_MessageHeader *message)
1453 {
1454   const struct RouteMessage *rm;
1455   const struct GNUNET_MessageHeader *payload;
1456   struct Route *route;
1457
1458   if (ntohs (message->size) < sizeof (struct RouteMessage) + sizeof (struct GNUNET_MessageHeader))
1459   {
1460     GNUNET_break_op (0);
1461     return GNUNET_SYSERR;
1462   }
1463   rm = (const struct RouteMessage *) message;
1464   payload = (const struct GNUNET_MessageHeader *) &rm[1];
1465   if (ntohs (message->size) != sizeof (struct RouteMessage) + ntohs (payload->size))
1466   {
1467     GNUNET_break_op (0);
1468     return GNUNET_SYSERR;
1469   }
1470   if (0 == memcmp (&rm->target,
1471                    &my_identity,
1472                    sizeof (struct GNUNET_PeerIdentity)))
1473   {
1474     /* message is for me, check reverse route! */
1475     route = GNUNET_CONTAINER_multihashmap_get (all_routes,
1476                                                &rm->sender.hashPubKey);
1477     if (NULL == route)
1478     {
1479       /* don't have reverse route, drop */
1480       GNUNET_STATISTICS_update (stats,
1481                                 "# message discarded (no reverse route)",
1482                                 1, GNUNET_NO);
1483       return GNUNET_OK;
1484     }
1485     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1486                 "Delivering %u bytes to myself!\n",
1487                 ntohs (payload->size));
1488     send_data_to_plugin (payload,
1489                          &rm->sender,
1490                          ntohl (route->target.distance));
1491     return GNUNET_OK;
1492   }
1493   route = GNUNET_CONTAINER_multihashmap_get (all_routes,
1494                                              &rm->target.hashPubKey);
1495   if (NULL == route)
1496   {
1497     GNUNET_STATISTICS_update (stats,
1498                               "# messages discarded (no route)",
1499                               1, GNUNET_NO);
1500     return GNUNET_OK;
1501   }
1502   if (ntohl (route->target.distance) > ntohl (rm->distance) + 1)
1503   {
1504     GNUNET_STATISTICS_update (stats,
1505                               "# messages discarded (target too far)",
1506                               1, GNUNET_NO);
1507     return GNUNET_OK;
1508   }
1509   forward_payload (route->next_hop,
1510                    ntohl (route->target.distance),
1511                    0,
1512                    &rm->target,
1513                    &rm->sender,
1514                    payload);
1515   return GNUNET_OK;
1516 }
1517
1518
1519 /**
1520  * Service server's handler for message send requests (which come
1521  * bubbling up to us through the DV plugin).
1522  *
1523  * @param cls closure
1524  * @param client identification of the client
1525  * @param message the actual message
1526  */
1527 static void
1528 handle_dv_send_message (void *cls, struct GNUNET_SERVER_Client *client,
1529                         const struct GNUNET_MessageHeader *message)
1530 {
1531   struct Route *route;
1532   const struct GNUNET_DV_SendMessage *msg;
1533   const struct GNUNET_MessageHeader *payload;
1534
1535   if (ntohs (message->size) < sizeof (struct GNUNET_DV_SendMessage) + sizeof (struct GNUNET_MessageHeader))
1536   {
1537     GNUNET_break (0);
1538     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1539     return;
1540   }
1541   msg = (const struct GNUNET_DV_SendMessage *) message;
1542   GNUNET_break (0 != ntohl (msg->uid));
1543   payload = (const struct GNUNET_MessageHeader *) &msg[1];
1544   if (ntohs (message->size) != sizeof (struct GNUNET_DV_SendMessage) + ntohs (payload->size))
1545   {
1546     GNUNET_break (0);
1547     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1548     return;
1549   }
1550   route = GNUNET_CONTAINER_multihashmap_get (all_routes,
1551                                              &msg->target.hashPubKey);
1552   if (NULL == route)
1553   {
1554     /* got disconnected */
1555     GNUNET_STATISTICS_update (stats,
1556                               "# local messages discarded (no route)",
1557                               1, GNUNET_NO);
1558     send_ack_to_plugin (&msg->target, ntohl (msg->uid), GNUNET_YES);
1559     GNUNET_SERVER_receive_done (client, GNUNET_OK);
1560     return;
1561   }
1562   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1563               "Forwarding %u bytes to %s\n",
1564               ntohs (payload->size),
1565               GNUNET_i2s (&msg->target));
1566
1567   forward_payload (route->next_hop,
1568                    ntohl (route->target.distance),
1569                    htonl (msg->uid),
1570                    &msg->target,
1571                    &my_identity,
1572                    payload);
1573   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1574 }
1575
1576
1577 /**
1578  * Cleanup all of the data structures associated with a given neighbor.
1579  *
1580  * @param neighbor neighbor to clean up
1581  */
1582 static void
1583 cleanup_neighbor (struct DirectNeighbor *neighbor)
1584 {
1585   struct PendingMessage *pending;
1586
1587   while (NULL != (pending = neighbor->pm_head))
1588   {
1589     neighbor->pm_queue_size--;
1590     GNUNET_CONTAINER_DLL_remove (neighbor->pm_head,
1591                                  neighbor->pm_tail,
1592                                  pending);
1593     GNUNET_free (pending);
1594   }
1595   handle_direct_disconnect (neighbor);
1596   GNUNET_assert (GNUNET_YES ==
1597                  GNUNET_CONTAINER_multihashmap_remove (direct_neighbors,
1598                                                        &neighbor->peer.hashPubKey,
1599                                                        neighbor));
1600   GNUNET_free (neighbor);
1601 }
1602
1603
1604 /**
1605  * Method called whenever a given peer disconnects.
1606  *
1607  * @param cls closure
1608  * @param peer peer identity this notification is about
1609  */
1610 static void
1611 handle_core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
1612 {
1613   struct DirectNeighbor *neighbor;
1614
1615   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1616               "Received core peer disconnect message for peer `%s'!\n",
1617               GNUNET_i2s (peer));
1618   /* Check for disconnect from self message */
1619   if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
1620     return;
1621   neighbor =
1622       GNUNET_CONTAINER_multihashmap_get (direct_neighbors, &peer->hashPubKey);
1623   if (NULL == neighbor)
1624   {
1625     GNUNET_break (0);
1626     return;
1627   }
1628   GNUNET_break (GNUNET_YES == neighbor->connected);
1629   neighbor->connected = GNUNET_NO;
1630   if (DIRECT_NEIGHBOR_COST == neighbor->distance)
1631   {
1632     GNUNET_STATISTICS_update (stats,
1633                               "# peers connected (1-hop)",
1634                               -1, GNUNET_NO);
1635   }
1636   cleanup_neighbor (neighbor);
1637   GNUNET_CONTAINER_multihashmap_iterate (direct_neighbors,
1638                                          &refresh_routes,
1639                                          NULL);
1640 }
1641
1642
1643 /**
1644  * Multihashmap iterator for freeing routes.  Should never be called.
1645  *
1646  * @param cls NULL
1647  * @param key key value stored under
1648  * @param value the route to be freed
1649  *
1650  * @return GNUNET_YES to continue iteration, GNUNET_NO to stop
1651  */
1652 static int
1653 free_route (void *cls, const struct GNUNET_HashCode * key, void *value)
1654 {
1655   struct Route *route = value;
1656
1657   GNUNET_break (0);
1658   GNUNET_assert (GNUNET_YES ==
1659                  GNUNET_CONTAINER_multihashmap_remove (all_routes, key, value));
1660   release_route (route);
1661   send_disconnect_to_plugin (&route->target.peer);
1662   GNUNET_free (route);
1663   return GNUNET_YES;
1664 }
1665
1666
1667 /**
1668  * Multihashmap iterator for freeing direct neighbors. Should never be called.
1669  *
1670  * @param cls NULL
1671  * @param key key value stored under
1672  * @param value the direct neighbor to be freed
1673  *
1674  * @return GNUNET_YES to continue iteration, GNUNET_NO to stop
1675  */
1676 static int
1677 free_direct_neighbors (void *cls, const struct GNUNET_HashCode * key, void *value)
1678 {
1679   struct DirectNeighbor *neighbor = value;
1680
1681   GNUNET_break (0);
1682   cleanup_neighbor (neighbor);
1683   return GNUNET_YES;
1684 }
1685
1686
1687 /**
1688  * Task run during shutdown.
1689  *
1690  * @param cls unused
1691  * @param tc unused
1692  */
1693 static void
1694 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1695 {
1696   unsigned int i;
1697
1698   GNUNET_CORE_disconnect (core_api);
1699   core_api = NULL;
1700   GNUNET_ATS_performance_done (ats);
1701   ats = NULL;
1702   GNUNET_CONTAINER_multihashmap_iterate (direct_neighbors,
1703                                          &free_direct_neighbors, NULL);
1704   GNUNET_CONTAINER_multihashmap_iterate (all_routes,
1705                                          &free_route, NULL);
1706   GNUNET_CONTAINER_multihashmap_destroy (direct_neighbors);
1707   GNUNET_CONTAINER_multihashmap_destroy (all_routes);
1708   GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
1709   stats = NULL;
1710   GNUNET_SERVER_notification_context_destroy (nc);
1711   nc = NULL;
1712   for (i=0;i<DEFAULT_FISHEYE_DEPTH - 1;i++)
1713     GNUNET_array_grow (consensi[i].targets,
1714                        consensi[i].array_length,
1715                        0);
1716 }
1717
1718
1719 /**
1720  * Notify newly connected client about an existing route.
1721  *
1722  * @param cls the 'struct GNUNET_SERVER_Client'
1723  * @param key peer identity
1724  * @param value the XXX.
1725  * @return GNUNET_OK (continue to iterate)
1726  */
1727 static int
1728 add_route (void *cls,
1729            const struct GNUNET_HashCode *key,
1730            void *value)
1731 {
1732   struct GNUNET_SERVER_Client *client = cls;
1733   struct Route *route = value;
1734   struct GNUNET_DV_ConnectMessage cm;
1735
1736   cm.header.size = htons (sizeof (cm));
1737   cm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_CONNECT);
1738   cm.distance = htonl (route->target.distance);
1739   cm.peer = route->target.peer;
1740
1741   GNUNET_SERVER_notification_context_unicast (nc,
1742                                               client,
1743                                               &cm.header,
1744                                               GNUNET_NO);
1745   return GNUNET_OK;
1746 }
1747
1748
1749 /**
1750  * Handle START-message.  This is the first message sent to us
1751  * by the client (can only be one!).
1752  *
1753  * @param cls closure (always NULL)
1754  * @param client identification of the client
1755  * @param message the actual message
1756  */
1757 static void
1758 handle_start (void *cls, struct GNUNET_SERVER_Client *client,
1759               const struct GNUNET_MessageHeader *message)
1760 {
1761   GNUNET_SERVER_notification_context_add (nc, client);
1762   GNUNET_SERVER_receive_done (client, GNUNET_OK);
1763   GNUNET_CONTAINER_multihashmap_iterate (all_routes,
1764                                          &add_route,
1765                                          client);
1766 }
1767
1768
1769 /**
1770  * Called on core init.
1771  *
1772  * @param cls unused
1773  * @param server legacy
1774  * @param identity this peer's identity
1775  */
1776 static void
1777 core_init (void *cls, struct GNUNET_CORE_Handle *server,
1778            const struct GNUNET_PeerIdentity *identity)
1779 {
1780   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1781               "I am peer: %s\n",
1782               GNUNET_i2s (identity));
1783   my_identity = *identity;
1784 }
1785
1786
1787 /**
1788  * Process dv requests.
1789  *
1790  * @param cls closure
1791  * @param server the initialized server
1792  * @param c configuration to use
1793  */
1794 static void
1795 run (void *cls, struct GNUNET_SERVER_Handle *server,
1796      const struct GNUNET_CONFIGURATION_Handle *c)
1797 {
1798   static struct GNUNET_CORE_MessageHandler core_handlers[] = {
1799     {&handle_dv_route_message, GNUNET_MESSAGE_TYPE_DV_ROUTE, 0},
1800     {NULL, 0, 0}
1801   };
1802   static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
1803     {&handle_start, NULL,
1804      GNUNET_MESSAGE_TYPE_DV_START,
1805      sizeof (struct GNUNET_MessageHeader) },
1806     { &handle_dv_send_message, NULL,
1807       GNUNET_MESSAGE_TYPE_DV_SEND,
1808       0},
1809     {NULL, NULL, 0, 0}
1810   };
1811
1812   cfg = c;
1813   direct_neighbors = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1814   all_routes = GNUNET_CONTAINER_multihashmap_create (65536, GNUNET_NO);
1815   core_api = GNUNET_CORE_connect (cfg, NULL,
1816                                   &core_init,
1817                                   &handle_core_connect,
1818                                   &handle_core_disconnect,
1819                                   NULL, GNUNET_NO,
1820                                   NULL, GNUNET_NO,
1821                                   core_handlers);
1822
1823   if (NULL == core_api)
1824     return;
1825   ats = GNUNET_ATS_performance_init (cfg, &handle_ats_update, NULL);
1826   if (NULL == ats)
1827   {
1828     GNUNET_CORE_disconnect (core_api);
1829     return;
1830   }
1831   nc = GNUNET_SERVER_notification_context_create (server,
1832                                                   MAX_QUEUE_SIZE_PLUGIN);
1833   stats = GNUNET_STATISTICS_create ("dv", cfg);
1834   GNUNET_SERVER_add_handlers (server, plugin_handlers);
1835   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1836                                 &shutdown_task, NULL);
1837 }
1838
1839
1840 /**
1841  * The main function for the dv service.
1842  *
1843  * @param argc number of arguments from the command line
1844  * @param argv command line arguments
1845  * @return 0 ok, 1 on error
1846  */
1847 int
1848 main (int argc, char *const *argv)
1849 {
1850   return (GNUNET_OK ==
1851           GNUNET_SERVICE_run (argc, argv, "dv", GNUNET_SERVICE_OPTION_NONE,
1852                               &run, NULL)) ? 0 : 1;
1853 }
1854
1855 /* end of gnunet-service-dv.c */