GNUnet  0.11.x
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, uint32_t nonce, const void *raw_data, size_t raw_data_size, va_list va)
 Create a new block group. More...
 
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. 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 struct GNUNET_HashCode *query, 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,
uint32_t  nonce,
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
noncerandom value used to seed the group creation
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 57 of file plugin_block_test.c.

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
71  int),
73  else if (0 == strcmp (guard,
74  "filter-size"))
75  bf_size = va_arg (va, unsigned int);
76  else
77  {
78  GNUNET_break (0);
79  bf_size = TEST_BF_SIZE;
80  }
81  GNUNET_break (NULL == va_arg (va, const char *));
82  return GNUNET_BLOCK_GROUP_bf_create (cls,
83  bf_size,
85  type,
86  nonce,
87  raw_data,
88  raw_data_size);
89 }
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:250
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:174
#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_evaluate()

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

Function called to validate a reply or a request.

For request evaluation, simply pass "NULL" for the reply_block.

Parameters
clsclosure
ctxblock context
typeblock type
groupgroup to check against
eocontrol flags
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 57 of file plugin_block_test.c.

119 {
120  struct GNUNET_HashCode chash;
121 
123  {
124  GNUNET_break (0);
126  }
127  if (0 != xquery_size)
128  {
129  GNUNET_break_op (0);
131  }
132  if (NULL == reply_block)
134  GNUNET_CRYPTO_hash (reply_block,
135  reply_block_size,
136  &chash);
137  if (GNUNET_YES ==
139  &chash))
142 }
@ GNUNET_YES
Definition: gnunet_common.h:97
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:214
@ GNUNET_BLOCK_EVALUATION_REQUEST_INVALID
Query format does not match block type (invalid query).
@ GNUNET_BLOCK_EVALUATION_OK_MORE
Valid result, and there may be more.
@ GNUNET_BLOCK_EVALUATION_OK_DUPLICATE
Valid result, but suppressed because it is a duplicate.
@ GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED
Specified block type not supported by this plugin.
@ GNUNET_BLOCK_EVALUATION_REQUEST_VALID
Query is valid, no reply given.
@ GNUNET_BLOCK_TYPE_TEST
Block for testing.
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
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
A 512-bit hashcode.

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

Definition at line 57 of file plugin_block_test.c.

162 {
164  {
165  GNUNET_break (0);
166  return GNUNET_SYSERR;
167  }
168  if (0 != xquery_size)
169  {
170  GNUNET_break_op (0);
171  return GNUNET_SYSERR;
172  }
174 }
@ GNUNET_SYSERR
Definition: gnunet_common.h:93

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 struct GNUNET_HashCode query,
const void *  block,
size_t  block_size 
)
static

Function called to validate a block for storage.

Parameters
clsclosure
typeblock type
querykey for the block (hash), must match exactly
blockblock data to validate
block_sizenumber of bytes in block
Returns
GNUNET_OK if the block is fine, GNUNET_NO if not

Definition at line 57 of file plugin_block_test.c.

193 {
195  {
196  GNUNET_break (0);
197  return GNUNET_SYSERR;
198  }
199  return GNUNET_OK;
200 }
@ GNUNET_OK
Definition: gnunet_common.h:95

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 57 of file plugin_block_test.c.

228 {
229  struct GNUNET_HashCode chash;
230 
232  {
233  GNUNET_break (0);
235  }
236  GNUNET_CRYPTO_hash (reply_block,
237  reply_block_size,
238  &chash);
239  if (GNUNET_YES ==
241  &chash))
244 }
@ 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.

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 (or if extracting a key from a block of this type does not work)

Definition at line 57 of file plugin_block_test.c.

264 {
265  /* always fails since there is no fixed relationship between
266  * keys and values for test values */
267  return GNUNET_SYSERR;
268 }

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 278 of file plugin_block_test.c.

279 {
280  static const enum GNUNET_BLOCK_Type types[] = {
282  GNUNET_BLOCK_TYPE_ANY /* end of list */
283  };
284  struct GNUNET_BLOCK_PluginFunctions *api;
285 
293  api->types = types;
294  return api;
295 }
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
@ GNUNET_BLOCK_TYPE_ANY
Any type of block, used as a wildcard when searching.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
static enum GNUNET_GenericReturnValue block_plugin_test_check_block(void *cls, enum GNUNET_BLOCK_Type type, const struct GNUNET_HashCode *query, const void *block, size_t block_size)
Function called to validate a block for storage.
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.
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_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.
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.
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.
GNUNET_BLOCK_EvaluationFunction evaluate
Main function of a block plugin.

References block_plugin_test_check_block(), block_plugin_test_check_query(), block_plugin_test_check_reply(), block_plugin_test_create_group(), block_plugin_test_evaluate(), 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::evaluate, 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 305 of file plugin_block_test.c.

306 {
307  struct GNUNET_BLOCK_PluginFunctions *api = cls;
308 
309  GNUNET_free (api);
310  return NULL;
311 }
#define GNUNET_free(ptr)
Wrapper around free.
void * cls
Closure for all of the callbacks.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.