src/dht/gnunet-service-xdht_routing.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 - 2014 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file dht/gnunet-service-xdht_routing.c
  23  * @brief GNUnet DHT tracking of requests for routing replies
  24  * @author Supriti Singh
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-xdht_neighbours.h"
  28 #include "gnunet-service-xdht_routing.h"
  29 #include "gnunet-service-xdht.h"
  30
  31
  32 /**
  33  * FIXME: Check if its better to store pointer to friend rather than storing
  34  * peer identity next_hop or prev_hop.
  35  * keep entries in destnation and source peer also. so when we send the trail
  36  * teardown message then we don't know the source but if source gets the message
  37  * then it shold remove that trail id from its finger table. But how does
  38  * source know what is the desination finger ? It will whenevr contact a trail
  39  * will do a lookup in routing table and if no trail id present the remove
  40  * that trail of the finger and if only one trail then remove the finger.
  41  * because of this use case of trail teardown I think trail compression
  42  * and trail teardown should not be merged.
  43  * 2. store a pointer to friendInfo in place o peer identity.
  44  */
  45 /**
  46  * Maximum number of entries in routing table.
  47  */
  48 #define ROUTING_TABLE_THRESHOLD 64
  49
  50 /**
  51  * Routing table entry .
  52  */
  53 struct RoutingTrail
  54 {
  55   /**
  56    * Global Unique identifier of the trail.
  57    */
  58   struct GNUNET_HashCode trail_id;
  59
  60   /**
  61    * The peer to which this request should be passed to.
  62    */
  63   struct GNUNET_PeerIdentity next_hop;
  64
  65   /**
  66    * Peer just before next hop in the trail.
  67    */
  68   struct GNUNET_PeerIdentity prev_hop;
  69 };
  70
  71 /**
  72  * Routing table of the peer
  73  */
  74 static struct GNUNET_CONTAINER_MultiHashMap *routing_table;
  75
  76 /**
  77  * Update the prev. hop of the trail. Call made by trail teardown where
  78  * if you are the first friend now in the trail then you need to update
  79  * your prev. hop.
  80  * @param trail_id
  81  * @return #GNUNET_OK success
  82  *         #GNUNET_SYSERR in case no matching entry found in routing table.
  83  */
  84 int
  85 GDS_ROUTING_update_trail_prev_hop (const struct GNUNET_HashCode trail_id,
  86                                    struct GNUNET_PeerIdentity prev_hop)
  87 {
  88   struct RoutingTrail *trail;
  89
  90   trail = GNUNET_CONTAINER_multihashmap_get (routing_table, &trail_id);
  91
  92   if (NULL == trail)
  93     return GNUNET_SYSERR;
  94
  95   trail->prev_hop = prev_hop;
  96   return GNUNET_OK;
  97 }
  98
  99
 100
 101 /**
 102  * Get the next hop for trail corresponding to trail_id
 103  * @param trail_id Trail id to be searched.
 104  * @return Next_hop if found
 105  *         NULL If next hop not found.
 106  */
 107 struct GNUNET_PeerIdentity *
 108 GDS_ROUTING_get_next_hop (const struct GNUNET_HashCode trail_id,
 109                           enum GDS_ROUTING_trail_direction trail_direction)
 110 {
 111   struct RoutingTrail *trail;
 112
 113   trail = GNUNET_CONTAINER_multihashmap_get (routing_table, &trail_id);
 114
 115   if (NULL == trail)
 116     return NULL;
 117
 118   switch (trail_direction)
 119   {
 120     case GDS_ROUTING_SRC_TO_DEST:
 121       return &(trail->next_hop);
 122     case GDS_ROUTING_DEST_TO_SRC:
 123       return &(trail->prev_hop);
 124   }
 125   return NULL;
 126 }
 127
 128
 129 /**
 130  * Remove trail with trail_id
 131  * @param trail_id Trail id to be removed
 132  * @return #GNUNET_YES success
 133  *         #GNUNET_NO if entry not found.
 134  */
 135 int
 136 GDS_ROUTING_remove_trail (const struct GNUNET_HashCode remove_trail_id)
 137 {
 138   struct RoutingTrail *remove_entry;
 139
 140   remove_entry = GNUNET_CONTAINER_multihashmap_get (routing_table, &remove_trail_id);
 141
 142   if (NULL == remove_entry)
 143     return GNUNET_NO;
 144
 145   if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_remove (routing_table,
 146                                                           &remove_trail_id,
 147                                                           remove_entry))
 148   {
 149     GNUNET_free (remove_entry);
 150     return GNUNET_YES;
 151   }
 152   return GNUNET_NO;
 153 }
 154
 155
 156 /**
 157  * Iterate over routing table and remove entries with value as part of any trail.
 158  *
 159  * @param cls closure
 160  * @param key current public key
 161  * @param value value in the hash map
 162  * @return #GNUNET_YES if we should continue to iterate,
 163  *         #GNUNET_NO if not.
 164  */
 165 static int remove_matching_trails (void *cls,
 166                                    const struct GNUNET_HashCode *key,
 167                                    void *value)
 168 {
 169   struct RoutingTrail *remove_trail = value;
 170   struct GNUNET_PeerIdentity *disconnected_peer = cls;
 171   struct GNUNET_HashCode trail_id = *key;
 172   struct GNUNET_PeerIdentity my_identity;
 173
 174   /* If disconnected_peer is next_hop, then send a trail teardown message through
 175    * prev_hop in direction from destination to source. */
 176   if (0 == GNUNET_CRYPTO_cmp_peer_identity (&remove_trail->next_hop,
 177                                             disconnected_peer))
 178   {
 179     my_identity = GDS_NEIGHBOURS_get_my_id ();
 180     if (0 != GNUNET_CRYPTO_cmp_peer_identity (&my_identity,
 181                                               &remove_trail->prev_hop))
 182     {
 183       GDS_NEIGHBOURS_send_trail_teardown (trail_id,
 184                                           GDS_ROUTING_DEST_TO_SRC,
 185                                           &remove_trail->prev_hop);
 186     }
 187   }
 188
 189   /* If disconnected_peer is prev_hop, then send a trail teardown through
 190    * next_hop in direction from Source to Destination. */
 191   if (0 == GNUNET_CRYPTO_cmp_peer_identity (&remove_trail->prev_hop,
 192                                             disconnected_peer))
 193   {
 194     my_identity = GDS_NEIGHBOURS_get_my_id ();
 195     if (0 != GNUNET_CRYPTO_cmp_peer_identity (&my_identity,
 196                                               &remove_trail->next_hop))
 197     {
 198       GDS_NEIGHBOURS_send_trail_teardown (trail_id,
 199                                           GDS_ROUTING_SRC_TO_DEST,
 200                                           &remove_trail->next_hop);
 201     }
 202   }
 203
 204   GNUNET_assert (GNUNET_YES ==
 205                    GNUNET_CONTAINER_multihashmap_remove (routing_table,
 206                                                          &trail_id,
 207                                                          remove_trail));
 208   GNUNET_free (remove_trail);
 209   return GNUNET_YES;
 210 }
 211
 212 #if 0
 213 /**
 214  * TEST FUNCTION
 215  * Remove after using.
 216  */
 217 void
 218 GDS_ROUTING_test_print (void)
 219 {
 220   struct GNUNET_CONTAINER_MultiHashMapIterator *iter;
 221   struct RoutingTrail *trail;
 222   struct GNUNET_PeerIdentity print_peer;
 223   struct GNUNET_HashCode key_ret;
 224   int i;
 225
 226    FPRINTF (stderr,_("\nSUPU ***PRINTING ROUTING TABLE *****"));
 227   iter =GNUNET_CONTAINER_multihashmap_iterator_create (routing_table);
 228   for (i = 0; i < GNUNET_CONTAINER_multihashmap_size(routing_table); i++)
 229   {
 230     if(GNUNET_YES == GNUNET_CONTAINER_multihashmap_iterator_next (iter,
 231                                                                   &key_ret,
 232                                                                   (const void **)&trail))
 233     {
 234       FPRINTF (stderr,_("\nSUPU %s, %s, %d, trail->trail_id = %s"),
 235               __FILE__, __func__,__LINE__, GNUNET_h2s(&trail->trail_id));
 236       memcpy (&print_peer, &trail->next_hop, sizeof (struct GNUNET_PeerIdentity));
 237       FPRINTF (stderr,_("\nSUPU %s, %s, %d, trail->next_hop = %s"),
 238               __FILE__, __func__,__LINE__, GNUNET_i2s(&print_peer));
 239       memcpy (&print_peer, &trail->prev_hop, sizeof (struct GNUNET_PeerIdentity));
 240       FPRINTF (stderr,_("\nSUPU %s, %s, %d, trail->prev_hop = %s"),
 241               __FILE__, __func__,__LINE__, GNUNET_i2s(&print_peer));
 242     }
 243   }
 244 }
 245 #endif
 246 /**
 247  * Remove every trail where peer is either next_hop or prev_hop. Also send a
 248  * trail teardown message in direction of hop which is not disconnected.
 249  * @param peer Peer identity. Trail containing this peer should be removed.
 250  */
 251 void
 252 GDS_ROUTING_remove_trail_by_peer (const struct GNUNET_PeerIdentity *peer)
 253 {
 254   /* No entries in my routing table. */
 255   if (0 == GNUNET_CONTAINER_multihashmap_size(routing_table))
 256     return;
 257
 258   GNUNET_CONTAINER_multihashmap_iterate (routing_table, &remove_matching_trails,
 259                                          (void *)peer);
 260 }
 261
 262
 263 /**
 264  * Add a new entry in routing table
 265  * @param new_trail_id
 266  * @param prev_hop
 267  * @param next_hop
 268  * @return #GNUNET_OK success
 269  *         #GNUNET_SYSERR in case new_trail_id already exists in the network
 270  *                         but with different prev_hop/next_hop
 271  */
 272 int
 273 GDS_ROUTING_add (struct GNUNET_HashCode new_trail_id,
 274                  struct GNUNET_PeerIdentity prev_hop,
 275                  struct GNUNET_PeerIdentity next_hop)
 276 {
 277   struct RoutingTrail *new_entry;
 278
 279   new_entry = GNUNET_new (struct RoutingTrail);
 280   new_entry->trail_id = new_trail_id;
 281   new_entry->next_hop = next_hop;
 282   new_entry->prev_hop = prev_hop;
 283
 284   return GNUNET_CONTAINER_multihashmap_put (routing_table,
 285                                             &new_trail_id, new_entry,
 286                                             GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
 287 }
 288
 289
 290 /**
 291  * Check if the size of routing table has crossed ROUTING_TABLE_THRESHOLD.
 292  * It means that I don't have any more space in my routing table and I can not
 293  * be part of any more trails till there is free space in my routing table.
 294  * @return #GNUNET_YES, if threshold crossed else #GNUNET_NO.
 295  */
 296 int
 297 GDS_ROUTING_threshold_reached (void)
 298 {
 299   return (GNUNET_CONTAINER_multihashmap_size(routing_table) >
 300           ROUTING_TABLE_THRESHOLD) ? GNUNET_YES:GNUNET_NO;
 301 }
 302
 303
 304 /**
 305  * Initialize routing subsystem.
 306  */
 307 void
 308 GDS_ROUTING_init (void)
 309 {
 310   routing_table = GNUNET_CONTAINER_multihashmap_create (ROUTING_TABLE_THRESHOLD * 4 / 3,
 311                                                         GNUNET_NO);
 312 }
 313
 314
 315 /**
 316  * Shutdown routing subsystem.
 317  */
 318 void
 319 GDS_ROUTING_done (void)
 320 {
 321   GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (routing_table));
 322   GNUNET_CONTAINER_multihashmap_destroy (routing_table);
 323 }
 324
 325 /* end of gnunet-service-xdht_routing.c */