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

block plugin for DHT internals (right now, find-peer requests only); other plugins should be used to store "useful" data in the DHT (see fs block plugin) More...

#include "platform.h"
#include "gnunet_constants.h"
#include "gnunet_hello_lib.h"
#include "gnunet_hello_uri_lib.h"
#include "gnunet_block_plugin.h"
#include "gnunet_block_group_lib.h"
Include dependency graph for plugin_block_dht.c:

Go to the source code of this file.

Macros

#define DEBUG_DHT   GNUNET_EXTRA_LOGGING
 
#define BLOOMFILTER_K   16
 Number of bits we set per entry in the bloomfilter. More...
 

Functions

static struct GNUNET_BLOCK_Groupblock_plugin_dht_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_dht_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_dht_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_dht_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_dht_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_dht_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_block_dht_done (void *cls)
 Exit point from the plugin. More...
 

Detailed Description

block plugin for DHT internals (right now, find-peer requests only); other plugins should be used to store "useful" data in the DHT (see fs block plugin)

Author
Christian Grothoff

Definition in file plugin_block_dht.c.

Macro Definition Documentation

◆ DEBUG_DHT

#define DEBUG_DHT   GNUNET_EXTRA_LOGGING

Definition at line 35 of file plugin_block_dht.c.

◆ BLOOMFILTER_K

#define BLOOMFILTER_K   16

Number of bits we set per entry in the bloomfilter.

Do not change!

Definition at line 41 of file plugin_block_dht.c.

Function Documentation

◆ block_plugin_dht_create_group()

static struct GNUNET_BLOCK_Group* block_plugin_dht_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_dht.c.

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,
71  unsigned 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 = 8;
80  }
81  GNUNET_break (NULL == va_arg (va, const char *));
82  return GNUNET_BLOCK_GROUP_bf_create (cls,
83  bf_size,
85  type,
86  nonce,
87  raw_data,
88  raw_data_size);
89 }
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 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_dht_init().

Here is the caller graph for this function:

◆ block_plugin_dht_check_query()

static enum GNUNET_GenericReturnValue block_plugin_dht_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
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 57 of file plugin_block_dht.c.

108 {
109  switch (type)
110  {
112  if (0 != xquery_size)
113  {
114  GNUNET_break_op (0);
115  return GNUNET_NO;
116  }
117  return GNUNET_OK;
119  if (0 != xquery_size)
120  {
121  GNUNET_break_op (0);
122  return GNUNET_NO;
123  }
124  return GNUNET_OK;
125  default:
126  GNUNET_break (0);
127  return GNUNET_SYSERR;
128  }
129 }
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_NO
Definition: gnunet_common.h:94
@ GNUNET_SYSERR
Definition: gnunet_common.h:93
@ GNUNET_BLOCK_TYPE_DHT_HELLO
Type of a block that contains a HELLO for a peer.
@ GNUNET_BLOCK_TYPE_DHT_URL_HELLO
Type of a block that contains a DHT-NG HELLO for a peer.
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.

Referenced by libgnunet_plugin_block_dht_init().

Here is the caller graph for this function:

◆ block_plugin_dht_check_block()

static enum GNUNET_GenericReturnValue block_plugin_dht_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 57 of file plugin_block_dht.c.

146 {
147  switch (type)
148  {
150  {
151  const struct GNUNET_HELLO_Message *hello;
152  struct GNUNET_PeerIdentity pid;
153  const struct GNUNET_MessageHeader *msg;
154 
155  if (block_size < sizeof(struct GNUNET_MessageHeader))
156  {
157  GNUNET_break_op (0);
158  return GNUNET_NO;
159  }
160  msg = block;
161  if (block_size != ntohs (msg->size))
162  {
163  GNUNET_break_op (0);
164  return GNUNET_NO;
165  }
166  hello = block;
167  if (GNUNET_OK !=
168  GNUNET_HELLO_get_id (hello,
169  &pid))
170  {
171  GNUNET_break_op (0);
172  return GNUNET_NO;
173  }
174  return GNUNET_OK;
175  }
177  {
178  struct GNUNET_HELLO_Builder *b;
179  struct GNUNET_PeerIdentity pid;
180  struct GNUNET_HashCode h_pid;
181 
183  block_size);
184  if (NULL == b)
185  {
186  GNUNET_break (0);
187  return GNUNET_NO;
188  }
190  &pid,
191  NULL, NULL);
193  sizeof (pid),
194  &h_pid);
196  return GNUNET_OK;
197  }
198  default:
199  GNUNET_break (0);
200  return GNUNET_SYSERR;
201  }
202 }
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static struct GNUNET_PeerIdentity pid
Identity of the peer we transmit to / connect to.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:41
struct GNUNET_HELLO_Builder * GNUNET_HELLO_builder_from_block(const void *block, size_t block_size)
Parse block into builder.
Definition: hello-uri.c:353
void GNUNET_HELLO_builder_free(struct GNUNET_HELLO_Builder *builder)
Release resources of a builder.
Definition: hello-uri.c:312
void GNUNET_HELLO_builder_iterate(const struct GNUNET_HELLO_Builder *builder, struct GNUNET_PeerIdentity *pid, GNUNET_HELLO_UriCallback uc, void *uc_cls)
Iterate over URIs in a builder.
Definition: hello-uri.c:815
int GNUNET_HELLO_get_id(const struct GNUNET_HELLO_Message *hello, struct GNUNET_PeerIdentity *peer)
Get the peer identity from a HELLO message.
Definition: hello.c:671
Context for building (or parsing) HELLO URIs.
Definition: hello-uri.c:184
A HELLO message is used to exchange information about transports with other peers.
A 512-bit hashcode.
Header for all communications.
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.
The identity of the host (wraps the signing key of the peer).

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

