src/include/gnunet_block_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010 Christian Grothoff (and other contributing authors)
   4
   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.
   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      General Public License for more details.
  14
  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.
  19 */
  20
  21 /**
  22  * @file include/gnunet_block_lib.h
  23  * @brief library for data block manipulation
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_BLOCK_LIB_H
  27 #define GNUNET_BLOCK_LIB_H
  28
  29 #include "gnunet_util_lib.h"
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38
  39 /**
  40  * Blocks in the datastore and the datacache must have a unique type.
  41  */
  42 enum GNUNET_BLOCK_Type
  43 {
  44     /**
  45      * Any type of block, used as a wildcard when searching.  Should
  46      * never be attached to a specific block.
  47      */
  48   GNUNET_BLOCK_TYPE_ANY = 0,
  49
  50     /**
  51      * Data block (leaf) in the CHK tree.
  52      */
  53   GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
  54
  55     /**
  56      * Inner block in the CHK tree.
  57      */
  58   GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
  59
  60     /**
  61      * Type of a block representing a keyword search result.  Note that
  62      * the values for KBLOCK, SBLOCK and NBLOCK must be consecutive.
  63      */
  64   GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
  65
  66     /**
  67      * Type of a block that is used to advertise content in a namespace.
  68      */
  69   GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
  70
  71     /**
  72      * Type of a block that is used to advertise a namespace.
  73      */
  74   GNUNET_BLOCK_TYPE_FS_NBLOCK = 5,
  75
  76     /**
  77      * Type of a block representing a block to be encoded on demand from disk.
  78      * Should never appear on the network directly.
  79      */
  80   GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6,
  81
  82     /**
  83      * Type of a block that contains a HELLO for a peer (for
  84      * DHT find-peer operations).
  85      */
  86   GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
  87
  88     /**
  89      * Block for testing.
  90      */
  91   GNUNET_BLOCK_TYPE_TEST = 8,
  92
  93     /**
  94      * Block for storing .gnunet-domains
  95      */
  96   GNUNET_BLOCK_TYPE_DNS = 10
  97 };
  98
  99
 100 /**
 101  * Possible ways for how a block may relate to a query.
 102  */
 103 enum GNUNET_BLOCK_EvaluationResult
 104 {
 105     /**
 106      * Valid result, and there may be more.
 107      */
 108   GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
 109
 110     /**
 111      * Last possible valid result.
 112      */
 113   GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
 114
 115     /**
 116      * Valid result, but suppressed because it is a duplicate.
 117      */
 118   GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
 119
 120     /**
 121      * Block does not match query (invalid result)
 122      */
 123   GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
 124
 125     /**
 126      * Query is valid, no reply given.
 127      */
 128   GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 4,
 129
 130     /**
 131      * Query format does not match block type (invalid query).  For
 132      * example, xquery not given or xquery_size not appropriate for
 133      * type.
 134      */
 135   GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 5,
 136
 137     /**
 138      * Specified block type not supported by this plugin.
 139      */
 140   GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 6
 141 };
 142
 143
 144 /**
 145  * Handle to an initialized block library.
 146  */
 147 struct GNUNET_BLOCK_Context;
 148
 149
 150 /**
 151  * Mingle hash with the mingle_number to produce different bits.
 152  *
 153  * @param in original hash code
 154  * @param mingle_number number for hash permutation
 155  * @param hc where to store the result.
 156  */
 157 void
 158 GNUNET_BLOCK_mingle_hash (const GNUNET_HashCode * in, uint32_t mingle_number,
 159                           GNUNET_HashCode * hc);
 160
 161
 162 /**
 163  * Create a block context.  Loads the block plugins.
 164  *
 165  * @param cfg configuration to use
 166  * @return NULL on error
 167  */
 168 struct GNUNET_BLOCK_Context *
 169 GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
 170
 171
 172 /**
 173  * Destroy the block context.
 174  *
 175  * @param ctx context to destroy
 176  */
 177 void
 178 GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
 179
 180
 181 /**
 182  * Function called to validate a reply or a request.  For
 183  * request evaluation, simply pass "NULL" for the reply_block.
 184  * Note that it is assumed that the reply has already been
 185  * matched to the key (and signatures checked) as it would
 186  * be done with the "get_key" function.
 187  *
 188  * @param ctx block contxt
 189  * @param type block type
 190  * @param query original query (hash)
 191  * @param bf pointer to bloom filter associated with query; possibly updated (!)
 192  * @param bf_mutator mutation value for bf
 193  * @param xquery extrended query data (can be NULL, depending on type)
 194  * @param xquery_size number of bytes in xquery
 195  * @param reply_block response to validate
 196  * @param reply_block_size number of bytes in reply block
 197  * @return characterization of result
 198  */
 199 enum GNUNET_BLOCK_EvaluationResult
 200 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
 201                        enum GNUNET_BLOCK_Type type,
 202                        const GNUNET_HashCode * query,
 203                        struct GNUNET_CONTAINER_BloomFilter **bf,
 204                        int32_t bf_mutator, const void *xquery,
 205                        size_t xquery_size, const void *reply_block,
 206                        size_t reply_block_size);
 207
 208
 209 /**
 210  * Function called to obtain the key for a block.
 211  *
 212  * @param ctx block context
 213  * @param type block type
 214  * @param block block to get the key for
 215  * @param block_size number of bytes in block
 216  * @param key set to the key (query) for the given block
 217  * @return GNUNET_YES on success,
 218  *         GNUNET_NO if the block is malformed
 219  *         GNUNET_SYSERR if type not supported
 220  *         (or if extracting a key from a block of this type does not work)
 221  */
 222 int
 223 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
 224                       enum GNUNET_BLOCK_Type type, const void *block,
 225                       size_t block_size, GNUNET_HashCode * key);
 226
 227
 228
 229 /**
 230  * Construct a bloom filter that would filter out the given
 231  * results.
 232  *
 233  * @param bf_mutator mutation value to use
 234  * @param seen_results results already seen
 235  * @param seen_results_count number of entries in 'seen_results'
 236  * @return NULL if seen_results_count is 0, otherwise a BF
 237  *         that would match the given results.
 238  */
 239 struct GNUNET_CONTAINER_BloomFilter *
 240 GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator,
 241                                     const GNUNET_HashCode * seen_results,
 242                                     unsigned int seen_results_count);
 243
 244
 245 #if 0                           /* keep Emacsens' auto-indent happy */
 246 {
 247 #endif
 248 #ifdef __cplusplus
 249 }
 250 #endif
 251
 252
 253 /* ifndef GNUNET_BLOCK_LIB_H */
 254 #endif
 255 /* end of gnunet_block_lib.h */