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