GNUnet  0.19.3
plugin_block_template.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2010, 2021, 2022 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
27 #include "platform.h"
28 #include "gnunet_block_plugin.h"
29 #include "gnunet_block_group_lib.h"
30 
31 #define DEBUG_TEMPLATE GNUNET_EXTRA_LOGGING
32 
37 #define BLOOMFILTER_K 16
38 
39 
43 #define TEMPLATE_BF_SIZE 8
44 
45 
57 static struct GNUNET_BLOCK_Group *
60  const void *raw_data,
61  size_t raw_data_size,
62  va_list va)
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, unsigned
71  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 = TEMPLATE_BF_SIZE;
80  }
81  GNUNET_break (NULL == va_arg (va, const char *));
83  bf_size,
85  type,
86  raw_data,
87  raw_data_size);
88 }
89 
90 
101 static enum GNUNET_GenericReturnValue
103  enum GNUNET_BLOCK_Type type,
104  const struct GNUNET_HashCode *query,
105  const void *xquery,
106  size_t xquery_size)
107 {
108  return GNUNET_SYSERR;
109 }
110 
111 
121 static enum GNUNET_GenericReturnValue
123  enum GNUNET_BLOCK_Type type,
124  const void *block,
125  size_t block_size)
126 {
127  return GNUNET_SYSERR;
128 }
129 
130 
149  void *cls,
150  enum GNUNET_BLOCK_Type type,
151  struct GNUNET_BLOCK_Group *group,
152  const struct GNUNET_HashCode *query,
153  const void *xquery,
154  size_t xquery_size,
155  const void *reply_block,
156  size_t reply_block_size)
157 {
159 }
160 
161 
173 static enum GNUNET_GenericReturnValue
175  enum GNUNET_BLOCK_Type type,
176  const void *block,
177  size_t block_size,
178  struct GNUNET_HashCode *key)
179 {
180  return GNUNET_SYSERR;
181 }
182 
183 
189 void *
191 {
192  static const enum GNUNET_BLOCK_Type types[] = {
193  /* NOTE: insert supported block types here */
194  GNUNET_BLOCK_TYPE_ANY /* end of list */
195  };
196  struct GNUNET_BLOCK_PluginFunctions *api;
197 
204  api->types = types;
205  return api;
206 }
207 
208 
212 void *
214 {
215  struct GNUNET_BLOCK_PluginFunctions *api = cls;
216 
217  GNUNET_free (api);
218  return NULL;
219 }
220 
221 
222 /* end of plugin_block_template.c */
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.
struct GNUNET_HashCode key
The key used in the DHT.
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
API for block plugins.
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
GNUNET_BLOCK_ReplyEvaluationResult
Possible ways for how a block may relate to a query.
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
@ GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED
Specified block type not supported by any plugin.
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_SYSERR
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
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.
#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.
void * libgnunet_plugin_block_template_init(void *cls)
Entry point for the plugin.
void * libgnunet_plugin_block_template_done(void *cls)
Exit point from the plugin.
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 struct GNUNET_BLOCK_Group * block_plugin_template_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.
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.
Block group data.
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.
void * cls
Closure for all of the callbacks.
A 512-bit hashcode.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model