2 This file is part of GNUnet.
3 Copyright (C) 2013 GNUnet e.V.
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.
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.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
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
27 * @author Christian Grothoff
28 * @author Nathan Evans
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"
44 * How often do we establish the consensu?
46 #define GNUNET_DV_CONSENSUS_FREQUENCY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 5)
49 * Maximum number of messages we queue per peer.
51 #define MAX_QUEUE_SIZE 16
54 * Maximum number of messages we queue towards the clients/plugin.
56 #define MAX_QUEUE_SIZE_PLUGIN 1024
59 * The default fisheye depth, from how many hops away will
62 #define DEFAULT_FISHEYE_DEPTH 3
65 * How many hops is a direct neighbor away?
67 #define DIRECT_NEIGHBOR_COST 1
70 GNUNET_NETWORK_STRUCT_BEGIN
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.
81 * Identity of the peer we can reach.
83 struct GNUNET_PeerIdentity peer;
86 * How many hops (1-3) is this peer away? in network byte order
88 uint32_t distance GNUNET_PACKED;
94 * Message exchanged between DV services (via core), requesting a
95 * message to be routed.
100 * Type: #GNUNET_MESSAGE_TYPE_DV_ROUTE
102 struct GNUNET_MessageHeader header;
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.
110 uint32_t distance GNUNET_PACKED;
113 * The (actual) target of the message (this peer, if distance is zero).
115 struct GNUNET_PeerIdentity target;
118 * The (actual) sender of the message.
120 struct GNUNET_PeerIdentity sender;
124 GNUNET_NETWORK_STRUCT_END
128 * Linked list of messages to send to clients.
130 struct PendingMessage
133 * Pointer to next item in the list
135 struct PendingMessage *next;
138 * Pointer to previous item in the list
140 struct PendingMessage *prev;
143 * Actual message to be sent, allocated after this struct.
145 const struct GNUNET_MessageHeader *msg;
148 * Next target for the message (a neighbour of ours).
150 struct GNUNET_PeerIdentity next_target;
153 * Unique ID of the message.
161 * Information about a direct neighbor (core-level, excluding
162 * DV-links, only DV-enabled peers).
164 struct DirectNeighbor
168 * Identity of the peer.
170 struct GNUNET_PeerIdentity peer;
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.
178 struct GNUNET_HashCode real_session_id;
181 * Head of linked list of messages to send to this peer.
183 struct PendingMessage *pm_head;
186 * Tail of linked list of messages to send to this peer.
188 struct PendingMessage *pm_tail;
191 * Transmit handle to core service.
193 struct GNUNET_CORE_TransmitHandle *cth;
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!
201 struct GNUNET_CONTAINER_MultiPeerMap *neighbor_table;
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 other peer, not from us!
210 struct GNUNET_CONTAINER_MultiPeerMap *neighbor_table_consensus;
213 * Our current (exposed) routing table as a set.
215 struct GNUNET_SET_Handle *my_set;
218 * Handle for our current active set union operation.
220 struct GNUNET_SET_OperationHandle *set_op;
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.
227 struct GNUNET_SET_ListenHandle *listen_handle;
230 * ID of the task we use to (periodically) update our consensus
231 * with this peer. Used if we are the initiating peer.
233 struct GNUNET_SCHEDULER_Task * initiate_task;
236 * At what offset are we, with respect to inserting our own routes
237 * into the consensus?
239 unsigned int consensus_insertion_offset;
242 * At what distance are we, with respect to inserting our own routes
243 * into the consensus?
245 unsigned int consensus_insertion_distance;
248 * Number of messages currently in the 'pm_XXXX'-DLL.
250 unsigned int pm_queue_size;
253 * Elements in consensus
255 unsigned int consensus_elements;
258 * Direct one hop route
260 struct Route *direct_route;
263 * Flag set within 'check_target_removed' to trigger full global route refresh.
268 * Our distance to this peer, 0 for unknown.
273 * The network this peer is in
275 enum GNUNET_ATS_Network_Type network;
278 * Is this neighbor connected at the core level?
286 * A route includes information about the next hop,
287 * the target, and the ultimate distance to the
294 * Which peer do we need to forward the message to?
296 struct DirectNeighbor *next_hop;
299 * What would be the target, and how far is it away?
301 struct Target target;
304 * Offset of this target in the respective consensus set.
306 unsigned int set_offset;
312 * Set of targets we bring to a consensus; all targets in a set have a
313 * distance equal to the sets distance (which is implied by the array
320 * Array of targets in the set, may include NULL entries if a
321 * neighbor has disconnected; the targets are allocated with the
322 * respective container (all_routes), not here.
324 struct Route **targets;
327 * Size of the @e targets array.
329 unsigned int array_length;
335 * Peermap of all of our neighbors; processing these usually requires
336 * first checking to see if the peer is core-connected and if the
337 * distance is 1, in which case they are direct neighbors.
339 static struct GNUNET_CONTAINER_MultiPeerMap *direct_neighbors;
342 * Hashmap with all routes that we currently support; contains
343 * routing information for all peers from distance 2
344 * up to distance #DEFAULT_FISHEYE_DEPTH.
346 static struct GNUNET_CONTAINER_MultiPeerMap *all_routes;
349 * Array of consensus sets we expose to the outside world. Sets
350 * are structured by the distance to the target.
352 static struct ConsensusSet consensi[DEFAULT_FISHEYE_DEPTH];
355 * Handle to the core service api.
357 static struct GNUNET_CORE_Handle *core_api;
360 * The identity of our peer.
362 static struct GNUNET_PeerIdentity my_identity;
365 * The configuration for this service.
367 static const struct GNUNET_CONFIGURATION_Handle *cfg;
370 * The client, the DV plugin connected to us (or an event monitor).
371 * Hopefully this client will never change, although if the plugin
372 * dies and returns for some reason it may happen.
374 static struct GNUNET_SERVER_NotificationContext *nc;
377 * Handle for the statistics service.
379 static struct GNUNET_STATISTICS_Handle *stats;
382 * Handle to ATS service.
384 static struct GNUNET_ATS_PerformanceHandle *ats;
387 * Task scheduled to refresh routes based on direct neighbours.
389 static struct GNUNET_SCHEDULER_Task * rr_task;
392 * #GNUNET_YES if we are shutting down.
394 static int in_shutdown;
397 * Start creating a new DV set union by initiating the connection.
399 * @param cls the 'struct DirectNeighbor' of the peer we're building
400 * a routing consensus with
403 initiate_set_union (void *cls);
407 * Start creating a new DV set union construction, our neighbour has
408 * asked for it (callback for listening peer).
410 * @param cls the 'struct DirectNeighbor' of the peer we're building
411 * a routing consensus with
412 * @param other_peer the other peer
413 * @param context_msg message with application specific information from
415 * @param request request from the other peer, use GNUNET_SET_accept
416 * to accept it, otherwise the request will be refused
417 * Note that we don't use a return value here, as it is also
418 * necessary to specify the set we want to do the operation with,
419 * whith sometimes can be derived from the context message.
420 * Also necessary to specify the timeout.
423 listen_set_union (void *cls,
424 const struct GNUNET_PeerIdentity *other_peer,
425 const struct GNUNET_MessageHeader *context_msg,
426 struct GNUNET_SET_Request *request);
430 * Forward a message from another peer to the plugin.
432 * @param message the message to send to the plugin
433 * @param origin the original sender of the message
434 * @param distance distance to the original sender of the message
437 send_data_to_plugin (const struct GNUNET_MessageHeader *message,
438 const struct GNUNET_PeerIdentity *origin,
441 struct GNUNET_DV_ReceivedMessage *received_msg;
444 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
445 "Delivering message from peer `%s' at distance %u\n",
447 (unsigned int) distance);
448 size = sizeof (struct GNUNET_DV_ReceivedMessage) +
449 ntohs (message->size);
450 if (size >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
452 GNUNET_break (0); /* too big */
455 received_msg = GNUNET_malloc (size);
456 received_msg->header.size = htons (size);
457 received_msg->header.type = htons (GNUNET_MESSAGE_TYPE_DV_RECV);
458 received_msg->distance = htonl (distance);
459 received_msg->sender = *origin;
460 memcpy (&received_msg[1], message, ntohs (message->size));
461 GNUNET_SERVER_notification_context_broadcast (nc,
462 &received_msg->header,
464 GNUNET_free (received_msg);
469 * Forward a control message to the plugin.
471 * @param message the message to send to the plugin
474 send_control_to_plugin (const struct GNUNET_MessageHeader *message)
476 GNUNET_SERVER_notification_context_broadcast (nc,
483 * Give an (N)ACK message to the plugin, we transmitted a message for it.
485 * @param target peer that received the message
486 * @param uid plugin-chosen UID for the message
487 * @param nack #GNUNET_NO to send ACK, #GNUNET_YES to send NACK
490 send_ack_to_plugin (const struct GNUNET_PeerIdentity *target,
494 struct GNUNET_DV_AckMessage ack_msg;
496 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
497 "Delivering ACK for message to peer `%s'\n",
498 GNUNET_i2s (target));
499 ack_msg.header.size = htons (sizeof (ack_msg));
500 ack_msg.header.type = htons ((GNUNET_YES == nack)
501 ? GNUNET_MESSAGE_TYPE_DV_SEND_NACK
502 : GNUNET_MESSAGE_TYPE_DV_SEND_ACK);
503 ack_msg.uid = htonl (uid);
504 ack_msg.target = *target;
505 send_control_to_plugin (&ack_msg.header);
510 * Send a DISTANCE_CHANGED message to the plugin.
512 * @param peer peer with a changed distance
513 * @param distance new distance to the peer
514 * @param network network used by the neighbor
517 send_distance_change_to_plugin (const struct GNUNET_PeerIdentity *peer,
519 enum GNUNET_ATS_Network_Type network)
521 struct GNUNET_DV_DistanceUpdateMessage du_msg;
523 GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != network);
524 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
525 "Delivering DISTANCE_CHANGED for message about peer `%s'\n",
527 du_msg.header.size = htons (sizeof (du_msg));
528 du_msg.header.type = htons (GNUNET_MESSAGE_TYPE_DV_DISTANCE_CHANGED);
529 du_msg.distance = htonl (distance);
531 du_msg.network = htonl ((uint32_t) network);
532 send_control_to_plugin (&du_msg.header);
537 * Give a CONNECT message to the plugin.
539 * @param target peer that connected
540 * @param distance distance to the target
541 * @param network the network the next hop is located in
544 send_connect_to_plugin (const struct GNUNET_PeerIdentity *target,
546 enum GNUNET_ATS_Network_Type network)
548 struct GNUNET_DV_ConnectMessage cm;
550 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
551 "Delivering CONNECT about peer %s with distance %u\n",
552 GNUNET_i2s (target), distance);
553 cm.header.size = htons (sizeof (cm));
554 cm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_CONNECT);
555 cm.distance = htonl (distance);
556 cm.network = htonl ((uint32_t) network);
558 send_control_to_plugin (&cm.header);
563 * Give a DISCONNECT message to the plugin.
565 * @param target peer that disconnected
568 send_disconnect_to_plugin (const struct GNUNET_PeerIdentity *target)
570 struct GNUNET_DV_DisconnectMessage dm;
572 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
573 "Delivering DISCONNECT about peer `%s'\n",
574 GNUNET_i2s (target));
575 dm.header.size = htons (sizeof (dm));
576 dm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_DISCONNECT);
577 dm.reserved = htonl (0);
579 send_control_to_plugin (&dm.header);
584 * Function called to transfer a message to another peer
587 * @param cls closure with the direct neighbor
588 * @param size number of bytes available in buf
589 * @param buf where the callee should write the message
590 * @return number of bytes written to buf
593 core_transmit_notify (void *cls, size_t size, void *buf)
595 struct DirectNeighbor *dn = cls;
597 struct PendingMessage *pending;
604 /* client disconnected */
608 while ( (NULL != (pending = dn->pm_head)) &&
609 (size >= off + (msize = ntohs (pending->msg->size))))
612 GNUNET_CONTAINER_DLL_remove (dn->pm_head,
615 memcpy (&cbuf[off], pending->msg, msize);
616 if (0 != pending->uid)
618 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
619 "Acking transmission of %u bytes to %s with plugin\n",
621 GNUNET_i2s (&pending->next_target));
622 send_ack_to_plugin (&pending->next_target,
626 GNUNET_free (pending);
629 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
630 "Transmitting total of %u bytes to %s\n",
632 GNUNET_i2s (&dn->peer));
633 GNUNET_assert (NULL != core_api);
636 GNUNET_CORE_notify_transmit_ready (core_api,
637 GNUNET_YES /* cork */,
638 GNUNET_CORE_PRIO_BEST_EFFORT,
639 GNUNET_TIME_UNIT_FOREVER_REL,
642 &core_transmit_notify, dn);
648 * Forward the given payload to the given target.
650 * @param target where to send the message
651 * @param distance distance to the @a sender
652 * @param uid unique ID for the message
653 * @param sender original sender of the message
654 * @param actual_target ultimate recipient for the message
655 * @param payload payload of the message
658 forward_payload (struct DirectNeighbor *target,
661 const struct GNUNET_PeerIdentity *sender,
662 const struct GNUNET_PeerIdentity *actual_target,
663 const struct GNUNET_MessageHeader *payload)
665 struct PendingMessage *pm;
666 struct RouteMessage *rm;
669 if ( (target->pm_queue_size >= MAX_QUEUE_SIZE) &&
671 (0 != memcmp (sender,
673 sizeof (struct GNUNET_PeerIdentity))) )
675 /* not _our_ client and queue is full, drop */
676 GNUNET_STATISTICS_update (stats,
677 "# messages dropped",
681 msize = sizeof (struct RouteMessage) + ntohs (payload->size);
682 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
687 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
688 pm->next_target = target->peer;
690 pm->msg = (const struct GNUNET_MessageHeader *) &pm[1];
691 rm = (struct RouteMessage *) &pm[1];
692 rm->header.size = htons ((uint16_t) msize);
693 rm->header.type = htons (GNUNET_MESSAGE_TYPE_DV_ROUTE);
694 rm->distance = htonl (distance);
695 rm->target = *actual_target;
696 rm->sender = *sender;
697 memcpy (&rm[1], payload, ntohs (payload->size));
698 GNUNET_CONTAINER_DLL_insert_tail (target->pm_head,
701 target->pm_queue_size++;
702 GNUNET_assert (NULL != core_api);
703 if (NULL == target->cth)
704 target->cth = GNUNET_CORE_notify_transmit_ready (core_api,
705 GNUNET_YES /* cork */,
706 GNUNET_CORE_PRIO_BEST_EFFORT,
707 GNUNET_TIME_UNIT_FOREVER_REL,
710 &core_transmit_notify, target);
715 * Find a free slot for storing a 'route' in the 'consensi'
716 * set at the given distance.
718 * @param distance distance to use for the set slot
721 get_consensus_slot (uint32_t distance)
723 struct ConsensusSet *cs;
726 GNUNET_assert (distance < DEFAULT_FISHEYE_DEPTH);
727 cs = &consensi[distance];
729 while ( (i < cs->array_length) &&
730 (NULL != cs->targets[i]) ) i++;
731 if (i == cs->array_length)
733 GNUNET_array_grow (cs->targets,
735 cs->array_length * 2 + 2);
742 * Allocate a slot in the consensus set for a route.
744 * @param route route to initialize
745 * @param distance which consensus set to use
748 allocate_route (struct Route *route,
753 if (distance >= DEFAULT_FISHEYE_DEPTH)
755 route->target.distance = htonl (distance);
756 route->set_offset = UINT_MAX; /* invalid slot */
759 i = get_consensus_slot (distance);
760 route->set_offset = i;
761 consensi[distance].targets[i] = route;
762 route->target.distance = htonl (distance);
767 * Release a slot in the consensus set for a route.
769 * @param route route to release the slot from
772 release_route (struct Route *route)
774 if (UINT_MAX == route->set_offset)
776 GNUNET_assert (ntohl (route->target.distance) < DEFAULT_FISHEYE_DEPTH);
777 consensi[ntohl (route->target.distance)].targets[route->set_offset] = NULL;
778 route->set_offset = UINT_MAX; /* indicate invalid slot */
783 * Move a route from one consensus set to another.
785 * @param route route to move
786 * @param new_distance new distance for the route (destination set)
789 move_route (struct Route *route,
790 uint32_t new_distance)
792 release_route (route);
793 allocate_route (route, new_distance);
798 * Initialize this neighbors 'my_set' and when done give
799 * it to the pending set operation for execution.
801 * Add a single element to the set per call:
803 * If we reached the last element of a consensus element: increase distance
806 * @param cls the neighbor for which we are building the set
809 build_set (void *cls)
811 struct DirectNeighbor *neighbor = cls;
812 struct GNUNET_SET_Element element;
813 struct Target *target;
817 /* skip over NULL entries */
818 while ( (DEFAULT_FISHEYE_DEPTH > neighbor->consensus_insertion_distance) &&
819 (consensi[neighbor->consensus_insertion_distance].array_length > neighbor->consensus_insertion_offset) &&
820 (NULL == consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset]) )
821 neighbor->consensus_insertion_offset++;
822 while ( (DEFAULT_FISHEYE_DEPTH > neighbor->consensus_insertion_distance) &&
823 (consensi[neighbor->consensus_insertion_distance].array_length == neighbor->consensus_insertion_offset) )
825 /* If we reached the last element of a consensus array element: increase distance and start with next array */
826 neighbor->consensus_insertion_offset = 0;
827 neighbor->consensus_insertion_distance++;
828 /* skip over NULL entries */
829 while ( (DEFAULT_FISHEYE_DEPTH > neighbor->consensus_insertion_distance) &&
830 (consensi[neighbor->consensus_insertion_distance].array_length > neighbor->consensus_insertion_offset) &&
831 (NULL == consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset]) )
832 neighbor->consensus_insertion_offset++;
834 if (DEFAULT_FISHEYE_DEPTH == neighbor->consensus_insertion_distance)
836 /* we have added all elements to the set, run the operation */
837 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
838 "Finished building my SET for peer `%s' with %u elements, committing\n",
839 GNUNET_i2s (&neighbor->peer),
840 neighbor->consensus_elements);
841 GNUNET_SET_commit (neighbor->set_op,
843 GNUNET_SET_destroy (neighbor->my_set);
844 neighbor->my_set = NULL;
848 route = consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset];
849 GNUNET_assert (NULL != route);
850 target = &route->target;
851 GNUNET_assert (ntohl (target->distance) < DEFAULT_FISHEYE_DEPTH);
852 element.size = sizeof (struct Target);
853 element.element_type = htons (0);
854 element.data = target;
856 /* Find next non-NULL entry */
857 neighbor->consensus_insertion_offset++;
858 if ( (0 != memcmp (&target->peer, &my_identity, sizeof (my_identity))) &&
859 (0 != memcmp (&target->peer, &neighbor->peer, sizeof (neighbor->peer))) )
861 /* Add target if it is not the neighbor or this peer */
862 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
863 "Adding peer `%s' with distance %u to SET\n",
864 GNUNET_i2s (&target->peer),
865 ntohl (target->distance) + 1);
866 GNUNET_SET_add_element (neighbor->my_set,
868 &build_set, neighbor);
869 neighbor->consensus_elements++;
872 build_set (neighbor);
877 * A peer is now connected to us at distance 1. Initiate DV exchange.
879 * @param neighbor entry for the neighbor at distance 1
882 handle_direct_connect (struct DirectNeighbor *neighbor)
885 struct GNUNET_HashCode h1;
886 struct GNUNET_HashCode h2;
887 struct GNUNET_HashCode session_id;
889 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
890 "Direct connection to %s established, routing table exchange begins.\n",
891 GNUNET_i2s (&neighbor->peer));
892 GNUNET_STATISTICS_update (stats,
893 "# peers connected (1-hop)",
895 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
899 GNUNET_assert (GNUNET_YES ==
900 GNUNET_CONTAINER_multipeermap_remove (all_routes,
903 send_disconnect_to_plugin (&neighbor->peer);
904 release_route (route);
908 neighbor->direct_route = GNUNET_new (struct Route);
909 neighbor->direct_route->next_hop = neighbor;
910 neighbor->direct_route->target.peer = neighbor->peer;
911 allocate_route (neighbor->direct_route, DIRECT_NEIGHBOR_COST);
913 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
914 "Adding direct route to %s\n",
915 GNUNET_i2s (&neighbor->direct_route->target.peer));
918 /* construct session ID seed as XOR of both peer's identities */
919 GNUNET_CRYPTO_hash (&my_identity, sizeof (my_identity), &h1);
920 GNUNET_CRYPTO_hash (&neighbor->peer, sizeof (struct GNUNET_PeerIdentity), &h2);
921 GNUNET_CRYPTO_hash_xor (&h1,
924 /* make sure session ID is unique across applications by salting it with 'DV' */
925 GNUNET_CRYPTO_hkdf (&neighbor->real_session_id, sizeof (struct GNUNET_HashCode),
926 GCRY_MD_SHA512, GCRY_MD_SHA256,
928 &session_id, sizeof (session_id),
930 if (0 < memcmp (&neighbor->peer,
932 sizeof (struct GNUNET_PeerIdentity)))
934 if (NULL != neighbor->listen_handle)
939 neighbor->initiate_task = GNUNET_SCHEDULER_add_now (&initiate_set_union,
944 if (NULL != neighbor->listen_handle)
950 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
951 "Starting SET listen operation with peer `%s'\n",
952 GNUNET_i2s(&neighbor->peer));
953 neighbor->listen_handle = GNUNET_SET_listen (cfg,
954 GNUNET_SET_OPERATION_UNION,
955 &neighbor->real_session_id,
964 * Method called whenever a peer connects.
967 * @param peer peer identity this notification is about
970 handle_core_connect (void *cls,
971 const struct GNUNET_PeerIdentity *peer)
973 struct DirectNeighbor *neighbor;
975 /* Check for connect to self message */
976 if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
978 /* check if entry exists */
979 neighbor = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
981 if (NULL != neighbor)
983 GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != neighbor->network);
984 GNUNET_break (GNUNET_YES != neighbor->connected);
985 neighbor->connected = GNUNET_YES;
986 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
987 "Core connected to %s (distance %u)\n",
989 (unsigned int) neighbor->distance);
990 if (DIRECT_NEIGHBOR_COST != neighbor->distance)
992 handle_direct_connect (neighbor);
995 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
996 "Core connected to %s (distance unknown)\n",
998 neighbor = GNUNET_new (struct DirectNeighbor);
999 neighbor->peer = *peer;
1000 GNUNET_assert (GNUNET_YES ==
1001 GNUNET_CONTAINER_multipeermap_put (direct_neighbors,
1004 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1005 neighbor->connected = GNUNET_YES;
1006 neighbor->distance = 0; /* unknown */
1007 neighbor->network = GNUNET_ATS_NET_UNSPECIFIED;
1012 * Called for each 'target' in a neighbor table to free the associated memory.
1015 * @param key key of the value
1016 * @param value value to free
1017 * @return #GNUNET_OK to continue to iterate
1020 free_targets (void *cls,
1021 const struct GNUNET_PeerIdentity *key,
1024 GNUNET_free (value);
1030 * Add a new route to the given @a target via the given @a neighbor.
1032 * @param target the target of the route
1033 * @param neighbor the next hop for communicating with the @a target
1036 add_new_route (struct Target *target,
1037 struct DirectNeighbor *neighbor)
1039 struct Route *route;
1041 route = GNUNET_new (struct Route);
1042 route->next_hop = neighbor;
1043 route->target.peer = target->peer;
1044 allocate_route (route, ntohl (target->distance) + 1);
1045 GNUNET_assert (GNUNET_YES ==
1046 GNUNET_CONTAINER_multipeermap_put (all_routes,
1047 &route->target.peer,
1049 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1050 send_connect_to_plugin (&route->target.peer,
1051 ntohl (route->target.distance),
1057 * Multipeerhmap iterator for checking if a given route is
1058 * (now) useful to this peer.
1060 * @param cls the direct neighbor for the given route
1061 * @param key key value stored under
1062 * @param value a 'struct Target' that may or may not be useful; not that
1063 * the distance in 'target' does not include the first hop yet
1064 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1067 check_possible_route (void *cls,
1068 const struct GNUNET_PeerIdentity *key,
1071 struct DirectNeighbor *neighbor = cls;
1072 struct Target *target = value;
1073 struct Route *route;
1076 GNUNET_CONTAINER_multipeermap_contains (direct_neighbors,
1078 return GNUNET_YES; /* direct route, do not care about alternatives */
1079 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1083 /* we have an existing route, check how it compares with going via 'target' */
1084 if (ntohl (route->target.distance) > ntohl (target->distance) + 1)
1086 /* via 'target' is cheaper than the existing route; switch to alternative route! */
1087 move_route (route, ntohl (target->distance) + 1);
1088 route->next_hop = neighbor;
1089 send_distance_change_to_plugin (&target->peer,
1090 ntohl (target->distance) + 1,
1093 return GNUNET_YES; /* got a route to this target already */
1095 if (ntohl (target->distance) >= DEFAULT_FISHEYE_DEPTH)
1096 return GNUNET_YES; /* distance is too large to be interesting */
1097 add_new_route (target, neighbor);
1103 * Multipeermap iterator for finding routes that were previously
1104 * "hidden" due to a better route (called after a disconnect event).
1107 * @param key peer identity of the given direct neighbor
1108 * @param value a `struct DirectNeighbor` to check for additional routes
1109 * @return #GNUNET_YES to continue iteration
1112 refresh_routes (void *cls,
1113 const struct GNUNET_PeerIdentity *key,
1116 struct DirectNeighbor *neighbor = value;
1118 if ( (GNUNET_YES != neighbor->connected) ||
1119 (DIRECT_NEIGHBOR_COST != neighbor->distance) )
1121 if (NULL != neighbor->neighbor_table)
1122 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1123 &check_possible_route,
1130 * Task to run #refresh_routes() on all direct neighbours.
1135 refresh_routes_task (void *cls)
1138 GNUNET_CONTAINER_multipeermap_iterate (direct_neighbors,
1145 * Asynchronously run #refresh_routes() at the next opportunity
1146 * on all direct neighbours.
1149 schedule_refresh_routes ()
1151 if (NULL == rr_task)
1152 rr_task = GNUNET_SCHEDULER_add_now (&refresh_routes_task,
1158 * Multipeermap iterator for freeing routes that go via a particular
1159 * neighbor that disconnected and is thus no longer available.
1161 * @param cls the direct neighbor that is now unavailable
1162 * @param key key value stored under
1163 * @param value a `struct Route` that may or may not go via neighbor
1165 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1168 cull_routes (void *cls,
1169 const struct GNUNET_PeerIdentity *key,
1172 struct DirectNeighbor *neighbor = cls;
1173 struct Route *route = value;
1175 if (route->next_hop != neighbor)
1176 return GNUNET_YES; /* not affected */
1177 GNUNET_assert (GNUNET_YES ==
1178 GNUNET_CONTAINER_multipeermap_remove (all_routes, key, value));
1179 release_route (route);
1180 send_disconnect_to_plugin (&route->target.peer);
1181 GNUNET_free (route);
1187 * Handle the case that a direct connection to a peer is
1188 * disrupted. Remove all routes via that peer and
1189 * stop the consensus with it.
1191 * @param neighbor peer that was disconnected (or at least is no
1192 * longer at distance 1)
1195 handle_direct_disconnect (struct DirectNeighbor *neighbor)
1197 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1198 "Culling routes via %s due to direct disconnect\n",
1199 GNUNET_i2s (&neighbor->peer));
1200 GNUNET_CONTAINER_multipeermap_iterate (all_routes,
1203 if (NULL != neighbor->cth)
1205 GNUNET_CORE_notify_transmit_ready_cancel (neighbor->cth);
1206 neighbor->cth = NULL;
1209 if (NULL != neighbor->direct_route)
1211 release_route (neighbor->direct_route);
1212 GNUNET_free (neighbor->direct_route);
1213 neighbor->direct_route = NULL;
1216 if (NULL != neighbor->neighbor_table_consensus)
1218 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table_consensus,
1221 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table_consensus);
1222 neighbor->neighbor_table_consensus = NULL;
1224 if (NULL != neighbor->neighbor_table)
1226 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1229 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table);
1230 neighbor->neighbor_table = NULL;
1232 if (NULL != neighbor->set_op)
1234 GNUNET_SET_operation_cancel (neighbor->set_op);
1235 neighbor->set_op = NULL;
1237 if (NULL != neighbor->my_set)
1239 GNUNET_SET_destroy (neighbor->my_set);
1240 neighbor->my_set = NULL;
1242 if (NULL != neighbor->listen_handle)
1244 GNUNET_SET_listen_cancel (neighbor->listen_handle);
1245 neighbor->listen_handle = NULL;
1247 if (NULL != neighbor->initiate_task)
1249 GNUNET_SCHEDULER_cancel (neighbor->initiate_task);
1250 neighbor->initiate_task = NULL;
1256 * Function that is called with QoS information about an address; used
1257 * to update our current distance to another peer.
1259 * @param cls closure
1260 * @param address the address
1261 * @param active #GNUNET_YES if this address is actively used
1262 * to maintain a connection to a peer;
1263 * #GNUNET_NO if the address is not actively used;
1264 * #GNUNET_SYSERR if this address is no longer available for ATS
1265 * @param bandwidth_out assigned outbound bandwidth for the connection
1266 * @param bandwidth_in assigned inbound bandwidth for the connection
1267 * @param prop performance data for the address (as far as known)
1270 handle_ats_update (void *cls,
1271 const struct GNUNET_HELLO_Address *address,
1273 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
1274 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1275 const struct GNUNET_ATS_Properties *prop)
1277 struct DirectNeighbor *neighbor;
1279 enum GNUNET_ATS_Network_Type network;
1281 if (NULL == address)
1283 /* ATS service temporarily disconnected */
1287 if (GNUNET_YES != active)
1289 // FIXME: handle disconnect/inactive case too!
1292 distance = prop->distance;
1293 network = prop->scope;
1294 GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != network);
1295 /* check if entry exists */
1296 neighbor = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
1298 if (NULL != neighbor)
1300 neighbor->network = network;
1301 if (neighbor->distance == distance)
1302 return; /* nothing new to see here, move along */
1303 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1304 "ATS says distance to %s is now %u\n",
1305 GNUNET_i2s (&address->peer),
1306 (unsigned int) distance);
1307 if ( (DIRECT_NEIGHBOR_COST == neighbor->distance) &&
1308 (DIRECT_NEIGHBOR_COST == distance) )
1309 return; /* no change */
1310 if (DIRECT_NEIGHBOR_COST == neighbor->distance)
1312 neighbor->distance = distance;
1313 GNUNET_STATISTICS_update (stats,
1314 "# peers connected (1-hop)",
1316 handle_direct_disconnect (neighbor);
1317 schedule_refresh_routes ();
1320 neighbor->distance = distance;
1321 if (DIRECT_NEIGHBOR_COST != neighbor->distance)
1323 if (GNUNET_YES != neighbor->connected)
1325 handle_direct_connect (neighbor);
1328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1329 "ATS says distance to %s is now %u\n",
1330 GNUNET_i2s (&address->peer),
1331 (unsigned int) distance);
1332 neighbor = GNUNET_new (struct DirectNeighbor);
1333 neighbor->peer = address->peer;
1334 GNUNET_assert (GNUNET_YES ==
1335 GNUNET_CONTAINER_multipeermap_put (direct_neighbors,
1338 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1339 neighbor->connected = GNUNET_NO; /* not yet */
1340 neighbor->distance = distance;
1341 neighbor->network = network;
1346 * Check if a target was removed from the set of the other peer; if so,
1347 * if we also used it for our route, we need to remove it from our
1348 * 'all_routes' set (and later check if an alternative path now exists).
1350 * @param cls the `struct DirectNeighbor`
1351 * @param key peer identity for the target
1352 * @param value a `struct Target` previously reachable via the given neighbor
1355 check_target_removed (void *cls,
1356 const struct GNUNET_PeerIdentity *key,
1359 struct DirectNeighbor *neighbor = cls;
1360 struct Target *new_target;
1361 struct Route *current_route;
1363 new_target = GNUNET_CONTAINER_multipeermap_get (neighbor->neighbor_table_consensus,
1365 current_route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1367 if (NULL != new_target)
1369 /* target was in old set, is in new set */
1370 if ( (NULL != current_route) &&
1371 (current_route->next_hop == neighbor) &&
1372 (current_route->target.distance != new_target->distance) )
1374 /* need to recalculate routes due to distance change */
1375 neighbor->target_removed = GNUNET_YES;
1379 /* target was revoked, check if it was used */
1380 if ( (NULL == current_route) ||
1381 (current_route->next_hop != neighbor) )
1383 /* didn't matter, wasn't used */
1386 /* remove existing route */
1387 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1388 "Lost route to %s\n",
1389 GNUNET_i2s (¤t_route->target.peer));
1390 GNUNET_assert (GNUNET_YES ==
1391 GNUNET_CONTAINER_multipeermap_remove (all_routes, key, current_route));
1392 send_disconnect_to_plugin (¤t_route->target.peer);
1393 release_route (current_route);
1394 GNUNET_free (current_route);
1395 neighbor->target_removed = GNUNET_YES;
1401 * Check if a target was added to the set of the other peer; if it
1402 * was added or impoves the existing route, do the needed updates.
1404 * @param cls the `struct DirectNeighbor`
1405 * @param key peer identity for the target
1406 * @param value a `struct Target` now reachable via the given neighbor
1409 check_target_added (void *cls,
1410 const struct GNUNET_PeerIdentity *key,
1413 struct DirectNeighbor *neighbor = cls;
1414 struct Target *target = value;
1415 struct Route *current_route;
1417 /* target was revoked, check if it was used */
1418 current_route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1420 if (NULL != current_route)
1423 if (current_route->next_hop == neighbor)
1425 /* we had the same route before, no change in target */
1426 if (ntohl (target->distance) + 1 != ntohl (current_route->target.distance))
1428 /* but distance changed! */
1429 if (ntohl (target->distance) + 1 > DEFAULT_FISHEYE_DEPTH)
1431 /* distance increased beyond what is allowed, kill route */
1432 GNUNET_assert (GNUNET_YES ==
1433 GNUNET_CONTAINER_multipeermap_remove (all_routes,
1436 send_disconnect_to_plugin (key);
1437 release_route (current_route);
1438 GNUNET_free (current_route);
1442 /* distance decreased, update route */
1443 move_route (current_route,
1444 ntohl (target->distance) + 1);
1445 send_distance_change_to_plugin (&target->peer,
1446 ntohl (target->distance) + 1,
1452 if (ntohl (current_route->target.distance) <= ntohl (target->distance) + 1)
1454 /* alternative, shorter route exists, ignore */
1457 /* new route is better than the existing one, take over! */
1458 /* NOTE: minor security issue: malicious peers may advertise
1459 very short routes to take over longer paths; as we don't
1460 check that the shorter routes actually work, a malicious
1461 direct neighbor can use this to DoS our long routes */
1463 move_route (current_route, ntohl (target->distance) + 1);
1464 current_route->next_hop = neighbor;
1465 send_distance_change_to_plugin (&target->peer,
1466 ntohl (target->distance) + 1,
1471 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1472 "Discovered new route to %s using %u hops\n",
1473 GNUNET_i2s (&target->peer),
1474 (unsigned int) (ntohl (target->distance) + 1));
1475 current_route = GNUNET_new (struct Route);
1476 current_route->next_hop = neighbor;
1477 current_route->target.peer = target->peer;
1478 allocate_route (current_route, ntohl (target->distance) + 1);
1479 GNUNET_assert (GNUNET_YES ==
1480 GNUNET_CONTAINER_multipeermap_put (all_routes,
1481 ¤t_route->target.peer,
1483 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1485 send_connect_to_plugin (¤t_route->target.peer,
1486 ntohl (current_route->target.distance),
1493 * Callback for set operation results. Called for each element
1494 * in the result set.
1495 * We have learned a new route from the other peer. Add it to the
1496 * route set we're building.
1498 * @param cls the `struct DirectNeighbor` we're building the consensus with
1499 * @param element a result element, only valid if status is #GNUNET_SET_STATUS_OK
1500 * @param status see `enum GNUNET_SET_Status`
1503 handle_set_union_result (void *cls,
1504 const struct GNUNET_SET_Element *element,
1505 enum GNUNET_SET_Status status)
1507 struct DirectNeighbor *neighbor = cls;
1508 struct DirectNeighbor *dn;
1509 struct Target *target;
1514 case GNUNET_SET_STATUS_OK:
1515 status_str = "GNUNET_SET_STATUS_OK";
1517 case GNUNET_SET_STATUS_FAILURE:
1518 status_str = "GNUNET_SET_STATUS_FAILURE";
1520 case GNUNET_SET_STATUS_HALF_DONE:
1521 status_str = "GNUNET_SET_STATUS_HALF_DONE";
1523 case GNUNET_SET_STATUS_DONE:
1524 status_str = "GNUNET_SET_STATUS_DONE";
1527 status_str = "UNDEFINED";
1531 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1532 "Got SET union result: %s\n",
1536 case GNUNET_SET_STATUS_OK:
1537 if (sizeof (struct Target) != element->size)
1539 GNUNET_break_op (0);
1542 if ( (NULL != (dn = GNUNET_CONTAINER_multipeermap_get (direct_neighbors, &((struct Target *) element->data)->peer))) && (DIRECT_NEIGHBOR_COST == dn->distance) )
1544 /* this is a direct neighbor of ours, we do not care about routes
1548 target = GNUNET_new (struct Target);
1549 memcpy (target, element->data, sizeof (struct Target));
1550 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1551 "Received information about peer `%s' with distance %u from SET\n",
1552 GNUNET_i2s (&target->peer),
1553 ntohl (target->distance) + 1);
1555 if (NULL == neighbor->neighbor_table_consensus)
1556 neighbor->neighbor_table_consensus
1557 = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1559 GNUNET_CONTAINER_multipeermap_put (neighbor->neighbor_table_consensus,
1562 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1564 GNUNET_break_op (0);
1565 GNUNET_free (target);
1568 case GNUNET_SET_STATUS_FAILURE:
1569 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1570 "Failed to establish DV union, will try again later\n");
1571 neighbor->set_op = NULL;
1572 if (NULL != neighbor->neighbor_table_consensus)
1574 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table_consensus,
1577 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table_consensus);
1578 neighbor->neighbor_table_consensus = NULL;
1580 if (0 < memcmp (&neighbor->peer,
1582 sizeof (struct GNUNET_PeerIdentity)))
1583 neighbor->initiate_task = GNUNET_SCHEDULER_add_delayed (GNUNET_DV_CONSENSUS_FREQUENCY,
1584 &initiate_set_union,
1587 case GNUNET_SET_STATUS_HALF_DONE:
1589 case GNUNET_SET_STATUS_DONE:
1590 /* we got all of our updates; integrate routing table! */
1591 neighbor->target_removed = GNUNET_NO;
1592 if (NULL == neighbor->neighbor_table_consensus)
1593 neighbor->neighbor_table_consensus = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1594 if (NULL != neighbor->neighbor_table)
1595 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1596 &check_target_removed,
1598 if (GNUNET_YES == neighbor->target_removed)
1600 /* check if we got an alternative for the removed routes */
1601 schedule_refresh_routes ();
1603 /* add targets that appeared (and check for improved routes) */
1604 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table_consensus,
1605 &check_target_added,
1607 if (NULL != neighbor->neighbor_table)
1609 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1612 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table);
1613 neighbor->neighbor_table = NULL;
1615 neighbor->neighbor_table = neighbor->neighbor_table_consensus;
1616 neighbor->neighbor_table_consensus = NULL;
1618 /* operation done, schedule next run! */
1619 neighbor->set_op = NULL;
1620 if (0 < memcmp (&neighbor->peer,
1622 sizeof (struct GNUNET_PeerIdentity)))
1623 neighbor->initiate_task = GNUNET_SCHEDULER_add_delayed (GNUNET_DV_CONSENSUS_FREQUENCY,
1624 &initiate_set_union,
1635 * Start creating a new DV set union construction, our neighbour has
1636 * asked for it (callback for listening peer).
1638 * @param cls the 'struct DirectNeighbor' of the peer we're building
1639 * a routing consensus with
1640 * @param other_peer the other peer
1641 * @param context_msg message with application specific information from
1643 * @param request request from the other peer, use GNUNET_SET_accept
1644 * to accept it, otherwise the request will be refused
1645 * Note that we don't use a return value here, as it is also
1646 * necessary to specify the set we want to do the operation with,
1647 * whith sometimes can be derived from the context message.
1648 * Also necessary to specify the timeout.
1651 listen_set_union (void *cls,
1652 const struct GNUNET_PeerIdentity *other_peer,
1653 const struct GNUNET_MessageHeader *context_msg,
1654 struct GNUNET_SET_Request *request)
1656 struct DirectNeighbor *neighbor = cls;
1658 if (NULL == request)
1659 return; /* why??? */
1660 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1661 "Starting to create consensus with %s\n",
1662 GNUNET_i2s (&neighbor->peer));
1663 if (NULL != neighbor->set_op)
1665 GNUNET_SET_operation_cancel (neighbor->set_op);
1666 neighbor->set_op = NULL;
1668 if (NULL != neighbor->my_set)
1670 GNUNET_SET_destroy (neighbor->my_set);
1671 neighbor->my_set = NULL;
1673 neighbor->my_set = GNUNET_SET_create (cfg,
1674 GNUNET_SET_OPERATION_UNION);
1675 neighbor->set_op = GNUNET_SET_accept (request,
1676 GNUNET_SET_RESULT_ADDED,
1677 &handle_set_union_result,
1679 neighbor->consensus_insertion_offset = 0;
1680 neighbor->consensus_insertion_distance = 0;
1681 neighbor->consensus_elements = 0;
1682 build_set (neighbor);
1687 * Start creating a new DV set union by initiating the connection.
1689 * @param cls the `struct DirectNeighbor *` of the peer we're building
1690 * a routing consensus with
1693 initiate_set_union (void *cls)
1695 struct DirectNeighbor *neighbor = cls;
1697 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1698 "Initiating SET union with peer `%s'\n",
1699 GNUNET_i2s (&neighbor->peer));
1700 neighbor->initiate_task = NULL;
1701 neighbor->my_set = GNUNET_SET_create (cfg,
1702 GNUNET_SET_OPERATION_UNION);
1703 neighbor->set_op = GNUNET_SET_prepare (&neighbor->peer,
1704 &neighbor->real_session_id,
1706 GNUNET_SET_RESULT_ADDED,
1707 &handle_set_union_result,
1709 neighbor->consensus_insertion_offset = 0;
1710 neighbor->consensus_insertion_distance = 0;
1711 neighbor->consensus_elements = 0;
1712 build_set (neighbor);
1717 * Core handler for DV data messages. Whatever this message
1718 * contains all we really have to do is rip it out of its
1719 * DV layering and give it to our pal the DV plugin to report
1722 * @param cls closure
1723 * @param peer peer which sent the message (immediate sender)
1724 * @param message the message
1725 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the other peer violated the protocol
1728 handle_dv_route_message (void *cls,
1729 const struct GNUNET_PeerIdentity *peer,
1730 const struct GNUNET_MessageHeader *message)
1732 const struct RouteMessage *rm;
1733 const struct GNUNET_MessageHeader *payload;
1734 struct Route *route;
1735 struct DirectNeighbor *neighbor;
1736 struct DirectNeighbor *dn;
1737 struct Target *target;
1744 if (ntohs (message->size) < sizeof (struct RouteMessage) + sizeof (struct GNUNET_MessageHeader))
1746 GNUNET_break_op (0);
1747 return GNUNET_SYSERR;
1749 rm = (const struct RouteMessage *) message;
1750 distance = ntohl (rm->distance);
1751 payload = (const struct GNUNET_MessageHeader *) &rm[1];
1752 if (ntohs (message->size) != sizeof (struct RouteMessage) + ntohs (payload->size))
1754 GNUNET_break_op (0);
1755 return GNUNET_SYSERR;
1757 strncpy (prev, GNUNET_i2s (peer), 4);
1758 strncpy (me, GNUNET_i2s (&my_identity), 4);
1759 strncpy (src, GNUNET_i2s (&rm->sender), 4);
1760 strncpy (dst, GNUNET_i2s (&rm->target), 4);
1761 prev[4] = me[4] = src[4] = dst[4] = '\0';
1762 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1763 "Handling DV message with %u bytes payload of type %u from %s to %s routed by %s to me (%s @ hop %u)\n",
1764 ntohs (message->size) - sizeof (struct RouteMessage),
1765 ntohs (payload->type),
1768 (unsigned int) distance + 1);
1770 if (0 == memcmp (&rm->target,
1772 sizeof (struct GNUNET_PeerIdentity)))
1775 != (dn = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
1776 &rm->sender))) && (DIRECT_NEIGHBOR_COST == dn->distance))
1778 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1779 "Discarding DV message, as %s is a direct neighbor\n",
1780 GNUNET_i2s (&rm->sender));
1781 GNUNET_STATISTICS_update (stats,
1782 "# messages discarded (direct neighbor)",
1786 /* message is for me, check reverse route! */
1787 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1789 if ( (NULL == route) &&
1790 (distance < DEFAULT_FISHEYE_DEPTH) )
1792 /* don't have reverse route yet, learn it! */
1793 neighbor = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
1795 if (NULL == neighbor)
1800 target = GNUNET_new (struct Target);
1801 target->peer = rm->sender;
1802 target->distance = htonl (distance);
1803 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1804 "Learning sender %s at distance %u from delivery!\n",
1805 GNUNET_i2s (&rm->sender),
1806 (unsigned int) distance + 1);
1807 if (NULL == neighbor->neighbor_table)
1808 neighbor->neighbor_table = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1810 GNUNET_CONTAINER_multipeermap_put (neighbor->neighbor_table,
1813 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1815 GNUNET_break_op (0);
1816 GNUNET_free (target);
1819 add_new_route (target, neighbor);
1821 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1822 "Delivering %u bytes from %s to myself!\n",
1823 ntohs (payload->size),
1824 GNUNET_i2s (&rm->sender));
1825 send_data_to_plugin (payload,
1830 if ( (NULL == GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
1832 (NULL == GNUNET_CONTAINER_multipeermap_get (all_routes,
1835 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1836 "Learning sender %s at distance %u from forwarding!\n",
1837 GNUNET_i2s (&rm->sender),
1839 neighbor = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
1841 if (NULL == neighbor)
1846 target = GNUNET_new (struct Target);
1847 target->peer = rm->sender;
1848 target->distance = htonl (distance);
1849 if (NULL == neighbor->neighbor_table)
1850 neighbor->neighbor_table = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1852 GNUNET_CONTAINER_multipeermap_put (neighbor->neighbor_table,
1855 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1857 GNUNET_break_op (0);
1858 GNUNET_free (target);
1861 add_new_route (target, neighbor);
1864 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1868 neighbor = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
1870 if (NULL == neighbor)
1872 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1873 "No route to %s, not routing %u bytes!\n",
1874 GNUNET_i2s (&rm->target),
1875 ntohs (payload->size));
1876 GNUNET_STATISTICS_update (stats,
1877 "# messages discarded (no route)",
1884 neighbor = route->next_hop;
1886 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1887 "Forwarding message to %s\n",
1888 GNUNET_i2s (&neighbor->peer));
1889 forward_payload (neighbor,
1900 * Service server's handler for message send requests (which come
1901 * bubbling up to us through the DV plugin).
1903 * @param cls closure
1904 * @param client identification of the client
1905 * @param message the actual message
1908 handle_dv_send_message (void *cls, struct GNUNET_SERVER_Client *client,
1909 const struct GNUNET_MessageHeader *message)
1911 struct Route *route;
1912 const struct GNUNET_DV_SendMessage *msg;
1913 const struct GNUNET_MessageHeader *payload;
1915 if (ntohs (message->size) < sizeof (struct GNUNET_DV_SendMessage) + sizeof (struct GNUNET_MessageHeader))
1918 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1921 msg = (const struct GNUNET_DV_SendMessage *) message;
1922 GNUNET_break (0 != ntohl (msg->uid));
1923 payload = (const struct GNUNET_MessageHeader *) &msg[1];
1924 if (ntohs (message->size) != sizeof (struct GNUNET_DV_SendMessage) + ntohs (payload->size))
1927 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1930 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1934 /* got disconnected */
1935 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1936 "No route to %s, dropping local message of type %u\n",
1937 GNUNET_i2s (&msg->target),
1938 ntohs (payload->type));
1939 GNUNET_STATISTICS_update (stats,
1940 "# local messages discarded (no route)",
1942 send_ack_to_plugin (&msg->target, ntohl (msg->uid), GNUNET_YES);
1943 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1946 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1947 "Forwarding %u bytes of type %u to %s\n",
1948 ntohs (payload->size),
1949 ntohs (payload->type),
1950 GNUNET_i2s (&msg->target));
1952 forward_payload (route->next_hop,
1953 0 /* first hop, distance is zero */,
1958 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1963 * Cleanup all of the data structures associated with a given neighbor.
1965 * @param neighbor neighbor to clean up
1968 cleanup_neighbor (struct DirectNeighbor *neighbor)
1970 struct PendingMessage *pending;
1972 while (NULL != (pending = neighbor->pm_head))
1974 neighbor->pm_queue_size--;
1975 GNUNET_CONTAINER_DLL_remove (neighbor->pm_head,
1978 GNUNET_free (pending);
1980 handle_direct_disconnect (neighbor);
1981 GNUNET_assert (GNUNET_YES ==
1982 GNUNET_CONTAINER_multipeermap_remove (direct_neighbors,
1985 GNUNET_free (neighbor);
1990 * Method called whenever a given peer disconnects.
1992 * @param cls closure
1993 * @param peer peer identity this notification is about
1996 handle_core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
1998 struct DirectNeighbor *neighbor;
2000 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2001 "Received core peer disconnect message for peer `%s'!\n",
2003 /* Check for disconnect from self message */
2004 if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
2007 GNUNET_CONTAINER_multipeermap_get (direct_neighbors, peer);
2008 if (NULL == neighbor)
2013 GNUNET_break (GNUNET_YES == neighbor->connected);
2014 neighbor->connected = GNUNET_NO;
2015 if (DIRECT_NEIGHBOR_COST == neighbor->distance)
2018 GNUNET_STATISTICS_update (stats,
2019 "# peers connected (1-hop)",
2022 cleanup_neighbor (neighbor);
2024 if (GNUNET_YES == in_shutdown)
2026 schedule_refresh_routes ();
2031 * Multipeermap iterator for freeing routes. Should never be called.
2034 * @param key key value stored under
2035 * @param value the route to be freed
2036 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
2039 free_route (void *cls,
2040 const struct GNUNET_PeerIdentity *key,
2043 struct Route *route = value;
2046 GNUNET_assert (GNUNET_YES ==
2047 GNUNET_CONTAINER_multipeermap_remove (all_routes, key, value));
2048 release_route (route);
2049 send_disconnect_to_plugin (&route->target.peer);
2050 GNUNET_free (route);
2056 * Multipeermap iterator for freeing direct neighbors. Should never be called.
2059 * @param key key value stored under
2060 * @param value the direct neighbor to be freed
2061 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
2064 free_direct_neighbors (void *cls,
2065 const struct GNUNET_PeerIdentity *key,
2068 struct DirectNeighbor *neighbor = value;
2070 cleanup_neighbor (neighbor);
2076 * Task run during shutdown.
2081 shutdown_task (void *cls)
2085 in_shutdown = GNUNET_YES;
2086 GNUNET_assert (NULL != core_api);
2087 GNUNET_CORE_disconnect (core_api);
2089 GNUNET_ATS_performance_done (ats);
2091 GNUNET_CONTAINER_multipeermap_iterate (direct_neighbors,
2092 &free_direct_neighbors, NULL);
2093 GNUNET_CONTAINER_multipeermap_iterate (all_routes,
2095 GNUNET_CONTAINER_multipeermap_destroy (direct_neighbors);
2096 GNUNET_CONTAINER_multipeermap_destroy (all_routes);
2097 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
2099 GNUNET_SERVER_notification_context_destroy (nc);
2101 for (i=0;i<DEFAULT_FISHEYE_DEPTH;i++)
2103 GNUNET_array_grow (consensi[i].targets,
2104 consensi[i].array_length,
2107 if (NULL != rr_task)
2109 GNUNET_SCHEDULER_cancel (rr_task);
2116 * Notify newly connected client about an existing route.
2118 * @param cls the `struct GNUNET_SERVER_Client *`
2119 * @param key peer identity
2120 * @param value the `struct Route *`
2121 * @return #GNUNET_OK (continue to iterate)
2124 notify_client_about_route (void *cls,
2125 const struct GNUNET_PeerIdentity *key,
2128 struct GNUNET_SERVER_Client *client = cls;
2129 struct Route *route = value;
2130 struct GNUNET_DV_ConnectMessage cm;
2132 memset (&cm, 0, sizeof (cm));
2133 cm.header.size = htons (sizeof (cm));
2134 cm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_CONNECT);
2135 cm.distance = htonl (route->target.distance);
2136 cm.peer = route->target.peer;
2138 GNUNET_SERVER_notification_context_unicast (nc,
2147 * Handle START-message. This is the first message sent to us
2148 * by the client (can only be one!).
2150 * @param cls closure (always NULL)
2151 * @param client identification of the client
2152 * @param message the actual message
2155 handle_start (void *cls, struct GNUNET_SERVER_Client *client,
2156 const struct GNUNET_MessageHeader *message)
2158 GNUNET_SERVER_notification_context_add (nc, client);
2159 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2160 GNUNET_CONTAINER_multipeermap_iterate (all_routes,
2161 ¬ify_client_about_route,
2167 * Called on core init.
2170 * @param identity this peer's identity
2173 core_init (void *cls,
2174 const struct GNUNET_PeerIdentity *identity)
2176 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2178 GNUNET_i2s (identity));
2179 my_identity = *identity;
2184 * Process dv requests.
2186 * @param cls closure
2187 * @param server the initialized server
2188 * @param c configuration to use
2191 run (void *cls, struct GNUNET_SERVER_Handle *server,
2192 const struct GNUNET_CONFIGURATION_Handle *c)
2194 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
2195 {&handle_dv_route_message, GNUNET_MESSAGE_TYPE_DV_ROUTE, 0},
2198 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
2199 {&handle_start, NULL,
2200 GNUNET_MESSAGE_TYPE_DV_START,
2201 sizeof (struct GNUNET_MessageHeader) },
2202 { &handle_dv_send_message, NULL,
2203 GNUNET_MESSAGE_TYPE_DV_SEND,
2207 in_shutdown = GNUNET_NO;
2209 direct_neighbors = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
2210 all_routes = GNUNET_CONTAINER_multipeermap_create (65536, GNUNET_NO);
2211 core_api = GNUNET_CORE_connect (cfg, NULL,
2213 &handle_core_connect,
2214 &handle_core_disconnect,
2219 if (NULL == core_api)
2221 ats = GNUNET_ATS_performance_init (cfg, &handle_ats_update, NULL);
2224 GNUNET_CORE_disconnect (core_api);
2228 nc = GNUNET_SERVER_notification_context_create (server,
2229 MAX_QUEUE_SIZE_PLUGIN);
2230 stats = GNUNET_STATISTICS_create ("dv", cfg);
2231 GNUNET_SERVER_add_handlers (server, plugin_handlers);
2232 GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
2237 * The main function for the dv service.
2239 * @param argc number of arguments from the command line
2240 * @param argv command line arguments
2241 * @return 0 ok, 1 on error
2244 main (int argc, char *const *argv)
2246 return (GNUNET_OK ==
2247 GNUNET_SERVICE_run (argc, argv, "dv", GNUNET_SERVICE_OPTION_NONE,
2248 &run, NULL)) ? 0 : 1;
2251 /* end of gnunet-service-dv.c */