src/block/plugin_block_template.c

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2010 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 /**
  20  * @file block/plugin_block_template.c
  21  * @brief template for a block plugin
  22  * @author Christian Grothoff
  23  */
  24
  25 #include "platform.h"
  26 #include "gnunet_block_plugin.h"
  27 #include "gnunet_block_group_lib.h"
  28
  29 #define DEBUG_TEMPLATE GNUNET_EXTRA_LOGGING
  30
  31 /**
  32  * Number of bits we set per entry in the bloomfilter.
  33  * Do not change!
  34  */
  35 #define BLOOMFILTER_K 16
  36
  37
  38 /**
  39  * How big is the BF we use for DHT blocks?
  40  */
  41 #define TEMPLATE_BF_SIZE 8
  42
  43
  44 /**
  45  * Create a new block group.
  46  *
  47  * @param ctx block context in which the block group is created
  48  * @param type type of the block for which we are creating the group
  49  * @param nonce random value used to seed the group creation
  50  * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
  51  * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
  52  * @param va variable arguments specific to @a type
  53  * @return block group handle, NULL if block groups are not supported
  54  *         by this @a type of block (this is not an error)
  55  */
  56 static struct GNUNET_BLOCK_Group *
  57 block_plugin_template_create_group (void *cls,
  58                                     enum GNUNET_BLOCK_Type type,
  59                                     uint32_t nonce,
  60                                     const void *raw_data,
  61                                     size_t raw_data_size,
  62                                     va_list va)
  63 {
  64   unsigned int bf_size;
  65   const char *guard;
  66
  67   guard = va_arg (va, const char *);
  68   if (0 == strcmp (guard,
  69                    "seen-set-size"))
  70     bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned int),
  71                                                            BLOOMFILTER_K);
  72   else if (0 == strcmp (guard,
  73                         "filter-size"))
  74     bf_size = va_arg (va, unsigned int);
  75   else
  76   {
  77     GNUNET_break (0);
  78     bf_size = TEMPLATE_BF_SIZE;
  79   }
  80   GNUNET_break (NULL == va_arg (va, const char *));
  81   return GNUNET_BLOCK_GROUP_bf_create (cls,
  82                                        bf_size,
  83                                        BLOOMFILTER_K,
  84                                        type,
  85                                        nonce,
  86                                        raw_data,
  87                                        raw_data_size);
  88 }
  89
  90
  91 /**
  92  * Function called to validate a reply or a request.  For
  93  * request evaluation, simply pass "NULL" for the reply_block.
  94  *
  95  * @param cls closure
  96  * @param ctx context
  97  * @param type block type
  98  * @param group block group to use
  99  * @param eo control flags
 100  * @param query original query (hash)
 101  * @param xquery extrended query data (can be NULL, depending on type)
 102  * @param xquery_size number of bytes in xquery
 103  * @param reply_block response to validate
 104  * @param reply_block_size number of bytes in reply block
 105  * @return characterization of result
 106  */
 107 static enum GNUNET_BLOCK_EvaluationResult
 108 block_plugin_template_evaluate (void *cls,
 109                                 struct GNUNET_BLOCK_Context *ctx,
 110                                 enum GNUNET_BLOCK_Type type,
 111                                 struct GNUNET_BLOCK_Group *group,
 112                                 enum GNUNET_BLOCK_EvaluationOptions eo,
 113                                 const struct GNUNET_HashCode *query,
 114                                 const void *xquery,
 115                                 size_t xquery_size,
 116                                 const void *reply_block,
 117                                 size_t reply_block_size)
 118 {
 119   struct GNUNET_HashCode chash;
 120
 121   if (NULL == reply_block)
 122     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 123   GNUNET_CRYPTO_hash (reply_block,
 124                       reply_block_size,
 125                       &chash);
 126   if (GNUNET_YES ==
 127       GNUNET_BLOCK_GROUP_bf_test_and_set (group,
 128                                           &chash))
 129     return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 130   return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 131 }
 132
 133
 134 /**
 135  * Function called to obtain the key for a block.
 136  *
 137  * @param cls closure
 138  * @param type block type
 139  * @param block block to get the key for
 140  * @param block_size number of bytes in block
 141  * @param key set to the key (query) for the given block
 142  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 143  *         (or if extracting a key from a block of this type does not work)
 144  */
 145 static int
 146 block_plugin_template_get_key (void *cls,
 147                                enum GNUNET_BLOCK_Type type,
 148                                const void *block,
 149                                size_t block_size,
 150                                struct GNUNET_HashCode *key)
 151 {
 152   return GNUNET_SYSERR;
 153 }
 154
 155
 156 /**
 157  * Entry point for the plugin.
 158  *
 159  * @param cls a `const struct GNUNET_CONFIGURATION_Handle`
 160  */
 161 void *
 162 libgnunet_plugin_block_template_init (void *cls)
 163 {
 164   static enum GNUNET_BLOCK_Type types[] =
 165   {
 166     /* FIXME: insert supported block types here */
 167     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 168   };
 169   struct GNUNET_BLOCK_PluginFunctions *api;
 170
 171   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 172   api->evaluate = &block_plugin_template_evaluate;
 173   api->get_key = &block_plugin_template_get_key;
 174   api->create_group = &block_plugin_template_create_group;
 175   api->types = types;
 176   return api;
 177 }
 178
 179
 180 /**
 181  * Exit point from the plugin.
 182  */
 183 void *
 184 libgnunet_plugin_block_template_done (void *cls)
 185 {
 186   struct GNUNET_BLOCK_PluginFunctions *api = cls;
 187
 188   GNUNET_free (api);
 189   return NULL;
 190 }
 191
 192 /* end of plugin_block_template.c */