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