src/include/gnunet_block_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (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    * Legacy type, no longer in use.
  62    */
  63   GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
  64
  65   /**
  66    * Legacy type, no longer in use.
  67    */
  68   GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
  69
  70   /**
  71    * Legacy type, no longer in use.
  72    */
  73   GNUNET_BLOCK_TYPE_FS_NBLOCK = 5,
  74
  75   /**
  76    * Type of a block representing a block to be encoded on demand from disk.
  77    * Should never appear on the network directly.
  78    */
  79   GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6,
  80
  81   /**
  82    * Type of a block that contains a HELLO for a peer (for
  83    * DHT and CADET find-peer operations).
  84    */
  85   GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
  86
  87   /**
  88    * Block for testing.
  89    */
  90   GNUNET_BLOCK_TYPE_TEST = 8,
  91
  92   /**
  93    * Type of a block representing any type of search result
  94    * (universal).  Implemented in the context of #2564, replaces
  95    * SBLOCKS, KBLOCKS and NBLOCKS.
  96    */
  97   GNUNET_BLOCK_TYPE_FS_UBLOCK = 9,
  98
  99   /**
 100    * Block for storing DNS exit service advertisements.
 101    */
 102   GNUNET_BLOCK_TYPE_DNS = 10,
 103
 104   /**
 105    * Block for storing record data
 106    */
 107   GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11,
 108
 109   /**
 110    * Block to store a cadet regex state
 111    */
 112   GNUNET_BLOCK_TYPE_REGEX = 22,
 113
 114   /**
 115    * Block to store a cadet regex accepting state
 116    */
 117   GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23
 118 };
 119
 120
 121 /**
 122  * Flags that can be set to control the evaluation.
 123  */
 124 enum GNUNET_BLOCK_EvaluationOptions
 125 {
 126
 127   /**
 128    * Default behavior.
 129    */
 130   GNUNET_BLOCK_EO_NONE = 0,
 131
 132   /**
 133    * The block is obtained from the local database, skip cryptographic
 134    * checks.
 135    */
 136   GNUNET_BLOCK_EO_LOCAL_SKIP_CRYPTO = 1
 137 };
 138
 139
 140 /**
 141  * Possible ways for how a block may relate to a query.
 142  */
 143 enum GNUNET_BLOCK_EvaluationResult
 144 {
 145   /**
 146    * Valid result, and there may be more.
 147    */
 148   GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
 149
 150   /**
 151    * Last possible valid result.
 152    */
 153   GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
 154
 155   /**
 156    * Valid result, but suppressed because it is a duplicate.
 157    */
 158   GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
 159
 160   /**
 161    * Block does not match query (invalid result)
 162    */
 163   GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
 164
 165   /**
 166    * Block does not match xquery (valid result, not relevant for the request)
 167    */
 168   GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4,
 169
 170   /**
 171    * Query is valid, no reply given.
 172    */
 173   GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10,
 174
 175   /**
 176    * Query format does not match block type (invalid query).  For
 177    * example, xquery not given or xquery_size not appropriate for
 178    * type.
 179    */
 180   GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11,
 181
 182   /**
 183    * Specified block type not supported by this plugin.
 184    */
 185   GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20
 186 };
 187
 188
 189 /**
 190  * Handle to an initialized block library.
 191  */
 192 struct GNUNET_BLOCK_Context;
 193
 194
 195 /**
 196  * Mingle hash with the mingle_number to produce different bits.
 197  *
 198  * @param in original hash code
 199  * @param mingle_number number for hash permutation
 200  * @param hc where to store the result.
 201  */
 202 void
 203 GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode *in,
 204                           uint32_t mingle_number,
 205                           struct GNUNET_HashCode *hc);
 206
 207
 208 /**
 209  * Create a block context.  Loads the block plugins.
 210  *
 211  * @param cfg configuration to use
 212  * @return NULL on error
 213  */
 214 struct GNUNET_BLOCK_Context *
 215 GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
 216
 217
 218 /**
 219  * Destroy the block context.
 220  *
 221  * @param ctx context to destroy
 222  */
 223 void
 224 GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
 225
 226
 227 /**
 228  * Function called to validate a reply or a request.  For
 229  * request evaluation, simply pass "NULL" for the @a reply_block.
 230  * Note that it is assumed that the reply has already been
 231  * matched to the key (and signatures checked) as it would
 232  * be done with the #GNUNET_BLOCK_get_key() function.
 233  *
 234  * @param ctx block contxt
 235  * @param type block type
 236  * @param eo evaluation options to control evaluation
 237  * @param query original query (hash)
 238  * @param bf pointer to bloom filter associated with query; possibly updated (!)
 239  * @param bf_mutator mutation value for @a bf
 240  * @param xquery extrended query data (can be NULL, depending on type)
 241  * @param xquery_size number of bytes in @a xquery
 242  * @param reply_block response to validate
 243  * @param reply_block_size number of bytes in @a reply_block
 244  * @return characterization of result
 245  */
 246 enum GNUNET_BLOCK_EvaluationResult
 247 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
 248                        enum GNUNET_BLOCK_Type type,
 249                        enum GNUNET_BLOCK_EvaluationOptions eo,
 250                        const struct GNUNET_HashCode *query,
 251                        struct GNUNET_CONTAINER_BloomFilter **bf,
 252                        int32_t bf_mutator,
 253                        const void *xquery,
 254                        size_t xquery_size,
 255                        const void *reply_block,
 256                        size_t reply_block_size);
 257
 258
 259 /**
 260  * Function called to obtain the key for a block.
 261  *
 262  * @param ctx block context
 263  * @param type block type
 264  * @param block block to get the key for
 265  * @param block_size number of bytes in @a block
 266  * @param key set to the key (query) for the given block
 267  * @return #GNUNET_YES on success,
 268  *         #GNUNET_NO if the block is malformed
 269  *         #GNUNET_SYSERR if type not supported
 270  *         (or if extracting a key from a block of this type does not work)
 271  */
 272 int
 273 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
 274                       enum GNUNET_BLOCK_Type type,
 275                       const void *block,
 276                       size_t block_size,
 277                       struct GNUNET_HashCode * key);
 278
 279
 280
 281 /**
 282  * Construct a bloom filter that would filter out the given
 283  * results.
 284  *
 285  * @param bf_mutator mutation value to use
 286  * @param seen_results results already seen
 287  * @param seen_results_count number of entries in @a seen_results
 288  * @return NULL if seen_results_count is 0, otherwise a BF
 289  *         that would match the given results.
 290  */
 291 struct GNUNET_CONTAINER_BloomFilter *
 292 GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator,
 293                                     const struct GNUNET_HashCode *seen_results,
 294                                     unsigned int seen_results_count);
 295
 296
 297 #if 0                           /* keep Emacsens' auto-indent happy */
 298 {
 299 #endif
 300 #ifdef __cplusplus
 301 }
 302 #endif
 303
 304
 305 /* ifndef GNUNET_BLOCK_LIB_H */
 306 #endif
 307 /* end of gnunet_block_lib.h */