GNUnet debian-0.24.3-29-g453fda2cf
 
Loading...
Searching...
No Matches
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 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.
 

Functions

static struct GNUNET_BLOCK_Groupblock_plugin_dht_create_group (void *cls, enum GNUNET_BLOCK_Type type, 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_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_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 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.
 
void * libgnunet_plugin_block_dht_init (void *cls)
 Entry point for the plugin.
 
void * libgnunet_plugin_block_dht_done (void *cls)
 Exit point from the plugin.
 

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 34 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 40 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,
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
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 55 of file plugin_block_dht.c.

60{
61 unsigned int bf_size;
62 const char *guard;
63
64 guard = va_arg (va, const char *);
65 if (0 == strcmp (guard,
66 "seen-set-size"))
68 unsigned int)
69 ,
71 else if (0 == strcmp (guard,
72 "filter-size"))
73 bf_size = va_arg (va, unsigned int);
74 else
75 {
76 GNUNET_break (0);
77 bf_size = 8;
78 }
79 GNUNET_break (NULL == va_arg (va, const char *));
81 bf_size,
83 type,
84 raw_data,
85 raw_data_size);
86}
static uint32_t type
Type string converted to DNS type value.
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:268
struct GNUNET_BLOCK_Group * GNUNET_BLOCK_GROUP_bf_create(void *cls, size_t bf_size, unsigned int bf_k, enum GNUNET_BLOCK_Type type, 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:173
#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.

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_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 100 of file plugin_block_dht.c.

105{
106 switch (type)
107 {
109 if (0 != xquery_size)
110 {
111 GNUNET_break_op (0);
112 return GNUNET_NO;
113 }
114 return GNUNET_OK;
115 default:
116 GNUNET_break (0);
117 return GNUNET_SYSERR;
118 }
119}
@ GNUNET_BLOCK_TYPE_DHT_HELLO
Type of a block that contains a DHT-NG HELLO for a peer.
@ GNUNET_OK
@ GNUNET_NO
@ GNUNET_SYSERR
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.

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

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 132 of file plugin_block_dht.c.

136{
137 switch (type)
138 {
140 {
141 struct GNUNET_HELLO_Parser *b;
142 const struct GNUNET_PeerIdentity *pid;
143 struct GNUNET_HashCode h_pid;
144
146 block_size);
147 if (NULL == b)
148 {
149 GNUNET_break (0);
150 return GNUNET_NO;
151 }
153 NULL, NULL);
155 sizeof (*pid),
156 &h_pid);
158 return GNUNET_OK;
159 }
160 default:
161 GNUNET_break (0);
162 return GNUNET_SYSERR;
163 }
164}
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
void GNUNET_HELLO_parser_free(struct GNUNET_HELLO_Parser *parser)
Release resources of a builder.
Definition hello-uri.c:379
const struct GNUNET_PeerIdentity * GNUNET_HELLO_parser_iterate(const struct GNUNET_HELLO_Parser *parser, GNUNET_HELLO_UriCallback uc, void *uc_cls)
Iterate over URIs in a parser.
Definition hello-uri.c:975
struct GNUNET_HELLO_Parser * GNUNET_HELLO_parser_from_block(const void *block, size_t block_size)
Parse block.
Definition hello-uri.c:523
Context for parsing HELLOs.
Definition hello-uri.c:232
A 512-bit hashcode.
The identity of the host (wraps the signing key of the peer).

References GNUNET_BLOCK_TYPE_DHT_HELLO, GNUNET_break, GNUNET_CRYPTO_hash(), GNUNET_HELLO_parser_free(), GNUNET_HELLO_parser_from_block(), GNUNET_HELLO_parser_iterate(), GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, pid, 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 184 of file plugin_block_dht.c.

193{
194 switch (type)
195 {
197 {
198 struct GNUNET_HELLO_Parser *b;
199 const struct GNUNET_PeerIdentity *pid;
200 struct GNUNET_HashCode h_pid;
201
202 b = GNUNET_HELLO_parser_from_block (reply_block,
203 reply_block_size);
204 if (NULL == b)
205 {
207 }
209 NULL, NULL);
211 sizeof (*pid),
212 &h_pid);
214 if (GNUNET_YES ==
216 &h_pid))
219 }
220 default:
222 }
223}
enum GNUNET_GenericReturnValue 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:232
@ 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.
@ GNUNET_BLOCK_REPLY_IRRELEVANT
Block does not match xquery (valid result, not relevant for the request)
@ GNUNET_YES

References GNUNET_BLOCK_GROUP_bf_test_and_set(), GNUNET_BLOCK_REPLY_IRRELEVANT, GNUNET_BLOCK_REPLY_OK_DUPLICATE, GNUNET_BLOCK_REPLY_OK_MORE, GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED, GNUNET_BLOCK_TYPE_DHT_HELLO, GNUNET_CRYPTO_hash(), GNUNET_HELLO_parser_free(), GNUNET_HELLO_parser_from_block(), GNUNET_HELLO_parser_iterate(), GNUNET_YES, pid, 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_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 238 of file plugin_block_dht.c.

243{
244 switch (type)
245 {
247 {
248 struct GNUNET_HELLO_Parser *b;
249 const struct GNUNET_PeerIdentity *pid;
250
252 block_size);
253 if (NULL == b)
254 {
255 GNUNET_break (0);
256 memset (key,
257 0,
258 sizeof (*key));
259 return GNUNET_OK;
260 }
262 NULL, NULL);
264 sizeof (*pid),
265 key);
267 return GNUNET_OK;
268 }
269 default:
270 GNUNET_break (0);
271 return GNUNET_SYSERR;
272 }
273}
struct GNUNET_HashCode key
The key used in the DHT.

References GNUNET_BLOCK_TYPE_DHT_HELLO, GNUNET_break, GNUNET_CRYPTO_hash(), GNUNET_HELLO_parser_free(), GNUNET_HELLO_parser_from_block(), GNUNET_HELLO_parser_iterate(), GNUNET_OK, GNUNET_SYSERR, key, pid, 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:

◆ libgnunet_plugin_block_dht_init()

void * libgnunet_plugin_block_dht_init ( void *  cls)

Entry point for the plugin.

Definition at line 283 of file plugin_block_dht.c.

284{
285 static enum GNUNET_BLOCK_Type types[] = {
287 GNUNET_BLOCK_TYPE_ANY /* end of list */
288 };
290
297 api->types = types;
298 return api;
299}
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 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 struct GNUNET_BLOCK_Group * block_plugin_dht_create_group(void *cls, enum GNUNET_BLOCK_Type type, const void *raw_data, size_t raw_data_size, va_list va)
Create a new block group.
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_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 309 of file plugin_block_dht.c.

310{
311 struct GNUNET_BLOCK_PluginFunctions *api = cls;
312
313 GNUNET_free (api);
314 return NULL;
315}
#define GNUNET_free(ptr)
Wrapper around free.
void * cls
Closure for all of the callbacks.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.