GNUnet  0.17.6
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"
30 #include "gnunet_block_group_lib.h"
31 
36 #define BLOOMFILTER_K 16
37 
41 #define TEST_BF_SIZE 8
42 
43 
55 static 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 *));
80  return GNUNET_BLOCK_GROUP_bf_create (cls,
81  bf_size,
83  type,
84  raw_data,
85  raw_data_size);
86 }
87 
88 
100 static enum GNUNET_GenericReturnValue
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;
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 
133 static enum GNUNET_GenericReturnValue
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;
143  {
144  GNUNET_break (0);
145  return GNUNET_SYSERR;
146  }
147  return GNUNET_OK;
148 }
149 
150 
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;
184  {
185  GNUNET_break (0);
187  }
188  GNUNET_CRYPTO_hash (reply_block,
189  reply_block_size,
190  &chash);
191  if (GNUNET_YES ==
193  &chash))
196 }
197 
198 
209 static enum GNUNET_GenericReturnValue
210 block_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;
221  {
222  GNUNET_break (0);
223  return GNUNET_SYSERR;
224  }
225  return GNUNET_NO;
226 }
227 
228 
235 void *
237 {
238  static const enum GNUNET_BLOCK_Type types[] = {
240  GNUNET_BLOCK_TYPE_ANY /* end of list */
241  };
242  struct GNUNET_BLOCK_PluginFunctions *api;
243 
250  api->types = types;
251  return api;
252 }
253 
254 
261 void *
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 */
struct GNUNET_HashCode key
The key used in the DHT.
API for block plugins.
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.
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.
Definition: gnunet_common.h:96
@ GNUNET_OK
Definition: gnunet_common.h:99
@ GNUNET_YES
@ GNUNET_NO
Definition: gnunet_common.h:98
@ GNUNET_SYSERR
Definition: gnunet_common.h:97
#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_done(void *cls)
Exit point from 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.
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 *cls, enum GNUNET_BLOCK_Type type, const void *raw_data, size_t raw_data_size, va_list va)
Create a new block group.
void * libgnunet_plugin_block_test_init(void *cls)
Entry point for the plugin.
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.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model