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