X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_block_lib.h;h=c85d3702bbc9bbea84c0aeba4e7514ddc8e2d942;hb=0d4f151374efb1972361c40b6624bf4fd0e3fcaa;hp=5f3bbda9689c1500c5e1ae8475021a4c149b47d5;hpb=61c39c60565b386e0e12ea669556b030e8cd7180;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_block_lib.h b/src/include/gnunet_block_lib.h index 5f3bbda96..c85d3702b 100644 --- a/src/include/gnunet_block_lib.h +++ b/src/include/gnunet_block_lib.h @@ -1,27 +1,32 @@ /* This file is part of GNUnet. - (C) 2010 Christian Grothoff (and other contributing authors) + Copyright (C) 2010 GNUnet e.V. - GNUnet is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 3, or (at your - option) any later version. + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . - You should have received a copy of the GNU General Public License - along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + SPDX-License-Identifier: AGPL3.0-or-later */ /** - * @file include/gnunet_block_lib.h - * @brief library for data block manipulation * @author Christian Grothoff + * + * @file + * Library for data block manipulation + * + * @defgroup block Block library + * Library for data block manipulation + * @{ */ #ifndef GNUNET_BLOCK_LIB_H #define GNUNET_BLOCK_LIB_H @@ -80,7 +85,7 @@ enum GNUNET_BLOCK_Type /** * Type of a block that contains a HELLO for a peer (for - * DHT find-peer operations). + * DHT and CADET find-peer operations). */ GNUNET_BLOCK_TYPE_DHT_HELLO = 7, @@ -107,19 +112,50 @@ enum GNUNET_BLOCK_Type GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11, /** - * Block for storing mesh peers + * Block type for a revocation message by which a key is revoked. */ - GNUNET_BLOCK_TYPE_MESH_PEER = 20, + GNUNET_BLOCK_TYPE_REVOCATION = 12, /** - * Block to store a mesh regex state + * Block to store a cadet regex state */ GNUNET_BLOCK_TYPE_REGEX = 22, /** - * Block to store a mesh regex accepting state + * Block to store a cadet regex accepting state + */ + GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23, + + /** + * Block for testing set/consensus. If first byte of the block + * is non-zero, the block is considered invalid. + */ + GNUNET_BLOCK_TYPE_SET_TEST = 24, + + /** + * Block type for consensus elements. + * Contains either special marker elements or a nested block. + */ + GNUNET_BLOCK_TYPE_CONSENSUS_ELEMENT = 25, +}; + + +/** + * Flags that can be set to control the evaluation. + */ +enum GNUNET_BLOCK_EvaluationOptions +{ + + /** + * Default behavior. + */ + GNUNET_BLOCK_EO_NONE = 0, + + /** + * The block is obtained from the local database, skip cryptographic + * checks. */ - GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23 + GNUNET_BLOCK_EO_LOCAL_SKIP_CRYPTO = 1 }; @@ -186,8 +222,9 @@ struct GNUNET_BLOCK_Context; * @param hc where to store the result. */ void -GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode * in, uint32_t mingle_number, - struct GNUNET_HashCode * hc); +GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode *in, + uint32_t mingle_number, + struct GNUNET_HashCode *hc); /** @@ -209,18 +246,73 @@ void GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx); +/** + * Handle for a group of elements that will be evaluated together. + * They must all be of the same type. A block group allows the + * plugin to keep some state across individual evaluations. + */ +struct GNUNET_BLOCK_Group; + + +/** + * Create a new block group. + * + * @param ctx block context in which the block group is created + * @param type type of the block for which we are creating the group + * @param nonce random value used to seed the group creation + * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh + * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh + * @param ... type-specific additional data, can be empty + * @return block group handle, NULL if block groups are not supported + * by this @a type of block (this is not an error) + */ +struct GNUNET_BLOCK_Group * +GNUNET_BLOCK_group_create (struct GNUNET_BLOCK_Context *ctx, + enum GNUNET_BLOCK_Type type, + uint32_t nonce, + const void *raw_data, + size_t raw_data_size, + ...); + + +/** + * Serialize state of a block group. + * + * @param bg group to serialize + * @param[out] nonce set to the nonce of the @a bg + * @param[out] raw_data set to the serialized state + * @param[out] raw_data_size set to the number of bytes in @a raw_data + * @return #GNUNET_OK on success, #GNUNET_NO if serialization is not + * supported, #GNUNET_SYSERR on error + */ +int +GNUNET_BLOCK_group_serialize (struct GNUNET_BLOCK_Group *bg, + uint32_t *nonce, + void **raw_data, + size_t *raw_data_size); + + +/** + * Destroy resources used by a block group. + * + * @param bg group to destroy, NULL is allowed + */ +void +GNUNET_BLOCK_group_destroy (struct GNUNET_BLOCK_Group *bg); + + /** * Function called to validate a reply or a request. For - * request evaluation, simply pass "NULL" for the reply_block. + * request evaluation, simply pass "NULL" for the @a reply_block. * Note that it is assumed that the reply has already been * matched to the key (and signatures checked) as it would - * be done with the "get_key" function. + * be done with the #GNUNET_BLOCK_get_key() function. * * @param ctx block contxt * @param type block type + * @param group block group to use for evaluation + * @param eo evaluation options to control evaluation * @param query original query (hash) - * @param bf pointer to bloom filter associated with query; possibly updated (!) - * @param bf_mutator mutation value for @a bf * @param xquery extrended query data (can be NULL, depending on type) * @param xquery_size number of bytes in @a xquery * @param reply_block response to validate @@ -230,10 +322,12 @@ GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx); enum GNUNET_BLOCK_EvaluationResult GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx, enum GNUNET_BLOCK_Type type, - const struct GNUNET_HashCode * query, - struct GNUNET_CONTAINER_BloomFilter **bf, - int32_t bf_mutator, const void *xquery, - size_t xquery_size, const void *reply_block, + 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); @@ -252,25 +346,44 @@ GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx, */ int GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx, - enum GNUNET_BLOCK_Type type, const void *block, - size_t block_size, struct GNUNET_HashCode * key); - + enum GNUNET_BLOCK_Type type, + const void *block, + size_t block_size, + struct GNUNET_HashCode *key); /** - * Construct a bloom filter that would filter out the given - * results. + * Update block group to filter out the given results. Note that the + * use of a hash for seen results implies that the caller magically + * knows how the specific block engine hashes for filtering + * duplicates, so this API may not always apply. * * @param bf_mutator mutation value to use * @param seen_results results already seen * @param seen_results_count number of entries in @a seen_results - * @return NULL if seen_results_count is 0, otherwise a BF - * that would match the given results. + * @return #GNUNET_SYSERR if not supported, #GNUNET_OK on success */ -struct GNUNET_CONTAINER_BloomFilter * -GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator, - const struct GNUNET_HashCode * seen_results, - unsigned int seen_results_count); +int +GNUNET_BLOCK_group_set_seen (struct GNUNET_BLOCK_Group *bg, + const struct GNUNET_HashCode *seen_results, + unsigned int seen_results_count); + + +/** + * Try merging two block groups. Afterwards, @a bg1 should remain + * valid and contain the rules from both @a bg1 and @bg2, and + * @a bg2 should be destroyed (as part of this call). The latter + * should happen even if merging is not supported. + * + * @param[in,out] bg1 first group to merge, is updated + * @param bg2 second group to merge, is destroyed + * @return #GNUNET_OK on success, + * #GNUNET_NO if merge failed due to different nonce + * #GNUNET_SYSERR if merging is not supported + */ +int +GNUNET_BLOCK_group_merge (struct GNUNET_BLOCK_Group *bg1, + struct GNUNET_BLOCK_Group *bg2); #if 0 /* keep Emacsens' auto-indent happy */ @@ -280,7 +393,9 @@ GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator, } #endif - /* ifndef GNUNET_BLOCK_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_block_lib.h */