2 This file is part of GNUnet.
3 (C) 2010 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_block_lib.h
23 * @brief library for data block manipulation
24 * @author Christian Grothoff
26 #ifndef GNUNET_BLOCK_LIB_H
27 #define GNUNET_BLOCK_LIB_H
29 #include "gnunet_util_lib.h"
33 #if 0 /* keep Emacsens' auto-indent happy */
40 * Blocks in the datastore and the datacache must have a unique type.
42 enum GNUNET_BLOCK_Type
45 * Any type of block, used as a wildcard when searching. Should
46 * never be attached to a specific block.
48 GNUNET_BLOCK_TYPE_ANY = 0,
51 * Data block (leaf) in the CHK tree.
53 GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
56 * Inner block in the CHK tree.
58 GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
61 * Type of a block representing a keyword search result. Note that
62 * the values for KBLOCK, SBLOCK and NBLOCK must be consecutive.
64 GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
67 * Type of a block that is used to advertise content in a namespace.
69 GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
72 * Type of a block that is used to advertise a namespace.
74 GNUNET_BLOCK_TYPE_FS_NBLOCK = 5,
77 * Type of a block representing a block to be encoded on demand from disk.
78 * Should never appear on the network directly.
80 GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6,
83 * Type of a block that contains a HELLO for a peer (for
84 * DHT find-peer operations).
86 GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
91 GNUNET_BLOCK_TYPE_TEST = 8,
94 * Block for storing .gnunet-domains
96 GNUNET_BLOCK_TYPE_DNS = 10,
99 * Block for storing record data
101 GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11,
104 * Block for storing mesh peers
106 GNUNET_BLOCK_TYPE_MESH_PEER = 20,
109 * Block for finding peers by type
111 GNUNET_BLOCK_TYPE_MESH_PEER_BY_TYPE = 21,
114 * Block to store a mesh regex state
116 GNUNET_BLOCK_TYPE_MESH_REGEX = 22,
119 * Block to store a mesh regex accepting state
121 GNUNET_BLOCK_TYPE_MESH_REGEX_ACCEPT = 23
126 * Possible ways for how a block may relate to a query.
128 enum GNUNET_BLOCK_EvaluationResult
131 * Valid result, and there may be more.
133 GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
136 * Last possible valid result.
138 GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
141 * Valid result, but suppressed because it is a duplicate.
143 GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
146 * Block does not match query (invalid result)
148 GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
151 * Block does not match xquery (valid result, not relevant for the request)
153 GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4,
156 * Query is valid, no reply given.
158 GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10,
161 * Query format does not match block type (invalid query). For
162 * example, xquery not given or xquery_size not appropriate for
165 GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11,
168 * Specified block type not supported by this plugin.
170 GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20
175 * Handle to an initialized block library.
177 struct GNUNET_BLOCK_Context;
181 * Mingle hash with the mingle_number to produce different bits.
183 * @param in original hash code
184 * @param mingle_number number for hash permutation
185 * @param hc where to store the result.
188 GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode * in, uint32_t mingle_number,
189 struct GNUNET_HashCode * hc);
193 * Create a block context. Loads the block plugins.
195 * @param cfg configuration to use
196 * @return NULL on error
198 struct GNUNET_BLOCK_Context *
199 GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
203 * Destroy the block context.
205 * @param ctx context to destroy
208 GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
212 * Function called to validate a reply or a request. For
213 * request evaluation, simply pass "NULL" for the reply_block.
214 * Note that it is assumed that the reply has already been
215 * matched to the key (and signatures checked) as it would
216 * be done with the "get_key" function.
218 * @param ctx block contxt
219 * @param type block type
220 * @param query original query (hash)
221 * @param bf pointer to bloom filter associated with query; possibly updated (!)
222 * @param bf_mutator mutation value for bf
223 * @param xquery extrended query data (can be NULL, depending on type)
224 * @param xquery_size number of bytes in xquery
225 * @param reply_block response to validate
226 * @param reply_block_size number of bytes in reply block
227 * @return characterization of result
229 enum GNUNET_BLOCK_EvaluationResult
230 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
231 enum GNUNET_BLOCK_Type type,
232 const struct GNUNET_HashCode * query,
233 struct GNUNET_CONTAINER_BloomFilter **bf,
234 int32_t bf_mutator, const void *xquery,
235 size_t xquery_size, const void *reply_block,
236 size_t reply_block_size);
240 * Function called to obtain the key for a block.
242 * @param ctx block context
243 * @param type block type
244 * @param block block to get the key for
245 * @param block_size number of bytes in block
246 * @param key set to the key (query) for the given block
247 * @return GNUNET_YES on success,
248 * GNUNET_NO if the block is malformed
249 * GNUNET_SYSERR if type not supported
250 * (or if extracting a key from a block of this type does not work)
253 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
254 enum GNUNET_BLOCK_Type type, const void *block,
255 size_t block_size, struct GNUNET_HashCode * key);
260 * Construct a bloom filter that would filter out the given
263 * @param bf_mutator mutation value to use
264 * @param seen_results results already seen
265 * @param seen_results_count number of entries in 'seen_results'
266 * @return NULL if seen_results_count is 0, otherwise a BF
267 * that would match the given results.
269 struct GNUNET_CONTAINER_BloomFilter *
270 GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator,
271 const struct GNUNET_HashCode * seen_results,
272 unsigned int seen_results_count);
275 #if 0 /* keep Emacsens' auto-indent happy */
283 /* ifndef GNUNET_BLOCK_LIB_H */
285 /* end of gnunet_block_lib.h */