2 This file is part of GNUnet
3 (C) 2010 Christian Grothoff (and other contributing authors)
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.
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.
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.
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
29 #include "gnunet_block_plugin.h"
31 #define DEBUG_TEST GNUNET_EXTRA_LOGGING
35 * Number of bits we set per entry in the bloomfilter.
38 #define BLOOMFILTER_K 16
41 * Function called to validate a reply or a request. For
42 * request evaluation, simply pass "NULL" for the reply_block.
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
55 static enum GNUNET_BLOCK_EvaluationResult
56 block_plugin_test_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
57 const struct 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)
63 struct GNUNET_HashCode chash;
64 struct GNUNET_HashCode mhash;
66 if (type != GNUNET_BLOCK_TYPE_TEST)
67 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
71 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
73 if (NULL == reply_block)
74 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
78 GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
79 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
82 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
83 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
87 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
89 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
91 return GNUNET_BLOCK_EVALUATION_OK_MORE;
96 * Function called to obtain the key for a block.
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)
107 block_plugin_test_get_key (void *cls, enum GNUNET_BLOCK_Type type,
108 const void *block, size_t block_size,
109 struct GNUNET_HashCode * key)
111 /* always fails since there is no fixed relationship between
112 * keys and values for test values */
113 return GNUNET_SYSERR;
118 * Entry point for the plugin.
121 libgnunet_plugin_block_test_init (void *cls)
123 static enum GNUNET_BLOCK_Type types[] =
125 GNUNET_BLOCK_TYPE_TEST,
126 GNUNET_BLOCK_TYPE_ANY /* end of list */
128 struct GNUNET_BLOCK_PluginFunctions *api;
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;
139 * Exit point from the plugin.
142 libgnunet_plugin_block_test_done (void *cls)
144 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
150 /* end of plugin_block_test.c */