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.
  62      */
  63     GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
  64
  65     /**
  66      * Type of a block that is used to advertise content in a namespace.
  67      */
  68     GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
  69
  70     /**
  71      * Type of a block representing a block to be encoded on demand from disk.
  72      * Should never appear on the network directly.
  73      */
  74     GNUNET_BLOCK_TYPE_FS_ONDEMAND = 5,
  75
  76     /**
  77      * Type of a block that is used to advertise a namespace.
  78      */
  79     GNUNET_BLOCK_TYPE_FS_NBLOCK = 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
  94
  95 /**
  96  * Possible ways for how a block may relate to a query.
  97  */
  98 enum GNUNET_BLOCK_EvaluationResult
  99   {
 100     /**
 101      * Valid result, and there may be more.
 102      */
 103     GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
 104
 105     /**
 106      * Last possible valid result.
 107      */
 108     GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
 109
 110     /**
 111      * Valid result, but suppressed because it is a duplicate.
 112      */
 113     GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
 114
 115     /**
 116      * Block does not match query (invalid result)
 117      */
 118     GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
 119
 120     /**
 121      * Query is valid, no reply given.
 122      */
 123     GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 4,
 124
 125     /**
 126      * Query format does not match block type (invalid query).  For
 127      * example, xquery not given or xquery_size not appropriate for
 128      * type.
 129      */
 130     GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 5,
 131
 132     /**
 133      * Specified block type not supported by this plugin.
 134      */
 135     GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 6
 136   };
 137
 138
 139 /**
 140  * Handle to an initialized block library.
 141  */
 142 struct GNUNET_BLOCK_Context;
 143
 144
 145 /**
 146  * Mingle hash with the mingle_number to produce different bits.
 147  *
 148  * @param in original hash code
 149  * @param mingle_number number for hash permutation
 150  * @param hc where to store the result.
 151  */
 152 void
 153 GNUNET_BLOCK_mingle_hash (const GNUNET_HashCode * in,
 154                           int32_t mingle_number,
 155                           GNUNET_HashCode * hc);
 156
 157
 158 /**
 159  * Create a block context.  Loads the block plugins.
 160  *
 161  * @param cfg configuration to use
 162  * @return NULL on error
 163  */
 164 struct GNUNET_BLOCK_Context *
 165 GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
 166
 167
 168 /**
 169  * Destroy the block context.
 170  *
 171  * @param ctx context to destroy
 172  */
 173 void
 174 GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
 175
 176
 177 /**
 178  * Function called to validate a reply or a request.  For
 179  * request evaluation, simply pass "NULL" for the reply_block.
 180  * Note that it is assumed that the reply has already been
 181  * matched to the key (and signatures checked) as it would
 182  * be done with the "get_key" function.
 183  *
 184  * @param ctx block contxt
 185  * @param type block type
 186  * @param query original query (hash)
 187  * @param bf pointer to bloom filter associated with query; possibly updated (!)
 188  * @param bf_mutator mutation value for bf
 189  * @param xquery extrended query data (can be NULL, depending on type)
 190  * @param xquery_size number of bytes in xquery
 191  * @param reply_block response to validate
 192  * @param reply_block_size number of bytes in reply block
 193  * @return characterization of result
 194  */
 195 enum GNUNET_BLOCK_EvaluationResult
 196 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
 197                        enum GNUNET_BLOCK_Type type,
 198                        const GNUNET_HashCode *query,
 199                        struct GNUNET_CONTAINER_BloomFilter **bf,
 200                        int32_t bf_mutator,
 201                        const void *xquery,
 202                        size_t xquery_size,
 203                        const void *reply_block,
 204                        size_t reply_block_size);
 205
 206
 207 /**
 208  * Function called to obtain the key for a block.
 209  *
 210  * @param ctx block context
 211  * @param type block type
 212  * @param block block to get the key for
 213  * @param block_size number of bytes in block
 214  * @param key set to the key (query) for the given block
 215  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
 216  *         (or if extracting a key from a block of this type does not work)
 217  */
 218 int
 219 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
 220                       enum GNUNET_BLOCK_Type type,
 221                       const void *block,
 222                       size_t block_size,
 223                       GNUNET_HashCode *key);
 224
 225
 226 #if 0                           /* keep Emacsens' auto-indent happy */
 227 {
 228 #endif
 229 #ifdef __cplusplus
 230 }
 231 #endif
 232
 233
 234 /* ifndef GNUNET_BLOCK_LIB_H */
 235 #endif
 236 /* end of gnunet_block_lib.h */