GNUnet  0.10.x
plugin_block_template.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2010 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 
58 static struct GNUNET_BLOCK_Group *
61  uint32_t nonce,
62  const void *raw_data,
63  size_t raw_data_size,
64  va_list va)
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 }
91 
92 
111  struct GNUNET_BLOCK_Context *ctx,
112  enum GNUNET_BLOCK_Type type,
113  struct GNUNET_BLOCK_Group *group,
115  const struct GNUNET_HashCode *query,
116  const void *xquery,
117  size_t xquery_size,
118  const void *reply_block,
119  size_t reply_block_size)
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 }
134 
135 
147 static int
149  enum GNUNET_BLOCK_Type type,
150  const void *block,
151  size_t block_size,
152  struct GNUNET_HashCode *key)
153 {
154  return GNUNET_SYSERR;
155 }
156 
157 
163 void *
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 }
180 
181 
185 void *
187 {
188  struct GNUNET_BLOCK_PluginFunctions *api = cls;
189 
190  GNUNET_free (api);
191  return NULL;
192 }
193 
194 /* end of plugin_block_template.c */
Handle to an initialized block library.
Definition: block.c:54
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.
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
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.
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...
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
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
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.
A 512-bit hashcode.
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.
struct GNUNET_HashCode key
The key used in the DHT.
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
GNUNET_BLOCK_GroupCreateFunction create_group
Create a block group to process a bunch of blocks in a shared context (i.e.
GNUNET_BLOCK_EvaluationResult
Possible ways for how a block may relate to a query.
#define BLOOMFILTER_K
Number of bits we set per entry in the bloomfilter.
Specified block type not supported by this plugin.
GNUNET_BLOCK_GetKeyFunction get_key
Obtain the key for a given block (if possible).
void * libgnunet_plugin_block_template_init(void *cls)
Entry point for the plugin.
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.
Block group data.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
#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
void * cls
Closure for all of the callbacks.
GNUNET_BLOCK_EvaluationOptions
Flags that can be set to control the evaluation.
#define TEMPLATE_BF_SIZE
How big is the BF we use for DHT blocks?
void * libgnunet_plugin_block_template_done(void *cls)
Exit point from the plugin.
Query is valid, no reply given.
#define GNUNET_free(ptr)
Wrapper around free.