GNUnet  0.10.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_BLOCK_EvaluationResult block_plugin_template_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_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.

Referenced by block_plugin_template_create_group().

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

Referenced by block_plugin_template_create_group().

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.

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

Referenced by libgnunet_plugin_block_template_init().

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 int),
74  else if (0 == strcmp (guard,
75  "filter-size"))
76  bf_size = va_arg (va, unsigned int);
77  else
78  {
79  GNUNET_break (0);
80  bf_size = TEMPLATE_BF_SIZE;
81  }
82  GNUNET_break (NULL == va_arg (va, const char *));
83  return GNUNET_BLOCK_GROUP_bf_create (cls,
84  bf_size,
86  type,
87  nonce,
88  raw_data,
89  raw_data_size);
90 }
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:175
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...
#define BLOOMFILTER_K
Number of bits we set per entry in the bloomfilter.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
#define TEMPLATE_BF_SIZE
How big is the BF we use for DHT blocks?
Here is the call graph for this function:
Here is the caller graph for this function:

◆ block_plugin_template_evaluate()

static enum GNUNET_BLOCK_EvaluationResult block_plugin_template_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
ctxcontext
typeblock type
groupblock group to use
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 110 of file plugin_block_template.c.

References GNUNET_BLOCK_EVALUATION_OK_DUPLICATE, GNUNET_BLOCK_EVALUATION_REQUEST_VALID, GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED, GNUNET_BLOCK_GROUP_bf_test_and_set(), GNUNET_CRYPTO_hash(), and GNUNET_YES.

Referenced by libgnunet_plugin_block_template_init().

120 {
121  struct GNUNET_HashCode chash;
122 
123  if (NULL == reply_block)
125  GNUNET_CRYPTO_hash (reply_block,
126  reply_block_size,
127  &chash);
128  if (GNUNET_YES ==
130  &chash))
133 }
Valid result, but suppressed because it is a duplicate.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:44
A 512-bit hashcode.
Specified block type not supported by this plugin.
#define GNUNET_YES
Definition: gnunet_common.h:80
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_template_get_key()

static int 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 148 of file plugin_block_template.c.

References GNUNET_SYSERR.

Referenced by libgnunet_plugin_block_template_init().

153 {
154  return GNUNET_SYSERR;
155 }
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
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 164 of file plugin_block_template.c.

References block_plugin_template_create_group(), block_plugin_template_evaluate(), block_plugin_template_get_key(), GNUNET_BLOCK_PluginFunctions::create_group, GNUNET_BLOCK_PluginFunctions::evaluate, GNUNET_BLOCK_PluginFunctions::get_key, GNUNET_BLOCK_TYPE_ANY, GNUNET_new, and GNUNET_BLOCK_PluginFunctions::types.

165 {
166  static enum GNUNET_BLOCK_Type types[] =
167  {
168  /* FIXME: insert supported block types here */
169  GNUNET_BLOCK_TYPE_ANY /* end of list */
170  };
171  struct GNUNET_BLOCK_PluginFunctions *api;
172 
177  api->types = types;
178  return api;
179 }
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 enum GNUNET_BLOCK_EvaluationResult block_plugin_template_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 int 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.
GNUNET_BLOCK_GroupCreateFunction create_group
Create a block group to process a bunch of blocks in a shared context (i.e.
GNUNET_BLOCK_GetKeyFunction get_key
Obtain the key for a given block (if possible).
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.
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 186 of file plugin_block_template.c.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.

187 {
188  struct GNUNET_BLOCK_PluginFunctions *api = cls;
189 
190  GNUNET_free (api);
191  return NULL;
192 }
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.