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 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
517 send_distance_change_to_plugin (const struct GNUNET_PeerIdentity *peer,
520 struct GNUNET_DV_DistanceUpdateMessage du_msg;
522 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
523 "Delivering DISTANCE_CHANGED for message about peer `%s'\n",
525 du_msg.header.size = htons (sizeof (du_msg));
526 du_msg.header.type = htons (GNUNET_MESSAGE_TYPE_DV_DISTANCE_CHANGED);
527 du_msg.distance = htonl (distance);
529 send_control_to_plugin (&du_msg.header);
534 * Give a CONNECT message to the plugin.
536 * @param target peer that connected
537 * @param distance distance to the target
538 * @param network the network the next hop is located in
541 send_connect_to_plugin (const struct GNUNET_PeerIdentity *target,
542 uint32_t distance, uint32_t network)
544 struct GNUNET_DV_ConnectMessage cm;
546 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
547 "Delivering CONNECT about peer `%s' with distance %u\n",
548 GNUNET_i2s (target), distance);
549 cm.header.size = htons (sizeof (cm));
550 cm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_CONNECT);
551 cm.distance = htonl (distance);
552 cm.network = htonl (network);
554 send_control_to_plugin (&cm.header);
559 * Give a DISCONNECT message to the plugin.
561 * @param target peer that disconnected
564 send_disconnect_to_plugin (const struct GNUNET_PeerIdentity *target)
566 struct GNUNET_DV_DisconnectMessage dm;
568 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
569 "Delivering DISCONNECT about peer `%s'\n",
570 GNUNET_i2s (target));
571 dm.header.size = htons (sizeof (dm));
572 dm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_DISCONNECT);
573 dm.reserved = htonl (0);
575 send_control_to_plugin (&dm.header);
580 * Function called to transfer a message to another peer
583 * @param cls closure with the direct neighbor
584 * @param size number of bytes available in buf
585 * @param buf where the callee should write the message
586 * @return number of bytes written to buf
589 core_transmit_notify (void *cls, size_t size, void *buf)
591 struct DirectNeighbor *dn = cls;
593 struct PendingMessage *pending;
600 /* peer disconnected */
604 while ( (NULL != (pending = dn->pm_head)) &&
605 (size >= off + (msize = ntohs (pending->msg->size))))
608 GNUNET_CONTAINER_DLL_remove (dn->pm_head,
611 memcpy (&cbuf[off], pending->msg, msize);
612 if (0 != pending->uid)
613 send_ack_to_plugin (&pending->ultimate_target,
616 GNUNET_free (pending);
619 GNUNET_assert (NULL != core_api);
620 if (NULL != dn->pm_head)
622 GNUNET_CORE_notify_transmit_ready (core_api,
623 GNUNET_YES /* cork */,
625 GNUNET_TIME_UNIT_FOREVER_REL,
628 &core_transmit_notify, dn);
634 * Forward the given payload to the given target.
636 * @param target where to send the message
637 * @param uid unique ID for the message
638 * @param ultimate_target ultimate recipient for the message
639 * @param distance expected (remaining) distance to the target
640 * @param sender original sender of the message
641 * @param payload payload of the message
644 forward_payload (struct DirectNeighbor *target,
647 const struct GNUNET_PeerIdentity *sender,
648 const struct GNUNET_PeerIdentity *ultimate_target,
649 const struct GNUNET_MessageHeader *payload)
651 struct PendingMessage *pm;
652 struct RouteMessage *rm;
655 if ( (target->pm_queue_size >= MAX_QUEUE_SIZE) &&
656 (0 != memcmp (sender,
658 sizeof (struct GNUNET_PeerIdentity))) )
660 GNUNET_break (0 == uid);
663 msize = sizeof (struct RouteMessage) + ntohs (payload->size);
664 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
669 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
670 pm->ultimate_target = *ultimate_target;
672 pm->msg = (const struct GNUNET_MessageHeader *) &pm[1];
673 rm = (struct RouteMessage *) &pm[1];
674 rm->header.size = htons ((uint16_t) msize);
675 rm->header.type = htons (GNUNET_MESSAGE_TYPE_DV_ROUTE);
676 rm->distance = htonl (distance);
677 rm->target = target->peer;
678 rm->sender = *sender;
679 memcpy (&rm[1], payload, ntohs (payload->size));
680 GNUNET_CONTAINER_DLL_insert_tail (target->pm_head,
683 target->pm_queue_size++;
684 GNUNET_assert (NULL != core_api);
685 if (NULL == target->cth)
686 target->cth = GNUNET_CORE_notify_transmit_ready (core_api,
687 GNUNET_YES /* cork */,
689 GNUNET_TIME_UNIT_FOREVER_REL,
692 &core_transmit_notify, target);
697 * Find a free slot for storing a 'route' in the 'consensi'
698 * set at the given distance.
700 * @param distance distance to use for the set slot
703 get_consensus_slot (uint32_t distance)
705 struct ConsensusSet *cs;
708 GNUNET_assert (distance < DEFAULT_FISHEYE_DEPTH);
709 cs = &consensi[distance];
711 while ( (i < cs->array_length) &&
712 (NULL != cs->targets[i]) ) i++;
713 if (i == cs->array_length)
715 GNUNET_array_grow (cs->targets,
717 cs->array_length * 2 + 2);
724 * Allocate a slot in the consensus set for a route.
726 * @param route route to initialize
727 * @param distance which consensus set to use
730 allocate_route (struct Route *route,
735 if (distance >= DEFAULT_FISHEYE_DEPTH)
737 route->set_offset = UINT_MAX; /* invalid slot */
740 i = get_consensus_slot (distance);
741 route->set_offset = i;
742 consensi[distance].targets[i] = route;
743 route->target.distance = htonl (distance);
748 * Release a slot in the consensus set for a route.
750 * @param route route to release the slot from
753 release_route (struct Route *route)
755 if (UINT_MAX == route->set_offset)
757 GNUNET_assert (ntohl (route->target.distance) < DEFAULT_FISHEYE_DEPTH);
758 consensi[ntohl (route->target.distance)].targets[route->set_offset] = NULL;
759 route->set_offset = UINT_MAX; /* indicate invalid slot */
764 * Move a route from one consensus set to another.
766 * @param route route to move
767 * @param new_distance new distance for the route (destination set)
770 move_route (struct Route *route,
771 uint32_t new_distance)
775 release_route (route);
776 if (new_distance >= DEFAULT_FISHEYE_DEPTH)
777 return; /* no longer interesting for 'consensi' */
778 i = get_consensus_slot (new_distance);
779 route->set_offset = i;
780 consensi[new_distance].targets[i] = route;
781 route->target.distance = htonl (new_distance);
786 * Initialize this neighbors 'my_set' and when done give
787 * it to the pending set operation for execution.
789 * Add a single element to the set per call:
791 * If we reached the last element of a consensus element: increase distance
794 * @param cls the neighbor for which we are building the set
797 build_set (void *cls)
799 struct DirectNeighbor *neighbor = cls;
800 struct GNUNET_SET_Element element;
801 struct Target *target;
804 while ( (DEFAULT_FISHEYE_DEPTH > neighbor->consensus_insertion_distance) &&
805 (consensi[neighbor->consensus_insertion_distance].array_length == neighbor->consensus_insertion_offset) )
807 /* If we reached the last element of a consensus array element: increase distance and start with next array */
808 neighbor->consensus_insertion_offset = 0;
809 neighbor->consensus_insertion_distance++;
810 /* skip over NULL entries */
811 while ( (DEFAULT_FISHEYE_DEPTH > neighbor->consensus_insertion_distance) &&
812 (consensi[neighbor->consensus_insertion_distance].array_length > neighbor->consensus_insertion_offset) &&
813 (NULL == consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset]) )
814 neighbor->consensus_insertion_offset++;
816 if (DEFAULT_FISHEYE_DEPTH == neighbor->consensus_insertion_distance)
818 /* we have added all elements to the set, run the operation */
819 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
820 "Finished building my SET for peer `%s' with %u elements, committing\n",
821 GNUNET_i2s (&neighbor->peer),
822 neighbor->consensus_elements);
823 GNUNET_SET_commit (neighbor->set_op,
825 GNUNET_SET_destroy (neighbor->my_set);
826 neighbor->my_set = NULL;
830 target = &consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset]->target;
831 element.size = sizeof (struct Target);
832 element.type = htons (0); /* do we need this? */
833 element.data = target;
835 /* Find next non-NULL entry */
836 neighbor->consensus_insertion_offset++;
837 /* skip over NULL entries */
838 while ( (DEFAULT_FISHEYE_DEPTH > neighbor->consensus_insertion_distance) &&
839 (consensi[neighbor->consensus_insertion_distance].array_length > neighbor->consensus_insertion_offset) &&
840 (NULL == consensi[neighbor->consensus_insertion_distance].targets[neighbor->consensus_insertion_offset]) )
842 neighbor->consensus_insertion_offset++;
845 if ( (0 != memcmp(&target->peer, &my_identity, sizeof (my_identity))) &&
846 (0 != memcmp(&target->peer, &neighbor->peer, sizeof (neighbor->peer))) )
848 /* Add target if it is not the neighbor or this peer */
849 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
850 "Adding peer `%s' with distance %u to SET\n",
851 GNUNET_i2s (&target->peer),
852 ntohl (target->distance));
853 GNUNET_SET_add_element (neighbor->my_set,
855 &build_set, neighbor);
856 neighbor->consensus_elements++;
864 * A peer is now connected to us at distance 1. Initiate DV exchange.
866 * @param neighbor entry for the neighbor at distance 1
869 handle_direct_connect (struct DirectNeighbor *neighbor)
872 struct GNUNET_HashCode h1;
873 struct GNUNET_HashCode h2;
874 struct GNUNET_HashCode session_id;
876 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
877 "Direct connection to %s established, routing table exchange begins.\n",
878 GNUNET_i2s (&neighbor->peer));
879 GNUNET_STATISTICS_update (stats,
880 "# peers connected (1-hop)",
882 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
886 GNUNET_assert (GNUNET_YES ==
887 GNUNET_CONTAINER_multipeermap_remove (all_routes,
890 send_disconnect_to_plugin (&neighbor->peer);
891 release_route (route);
895 neighbor->direct_route = GNUNET_new (struct Route);
896 neighbor->direct_route->next_hop = neighbor;
897 neighbor->direct_route->target.peer= neighbor->peer;
898 allocate_route (neighbor->direct_route, DIRECT_NEIGHBOR_COST);
900 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
901 "Adding direct route to %s\n",
902 GNUNET_i2s (&neighbor->direct_route->target.peer));
905 /* construct session ID seed as XOR of both peer's identities */
906 GNUNET_CRYPTO_hash (&my_identity, sizeof (my_identity), &h1);
907 GNUNET_CRYPTO_hash (&neighbor->peer, sizeof (struct GNUNET_PeerIdentity), &h2);
908 GNUNET_CRYPTO_hash_xor (&h1,
911 /* make sure session ID is unique across applications by salting it with 'DV' */
912 GNUNET_CRYPTO_hkdf (&neighbor->real_session_id, sizeof (struct GNUNET_HashCode),
913 GCRY_MD_SHA512, GCRY_MD_SHA256,
915 &session_id, sizeof (session_id),
917 if (0 < memcmp (&neighbor->peer,
919 sizeof (struct GNUNET_PeerIdentity)))
921 if (NULL != neighbor->listen_handle)
926 neighbor->initiate_task = GNUNET_SCHEDULER_add_now (&initiate_set_union,
931 if (NULL != neighbor->listen_handle)
937 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
938 "Starting SET listen operation with peer `%s'\n",
939 GNUNET_i2s(&neighbor->peer));
940 neighbor->listen_handle = GNUNET_SET_listen (cfg,
941 GNUNET_SET_OPERATION_UNION,
942 &neighbor->real_session_id,
951 * Method called whenever a peer connects.
954 * @param peer peer identity this notification is about
957 handle_core_connect (void *cls,
958 const struct GNUNET_PeerIdentity *peer)
960 struct DirectNeighbor *neighbor;
962 /* Check for connect to self message */
963 if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
965 /* check if entry exists */
966 neighbor = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
968 if (NULL != neighbor)
970 GNUNET_break (GNUNET_YES != neighbor->connected);
971 neighbor->connected = GNUNET_YES;
972 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
973 "Core connected to %s (distance %u)\n",
975 (unsigned int) neighbor->distance);
976 if (DIRECT_NEIGHBOR_COST != neighbor->distance)
978 handle_direct_connect (neighbor);
981 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
982 "Core connected to %s (distance unknown)\n",
984 neighbor = GNUNET_new (struct DirectNeighbor);
985 neighbor->peer = *peer;
986 GNUNET_assert (GNUNET_YES ==
987 GNUNET_CONTAINER_multipeermap_put (direct_neighbors,
990 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
991 neighbor->connected = GNUNET_YES;
992 neighbor->distance = 0; /* unknown */
993 neighbor->network = GNUNET_ATS_NET_UNSPECIFIED;
998 * Called for each 'target' in a neighbor table to free the associated memory.
1001 * @param key key of the value
1002 * @param value value to free
1003 * @return #GNUNET_OK to continue to iterate
1006 free_targets (void *cls,
1007 const struct GNUNET_PeerIdentity *key,
1010 GNUNET_free (value);
1016 * Multipeerhmap iterator for checking if a given route is
1017 * (now) useful to this peer.
1019 * @param cls the direct neighbor for the given route
1020 * @param key key value stored under
1021 * @param value a 'struct Target' that may or may not be useful; not that
1022 * the distance in 'target' does not include the first hop yet
1023 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1026 check_possible_route (void *cls,
1027 const struct GNUNET_PeerIdentity *key,
1030 struct DirectNeighbor *neighbor = cls;
1031 struct Target *target = value;
1032 struct Route *route;
1034 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1038 if (ntohl (route->target.distance) > ntohl (target->distance) + 1)
1040 /* this 'target' is cheaper than the existing route; switch to alternative route! */
1041 move_route (route, ntohl (target->distance) + 1);
1042 route->next_hop = neighbor;
1043 send_distance_change_to_plugin (&target->peer, ntohl (target->distance) + 1);
1045 return GNUNET_YES; /* got a route to this target already */
1047 if (ntohl (target->distance) >= DEFAULT_FISHEYE_DEPTH)
1048 return GNUNET_YES; /* distance is too large to be interesting */
1049 route = GNUNET_new (struct Route);
1050 route->next_hop = neighbor;
1051 route->target.peer = target->peer;
1052 allocate_route (route, ntohl (target->distance) + 1);
1053 GNUNET_assert (GNUNET_YES ==
1054 GNUNET_CONTAINER_multipeermap_put (all_routes,
1055 &route->target.peer,
1057 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1058 send_connect_to_plugin (&route->target.peer, ntohl (target->distance),
1065 * Multipeermap iterator for finding routes that were previously
1066 * "hidden" due to a better route (called after a disconnect event).
1069 * @param key peer identity of the given direct neighbor
1070 * @param value a `struct DirectNeighbor` to check for additional routes
1071 * @return #GNUNET_YES to continue iteration
1074 refresh_routes (void *cls,
1075 const struct GNUNET_PeerIdentity *key,
1078 struct DirectNeighbor *neighbor = value;
1080 if ( (GNUNET_YES != neighbor->connected) ||
1081 (DIRECT_NEIGHBOR_COST != neighbor->distance) )
1083 if (NULL != neighbor->neighbor_table)
1084 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1085 &check_possible_route,
1092 * Task to run #refresh_routes() on all direct neighbours.
1098 refresh_routes_task (void *cls,
1099 const struct GNUNET_SCHEDULER_TaskContext *tc)
1101 rr_task = GNUNET_SCHEDULER_NO_TASK;
1102 GNUNET_CONTAINER_multipeermap_iterate (direct_neighbors,
1109 * Asynchronously run #refresh_routes() at the next opportunity
1110 * on all direct neighbours.
1113 schedule_refresh_routes ()
1115 if (GNUNET_SCHEDULER_NO_TASK == rr_task)
1116 rr_task = GNUNET_SCHEDULER_add_now (&refresh_routes_task,
1122 * Get distance information from 'atsi'.
1124 * @param atsi performance data
1125 * @param atsi_count number of entries in atsi
1126 * @return connected transport distance
1129 get_atsi_distance (const struct GNUNET_ATS_Information *atsi,
1130 uint32_t atsi_count)
1134 for (i = 0; i < atsi_count; i++)
1135 if (ntohl (atsi[i].type) == GNUNET_ATS_QUALITY_NET_DISTANCE)
1136 return (0 == ntohl (atsi[i].value)) ? DIRECT_NEIGHBOR_COST : ntohl (atsi[i].value); // FIXME: 0 check should not be required once ATS is fixed!
1137 /* If we do not have explicit distance data, assume direct neighbor. */
1138 return DIRECT_NEIGHBOR_COST;
1143 * Get network information from 'atsi'.
1145 * @param atsi performance data
1146 * @param atsi_count number of entries in atsi
1147 * @return connected transport network
1150 get_atsi_network (const struct GNUNET_ATS_Information *atsi,
1151 uint32_t atsi_count)
1155 for (i = 0; i < atsi_count; i++)
1156 if (ntohl (atsi[i].type) == GNUNET_ATS_NETWORK_TYPE)
1157 return ntohl (atsi[i].value);
1158 return GNUNET_ATS_NET_UNSPECIFIED;
1162 * Multipeermap iterator for freeing routes that go via a particular
1163 * neighbor that disconnected and is thus no longer available.
1165 * @param cls the direct neighbor that is now unavailable
1166 * @param key key value stored under
1167 * @param value a `struct Route` that may or may not go via neighbor
1169 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1172 cull_routes (void *cls,
1173 const struct GNUNET_PeerIdentity *key,
1176 struct DirectNeighbor *neighbor = cls;
1177 struct Route *route = value;
1179 if (route->next_hop != neighbor)
1180 return GNUNET_YES; /* not affected */
1181 GNUNET_assert (GNUNET_YES ==
1182 GNUNET_CONTAINER_multipeermap_remove (all_routes, key, value));
1183 release_route (route);
1184 send_disconnect_to_plugin (&route->target.peer);
1185 GNUNET_free (route);
1191 * Handle the case that a direct connection to a peer is
1192 * disrupted. Remove all routes via that peer and
1193 * stop the consensus with it.
1195 * @param neighbor peer that was disconnected (or at least is no
1196 * longer at distance 1)
1199 handle_direct_disconnect (struct DirectNeighbor *neighbor)
1201 GNUNET_CONTAINER_multipeermap_iterate (all_routes,
1204 if (NULL != neighbor->cth)
1206 GNUNET_CORE_notify_transmit_ready_cancel (neighbor->cth);
1207 neighbor->cth = NULL;
1210 if (NULL != neighbor->direct_route)
1212 release_route (neighbor->direct_route);
1213 GNUNET_free (neighbor->direct_route);
1214 neighbor->direct_route = NULL;
1217 if (NULL != neighbor->neighbor_table_consensus)
1219 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table_consensus,
1222 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table_consensus);
1223 neighbor->neighbor_table_consensus = NULL;
1225 if (NULL != neighbor->neighbor_table)
1227 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1230 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table);
1231 neighbor->neighbor_table = NULL;
1233 if (NULL != neighbor->set_op)
1235 GNUNET_SET_operation_cancel (neighbor->set_op);
1236 neighbor->set_op = NULL;
1238 if (NULL != neighbor->my_set)
1240 GNUNET_SET_destroy (neighbor->my_set);
1241 neighbor->my_set = NULL;
1243 if (NULL != neighbor->listen_handle)
1245 GNUNET_SET_listen_cancel (neighbor->listen_handle);
1246 neighbor->listen_handle = NULL;
1248 if (GNUNET_SCHEDULER_NO_TASK != neighbor->initiate_task)
1250 GNUNET_SCHEDULER_cancel (neighbor->initiate_task);
1251 neighbor->initiate_task = GNUNET_SCHEDULER_NO_TASK;
1257 * Function that is called with QoS information about an address; used
1258 * to update our current distance to another peer.
1260 * @param cls closure
1261 * @param address the address
1262 * @param active is this address in active use
1263 * @param bandwidth_out assigned outbound bandwidth for the connection
1264 * @param bandwidth_in assigned inbound bandwidth for the connection
1265 * @param ats performance data for the address (as far as known)
1266 * @param ats_count number of performance records in @a ats
1269 handle_ats_update (void *cls,
1270 const struct GNUNET_HELLO_Address *address,
1272 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
1273 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1274 const struct GNUNET_ATS_Information *ats,
1277 struct DirectNeighbor *neighbor;
1279 uint32_t network = GNUNET_ATS_NET_UNSPECIFIED;
1281 if (GNUNET_NO == active)
1283 distance = get_atsi_distance (ats, ats_count);
1284 network = get_atsi_network (ats, ats_count);
1287 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1288 "ATS says distance to %s is %u\n",
1289 GNUNET_i2s (&address->peer),
1290 (unsigned int) distance);*/
1291 /* check if entry exists */
1292 neighbor = GNUNET_CONTAINER_multipeermap_get (direct_neighbors,
1294 if (NULL != neighbor)
1296 if (GNUNET_ATS_NET_UNSPECIFIED != network)
1297 neighbor->network = network;
1299 if ( (DIRECT_NEIGHBOR_COST == neighbor->distance) &&
1300 (DIRECT_NEIGHBOR_COST == distance) )
1301 return; /* no change */
1302 if (DIRECT_NEIGHBOR_COST == neighbor->distance)
1304 neighbor->distance = distance;
1305 GNUNET_STATISTICS_update (stats,
1306 "# peers connected (1-hop)",
1308 handle_direct_disconnect (neighbor);
1309 schedule_refresh_routes ();
1312 neighbor->distance = distance;
1313 if (DIRECT_NEIGHBOR_COST != neighbor->distance)
1315 if (GNUNET_YES != neighbor->connected)
1317 handle_direct_connect (neighbor);
1320 neighbor = GNUNET_new (struct DirectNeighbor);
1321 neighbor->peer = address->peer;
1322 GNUNET_assert (GNUNET_YES ==
1323 GNUNET_CONTAINER_multipeermap_put (direct_neighbors,
1326 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1327 neighbor->connected = GNUNET_NO; /* not yet */
1328 neighbor->distance = distance;
1329 neighbor->network = network;
1334 * Check if a target was removed from the set of the other peer; if so,
1335 * if we also used it for our route, we need to remove it from our
1336 * 'all_routes' set (and later check if an alternative path now exists).
1338 * @param cls the `struct DirectNeighbor`
1339 * @param key peer identity for the target
1340 * @param value a `struct Target` previously reachable via the given neighbor
1343 check_target_removed (void *cls,
1344 const struct GNUNET_PeerIdentity *key,
1347 struct DirectNeighbor *neighbor = cls;
1348 struct Target *new_target;
1349 struct Route *current_route;
1351 new_target = GNUNET_CONTAINER_multipeermap_get (neighbor->neighbor_table_consensus,
1353 if (NULL == new_target)
1355 /* target was revoked, check if it was used */
1356 current_route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1358 if ( (NULL == current_route) ||
1359 (current_route->next_hop != neighbor) )
1361 /* didn't matter, wasn't used */
1364 /* remove existing route */
1365 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1366 "Lost route to %s\n",
1367 GNUNET_i2s (¤t_route->target.peer));
1368 GNUNET_assert (GNUNET_YES ==
1369 GNUNET_CONTAINER_multipeermap_remove (all_routes, key, current_route));
1370 send_disconnect_to_plugin (¤t_route->target.peer);
1371 GNUNET_free (current_route);
1372 neighbor->target_removed = GNUNET_YES;
1380 * Check if a target was added to the set of the other peer; if it
1381 * was added or impoves the existing route, do the needed updates.
1383 * @param cls the `struct DirectNeighbor`
1384 * @param key peer identity for the target
1385 * @param value a `struct Target` now reachable via the given neighbor
1388 check_target_added (void *cls,
1389 const struct GNUNET_PeerIdentity *key,
1392 struct DirectNeighbor *neighbor = cls;
1393 struct Target *target = value;
1394 struct Route *current_route;
1396 /* target was revoked, check if it was used */
1397 current_route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1399 if (NULL != current_route)
1402 if (current_route->next_hop == neighbor)
1404 /* we had the same route before, no change in target */
1405 if (ntohl (target->distance) + 1 != ntohl (current_route->target.distance))
1407 /* but distance changed! */
1408 if (ntohl (target->distance) + 1 > DEFAULT_FISHEYE_DEPTH)
1410 /* distance increased beyond what is allowed, kill route */
1411 GNUNET_assert (GNUNET_YES ==
1412 GNUNET_CONTAINER_multipeermap_remove (all_routes,
1415 send_disconnect_to_plugin (key);
1416 release_route (current_route);
1417 GNUNET_free (current_route);
1421 /* distance decreased, update route */
1422 move_route (current_route,
1423 ntohl (target->distance) + 1);
1424 send_distance_change_to_plugin (&target->peer, ntohl (target->distance) + 1);
1429 if (ntohl (current_route->target.distance) >= ntohl (target->distance) + 1)
1431 /* alternative, shorter route exists, ignore */
1434 /* new route is better than the existing one, take over! */
1435 /* NOTE: minor security issue: malicious peers may advertise
1436 very short routes to take over longer paths; as we don't
1437 check that the shorter routes actually work, a malicious
1438 direct neighbor can use this to DoS our long routes */
1440 move_route (current_route, ntohl (target->distance) + 1);
1441 current_route->next_hop = neighbor;
1442 send_distance_change_to_plugin (&target->peer, ntohl (target->distance) + 1);
1446 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1447 "Discovered new route to %s using %u hops\n",
1448 GNUNET_i2s (&target->peer),
1449 (unsigned int) (ntohl (target->distance) + 1));
1450 current_route = GNUNET_new (struct Route);
1451 current_route->next_hop = neighbor;
1452 current_route->target.peer = target->peer;
1453 allocate_route (current_route, ntohl (target->distance) + 1);
1454 GNUNET_assert (GNUNET_YES ==
1455 GNUNET_CONTAINER_multipeermap_put (all_routes,
1456 ¤t_route->target.peer,
1458 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1460 send_connect_to_plugin (¤t_route->target.peer,
1461 ntohl (current_route->target.distance),
1468 * Callback for set operation results. Called for each element
1469 * in the result set.
1470 * We have learned a new route from the other peer. Add it to the
1471 * route set we're building.
1473 * @param cls the `struct DirectNeighbor` we're building the consensus with
1474 * @param element a result element, only valid if status is #GNUNET_SET_STATUS_OK
1475 * @param status see `enum GNUNET_SET_Status`
1478 handle_set_union_result (void *cls,
1479 const struct GNUNET_SET_Element *element,
1480 enum GNUNET_SET_Status status)
1482 struct DirectNeighbor *neighbor = cls;
1483 struct Target *target;
1487 case GNUNET_SET_STATUS_OK:
1488 status_str = "GNUNET_SET_STATUS_OK";
1490 case GNUNET_SET_STATUS_TIMEOUT:
1491 status_str = "GNUNET_SET_STATUS_TIMEOUT";
1493 case GNUNET_SET_STATUS_FAILURE:
1494 status_str = "GNUNET_SET_STATUS_FAILURE";
1496 case GNUNET_SET_STATUS_HALF_DONE:
1497 status_str = "GNUNET_SET_STATUS_HALF_DONE";
1499 case GNUNET_SET_STATUS_DONE:
1500 status_str = "GNUNET_SET_STATUS_DONE";
1503 status_str = "UNDEFINED";
1507 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1508 "Got SET union result: %s\n",
1512 case GNUNET_SET_STATUS_OK:
1513 if (sizeof (struct Target) != element->size)
1515 GNUNET_break_op (0);
1518 target = GNUNET_new (struct Target);
1519 memcpy (target, element->data, sizeof (struct Target));
1520 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1521 "Received information about peer `%s' with distance %u\n",
1522 GNUNET_i2s (&target->peer), ntohl(target->distance) + 1);
1523 if (NULL == neighbor->neighbor_table_consensus)
1524 neighbor->neighbor_table_consensus = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1526 GNUNET_CONTAINER_multipeermap_put (neighbor->neighbor_table_consensus,
1529 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1531 GNUNET_break_op (0);
1532 GNUNET_free (target);
1535 case GNUNET_SET_STATUS_TIMEOUT:
1536 case GNUNET_SET_STATUS_FAILURE:
1537 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1538 "Failed to establish DV union, will try again later\n");
1539 neighbor->set_op = NULL;
1540 if (NULL != neighbor->neighbor_table_consensus)
1542 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table_consensus,
1545 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table_consensus);
1546 neighbor->neighbor_table_consensus = NULL;
1548 if (0 < memcmp (&neighbor->peer,
1550 sizeof (struct GNUNET_PeerIdentity)))
1551 neighbor->initiate_task = GNUNET_SCHEDULER_add_delayed (GNUNET_DV_CONSENSUS_FREQUENCY,
1552 &initiate_set_union,
1555 case GNUNET_SET_STATUS_HALF_DONE:
1557 case GNUNET_SET_STATUS_DONE:
1558 /* we got all of our updates; integrate routing table! */
1559 neighbor->target_removed = GNUNET_NO;
1560 if (NULL == neighbor->neighbor_table_consensus)
1561 neighbor->neighbor_table_consensus = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1562 if (NULL != neighbor->neighbor_table)
1563 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1564 &check_target_removed,
1566 if (GNUNET_YES == neighbor->target_removed)
1568 /* check if we got an alternative for the removed routes */
1569 schedule_refresh_routes ();
1571 /* add targets that appeared (and check for improved routes) */
1572 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table_consensus,
1573 &check_target_added,
1575 if (NULL != neighbor->neighbor_table)
1577 GNUNET_CONTAINER_multipeermap_iterate (neighbor->neighbor_table,
1580 GNUNET_CONTAINER_multipeermap_destroy (neighbor->neighbor_table);
1581 neighbor->neighbor_table = NULL;
1583 neighbor->neighbor_table = neighbor->neighbor_table_consensus;
1584 neighbor->neighbor_table_consensus = NULL;
1586 /* operation done, schedule next run! */
1587 neighbor->set_op = NULL;
1588 if (0 < memcmp (&neighbor->peer,
1590 sizeof (struct GNUNET_PeerIdentity)))
1591 neighbor->initiate_task = GNUNET_SCHEDULER_add_delayed (GNUNET_DV_CONSENSUS_FREQUENCY,
1592 &initiate_set_union,
1603 * Start creating a new DV set union construction, our neighbour has
1604 * asked for it (callback for listening peer).
1606 * @param cls the 'struct DirectNeighbor' of the peer we're building
1607 * a routing consensus with
1608 * @param other_peer the other peer
1609 * @param context_msg message with application specific information from
1611 * @param request request from the other peer, use GNUNET_SET_accept
1612 * to accept it, otherwise the request will be refused
1613 * Note that we don't use a return value here, as it is also
1614 * necessary to specify the set we want to do the operation with,
1615 * whith sometimes can be derived from the context message.
1616 * Also necessary to specify the timeout.
1619 listen_set_union (void *cls,
1620 const struct GNUNET_PeerIdentity *other_peer,
1621 const struct GNUNET_MessageHeader *context_msg,
1622 struct GNUNET_SET_Request *request)
1624 struct DirectNeighbor *neighbor = cls;
1626 if (NULL == request)
1627 return; /* why??? */
1628 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1629 "Starting to create consensus with %s\n",
1630 GNUNET_i2s (&neighbor->peer));
1631 if (NULL != neighbor->set_op)
1633 GNUNET_SET_operation_cancel (neighbor->set_op);
1634 neighbor->set_op = NULL;
1636 if (NULL != neighbor->my_set)
1638 GNUNET_SET_destroy (neighbor->my_set);
1639 neighbor->my_set = NULL;
1641 neighbor->my_set = GNUNET_SET_create (cfg,
1642 GNUNET_SET_OPERATION_UNION);
1643 neighbor->set_op = GNUNET_SET_accept (request,
1644 GNUNET_SET_RESULT_ADDED,
1645 &handle_set_union_result,
1647 neighbor->consensus_insertion_offset = 0;
1648 neighbor->consensus_insertion_distance = 0;
1649 neighbor->consensus_elements = 0;
1650 build_set (neighbor);
1655 * Start creating a new DV set union by initiating the connection.
1657 * @param cls the `struct DirectNeighbor *` of the peer we're building
1658 * a routing consensus with
1659 * @param tc scheduler context
1662 initiate_set_union (void *cls,
1663 const struct GNUNET_SCHEDULER_TaskContext *tc)
1665 static uint16_t salt;
1666 struct DirectNeighbor *neighbor = cls;
1668 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1669 "Initiating SET union with peer `%s'\n",
1670 GNUNET_i2s (&neighbor->peer));
1671 neighbor->initiate_task = GNUNET_SCHEDULER_NO_TASK;
1672 neighbor->my_set = GNUNET_SET_create (cfg,
1673 GNUNET_SET_OPERATION_UNION);
1674 neighbor->set_op = GNUNET_SET_prepare (&neighbor->peer,
1675 &neighbor->real_session_id,
1678 GNUNET_SET_RESULT_ADDED,
1679 &handle_set_union_result,
1681 neighbor->consensus_insertion_offset = 0;
1682 neighbor->consensus_insertion_distance = 0;
1683 neighbor->consensus_elements = 0;
1684 build_set (neighbor);
1689 * Core handler for DV data messages. Whatever this message
1690 * contains all we really have to do is rip it out of its
1691 * DV layering and give it to our pal the DV plugin to report
1694 * @param cls closure
1695 * @param peer peer which sent the message (immediate sender)
1696 * @param message the message
1697 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the other peer violated the protocol
1700 handle_dv_route_message (void *cls, const struct GNUNET_PeerIdentity *peer,
1701 const struct GNUNET_MessageHeader *message)
1703 const struct RouteMessage *rm;
1704 const struct GNUNET_MessageHeader *payload;
1705 struct Route *route;
1707 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1708 "Handling DV message\n");
1709 if (ntohs (message->size) < sizeof (struct RouteMessage) + sizeof (struct GNUNET_MessageHeader))
1711 GNUNET_break_op (0);
1712 return GNUNET_SYSERR;
1714 rm = (const struct RouteMessage *) message;
1715 payload = (const struct GNUNET_MessageHeader *) &rm[1];
1716 if (ntohs (message->size) != sizeof (struct RouteMessage) + ntohs (payload->size))
1718 GNUNET_break_op (0);
1719 return GNUNET_SYSERR;
1721 if (0 == memcmp (&rm->target,
1723 sizeof (struct GNUNET_PeerIdentity)))
1725 /* message is for me, check reverse route! */
1726 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1730 /* don't have reverse route, drop */
1731 GNUNET_STATISTICS_update (stats,
1732 "# message discarded (no reverse route)",
1736 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1737 "Delivering %u bytes to myself!\n",
1738 ntohs (payload->size));
1739 send_data_to_plugin (payload,
1741 ntohl (route->target.distance));
1744 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1748 GNUNET_STATISTICS_update (stats,
1749 "# messages discarded (no route)",
1753 if (ntohl (route->target.distance) > ntohl (rm->distance) + 1)
1755 GNUNET_STATISTICS_update (stats,
1756 "# messages discarded (target too far)",
1760 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1761 "Forwarding message to %s\n",
1762 GNUNET_i2s (&rm->target));
1763 forward_payload (route->next_hop,
1764 ntohl (route->target.distance),
1774 * Service server's handler for message send requests (which come
1775 * bubbling up to us through the DV plugin).
1777 * @param cls closure
1778 * @param client identification of the client
1779 * @param message the actual message
1782 handle_dv_send_message (void *cls, struct GNUNET_SERVER_Client *client,
1783 const struct GNUNET_MessageHeader *message)
1785 struct Route *route;
1786 const struct GNUNET_DV_SendMessage *msg;
1787 const struct GNUNET_MessageHeader *payload;
1789 if (ntohs (message->size) < sizeof (struct GNUNET_DV_SendMessage) + sizeof (struct GNUNET_MessageHeader))
1792 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1795 msg = (const struct GNUNET_DV_SendMessage *) message;
1796 GNUNET_break (0 != ntohl (msg->uid));
1797 payload = (const struct GNUNET_MessageHeader *) &msg[1];
1798 if (ntohs (message->size) != sizeof (struct GNUNET_DV_SendMessage) + ntohs (payload->size))
1801 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1804 route = GNUNET_CONTAINER_multipeermap_get (all_routes,
1808 /* got disconnected */
1809 GNUNET_STATISTICS_update (stats,
1810 "# local messages discarded (no route)",
1812 send_ack_to_plugin (&msg->target, ntohl (msg->uid), GNUNET_YES);
1813 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1816 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1817 "Forwarding %u bytes to %s\n",
1818 ntohs (payload->size),
1819 GNUNET_i2s (&msg->target));
1821 forward_payload (route->next_hop,
1822 ntohl (route->target.distance),
1827 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1832 * Cleanup all of the data structures associated with a given neighbor.
1834 * @param neighbor neighbor to clean up
1837 cleanup_neighbor (struct DirectNeighbor *neighbor)
1839 struct PendingMessage *pending;
1841 while (NULL != (pending = neighbor->pm_head))
1843 neighbor->pm_queue_size--;
1844 GNUNET_CONTAINER_DLL_remove (neighbor->pm_head,
1847 GNUNET_free (pending);
1849 handle_direct_disconnect (neighbor);
1850 GNUNET_assert (GNUNET_YES ==
1851 GNUNET_CONTAINER_multipeermap_remove (direct_neighbors,
1854 GNUNET_free (neighbor);
1859 * Method called whenever a given peer disconnects.
1861 * @param cls closure
1862 * @param peer peer identity this notification is about
1865 handle_core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
1867 struct DirectNeighbor *neighbor;
1869 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1870 "Received core peer disconnect message for peer `%s'!\n",
1872 /* Check for disconnect from self message */
1873 if (0 == memcmp (&my_identity, peer, sizeof (struct GNUNET_PeerIdentity)))
1876 GNUNET_CONTAINER_multipeermap_get (direct_neighbors, peer);
1877 if (NULL == neighbor)
1882 GNUNET_break (GNUNET_YES == neighbor->connected);
1883 neighbor->connected = GNUNET_NO;
1884 if (DIRECT_NEIGHBOR_COST == neighbor->distance)
1887 GNUNET_STATISTICS_update (stats,
1888 "# peers connected (1-hop)",
1891 cleanup_neighbor (neighbor);
1893 if (GNUNET_YES == in_shutdown)
1895 schedule_refresh_routes ();
1900 * Multipeermap iterator for freeing routes. Should never be called.
1903 * @param key key value stored under
1904 * @param value the route to be freed
1905 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1908 free_route (void *cls,
1909 const struct GNUNET_PeerIdentity *key,
1912 struct Route *route = value;
1915 GNUNET_assert (GNUNET_YES ==
1916 GNUNET_CONTAINER_multipeermap_remove (all_routes, key, value));
1917 release_route (route);
1918 send_disconnect_to_plugin (&route->target.peer);
1919 GNUNET_free (route);
1925 * Multipeermap iterator for freeing direct neighbors. Should never be called.
1928 * @param key key value stored under
1929 * @param value the direct neighbor to be freed
1930 * @return #GNUNET_YES to continue iteration, #GNUNET_NO to stop
1933 free_direct_neighbors (void *cls,
1934 const struct GNUNET_PeerIdentity *key,
1937 struct DirectNeighbor *neighbor = value;
1938 cleanup_neighbor (neighbor);
1944 * Task run during shutdown.
1950 shutdown_task (void *cls,
1951 const struct GNUNET_SCHEDULER_TaskContext *tc)
1955 in_shutdown = GNUNET_YES;
1956 GNUNET_assert (NULL != core_api);
1957 GNUNET_CORE_disconnect (core_api);
1959 GNUNET_ATS_performance_done (ats);
1961 GNUNET_CONTAINER_multipeermap_iterate (direct_neighbors,
1962 &free_direct_neighbors, NULL);
1963 GNUNET_CONTAINER_multipeermap_iterate (all_routes,
1965 GNUNET_CONTAINER_multipeermap_destroy (direct_neighbors);
1966 GNUNET_CONTAINER_multipeermap_destroy (all_routes);
1967 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
1969 GNUNET_SERVER_notification_context_destroy (nc);
1971 for (i=0;i<DEFAULT_FISHEYE_DEPTH;i++)
1973 GNUNET_array_grow (consensi[i].targets,
1974 consensi[i].array_length,
1977 if (GNUNET_SCHEDULER_NO_TASK != rr_task)
1979 GNUNET_SCHEDULER_cancel (rr_task);
1980 rr_task = GNUNET_SCHEDULER_NO_TASK;
1986 * Notify newly connected client about an existing route.
1988 * @param cls the `struct GNUNET_SERVER_Client *`
1989 * @param key peer identity
1990 * @param value the `struct Route *`
1991 * @return #GNUNET_OK (continue to iterate)
1994 add_route (void *cls,
1995 const struct GNUNET_PeerIdentity *key,
1998 struct GNUNET_SERVER_Client *client = cls;
1999 struct Route *route = value;
2000 struct GNUNET_DV_ConnectMessage cm;
2002 memset (&cm, 0, sizeof (cm));
2003 cm.header.size = htons (sizeof (cm));
2004 cm.header.type = htons (GNUNET_MESSAGE_TYPE_DV_CONNECT);
2005 cm.distance = htonl (route->target.distance);
2006 cm.peer = route->target.peer;
2008 GNUNET_SERVER_notification_context_unicast (nc,
2017 * Handle START-message. This is the first message sent to us
2018 * by the client (can only be one!).
2020 * @param cls closure (always NULL)
2021 * @param client identification of the client
2022 * @param message the actual message
2025 handle_start (void *cls, struct GNUNET_SERVER_Client *client,
2026 const struct GNUNET_MessageHeader *message)
2028 GNUNET_SERVER_notification_context_add (nc, client);
2029 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2030 GNUNET_CONTAINER_multipeermap_iterate (all_routes,
2037 * Called on core init.
2040 * @param identity this peer's identity
2043 core_init (void *cls,
2044 const struct GNUNET_PeerIdentity *identity)
2046 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2048 GNUNET_i2s (identity));
2049 my_identity = *identity;
2054 * Process dv requests.
2056 * @param cls closure
2057 * @param server the initialized server
2058 * @param c configuration to use
2061 run (void *cls, struct GNUNET_SERVER_Handle *server,
2062 const struct GNUNET_CONFIGURATION_Handle *c)
2064 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
2065 {&handle_dv_route_message, GNUNET_MESSAGE_TYPE_DV_ROUTE, 0},
2068 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
2069 {&handle_start, NULL,
2070 GNUNET_MESSAGE_TYPE_DV_START,
2071 sizeof (struct GNUNET_MessageHeader) },
2072 { &handle_dv_send_message, NULL,
2073 GNUNET_MESSAGE_TYPE_DV_SEND,
2077 in_shutdown = GNUNET_NO;
2079 direct_neighbors = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
2080 all_routes = GNUNET_CONTAINER_multipeermap_create (65536, GNUNET_NO);
2081 core_api = GNUNET_CORE_connect (cfg, NULL,
2083 &handle_core_connect,
2084 &handle_core_disconnect,
2089 if (NULL == core_api)
2091 ats = GNUNET_ATS_performance_init (cfg, &handle_ats_update, NULL);
2094 GNUNET_CORE_disconnect (core_api);
2098 nc = GNUNET_SERVER_notification_context_create (server,
2099 MAX_QUEUE_SIZE_PLUGIN);
2100 stats = GNUNET_STATISTICS_create ("dv", cfg);
2101 GNUNET_SERVER_add_handlers (server, plugin_handlers);
2102 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
2103 &shutdown_task, NULL);
2108 * The main function for the dv service.
2110 * @param argc number of arguments from the command line
2111 * @param argv command line arguments
2112 * @return 0 ok, 1 on error
2115 main (int argc, char *const *argv)
2117 return (GNUNET_OK ==
2118 GNUNET_SERVICE_run (argc, argv, "dv", GNUNET_SERVICE_OPTION_NONE,
2119 &run, NULL)) ? 0 : 1;
2122 /* end of gnunet-service-dv.c */