GNUnet  0.17.6
Macros | Functions
plugin_block_test.c File Reference

block plugin to test the DHT as a simple key-value store; this plugin simply accepts any (new) response for any key More...

#include "platform.h"
#include "gnunet_block_plugin.h"
#include "gnunet_block_group_lib.h"
Include dependency graph for plugin_block_test.c:

Go to the source code of this file.

Macros

#define BLOOMFILTER_K   16
 Number of bits we set per entry in the bloomfilter. More...
 
#define TEST_BF_SIZE   8
 How big is the BF we use for DHT blocks? More...
 

Functions

static struct GNUNET_BLOCK_Groupblock_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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void * libgnunet_plugin_block_test_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_block_test_done (void *cls)
 Exit point from the plugin. More...
 

Detailed Description

block plugin to test the DHT as a simple key-value store; this plugin simply accepts any (new) response for any key

Author
Christian Grothoff

Definition in file plugin_block_test.c.

Macro Definition Documentation

◆ BLOOMFILTER_K

#define BLOOMFILTER_K   16

Number of bits we set per entry in the bloomfilter.

Do not change!

Definition at line 36 of file plugin_block_test.c.

◆ TEST_BF_SIZE

#define TEST_BF_SIZE   8

How big is the BF we use for DHT blocks?

Definition at line 41 of file plugin_block_test.c.

Function Documentation

◆ block_plugin_test_create_group()

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 
)
static

Create a new block group.

Parameters
ctxblock context in which the block group is created
typetype of the block for which we are creating the group
raw_dataoptional serialized prior state of the group, NULL if unavailable/fresh
raw_data_sizenumber of bytes in raw_data, 0 if unavailable/fresh
vavariable arguments specific to type
Returns
block group handle, NULL if block groups are not supported by this type of block (this is not an error)

Definition at line 56 of file plugin_block_test.c.

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 }
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
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
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
#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.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model

Referenced by libgnunet_plugin_block_test_init().

Here is the caller graph for this function:

◆ block_plugin_test_check_query()

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 
)
static

Function called to validate a query.

Parameters
clsclosure
ctxblock context
typeblock type
queryoriginal query (hash)
xqueryextrended query data (can be NULL, depending on type)
xquery_sizenumber of bytes in xquery
Returns
GNUNET_OK if the query is fine, GNUNET_NO if not, GNUNET_SYSERR if type is not supported

Definition at line 56 of file plugin_block_test.c.

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 }
@ GNUNET_BLOCK_TYPE_TEST
Block for testing.
@ GNUNET_OK
Definition: gnunet_common.h:99
@ 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.

Referenced by libgnunet_plugin_block_test_init().

Here is the caller graph for this function:

◆ block_plugin_test_check_block()

static enum GNUNET_GenericReturnValue block_plugin_test_check_block ( void *  cls,
enum GNUNET_BLOCK_Type  type,
const void *  block,
size_t  block_size 
)
static

Function called to validate a block for storage.

Parameters
clsclosure
typeblock type
blockblock data to validate
block_sizenumber of bytes in block
Returns
GNUNET_OK if the block is fine, GNUNET_NO if not, GNUNET_SYSERR if type is not supported

Definition at line 56 of file plugin_block_test.c.

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 }

References BLOOMFILTER_K, GNUNET_BLOCK_GROUP_bf_create(), GNUNET_BLOCK_GROUP_compute_bloomfilter_size(), GNUNET_break, TEST_BF_SIZE, and type.

Referenced by libgnunet_plugin_block_test_init().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ block_plugin_test_check_reply()

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 
)
static

Function called to validate a reply to a request.

Note that it is assumed that the reply has already been matched to the key (and signatures checked) as it would be done with the GetKeyFunction and the BlockEvaluationFunction.

Parameters
clsclosure
typeblock type
groupwhich block group to use for evaluation
queryoriginal query (hash)
xqueryextrended query data (can be NULL, depending on type)
xquery_sizenumber of bytes in xquery
reply_blockresponse to validate
reply_block_sizenumber of bytes in reply_block
Returns
characterization of result

Definition at line 56 of file plugin_block_test.c.

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 }
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
@ 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_YES
A 512-bit hashcode.

Referenced by libgnunet_plugin_block_test_init().

Here is the caller graph for this function:

◆ block_plugin_test_get_key()

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 
)
static

Function called to obtain the key for a block.

Parameters
clsclosure
typeblock type
blockblock to get the key for
block_sizenumber of bytes in block
keyset to the key (query) for the given block
Returns
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

Definition at line 56 of file plugin_block_test.c.

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 }
struct GNUNET_HashCode key
The key used in the DHT.

Referenced by libgnunet_plugin_block_test_init().

Here is the caller graph for this function:

◆ libgnunet_plugin_block_test_init()

void* libgnunet_plugin_block_test_init ( void *  cls)

Entry point for the plugin.

Parameters
clsNULL
Returns
the exported block API

Definition at line 236 of file plugin_block_test.c.

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 }
GNUNET_BLOCK_Type
WARNING: This header is generated! In order to add DHT block types, you must register them in GANA,...
@ GNUNET_BLOCK_TYPE_ANY
Identifier for any block.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
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.
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.
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.

References block_plugin_test_check_block(), block_plugin_test_check_query(), block_plugin_test_check_reply(), block_plugin_test_create_group(), block_plugin_test_get_key(), GNUNET_BLOCK_PluginFunctions::check_block, GNUNET_BLOCK_PluginFunctions::check_query, GNUNET_BLOCK_PluginFunctions::check_reply, GNUNET_BLOCK_PluginFunctions::create_group, GNUNET_BLOCK_PluginFunctions::get_key, GNUNET_BLOCK_TYPE_ANY, GNUNET_BLOCK_TYPE_TEST, GNUNET_new, and GNUNET_BLOCK_PluginFunctions::types.

Here is the call graph for this function:

◆ libgnunet_plugin_block_test_done()

void* libgnunet_plugin_block_test_done ( void *  cls)

Exit point from the plugin.

Parameters
clsthe return value from libgnunet_plugin_block_test_init
Returns
NULL

Definition at line 262 of file plugin_block_test.c.

263 {
264  struct GNUNET_BLOCK_PluginFunctions *api = cls;
265 
266  GNUNET_free (api);
267  return NULL;
268 }
#define GNUNET_free(ptr)
Wrapper around free.
void * cls
Closure for all of the callbacks.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.