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