GNUnet  0.20.0
Functions
plugin_block_setu_test.c File Reference

set test block, recognizes elements with non-zero first byte as invalid More...

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

Go to the source code of this file.

Functions

static enum GNUNET_GenericReturnValue block_plugin_setu_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_setu_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_setu_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_setu_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_setu_test_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_block_setu_test_done (void *cls)
 Exit point from the plugin. More...
 

Detailed Description

set test block, recognizes elements with non-zero first byte as invalid

Author
Christian Grothoff

Definition in file plugin_block_setu_test.c.

Function Documentation

◆ block_plugin_setu_test_check_query()

static enum GNUNET_GenericReturnValue block_plugin_setu_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 1 of file plugin_block_setu_test.c.

48 {
49  if (GNUNET_BLOCK_TYPE_SETU_TEST != type)
50  {
51  GNUNET_break (0);
52  return GNUNET_SYSERR;
53  }
54  if (0 != xquery_size)
55  {
56  GNUNET_break_op (0);
57  return GNUNET_NO;
58  }
59  return GNUNET_OK;
60 }
GNUNET_BLOCK_TYPE_SETU_TEST
@ GNUNET_BLOCK_TYPE_SETU_TEST
Block for testing set union.
Definition: gnunet_dht_block_types.h:145
GNUNET_OK
@ GNUNET_OK
Definition: gnunet_common.h:109
GNUNET_NO
@ GNUNET_NO
Definition: gnunet_common.h:108
GNUNET_SYSERR
@ GNUNET_SYSERR
Definition: gnunet_common.h:107
GNUNET_break_op
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
Definition: gnunet_common.h:1046
GNUNET_break
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
Definition: gnunet_common.h:1024
type
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Definition: testbed_api_underlay.c:133

Referenced by libgnunet_plugin_block_setu_test_init().

Here is the caller graph for this function:

◆ block_plugin_setu_test_check_block()

static enum GNUNET_GenericReturnValue block_plugin_setu_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

Definition at line 1 of file plugin_block_setu_test.c.

77 {
78  if (GNUNET_BLOCK_TYPE_SETU_TEST != type)
79  {
80  GNUNET_break (0);
81  return GNUNET_SYSERR;
82  }
83  if ( (NULL == block) ||
84  (0 == block_size) ||
85  (0 != ((char *) block)[0]) )
86  return GNUNET_NO;
87  return GNUNET_OK;
88 }

References GNUNET_BLOCK_TYPE_SETU_TEST, GNUNET_break, GNUNET_break_op, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, and type.

Referenced by libgnunet_plugin_block_setu_test_init().

Here is the caller graph for this function:

◆ block_plugin_setu_test_check_reply()

static enum GNUNET_BLOCK_ReplyEvaluationResult block_plugin_setu_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 1 of file plugin_block_setu_test.c.

116 {
117  (void) cls;
118  (void) xquery;
119  (void) xquery_size;
120  if (GNUNET_BLOCK_TYPE_SETU_TEST != type)
121  {
122  GNUNET_break (0);
123  return GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED;
124  }
125  if ( (NULL == reply_block) ||
126  (0 == reply_block_size) ||
127  (0 != ((char *) reply_block)[0]) )
128  GNUNET_assert (0);
129  return GNUNET_BLOCK_REPLY_OK_MORE;
130 }
GNUNET_BLOCK_REPLY_OK_MORE
@ GNUNET_BLOCK_REPLY_OK_MORE
Valid result, and there may be more.
Definition: gnunet_block_lib.h:74
GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED
@ GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED
Specified block type not supported by any plugin.
Definition: gnunet_block_lib.h:59
GNUNET_assert
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
Definition: gnunet_common.h:943

Referenced by libgnunet_plugin_block_setu_test_init().

Here is the caller graph for this function:

◆ block_plugin_setu_test_get_key()

static enum GNUNET_GenericReturnValue block_plugin_setu_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 1 of file plugin_block_setu_test.c.

150 {
151  if (GNUNET_BLOCK_TYPE_SETU_TEST != type)
152  {
153  GNUNET_break (0);
154  return GNUNET_SYSERR;
155  }
156  return GNUNET_NO;
157 }

Referenced by libgnunet_plugin_block_setu_test_init().

Here is the caller graph for this function:

◆ libgnunet_plugin_block_setu_test_init()

