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_Group *	block_plugin_test_create_group (void *ctx, 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 *  ctx, enum GNUNET_BLOCK_Type  type, const void *  raw_data, size_t  raw_data_size, va_list  va  )

static

Create a new block group.

Parameters

ctx	block context in which the block group is created
type	type of the block for which we are creating the group
raw_data	optional serialized prior state of the group, NULL if unavailable/fresh
raw_data_size	number of bytes in raw_data, 0 if unavailable/fresh
va	variable 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.

{
  unsigned int bf_size;
  const char *guard;
 
  guard = va_arg (va, const char *);
  if (0 == strcmp (guard,
                   "seen-set-size"))
    bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned
                                                                   int),
                                                           BLOOMFILTER_K);
  else if (0 == strcmp (guard,
                        "filter-size"))
    bf_size = va_arg (va, unsigned int);
  else
  {
    GNUNET_break (0);
    bf_size = TEST_BF_SIZE;
  }
  GNUNET_break (NULL == va_arg (va, const char *));
  return GNUNET_BLOCK_GROUP_bf_create (ctx,
                                       bf_size,
                                       BLOOMFILTER_K,
                                       type,
                                       raw_data,
                                       raw_data_size);
}

References BLOOMFILTER_K, ctx, 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_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

cls	closure
type	block type
query	original query (hash)
xquery	extended query data (can be NULL, depending on type)
xquery_size	number 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 100 of file plugin_block_test.c.

{
  (void) cls;
  (void) query;
  (void) xquery;
  if (GNUNET_BLOCK_TYPE_TEST != type)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  if (0 != xquery_size)
  {
    GNUNET_break_op (0);
    return GNUNET_NO;
  }
  return GNUNET_OK;
}

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

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

cls	closure
type	block type
block	block data to validate
block_size	number 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 133 of file plugin_block_test.c.

{
  (void) cls;
  (void) block;
  (void) block_size;
  if (GNUNET_BLOCK_TYPE_TEST != type)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_BLOCK_TYPE_TEST, GNUNET_break, GNUNET_OK, GNUNET_SYSERR, and type.

Referenced by libgnunet_plugin_block_test_init().

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

cls	closure
type	block type
group	which block group to use for evaluation
query	original query (hash)
xquery	extrended query data (can be NULL, depending on type)
xquery_size	number of bytes in xquery
reply_block	response to validate
reply_block_size	number of bytes in reply_block

Returns

characterization of result

Definition at line 167 of file plugin_block_test.c.

{
  struct GNUNET_HashCode chash;
 
  (void) cls;
  (void) query;
  (void) xquery;
  (void) xquery_size;
  if (GNUNET_BLOCK_TYPE_TEST != type)
  {
    GNUNET_break (0);
    return GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED;
  }
  GNUNET_CRYPTO_hash (reply_block,
                      reply_block_size,
                      &chash);
  if (GNUNET_YES ==
      GNUNET_BLOCK_GROUP_bf_test_and_set (group,
                                          &chash))
    return GNUNET_BLOCK_REPLY_OK_DUPLICATE;
  return GNUNET_BLOCK_REPLY_OK_MORE;
}

References GNUNET_BLOCK_GROUP_bf_test_and_set(), GNUNET_BLOCK_REPLY_OK_DUPLICATE, GNUNET_BLOCK_REPLY_OK_MORE, GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED, GNUNET_BLOCK_TYPE_TEST, GNUNET_break, GNUNET_CRYPTO_hash(), GNUNET_YES, 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_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

cls	closure
type	block type
block	block to get the key for
block_size	number of bytes in block
key	set 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 209 of file plugin_block_test.c.

{
  (void) cls;
  (void) block;
  (void) block_size;
  (void) key;
  if (GNUNET_BLOCK_TYPE_TEST != type)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_NO;
}

References GNUNET_BLOCK_TYPE_TEST, GNUNET_break, GNUNET_NO, GNUNET_SYSERR, key, and type.

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

cls

NULL

Returns

the exported block API

Definition at line 237 of file plugin_block_test.c.

{
  static const enum GNUNET_BLOCK_Type types[] = {
    GNUNET_BLOCK_TYPE_TEST,
    GNUNET_BLOCK_TYPE_ANY       /* end of list */
  };
  struct GNUNET_BLOCK_PluginFunctions *api;
 
  api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
  api->get_key = &block_plugin_test_get_key;
  api->check_query = &block_plugin_test_check_query;
  api->check_block = &block_plugin_test_check_block;
  api->check_reply = &block_plugin_test_check_reply;
  api->create_group = &block_plugin_test_create_group;
  api->types = types;
  return api;
}

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

cls	the return value from libgnunet_plugin_block_test_init

Returns

NULL

Definition at line 265 of file plugin_block_test.c.

{
  struct GNUNET_BLOCK_PluginFunctions *api = cls;
 
  GNUNET_free (api);
  return NULL;
}

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.