aboutsummaryrefslogtreecommitdiff
path: root/src/block/plugin_block_test.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/block/plugin_block_test.c')
-rw-r--r--src/block/plugin_block_test.c271
1 files changed, 0 insertions, 271 deletions
diff --git a/src/block/plugin_block_test.c b/src/block/plugin_block_test.c
deleted file mode 100644
index 2e404bbc2..000000000
--- a/src/block/plugin_block_test.c
+++ /dev/null
@@ -1,271 +0,0 @@
1/*
2 This file is part of GNUnet
3 Copyright (C) 2010, 2021, 2022 GNUnet e.V.
4
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
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#include "gnunet_block_group_lib.h"
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 * How big is the BF we use for DHT blocks?
40 */
41#define TEST_BF_SIZE 8
42
43
44/**
45 * Create a new block group.
46 *
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 raw_data optional serialized prior state of the group, NULL if unavailable/fresh
50 * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
51 * @param va variable arguments specific to @a type
52 * @return block group handle, NULL if block groups are not supported
53 * by this @a type of block (this is not an error)
54 */
55static struct GNUNET_BLOCK_Group *
56block_plugin_test_create_group (void *cls,
57 enum GNUNET_BLOCK_Type type,
58 const void *raw_data,
59 size_t raw_data_size,
60 va_list va)
61{
62 unsigned int bf_size;
63 const char *guard;
64
65 guard = va_arg (va, const char *);
66 if (0 == strcmp (guard,
67 "seen-set-size"))
68 bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned
69 int),
70 BLOOMFILTER_K);
71 else if (0 == strcmp (guard,
72 "filter-size"))
73 bf_size = va_arg (va, unsigned int);
74 else
75 {
76 GNUNET_break (0);
77 bf_size = TEST_BF_SIZE;
78 }
79 GNUNET_break (NULL == va_arg (va, const char *));
80 return GNUNET_BLOCK_GROUP_bf_create (cls,
81 bf_size,
82 BLOOMFILTER_K,
83 type,
84 raw_data,
85 raw_data_size);
86}
87
88
89/**
90 * Function called to validate a query.
91 *
92 * @param cls closure
93 * @param ctx block context
94 * @param type block type
95 * @param query original query (hash)
96 * @param xquery extrended query data (can be NULL, depending on type)
97 * @param xquery_size number of bytes in @a xquery
98 * @return #GNUNET_OK if the query is fine, #GNUNET_NO if not, #GNUNET_SYSERR if @a type is not supported
99 */
100static enum GNUNET_GenericReturnValue
101block_plugin_test_check_query (void *cls,
102 enum GNUNET_BLOCK_Type type,
103 const struct GNUNET_HashCode *query,
104 const void *xquery,
105 size_t xquery_size)
106{
107 (void) cls;
108 (void) query;
109 (void) xquery;
110 if (GNUNET_BLOCK_TYPE_TEST != type)
111 {
112 GNUNET_break (0);
113 return GNUNET_SYSERR;
114 }
115 if (0 != xquery_size)
116 {
117 GNUNET_break_op (0);
118 return GNUNET_NO;
119 }
120 return GNUNET_OK;
121}
122
123
124/**
125 * Function called to validate a block for storage.
126 *
127 * @param cls closure
128 * @param type block type
129 * @param block block data to validate
130 * @param block_size number of bytes in @a block
131 * @return #GNUNET_OK if the block is fine, #GNUNET_NO if not, #GNUNET_SYSERR if @a type is not supported
132 */
133static enum GNUNET_GenericReturnValue
134block_plugin_test_check_block (void *cls,
135 enum GNUNET_BLOCK_Type type,
136 const void *block,
137 size_t block_size)
138{
139 (void) cls;
140 (void) block;
141 (void) block_size;
142 if (GNUNET_BLOCK_TYPE_TEST != type)
143 {
144 GNUNET_break (0);
145 return GNUNET_SYSERR;
146 }
147 return GNUNET_OK;
148}
149
150
151/**
152 * Function called to validate a reply to a request. Note that it is assumed
153 * that the reply has already been matched to the key (and signatures checked)
154 * as it would be done with the GetKeyFunction and the
155 * BlockEvaluationFunction.
156 *
157 * @param cls closure
158 * @param type block type
159 * @param group which block group to use for evaluation
160 * @param query original query (hash)
161 * @param xquery extrended query data (can be NULL, depending on type)
162 * @param xquery_size number of bytes in @a xquery
163 * @param reply_block response to validate
164 * @param reply_block_size number of bytes in @a reply_block
165 * @return characterization of result
166 */
167static enum GNUNET_BLOCK_ReplyEvaluationResult
168block_plugin_test_check_reply (void *cls,
169 enum GNUNET_BLOCK_Type type,
170 struct GNUNET_BLOCK_Group *group,
171 const struct GNUNET_HashCode *query,
172 const void *xquery,
173 size_t xquery_size,
174 const void *reply_block,
175 size_t reply_block_size)
176{
177 struct GNUNET_HashCode chash;
178
179 (void) cls;
180 (void) query;
181 (void) xquery;
182 (void) xquery_size;
183 if (GNUNET_BLOCK_TYPE_TEST != type)
184 {
185 GNUNET_break (0);
186 return GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED;
187 }
188 GNUNET_CRYPTO_hash (reply_block,
189 reply_block_size,
190 &chash);
191 if (GNUNET_YES ==
192 GNUNET_BLOCK_GROUP_bf_test_and_set (group,
193 &chash))
194 return GNUNET_BLOCK_REPLY_OK_DUPLICATE;
195 return GNUNET_BLOCK_REPLY_OK_MORE;
196}
197
198
199/**
200 * Function called to obtain the key for a block.
201 *
202 * @param cls closure
203 * @param type block type
204 * @param block block to get the key for
205 * @param block_size number of bytes in @a block
206 * @param key set to the key (query) for the given block
207 * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported, #GNUNET_NO if extracting a key from a block of this type does not work
208 */
209static enum GNUNET_GenericReturnValue
210block_plugin_test_get_key (void *cls,
211 enum GNUNET_BLOCK_Type type,
212 const void *block,
213 size_t block_size,
214 struct GNUNET_HashCode *key)
215{
216 (void) cls;
217 (void) block;
218 (void) block_size;
219 (void) key;
220 if (GNUNET_BLOCK_TYPE_TEST != type)
221 {
222 GNUNET_break (0);
223 return GNUNET_SYSERR;
224 }
225 return GNUNET_NO;
226}
227
228
229/**
230 * Entry point for the plugin.
231 *
232 * @param cls NULL
233 * @return the exported block API
234 */
235void *
236libgnunet_plugin_block_test_init (void *cls)
237{
238 static const enum GNUNET_BLOCK_Type types[] = {
239 GNUNET_BLOCK_TYPE_TEST,
240 GNUNET_BLOCK_TYPE_ANY /* end of list */
241 };
242 struct GNUNET_BLOCK_PluginFunctions *api;
243
244 api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
245 api->get_key = &block_plugin_test_get_key;
246 api->check_query = &block_plugin_test_check_query;
247 api->check_block = &block_plugin_test_check_block;
248 api->check_reply = &block_plugin_test_check_reply;
249 api->create_group = &block_plugin_test_create_group;
250 api->types = types;
251 return api;
252}
253
254
255/**
256 * Exit point from the plugin.
257 *
258 * @param cls the return value from #libgnunet_plugin_block_test_init
259 * @return NULL
260 */
261void *
262libgnunet_plugin_block_test_done (void *cls)
263{
264 struct GNUNET_BLOCK_PluginFunctions *api = cls;
265
266 GNUNET_free (api);
267 return NULL;
268}
269
270
271/* end of plugin_block_test.c */
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-24 16:43:05 +0000