void* libgnunet_plugin_block_setu_test_init ( void *  cls)

Entry point for the plugin.

Definition at line 164 of file plugin_block_setu_test.c.

165 {
166  static enum GNUNET_BLOCK_Type types[] = {
167  GNUNET_BLOCK_TYPE_SETU_TEST,
168  GNUNET_BLOCK_TYPE_ANY /* end of list */
169  };
170  struct GNUNET_BLOCK_PluginFunctions *api;
171 
172  api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
173  api->get_key = &block_plugin_setu_test_get_key;
174  api->check_query = &block_plugin_setu_test_check_query;
175  api->check_block = &block_plugin_setu_test_check_block;
176  api->check_reply = &block_plugin_setu_test_check_reply;
177  api->types = types;
178  return api;
179 }
GNUNET_BLOCK_Type
GNUNET_BLOCK_Type
WARNING: This header is generated! In order to add DHT block types, you must register them in GANA,...
Definition: gnunet_dht_block_types.h:43
GNUNET_BLOCK_TYPE_ANY
@ GNUNET_BLOCK_TYPE_ANY
Identifier for any block.
Definition: gnunet_dht_block_types.h:49
GNUNET_new
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Definition: gnunet_common.h:1214
block_plugin_setu_test_check_query
static enum GNUNET_GenericReturnValue block_plugin_setu_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.
Definition: plugin_block_setu_test.c:43
block_plugin_setu_test_check_reply
static enum GNUNET_BLOCK_ReplyEvaluationResult block_plugin_setu_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.
Definition: plugin_block_setu_test.c:108
block_plugin_setu_test_get_key
static enum GNUNET_GenericReturnValue block_plugin_setu_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.
Definition: plugin_block_setu_test.c:145
block_plugin_setu_test_check_block
static enum GNUNET_GenericReturnValue block_plugin_setu_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.
Definition: plugin_block_setu_test.c:73
GNUNET_BLOCK_PluginFunctions
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
Definition: gnunet_block_plugin.h:254
GNUNET_BLOCK_PluginFunctions::types
enum GNUNET_BLOCK_Type * types
0-terminated array of block types supported by this plugin.
Definition: gnunet_block_plugin.h:263
GNUNET_BLOCK_PluginFunctions::check_query
GNUNET_BLOCK_QueryEvaluationFunction check_query
Check that a query is well-formed.
Definition: gnunet_block_plugin.h:279
GNUNET_BLOCK_PluginFunctions::check_block
GNUNET_BLOCK_BlockEvaluationFunction check_block
Check that a block is well-formed.
Definition: gnunet_block_plugin.h:284
GNUNET_BLOCK_PluginFunctions::get_key
GNUNET_BLOCK_GetKeyFunction get_key
Obtain the key for a given block (if possible).
Definition: gnunet_block_plugin.h:268
GNUNET_BLOCK_PluginFunctions::check_reply
GNUNET_BLOCK_ReplyEvaluationFunction check_reply
Check that a reply block matches a query.
Definition: gnunet_block_plugin.h:289

References block_plugin_setu_test_check_block(), block_plugin_setu_test_check_query(), block_plugin_setu_test_check_reply(), block_plugin_setu_test_get_key(), GNUNET_BLOCK_PluginFunctions::check_block, GNUNET_BLOCK_PluginFunctions::check_query, GNUNET_BLOCK_PluginFunctions::check_reply, GNUNET_BLOCK_PluginFunctions::get_key, GNUNET_BLOCK_TYPE_ANY, GNUNET_BLOCK_TYPE_SETU_TEST, GNUNET_new, and GNUNET_BLOCK_PluginFunctions::types.

Here is the call graph for this function:

◆ libgnunet_plugin_block_setu_test_done()

void* libgnunet_plugin_block_setu_test_done ( void *  cls)

Exit point from the plugin.

Definition at line 186 of file plugin_block_setu_test.c.

187 {
188  struct GNUNET_BLOCK_PluginFunctions *api = cls;
189 
190  GNUNET_free (api);
191  return NULL;
192 }
GNUNET_free
#define GNUNET_free(ptr)
Wrapper around free.
Definition: gnunet_common.h:1412
GNUNET_BLOCK_PluginFunctions::cls
void * cls
Closure for all of the callbacks.
Definition: gnunet_block_plugin.h:258

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.