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    * 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 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 for storing mesh peers
 111    */
 112   GNUNET_BLOCK_TYPE_MESH_PEER = 20,
 113
 114   /**
 115    * Block to store a mesh regex state
 116    */
 117   GNUNET_BLOCK_TYPE_REGEX = 22,
 118
 119   /**
 120    * Block to store a mesh regex accepting state
 121    */
 122   GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23
 123 };
 124
 125
 126 /**
 127  * Possible ways for how a block may relate to a query.
 128  */
 129 enum GNUNET_BLOCK_EvaluationResult
 130 {
 131   /**
 132    * Valid result, and there may be more.
 133    */
 134   GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
 135
 136   /**
 137    * Last possible valid result.
 138    */
 139   GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
 140
 141   /**
 142    * Valid result, but suppressed because it is a duplicate.
 143    */
 144   GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
 145
 146   /**
 147    * Block does not match query (invalid result)
 148    */
 149   GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
 150
 151   /**
 152    * Block does not match xquery (valid result, not relevant for the request)
 153    */
 154   GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4,
 155
 156   /**
 157    * Query is valid, no reply given.
 158    */
 159   GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10,
 160
 161   /**
 162    * Query format does not match block type (invalid query).  For
 163    * example, xquery not given or xquery_size not appropriate for
 164    * type.
 165    */
 166   GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11,
 167
 168   /**
 169    * Specified block type not supported by this plugin.
 170    */
 171   GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20
 172 };
 173
 174
 175 /**
 176  * Handle to an initialized block library.
 177  */
 178 struct GNUNET_BLOCK_Context;
 179
 180
 181 /**
 182  * Mingle hash with the mingle_number to produce different bits.
 183  *
 184  * @param in original hash code
 185  * @param mingle_number number for hash permutation
 186  * @param hc where to store the result.
 187  */
 188 void
 189 GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode * in, uint32_t mingle_number,
 190                           struct GNUNET_HashCode * hc);
 191
 192
 193 /**
 194  * Create a block context.  Loads the block plugins.
 195  *
 196  * @param cfg configuration to use
 197  * @return NULL on error
 198  */
 199 struct GNUNET_BLOCK_Context *
 200 GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
 201
 202
 203 /**
 204  * Destroy the block context.
 205  *
 206  * @param ctx context to destroy
 207  */
 208 void
 209 GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
 210
 211
 212 /**
 213  * Function called to validate a reply or a request.  For
 214  * request evaluation, simply pass "NULL" for the reply_block.
 215  * Note that it is assumed that the reply has already been
 216  * matched to the key (and signatures checked) as it would
 217  * be done with the "get_key" function.
 218  *
 219  * @param ctx block contxt
 220  * @param type block type
 221  * @param query original query (hash)
 222  * @param bf pointer to bloom filter associated with query; possibly updated (!)
 223  * @param bf_mutator mutation value for @a bf
 224  * @param xquery extrended query data (can be NULL, depending on type)
 225  * @param xquery_size number of bytes in @a xquery
 226  * @param reply_block response to validate
 227  * @param reply_block_size number of bytes in @a reply_block
 228  * @return characterization of result
 229  */
 230 enum GNUNET_BLOCK_EvaluationResult
 231 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
 232                        enum GNUNET_BLOCK_Type type,
 233                        const struct GNUNET_HashCode * query,
 234                        struct GNUNET_CONTAINER_BloomFilter **bf,
 235                        int32_t bf_mutator, const void *xquery,
 236                        size_t xquery_size, const void *reply_block,
 237                        size_t reply_block_size);
 238
 239
 240 /**
 241  * Function called to obtain the key for a block.
 242  *
 243  * @param ctx block context
 244  * @param type block type
 245  * @param block block to get the key for
 246  * @param block_size number of bytes in @a block
 247  * @param key set to the key (query) for the given block
 248  * @return #GNUNET_YES on success,
 249  *         #GNUNET_NO if the block is malformed
 250  *         #GNUNET_SYSERR if type not supported
 251  *         (or if extracting a key from a block of this type does not work)
 252  */
 253 int
 254 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
 255                       enum GNUNET_BLOCK_Type type, const void *block,
 256                       size_t block_size, struct GNUNET_HashCode * key);
 257
 258
 259
 260 /**
 261  * Construct a bloom filter that would filter out the given
 262  * results.
 263  *
 264  * @param bf_mutator mutation value to use
 265  * @param seen_results results already seen
 266  * @param seen_results_count number of entries in @a seen_results
 267  * @return NULL if seen_results_count is 0, otherwise a BF
 268  *         that would match the given results.
 269  */
 270 struct GNUNET_CONTAINER_BloomFilter *
 271 GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator,
 272                                     const struct GNUNET_HashCode * seen_results,
 273                                     unsigned int seen_results_count);
 274
 275
 276 #if 0                           /* keep Emacsens' auto-indent happy */
 277 {
 278 #endif
 279 #ifdef __cplusplus
 280 }
 281 #endif
 282
 283
 284 /* ifndef GNUNET_BLOCK_LIB_H */
 285 #endif
 286 /* end of gnunet_block_lib.h */