src/dht/gnunet-service-xdht_routing.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 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 /* FIXME
  32  * 1. We need field to understand which routing table is for which peer.
  33  * 2. Better function names and variable names.
  34  * 3. Use destination peer id as key for routing table.
  35  * 4. What does GDS stands for?
  36  *
  37  */
  38
  39
  40 /**
  41  * Number of requests we track at most (for routing replies).
  42  */
  43 #define DHT_MAX_RECENT (1024 * 16)
  44
  45
  46 /**
  47  * Routing table entry .
  48  */
  49 struct RoutingTrail
  50 {
  51   /**
  52    * Source peer .
  53    */
  54   struct GNUNET_PeerIdentity *source;
  55
  56   /**
  57    * Destination peer.
  58    */
  59   struct GNUNET_PeerIdentity *destination;
  60
  61   /**
  62    * The peer this request was received from.
  63    */
  64   struct GNUNET_PeerIdentity *previous_hop;
  65
  66   /**
  67    * The peer to which this request should be passed to.
  68    */
  69   struct GNUNET_PeerIdentity *next_hop;
  70
  71 };
  72
  73
  74 /**
  75  * Routing table of the peer
  76  */
  77 static struct GNUNET_CONTAINER_MultiPeerMap *routing_table;
  78
  79
  80 /**
  81  * FIXME: Change the name of variable.
  82  * Ensure that everywhere in this file you are using destination as the key.
  83  * Do we need prev field in routing table?
  84  * Add a new entry to our routing table.
  85  * @param source peer
  86  * @param destintation
  87  * @param next_hop
  88  */
  89 void
  90 GDS_ROUTING_add (struct GNUNET_PeerIdentity *source,
  91                  struct GNUNET_PeerIdentity *dest,
  92                  struct GNUNET_PeerIdentity *next_hop)
  93 {
  94   struct RoutingTrail *new_routing_entry;
  95
  96   new_routing_entry = GNUNET_malloc (sizeof (struct RoutingTrail));
  97   new_routing_entry->source = source;
  98   new_routing_entry->next_hop = next_hop;
  99   new_routing_entry->destination = dest;
 100
 101   /* If dest is already present in the routing table, then exit.*/
 102   if (GNUNET_YES ==
 103     GNUNET_CONTAINER_multipeermap_contains (routing_table,
 104                                               dest))
 105   {
 106     GNUNET_break (0);
 107     return;
 108   }
 109
 110   GNUNET_assert (GNUNET_OK ==
 111     GNUNET_CONTAINER_multipeermap_put (routing_table,
 112                                            dest, new_routing_entry,
 113                                            GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 114 }
 115
 116
 117 /**
 118  * Find the next hop to send packet to .
 119  * @return next hop peer id
 120  */
 121 struct GNUNET_PeerIdentity *
 122 GDS_ROUTING_search(struct GNUNET_PeerIdentity *source_peer,
 123                    struct GNUNET_PeerIdentity *destination_peer)
 124 {
 125   struct RoutingTrail *trail;
 126   trail = (struct RoutingTrail *)(GNUNET_CONTAINER_multipeermap_get(routing_table,destination_peer));
 127
 128   if(trail == NULL)
 129       return NULL;
 130
 131   return trail->next_hop;
 132 }
 133
 134
 135 /**FIXME: Old implementation just to remove error
 136  * Handle a reply (route to origin).  Only forwards the reply back to
 137  * other peers waiting for it.  Does not do local caching or
 138  * forwarding to local clients.  Essentially calls
 139  * GDS_NEIGHBOURS_handle_reply for all peers that sent us a matching
 140  * request recently.
 141  *
 142  * @param type type of the block
 143  * @param expiration_time when does the content expire
 144  * @param key key for the content
 145  * @param put_path_length number of entries in put_path
 146  * @param put_path peers the original PUT traversed (if tracked)
 147  * @param get_path_length number of entries in get_path
 148  * @param get_path peers this reply has traversed so far (if tracked)
 149  * @param data payload of the reply
 150  * @param data_size number of bytes in data
 151  */
 152 void
 153 GDS_ROUTING_process (enum GNUNET_BLOCK_Type type,
 154                      struct GNUNET_TIME_Absolute expiration_time,
 155                      const struct GNUNET_HashCode * key, unsigned int put_path_length,
 156                      const struct GNUNET_PeerIdentity *put_path,
 157                      unsigned int get_path_length,
 158                      const struct GNUNET_PeerIdentity *get_path,
 159                      const void *data, size_t data_size)
 160 {
 161
 162 }
 163
 164
 165 /**
 166  * Initialize routing subsystem.
 167  */
 168 void
 169 GDS_ROUTING_init ()
 170 {
 171   routing_table = GNUNET_CONTAINER_multipeermap_create (DHT_MAX_RECENT * 4 / 3, GNUNET_NO);
 172 }
 173
 174
 175 /**
 176  * Shutdown routing subsystem.
 177  */
 178 void
 179 GDS_ROUTING_done ()
 180 {
 181   GNUNET_assert (0 == GNUNET_CONTAINER_multipeermap_size (routing_table));
 182   GNUNET_CONTAINER_multipeermap_destroy (routing_table);
 183 }
 184
 185 /* end of gnunet-service-xdht_routing.c */