2 This file is part of GNUnet
3 Copyright (C) 2010 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, 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"
30 #include "gnunet_block_group_lib.h"
33 * Number of bits we set per entry in the bloomfilter.
36 #define BLOOMFILTER_K 16
39 * How big is the BF we use for DHT blocks?
41 #define TEST_BF_SIZE 8
45 * Create a new block group.
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)
56 static struct GNUNET_BLOCK_Group *
57 block_plugin_test_create_group (void *cls,
58 enum GNUNET_BLOCK_Type type,
67 guard = va_arg (va, const char *);
68 if (0 == strcmp (guard,
70 bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned int),
72 else if (0 == strcmp (guard,
74 bf_size = va_arg (va, unsigned int);
78 bf_size = TEST_BF_SIZE;
80 GNUNET_break (NULL == va_arg (va, const char *));
81 return GNUNET_BLOCK_GROUP_bf_create (cls,
92 * Function called to validate a reply or a request. For
93 * request evaluation, simply pass "NULL" for the reply_block.
96 * @param ctx block context
97 * @param type block type
98 * @param group group to check against
99 * @param eo control flags
100 * @param query original query (hash)
101 * @param xquery extrended query data (can be NULL, depending on type)
102 * @param xquery_size number of bytes in @a xquery
103 * @param reply_block response to validate
104 * @param reply_block_size number of bytes in @a reply_block
105 * @return characterization of result
107 static enum GNUNET_BLOCK_EvaluationResult
108 block_plugin_test_evaluate (void *cls,
109 struct GNUNET_BLOCK_Context *ctx,
110 enum GNUNET_BLOCK_Type type,
111 struct GNUNET_BLOCK_Group *group,
112 enum GNUNET_BLOCK_EvaluationOptions eo,
113 const struct GNUNET_HashCode *query,
116 const void *reply_block,
117 size_t reply_block_size)
119 struct GNUNET_HashCode chash;
121 if ( GNUNET_BLOCK_TYPE_TEST != type)
124 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
126 if (0 != xquery_size)
129 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
131 if (NULL == reply_block)
132 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
133 GNUNET_CRYPTO_hash (reply_block,
137 GNUNET_BLOCK_GROUP_bf_test_and_set (group,
139 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
140 return GNUNET_BLOCK_EVALUATION_OK_MORE;
145 * Function called to obtain the key for a block.
148 * @param type block type
149 * @param block block to get the key for
150 * @param block_size number of bytes in @a block
151 * @param key set to the key (query) for the given block
152 * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
153 * (or if extracting a key from a block of this type does not work)
156 block_plugin_test_get_key (void *cls,
157 enum GNUNET_BLOCK_Type type,
160 struct GNUNET_HashCode *key)
162 /* always fails since there is no fixed relationship between
163 * keys and values for test values */
164 return GNUNET_SYSERR;
169 * Entry point for the plugin.
172 * @return the exported block API
175 libgnunet_plugin_block_test_init (void *cls)
177 static enum GNUNET_BLOCK_Type types[] =
179 GNUNET_BLOCK_TYPE_TEST,
180 GNUNET_BLOCK_TYPE_ANY /* end of list */
182 struct GNUNET_BLOCK_PluginFunctions *api;
184 api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
185 api->evaluate = &block_plugin_test_evaluate;
186 api->get_key = &block_plugin_test_get_key;
187 api->create_group = &block_plugin_test_create_group;
194 * Exit point from the plugin.
196 * @param cls the return value from #libgnunet_plugin_block_test_init
200 libgnunet_plugin_block_test_done (void *cls)
202 struct GNUNET_BLOCK_PluginFunctions *api = cls;
208 /* end of plugin_block_test.c */