GNUnet  0.10.x
plugin_block_test.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2010 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 
56 static struct GNUNET_BLOCK_Group *
59  uint32_t nonce,
60  const void *raw_data,
61  size_t raw_data_size,
62  va_list va)
63 {
64  unsigned int bf_size;
65  const char *guard;
66 
67  guard = va_arg(va, const char *);
68  if (0 == strcmp(guard,
69  "seen-set-size"))
70  bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size(va_arg(va, unsigned int),
72  else if (0 == strcmp(guard,
73  "filter-size"))
74  bf_size = va_arg(va, unsigned int);
75  else
76  {
77  GNUNET_break(0);
78  bf_size = TEST_BF_SIZE;
79  }
80  GNUNET_break(NULL == va_arg(va, const char *));
82  bf_size,
84  type,
85  nonce,
86  raw_data,
87  raw_data_size);
88 }
89 
90 
109  struct GNUNET_BLOCK_Context *ctx,
110  enum GNUNET_BLOCK_Type type,
111  struct GNUNET_BLOCK_Group *group,
113  const struct GNUNET_HashCode *query,
114  const void *xquery,
115  size_t xquery_size,
116  const void *reply_block,
117  size_t reply_block_size)
118 {
119  struct GNUNET_HashCode chash;
120 
121  if (GNUNET_BLOCK_TYPE_TEST != type)
122  {
123  GNUNET_break(0);
125  }
126  if (0 != xquery_size)
127  {
128  GNUNET_break_op(0);
130  }
131  if (NULL == reply_block)
133  GNUNET_CRYPTO_hash(reply_block,
134  reply_block_size,
135  &chash);
136  if (GNUNET_YES ==
138  &chash))
141 }
142 
143 
155 static int
157  enum GNUNET_BLOCK_Type type,
158  const void *block,
159  size_t block_size,
160  struct GNUNET_HashCode *key)
161 {
162  /* always fails since there is no fixed relationship between
163  * keys and values for test values */
164  return GNUNET_SYSERR;
165 }
166 
167 
174 void *
176 {
177  static enum GNUNET_BLOCK_Type types[] =
178  {
180  GNUNET_BLOCK_TYPE_ANY /* end of list */
181  };
182  struct GNUNET_BLOCK_PluginFunctions *api;
183 
188  api->types = types;
189  return api;
190 }
191 
192 
199 void *
201 {
202  struct GNUNET_BLOCK_PluginFunctions *api = cls;
203 
204  GNUNET_free(api);
205  return NULL;
206 }
207 
208 /* end of plugin_block_test.c */
Handle to an initialized block library.
Definition: block.c:53
enum GNUNET_BLOCK_Type * types
0-terminated array of block types supported by this plugin.
Any type of block, used as a wildcard when searching.
#define TEST_BF_SIZE
How big is the BF we use for DHT blocks?
GNUNET_BLOCK_EvaluationFunction evaluate
Main function of a block plugin.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
struct GNUNET_BLOCK_Group * GNUNET_BLOCK_GROUP_bf_create(void *cls, size_t bf_size, unsigned int bf_k, enum GNUNET_BLOCK_Type type, uint32_t nonce, 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
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define BLOOMFILTER_K
Number of bits we set per entry in the bloomfilter.
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? Sized so that do not have to re-size the filter too often (to keep it cheap).
Definition: bg_bf.c:248
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
Valid result, but suppressed because it is a duplicate.
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:44
static int 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.
A 512-bit hashcode.
static struct GNUNET_BLOCK_Group * block_plugin_test_create_group(void *cls, enum GNUNET_BLOCK_Type type, uint32_t nonce, const void *raw_data, size_t raw_data_size, va_list va)
Create a new block group.
Valid result, and there may be more.
struct GNUNET_HashCode key
The key used in the DHT.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
GNUNET_BLOCK_GroupCreateFunction create_group
Create a block group to process a bunch of blocks in a shared context (i.e.
GNUNET_BLOCK_EvaluationResult
Possible ways for how a block may relate to a query.
static enum GNUNET_BLOCK_EvaluationResult block_plugin_test_evaluate(void *cls, struct GNUNET_BLOCK_Context *ctx, enum GNUNET_BLOCK_Type type, struct GNUNET_BLOCK_Group *group, enum GNUNET_BLOCK_EvaluationOptions eo, 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 or a request.
Specified block type not supported by this plugin.
GNUNET_BLOCK_GetKeyFunction get_key
Obtain the key for a given block (if possible).
Block for testing.
Query format does not match block type (invalid query).
Block group data.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
#define GNUNET_YES
Definition: gnunet_common.h:77
int 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:212
void * cls
Closure for all of the callbacks.
GNUNET_BLOCK_EvaluationOptions
Flags that can be set to control the evaluation.
Query is valid, no reply given.
void * libgnunet_plugin_block_test_done(void *cls)
Exit point from the plugin.
#define GNUNET_free(ptr)
Wrapper around free.
void * libgnunet_plugin_block_test_init(void *cls)
Entry point for the plugin.