2 This file is part of GNUnet.
3 Copyright (C) 2009-2015 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.
21 * @file dht/gnunet-service-wdht_neighbours.c
22 * @brief GNUnet DHT service's finger and friend table management code
23 * @author Supriti Singh
26 #include "gnunet_util_lib.h"
27 #include "gnunet_block_lib.h"
28 #include "gnunet_hello_lib.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_ats_service.h"
32 #include "gnunet_core_service.h"
33 #include "gnunet_datacache_lib.h"
34 #include "gnunet_transport_service.h"
35 #include "gnunet_dht_service.h"
36 #include "gnunet_statistics_service.h"
37 #include "gnunet-service-wdht.h"
38 #include "gnunet-service-wdht_clients.h"
39 #include "gnunet-service-wdht_datacache.h"
40 #include "gnunet-service-wdht_neighbours.h"
41 #include "gnunet-service-wdht_nse.h"
48 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
51 * Trail timeout. After what time do trails always die?
53 #define TRAIL_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 42)
56 * Random walk delay. How often do we walk the overlay?
58 #define RANDOM_WALK_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 42)
61 * The number of layered ID to use.
63 #define NUMBER_LAYERED_ID 8
66 * The number of random walk to launch at the beginning of the initialization
68 /* FIXME: find a better value */
69 #define NUMBER_RANDOM_WALK 20
72 /******************* The db structure and related functions *******************/
75 * Entry in #friends_peermap.
81 * Information we keep per trail.
87 * MDLL entry in the list of all trails with the same predecessor.
89 struct Trail *prev_succ;
92 * MDLL entry in the list of all trails with the same predecessor.
94 struct Trail *next_succ;
97 * MDLL entry in the list of all trails with the same predecessor.
99 struct Trail *prev_pred;
102 * MDLL entry in the list of all trails with the same predecessor.
104 struct Trail *next_pred;
107 * Our predecessor in the trail, NULL if we are initiator (?).
109 struct FriendInfo *pred;
112 * Our successor in the trail, NULL if we are the last peer.
114 struct FriendInfo *succ;
117 * Identifier of the trail with the predecessor.
119 struct GNUNET_HashCode pred_id;
122 * Identifier of the trail with the successor.
124 struct GNUNET_HashCode succ_id;
127 * When does this trail expire.
129 struct GNUNET_TIME_Absolute expiration_time;
132 * Location of this trail in the heap.
134 struct GNUNET_CONTAINER_HeapNode *hn;
137 * If this peer started the to create a Finger (and thus @e pred is
138 * NULL), this is the Finger we are trying to intialize.
140 struct Finger **finger;
146 * Entry in #friends_peermap.
153 struct GNUNET_PeerIdentity id;
158 struct Trail *pred_head;
163 struct Trail *pred_tail;
168 struct Trail *succ_head;
173 struct Trail *succ_tail;
176 * Core handle for sending messages to this friend.
178 struct GNUNET_MQ_Handle *mq;
202 struct FingerTable *ft;
207 struct GNUNET_HashCode destination;
210 * #GNUNET_YES if a response has been received. Otherwise #GNUNET_NO.
219 * Array of our fingers, unsorted.
221 struct Finger **fingers;
224 * Array of sorted fingers (sorted by destination, valid fingers first).
226 struct Finger **sorted_fingers;
229 * Size of the finger array.
231 unsigned int finger_array_size;
234 * Number of valid entries in @e sorted_fingers (contiguous from offset 0)
236 unsigned int number_valid_fingers;
239 * Which offset in @e fingers will we redo next.
241 unsigned int walk_offset;
244 * Is the finger array sorted?
251 /*********************** end of the db structure part ***********************/
254 GNUNET_NETWORK_STRUCT_BEGIN
257 * Setup a finger using the underlay topology ("social network").
259 struct RandomWalkMessage
262 * Type: #GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK
264 struct GNUNET_MessageHeader header;
267 * Number of hops this message has taken so far, we stop at
270 uint16_t hops_taken GNUNET_PACKED;
273 * Layer for the request, in NBO.
275 uint16_t layer GNUNET_PACKED;
278 * Unique (random) identifier this peer will use to
279 * identify the trail (in future messages).
281 struct GNUNET_HashCode trail_id;
286 * Response to a `struct RandomWalkMessage`.
288 struct RandomWalkResponseMessage
291 * Type: #GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK_RESPONSE
293 struct GNUNET_MessageHeader header;
296 * Zero, for alignment.
298 uint32_t reserved GNUNET_PACKED;
301 * Unique (random) identifier from the
302 * `struct RandomWalkMessage`.
304 struct GNUNET_HashCode trail_id;
307 * Random location in the respective layer where the
308 * random path of the finger setup terminated.
310 struct GNUNET_HashCode location;
315 * Response to an event that causes a trail to die.
317 struct TrailDestroyMessage
320 * Type: #GNUNET_MESSAGE_TYPE_WDHT_TRAIL_DESTROY
322 struct GNUNET_MessageHeader header;
325 * Zero, for alignment.
327 uint32_t reserved GNUNET_PACKED;
330 * Unique (random) identifier this peer will use to
331 * identify the finger (in future messages).
333 struct GNUNET_HashCode trail_id;
339 * Send a message along a trail.
341 struct FindSuccessorMessage
344 * Type: #GNUNET_MESSAGE_TYPE_WDHT_FIND_SUCCESSOR
346 struct GNUNET_MessageHeader header;
349 * Zero, for alignment.
351 uint32_t reserved GNUNET_PACKED;
354 * Unique (random) identifier this peer will use to
355 * identify the finger (in future messages).
357 struct GNUNET_HashCode trail_id;
360 * Key for which we would like close values returned.
361 * identify the finger (in future messages).
363 struct GNUNET_HashCode key;
369 * Send a message along a trail.
371 struct TrailRouteMessage
374 * Type: #GNUNET_MESSAGE_TYPE_WDHT_TRAIL_ROUTE
376 struct GNUNET_MessageHeader header;
379 * #GNUNET_YES if the path should be recorded, #GNUNET_NO if not; in NBO.
381 uint16_t record_path GNUNET_PACKED;
384 * Length of the recorded trail, 0 if @e record_path is #GNUNET_NO; in NBO.
386 uint16_t path_length GNUNET_PACKED;
389 * Unique (random) identifier this peer will use to
390 * identify the finger (in future messages).
392 struct GNUNET_HashCode trail_id;
395 * Path the message has taken so far (excluding sender).
397 /* struct GNUNET_PeerIdentity path[path_length]; */
399 /* followed by payload (another `struct GNUNET_MessageHeader`) to
400 send along the trail */
407 struct PeerPutMessage
410 * Type: #GNUNET_MESSAGE_TYPE_WDHT_PUT
412 struct GNUNET_MessageHeader header;
417 uint32_t options GNUNET_PACKED;
422 uint32_t block_type GNUNET_PACKED;
427 uint32_t hop_count GNUNET_PACKED;
430 * Replication level for this message
431 * In the current implementation, this value is not used.
433 uint32_t desired_replication_level GNUNET_PACKED;
436 * Length of the PUT path that follows (if tracked).
438 uint32_t put_path_length GNUNET_PACKED;
441 * When does the content expire?
443 struct GNUNET_TIME_AbsoluteNBO expiration_time;
446 * The key to store the value under.
448 struct GNUNET_HashCode key GNUNET_PACKED;
450 /* put path (if tracked) */
459 struct PeerGetMessage
462 * Type: #GNUNET_MESSAGE_TYPE_WDHT_GET
464 struct GNUNET_MessageHeader header;
469 uint32_t options GNUNET_PACKED;
472 * Desired content type.
474 uint32_t block_type GNUNET_PACKED;
479 uint32_t hop_count GNUNET_PACKED;
482 * Desired replication level for this request.
483 * In the current implementation, this value is not used.
485 uint32_t desired_replication_level GNUNET_PACKED;
488 * Total number of peers in get path.
490 unsigned int get_path_length;
493 * The key we are looking for.
495 struct GNUNET_HashCode key;
498 /* struct GNUNET_PeerIdentity[]*/
505 struct PeerGetResultMessage
508 * Type: #GNUNET_MESSAGE_TYPE_WDHT_GET_RESULT
510 struct GNUNET_MessageHeader header;
513 * The type for the data.
515 uint32_t type GNUNET_PACKED;
518 * Number of peers recorded in the outgoing path from source to the
519 * stored location of this message.
521 uint32_t put_path_length GNUNET_PACKED;
524 * Length of the GET path that follows (if tracked).
526 uint32_t get_path_length GNUNET_PACKED;
529 * Peer which queried for get and should get the result.
531 struct GNUNET_PeerIdentity querying_peer;
534 * When does the content expire?
536 struct GNUNET_TIME_Absolute expiration_time;
539 * The key of the corresponding GET request.
541 struct GNUNET_HashCode key;
543 /* put path (if tracked) */
545 /* get path (if tracked) */
551 GNUNET_NETWORK_STRUCT_END
555 * Contains all the layered IDs of this peer.
557 struct GNUNET_PeerIdentity layered_id[NUMBER_LAYERED_ID];
560 * Task to timeout trails that have expired.
562 static struct GNUNET_SCHEDULER_Task *trail_timeout_task;
565 * Task to perform random walks.
567 static struct GNUNET_SCHEDULER_Task *random_walk_task;
570 * Identity of this peer.
572 static struct GNUNET_PeerIdentity my_identity;
575 * Peer map of all the friends of a peer
577 static struct GNUNET_CONTAINER_MultiPeerMap *friends_peermap;
582 static struct FingerTable fingers[NUMBER_LAYERED_ID];
585 * Tail map, mapping tail identifiers to `struct Trail`s
587 static struct GNUNET_CONTAINER_MultiHashMap *trail_map;
590 * Tail heap, organizing trails by expiration time.
592 static struct GNUNET_CONTAINER_Heap *trail_heap;
597 static struct GNUNET_CORE_Handle *core_api;
601 * Handle the put request from the client.
603 * @param key Key for the content
604 * @param block_type Type of the block
605 * @param options Routing options
606 * @param desired_replication_level Desired replication count
607 * @param expiration_time When does the content expire
608 * @param data Content to store
609 * @param data_size Size of content @a data in bytes
612 GDS_NEIGHBOURS_handle_put (const struct GNUNET_HashCode *key,
613 enum GNUNET_BLOCK_Type block_type,
614 enum GNUNET_DHT_RouteOption options,
615 uint32_t desired_replication_level,
616 struct GNUNET_TIME_Absolute expiration_time,
620 GDS_DATACACHE_handle_put (expiration_time,
627 GDS_CLIENTS_process_put (options,
639 * Handle the get request from the client file. If I am destination do
640 * datacache put and return. Else find the target friend and forward message
643 * @param key Key for the content
644 * @param block_type Type of the block
645 * @param options Routing options
646 * @param desired_replication_level Desired replication count
649 GDS_NEIGHBOURS_handle_get (const struct GNUNET_HashCode *key,
650 enum GNUNET_BLOCK_Type block_type,
651 enum GNUNET_DHT_RouteOption options,
652 uint32_t desired_replication_level)
654 // find closest finger(s) on all layers
655 // use TrailRoute with PeerGetMessage embedded to contact peer
660 * Delete a trail, it died (timeout, link failure, etc.).
662 * @param trail trail to delete from all data structures
663 * @param inform_pred should we notify the predecessor?
664 * @param inform_succ should we inform the successor?
667 delete_trail (struct Trail *trail,
671 struct FriendInfo *friend;
672 struct GNUNET_MQ_Envelope *env;
673 struct TrailDestroyMessage *tdm;
674 struct Finger *finger;
676 friend = trail->pred;
679 if (GNUNET_YES == inform_pred)
681 env = GNUNET_MQ_msg (tdm,
682 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_DESTROY);
683 tdm->trail_id = trail->pred_id;
684 GNUNET_MQ_send (friend->mq,
687 GNUNET_CONTAINER_MDLL_remove (pred,
692 friend = trail->succ;
695 if (GNUNET_YES == inform_succ)
697 env = GNUNET_MQ_msg (tdm,
698 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_DESTROY);
699 tdm->trail_id = trail->pred_id;
700 GNUNET_MQ_send (friend->mq,
703 GNUNET_CONTAINER_MDLL_remove (succ,
708 GNUNET_break (trail ==
709 GNUNET_CONTAINER_heap_remove_node (trail->hn));
710 finger = *trail->finger;
713 *trail->finger = NULL;
714 GNUNET_free (finger);
721 * Send the get result to requesting client.
723 * @param trail_id trail identifying where to send the result to, NULL for us
724 * @param key Key of the requested data.
725 * @param type Block type
726 * @param put_path_length Number of peers in @a put_path
727 * @param put_path Path taken to put the data at its stored location.
728 * @param expiration When will this result expire?
729 * @param data Payload to store
730 * @param data_size Size of the @a data
732 * FIXME: also pass options, so we know to record paths or not...
735 GDS_NEIGHBOURS_send_get_result (const struct GNUNET_HashCode *trail_id,
736 const struct GNUNET_HashCode *key,
737 enum GNUNET_BLOCK_Type type,
738 unsigned int put_path_length,
739 const struct GNUNET_PeerIdentity *put_path,
740 struct GNUNET_TIME_Absolute expiration,
744 // TRICKY: need to introduce some context to remember trail from
750 * Method called whenever a peer disconnects.
753 * @param peer peer identity this notification is about
756 handle_core_disconnect (void *cls,
757 const struct GNUNET_PeerIdentity *peer)
759 struct FriendInfo *remove_friend;
762 /* If disconnected to own identity, then return. */
763 if (0 == memcmp (&my_identity,
765 sizeof (struct GNUNET_PeerIdentity)))
768 if (NULL == (remove_friend =
769 GNUNET_CONTAINER_multipeermap_get (friends_peermap,
776 GNUNET_assert (GNUNET_YES ==
777 GNUNET_CONTAINER_multipeermap_remove (friends_peermap,
780 while (NULL != (t = remove_friend->succ_head))
784 while (NULL != (t = remove_friend->pred_head))
788 GNUNET_MQ_destroy (remove_friend->mq);
789 GNUNET_free (remove_friend);
791 GNUNET_CONTAINER_multipeermap_size (friends_peermap))
793 GNUNET_SCHEDULER_cancel (random_walk_task);
794 random_walk_task = NULL;
800 * Pick random friend from friends for random walk.
802 static struct FriendInfo *
803 pick_random_friend ()
805 // TODO: need to extend peermap API to return random entry...
806 // (Note: same extension exists for hashmap API).
807 return NULL; // FIXME...
812 * One of our trails might have timed out, check and
813 * possibly initiate cleanup.
819 trail_timeout_callback (void *cls,
820 const struct GNUNET_SCHEDULER_TaskContext *tc)
823 struct GNUNET_TIME_Relative left;
825 trail_timeout_task = NULL;
826 while (NULL != (trail = GNUNET_CONTAINER_heap_peek (trail_heap)))
828 left = GNUNET_TIME_absolute_get_remaining (trail->expiration_time);
829 if (0 != left.rel_value_us)
836 trail_timeout_task = GNUNET_SCHEDULER_add_delayed (left,
837 &trail_timeout_callback,
843 * Initiate a random walk.
849 do_random_walk (void *cls,
850 const struct GNUNET_SCHEDULER_TaskContext *tc)
852 static unsigned int walk_layer;
853 struct FriendInfo *friend;
854 struct GNUNET_MQ_Envelope *env;
855 struct RandomWalkMessage *rwm;
856 struct FingerTable *ft;
857 struct Finger *finger;
860 random_walk_task = NULL;
861 friend = pick_random_friend ();
863 trail = GNUNET_new (struct Trail);
864 /* We create the random walk so, no predecessor */
865 trail->succ = friend;
866 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_NONCE,
869 GNUNET_CONTAINER_multihashmap_put (trail_map,
872 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
878 GNUNET_CONTAINER_MDLL_insert (succ,
882 trail->expiration_time = GNUNET_TIME_relative_to_absolute (TRAIL_TIMEOUT);
883 trail->hn = GNUNET_CONTAINER_heap_insert (trail_heap,
885 trail->expiration_time.abs_value_us);
886 if (NULL == trail_timeout_task)
887 trail_timeout_task = GNUNET_SCHEDULER_add_delayed (TRAIL_TIMEOUT,
888 &trail_timeout_callback,
890 env = GNUNET_MQ_msg (rwm,
891 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK);
892 rwm->hops_taken = htonl (0);
893 rwm->trail_id = trail->succ_id;
894 GNUNET_MQ_send (friend->mq,
896 /* clean up 'old' entry (implicitly via trail cleanup) */
897 ft = &fingers[walk_layer];
899 if ( (NULL != ft->fingers) &&
900 (NULL != (finger = ft->fingers[ft->walk_offset])) )
901 delete_trail (finger->trail,
904 if (ft->finger_array_size < 42)
906 // FIXME: must have finger array of the right size here,
907 // FIXME: growing / shrinking are tricy -- with pointers
911 GNUNET_assert (NULL == ft->fingers[ft->walk_offset]);
913 finger = GNUNET_new (struct Finger);
914 finger->trail = trail;
915 trail->finger = &ft->fingers[ft->walk_offset];
917 ft->fingers[ft->walk_offset] = finger;
918 ft->is_sorted = GNUNET_NO;
919 ft->walk_offset = (ft->walk_offset + 1) % ft->finger_array_size;
921 walk_layer = (walk_layer + 1) % NUMBER_LAYERED_ID;
922 random_walk_task = GNUNET_SCHEDULER_add_delayed (RANDOM_WALK_DELAY,
929 * Method called whenever a peer connects.
932 * @param peer_identity peer identity this notification is about
935 handle_core_connect (void *cls,
936 const struct GNUNET_PeerIdentity *peer_identity)
938 struct FriendInfo *friend;
940 /* Check for connect to self message */
941 if (0 == memcmp (&my_identity,
943 sizeof (struct GNUNET_PeerIdentity)))
946 /* If peer already exists in our friend_peermap, then exit. */
948 GNUNET_CONTAINER_multipeermap_contains (friends_peermap,
955 friend = GNUNET_new (struct FriendInfo);
956 friend->id = *peer_identity;
957 friend->mq = GNUNET_CORE_mq_create (core_api,
959 GNUNET_assert (GNUNET_OK ==
960 GNUNET_CONTAINER_multipeermap_put (friends_peermap,
963 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
964 if (NULL == random_walk_task)
966 /* random walk needs to be started -- we have a first connection */
967 random_walk_task = GNUNET_SCHEDULER_add_now (&do_random_walk,
974 * To be called on core init/fail.
976 * @param cls service closure
977 * @param identity the public identity of this peer
980 core_init (void *cls,
981 const struct GNUNET_PeerIdentity *identity)
983 my_identity = *identity;
988 * Handle a `struct RandomWalkMessage` from a
989 * #GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK message.
991 * @param cls closure (NULL)
992 * @param peer sender identity
993 * @param message the setup message
994 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
997 handle_dht_p2p_random_walk (void *cls,
998 const struct GNUNET_PeerIdentity *peer,
999 const struct GNUNET_MessageHeader *message)
1001 const struct RandomWalkMessage *m;
1003 struct FriendInfo *pred;
1005 m = (const struct RandomWalkMessage *) message;
1006 pred = GNUNET_CONTAINER_multipeermap_get (friends_peermap,
1008 t = GNUNET_new (struct Trail);
1009 t->pred_id = m->trail_id;
1012 GNUNET_CONTAINER_multihashmap_put (trail_map,
1015 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1017 GNUNET_break_op (0);
1019 return GNUNET_SYSERR;
1021 GNUNET_CONTAINER_MDLL_insert (pred,
1025 t->expiration_time = GNUNET_TIME_relative_to_absolute (TRAIL_TIMEOUT);
1026 t->hn = GNUNET_CONTAINER_heap_insert (trail_heap,
1028 t->expiration_time.abs_value_us);
1029 if (NULL == trail_timeout_task)
1030 trail_timeout_task = GNUNET_SCHEDULER_add_delayed (TRAIL_TIMEOUT,
1031 &trail_timeout_callback,
1034 if (ntohl (m->hops_taken) > GDS_NSE_get ())
1036 /* We are the last hop, generate response */
1037 struct GNUNET_MQ_Envelope *env;
1038 struct RandomWalkResponseMessage *rwrm;
1041 env = GNUNET_MQ_msg (rwrm,
1042 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK_RESPONSE);
1043 rwrm->reserved = htonl (0);
1044 rwrm->trail_id = m->trail_id;
1045 layer = ntohs (m->layer);
1047 (void) GDS_DATACACHE_get_random_key (&rwrm->location);
1050 struct FingerTable *ft;
1052 if (layer > NUMBER_LAYERED_ID)
1054 GNUNET_break_op (0);
1055 // FIXME: clean up 't'...
1056 return GNUNET_SYSERR;
1058 ft = &fingers[layer-1];
1059 if (0 == ft->number_valid_fingers)
1061 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_NONCE,
1068 f = ft->fingers[GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE,
1069 ft->number_valid_fingers)];
1070 rwrm->location = f->destination;
1073 GNUNET_MQ_send (pred->mq,
1078 struct GNUNET_MQ_Envelope *env;
1079 struct RandomWalkMessage *rwm;
1080 struct FriendInfo *succ;
1082 /* extend the trail by another random hop */
1083 succ = pick_random_friend ();
1084 GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_NONCE,
1088 GNUNET_CONTAINER_multihashmap_put (trail_map,
1091 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
1094 GNUNET_CONTAINER_MDLL_remove (pred,
1101 GNUNET_CONTAINER_MDLL_insert (succ,
1105 env = GNUNET_MQ_msg (rwm,
1106 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK);
1107 rwm->hops_taken = htons (1 + ntohs (m->hops_taken));
1108 rwm->layer = m->layer;
1109 rwm->trail_id = t->succ_id;
1110 GNUNET_MQ_send (succ->mq,
1118 * Handle a `struct RandomWalkResponseMessage` from a GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK_RESPONSE
1121 * @param cls closure (NULL)
1122 * @param peer sender identity
1123 * @param message the setup response message
1124 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1127 handle_dht_p2p_random_walk_response (void *cls,
1128 const struct GNUNET_PeerIdentity *peer,
1129 const struct GNUNET_MessageHeader *message)
1131 const struct RandomWalkResponseMessage *rwrm;
1133 rwrm = (const struct RandomWalkResponseMessage *) message;
1134 // 1) lookup trail => find Finger entry => fill in 'destination' and mark valid, move to end of sorted array, mark unsorted, update links from 'trails'
1137 * 1 check if we are the correct layer
1138 * 1.a if true : add the returned value (finger) in the db structure
1139 * 1.b if true : do nothing
1141 /* FIXME: add the value in db structure 1.a */
1148 * Handle a `struct TrailDestroyMessage`.
1150 * @param cls closure (NULL)
1151 * @param peer sender identity
1152 * @param message the finger destroy message
1153 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1156 handle_dht_p2p_trail_destroy (void *cls,
1157 const struct GNUNET_PeerIdentity *peer,
1158 const struct GNUNET_MessageHeader *message)
1160 const struct TrailDestroyMessage *tdm;
1161 struct Trail *trail;
1163 tdm = (const struct TrailDestroyMessage *) message;
1164 trail = GNUNET_CONTAINER_multihashmap_get (trail_map,
1166 delete_trail (trail,
1167 ( (NULL != trail->succ) &&
1170 sizeof (struct GNUNET_PeerIdentity))) ),
1171 ( (NULL != trail->pred) &&
1174 sizeof (struct GNUNET_PeerIdentity))) ));
1180 * Handle a `struct FindSuccessorMessage` from a #GNUNET_MESSAGE_TYPE_WDHT_SUCCESSOR_FIND
1183 * @param cls closure (NULL)
1184 * @param trail_id path to the originator
1185 * @param message the finger setup message
1186 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1189 handle_dht_p2p_successor_find (void *cls,
1190 const struct GNUNET_HashCode *trail_id,
1191 const struct GNUNET_MessageHeader *message)
1193 const struct FindSuccessorMessage *fsm;
1195 fsm = (const struct FindSuccessorMessage *) message;
1196 // locate trail (for sending reply), if not exists, fail nicely.
1197 // otherwise, go to datacache and return 'top k' elements closest to 'key'
1198 // as "PUT" messages via the trail (need to extend DB API!)
1200 GDS_DATACACHE_get_successors (trail_id,
1208 * Handle a `struct PeerGetMessage`.
1210 * @param cls closure (NULL)
1211 * @param trail_id path to the originator
1212 * @param message the peer get message
1213 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1216 handle_dht_p2p_peer_get (void *cls,
1217 const struct GNUNET_HashCode *trail_id,
1218 const struct GNUNET_MessageHeader *message)
1220 const struct PeerGetMessage *pgm;
1222 // FIXME: note: never called like this, message embedded with trail route!
1223 pgm = (const struct PeerGetMessage *) message;
1224 // -> lookup in datacache (figure out way to remember trail!)
1227 * 1 extract the result
1229 * 3 send it using the good trail
1231 * What do i do when i don't have the key/value?
1239 * Handle a `struct PeerGetResultMessage`.
1241 * @param cls closure (NULL)
1242 * @param trail_id path to the originator
1243 * @param message the peer get result message
1244 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1247 handle_dht_p2p_peer_get_result (void *cls,
1248 const struct GNUNET_HashCode *trail_id,
1249 const struct GNUNET_MessageHeader *message)
1251 const struct PeerGetResultMessage *pgrm;
1253 pgrm = (const struct PeerGetResultMessage *) message;
1254 // pretty much: parse, & pass to client (there is some call for that...)
1257 GDS_CLIENTS_process_get (options,
1262 (void) GDS_DATACACHE_handle_get (trail_id,
1275 * Handle a `struct PeerPutMessage`.
1277 * @param cls closure (NULL)
1278 * @param trail_id path to the originator
1279 * @param message the peer put message
1280 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1283 handle_dht_p2p_peer_put (void *cls,
1284 const struct GNUNET_HashCode *trail_id,
1285 const struct GNUNET_MessageHeader *message)
1287 const struct PeerGetResultMessage *pgrm;
1289 pgrm = (const struct PeerGetResultMessage *) message;
1290 // parse & store in datacache, this is in response to us asking for successors.
1293 * 1 check the size of the message
1294 * 2 use the API to add the value in the "database". Check on the xdht file, how to do it.
1295 * 3 Did i a have to return a notification or did i have to return GNUNET_[OK|SYSERR]?
1298 GDS_DATACACHE_handle_put (expiration_time,
1304 GDS_CLIENTS_process_put (options,
1320 * Handler for a message we received along some trail.
1322 * @param cls closure
1323 * @param trail_id trail identifier
1324 * @param message the message we got
1325 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1328 (*TrailHandlerCallback)(void *cls,
1329 const struct GNUNET_HashCode *trail_id,
1330 const struct GNUNET_MessageHeader *message);
1334 * Definition of a handler for a message received along some trail.
1339 * NULL for end-of-list.
1341 TrailHandlerCallback callback;
1344 * Closure for @e callback.
1349 * Message type this handler addresses.
1351 uint16_t message_type;
1354 * Use 0 for variable-size.
1356 uint16_t message_size;
1364 forward_message_on_trail (struct FriendInfo *next_target,
1365 const struct GNUNET_HashCode *trail_id,
1367 const struct GNUNET_PeerIdentity *predecessor,
1368 const struct GNUNET_PeerIdentity *path,
1369 uint16_t path_length,
1370 const struct GNUNET_MessageHeader *payload)
1372 struct GNUNET_MQ_Envelope *env;
1373 struct TrailRouteMessage *trm;
1374 struct GNUNET_PeerIdentity *new_path;
1376 uint16_t payload_len;
1378 payload_len = ntohs (payload->size);
1381 plen = path_length + 1;
1382 if (plen >= (GNUNET_SERVER_MAX_MESSAGE_SIZE
1384 - sizeof (struct TrailRouteMessage))
1385 / sizeof (struct GNUNET_PeerIdentity))
1387 /* Should really not have paths this long... */
1388 GNUNET_break_op (0);
1395 GNUNET_break_op (0 == path_length);
1399 env = GNUNET_MQ_msg_extra (trm,
1401 plen * sizeof (struct GNUNET_PeerIdentity),
1402 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_ROUTE);
1403 trm->record_path = htons (have_path);
1404 trm->path_length = htons (plen);
1405 trm->trail_id = *trail_id;
1406 new_path = (struct GNUNET_PeerIdentity *) &trm[1];
1411 path_length * sizeof (struct GNUNET_PeerIdentity));
1412 new_path[path_length] = *predecessor;
1414 memcpy (&new_path[plen],
1417 GNUNET_MQ_send (next_target->mq,
1423 * Handle a `struct TrailRouteMessage`.
1425 * @param cls closure (NULL)
1426 * @param peer sender identity
1427 * @param message the finger destroy message
1428 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1431 handle_dht_p2p_trail_route (void *cls,
1432 const struct GNUNET_PeerIdentity *peer,
1433 const struct GNUNET_MessageHeader *message)
1435 static const struct TrailHandler handlers[] = {
1436 { &handle_dht_p2p_successor_find, NULL,
1437 GNUNET_MESSAGE_TYPE_WDHT_SUCCESSOR_FIND,
1438 sizeof (struct FindSuccessorMessage) },
1439 { NULL, NULL, 0, 0 }
1442 const struct TrailRouteMessage *trm;
1443 const struct GNUNET_PeerIdentity *path;
1444 uint16_t path_length;
1445 const struct GNUNET_MessageHeader *payload;
1446 const struct TrailHandler *th;
1447 struct Trail *trail;
1450 /* Parse and check message is well-formed */
1451 msize = ntohs (message->size);
1452 if (msize < sizeof (struct TrailRouteMessage))
1454 GNUNET_break_op (0);
1457 trm = (const struct TrailRouteMessage *) message;
1458 path_length = ntohs (trm->path_length);
1459 if (msize < sizeof (struct TrailRouteMessage) +
1460 path_length * sizeof (struct GNUNET_PeerIdentity) +
1461 sizeof (struct GNUNET_MessageHeader) )
1463 GNUNET_break_op (0);
1466 path = (const struct GNUNET_PeerIdentity *) &trm[1];
1467 payload = (const struct GNUNET_MessageHeader *) &path[path_length];
1468 if (msize != (ntohs (payload->size) +
1469 sizeof (struct TrailRouteMessage) +
1470 path_length * sizeof (struct GNUNET_PeerIdentity)))
1472 GNUNET_break_op (0);
1476 /* Is this message for us? */
1477 trail = GNUNET_CONTAINER_multihashmap_get (trail_map,
1479 if ( (NULL != trail->pred) &&
1482 sizeof (struct GNUNET_PeerIdentity))) )
1484 /* forward to 'successor' */
1485 if (NULL != trail->succ)
1487 forward_message_on_trail (trail->succ,
1489 ntohs (trm->record_path),
1499 /* forward to 'predecessor' */
1500 GNUNET_break_op ( (NULL != trail->succ) &&
1503 sizeof (struct GNUNET_PeerIdentity))) );
1504 if (NULL != trail->pred)
1506 forward_message_on_trail (trail->pred,
1508 ntohs (trm->record_path),
1517 /* Message is for us, dispatch to handler */
1519 for (i=0; NULL != handlers[i].callback; i++)
1522 if (ntohs (payload->type) == th->message_type)
1524 if ( (0 == th->message_size) ||
1525 (ntohs (payload->size) == th->message_size) )
1526 th->callback (th->cls,
1530 GNUNET_break_op (0);
1534 GNUNET_break_op (NULL != th);
1540 * Initialize neighbours subsystem.
1541 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1544 GDS_NEIGHBOURS_init (void)
1546 static const struct GNUNET_CORE_MessageHandler core_handlers[] = {
1547 { &handle_dht_p2p_random_walk,
1548 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK,
1549 sizeof (struct RandomWalkMessage) },
1550 { &handle_dht_p2p_random_walk_response,
1551 GNUNET_MESSAGE_TYPE_WDHT_RANDOM_WALK_RESPONSE,
1552 sizeof (struct RandomWalkResponseMessage) },
1553 { &handle_dht_p2p_trail_destroy,
1554 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_DESTROY,
1555 sizeof (struct TrailDestroyMessage) },
1556 { &handle_dht_p2p_trail_route,
1557 GNUNET_MESSAGE_TYPE_WDHT_TRAIL_ROUTE,
1563 GNUNET_CORE_connect (GDS_cfg, NULL,
1565 &handle_core_connect,
1566 &handle_core_disconnect,
1571 if (NULL == core_api)
1572 return GNUNET_SYSERR;
1573 friends_peermap = GNUNET_CONTAINER_multipeermap_create (256, GNUNET_NO);
1574 trail_map = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_YES);
1575 trail_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1581 * Shutdown neighbours subsystem.
1584 GDS_NEIGHBOURS_done (void)
1586 if (NULL == core_api)
1588 GNUNET_CORE_disconnect (core_api);
1590 GNUNET_assert (0 == GNUNET_CONTAINER_multipeermap_size (friends_peermap));
1591 GNUNET_CONTAINER_multipeermap_destroy (friends_peermap);
1592 friends_peermap = NULL;
1593 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (trail_map));
1594 GNUNET_CONTAINER_multihashmap_destroy (trail_map);
1596 GNUNET_CONTAINER_heap_destroy (trail_heap);
1598 if (NULL != trail_timeout_task)
1600 GNUNET_SCHEDULER_cancel (trail_timeout_task);
1601 trail_timeout_task = NULL;
1609 * @return my identity
1611 struct GNUNET_PeerIdentity
1612 GDS_NEIGHBOURS_get_my_id (void)
1617 /* end of gnunet-service-wdht_neighbours.c */