src/dht/gnunet-service-xdht_datacache.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 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-dht_datacache.c
  23  * @brief GNUnet DHT service's datacache integration
  24  * @author Christian Grothoff
  25  * @author Nathan Evans
  26  */
  27 #include "platform.h"
  28 #include "gnunet_datacache_lib.h"
  29 #include "gnunet-service-xdht_clients.h"
  30 #include "gnunet-service-xdht_datacache.h"
  31 #include "gnunet-service-xdht_routing.h"
  32 #include "gnunet-service-xdht_neighbours.h"
  33 #include "gnunet-service-dht.h"
  34
  35 #define LOG(kind,...) GNUNET_log_from (kind, "dht-dtcache",__VA_ARGS__)
  36
  37
  38 /**
  39  * Handle to the datacache service (for inserting/retrieving data)
  40  */
  41 static struct GNUNET_DATACACHE_Handle *datacache;
  42
  43
  44 /**
  45  * Handle a datum we've received from another peer.  Cache if
  46  * possible.
  47  *
  48  * @param expiration when will the reply expire
  49  * @param key the query this reply is for
  50  * @param put_path_length number of peers in 'put_path'
  51  * @param put_path path the reply took on put
  52  * @param type type of the reply
  53  * @param data_size number of bytes in 'data'
  54  * @param data application payload data
  55  */
  56 void
  57 GDS_DATACACHE_handle_put (struct GNUNET_TIME_Absolute expiration,
  58                           const struct GNUNET_HashCode * key,
  59                           unsigned int put_path_length,
  60                           const struct GNUNET_PeerIdentity *put_path,
  61                           enum GNUNET_BLOCK_Type type, size_t data_size,
  62                           const void *data)
  63 {
  64   int r;
  65
  66   if (NULL == datacache)
  67   {
  68     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
  69                 _("%s request received, but have no datacache!\n"), "PUT");
  70     return;
  71   }
  72   if (data_size >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
  73   {
  74     GNUNET_break (0);
  75     return;
  76   }
  77   /* Put size is actual data size plus struct overhead plus path length (if any) */
  78   GNUNET_STATISTICS_update (GDS_stats,
  79                             gettext_noop ("# ITEMS stored in datacache"), 1,
  80                             GNUNET_NO);
  81   r = GNUNET_DATACACHE_put (datacache, key, data_size, data, type, expiration,
  82                             put_path_length, put_path);
  83   LOG (GNUNET_ERROR_TYPE_DEBUG,
  84        "DATACACHE PUT for key %s [%u] completed (%d) after %u hops\n",
  85        GNUNET_h2s (key), data_size, r, put_path_length);
  86 }
  87
  88 /**
  89  * List of peers in the get path.
  90  */
  91 struct GetPath
  92 {
  93   /**
  94    * Pointer to next item in the list
  95    */
  96   struct GetPath *next;
  97
  98   /**
  99    * Pointer to previous item in the list
 100    */
 101   struct GetPath *prev;
 102
 103   /**
 104    *  An element in the get path.
 105    */
 106   struct GNUNET_PeerIdentity peer;
 107 };
 108
 109
 110 /**
 111  * Context containing information about a GET request.
 112  */
 113 struct GetRequestContext
 114 {
 115   /**
 116    * extended query (see gnunet_block_lib.h).
 117    */
 118   const void *xquery;
 119
 120   /**
 121    * Bloomfilter to filter out duplicate replies (updated)
 122    */
 123   struct GNUNET_CONTAINER_BloomFilter **reply_bf;
 124
 125   /**
 126    * The key this request was about
 127    */
 128   struct GNUNET_HashCode key;
 129
 130   /**
 131    * Number of bytes in xquery.
 132    */
 133   size_t xquery_size;
 134
 135   /**
 136    * Mutator value for the reply_bf, see gnunet_block_lib.h
 137    */
 138   uint32_t reply_bf_mutator;
 139
 140   /**
 141    * Total number of peers in get path.
 142    */
 143   unsigned int get_path_length;
 144
 145   /**
 146    * Return value to give back.
 147    */
 148   enum GNUNET_BLOCK_EvaluationResult eval;
 149
 150   /**
 151    *
 152    */
 153   struct GNUNET_PeerIdentity source_peer;
 154
 155   /**
 156    *
 157    */
 158   unsigned int current_trail_index;
 159
 160   /**
 161    *
 162    */
 163   struct GNUNET_PeerIdentity next_hop;
 164
 165   /**
 166    * Head of trail to reach this finger.
 167    */
 168   struct GetPath *head;
 169
 170   /**
 171    * Tail of trail to reach this finger.
 172    */
 173   struct GetPath *tail;
 174   /* get_path */
 175 };
 176
 177
 178 /**
 179  * Iterator for local get request results,
 180  *
 181  * @param cls closure for iterator, a DatacacheGetContext
 182  * @param exp when does this value expire?
 183  * @param key the key this data is stored under
 184  * @param size the size of the data identified by key
 185  * @param data the actual data
 186  * @param type the type of the data
 187  * @param put_path_length number of peers in 'put_path'
 188  * @param put_path path the reply took on put
 189  * @return GNUNET_OK to continue iteration, anything else
 190  * to stop iteration.
 191  */
 192 static int
 193 datacache_get_iterator (void *cls,
 194                         const struct GNUNET_HashCode * key, size_t size,
 195                         const char *data, enum GNUNET_BLOCK_Type type,
 196                         struct GNUNET_TIME_Absolute exp,
 197                         unsigned int put_path_length,
 198                         const struct GNUNET_PeerIdentity *put_path)
 199 {
 200   struct GetRequestContext *ctx = cls;
 201   enum GNUNET_BLOCK_EvaluationResult eval;
 202
 203   eval =
 204       GNUNET_BLOCK_evaluate (GDS_block_context, type, key, ctx->reply_bf,
 205                              ctx->reply_bf_mutator, ctx->xquery,
 206                              ctx->xquery_size, data, size);
 207   LOG (GNUNET_ERROR_TYPE_DEBUG,
 208        "Found reply for query %s in datacache, evaluation result is %d\n",
 209        GNUNET_h2s (key), (int) eval);
 210   ctx->eval = eval;
 211   switch (eval)
 212   {
 213   case GNUNET_BLOCK_EVALUATION_OK_MORE:
 214   case GNUNET_BLOCK_EVALUATION_OK_LAST:
 215     /* forward to local clients */
 216     GNUNET_STATISTICS_update (GDS_stats,
 217                               gettext_noop
 218                               ("# Good RESULTS found in datacache"), 1,
 219                               GNUNET_NO);
 220     struct GNUNET_PeerIdentity *get_path;
 221     get_path = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
 222     struct GetPath *iterator;
 223     iterator = ctx->head;
 224     int i = 0;
 225     while (i < ctx->get_path_length)
 226     {
 227       memcpy (&get_path[i], &(iterator->peer), sizeof (struct GNUNET_PeerIdentity));
 228       i++;
 229       iterator = iterator->next;
 230     }
 231     GDS_NEIGHBOURS_send_get_result (exp, key, put_path_length, put_path,
 232                                     type, size, data, get_path, ctx->get_path_length,
 233                                     ctx->current_trail_index, &(ctx->next_hop),
 234                                     &(ctx->source_peer));
 235
 236     /* forward to other peers */
 237     GDS_ROUTING_process (type, exp, key, put_path_length, put_path, 0, NULL,
 238                          data, size);
 239     break;
 240   case GNUNET_BLOCK_EVALUATION_OK_DUPLICATE:
 241     GNUNET_STATISTICS_update (GDS_stats,
 242                               gettext_noop
 243                               ("# Duplicate RESULTS found in datacache"), 1,
 244                               GNUNET_NO);
 245     break;
 246   case GNUNET_BLOCK_EVALUATION_RESULT_INVALID:
 247     GNUNET_STATISTICS_update (GDS_stats,
 248                               gettext_noop
 249                               ("# Invalid RESULTS found in datacache"), 1,
 250                               GNUNET_NO);
 251     break;
 252   case GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT:
 253     GNUNET_STATISTICS_update (GDS_stats,
 254                               gettext_noop
 255                               ("# Irrelevant RESULTS found in datacache"), 1,
 256                               GNUNET_NO);
 257     break;
 258   case GNUNET_BLOCK_EVALUATION_REQUEST_VALID:
 259     GNUNET_break (0);
 260     break;
 261   case GNUNET_BLOCK_EVALUATION_REQUEST_INVALID:
 262     GNUNET_break_op (0);
 263     return GNUNET_SYSERR;
 264   case GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED:
 265     GNUNET_STATISTICS_update (GDS_stats,
 266                               gettext_noop
 267                               ("# Unsupported RESULTS found in datacache"), 1,
 268                               GNUNET_NO);
 269     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 270                 _("Unsupported block type (%u) in local response!\n"), type);
 271     break;
 272   }
 273   return (eval == GNUNET_BLOCK_EVALUATION_OK_LAST) ? GNUNET_NO : GNUNET_OK;
 274 }
 275
 276
 277 /**
 278  * Handle a GET request we've received from another peer.
 279  *
 280  * @param key the query
 281  * @param type requested data type
 282  * @param xquery extended query
 283  * @param xquery_size number of bytes in xquery
 284  * @param reply_bf where the reply bf is (to be) stored, possibly updated, can be NULL
 285  * @param reply_bf_mutator mutation value for reply_bf
 286  * @return evaluation result for the local replies
 287  * @get_path_length Total number of peers in get path
 288  * @get_path Peers in get path.
 289  */
 290 enum GNUNET_BLOCK_EvaluationResult
 291 GDS_DATACACHE_handle_get (const struct GNUNET_HashCode * key,
 292                           enum GNUNET_BLOCK_Type type, const void *xquery,
 293                           size_t xquery_size,
 294                           struct GNUNET_CONTAINER_BloomFilter **reply_bf,
 295                           uint32_t reply_bf_mutator,
 296                           uint32_t get_path_length,
 297                           struct GNUNET_PeerIdentity *get_path,
 298                           unsigned int current_trail_index,
 299                           struct GNUNET_PeerIdentity *next_hop,
 300                           struct GNUNET_PeerIdentity *source_peer)
 301 {
 302   struct GetRequestContext ctx;
 303   unsigned int r;
 304
 305   if (datacache == NULL)
 306     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 307   GNUNET_STATISTICS_update (GDS_stats,
 308                             gettext_noop ("# GET requests given to datacache"),
 309                             1, GNUNET_NO);
 310   ctx.eval = GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 311   ctx.key = *key;
 312   ctx.xquery = xquery;
 313   ctx.xquery_size = xquery_size;
 314   ctx.reply_bf = reply_bf;
 315   ctx.reply_bf_mutator = reply_bf_mutator;
 316   ctx.get_path_length = get_path_length;
 317   if (next_hop != NULL)
 318     memcpy (&(ctx.next_hop), next_hop, sizeof (struct GNUNET_PeerIdentity));
 319   ctx.current_trail_index = current_trail_index;
 320   /* FIXME: add the get path into ctx and then call gds_neighbours_handle_get*/
 321   int i = 0;
 322   while (i < get_path_length)
 323   {
 324     struct GetPath *element;
 325     element = GNUNET_malloc (sizeof (struct GetPath));
 326     element->next = NULL;
 327     element->prev = NULL;
 328
 329     memcpy (&(element->peer), &get_path[i], sizeof(struct GNUNET_PeerIdentity));
 330     GNUNET_CONTAINER_DLL_insert_tail(ctx.head, ctx.tail, element);
 331     i++;
 332   }
 333
 334   r = GNUNET_DATACACHE_get (datacache, key, type, &datacache_get_iterator,
 335                             &ctx);
 336   LOG (GNUNET_ERROR_TYPE_DEBUG,
 337        "DATACACHE GET for key %s completed (%d). %u results found.\n",
 338        GNUNET_h2s (key), ctx.eval, r);
 339   return ctx.eval;
 340 }
 341
 342
 343 /**
 344  * Initialize datacache subsystem.
 345  */
 346 void
 347 GDS_DATACACHE_init ()
 348 {
 349   datacache = GNUNET_DATACACHE_create (GDS_cfg, "dhtcache");
 350 }
 351
 352
 353 /**
 354  * Shutdown datacache subsystem.
 355  */
 356 void
 357 GDS_DATACACHE_done ()
 358 {
 359   if (datacache != NULL)
 360   {
 361     GNUNET_DATACACHE_destroy (datacache);
 362     datacache = NULL;
 363   }
 364 }
 365
 366
 367 /* end of gnunet-service-dht_datacache.c */