2 This file is part of GNUnet.
3 (C) 2013 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, 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 * Ultimate target for the message.
150 struct GNUNET_PeerIdentity ultimate_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 GNUNET_SCHEDULER_TaskIdentifier 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
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 GNUNET_SCHEDULER_TaskIdentifier 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
401 * @param tc scheduler context
404 initiate_set_union (void *cls,
405 const struct GNUNET_SCHEDULER_TaskContext *tc);
409 * Start creating a new DV set union construction, our neighbour has
410 * asked for it (callback for listening peer).
412 * @param cls the 'struct DirectNeighbor' of the peer we're building
413 * a routing consensus with
414 * @param other_peer the other peer
415 * @param context_msg message with application specific information from
417 * @param request request from the other peer, use GNUNET_SET_accept
418 * to accept it, otherwise the request will be refused
419 * Note that we don't use a return value here, as it is also
420 * necessary to specify the set we want to do the operation with,
421 * whith sometimes can be derived from the context message.
422 * Also necessary to specify the timeout.
425 listen_set_union (void *cls,
426 const struct GNUNET_PeerIdentity *other_peer,
427 const struct GNUNET_MessageHeader *context_msg,
428 struct GNUNET_SET_Request *request);
432 * Forward a message from another peer to the plugin.
434 * @param message the message to send to the plugin
435 * @param origin the original sender of the message
436 * @param distance distance to the original sender of the message
439 send_data_to_plugin (const struct GNUNET_MessageHeader *message,
440 const struct GNUNET_PeerIdentity *origin,
443 struct GNUNET_DV_ReceivedMessage *received_msg;
446 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
447 "Delivering message from peer `%s'\n",
448 GNUNET_i2s (origin));
449 size = sizeof (struct GNUNET_DV_ReceivedMessage) +
450 ntohs (message->size);
451 if (size >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
453 GNUNET_break (0); /* too big */
456 received_msg = GNUNET_malloc (size);
457 received_msg->header.size = htons (size);
458 received_msg->header.type = htons (GNUNET_MESSAGE_TYPE_DV_RECV);
459 received_msg->distance = htonl (distance);
460 received_msg->sender = *origin;
461 memcpy (&received_msg[1], message, ntohs (message->size));
462 GNUNET_SERVER_notification_context_broadcast (nc,
463 &received_msg->header,
465 GNUNET_free (received_msg);
470 * Forward a control message to the plugin.
472 * @param message the message to send to the plugin
475 send_control_to_plugin (const struct GNUNET_MessageHeader *message)
477 GNUNET_SERVER_notification_context_broadcast (nc,
484 * Give an (N)ACK message to the plugin, we transmitted a message for it.
486 * @param target peer that received the message
487 * @param uid plugin-chosen UID for the message
488 * @param nack #GNUNET_NO to send ACK, #GNUNET_YES to send NACK
491 send_ack_to_plugin (const struct GNUNET_PeerIdentity *target,
495 struct GNUNET_DV_AckMessage ack_msg;
497 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
498 "Delivering ACK for message to peer `%s'\n",
499 GNUNET_i2s (target));
500 ack_msg.header.size = htons (sizeof (ack_msg));
501 ack_msg.header.type = htons ((GNUNET_YES == nack)
502 ? GNUNET_MESSAGE_TYPE_DV_SEND_NACK
503 : GNUNET_MESSAGE_TYPE_DV_SEND_ACK);
504 ack_msg.uid = htonl (uid);
505 ack_msg.target = *target;
506 send_control_to_plugin (&ack_msg.header);
511 * Send a DISTANCE_CHANGED message to the plugin.
513 * @param peer peer with a changed distance
514 * @param distance new distance to the peer
515 * @param network network used by the neighbor
518 send_distance_change_to_plugin (const struct GNUNET_PeerIdentity *peer,
522 struct GNUNET_DV_DistanceUpdateMessage du_msg;
524 GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != network);
525 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
526 "Delivering DISTANCE_CHANGED for message about peer `%s'\n",
528 du_msg.header.size = htons (sizeof (du_msg));
529 du_msg.header.type = htons (GNUNET_MESSAGE_TYPE_DV_DISTANCE_CHANGED);
530 du_msg.distance = htonl (distance);
532 du_msg.network = htonl (network);
533 send_control_to_plugin (&du_msg.header);
538 * Give a CONNECT message to the plugin.
540 * @param target peer that connected
541 * @param distance distance to the target
542 * @param network the network the next hop is located in
545 send_connect_to_plugin (const struct GNUNET_PeerIdentity *target,
546 uint32_t distance, uint32_t 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 (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)
617 send_ack_to_plugin (&pending->ultimate_target,
620 GNUNET_free (pending);
623 GNUNET_assert (NULL != core_api);
624 if (NULL != dn->pm_head)
626 GNUNET_CORE_notify_transmit_ready (core_api,
627 GNUNET_YES /* cork */,
629 GNUNET_TIME_UNIT_FOREVER_REL,
632 &core_transmit_notify, dn);
638 * Forward the given payload to the given target.
640 * @param target where to send the message
641 * @param distance expected (remaining) distance to the target
642 * @param uid unique ID for the message
643 * @param ultimate_target ultimate recipient for the message
644 * @param sender original sender of the message
645 * @param payload payload of the message
648 forward_payload (struct DirectNeighbor *target,
651 const struct GNUNET_PeerIdentity *sender,
652 const struct GNUNET_PeerIdentity *ultimate_target,
653 const struct GNUNET_MessageHeader *payload)
655 struct PendingMessage *pm;
656 struct RouteMessage *rm;
659 if ( (target->pm_queue_size >= MAX_QUEUE_SIZE) &&
661 (0 != memcmp (sender,
663 sizeof (struct GNUNET_PeerIdentity))) )
665 /* not _our_ client and queue is full, drop */
666 GNUNET_STATISTICS_update (stats,
667 "# messages dropped",
671 msize = sizeof (struct RouteMessage) + ntohs (payload->size);
672 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
677 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
678 pm->ultimate_target = *ultimate_target;
680 pm->msg = (const struct GNUNET_MessageHeader *) &pm[1];
681 rm = (struct RouteMessage *) &pm[1];
682 rm->header.size = htons ((uint16_t) msize);
683 rm->header.type = htons (GNUNET_MESSAGE_TYPE_DV_ROUTE);
684 rm->distance = htonl (distance);
685 rm->target = target->peer;
686 rm->sender = *sender;
687 memcpy (&rm[1], payload, ntohs (payload->size));
688 GNUNET_CONTAINER_DLL_insert_tail (target->pm_head,
691 target->pm_queue_size++;
692 GNUNET_assert (NULL != core_api);
693 if (NULL == target->cth)
694 target->cth = GNUNET_CORE_notify_transmit_ready (core_api,
695 GNUNET_YES /* cork */,
697 GNUNET_TIME_UNIT_FOREVER_REL,
700 &core_transmit_notify, target);
705 * Find a free slot for storing a 'route' in the 'consensi'
706 * set at the given distance.
708 * @param distance distance to use for the set slot
711 get_consensus_slot (uint32_t distance)
713 struct ConsensusSet *cs;
716 GNUNET_assert (distance < DEFAULT_FISHEYE_DEPTH);
717 cs = &consensi[distance];
719 while ( (i < cs->array_length) &&
720 (NULL != cs->targets[i]) ) i++;
721 if (i == cs->array_length)
723 GNUNET_array_grow (cs->targets,
725 cs->array_length * 2 + 2);
732 * Allocate a slot in the consensus set for a route.
734 * @param route route to initialize
735 * @param distance which consensus set to use
738 allocate_route (struct Route *route,
743 if (distance >= DEFAULT_FISHEYE_DEPTH)
745 route->target.distance = htonl (distance);
746 route->set_offset = UINT_MAX; /* invalid slot */
749 i = get_consensus_slot (distance);
750 route->set_offset = i;
751 consensi[distance].targets[i] = route;
752 route->target.distance = htonl (distance);
757 * Release a slot in the consensus set for a route.
759 * @param route route to release the slot from
762 release_route (struct Route *route)
764 if (UINT_MAX == route->set_offset)
766 GNUNET_assert (ntohl (route->target.distance) < DEFAULT_FISHEYE_DEPTH);
767 consensi[ntohl (route->target.distance)].targets[route->set_offset] = NULL;
768 route->set_offset = UINT_MAX; /* indicate invalid slot */
773 * Move a route from one consensus set to another.
775 * @param route route to move
776 * @param new_distance new distance for the route (destination set)
779 move_route (struct Route *route,
780 uint32_t new_distance)
782 release_route (route);
783 allocate_route (route, new_distance);
788 * Initialize this neighbors 'my_set' and when done give
789 * it to the pending set operation for execution.
791 * Add a single element to the set per call:
793 * If we reached the last element of a consensus element: increase distance
796 * @param cls the neighbor for which we are building the set
799 build_set (void *cls)
801 struct DirectNeighbor *neighbor = cls;
802 struct GNUNET_SET_Element element;
803 struct Target *target;
807 /* skip over NULL entries */
808 while ( (DEFAULT_FISHEYE_DEPTH > neighbor->consensus_insertion_distance) &&
809 (consensi[neighbor->consensus_insertion_distance].array_length > neighbor->consensus_insertion_offset) &&
810 (NULL == consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset]) )
811 neighbor->consensus_insertion_offset++;
812 while ( (DEFAULT_FISHEYE_DEPTH > neighbor->consensus_insertion_distance) &&
813 (consensi[neighbor->consensus_insertion_distance].array_length == neighbor->consensus_insertion_offset) )
815 /* If we reached the last element of a consensus array element: increase distance and start with next array */
816 neighbor->consensus_insertion_offset = 0;
817 neighbor->consensus_insertion_distance++;
818 /* skip over NULL entries */
819 while ( (DEFAULT_FISHEYE_DEPTH > neighbor->consensus_insertion_distance) &&
820 (consensi[neighbor->consensus_insertion_distance].array_length > neighbor->consensus_insertion_offset) &&
821 (NULL == consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset]) )
822 neighbor->consensus_insertion_offset++;
824 if (DEFAULT_FISHEYE_DEPTH == neighbor->consensus_insertion_distance)
826 /* we have added all elements to the set, run the operation */
827 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
828 "Finished building my SET for peer `%s' with %u elements, committing\n",
829 GNUNET_i2s (&neighbor->peer),
830 neighbor->consensus_elements);
831 GNUNET_SET_commit (neighbor->set_op,
833 GNUNET_SET_destroy (neighbor->my_set);
834 neighbor->my_set = NULL;
838 route = consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset];
839 GNUNET_assert (NULL != route);
840 target = &route->target;
841 GNUNET_assert (ntohl (target->distance) < DEFAULT_FISHEYE_DEPTH);
842 element.size = sizeof (struct Target);
843 element.type = htons (0); /* do we need this? */
844 element.data = target;
846 /* Find next non-NULL entry */
847 neighbor->consensus_insertion_offset++;
848 if ( (0 != memcmp (&target->peer, &my_identity, sizeof (my_identity))) &&
849 (0 != memcmp (&target->peer, &neighbor->peer, sizeof (neighbor->peer))) )
851 /* Add target if it is not the neighbor or this peer */
852 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
853 "Adding peer `%s' with distance %u to SET\n",
854 GNUNET_i2s (&target->peer),
855 ntohl (target->distance));
856 GNUNET_SET_add_element (neighbor->my_set,
858 &build_set, neighbor);
859 neighbor->consensus_elements++;
862 build_set (neighbor);
867 * A peer is now connected to us at distance 1. Initiate DV exchange.
869 * @param neighbor entry for the neighbor at distance 1
872 handle_direct_connect (struct DirectNeighbor *neighbor)
875 struct GNUNET_HashCode h1;
876 struct GNUNET_HashCode h2;
877 struct GNUNET_HashCode session_id;
879 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
880 "Direct connection to %s established, routing table exchange begins.\n",
881 GNUNET_i2s (&neighbor->peer));
882 GNUNET_STATISTICS_update (stats,
883 "# peers connected (1-hop)",
885 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
889 GNUNET_assert (GNUNET_YES ==
890 GNUNET_CONTAINER_multipeermap_remove (all_routes,
893 send_disconnect_to_plugin (&neighbor->peer);
894 release_route (route);
898 neighbor->direct_route = GNUNET_new (struct Route);
899 neighbor->direct_route->next_hop = neighbor;
900 neighbor->direct_route->target.peer = neighbor->peer;
901 allocate_route (neighbor->direct_route, DIRECT_NEIGHBOR_COST);
903 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
904 "Adding direct route to %s\n",
905 GNUNET_i2s (&neighbor->direct_route->target.peer));
908 /* construct session ID seed as XOR of both peer's identities */
909 GNUNET_CRYPTO_hash (&my_identity, sizeof (my_identity), &h1);
910 GNUNET_CRYPTO_hash (&neighbor->peer, sizeof (struct GNUNET_PeerIdentity), &h2);
911 GNUNET_CRYPTO_hash_xor (&h1,
914 /* make sure session ID is unique across applications by salting it with 'DV' */
915 GNUNET_CRYPTO_hkdf (&neighbor->real_session_id, sizeof (struct GNUNET_HashCode),
916 GCRY_MD_SHA512, GCRY_MD_SHA256,
918 &session_id, sizeof (session_id),
920 if (0 < memcmp (&neighbor->peer,
922 sizeof (struct GNUNET_PeerIdentity)))
924 if (NULL != neighbor->listen_handle)
929 neighbor->initiate_task = GNUNET_SCHEDULER_add_now (&initiate_set_union,
934 if (NULL != neighbor->listen_handle)
940 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
941 "Starting SET listen operation with peer `%s'\n",
942 GNUNET_i2s(&neighbor->peer));
943 neighbor->listen_handle = GNUNET_SET_listen (cfg,
944 GNUNET_SET_OPERATION_UNION,
945 &neighbor->real_session_id,
954 * Method called whenever a peer connects.
957 * @param peer peer identity this notification is about
960 handle_core_connect (void *cls,
961 const struct GNUNET_PeerIdentity *peer)
963 struct DirectNeighbor *neighbor;
965 /* Check for connect to self message */
966 if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
968 /* check if entry exists */
969 neighbor = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
971 if (NULL != neighbor)
973 GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != neighbor->network);
974 GNUNET_break (GNUNET_YES != neighbor->connected);
975 neighbor->connected = GNUNET_YES;
976 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
977 "Core connected to %s (distance %u)\n",
979 (unsigned int) neighbor->distance);
980 if (DIRECT_NEIGHBOR_COST != neighbor->distance)
982 handle_direct_connect (neighbor);
985 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
986 "Core connected to %s (distance unknown)\n",
988 neighbor = GNUNET_new (struct DirectNeighbor);
989 neighbor->peer = *peer;
990 GNUNET_assert (GNUNET_YES ==
991 GNUNET_CONTAINER_multipeermap_put (direct_neighbors,
994 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
995 neighbor->connected = GNUNET_YES;
996 neighbor->distance = 0; /* unknown */
997 neighbor->network = GNUNET_ATS_NET_UNSPECIFIED;
1002 * Called for each 'target' in a neighbor table to free the associated memory.
1005 * @param key key of the value
1006 * @param value value to free
1007 * @return #GNUNET_OK to continue to iterate
1010 free_targets (void *cls,
1011 const struct GNUNET_PeerIdentity *key,
1014 GNUNET_free (value);
1020 * Multipeerhmap iterator for checking if a given route is
1021 * (now) useful to this peer.
1023 * @param cls the direct neighbor for the given route
1024 * @param key key value stored under
1025 * @param value a 'struct Target' that may or may not be useful; not that
1026 * the distance in 'target' does not include the first hop yet
1027 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1030 check_possible_route (void *cls,
1031 const struct GNUNET_PeerIdentity *key,
1034 struct DirectNeighbor *neighbor = cls;
1035 struct Target *target = value;
1036 struct Route *route;
1039 GNUNET_CONTAINER_multipeermap_contains (direct_neighbors,
1041 return GNUNET_YES; /* direct route, do not care about alternatives */
1042 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1046 /* we have an existing route, check how it compares with going via 'target' */
1047 if (ntohl (route->target.distance) > ntohl (target->distance) + 1)
1049 /* via 'target' is cheaper than the existing route; switch to alternative route! */
1050 move_route (route, ntohl (target->distance) + 1);
1051 route->next_hop = neighbor;
1052 send_distance_change_to_plugin (&target->peer,
1053 ntohl (target->distance) + 1,
1056 return GNUNET_YES; /* got a route to this target already */
1058 if (ntohl (target->distance) >= DEFAULT_FISHEYE_DEPTH)
1059 return GNUNET_YES; /* distance is too large to be interesting */
1060 route = GNUNET_new (struct Route);
1061 route->next_hop = neighbor;
1062 route->target.peer = target->peer;
1063 allocate_route (route, ntohl (target->distance) + 1);
1064 GNUNET_assert (GNUNET_YES ==
1065 GNUNET_CONTAINER_multipeermap_put (all_routes,
1066 &route->target.peer,
1068 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1069 send_connect_to_plugin (&route->target.peer,
1070 ntohl (route->target.distance),
1077 * Multipeermap iterator for finding routes that were previously
1078 * "hidden" due to a better route (called after a disconnect event).
1081 * @param key peer identity of the given direct neighbor
1082 * @param value a `struct DirectNeighbor` to check for additional routes
1083 * @return #GNUNET_YES to continue iteration
1086 refresh_routes (void *cls,
1087 const struct GNUNET_PeerIdentity *key,
1090 struct DirectNeighbor *neighbor = value;
1092 if ( (GNUNET_YES != neighbor->connected) ||
1093 (DIRECT_NEIGHBOR_COST != neighbor->distance) )
1095 if (NULL != neighbor->neighbor_table)
1096 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1097 &check_possible_route,
1104 * Task to run #refresh_routes() on all direct neighbours.
1110 refresh_routes_task (void *cls,
1111 const struct GNUNET_SCHEDULER_TaskContext *tc)
1113 rr_task = GNUNET_SCHEDULER_NO_TASK;
1114 GNUNET_CONTAINER_multipeermap_iterate (direct_neighbors,
1121 * Asynchronously run #refresh_routes() at the next opportunity
1122 * on all direct neighbours.
1125 schedule_refresh_routes ()
1127 if (GNUNET_SCHEDULER_NO_TASK == rr_task)
1128 rr_task = GNUNET_SCHEDULER_add_now (&refresh_routes_task,
1134 * Get distance information from 'atsi'.
1136 * @param atsi performance data
1137 * @param atsi_count number of entries in atsi
1138 * @return connected transport distance
1141 get_atsi_distance (const struct GNUNET_ATS_Information *atsi,
1142 uint32_t atsi_count)
1146 for (i = 0; i < atsi_count; i++)
1147 if (ntohl (atsi[i].type) == GNUNET_ATS_QUALITY_NET_DISTANCE)
1148 return (0 == ntohl (atsi[i].value)) ? DIRECT_NEIGHBOR_COST : ntohl (atsi[i].value); // FIXME: 0 check should not be required once ATS is fixed!
1149 /* If we do not have explicit distance data, assume direct neighbor. */
1150 return DIRECT_NEIGHBOR_COST;
1155 * Get network information from 'atsi'.
1157 * @param atsi performance data
1158 * @param atsi_count number of entries in atsi
1159 * @return connected transport network
1162 get_atsi_network (const struct GNUNET_ATS_Information *atsi,
1163 uint32_t atsi_count)
1167 for (i = 0; i < atsi_count; i++)
1168 if (ntohl (atsi[i].type) == GNUNET_ATS_NETWORK_TYPE)
1169 return ntohl (atsi[i].value);
1170 return GNUNET_ATS_NET_UNSPECIFIED;
1174 * Multipeermap iterator for freeing routes that go via a particular
1175 * neighbor that disconnected and is thus no longer available.
1177 * @param cls the direct neighbor that is now unavailable
1178 * @param key key value stored under
1179 * @param value a `struct Route` that may or may not go via neighbor
1181 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1184 cull_routes (void *cls,
1185 const struct GNUNET_PeerIdentity *key,
1188 struct DirectNeighbor *neighbor = cls;
1189 struct Route *route = value;
1191 if (route->next_hop != neighbor)
1192 return GNUNET_YES; /* not affected */
1193 GNUNET_assert (GNUNET_YES ==
1194 GNUNET_CONTAINER_multipeermap_remove (all_routes, key, value));
1195 release_route (route);
1196 send_disconnect_to_plugin (&route->target.peer);
1197 GNUNET_free (route);
1203 * Handle the case that a direct connection to a peer is
1204 * disrupted. Remove all routes via that peer and
1205 * stop the consensus with it.
1207 * @param neighbor peer that was disconnected (or at least is no
1208 * longer at distance 1)
1211 handle_direct_disconnect (struct DirectNeighbor *neighbor)
1213 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1214 "Culling routes via %s due to direct disconnect\n",
1215 GNUNET_i2s (&neighbor->peer));
1216 GNUNET_CONTAINER_multipeermap_iterate (all_routes,
1219 if (NULL != neighbor->cth)
1221 GNUNET_CORE_notify_transmit_ready_cancel (neighbor->cth);
1222 neighbor->cth = NULL;
1225 if (NULL != neighbor->direct_route)
1227 release_route (neighbor->direct_route);
1228 GNUNET_free (neighbor->direct_route);
1229 neighbor->direct_route = NULL;
1232 if (NULL != neighbor->neighbor_table_consensus)
1234 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table_consensus,
1237 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table_consensus);
1238 neighbor->neighbor_table_consensus = NULL;
1240 if (NULL != neighbor->neighbor_table)
1242 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1245 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table);
1246 neighbor->neighbor_table = NULL;
1248 if (NULL != neighbor->set_op)
1250 GNUNET_SET_operation_cancel (neighbor->set_op);
1251 neighbor->set_op = NULL;
1253 if (NULL != neighbor->my_set)
1255 GNUNET_SET_destroy (neighbor->my_set);
1256 neighbor->my_set = NULL;
1258 if (NULL != neighbor->listen_handle)
1260 GNUNET_SET_listen_cancel (neighbor->listen_handle);
1261 neighbor->listen_handle = NULL;
1263 if (GNUNET_SCHEDULER_NO_TASK != neighbor->initiate_task)
1265 GNUNET_SCHEDULER_cancel (neighbor->initiate_task);
1266 neighbor->initiate_task = GNUNET_SCHEDULER_NO_TASK;
1272 * Function that is called with QoS information about an address; used
1273 * to update our current distance to another peer.
1275 * @param cls closure
1276 * @param address the address
1277 * @param active is this address in active use
1278 * @param bandwidth_out assigned outbound bandwidth for the connection
1279 * @param bandwidth_in assigned inbound bandwidth for the connection
1280 * @param ats performance data for the address (as far as known)
1281 * @param ats_count number of performance records in @a ats
1284 handle_ats_update (void *cls,
1285 const struct GNUNET_HELLO_Address *address,
1287 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
1288 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1289 const struct GNUNET_ATS_Information *ats,
1292 struct DirectNeighbor *neighbor;
1294 uint32_t network = GNUNET_ATS_NET_UNSPECIFIED;
1296 if (GNUNET_NO == active)
1298 distance = get_atsi_distance (ats, ats_count);
1299 network = get_atsi_network (ats, ats_count);
1300 GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != network);
1301 /* check if entry exists */
1302 neighbor = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
1304 if (NULL != neighbor)
1306 neighbor->network = network;
1307 if (neighbor->distance == distance)
1308 return; /* nothing new to see here, move along */
1309 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1310 "ATS says distance to %s is now %u\n",
1311 GNUNET_i2s (&address->peer),
1312 (unsigned int) distance);
1313 if ( (DIRECT_NEIGHBOR_COST == neighbor->distance) &&
1314 (DIRECT_NEIGHBOR_COST == distance) )
1315 return; /* no change */
1316 if (DIRECT_NEIGHBOR_COST == neighbor->distance)
1318 neighbor->distance = distance;
1319 GNUNET_STATISTICS_update (stats,
1320 "# peers connected (1-hop)",
1322 handle_direct_disconnect (neighbor);
1323 schedule_refresh_routes ();
1326 neighbor->distance = distance;
1327 if (DIRECT_NEIGHBOR_COST != neighbor->distance)
1329 if (GNUNET_YES != neighbor->connected)
1331 handle_direct_connect (neighbor);
1334 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1335 "ATS says distance to %s is now %u\n",
1336 GNUNET_i2s (&address->peer),
1337 (unsigned int) distance);
1338 neighbor = GNUNET_new (struct DirectNeighbor);
1339 neighbor->peer = address->peer;
1340 GNUNET_assert (GNUNET_YES ==
1341 GNUNET_CONTAINER_multipeermap_put (direct_neighbors,
1344 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1345 neighbor->connected = GNUNET_NO; /* not yet */
1346 neighbor->distance = distance;
1347 neighbor->network = network;
1352 * Check if a target was removed from the set of the other peer; if so,
1353 * if we also used it for our route, we need to remove it from our
1354 * 'all_routes' set (and later check if an alternative path now exists).
1356 * @param cls the `struct DirectNeighbor`
1357 * @param key peer identity for the target
1358 * @param value a `struct Target` previously reachable via the given neighbor
1361 check_target_removed (void *cls,
1362 const struct GNUNET_PeerIdentity *key,
1365 struct DirectNeighbor *neighbor = cls;
1366 struct Target *new_target;
1367 struct Route *current_route;
1369 new_target = GNUNET_CONTAINER_multipeermap_get (neighbor->neighbor_table_consensus,
1371 current_route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1373 if (NULL != new_target)
1375 /* target was in old set, is in new set */
1376 if ( (NULL != current_route) &&
1377 (current_route->next_hop == neighbor) &&
1378 (current_route->target.distance != new_target->distance) )
1380 /* need to recalculate routes due to distance change */
1381 neighbor->target_removed = GNUNET_YES;
1385 /* target was revoked, check if it was used */
1386 if ( (NULL == current_route) ||
1387 (current_route->next_hop != neighbor) )
1389 /* didn't matter, wasn't used */
1392 /* remove existing route */
1393 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1394 "Lost route to %s\n",
1395 GNUNET_i2s (¤t_route->target.peer));
1396 GNUNET_assert (GNUNET_YES ==
1397 GNUNET_CONTAINER_multipeermap_remove (all_routes, key, current_route));
1398 send_disconnect_to_plugin (¤t_route->target.peer);
1399 release_route (current_route);
1400 GNUNET_free (current_route);
1401 neighbor->target_removed = GNUNET_YES;
1407 * Check if a target was added to the set of the other peer; if it
1408 * was added or impoves the existing route, do the needed updates.
1410 * @param cls the `struct DirectNeighbor`
1411 * @param key peer identity for the target
1412 * @param value a `struct Target` now reachable via the given neighbor
1415 check_target_added (void *cls,
1416 const struct GNUNET_PeerIdentity *key,
1419 struct DirectNeighbor *neighbor = cls;
1420 struct Target *target = value;
1421 struct Route *current_route;
1423 /* target was revoked, check if it was used */
1424 current_route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1426 if (NULL != current_route)
1429 if (current_route->next_hop == neighbor)
1431 /* we had the same route before, no change in target */
1432 if (ntohl (target->distance) + 1 != ntohl (current_route->target.distance))
1434 /* but distance changed! */
1435 if (ntohl (target->distance) + 1 > DEFAULT_FISHEYE_DEPTH)
1437 /* distance increased beyond what is allowed, kill route */
1438 GNUNET_assert (GNUNET_YES ==
1439 GNUNET_CONTAINER_multipeermap_remove (all_routes,
1442 send_disconnect_to_plugin (key);
1443 release_route (current_route);
1444 GNUNET_free (current_route);
1448 /* distance decreased, update route */
1449 move_route (current_route,
1450 ntohl (target->distance) + 1);
1451 send_distance_change_to_plugin (&target->peer,
1452 ntohl (target->distance) + 1,
1458 if (ntohl (current_route->target.distance) <= ntohl (target->distance) + 1)
1460 /* alternative, shorter route exists, ignore */
1463 /* new route is better than the existing one, take over! */
1464 /* NOTE: minor security issue: malicious peers may advertise
1465 very short routes to take over longer paths; as we don't
1466 check that the shorter routes actually work, a malicious
1467 direct neighbor can use this to DoS our long routes */
1469 move_route (current_route, ntohl (target->distance) + 1);
1470 current_route->next_hop = neighbor;
1471 send_distance_change_to_plugin (&target->peer,
1472 ntohl (target->distance) + 1,
1477 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1478 "Discovered new route to %s using %u hops\n",
1479 GNUNET_i2s (&target->peer),
1480 (unsigned int) (ntohl (target->distance) + 1));
1481 current_route = GNUNET_new (struct Route);
1482 current_route->next_hop = neighbor;
1483 current_route->target.peer = target->peer;
1484 allocate_route (current_route, ntohl (target->distance) + 1);
1485 GNUNET_assert (GNUNET_YES ==
1486 GNUNET_CONTAINER_multipeermap_put (all_routes,
1487 ¤t_route->target.peer,
1489 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1491 send_connect_to_plugin (¤t_route->target.peer,
1492 ntohl (current_route->target.distance),
1499 * Callback for set operation results. Called for each element
1500 * in the result set.
1501 * We have learned a new route from the other peer. Add it to the
1502 * route set we're building.
1504 * @param cls the `struct DirectNeighbor` we're building the consensus with
1505 * @param element a result element, only valid if status is #GNUNET_SET_STATUS_OK
1506 * @param status see `enum GNUNET_SET_Status`
1509 handle_set_union_result (void *cls,
1510 const struct GNUNET_SET_Element *element,
1511 enum GNUNET_SET_Status status)
1513 struct DirectNeighbor *neighbor = cls;
1514 struct Target *target;
1518 case GNUNET_SET_STATUS_OK:
1519 status_str = "GNUNET_SET_STATUS_OK";
1521 case GNUNET_SET_STATUS_TIMEOUT:
1522 status_str = "GNUNET_SET_STATUS_TIMEOUT";
1524 case GNUNET_SET_STATUS_FAILURE:
1525 status_str = "GNUNET_SET_STATUS_FAILURE";
1527 case GNUNET_SET_STATUS_HALF_DONE:
1528 status_str = "GNUNET_SET_STATUS_HALF_DONE";
1530 case GNUNET_SET_STATUS_DONE:
1531 status_str = "GNUNET_SET_STATUS_DONE";
1534 status_str = "UNDEFINED";
1538 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1539 "Got SET union result: %s\n",
1543 case GNUNET_SET_STATUS_OK:
1544 if (sizeof (struct Target) != element->size)
1546 GNUNET_break_op (0);
1550 GNUNET_CONTAINER_multipeermap_contains (direct_neighbors,
1551 &((struct Target *) element->data)->peer))
1553 /* this is a direct neighbor of ours, we do not care about routes
1557 target = GNUNET_new (struct Target);
1558 memcpy (target, element->data, sizeof (struct Target));
1559 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1560 "Received information about peer `%s' with distance %u from SET\n",
1561 GNUNET_i2s (&target->peer),
1562 ntohl (target->distance) + 1);
1564 if (NULL == neighbor->neighbor_table_consensus)
1565 neighbor->neighbor_table_consensus
1566 = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1568 GNUNET_CONTAINER_multipeermap_put (neighbor->neighbor_table_consensus,
1571 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1573 GNUNET_break_op (0);
1574 GNUNET_free (target);
1577 case GNUNET_SET_STATUS_TIMEOUT:
1578 case GNUNET_SET_STATUS_FAILURE:
1579 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1580 "Failed to establish DV union, will try again later\n");
1581 neighbor->set_op = NULL;
1582 if (NULL != neighbor->neighbor_table_consensus)
1584 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table_consensus,
1587 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table_consensus);
1588 neighbor->neighbor_table_consensus = NULL;
1590 if (0 < memcmp (&neighbor->peer,
1592 sizeof (struct GNUNET_PeerIdentity)))
1593 neighbor->initiate_task = GNUNET_SCHEDULER_add_delayed (GNUNET_DV_CONSENSUS_FREQUENCY,
1594 &initiate_set_union,
1597 case GNUNET_SET_STATUS_HALF_DONE:
1599 case GNUNET_SET_STATUS_DONE:
1600 /* we got all of our updates; integrate routing table! */
1601 neighbor->target_removed = GNUNET_NO;
1602 if (NULL == neighbor->neighbor_table_consensus)
1603 neighbor->neighbor_table_consensus = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1604 if (NULL != neighbor->neighbor_table)
1605 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1606 &check_target_removed,
1608 if (GNUNET_YES == neighbor->target_removed)
1610 /* check if we got an alternative for the removed routes */
1611 schedule_refresh_routes ();
1613 /* add targets that appeared (and check for improved routes) */
1614 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table_consensus,
1615 &check_target_added,
1617 if (NULL != neighbor->neighbor_table)
1619 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1622 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table);
1623 neighbor->neighbor_table = NULL;
1625 neighbor->neighbor_table = neighbor->neighbor_table_consensus;
1626 neighbor->neighbor_table_consensus = NULL;
1628 /* operation done, schedule next run! */
1629 neighbor->set_op = NULL;
1630 if (0 < memcmp (&neighbor->peer,
1632 sizeof (struct GNUNET_PeerIdentity)))
1633 neighbor->initiate_task = GNUNET_SCHEDULER_add_delayed (GNUNET_DV_CONSENSUS_FREQUENCY,
1634 &initiate_set_union,
1645 * Start creating a new DV set union construction, our neighbour has
1646 * asked for it (callback for listening peer).
1648 * @param cls the 'struct DirectNeighbor' of the peer we're building
1649 * a routing consensus with
1650 * @param other_peer the other peer
1651 * @param context_msg message with application specific information from
1653 * @param request request from the other peer, use GNUNET_SET_accept
1654 * to accept it, otherwise the request will be refused
1655 * Note that we don't use a return value here, as it is also
1656 * necessary to specify the set we want to do the operation with,
1657 * whith sometimes can be derived from the context message.
1658 * Also necessary to specify the timeout.
1661 listen_set_union (void *cls,
1662 const struct GNUNET_PeerIdentity *other_peer,
1663 const struct GNUNET_MessageHeader *context_msg,
1664 struct GNUNET_SET_Request *request)
1666 struct DirectNeighbor *neighbor = cls;
1668 if (NULL == request)
1669 return; /* why??? */
1670 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1671 "Starting to create consensus with %s\n",
1672 GNUNET_i2s (&neighbor->peer));
1673 if (NULL != neighbor->set_op)
1675 GNUNET_SET_operation_cancel (neighbor->set_op);
1676 neighbor->set_op = NULL;
1678 if (NULL != neighbor->my_set)
1680 GNUNET_SET_destroy (neighbor->my_set);
1681 neighbor->my_set = NULL;
1683 neighbor->my_set = GNUNET_SET_create (cfg,
1684 GNUNET_SET_OPERATION_UNION);
1685 neighbor->set_op = GNUNET_SET_accept (request,
1686 GNUNET_SET_RESULT_ADDED,
1687 &handle_set_union_result,
1689 neighbor->consensus_insertion_offset = 0;
1690 neighbor->consensus_insertion_distance = 0;
1691 neighbor->consensus_elements = 0;
1692 build_set (neighbor);
1697 * Start creating a new DV set union by initiating the connection.
1699 * @param cls the `struct DirectNeighbor *` of the peer we're building
1700 * a routing consensus with
1701 * @param tc scheduler context
1704 initiate_set_union (void *cls,
1705 const struct GNUNET_SCHEDULER_TaskContext *tc)
1707 static uint16_t salt;
1708 struct DirectNeighbor *neighbor = cls;
1710 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1711 "Initiating SET union with peer `%s'\n",
1712 GNUNET_i2s (&neighbor->peer));
1713 neighbor->initiate_task = GNUNET_SCHEDULER_NO_TASK;
1714 neighbor->my_set = GNUNET_SET_create (cfg,
1715 GNUNET_SET_OPERATION_UNION);
1716 neighbor->set_op = GNUNET_SET_prepare (&neighbor->peer,
1717 &neighbor->real_session_id,
1720 GNUNET_SET_RESULT_ADDED,
1721 &handle_set_union_result,
1723 neighbor->consensus_insertion_offset = 0;
1724 neighbor->consensus_insertion_distance = 0;
1725 neighbor->consensus_elements = 0;
1726 build_set (neighbor);
1731 * Core handler for DV data messages. Whatever this message
1732 * contains all we really have to do is rip it out of its
1733 * DV layering and give it to our pal the DV plugin to report
1736 * @param cls closure
1737 * @param peer peer which sent the message (immediate sender)
1738 * @param message the message
1739 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the other peer violated the protocol
1742 handle_dv_route_message (void *cls, const struct GNUNET_PeerIdentity *peer,
1743 const struct GNUNET_MessageHeader *message)
1745 const struct RouteMessage *rm;
1746 const struct GNUNET_MessageHeader *payload;
1747 struct Route *route;
1749 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1750 "Handling DV message\n");
1751 if (ntohs (message->size) < sizeof (struct RouteMessage) + sizeof (struct GNUNET_MessageHeader))
1753 GNUNET_break_op (0);
1754 return GNUNET_SYSERR;
1756 rm = (const struct RouteMessage *) message;
1757 payload = (const struct GNUNET_MessageHeader *) &rm[1];
1758 if (ntohs (message->size) != sizeof (struct RouteMessage) + ntohs (payload->size))
1760 GNUNET_break_op (0);
1761 return GNUNET_SYSERR;
1763 if (0 == memcmp (&rm->target,
1765 sizeof (struct GNUNET_PeerIdentity)))
1767 /* message is for me, check reverse route! */
1768 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1772 /* don't have reverse route, drop */
1773 GNUNET_STATISTICS_update (stats,
1774 "# message discarded (no reverse route)",
1778 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1779 "Delivering %u bytes to myself!\n",
1780 ntohs (payload->size));
1781 send_data_to_plugin (payload,
1783 ntohl (route->target.distance));
1786 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1790 GNUNET_STATISTICS_update (stats,
1791 "# messages discarded (no route)",
1795 if (ntohl (route->target.distance) > ntohl (rm->distance) + 1)
1797 GNUNET_STATISTICS_update (stats,
1798 "# messages discarded (target too far)",
1802 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1803 "Forwarding message to %s\n",
1804 GNUNET_i2s (&rm->target));
1805 forward_payload (route->next_hop,
1806 ntohl (route->target.distance),
1816 * Service server's handler for message send requests (which come
1817 * bubbling up to us through the DV plugin).
1819 * @param cls closure
1820 * @param client identification of the client
1821 * @param message the actual message
1824 handle_dv_send_message (void *cls, struct GNUNET_SERVER_Client *client,
1825 const struct GNUNET_MessageHeader *message)
1827 struct Route *route;
1828 const struct GNUNET_DV_SendMessage *msg;
1829 const struct GNUNET_MessageHeader *payload;
1831 if (ntohs (message->size) < sizeof (struct GNUNET_DV_SendMessage) + sizeof (struct GNUNET_MessageHeader))
1834 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1837 msg = (const struct GNUNET_DV_SendMessage *) message;
1838 GNUNET_break (0 != ntohl (msg->uid));
1839 payload = (const struct GNUNET_MessageHeader *) &msg[1];
1840 if (ntohs (message->size) != sizeof (struct GNUNET_DV_SendMessage) + ntohs (payload->size))
1843 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1846 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1850 /* got disconnected */
1851 GNUNET_STATISTICS_update (stats,
1852 "# local messages discarded (no route)",
1854 send_ack_to_plugin (&msg->target, ntohl (msg->uid), GNUNET_YES);
1855 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1858 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1859 "Forwarding %u bytes to %s\n",
1860 ntohs (payload->size),
1861 GNUNET_i2s (&msg->target));
1863 forward_payload (route->next_hop,
1864 ntohl (route->target.distance),
1869 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1874 * Cleanup all of the data structures associated with a given neighbor.
1876 * @param neighbor neighbor to clean up
1879 cleanup_neighbor (struct DirectNeighbor *neighbor)
1881 struct PendingMessage *pending;
1883 while (NULL != (pending = neighbor->pm_head))
1885 neighbor->pm_queue_size--;
1886 GNUNET_CONTAINER_DLL_remove (neighbor->pm_head,
1889 GNUNET_free (pending);
1891 handle_direct_disconnect (neighbor);
1892 GNUNET_assert (GNUNET_YES ==
1893 GNUNET_CONTAINER_multipeermap_remove (direct_neighbors,
1896 GNUNET_free (neighbor);
1901 * Method called whenever a given peer disconnects.
1903 * @param cls closure
1904 * @param peer peer identity this notification is about
1907 handle_core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
1909 struct DirectNeighbor *neighbor;
1911 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1912 "Received core peer disconnect message for peer `%s'!\n",
1914 /* Check for disconnect from self message */
1915 if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
1918 GNUNET_CONTAINER_multipeermap_get (direct_neighbors, peer);
1919 if (NULL == neighbor)
1924 GNUNET_break (GNUNET_YES == neighbor->connected);
1925 neighbor->connected = GNUNET_NO;
1926 if (DIRECT_NEIGHBOR_COST == neighbor->distance)
1929 GNUNET_STATISTICS_update (stats,
1930 "# peers connected (1-hop)",
1933 cleanup_neighbor (neighbor);
1935 if (GNUNET_YES == in_shutdown)
1937 schedule_refresh_routes ();
1942 * Multipeermap iterator for freeing routes. Should never be called.
1945 * @param key key value stored under
1946 * @param value the route to be freed
1947 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1950 free_route (void *cls,
1951 const struct GNUNET_PeerIdentity *key,
1954 struct Route *route = value;
1957 GNUNET_assert (GNUNET_YES ==
1958 GNUNET_CONTAINER_multipeermap_remove (all_routes, key, value));
1959 release_route (route);
1960 send_disconnect_to_plugin (&route->target.peer);
1961 GNUNET_free (route);
1967 * Multipeermap iterator for freeing direct neighbors. Should never be called.
1970 * @param key key value stored under
1971 * @param value the direct neighbor to be freed
1972 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1975 free_direct_neighbors (void *cls,
1976 const struct GNUNET_PeerIdentity *key,
1979 struct DirectNeighbor *neighbor = value;
1981 cleanup_neighbor (neighbor);
1987 * Task run during shutdown.
1993 shutdown_task (void *cls,
1994 const struct GNUNET_SCHEDULER_TaskContext *tc)
1998 in_shutdown = GNUNET_YES;
1999 GNUNET_assert (NULL != core_api);
2000 GNUNET_CORE_disconnect (core_api);
2002 GNUNET_ATS_performance_done (ats);
2004 GNUNET_CONTAINER_multipeermap_iterate (direct_neighbors,
2005 &free_direct_neighbors, NULL);
2006 GNUNET_CONTAINER_multipeermap_iterate (all_routes,
2008 GNUNET_CONTAINER_multipeermap_destroy (direct_neighbors);
2009 GNUNET_CONTAINER_multipeermap_destroy (all_routes);
2010 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
2012 GNUNET_SERVER_notification_context_destroy (nc);
2014 for (i=0;i<DEFAULT_FISHEYE_DEPTH;i++)
2016 GNUNET_array_grow (consensi[i].targets,
2017 consensi[i].array_length,
2020 if (GNUNET_SCHEDULER_NO_TASK != rr_task)
2022 GNUNET_SCHEDULER_cancel (rr_task);
2023 rr_task = GNUNET_SCHEDULER_NO_TASK;
2029 * Notify newly connected client about an existing route.
2031 * @param cls the `struct GNUNET_SERVER_Client *`
2032 * @param key peer identity
2033 * @param value the `struct Route *`
2034 * @return #GNUNET_OK (continue to iterate)
2037 add_route (void *cls,
2038 const struct GNUNET_PeerIdentity *key,
2041 struct GNUNET_SERVER_Client *client = cls;
2042 struct Route *route = value;
2043 struct GNUNET_DV_ConnectMessage cm;
2045 memset (&cm, 0, sizeof (cm));
2046 cm.header.size = htons (sizeof (cm));
2047 cm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_CONNECT);
2048 cm.distance = htonl (route->target.distance);
2049 cm.peer = route->target.peer;
2051 GNUNET_SERVER_notification_context_unicast (nc,
2060 * Handle START-message. This is the first message sent to us
2061 * by the client (can only be one!).
2063 * @param cls closure (always NULL)
2064 * @param client identification of the client
2065 * @param message the actual message
2068 handle_start (void *cls, struct GNUNET_SERVER_Client *client,
2069 const struct GNUNET_MessageHeader *message)
2071 GNUNET_SERVER_notification_context_add (nc, client);
2072 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2073 GNUNET_CONTAINER_multipeermap_iterate (all_routes,
2080 * Called on core init.
2083 * @param identity this peer's identity
2086 core_init (void *cls,
2087 const struct GNUNET_PeerIdentity *identity)
2089 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2091 GNUNET_i2s (identity));
2092 my_identity = *identity;
2097 * Process dv requests.
2099 * @param cls closure
2100 * @param server the initialized server
2101 * @param c configuration to use
2104 run (void *cls, struct GNUNET_SERVER_Handle *server,
2105 const struct GNUNET_CONFIGURATION_Handle *c)
2107 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
2108 {&handle_dv_route_message, GNUNET_MESSAGE_TYPE_DV_ROUTE, 0},
2111 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
2112 {&handle_start, NULL,
2113 GNUNET_MESSAGE_TYPE_DV_START,
2114 sizeof (struct GNUNET_MessageHeader) },
2115 { &handle_dv_send_message, NULL,
2116 GNUNET_MESSAGE_TYPE_DV_SEND,
2120 in_shutdown = GNUNET_NO;
2122 direct_neighbors = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
2123 all_routes = GNUNET_CONTAINER_multipeermap_create (65536, GNUNET_NO);
2124 core_api = GNUNET_CORE_connect (cfg, NULL,
2126 &handle_core_connect,
2127 &handle_core_disconnect,
2132 if (NULL == core_api)
2134 ats = GNUNET_ATS_performance_init (cfg, &handle_ats_update, NULL);
2137 GNUNET_CORE_disconnect (core_api);
2141 nc = GNUNET_SERVER_notification_context_create (server,
2142 MAX_QUEUE_SIZE_PLUGIN);
2143 stats = GNUNET_STATISTICS_create ("dv", cfg);
2144 GNUNET_SERVER_add_handlers (server, plugin_handlers);
2145 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
2146 &shutdown_task, NULL);
2151 * The main function for the dv service.
2153 * @param argc number of arguments from the command line
2154 * @param argv command line arguments
2155 * @return 0 ok, 1 on error
2158 main (int argc, char *const *argv)
2160 return (GNUNET_OK ==
2161 GNUNET_SERVICE_run (argc, argv, "dv", GNUNET_SERVICE_OPTION_NONE,
2162 &run, NULL)) ? 0 : 1;
2165 /* end of gnunet-service-dv.c */