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 #include "gnunet_block_group_lib.h"
  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  * How big is the BF we use for DHT blocks?
  40  */
  41 #define TEST_BF_SIZE 8
  42
  43
  44 /**
  45  * Create a new block group.
  46  *
  47  * @param ctx block context in which the block group is created
  48  * @param type type of the block for which we are creating the group
  49  * @param nonce random value used to seed the group creation
  50  * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
  51  * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
  52  * @param va variable arguments specific to @a type
  53  * @return block group handle, NULL if block groups are not supported
  54  *         by this @a type of block (this is not an error)
  55  */
  56 static struct GNUNET_BLOCK_Group *
  57 block_plugin_test_create_group (void *cls,
  58                                 enum GNUNET_BLOCK_Type type,
  59                                 uint32_t nonce,
  60                                 const void *raw_data,
  61                                 size_t raw_data_size,
  62                                 va_list va)
  63 {
  64   return GNUNET_BLOCK_GROUP_bf_create (cls,
  65                                        TEST_BF_SIZE,
  66                                        BLOOMFILTER_K,
  67                                        type,
  68                                        nonce,
  69                                        raw_data,
  70                                        raw_data_size);
  71 }
  72
  73
  74 /**
  75  * Function called to validate a reply or a request.  For
  76  * request evaluation, simply pass "NULL" for the reply_block.
  77  *
  78  * @param cls closure
  79  * @param type block type
  80  * @param group group to check against
  81  * @param eo control flags
  82  * @param query original query (hash)
  83  * @param xquery extrended query data (can be NULL, depending on type)
  84  * @param xquery_size number of bytes in @a xquery
  85  * @param reply_block response to validate
  86  * @param reply_block_size number of bytes in @a reply_block
  87  * @return characterization of result
  88  */
  89 static enum GNUNET_BLOCK_EvaluationResult
  90 block_plugin_test_evaluate (void *cls,
  91                             enum GNUNET_BLOCK_Type type,
  92                             struct GNUNET_BLOCK_Group *group,
  93                             enum GNUNET_BLOCK_EvaluationOptions eo,
  94                             const struct GNUNET_HashCode *query,
  95                             const void *xquery,
  96                             size_t xquery_size,
  97                             const void *reply_block,
  98                             size_t reply_block_size)
  99 {
 100   struct GNUNET_HashCode chash;
 101
 102   if ( GNUNET_BLOCK_TYPE_TEST != type)
 103   {
 104     GNUNET_break (0);
 105     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 106   }
 107   if (0 != xquery_size)
 108   {
 109     GNUNET_break_op (0);
 110     return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
 111   }
 112   if (NULL == reply_block)
 113     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 114   GNUNET_CRYPTO_hash (reply_block,
 115                       reply_block_size,
 116                       &chash);
 117   if (GNUNET_YES ==
 118       GNUNET_BLOCK_GROUP_bf_test_and_set (group,
 119                                           &chash))
 120     return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 121   return GNUNET_BLOCK_EVALUATION_OK_MORE;
 122 }
 123
 124
 125 /**
 126  * Function called to obtain the key for a block.
 127  *
 128  * @param cls closure
 129  * @param type block type
 130  * @param block block to get the key for
 131  * @param block_size number of bytes in @a block
 132  * @param key set to the key (query) for the given block
 133  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 134  *         (or if extracting a key from a block of this type does not work)
 135  */
 136 static int
 137 block_plugin_test_get_key (void *cls,
 138                            enum GNUNET_BLOCK_Type type,
 139                            const void *block,
 140                            size_t block_size,
 141                            struct GNUNET_HashCode *key)
 142 {
 143   /* always fails since there is no fixed relationship between
 144    * keys and values for test values */
 145   return GNUNET_SYSERR;
 146 }
 147
 148
 149 /**
 150  * Entry point for the plugin.
 151  *
 152  * @param cls NULL
 153  * @return the exported block API
 154  */
 155 void *
 156 libgnunet_plugin_block_test_init (void *cls)
 157 {
 158   static enum GNUNET_BLOCK_Type types[] =
 159   {
 160     GNUNET_BLOCK_TYPE_TEST,
 161     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 162   };
 163   struct GNUNET_BLOCK_PluginFunctions *api;
 164
 165   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 166   api->evaluate = &block_plugin_test_evaluate;
 167   api->get_key = &block_plugin_test_get_key;
 168   api->create_group = &block_plugin_test_create_group;
 169   api->types = types;
 170   return api;
 171 }
 172
 173
 174 /**
 175  * Exit point from the plugin.
 176  *
 177  * @param cls the return value from #libgnunet_plugin_block_test_init
 178  * @return NULL
 179  */
 180 void *
 181 libgnunet_plugin_block_test_done (void *cls)
 182 {
 183   struct GNUNET_BLOCK_PluginFunctions *api = cls;
 184
 185   GNUNET_free (api);
 186   return NULL;
 187 }
 188
 189 /* end of plugin_block_test.c */