src/dht/gnunet-service-dht_routing.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file dht/gnunet-service-dht_routing.c
  23  * @brief GNUnet DHT tracking of requests for routing replies
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-dht_neighbours.h"
  28 #include "gnunet-service-dht_routing.h"
  29 #include "gnunet-service-dht.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 /**
  39  * Information we keep about all recent GET requests
  40  * so that we can route replies.
  41  */
  42 struct RecentRequest
  43 {
  44
  45   /**
  46    * The peer this request was received from.
  47    */
  48   struct GNUNET_PeerIdentity peer;
  49
  50   /**
  51    * Key of this request.
  52    */
  53   struct GNUNET_HashCode key;
  54
  55   /**
  56    * Position of this node in the min heap.
  57    */
  58   struct GNUNET_CONTAINER_HeapNode *heap_node;
  59
  60   /**
  61    * Bloomfilter for replies to drop.
  62    */
  63   struct GNUNET_CONTAINER_BloomFilter *reply_bf;
  64
  65   /**
  66    * Type of the requested block.
  67    */
  68   enum GNUNET_BLOCK_Type type;
  69
  70   /**
  71    * extended query (see gnunet_block_lib.h).  Allocated at the
  72    * end of this struct.
  73    */
  74   const void *xquery;
  75
  76   /**
  77    * Number of bytes in xquery.
  78    */
  79   size_t xquery_size;
  80
  81   /**
  82    * Mutator value for the reply_bf, see gnunet_block_lib.h
  83    */
  84   uint32_t reply_bf_mutator;
  85
  86   /**
  87    * Request options.
  88    */
  89   enum GNUNET_DHT_RouteOption options;
  90
  91 };
  92
  93
  94 /**
  95  * Recent requests by time inserted.
  96  */
  97 static struct GNUNET_CONTAINER_Heap *recent_heap;
  98
  99 /**
 100  * Recently seen requests by key.
 101  */
 102 static struct GNUNET_CONTAINER_MultiHashMap *recent_map;
 103
 104
 105 /**
 106  * Closure for the 'process' function.
 107  */
 108 struct ProcessContext
 109 {
 110   /**
 111    * Path of the original PUT
 112    */
 113   const struct GNUNET_PeerIdentity *put_path;
 114
 115   /**
 116    * Path of the reply.
 117    */
 118   const struct GNUNET_PeerIdentity *get_path;
 119
 120   /**
 121    * Payload of the reply.
 122    */
 123   const void *data;
 124
 125   /**
 126    * Expiration time of the result.
 127    */
 128   struct GNUNET_TIME_Absolute expiration_time;
 129
 130   /**
 131    * Number of entries in 'put_path'.
 132    */
 133   unsigned int put_path_length;
 134
 135   /**
 136    * Number of entries in 'get_path'.
 137    */
 138   unsigned int get_path_length;
 139
 140   /**
 141    * Number of bytes in 'data'.
 142    */
 143   size_t data_size;
 144
 145   /**
 146    * Type of the reply.
 147    */
 148   enum GNUNET_BLOCK_Type type;
 149
 150 };
 151
 152
 153 /**
 154  * Forward the result to the given peer if it matches the request.
 155  *
 156  * @param cls the `struct ProcessContext` with the result
 157  * @param key the query
 158  * @param value the `struct RecentRequest` with the request
 159  * @return #GNUNET_OK (continue to iterate),
 160  *         #GNUNET_SYSERR if the result is malformed or type unsupported
 161  */
 162 static int
 163 process (void *cls,
 164          const struct GNUNET_HashCode *key,
 165          void *value)
 166 {
 167   struct ProcessContext *pc = cls;
 168   struct RecentRequest *rr = value;
 169   enum GNUNET_BLOCK_EvaluationResult eval;
 170   unsigned int gpl;
 171   unsigned int ppl;
 172   struct GNUNET_HashCode hc;
 173   const struct GNUNET_HashCode *eval_key;
 174
 175   if ( (rr->type != GNUNET_BLOCK_TYPE_ANY) &&
 176        (rr->type != pc->type) )
 177     return GNUNET_OK;           /* type missmatch */
 178
 179   if (0 != (rr->options & GNUNET_DHT_RO_RECORD_ROUTE))
 180   {
 181     gpl = pc->get_path_length;
 182     ppl = pc->put_path_length;
 183   }
 184   else
 185   {
 186     gpl = 0;
 187     ppl = 0;
 188   }
 189   if ( (0 != (rr->options & GNUNET_DHT_RO_FIND_PEER)) &&
 190        (pc->type == GNUNET_BLOCK_TYPE_DHT_HELLO) )
 191   {
 192     /* key may not match HELLO, which is OK since
 193      * the search is approximate.  Still, the evaluation
 194      * would fail since the match is not exact.  So
 195      * we fake it by changing the key to the actual PID ... */
 196     GNUNET_BLOCK_get_key (GDS_block_context,
 197                           GNUNET_BLOCK_TYPE_DHT_HELLO,
 198                           pc->data,
 199                           pc->data_size,
 200                           &hc);
 201     eval_key = &hc;
 202   }
 203   else
 204   {
 205     eval_key = key;
 206   }
 207   eval
 208     = GNUNET_BLOCK_evaluate (GDS_block_context,
 209                              pc->type,
 210                              GNUNET_BLOCK_EO_NONE,
 211                              eval_key,
 212                              &rr->reply_bf,
 213                              rr->reply_bf_mutator,
 214                              rr->xquery,
 215                              rr->xquery_size,
 216                              pc->data,
 217                              pc->data_size);
 218   switch (eval)
 219   {
 220   case GNUNET_BLOCK_EVALUATION_OK_MORE:
 221   case GNUNET_BLOCK_EVALUATION_OK_LAST:
 222     GNUNET_STATISTICS_update (GDS_stats,
 223                               gettext_noop
 224                               ("# Good REPLIES matched against routing table"),
 225                               1, GNUNET_NO);
 226     GDS_NEIGHBOURS_handle_reply (&rr->peer, pc->type, pc->expiration_time, key,
 227                                  ppl, pc->put_path, gpl, pc->get_path, pc->data,
 228                                  pc->data_size);
 229     break;
 230   case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
 231     GNUNET_STATISTICS_update (GDS_stats,
 232                               gettext_noop
 233                               ("# Duplicate REPLIES matched against routing table"),
 234                               1, GNUNET_NO);
 235     return GNUNET_OK;
 236   case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
 237     GNUNET_STATISTICS_update (GDS_stats,
 238                               gettext_noop
 239                               ("# Invalid REPLIES matched against routing table"),
 240                               1, GNUNET_NO);
 241     return GNUNET_SYSERR;
 242   case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
 243     GNUNET_STATISTICS_update (GDS_stats,
 244                               gettext_noop
 245                               ("# Irrelevant REPLIES matched against routing table"),
 246                               1, GNUNET_NO);
 247     return GNUNET_OK;
 248   case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
 249     GNUNET_break (0);
 250     return GNUNET_OK;
 251   case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
 252     GNUNET_break (0);
 253     return GNUNET_OK;
 254   case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
 255     GNUNET_STATISTICS_update (GDS_stats,
 256                               gettext_noop
 257                               ("# Unsupported REPLIES matched against routing table"),
 258                               1, GNUNET_NO);
 259     return GNUNET_SYSERR;
 260   default:
 261     GNUNET_break (0);
 262     return GNUNET_SYSERR;
 263   }
 264   return GNUNET_OK;
 265 }
 266
 267
 268 /**
 269  * Handle a reply (route to origin).  Only forwards the reply back to
 270  * other peers waiting for it.  Does not do local caching or
 271  * forwarding to local clients.  Essentially calls
 272  * GDS_NEIGHBOURS_handle_reply for all peers that sent us a matching
 273  * request recently.
 274  *
 275  * @param type type of the block
 276  * @param expiration_time when does the content expire
 277  * @param key key for the content
 278  * @param put_path_length number of entries in put_path
 279  * @param put_path peers the original PUT traversed (if tracked)
 280  * @param get_path_length number of entries in get_path
 281  * @param get_path peers this reply has traversed so far (if tracked)
 282  * @param data payload of the reply
 283  * @param data_size number of bytes in data
 284  */
 285 void
 286 GDS_ROUTING_process (void *cls,
 287                      enum GNUNET_BLOCK_Type type,
 288                      struct GNUNET_TIME_Absolute expiration_time,
 289                      const struct GNUNET_HashCode *key,
 290                      unsigned int put_path_length,
 291                      const struct GNUNET_PeerIdentity *put_path,
 292                      unsigned int get_path_length,
 293                      const struct GNUNET_PeerIdentity *get_path,
 294                      const void *data,
 295                      size_t data_size)
 296 {
 297   struct ProcessContext pc;
 298
 299   pc.type = type;
 300   pc.expiration_time = expiration_time;
 301   pc.put_path_length = put_path_length;
 302   pc.put_path = put_path;
 303   pc.get_path_length = get_path_length;
 304   pc.get_path = get_path;
 305   pc.data = data;
 306   pc.data_size = data_size;
 307   if (NULL == data)
 308   {
 309     /* Some apps might have an 'empty' reply as a valid reply; however,
 310        'process' will call GNUNET_BLOCK_evaluate' which treats a 'NULL'
 311        reply as request-validation (but we need response-validation).
 312        So we set 'data' to a 0-byte non-NULL value just to be sure */
 313     GNUNET_break (0 == data_size);
 314     pc.data_size = 0;
 315     pc.data = ""; /* something not null */
 316   }
 317   GNUNET_CONTAINER_multihashmap_get_multiple (recent_map,
 318                                               key,
 319                                               &process,
 320                                               &pc);
 321 }
 322
 323
 324 /**
 325  * Remove the oldest entry from the DHT routing table.  Must only
 326  * be called if it is known that there is at least one entry
 327  * in the heap and hashmap.
 328  */
 329 static void
 330 expire_oldest_entry ()
 331 {
 332   struct RecentRequest *recent_req;
 333
 334   GNUNET_STATISTICS_update (GDS_stats,
 335                             gettext_noop
 336                             ("# Entries removed from routing table"), 1,
 337                             GNUNET_NO);
 338   recent_req = GNUNET_CONTAINER_heap_peek (recent_heap);
 339   GNUNET_assert (recent_req != NULL);
 340   GNUNET_CONTAINER_heap_remove_node (recent_req->heap_node);
 341   GNUNET_CONTAINER_bloomfilter_free (recent_req->reply_bf);
 342   GNUNET_assert (GNUNET_YES ==
 343                  GNUNET_CONTAINER_multihashmap_remove (recent_map,
 344                                                        &recent_req->key,
 345                                                        recent_req));
 346   GNUNET_free (recent_req);
 347 }
 348
 349
 350 /**
 351  * Try to combine multiple recent requests for the same value
 352  * (if they come from the same peer).
 353  *
 354  * @param cls the new 'struct RecentRequest' (to discard upon successful combination)
 355  * @param key the query
 356  * @param value the existing 'struct RecentRequest' (to update upon successful combination)
 357  * @return #GNUNET_OK (continue to iterate),
 358  *         #GNUNET_SYSERR if the request was successfully combined
 359  */
 360 static int
 361 try_combine_recent (void *cls,
 362                     const struct GNUNET_HashCode *key,
 363                     void *value)
 364 {
 365   struct RecentRequest *in = cls;
 366   struct RecentRequest *rr = value;
 367
 368   if ( (0 != memcmp (&in->peer,
 369                      &rr->peer,
 370                      sizeof (struct GNUNET_PeerIdentity))) ||
 371        (in->type != rr->type) ||
 372        (in->xquery_size != rr->xquery_size) ||
 373        (0 != memcmp (in->xquery,
 374                      rr->xquery,
 375                      in->xquery_size)) )
 376     return GNUNET_OK;
 377   if (in->reply_bf_mutator != rr->reply_bf_mutator)
 378   {
 379     rr->reply_bf_mutator = in->reply_bf_mutator;
 380     GNUNET_CONTAINER_bloomfilter_free (rr->reply_bf);
 381     rr->reply_bf = in->reply_bf;
 382   }
 383   else
 384   {
 385     GNUNET_CONTAINER_bloomfilter_or2 (rr->reply_bf,
 386                                       in->reply_bf);
 387     GNUNET_CONTAINER_bloomfilter_free (in->reply_bf);
 388   }
 389   GNUNET_free (in);
 390   return GNUNET_SYSERR;
 391 }
 392
 393
 394 /**
 395  * Add a new entry to our routing table.
 396  *
 397  * @param sender peer that originated the request
 398  * @param type type of the block
 399  * @param options options for processing
 400  * @param key key for the content
 401  * @param xquery extended query
 402  * @param xquery_size number of bytes in @a xquery
 403  * @param reply_bf bloomfilter to filter duplicates
 404  * @param reply_bf_mutator mutator for @a reply_bf
 405  */
 406 void
 407 GDS_ROUTING_add (const struct GNUNET_PeerIdentity *sender,
 408                  enum GNUNET_BLOCK_Type type,
 409                  enum GNUNET_DHT_RouteOption options,
 410                  const struct GNUNET_HashCode *key,
 411                  const void *xquery,
 412                  size_t xquery_size,
 413                  const struct GNUNET_CONTAINER_BloomFilter *reply_bf,
 414                  uint32_t reply_bf_mutator)
 415 {
 416   struct RecentRequest *recent_req;
 417
 418   while (GNUNET_CONTAINER_heap_get_size (recent_heap) >= DHT_MAX_RECENT)
 419     expire_oldest_entry ();
 420   GNUNET_STATISTICS_update (GDS_stats,
 421                             gettext_noop ("# Entries added to routing table"),
 422                             1, GNUNET_NO);
 423   recent_req = GNUNET_malloc (sizeof (struct RecentRequest) + xquery_size);
 424   recent_req->peer = *sender;
 425   recent_req->key = *key;
 426   recent_req->reply_bf = GNUNET_CONTAINER_bloomfilter_copy (reply_bf);
 427   recent_req->type = type;
 428   recent_req->options = options;
 429   recent_req->xquery = &recent_req[1];
 430   GNUNET_memcpy (&recent_req[1], xquery, xquery_size);
 431   recent_req->xquery_size = xquery_size;
 432   recent_req->reply_bf_mutator = reply_bf_mutator;
 433   if (GNUNET_SYSERR ==
 434       GNUNET_CONTAINER_multihashmap_get_multiple (recent_map,
 435                                                   key,
 436                                                   &try_combine_recent,
 437                                                   recent_req))
 438   {
 439     GNUNET_STATISTICS_update (GDS_stats,
 440                               gettext_noop
 441                               ("# DHT requests combined"),
 442                               1, GNUNET_NO);
 443     return;
 444   }
 445   recent_req->heap_node =
 446       GNUNET_CONTAINER_heap_insert (recent_heap, recent_req,
 447                                     GNUNET_TIME_absolute_get ().abs_value_us);
 448   GNUNET_CONTAINER_multihashmap_put (recent_map, key, recent_req,
 449                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 450
 451
 452 }
 453
 454
 455 /**
 456  * Initialize routing subsystem.
 457  */
 458 void
 459 GDS_ROUTING_init ()
 460 {
 461   recent_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
 462   recent_map = GNUNET_CONTAINER_multihashmap_create (DHT_MAX_RECENT * 4 / 3, GNUNET_NO);
 463 }
 464
 465
 466 /**
 467  * Shutdown routing subsystem.
 468  */
 469 void
 470 GDS_ROUTING_done ()
 471 {
 472   while (GNUNET_CONTAINER_heap_get_size (recent_heap) > 0)
 473     expire_oldest_entry ();
 474   GNUNET_assert (0 == GNUNET_CONTAINER_heap_get_size (recent_heap));
 475   GNUNET_CONTAINER_heap_destroy (recent_heap);
 476   recent_heap = NULL;
 477   GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (recent_map));
 478   GNUNET_CONTAINER_multihashmap_destroy (recent_map);
 479   recent_map = NULL;
 480 }
 481
 482 /* end of gnunet-service-dht_routing.c */