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 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. 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.

Referenced by block_plugin_test_create_group().

◆ 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.

Referenced by block_plugin_test_create_group().

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.

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

Referenced by libgnunet_plugin_block_test_init().

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 *));
83  bf_size,
85  type,
86  nonce,
87  raw_data,
88  raw_data_size);
89 }
#define TEST_BF_SIZE
How big is the BF we use for DHT blocks?
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 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:250
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
void * cls
Closure for all of the callbacks.
Here is the call graph for this function:
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 109 of file plugin_block_test.c.

References GNUNET_BLOCK_EVALUATION_OK_DUPLICATE, GNUNET_BLOCK_EVALUATION_OK_MORE, GNUNET_BLOCK_EVALUATION_REQUEST_INVALID, GNUNET_BLOCK_EVALUATION_REQUEST_VALID, GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED, GNUNET_BLOCK_GROUP_bf_test_and_set(), GNUNET_BLOCK_TYPE_TEST, GNUNET_break, GNUNET_break_op, GNUNET_CRYPTO_hash(), and GNUNET_YES.

Referenced by libgnunet_plugin_block_test_init().

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 }
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
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:48
A 512-bit hashcode.
Valid result, and there may be more.
Specified block type not supported by this plugin.
Block for testing.
Query format does not match block type (invalid query).
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:214
Query is valid, no reply given.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ block_plugin_test_get_key()

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

References GNUNET_SYSERR.

Referenced by libgnunet_plugin_block_test_init().

162 {
163  /* always fails since there is no fixed relationship between
164  * keys and values for test values */
165  return GNUNET_SYSERR;
166 }
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
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 176 of file plugin_block_test.c.

References block_plugin_test_create_group(), block_plugin_test_evaluate(), block_plugin_test_get_key(), 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.

177 {
178  static enum GNUNET_BLOCK_Type types[] = {
180  GNUNET_BLOCK_TYPE_ANY /* end of list */
181  };
182  struct GNUNET_BLOCK_PluginFunctions *api;
183 
188  api->types = types;
189  return api;
190 }
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.
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.
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.
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.
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.
GNUNET_BLOCK_GroupCreateFunction create_group
Create a block group to process a bunch of blocks in a shared context (i.e.
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.
GNUNET_BLOCK_GetKeyFunction get_key
Obtain the key for a given block (if possible).
Block for testing.
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 200 of file plugin_block_test.c.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.

201 {
202  struct GNUNET_BLOCK_PluginFunctions *api = cls;
203 
204  GNUNET_free (api);
205  return NULL;
206 }
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
void * cls
Closure for all of the callbacks.
#define GNUNET_free(ptr)
Wrapper around free.