2 This file is part of GNUnet
3 Copyright (C) 2010 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file block/plugin_block_template.c
23 * @brief template for a block plugin
24 * @author Christian Grothoff
28 #include "gnunet_block_plugin.h"
29 #include "gnunet_block_group_lib.h"
31 #define DEBUG_TEMPLATE GNUNET_EXTRA_LOGGING
34 * Number of bits we set per entry in the bloomfilter.
37 #define BLOOMFILTER_K 16
41 * How big is the BF we use for DHT blocks?
43 #define TEMPLATE_BF_SIZE 8
47 * Create a new block group.
49 * @param ctx block context in which the block group is created
50 * @param type type of the block for which we are creating the group
51 * @param nonce random value used to seed the group creation
52 * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
53 * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
54 * @param va variable arguments specific to @a type
55 * @return block group handle, NULL if block groups are not supported
56 * by this @a type of block (this is not an error)
58 static struct GNUNET_BLOCK_Group *
59 block_plugin_template_create_group (void *cls,
60 enum GNUNET_BLOCK_Type type,
69 guard = va_arg (va, const char *);
70 if (0 == strcmp (guard,
72 bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned int),
74 else if (0 == strcmp (guard,
76 bf_size = va_arg (va, unsigned int);
80 bf_size = TEMPLATE_BF_SIZE;
82 GNUNET_break (NULL == va_arg (va, const char *));
83 return GNUNET_BLOCK_GROUP_bf_create (cls,
94 * Function called to validate a reply or a request. For
95 * request evaluation, simply pass "NULL" for the reply_block.
99 * @param type block type
100 * @param group block group to use
101 * @param eo control flags
102 * @param query original query (hash)
103 * @param xquery extrended query data (can be NULL, depending on type)
104 * @param xquery_size number of bytes in xquery
105 * @param reply_block response to validate
106 * @param reply_block_size number of bytes in reply block
107 * @return characterization of result
109 static enum GNUNET_BLOCK_EvaluationResult
110 block_plugin_template_evaluate (void *cls,
111 struct GNUNET_BLOCK_Context *ctx,
112 enum GNUNET_BLOCK_Type type,
113 struct GNUNET_BLOCK_Group *group,
114 enum GNUNET_BLOCK_EvaluationOptions eo,
115 const struct GNUNET_HashCode *query,
118 const void *reply_block,
119 size_t reply_block_size)
121 struct GNUNET_HashCode chash;
123 if (NULL == reply_block)
124 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
125 GNUNET_CRYPTO_hash (reply_block,
129 GNUNET_BLOCK_GROUP_bf_test_and_set (group,
131 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
132 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
137 * Function called to obtain the key for a block.
140 * @param type block type
141 * @param block block to get the key for
142 * @param block_size number of bytes in block
143 * @param key set to the key (query) for the given block
144 * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
145 * (or if extracting a key from a block of this type does not work)
148 block_plugin_template_get_key (void *cls,
149 enum GNUNET_BLOCK_Type type,
152 struct GNUNET_HashCode *key)
154 return GNUNET_SYSERR;
159 * Entry point for the plugin.
161 * @param cls a `const struct GNUNET_CONFIGURATION_Handle`
164 libgnunet_plugin_block_template_init (void *cls)
166 static enum GNUNET_BLOCK_Type types[] =
168 /* FIXME: insert supported block types here */
169 GNUNET_BLOCK_TYPE_ANY /* end of list */
171 struct GNUNET_BLOCK_PluginFunctions *api;
173 api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
174 api->evaluate = &block_plugin_template_evaluate;
175 api->get_key = &block_plugin_template_get_key;
176 api->create_group = &block_plugin_template_create_group;
183 * Exit point from the plugin.
186 libgnunet_plugin_block_template_done (void *cls)
188 struct GNUNET_BLOCK_PluginFunctions *api = cls;
194 /* end of plugin_block_template.c */