2 This file is part of GNUnet.
3 Copyright (C) 2009-2016 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @file dht/gnunet-service-wdht_neighbours.c
22 * @brief GNUnet DHT service's finger and friend table management code
23 * @author Supriti Singh
24 * @author Christian Grothoff
25 * @author Arthur Dewarumez
28 * - initiate finding of successors
31 #include "gnunet_util_lib.h"
32 #include "gnunet_block_lib.h"
33 #include "gnunet_hello_lib.h"
34 #include "gnunet_constants.h"
35 #include "gnunet_protocols.h"
36 #include "gnunet_ats_service.h"
37 #include "gnunet_core_service.h"
38 #include "gnunet_datacache_lib.h"
39 #include "gnunet_transport_service.h"
40 #include "gnunet_dht_service.h"
41 #include "gnunet_statistics_service.h"
42 #include "gnunet-service-wdht.h"
43 #include "gnunet-service-wdht_clients.h"
44 #include "gnunet-service-wdht_datacache.h"
45 #include "gnunet-service-wdht_neighbours.h"
46 #include "gnunet-service-wdht_nse.h"
50 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
53 * Trail timeout. After what time do trails always die?
55 #define TRAIL_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 42)
58 * Random walk delay. How often do we walk the overlay?
60 #define RANDOM_WALK_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 42)
63 * The number of layered ID to use.
65 #define NUMBER_LAYERED_ID 8
68 * The number of random walk to launch at the beginning of the initialization
70 /* FIXME: find a better value */
71 #define NUMBER_RANDOM_WALK 20
74 /******************* The db structure and related functions *******************/
77 * Entry in #friends_peermap.
87 * Information we keep per trail.
93 * Identifier of the trail with the predecessor.
95 struct GNUNET_HashCode pred_id;
98 * Identifier of the trail with the successor.
100 struct GNUNET_HashCode succ_id;
103 * When does this trail expire.
105 struct GNUNET_TIME_Absolute expiration_time;
108 * MDLL entry in the list of all trails with the same predecessor.
110 struct Trail *prev_succ;
113 * MDLL entry in the list of all trails with the same predecessor.
115 struct Trail *next_succ;
118 * MDLL entry in the list of all trails with the same predecessor.
120 struct Trail *prev_pred;
123 * MDLL entry in the list of all trails with the same predecessor.
125 struct Trail *next_pred;
128 * Our predecessor in the trail, NULL if we are initiator (?).
130 struct FriendInfo *pred;
133 * Our successor in the trail, NULL if we are the last peer.
135 struct FriendInfo *succ;
138 * Location of this trail in the heap.
140 struct GNUNET_CONTAINER_HeapNode *hn;
143 * If this peer started the to create a Finger (and thus @e pred is
144 * NULL), this is the finger table of the finger we are trying to
147 struct FingerTable *ft;
150 * If this peer started the trail to create a Finger (and thus @e
151 * pred is NULL), this is the offset of the finger we are trying to
152 * intialize in the unsorted array.
154 unsigned int finger_off;
160 * Entry in #friends_peermap.
167 const struct GNUNET_PeerIdentity *id;
172 struct Trail *pred_head;
177 struct Trail *pred_tail;
182 struct Trail *succ_head;
187 struct Trail *succ_tail;
190 * Core handle for sending messages to this friend.
192 struct GNUNET_MQ_Handle *mq;
210 struct FingerTable *ft;
215 struct GNUNET_HashCode destination;
218 * #GNUNET_YES if a response has been received. Otherwise #GNUNET_NO.
227 * Array of our fingers, unsorted.
229 struct Finger **fingers;
232 * Size of the finger array.
234 unsigned int finger_array_size;
237 * Number of valid entries in @e fingers
239 unsigned int number_valid_fingers;
242 * Which offset in @e fingers will we redo next.
244 unsigned int walk_offset;
247 * Is the finger array sorted?
254 /*********************** end of the db structure part ***********************/
257 GNUNET_NETWORK_STRUCT_BEGIN
260 * Setup a finger using the underlay topology ("social network").
262 struct RandomWalkMessage
265 * Type: #GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK
267 struct GNUNET_MessageHeader header;
270 * Number of hops this message has taken so far, we stop at
273 uint16_t hops_taken GNUNET_PACKED;
276 * Layer for the request, in NBO.
278 uint16_t layer GNUNET_PACKED;
281 * Unique (random) identifier this peer will use to
282 * identify the trail (in future messages).
284 struct GNUNET_HashCode trail_id;
289 * Response to a `struct RandomWalkMessage`.
291 struct RandomWalkResponseMessage
294 * Type: #GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK_RESPONSE
296 struct GNUNET_MessageHeader header;
299 * Zero, for alignment.
301 uint32_t reserved GNUNET_PACKED;
304 * Unique (random) identifier from the
305 * `struct RandomWalkMessage`.
307 struct GNUNET_HashCode trail_id;
310 * Random location in the respective layer where the
311 * random path of the finger setup terminated.
313 struct GNUNET_HashCode location;
318 * Response to an event that causes a trail to die.
320 struct TrailDestroyMessage
323 * Type: #GNUNET_MESSAGE_TYPE_WDHT_TRAIL_DESTROY
325 struct GNUNET_MessageHeader header;
328 * Zero, for alignment.
330 uint32_t reserved GNUNET_PACKED;
333 * Unique (random) identifier this peer will use to
334 * identify the finger (in future messages).
336 struct GNUNET_HashCode trail_id;
342 * Send a message along a trail.
344 struct FindSuccessorMessage
347 * Type: #GNUNET_MESSAGE_TYPE_WDHT_SUCCESSOR_FIND
349 struct GNUNET_MessageHeader header;
352 * Zero, for alignment.
354 uint32_t reserved GNUNET_PACKED;
357 * Key for which we would like close values returned.
358 * identify the finger (in future messages).
360 struct GNUNET_HashCode key;
366 * Send a message along a trail.
368 struct TrailRouteMessage
371 * Type: #GNUNET_MESSAGE_TYPE_WDHT_TRAIL_ROUTE
373 struct GNUNET_MessageHeader header;
376 * #GNUNET_YES if the path should be recorded, #GNUNET_NO if not; in NBO.
378 uint16_t record_path GNUNET_PACKED;
381 * Length of the recorded trail, 0 if @e record_path is #GNUNET_NO; in NBO.
383 uint16_t path_length GNUNET_PACKED;
386 * Unique (random) identifier this peer will use to
387 * identify the finger (in future messages).
389 struct GNUNET_HashCode trail_id;
392 * Path the message has taken so far (excluding sender).
394 /* struct GNUNET_PeerIdentity path[path_length]; */
396 /* followed by payload (another `struct GNUNET_MessageHeader`) to
397 send along the trail */
404 struct PeerPutMessage
407 * Type: #GNUNET_MESSAGE_TYPE_WDHT_PUT
409 struct GNUNET_MessageHeader header;
414 uint32_t options GNUNET_PACKED;
419 uint32_t block_type GNUNET_PACKED;
424 uint32_t hop_count GNUNET_PACKED;
427 * Replication level for this message
428 * In the current implementation, this value is not used.
430 uint32_t desired_replication_level GNUNET_PACKED;
433 * Length of the PUT path that follows (if tracked).
435 uint32_t put_path_length GNUNET_PACKED;
438 * When does the content expire?
440 struct GNUNET_TIME_AbsoluteNBO expiration_time;
443 * The key to store the value under.
445 struct GNUNET_HashCode key GNUNET_PACKED;
447 /* put path (if tracked) */
456 struct PeerGetMessage
459 * Type: #GNUNET_MESSAGE_TYPE_WDHT_GET
461 struct GNUNET_MessageHeader header;
466 uint32_t options GNUNET_PACKED;
469 * Desired content type.
471 uint32_t block_type GNUNET_PACKED;
476 uint32_t hop_count GNUNET_PACKED;
479 * Desired replication level for this request.
480 * In the current implementation, this value is not used.
482 uint32_t desired_replication_level GNUNET_PACKED;
485 * Total number of peers in get path.
487 unsigned int get_path_length;
490 * The key we are looking for.
492 struct GNUNET_HashCode key;
495 /* struct GNUNET_PeerIdentity[]*/
502 struct PeerGetResultMessage
505 * Type: #GNUNET_MESSAGE_TYPE_WDHT_GET_RESULT
507 struct GNUNET_MessageHeader header;
510 * The type for the data in NBO.
512 uint32_t type GNUNET_PACKED;
515 * Number of peers recorded in the outgoing path from source to the
516 * stored location of this message.
518 uint32_t put_path_length GNUNET_PACKED;
521 * When does the content expire?
523 struct GNUNET_TIME_AbsoluteNBO expiration_time;
526 * The key of the corresponding GET request.
528 struct GNUNET_HashCode key;
530 /* put path (if tracked) */
536 GNUNET_NETWORK_STRUCT_END
540 * Contains all the layered IDs of this peer.
542 struct GNUNET_PeerIdentity layered_id[NUMBER_LAYERED_ID];
545 * Task to timeout trails that have expired.
547 static struct GNUNET_SCHEDULER_Task *trail_timeout_task;
550 * Task to perform random walks.
552 static struct GNUNET_SCHEDULER_Task *random_walk_task;
555 * Identity of this peer.
557 static struct GNUNET_PeerIdentity my_identity;
560 * Peer map of all the friends of a peer
562 static struct GNUNET_CONTAINER_MultiPeerMap *friends_peermap;
567 static struct FingerTable fingers[NUMBER_LAYERED_ID];
570 * Tail map, mapping tail identifiers to `struct Trail`s
572 static struct GNUNET_CONTAINER_MultiHashMap *trail_map;
575 * Tail heap, organizing trails by expiration time.
577 static struct GNUNET_CONTAINER_Heap *trail_heap;
582 static struct GNUNET_CORE_Handle *core_api;
586 * Handle the put request from the client.
588 * @param key Key for the content
589 * @param block_type Type of the block
590 * @param options Routing options
591 * @param desired_replication_level Desired replication count
592 * @param expiration_time When does the content expire
593 * @param data Content to store
594 * @param data_size Size of content @a data in bytes
597 GDS_NEIGHBOURS_handle_put (const struct GNUNET_HashCode *key,
598 enum GNUNET_BLOCK_Type block_type,
599 enum GNUNET_DHT_RouteOption options,
600 uint32_t desired_replication_level,
601 struct GNUNET_TIME_Absolute expiration_time,
605 GDS_DATACACHE_handle_put (expiration_time,
612 GDS_CLIENTS_process_put (options,
624 * Handle the get request from the client file. If I am destination do
625 * datacache put and return. Else find the target friend and forward message
628 * @param key Key for the content
629 * @param block_type Type of the block
630 * @param options Routing options
631 * @param desired_replication_level Desired replication count
634 GDS_NEIGHBOURS_handle_get (const struct GNUNET_HashCode *key,
635 enum GNUNET_BLOCK_Type block_type,
636 enum GNUNET_DHT_RouteOption options,
637 uint32_t desired_replication_level)
639 // find closest finger(s) on all layers
640 // use TrailRoute with PeerGetMessage embedded to contact peer
641 // NOTE: actually more complicated, see paper!
646 * Delete a trail, it died (timeout, link failure, etc.).
648 * @param trail trail to delete from all data structures
649 * @param inform_pred should we notify the predecessor?
650 * @param inform_succ should we inform the successor?
653 delete_trail (struct Trail *trail,
657 struct FriendInfo *friend;
658 struct GNUNET_MQ_Envelope *env;
659 struct TrailDestroyMessage *tdm;
660 struct Finger *finger;
662 friend = trail->pred;
665 if (GNUNET_YES == inform_pred)
667 env = GNUNET_MQ_msg (tdm,
668 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_DESTROY);
669 tdm->trail_id = trail->pred_id;
670 GNUNET_MQ_send (friend->mq,
673 GNUNET_CONTAINER_MDLL_remove (pred,
678 friend = trail->succ;
681 if (GNUNET_YES == inform_succ)
683 env = GNUNET_MQ_msg (tdm,
684 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_DESTROY);
685 tdm->trail_id = trail->pred_id;
686 GNUNET_MQ_send (friend->mq,
689 GNUNET_CONTAINER_MDLL_remove (succ,
694 GNUNET_break (trail ==
695 GNUNET_CONTAINER_heap_remove_node (trail->hn));
696 finger = trail->ft->fingers[trail->finger_off];
699 trail->ft->fingers[trail->finger_off] = NULL;
700 trail->ft->number_valid_fingers--;
701 GNUNET_free (finger);
708 * Forward the given payload message along the trail.
710 * @param next_target which direction along the trail should we forward
711 * @param trail_id which trail should we forward along
712 * @param have_path do we track the forwarding path?
713 * @param predecessor which peer do we tack on to the path?
714 * @param path path the message has taken so far along the trail
715 * @param path_length number of entries in @a path
716 * @param payload payload of the message
719 forward_message_on_trail (struct FriendInfo *next_target,
720 const struct GNUNET_HashCode *trail_id,
722 const struct GNUNET_PeerIdentity *predecessor,
723 const struct GNUNET_PeerIdentity *path,
724 uint16_t path_length,
725 const struct GNUNET_MessageHeader *payload)
727 struct GNUNET_MQ_Envelope *env;
728 struct TrailRouteMessage *trm;
729 struct GNUNET_PeerIdentity *new_path;
731 uint16_t payload_len;
733 payload_len = ntohs (payload->size);
736 plen = path_length + 1;
737 if (plen >= (GNUNET_SERVER_MAX_MESSAGE_SIZE
739 - sizeof (struct TrailRouteMessage))
740 / sizeof (struct GNUNET_PeerIdentity))
742 /* Should really not have paths this long... */
750 GNUNET_break_op (0 == path_length);
754 env = GNUNET_MQ_msg_extra (trm,
756 plen * sizeof (struct GNUNET_PeerIdentity),
757 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_ROUTE);
758 trm->record_path = htons (have_path);
759 trm->path_length = htons (plen);
760 trm->trail_id = *trail_id;
761 new_path = (struct GNUNET_PeerIdentity *) &trm[1];
764 GNUNET_memcpy (new_path,
766 path_length * sizeof (struct GNUNET_PeerIdentity));
767 new_path[path_length] = *predecessor;
769 GNUNET_memcpy (&new_path[plen],
772 GNUNET_MQ_send (next_target->mq,
778 * Send the get result to requesting client.
780 * @param trail_id trail identifying where to send the result to, NULL for us
781 * @param options routing options (from GET request)
782 * @param key Key of the requested data.
783 * @param type Block type
784 * @param put_path_length Number of peers in @a put_path
785 * @param put_path Path taken to put the data at its stored location.
786 * @param expiration When will this result expire?
787 * @param data Payload to store
788 * @param data_size Size of the @a data
791 GDS_NEIGHBOURS_send_get_result (const struct GNUNET_HashCode *trail_id,
792 enum GNUNET_DHT_RouteOption options,
793 const struct GNUNET_HashCode *key,
794 enum GNUNET_BLOCK_Type type,
795 unsigned int put_path_length,
796 const struct GNUNET_PeerIdentity *put_path,
797 struct GNUNET_TIME_Absolute expiration,
801 struct GNUNET_MessageHeader *payload;
804 trail = GNUNET_CONTAINER_multihashmap_get (trail_map,
808 /* TODO: inform statistics */
811 if (NULL == trail->pred)
813 /* result is for *us* (local client) */
814 GDS_CLIENTS_handle_reply (expiration,
817 put_path_length, put_path,
824 payload = GNUNET_malloc(sizeof(struct GNUNET_MessageHeader) + data_size);
825 payload->size = data_size;
826 payload->type = GNUNET_MESSAGE_TYPE_WDHT_GET_RESULT;
828 forward_message_on_trail (trail->pred,
830 0 != (options & GNUNET_DHT_RO_RECORD_ROUTE),
834 GNUNET_free (payload);
839 * Method called whenever a peer disconnects.
842 * @param peer peer identity this notification is about
843 * @param internal_cls our `struct FriendInfo` for @a peer
846 handle_core_disconnect (void *cls,
847 const struct GNUNET_PeerIdentity *peer,
850 struct FriendInfo *remove_friend = internal_cls;
853 /* If disconnected to own identity, then return. */
854 if (NULL == remove_friend)
856 GNUNET_assert (GNUNET_YES ==
857 GNUNET_CONTAINER_multipeermap_remove (friends_peermap,
860 while (NULL != (t = remove_friend->succ_head))
864 while (NULL != (t = remove_friend->pred_head))
868 GNUNET_free (remove_friend);
869 if (0 == GNUNET_CONTAINER_multipeermap_size (friends_peermap))
871 GNUNET_SCHEDULER_cancel (random_walk_task);
872 random_walk_task = NULL;
878 * Function called with a random friend to be returned.
880 * @param cls a `struct FriendInfo **` with where to store the result
881 * @param peer the peer identity of the friend (ignored)
882 * @param value the `struct FriendInfo *` that was selected at random
883 * @return #GNUNET_OK (all good)
886 pick_random_helper (void *cls,
887 const struct GNUNET_PeerIdentity *peer,
890 struct FriendInfo **fi = cls;
891 struct FriendInfo *v = value;
899 * Pick random friend from friends for random walk.
901 * @return NULL if we have no friends
903 static struct FriendInfo *
904 pick_random_friend ()
906 struct FriendInfo *ret;
910 GNUNET_CONTAINER_multipeermap_get_random (friends_peermap,
919 * One of our trails might have timed out, check and
920 * possibly initiate cleanup.
925 trail_timeout_callback (void *cls)
928 struct GNUNET_TIME_Relative left;
930 trail_timeout_task = NULL;
931 while (NULL != (trail = GNUNET_CONTAINER_heap_peek (trail_heap)))
933 left = GNUNET_TIME_absolute_get_remaining (trail->expiration_time);
934 if (0 != left.rel_value_us)
941 trail_timeout_task = GNUNET_SCHEDULER_add_delayed (left,
942 &trail_timeout_callback,
948 * Compute how big our finger arrays should be (at least).
950 * @return size of the finger array, never 0
953 get_desired_finger_array_size ()
955 /* FIXME: This is just a stub... */
961 * Initiate a random walk.
966 do_random_walk (void *cls)
968 static unsigned int walk_layer;
969 struct FriendInfo *friend;
970 struct GNUNET_MQ_Envelope *env;
971 struct RandomWalkMessage *rwm;
972 struct FingerTable *ft;
973 struct Finger *finger;
977 random_walk_task = NULL;
978 friend = pick_random_friend ();
980 trail = GNUNET_new (struct Trail);
981 /* We create the random walk so, no predecessor */
982 trail->succ = friend;
983 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_NONCE,
986 GNUNET_CONTAINER_multihashmap_put (trail_map,
989 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
995 GNUNET_CONTAINER_MDLL_insert (succ,
999 trail->expiration_time = GNUNET_TIME_relative_to_absolute (TRAIL_TIMEOUT);
1000 trail->hn = GNUNET_CONTAINER_heap_insert (trail_heap,
1002 trail->expiration_time.abs_value_us);
1003 if (NULL == trail_timeout_task)
1004 trail_timeout_task = GNUNET_SCHEDULER_add_delayed (TRAIL_TIMEOUT,
1005 &trail_timeout_callback,
1007 env = GNUNET_MQ_msg (rwm,
1008 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK);
1009 rwm->hops_taken = htonl (0);
1010 rwm->trail_id = trail->succ_id;
1011 GNUNET_MQ_send (friend->mq,
1013 /* clean up 'old' entry (implicitly via trail cleanup) */
1014 ft = &fingers[walk_layer];
1016 if ( (NULL != ft->fingers) &&
1017 (NULL != (finger = ft->fingers[ft->walk_offset])) )
1018 delete_trail (finger->trail,
1021 if (ft->finger_array_size < (nsize = get_desired_finger_array_size()) )
1022 GNUNET_array_grow (ft->fingers,
1023 ft->finger_array_size,
1025 GNUNET_assert (NULL == ft->fingers[ft->walk_offset]);
1027 trail->finger_off = ft->walk_offset;
1028 finger = GNUNET_new (struct Finger);
1029 finger->trail = trail;
1031 ft->fingers[ft->walk_offset] = finger;
1032 ft->is_sorted = GNUNET_NO;
1033 ft->number_valid_fingers++;
1034 ft->walk_offset = (ft->walk_offset + 1) % ft->finger_array_size;
1036 walk_layer = (walk_layer + 1) % NUMBER_LAYERED_ID;
1037 random_walk_task = GNUNET_SCHEDULER_add_delayed (RANDOM_WALK_DELAY,
1044 * Method called whenever a peer connects.
1046 * @param cls closure
1047 * @param peer_identity peer identity this notification is about
1048 * @param mq message queue for transmission to @a peer_identity
1049 * @return the `struct FriendInfo` for the @a peer_identity, NULL for us
1052 handle_core_connect (void *cls,
1053 const struct GNUNET_PeerIdentity *peer_identity,
1054 struct GNUNET_MQ_Handle *mq)
1056 struct FriendInfo *friend;
1058 /* Check for connect to self message */
1059 if (0 == memcmp (&my_identity,
1061 sizeof (struct GNUNET_PeerIdentity)))
1064 friend = GNUNET_new (struct FriendInfo);
1065 friend->id = peer_identity;
1067 GNUNET_assert (GNUNET_OK ==
1068 GNUNET_CONTAINER_multipeermap_put (friends_peermap,
1071 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1072 if (NULL == random_walk_task)
1074 /* random walk needs to be started -- we have a first connection */
1075 random_walk_task = GNUNET_SCHEDULER_add_now (&do_random_walk,
1083 * To be called on core init/fail.
1085 * @param cls service closure
1086 * @param identity the public identity of this peer
1089 core_init (void *cls,
1090 const struct GNUNET_PeerIdentity *identity)
1092 my_identity = *identity;
1097 * Handle a `struct RandomWalkMessage` from a
1098 * #GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK message.
1100 * @param cls the `struct FriendInfo` for the sender
1101 * @param m the setup message
1104 handle_dht_p2p_random_walk (void *cls,
1105 const struct RandomWalkMessage *m)
1107 struct FriendInfo *pred = cls;
1111 layer = ntohs (m->layer);
1112 if (layer > NUMBER_LAYERED_ID)
1114 GNUNET_break_op (0);
1117 t = GNUNET_new (struct Trail);
1118 t->pred_id = m->trail_id;
1121 GNUNET_CONTAINER_multihashmap_put (trail_map,
1124 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1126 GNUNET_break_op (0);
1130 GNUNET_CONTAINER_MDLL_insert (pred,
1134 t->expiration_time = GNUNET_TIME_relative_to_absolute (TRAIL_TIMEOUT);
1135 t->hn = GNUNET_CONTAINER_heap_insert (trail_heap,
1137 t->expiration_time.abs_value_us);
1138 if (NULL == trail_timeout_task)
1139 trail_timeout_task = GNUNET_SCHEDULER_add_delayed (TRAIL_TIMEOUT,
1140 &trail_timeout_callback,
1143 if (ntohl (m->hops_taken) > GDS_NSE_get ())
1145 /* We are the last hop, generate response */
1146 struct GNUNET_MQ_Envelope *env;
1147 struct RandomWalkResponseMessage *rwrm;
1149 env = GNUNET_MQ_msg (rwrm,
1150 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK_RESPONSE);
1151 rwrm->reserved = htonl (0);
1152 rwrm->trail_id = m->trail_id;
1154 (void) GDS_DATACACHE_get_random_key (&rwrm->location);
1157 struct FingerTable *ft;
1159 ft = &fingers[layer-1];
1160 if (0 == ft->number_valid_fingers)
1162 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_NONCE,
1171 off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE,
1172 ft->number_valid_fingers);
1173 for (i=0; (NULL == (f = ft->fingers[i])) || (off > 0); i++)
1174 if (NULL != f) off--;
1175 rwrm->location = f->destination;
1178 GNUNET_MQ_send (pred->mq,
1183 struct GNUNET_MQ_Envelope *env;
1184 struct RandomWalkMessage *rwm;
1185 struct FriendInfo *succ;
1187 /* extend the trail by another random hop */
1188 succ = pick_random_friend ();
1189 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_NONCE,
1193 GNUNET_CONTAINER_multihashmap_put (trail_map,
1196 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1199 GNUNET_CONTAINER_MDLL_remove (pred,
1206 GNUNET_CONTAINER_MDLL_insert (succ,
1210 env = GNUNET_MQ_msg (rwm,
1211 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK);
1212 rwm->hops_taken = htons (1 + ntohs (m->hops_taken));
1213 rwm->layer = m->layer;
1214 rwm->trail_id = t->succ_id;
1215 GNUNET_MQ_send (succ->mq,
1222 * Handle a `struct RandomWalkResponseMessage`.
1224 * @param cls closure
1225 * @param rwrm the setup response message
1228 handle_dht_p2p_random_walk_response (void *cls,
1229 const struct RandomWalkResponseMessage *rwrm)
1231 struct Trail *trail;
1232 struct FriendInfo *pred;
1233 struct FingerTable *ft;
1234 struct Finger *finger;
1236 trail = GNUNET_CONTAINER_multihashmap_get (trail_map,
1240 /* TODO: log/statistics: we didn't find the trail (can happen) */
1243 if (NULL != (pred = trail->pred))
1245 /* We are not the first hop, keep forwarding */
1246 struct GNUNET_MQ_Envelope *env;
1247 struct RandomWalkResponseMessage *rwrm2;
1249 env = GNUNET_MQ_msg (rwrm2,
1250 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK_RESPONSE);
1251 rwrm2->reserved = htonl (0);
1252 rwrm2->location = rwrm->location;
1253 rwrm2->trail_id = trail->pred_id;
1254 GNUNET_MQ_send (pred->mq,
1258 /* We are the first hop, complete finger */
1259 if (NULL == (ft = trail->ft))
1261 /* Eh, why did we create the trail if we have no FT? */
1263 delete_trail (trail,
1268 if (NULL == (finger = ft->fingers[trail->finger_off]))
1270 /* Eh, finger got deleted, but why not the trail as well? */
1272 delete_trail (trail,
1279 // 1) lookup trail => find Finger entry => fill in 'destination' and mark valid, move to end of sorted array,
1280 //mark unsorted, update links from 'trails'
1283 * 1 check if we are the correct layer
1284 * 1.a if true : add the returned value (finger) in the db structure
1285 * 1.b if true : do nothing
1287 /* FIXME: add the value in db structure 1.a */
1293 * Handle a `struct TrailDestroyMessage`.
1295 * @param cls closure
1296 * @param tdm the trail destroy message
1299 handle_dht_p2p_trail_destroy (void *cls,
1300 const struct TrailDestroyMessage *tdm)
1302 struct FriendInfo *sender = cls;
1303 struct Trail *trail;
1305 trail = GNUNET_CONTAINER_multihashmap_get (trail_map,
1307 delete_trail (trail,
1308 ( (NULL != trail->succ) &&
1309 (0 == memcmp (sender->id,
1311 sizeof (struct GNUNET_PeerIdentity))) ),
1312 ( (NULL != trail->pred) &&
1313 (0 == memcmp (sender->id,
1315 sizeof (struct GNUNET_PeerIdentity))) ));
1320 * Handle a `struct FindSuccessorMessage` from a #GNUNET_MESSAGE_TYPE_WDHT_SUCCESSOR_FIND
1323 * @param cls closure (NULL)
1324 * @param trail_id path to the originator
1325 * @param trail_path path the message took on the trail, if available
1326 * @param trail_path_length number of entries on the @a trail_path
1327 * @param message the finger setup message
1328 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1331 handle_dht_p2p_successor_find (void *cls,
1332 const struct GNUNET_HashCode *trail_id,
1333 const struct GNUNET_PeerIdentity *trail_path,
1334 unsigned int trail_path_length,
1335 const struct GNUNET_MessageHeader *message)
1337 const struct FindSuccessorMessage *fsm;
1339 /* We do not expect to track trails for the forward-direction
1340 of successor finding... */
1341 GNUNET_break_op (0 == trail_path_length);
1342 fsm = (const struct FindSuccessorMessage *) message;
1343 GDS_DATACACHE_get_successors (trail_id,
1350 * Handle a `struct PeerGetMessage`.
1352 * @param cls closure (NULL)
1353 * @param trail_id path to the originator
1354 * @param trail_path path the message took on the trail, if available
1355 * @param trail_path_length number of entries on the @a trail_path
1356 * @param message the peer get message
1357 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1360 handle_dht_p2p_peer_get (void *cls,
1361 const struct GNUNET_HashCode *trail_id,
1362 const struct GNUNET_PeerIdentity *trail_path,
1363 unsigned int trail_path_length,
1364 const struct GNUNET_MessageHeader *message)
1367 const struct PeerGetMessage *pgm;
1369 // FIXME: note: never called like this, message embedded with trail route!
1370 pgm = (const struct PeerGetMessage *) message;
1372 // -> lookup in datacache (figure out way to remember trail!)
1375 * 1 extract the result
1377 * 3 send it using the good trail
1379 * What do i do when i don't have the key/value?
1387 * Handle a `struct PeerGetResultMessage`.
1389 * @param cls closure (NULL)
1390 * @param trail_id path to the originator
1391 * @param trail_path path the message took on the trail, if available
1392 * @param trail_path_length number of entries on the @a trail_path
1393 * @param message the peer get result message
1394 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1397 handle_dht_p2p_peer_get_result (void *cls,
1398 const struct GNUNET_HashCode *trail_id,
1399 const struct GNUNET_PeerIdentity *trail_path,
1400 unsigned int trail_path_length,
1401 const struct GNUNET_MessageHeader *message)
1404 const struct PeerGetResultMessage *pgrm;
1406 pgrm = (const struct PeerGetResultMessage *) message;
1408 // pretty much: parse, & pass to client (there is some call for that...)
1411 GDS_CLIENTS_process_get (options,
1416 (void) GDS_DATACACHE_handle_get (trail_id,
1429 * Handle a `struct PeerPutMessage`.
1431 * @param cls closure (NULL)
1432 * @param trail_id path to the originator
1433 * @param trail_path path the message took on the trail, if available
1434 * @param trail_path_length number of entries on the @a trail_path
1435 * @param message the peer put message
1436 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1439 handle_dht_p2p_peer_put (void *cls,
1440 const struct GNUNET_HashCode *trail_id,
1441 const struct GNUNET_PeerIdentity *trail_path,
1442 unsigned int trail_path_length,
1443 const struct GNUNET_MessageHeader *message)
1446 const struct PeerGetResultMessage *pgrm;
1448 pgrm = (const struct PeerGetResultMessage *) message;
1450 // parse & store in datacache, this is in response to us asking for successors.
1453 * 1 check the size of the message
1454 * 2 use the API to add the value in the "database". Check on the xdht file, how to do it.
1455 * 3 Did i a have to return a notification or did i have to return GNUNET_[OK|SYSERR]?
1458 GDS_DATACACHE_handle_put (expiration_time,
1460 combined_path_length, combined_path,
1464 GDS_CLIENTS_process_put (options,
1467 combined_path_length, combined_path,
1478 * Handler for a message we received along some trail.
1480 * @param cls closure
1481 * @param trail_id trail identifier
1482 * @param trail_path path the message took on the trail, if available
1483 * @param trail_path_length number of entries on the @a trail_path
1484 * @param message the message we got
1485 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1488 (*TrailHandlerCallback)(void *cls,
1489 const struct GNUNET_HashCode *trail_id,
1490 const struct GNUNET_PeerIdentity *trail_path,
1491 unsigned int trail_path_length,
1492 const struct GNUNET_MessageHeader *message);
1496 * Definition of a handler for a message received along some trail.
1501 * NULL for end-of-list.
1503 TrailHandlerCallback callback;
1506 * Closure for @e callback.
1511 * Message type this handler addresses.
1513 uint16_t message_type;
1516 * Use 0 for variable-size.
1518 uint16_t message_size;
1523 * Check that a `struct TrailRouteMessage` is well-formed.
1525 * @param cls closure
1526 * @param trm the finger destroy message
1527 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1530 check_dht_p2p_trail_route (void *cls,
1531 const struct TrailRouteMessage *trm)
1533 const struct GNUNET_PeerIdentity *path;
1534 uint16_t path_length;
1535 const struct GNUNET_MessageHeader *payload;
1538 msize = ntohs (trm->header.size);
1539 path_length = ntohs (trm->path_length);
1540 if (msize < sizeof (struct TrailRouteMessage) +
1541 path_length * sizeof (struct GNUNET_PeerIdentity) +
1542 sizeof (struct GNUNET_MessageHeader) )
1544 GNUNET_break_op (0);
1545 return GNUNET_SYSERR;
1547 path = (const struct GNUNET_PeerIdentity *) &trm[1];
1548 payload = (const struct GNUNET_MessageHeader *) &path[path_length];
1549 if (msize != (ntohs (payload->size) +
1550 sizeof (struct TrailRouteMessage) +
1551 path_length * sizeof (struct GNUNET_PeerIdentity)))
1553 GNUNET_break_op (0);
1554 return GNUNET_SYSERR;
1556 /* FIXME: verify payload is OK!? */
1562 * Handle a `struct TrailRouteMessage`.
1564 * @param cls closure
1565 * @param trm the finger destroy message
1568 handle_dht_p2p_trail_route (void *cls,
1569 const struct TrailRouteMessage *trm)
1571 static const struct TrailHandler handlers[] = {
1572 { &handle_dht_p2p_successor_find, NULL,
1573 GNUNET_MESSAGE_TYPE_WDHT_SUCCESSOR_FIND,
1574 sizeof (struct FindSuccessorMessage) },
1575 { &handle_dht_p2p_peer_get, NULL,
1576 GNUNET_MESSAGE_TYPE_WDHT_GET,
1578 { &handle_dht_p2p_peer_get_result, NULL,
1579 GNUNET_MESSAGE_TYPE_WDHT_GET_RESULT,
1581 { &handle_dht_p2p_peer_put, NULL,
1582 GNUNET_MESSAGE_TYPE_WDHT_PUT,
1584 { NULL, NULL, 0, 0 }
1586 struct FriendInfo *sender = cls;
1588 const struct GNUNET_PeerIdentity *path;
1589 uint16_t path_length;
1590 const struct GNUNET_MessageHeader *payload;
1591 const struct TrailHandler *th;
1592 struct Trail *trail;
1594 path_length = ntohs (trm->path_length);
1595 path = (const struct GNUNET_PeerIdentity *) &trm[1];
1596 payload = (const struct GNUNET_MessageHeader *) &path[path_length];
1597 /* Is this message for us? */
1598 trail = GNUNET_CONTAINER_multihashmap_get (trail_map,
1600 if ( (NULL != trail->pred) &&
1601 (0 == memcmp (sender->id,
1603 sizeof (struct GNUNET_PeerIdentity))) )
1605 /* forward to 'successor' */
1606 if (NULL != trail->succ)
1608 forward_message_on_trail (trail->succ,
1610 ntohs (trm->record_path),
1620 /* forward to 'predecessor' */
1621 GNUNET_break_op ( (NULL != trail->succ) &&
1622 (0 == memcmp (sender->id,
1624 sizeof (struct GNUNET_PeerIdentity))) );
1625 if (NULL != trail->pred)
1627 forward_message_on_trail (trail->pred,
1629 ntohs (trm->record_path),
1638 /* Message is for us, dispatch to handler */
1640 for (i=0; NULL != handlers[i].callback; i++)
1643 if (ntohs (payload->type) == th->message_type)
1645 if ( (0 == th->message_size) ||
1646 (ntohs (payload->size) == th->message_size) )
1647 th->callback (th->cls,
1653 GNUNET_break_op (0);
1657 GNUNET_break_op (NULL != th);
1662 * Initialize neighbours subsystem.
1664 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1667 GDS_NEIGHBOURS_init (void)
1669 GNUNET_MQ_hd_fixed_size (dht_p2p_random_walk,
1670 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK,
1671 struct RandomWalkMessage);
1672 GNUNET_MQ_hd_fixed_size (dht_p2p_random_walk_response,
1673 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK_RESPONSE,
1674 struct RandomWalkResponseMessage);
1675 GNUNET_MQ_hd_fixed_size (dht_p2p_trail_destroy,
1676 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_DESTROY,
1677 struct TrailDestroyMessage);
1678 GNUNET_MQ_hd_var_size (dht_p2p_trail_route,
1679 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_ROUTE,
1680 struct TrailRouteMessage);
1681 struct GNUNET_MQ_MessageHandler core_handlers[] = {
1682 make_dht_p2p_random_walk_handler (NULL),
1683 make_dht_p2p_random_walk_response_handler (NULL),
1684 make_dht_p2p_trail_destroy_handler (NULL),
1685 make_dht_p2p_trail_route_handler (NULL),
1686 GNUNET_MQ_handler_end ()
1689 core_api = GNUNET_CORE_connecT (GDS_cfg, NULL,
1691 &handle_core_connect,
1692 &handle_core_disconnect,
1694 if (NULL == core_api)
1695 return GNUNET_SYSERR;
1696 friends_peermap = GNUNET_CONTAINER_multipeermap_create (256,
1698 trail_map = GNUNET_CONTAINER_multihashmap_create (1024,
1700 trail_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1706 * Shutdown neighbours subsystem.
1709 GDS_NEIGHBOURS_done (void)
1711 if (NULL == core_api)
1713 GNUNET_CORE_disconnecT (core_api);
1715 GNUNET_assert (0 == GNUNET_CONTAINER_multipeermap_size (friends_peermap));
1716 GNUNET_CONTAINER_multipeermap_destroy (friends_peermap);
1717 friends_peermap = NULL;
1718 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (trail_map));
1719 GNUNET_CONTAINER_multihashmap_destroy (trail_map);
1721 GNUNET_CONTAINER_heap_destroy (trail_heap);
1723 if (NULL != trail_timeout_task)
1725 GNUNET_SCHEDULER_cancel (trail_timeout_task);
1726 trail_timeout_task = NULL;
1734 * @return my identity
1736 struct GNUNET_PeerIdentity
1737 GDS_NEIGHBOURS_get_my_id (void)
1742 /* end of gnunet-service-wdht_neighbours.c */