1.Removed GNUNET_CRYPTO_compute_finger_identity
[oweals/gnunet.git] / 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
32 /**
33  * Number of requests we track at most (for routing replies).
34  */
35 #define DHT_MAX_RECENT (1024 * 16)
36
37 /**
38  * Maximum number of entries in routing table. 
39  */
40 #define ROUTING_TABLE_THRESHOLD 64
41
42 /**
43  * Routing table entry .
44  */
45 struct RoutingTrail
46 {
47   /**
48    * Source peer .
49    */
50   struct GNUNET_PeerIdentity source;
51
52   /**
53    * Destination peer.
54    */
55   struct GNUNET_PeerIdentity destination;
56
57   /**
58    * The peer to which this request should be passed to.
59    */
60   struct GNUNET_PeerIdentity next_hop;
61   
62   /**
63    * Peer just before next hop in the trail. 
64    */
65   struct GNUNET_PeerIdentity prev_hop;
66   
67 };
68
69
70 /**
71  * Routing table of the peer
72  */
73 static struct GNUNET_CONTAINER_MultiPeerMap *routing_table;
74
75
76 /**
77  * Add a new entry to our routing table.
78  * @param source peer Source of the trail.
79  * @param destintation Destination of the trail.
80  * @param next_hop Next peer to forward the message to reach the destination.
81  * @return GNUNET_YES
82  *         GNUNET_SYSERR If the number of routing entries crossed thershold.
83  */
84 int
85 GDS_ROUTING_add (struct GNUNET_PeerIdentity *source,
86                  struct GNUNET_PeerIdentity *dest,
87                  struct GNUNET_PeerIdentity *next_hop,
88                  const struct GNUNET_PeerIdentity *prev_hop)
89 {
90   struct RoutingTrail *new_routing_entry;
91     
92   if (GNUNET_CONTAINER_multipeermap_size(routing_table) > ROUTING_TABLE_THRESHOLD)
93     return GNUNET_SYSERR;
94   //FPRINTF (stderr,_("\nSUPU ROUTING ADD %s, %s, %d"),__FILE__, __func__,__LINE__);
95   new_routing_entry = GNUNET_malloc (sizeof (struct RoutingTrail));
96   memcpy (&(new_routing_entry->source) , source, sizeof (struct GNUNET_PeerIdentity));
97   memcpy (&(new_routing_entry->next_hop), next_hop, sizeof (struct GNUNET_PeerIdentity));
98   memcpy (&(new_routing_entry->destination), dest, sizeof (struct GNUNET_PeerIdentity));
99   memcpy (&(new_routing_entry->prev_hop), prev_hop, sizeof (struct GNUNET_PeerIdentity));
100   
101   GNUNET_assert (GNUNET_OK ==
102     GNUNET_CONTAINER_multipeermap_put (routing_table,
103                                        dest, new_routing_entry,
104                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
105   return GNUNET_YES;
106 }
107
108
109 /**
110  * Iterate over multiple entries for same destinational value and get
111  * the correct next hop.
112  * @param cls struct RoutingTrail
113  * @param key Destination identity
114  * @param value struct RoutingTrail
115  * @return #GNUNET_YES to continue looking, #GNUNET_NO if we found the next hop
116  */
117 int
118 get_next_hop (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
119 {
120   /* Here you should match if source, prev hop matches if yes then send 
121    GNUNET_NO as you don't need to check more entries. */
122   struct RoutingTrail *request = cls;
123   struct RoutingTrail *existing_entry = (struct RoutingTrail *)value;
124   
125   if (0 == GNUNET_CRYPTO_cmp_peer_identity (&(request->source), &(existing_entry->source)))
126   {
127     if (0 == GNUNET_CRYPTO_cmp_peer_identity (&(request->prev_hop), &(existing_entry->prev_hop)))
128     {
129       memcpy (&(request->next_hop), &(existing_entry->next_hop), sizeof (struct GNUNET_PeerIdentity));
130       return GNUNET_YES;
131     }
132   }
133   return GNUNET_NO;
134 }
135
136
137 /**
138  * Find the next hop to send packet to.
139  * @param source_peer Source of the trail.
140  * @param destination_peer Destination of the trail.
141  * @param prev_hop Previous hop in the trail. 
142  * @return Next hop in the trail from source to destination. 
143  */
144 struct GNUNET_PeerIdentity *
145 GDS_ROUTING_search(struct GNUNET_PeerIdentity *source_peer,
146                    struct GNUNET_PeerIdentity *destination_peer,
147                    const struct GNUNET_PeerIdentity *prev_hop)
148 {
149   struct RoutingTrail *trail;
150   trail = GNUNET_malloc (sizeof (struct RoutingTrail));
151   memcpy (&(trail->destination), destination_peer, sizeof (struct GNUNET_PeerIdentity));
152   memcpy (&(trail->source), source_peer, sizeof (struct GNUNET_PeerIdentity));
153   memcpy (&(trail->prev_hop), prev_hop, sizeof (struct GNUNET_PeerIdentity));
154   //trail->next_hop = NULL;
155   //FPRINTF (stderr,_("\nSUPU ROUTING SEARCH %s, %s, %d"),__FILE__, __func__,__LINE__);
156   GNUNET_CONTAINER_multipeermap_get_multiple (routing_table, destination_peer,
157                                               get_next_hop, trail);
158   if(trail != NULL)
159     return &(trail->next_hop);
160   else
161     return NULL;
162 }
163
164
165 /**FIXME: Old implementation just to remove error
166  * Handle a reply (route to origin).  Only forwards the reply back to
167  * other peers waiting for it.  Does not do local caching or
168  * forwarding to local clients.  Essentially calls
169  * GDS_NEIGHBOURS_handle_reply for all peers that sent us a matching
170  * request recently.
171  *
172  * @param type type of the block
173  * @param expiration_time when does the content expire
174  * @param key key for the content
175  * @param put_path_length number of entries in put_path
176  * @param put_path peers the original PUT traversed (if tracked)
177  * @param get_path_length number of entries in get_path
178  * @param get_path peers this reply has traversed so far (if tracked)
179  * @param data payload of the reply
180  * @param data_size number of bytes in data
181  */
182 void
183 GDS_ROUTING_process (enum GNUNET_BLOCK_Type type,
184                      struct GNUNET_TIME_Absolute expiration_time,
185                      const struct GNUNET_HashCode * key, unsigned int put_path_length,
186                      const struct GNUNET_PeerIdentity *put_path,
187                      unsigned int get_path_length,
188                      const struct GNUNET_PeerIdentity *get_path,
189                      const void *data, size_t data_size)
190 {
191   return;
192 }
193
194
195 /**
196  * Initialize routing subsystem.
197  */
198 void
199 GDS_ROUTING_init ()
200
201   routing_table = GNUNET_CONTAINER_multipeermap_create (DHT_MAX_RECENT * 4 / 3, GNUNET_NO);
202 }
203
204
205 /**
206  * Shutdown routing subsystem.
207  */
208 void
209 GDS_ROUTING_done ()
210 {
211   GNUNET_assert (0 == GNUNET_CONTAINER_multipeermap_size (routing_table));
212   GNUNET_CONTAINER_multipeermap_destroy (routing_table);
213 }
214
215 /* end of gnunet-service-xdht_routing.c */