GNUnet 0.22.1
plugin_block_test.c
Go to the documentation of this file.
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
28#include "platform.h"
29#include "gnunet_block_plugin.h"
31
36#define BLOOMFILTER_K 16
37
41#define TEST_BF_SIZE 8
42
43
55static struct GNUNET_BLOCK_Group *
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),
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 *));
81 bf_size,
83 type,
84 raw_data,
85 raw_data_size);
86}
87
88
102 const struct GNUNET_HashCode *query,
103 const void *xquery,
104 size_t xquery_size)
105{
106 (void) cls;
107 (void) query;
108 (void) xquery;
110 {
111 GNUNET_break (0);
112 return GNUNET_SYSERR;
113 }
114 if (0 != xquery_size)
115 {
116 GNUNET_break_op (0);
117 return GNUNET_NO;
118 }
119 return GNUNET_OK;
120}
121
122
135 const void *block,
136 size_t block_size)
137{
138 (void) cls;
139 (void) block;
140 (void) block_size;
142 {
143 GNUNET_break (0);
144 return GNUNET_SYSERR;
145 }
146 return GNUNET_OK;
147}
148
149
169 struct GNUNET_BLOCK_Group *group,
170 const struct GNUNET_HashCode *query,
171 const void *xquery,
172 size_t xquery_size,
173 const void *reply_block,
174 size_t reply_block_size)
175{
176 struct GNUNET_HashCode chash;
177
178 (void) cls;
179 (void) query;
180 (void) xquery;
181 (void) xquery_size;
183 {
184 GNUNET_break (0);
186 }
187 GNUNET_CRYPTO_hash (reply_block,
188 reply_block_size,
189 &chash);
190 if (GNUNET_YES ==
192 &chash))
195}
196
197
211 const void *block,
212 size_t block_size,
213 struct GNUNET_HashCode *key)
214{
215 (void) cls;
216 (void) block;
217 (void) block_size;
218 (void) key;
220 {
221 GNUNET_break (0);
222 return GNUNET_SYSERR;
223 }
224 return GNUNET_NO;
225}
226
227void *
229
236void *
238{
239 static const enum GNUNET_BLOCK_Type types[] = {
241 GNUNET_BLOCK_TYPE_ANY /* end of list */
242 };
244
251 api->types = types;
252 return api;
253}
254
255void *
257
264void *
266{
267 struct GNUNET_BLOCK_PluginFunctions *api = cls;
268
269 GNUNET_free (api);
270 return NULL;
271}
272
273
274/* end of plugin_block_test.c */
struct GNUNET_HashCode key
The key used in the DHT.
static struct GNUNET_FS_Handle * ctx
static uint32_t type
Type string converted to DNS type value.
API for block plugins.
enum GNUNET_GenericReturnValue GNUNET_BLOCK_GROUP_bf_test_and_set(struct GNUNET_BLOCK_Group *bg, const struct GNUNET_HashCode *hc)
Test if hc is contained in the Bloom filter of bg.
Definition: bg_bf.c:232
size_t GNUNET_BLOCK_GROUP_compute_bloomfilter_size(unsigned int entry_count, unsigned int k)
How many bytes should a bloomfilter be if we have already seen entry_count responses?...
Definition: bg_bf.c:268
GNUNET_BLOCK_ReplyEvaluationResult
Possible ways for how a block may relate to a query.
struct GNUNET_BLOCK_Group * GNUNET_BLOCK_GROUP_bf_create(void *cls, size_t bf_size, unsigned int bf_k, enum GNUNET_BLOCK_Type type, const void *raw_data, size_t raw_data_size)
Create a new block group that filters duplicates using a Bloom filter.
Definition: bg_bf.c:173
@ GNUNET_BLOCK_REPLY_OK_MORE
Valid result, and there may be more.
@ GNUNET_BLOCK_REPLY_OK_DUPLICATE
Valid result, but suppressed because it is a duplicate.
@ GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED
Specified block type not supported by any plugin.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:41
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_OK
@ GNUNET_YES
@ GNUNET_NO
@ GNUNET_SYSERR
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
void * libgnunet_plugin_block_test_init(void *cls)
Entry point for the plugin.
static enum GNUNET_BLOCK_ReplyEvaluationResult block_plugin_test_check_reply(void *cls, enum GNUNET_BLOCK_Type type, struct GNUNET_BLOCK_Group *group, const struct GNUNET_HashCode *query, const void *xquery, size_t xquery_size, const void *reply_block, size_t reply_block_size)
Function called to validate a reply to a request.
void * libgnunet_plugin_block_test_done(void *cls)
Exit point from the plugin.
static enum GNUNET_GenericReturnValue block_plugin_test_check_block(void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size)
Function called to validate a block for storage.
#define TEST_BF_SIZE
How big is the BF we use for DHT blocks?
#define BLOOMFILTER_K
Number of bits we set per entry in the bloomfilter.
static enum GNUNET_GenericReturnValue block_plugin_test_check_query(void *cls, enum GNUNET_BLOCK_Type type, const struct GNUNET_HashCode *query, const void *xquery, size_t xquery_size)
Function called to validate a query.
static enum GNUNET_GenericReturnValue block_plugin_test_get_key(void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size, struct GNUNET_HashCode *key)
Function called to obtain the key for a block.
static struct GNUNET_BLOCK_Group * block_plugin_test_create_group(void *ctx, enum GNUNET_BLOCK_Type type, const void *raw_data, size_t raw_data_size, va_list va)
Create a new block group.
GNUNET_BLOCK_Type
WARNING: This header is generated! In order to add DHT block types, you must register them in GANA,...
@ GNUNET_BLOCK_TYPE_TEST
Block for testing.
@ GNUNET_BLOCK_TYPE_ANY
Identifier for any block.
Block group data.
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
enum GNUNET_BLOCK_Type * types
0-terminated array of block types supported by this plugin.
GNUNET_BLOCK_QueryEvaluationFunction check_query
Check that a query is well-formed.
GNUNET_BLOCK_BlockEvaluationFunction check_block
Check that a block is well-formed.
GNUNET_BLOCK_GetKeyFunction get_key
Obtain the key for a given block (if possible).
GNUNET_BLOCK_ReplyEvaluationFunction check_reply
Check that a reply block matches a query.
GNUNET_BLOCK_GroupCreateFunction create_group
Create a block group to process a bunch of blocks in a shared context (i.e.
void * cls
Closure for all of the callbacks.
A 512-bit hashcode.