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
  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 query original query (hash)
  45  * @param bf pointer to bloom filter associated with query; possibly updated (!)
  46  * @param bf_mutator mutation value for @a bf
  47  * @param xquery extrended query data (can be NULL, depending on type)
  48  * @param xquery_size number of bytes in @a xquery
  49  * @param reply_block response to validate
  50  * @param reply_block_size number of bytes in @a reply_block
  51  * @return characterization of result
  52  */
  53 static enum GNUNET_BLOCK_EvaluationResult
  54 block_plugin_test_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
  55                             const struct GNUNET_HashCode * query,
  56                             struct GNUNET_CONTAINER_BloomFilter **bf,
  57                             int32_t bf_mutator, const void *xquery,
  58                             size_t xquery_size, const void *reply_block,
  59                             size_t reply_block_size)
  60 {
  61   struct GNUNET_HashCode chash;
  62   struct GNUNET_HashCode mhash;
  63
  64   if ( GNUNET_BLOCK_TYPE_TEST != type)
  65     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
  66   if (0 != xquery_size)
  67   {
  68     GNUNET_break_op (0);
  69     return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  70   }
  71   if (NULL == reply_block)
  72     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  73
  74   if (NULL != bf)
  75   {
  76     GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
  77     GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
  78     if (NULL != *bf)
  79     {
  80       if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
  81         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
  82     }
  83     else
  84     {
  85       *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
  86     }
  87     GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
  88   }
  89   return GNUNET_BLOCK_EVALUATION_OK_MORE;
  90 }
  91
  92
  93 /**
  94  * Function called to obtain the key for a block.
  95  *
  96  * @param cls closure
  97  * @param type block type
  98  * @param block block to get the key for
  99  * @param block_size number of bytes in @a block
 100  * @param key set to the key (query) for the given block
 101  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 102  *         (or if extracting a key from a block of this type does not work)
 103  */
 104 static int
 105 block_plugin_test_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 106                            const void *block, size_t block_size,
 107                            struct GNUNET_HashCode * key)
 108 {
 109   /* always fails since there is no fixed relationship between
 110    * keys and values for test values */
 111   return GNUNET_SYSERR;
 112 }
 113
 114
 115 /**
 116  * Entry point for the plugin.
 117  *
 118  * @param cls NULL
 119  * @return the exported block API
 120  */
 121 void *
 122 libgnunet_plugin_block_test_init (void *cls)
 123 {
 124   static enum GNUNET_BLOCK_Type types[] =
 125   {
 126     GNUNET_BLOCK_TYPE_TEST,
 127     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 128   };
 129   struct GNUNET_BLOCK_PluginFunctions *api;
 130
 131   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 132   api->evaluate = &block_plugin_test_evaluate;
 133   api->get_key = &block_plugin_test_get_key;
 134   api->types = types;
 135   return api;
 136 }
 137
 138
 139 /**
 140  * Exit point from the plugin.
 141  *
 142  * @param cls the return value from #libgnunet_plugin_block_test_init
 143  * @return NULL
 144  */
 145 void *
 146 libgnunet_plugin_block_test_done (void *cls)
 147 {
 148   struct GNUNET_BLOCK_PluginFunctions *api = cls;
 149
 150   GNUNET_free (api);
 151   return NULL;
 152 }
 153
 154 /* end of plugin_block_test.c */