src/block/plugin_block_test.c

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2010 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 block/plugin_block_test.c
  23  * @brief block plugin to test the DHT as a simple key-value store;
  24  *        this plugin simply accepts any (new) response for any key
  25  * @author Christian Grothoff
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_block_plugin.h"
  30
  31
  32 /**
  33  * Number of bits we set per entry in the bloomfilter.
  34  * Do not change!
  35  */
  36 #define BLOOMFILTER_K 16
  37
  38 /**
  39  * Function called to validate a reply or a request.  For
  40  * request evaluation, simply pass "NULL" for the reply_block.
  41  *
  42  * @param cls closure
  43  * @param type block type
  44  * @param eo control flags
  45  * @param query original query (hash)
  46  * @param bf pointer to bloom filter associated with query; possibly updated (!)
  47  * @param bf_mutator mutation value for @a bf
  48  * @param xquery extrended query data (can be NULL, depending on type)
  49  * @param xquery_size number of bytes in @a xquery
  50  * @param reply_block response to validate
  51  * @param reply_block_size number of bytes in @a reply_block
  52  * @return characterization of result
  53  */
  54 static enum GNUNET_BLOCK_EvaluationResult
  55 block_plugin_test_evaluate (void *cls,
  56                             enum GNUNET_BLOCK_Type type,
  57                             enum GNUNET_BLOCK_EvaluationOptions eo,
  58                             const struct GNUNET_HashCode *query,
  59                             struct GNUNET_CONTAINER_BloomFilter **bf,
  60                             int32_t bf_mutator,
  61                             const void *xquery,
  62                             size_t xquery_size,
  63                             const void *reply_block,
  64                             size_t reply_block_size)
  65 {
  66   struct GNUNET_HashCode chash;
  67   struct GNUNET_HashCode mhash;
  68
  69   if ( GNUNET_BLOCK_TYPE_TEST != type)
  70     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
  71   if (0 != xquery_size)
  72   {
  73     GNUNET_break_op (0);
  74     return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  75   }
  76   if (NULL == reply_block)
  77     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  78
  79   if (NULL != bf)
  80   {
  81     GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
  82     GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
  83     if (NULL != *bf)
  84     {
  85       if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
  86         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
  87     }
  88     else
  89     {
  90       *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
  91     }
  92     GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
  93   }
  94   return GNUNET_BLOCK_EVALUATION_OK_MORE;
  95 }
  96
  97
  98 /**
  99  * Function called to obtain the key for a block.
 100  *
 101  * @param cls closure
 102  * @param type block type
 103  * @param block block to get the key for
 104  * @param block_size number of bytes in @a block
 105  * @param key set to the key (query) for the given block
 106  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 107  *         (or if extracting a key from a block of this type does not work)
 108  */
 109 static int
 110 block_plugin_test_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 111                            const void *block, size_t block_size,
 112                            struct GNUNET_HashCode * key)
 113 {
 114   /* always fails since there is no fixed relationship between
 115    * keys and values for test values */
 116   return GNUNET_SYSERR;
 117 }
 118
 119
 120 /**
 121  * Entry point for the plugin.
 122  *
 123  * @param cls NULL
 124  * @return the exported block API
 125  */
 126 void *
 127 libgnunet_plugin_block_test_init (void *cls)
 128 {
 129   static enum GNUNET_BLOCK_Type types[] =
 130   {
 131     GNUNET_BLOCK_TYPE_TEST,
 132     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 133   };
 134   struct GNUNET_BLOCK_PluginFunctions *api;
 135
 136   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 137   api->evaluate = &block_plugin_test_evaluate;
 138   api->get_key = &block_plugin_test_get_key;
 139   api->types = types;
 140   return api;
 141 }
 142
 143
 144 /**
 145  * Exit point from the plugin.
 146  *
 147  * @param cls the return value from #libgnunet_plugin_block_test_init
 148  * @return NULL
 149  */
 150 void *
 151 libgnunet_plugin_block_test_done (void *cls)
 152 {
 153   struct GNUNET_BLOCK_PluginFunctions *api = cls;
 154
 155   GNUNET_free (api);
 156   return NULL;
 157 }
 158
 159 /* end of plugin_block_test.c */