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 * @author Christian Grothoff
25 * Library for data block manipulation
27 * @defgroup block Block library
28 * Library for data block manipulation
31 #ifndef GNUNET_BLOCK_LIB_H
32 #define GNUNET_BLOCK_LIB_H
34 #include "gnunet_util_lib.h"
38 #if 0 /* keep Emacsens' auto-indent happy */
45 * Blocks in the datastore and the datacache must have a unique type.
47 enum GNUNET_BLOCK_Type
50 * Any type of block, used as a wildcard when searching. Should
51 * never be attached to a specific block.
53 GNUNET_BLOCK_TYPE_ANY = 0,
56 * Data block (leaf) in the CHK tree.
58 GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
61 * Inner block in the CHK tree.
63 GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
66 * Legacy type, no longer in use.
68 GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
71 * Legacy type, no longer in use.
73 GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
76 * Legacy type, no longer in use.
78 GNUNET_BLOCK_TYPE_FS_NBLOCK = 5,
81 * Type of a block representing a block to be encoded on demand from disk.
82 * Should never appear on the network directly.
84 GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6,
87 * Type of a block that contains a HELLO for a peer (for
88 * DHT and CADET find-peer operations).
90 GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
95 GNUNET_BLOCK_TYPE_TEST = 8,
98 * Type of a block representing any type of search result
99 * (universal). Implemented in the context of #2564, replaces
100 * SBLOCKS, KBLOCKS and NBLOCKS.
102 GNUNET_BLOCK_TYPE_FS_UBLOCK = 9,
105 * Block for storing DNS exit service advertisements.
107 GNUNET_BLOCK_TYPE_DNS = 10,
110 * Block for storing record data
112 GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11,
115 * Block to store a cadet regex state
117 GNUNET_BLOCK_TYPE_REGEX = 22,
120 * Block to store a cadet regex accepting state
122 GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23
127 * Flags that can be set to control the evaluation.
129 enum GNUNET_BLOCK_EvaluationOptions
135 GNUNET_BLOCK_EO_NONE = 0,
138 * The block is obtained from the local database, skip cryptographic
141 GNUNET_BLOCK_EO_LOCAL_SKIP_CRYPTO = 1
146 * Possible ways for how a block may relate to a query.
148 enum GNUNET_BLOCK_EvaluationResult
151 * Valid result, and there may be more.
153 GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
156 * Last possible valid result.
158 GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
161 * Valid result, but suppressed because it is a duplicate.
163 GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
166 * Block does not match query (invalid result)
168 GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
171 * Block does not match xquery (valid result, not relevant for the request)
173 GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4,
176 * Query is valid, no reply given.
178 GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10,
181 * Query format does not match block type (invalid query). For
182 * example, xquery not given or xquery_size not appropriate for
185 GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11,
188 * Specified block type not supported by this plugin.
190 GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20
195 * Handle to an initialized block library.
197 struct GNUNET_BLOCK_Context;
201 * Mingle hash with the mingle_number to produce different bits.
203 * @param in original hash code
204 * @param mingle_number number for hash permutation
205 * @param hc where to store the result.
208 GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode *in,
209 uint32_t mingle_number,
210 struct GNUNET_HashCode *hc);
214 * Create a block context. Loads the block plugins.
216 * @param cfg configuration to use
217 * @return NULL on error
219 struct GNUNET_BLOCK_Context *
220 GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
224 * Destroy the block context.
226 * @param ctx context to destroy
229 GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
233 * Function called to validate a reply or a request. For
234 * request evaluation, simply pass "NULL" for the @a reply_block.
235 * Note that it is assumed that the reply has already been
236 * matched to the key (and signatures checked) as it would
237 * be done with the #GNUNET_BLOCK_get_key() function.
239 * @param ctx block contxt
240 * @param type block type
241 * @param eo evaluation options to control evaluation
242 * @param query original query (hash)
243 * @param bf pointer to bloom filter associated with query; possibly updated (!)
244 * @param bf_mutator mutation value for @a bf
245 * @param xquery extrended query data (can be NULL, depending on type)
246 * @param xquery_size number of bytes in @a xquery
247 * @param reply_block response to validate
248 * @param reply_block_size number of bytes in @a reply_block
249 * @return characterization of result
251 enum GNUNET_BLOCK_EvaluationResult
252 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
253 enum GNUNET_BLOCK_Type type,
254 enum GNUNET_BLOCK_EvaluationOptions eo,
255 const struct GNUNET_HashCode *query,
256 struct GNUNET_CONTAINER_BloomFilter **bf,
260 const void *reply_block,
261 size_t reply_block_size);
265 * Function called to obtain the key for a block.
267 * @param ctx block context
268 * @param type block type
269 * @param block block to get the key for
270 * @param block_size number of bytes in @a block
271 * @param key set to the key (query) for the given block
272 * @return #GNUNET_YES on success,
273 * #GNUNET_NO if the block is malformed
274 * #GNUNET_SYSERR if type not supported
275 * (or if extracting a key from a block of this type does not work)
278 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
279 enum GNUNET_BLOCK_Type type,
282 struct GNUNET_HashCode * key);
287 * Construct a bloom filter that would filter out the given
290 * @param bf_mutator mutation value to use
291 * @param seen_results results already seen
292 * @param seen_results_count number of entries in @a seen_results
293 * @return NULL if seen_results_count is 0, otherwise a BF
294 * that would match the given results.
296 struct GNUNET_CONTAINER_BloomFilter *
297 GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator,
298 const struct GNUNET_HashCode *seen_results,
299 unsigned int seen_results_count);
302 #if 0 /* keep Emacsens' auto-indent happy */
309 /* ifndef GNUNET_BLOCK_LIB_H */
312 /** @} */ /* end of group */
314 /* end of gnunet_block_lib.h */