Referenced by libgnunet_plugin_block_dht_init().

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

◆ block_plugin_dht_check_reply()

static enum GNUNET_BLOCK_ReplyEvaluationResult block_plugin_dht_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 57 of file plugin_block_dht.c.

231 {
232  switch (type)
233  {
235  {
236  const struct GNUNET_MessageHeader *msg = reply_block;
237  const struct GNUNET_HELLO_Message *hello = reply_block;
238  struct GNUNET_PeerIdentity pid;
239  struct GNUNET_HashCode phash;
240 
241  GNUNET_assert (reply_block_size >= sizeof(struct GNUNET_MessageHeader));
242  GNUNET_assert (reply_block_size == ntohs (msg->size));
244  GNUNET_HELLO_get_id (hello,
245  &pid));
247  sizeof(pid),
248  &phash);
249  if (GNUNET_YES ==
251  &phash))
254  }
256  {
257  struct GNUNET_HELLO_Builder *b;
258  struct GNUNET_PeerIdentity pid;
259  struct GNUNET_HashCode h_pid;
260 
261  b = GNUNET_HELLO_builder_from_block (reply_block,
262  reply_block_size);
263  GNUNET_assert (NULL != b);
265  &pid,
266  NULL, NULL);
268  sizeof (pid),
269  &h_pid);
271  if (GNUNET_YES ==
273  &h_pid))
276  }
277  default:
279  }
280 }
@ GNUNET_YES
Definition: gnunet_common.h:97
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
@ GNUNET_BLOCK_REPLY_OK_MORE
Valid result, and there may be more.
@ GNUNET_BLOCK_REPLY_OK_DUPLICATE
Valid result, but suppressed because it is a duplicate.
@ GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED
Specified block type not supported by any plugin.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.

Referenced by libgnunet_plugin_block_dht_init().

Here is the caller graph for this function:

◆ block_plugin_dht_get_key()

static enum GNUNET_GenericReturnValue block_plugin_dht_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 block
[out]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 57 of file plugin_block_dht.c.

300 {
301  switch (type)
302  {
304  {
305  const struct GNUNET_MessageHeader *msg;
306  const struct GNUNET_HELLO_Message *hello;
307  struct GNUNET_PeerIdentity *pid;
308 
309  if (block_size < sizeof(struct GNUNET_MessageHeader))
310  {
311  GNUNET_break_op (0);
312  memset (key,
313  0,
314  sizeof (*key));
315  return GNUNET_OK;
316  }
317  msg = block;
318  if (block_size != ntohs (msg->size))
319  {
320  GNUNET_break_op (0);
321  memset (key,
322  0,
323  sizeof (*key));
324  return GNUNET_OK;
325  }
326  hello = block;
327  memset (key,
328  0,
329  sizeof(*key));
330  pid = (struct GNUNET_PeerIdentity *) key;
331  if (GNUNET_OK !=
332  GNUNET_HELLO_get_id (hello,
333  pid))
334  {
335  GNUNET_break_op (0);
336  memset (key,
337  0,
338  sizeof (*key));
339  return GNUNET_OK;
340  }
341  return GNUNET_OK;
342  }
344  {
345  struct GNUNET_HELLO_Builder *b;
346  struct GNUNET_PeerIdentity pid;
347 
349  block_size);
350  if (NULL == b)
351  {
352  GNUNET_break (0);
353  memset (key,
354  0,
355  sizeof (*key));
356  return GNUNET_OK;
357  }
359  &pid,
360  NULL, NULL);
362  sizeof (pid),
363  key);
365  return GNUNET_OK;
366  }
367  default:
368  GNUNET_break (0);
369  return GNUNET_SYSERR;
370  }
371 }
struct GNUNET_HashCode key
The key used in the DHT.

Referenced by libgnunet_plugin_block_dht_init().

Here is the caller graph for this function:

◆ libgnunet_plugin_block_dht_init()

void* libgnunet_plugin_block_dht_init ( void *  cls)

Entry point for the plugin.

Definition at line 378 of file plugin_block_dht.c.

379 {
380  static enum GNUNET_BLOCK_Type types[] = {
383  GNUNET_BLOCK_TYPE_ANY /* end of list */
384  };
385  struct GNUNET_BLOCK_PluginFunctions *api;
386 
393  api->types = types;
394  return api;
395 }
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_BLOCK_ReplyEvaluationResult block_plugin_dht_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 struct GNUNET_BLOCK_Group * block_plugin_dht_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_GenericReturnValue block_plugin_dht_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.
static enum GNUNET_GenericReturnValue block_plugin_dht_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 enum GNUNET_GenericReturnValue block_plugin_dht_check_block(void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size)
Function called to validate a block for storage.
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_dht_check_block(), block_plugin_dht_check_query(), block_plugin_dht_check_reply(), block_plugin_dht_create_group(), block_plugin_dht_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_DHT_HELLO, GNUNET_BLOCK_TYPE_DHT_URL_HELLO, GNUNET_new, and GNUNET_BLOCK_PluginFunctions::types.

Here is the call graph for this function:

◆ libgnunet_plugin_block_dht_done()

void* libgnunet_plugin_block_dht_done ( void *  cls)

Exit point from the plugin.

Definition at line 402 of file plugin_block_dht.c.

403 {
404  struct GNUNET_BLOCK_PluginFunctions *api = cls;
405 
406  GNUNET_free (api);
407  return NULL;
408 }
#define GNUNET_free(ptr)
Wrapper around free.
void * cls
Closure for all of the callbacks.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.