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