GNUnet  0.11.x
Macros | Functions
plugin_block_template.c File Reference

template for a block plugin More...

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

Go to the source code of this file.

Macros

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

Functions

static struct GNUNET_BLOCK_Groupblock_plugin_template_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_GenericReturnValue block_plugin_template_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_template_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_template_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_template_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_template_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_block_template_done (void *cls)
 Exit point from the plugin. More...
 

Detailed Description

template for a block plugin

Author
Christian Grothoff

Definition in file plugin_block_template.c.

Macro Definition Documentation

◆ DEBUG_TEMPLATE

#define DEBUG_TEMPLATE   GNUNET_EXTRA_LOGGING

Definition at line 31 of file plugin_block_template.c.

◆ BLOOMFILTER_K

#define BLOOMFILTER_K   16

Number of bits we set per entry in the bloomfilter.

Do not change!

Definition at line 37 of file plugin_block_template.c.

◆ TEMPLATE_BF_SIZE

#define TEMPLATE_BF_SIZE   8

How big is the BF we use for DHT blocks?

Definition at line 43 of file plugin_block_template.c.

Function Documentation

◆ block_plugin_template_create_group()

static struct GNUNET_BLOCK_Group* block_plugin_template_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 59 of file plugin_block_template.c.

65 {
66  unsigned int bf_size;
67  const char *guard;
68 
69  guard = va_arg (va, const char *);
70  if (0 == strcmp (guard,
71  "seen-set-size"))
72  bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned
73  int),
75  else if (0 == strcmp (guard,
76  "filter-size"))
77  bf_size = va_arg (va, unsigned int);
78  else
79  {
80  GNUNET_break (0);
81  bf_size = TEMPLATE_BF_SIZE;
82  }
83  GNUNET_break (NULL == va_arg (va, const char *));
84  return GNUNET_BLOCK_GROUP_bf_create (cls,
85  bf_size,
87  type,
88  nonce,
89  raw_data,
90  raw_data_size);
91 }
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 TEMPLATE_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_template_init().

Here is the caller graph for this function:

◆ block_plugin_template_check_query()

static enum GNUNET_GenericReturnValue block_plugin_template_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 not supported

Definition at line 59 of file plugin_block_template.c.

111 {
112  return GNUNET_SYSERR;
113 }
@ GNUNET_SYSERR
Definition: gnunet_common.h:93

Referenced by libgnunet_plugin_block_template_init().

Here is the caller graph for this function:

◆ block_plugin_template_check_block()

static enum GNUNET_GenericReturnValue block_plugin_template_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 not supported

Definition at line 59 of file plugin_block_template.c.

130 {
131  return GNUNET_SYSERR;
132 }

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

Referenced by libgnunet_plugin_block_template_init().

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

◆ block_plugin_template_check_reply()

static enum GNUNET_BLOCK_ReplyEvaluationResult block_plugin_template_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 59 of file plugin_block_template.c.

161 {
163 }
@ GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED
Specified block type not supported by any plugin.

Referenced by libgnunet_plugin_block_template_init().

Here is the caller graph for this function:

◆ block_plugin_template_get_key()

static enum GNUNET_GenericReturnValue block_plugin_template_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 59 of file plugin_block_template.c.

183 {
184  return GNUNET_SYSERR;
185 }

Referenced by libgnunet_plugin_block_template_init().

Here is the caller graph for this function:

◆ libgnunet_plugin_block_template_init()

void* libgnunet_plugin_block_template_init ( void *  cls)

Entry point for the plugin.

Parameters
clsa const struct GNUNET_CONFIGURATION_Handle

Definition at line 194 of file plugin_block_template.c.

195 {
196  static const enum GNUNET_BLOCK_Type types[] = {
197  /* NOTE: insert supported block types here */
198  GNUNET_BLOCK_TYPE_ANY /* end of list */
199  };
200  struct GNUNET_BLOCK_PluginFunctions *api;
201 
208  api->types = types;
209  return api;
210 }
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_GenericReturnValue block_plugin_template_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_template_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_template_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_template_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_template_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.
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_template_check_block(), block_plugin_template_check_query(), block_plugin_template_check_reply(), block_plugin_template_create_group(), block_plugin_template_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_new, and GNUNET_BLOCK_PluginFunctions::types.

Here is the call graph for this function:

◆ libgnunet_plugin_block_template_done()

void* libgnunet_plugin_block_template_done ( void *  cls)

Exit point from the plugin.

Definition at line 217 of file plugin_block_template.c.

218 {
219  struct GNUNET_BLOCK_PluginFunctions *api = cls;
220 
221  GNUNET_free (api);
222  return NULL;
223 }
#define GNUNET_free(ptr)
Wrapper around free.
void * cls
Closure for all of the callbacks.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.