src/block/plugin_block_test.c

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