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