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
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  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  * How many bytes should a bloomfilter be if we have already seen
  48  * entry_count responses?  Note that #GNUNET_CONSTANTS_BLOOMFILTER_K
  49  * gives us the number of bits set per entry.  Furthermore, we should
  50  * not re-size the filter too often (to keep it cheap).
  51  *
  52  * Since other peers will also add entries but not resize the filter,
  53  * we should generally pick a slightly larger size than what the
  54  * strict math would suggest.
  55  *
  56  * @param entry_count expected number of entries in the Bloom filter
  57  * @return must be a power of two and smaller or equal to 2^15.
  58  */
  59 static size_t
  60 compute_bloomfilter_size (unsigned int entry_count)
  61 {
  62   size_t size;
  63   unsigned int ideal = (entry_count * BLOOMFILTER_K) / 4;
  64   uint16_t max = 1 << 15;
  65
  66   if (entry_count > max)
  67     return max;
  68   size = 8;
  69   while ((size < max) && (size < ideal))
  70     size *= 2;
  71   if (size > max)
  72     return max;
  73   return size;
  74 }
  75
  76
  77 /**
  78  * Create a new block group.
  79  *
  80  * @param ctx block context in which the block group is created
  81  * @param type type of the block for which we are creating the group
  82  * @param nonce random value used to seed the group creation
  83  * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
  84  * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
  85  * @param va variable arguments specific to @a type
  86  * @return block group handle, NULL if block groups are not supported
  87  *         by this @a type of block (this is not an error)
  88  */
  89 static struct GNUNET_BLOCK_Group *
  90 block_plugin_template_create_group (void *cls,
  91                                     enum GNUNET_BLOCK_Type type,
  92                                     uint32_t nonce,
  93                                     const void *raw_data,
  94                                     size_t raw_data_size,
  95                                     va_list va)
  96 {
  97   unsigned int bf_size;
  98   const char *guard;
  99
 100   guard = va_arg (va, const char *);
 101   if (0 == strcmp (guard,
 102                    "seen-set-size"))
 103     bf_size = compute_bloomfilter_size (va_arg (va, unsigned int));
 104   else if (0 == strcmp (guard,
 105                         "filter-size"))
 106     bf_size = va_arg (va, unsigned int);
 107   else
 108   {
 109     GNUNET_break (0);
 110     bf_size = TEMPLATE_BF_SIZE;
 111   }
 112   GNUNET_break (NULL == va_arg (va, const char *));
 113   return GNUNET_BLOCK_GROUP_bf_create (cls,
 114                                        bf_size,
 115                                        BLOOMFILTER_K,
 116                                        type,
 117                                        nonce,
 118                                        raw_data,
 119                                        raw_data_size);
 120 }
 121
 122
 123 /**
 124  * Function called to validate a reply or a request.  For
 125  * request evaluation, simply pass "NULL" for the reply_block.
 126  *
 127  * @param cls closure
 128  * @param type block type
 129  * @param group block group to use
 130  * @param eo control flags
 131  * @param query original query (hash)
 132  * @param xquery extrended query data (can be NULL, depending on type)
 133  * @param xquery_size number of bytes in xquery
 134  * @param reply_block response to validate
 135  * @param reply_block_size number of bytes in reply block
 136  * @return characterization of result
 137  */
 138 static enum GNUNET_BLOCK_EvaluationResult
 139 block_plugin_template_evaluate (void *cls,
 140                                 enum GNUNET_BLOCK_Type type,
 141                                 struct GNUNET_BLOCK_Group *group,
 142                                 enum GNUNET_BLOCK_EvaluationOptions eo,
 143                                 const struct GNUNET_HashCode *query,
 144                                 const void *xquery,
 145                                 size_t xquery_size,
 146                                 const void *reply_block,
 147                                 size_t reply_block_size)
 148 {
 149   struct GNUNET_HashCode chash;
 150
 151   if (NULL == reply_block)
 152     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 153   GNUNET_CRYPTO_hash (reply_block,
 154                       reply_block_size,
 155                       &chash);
 156   if (GNUNET_YES ==
 157       GNUNET_BLOCK_GROUP_bf_test_and_set (group,
 158                                           &chash))
 159     return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 160   return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 161 }
 162
 163
 164 /**
 165  * Function called to obtain the key for a block.
 166  *
 167  * @param cls closure
 168  * @param type block type
 169  * @param block block to get the key for
 170  * @param block_size number of bytes in block
 171  * @param key set to the key (query) for the given block
 172  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 173  *         (or if extracting a key from a block of this type does not work)
 174  */
 175 static int
 176 block_plugin_template_get_key (void *cls,
 177                                enum GNUNET_BLOCK_Type type,
 178                                const void *block,
 179                                size_t block_size,
 180                                struct GNUNET_HashCode *key)
 181 {
 182   return GNUNET_SYSERR;
 183 }
 184
 185
 186 /**
 187  * Entry point for the plugin.
 188  */
 189 void *
 190 libgnunet_plugin_block_template_init (void *cls)
 191 {
 192   static enum GNUNET_BLOCK_Type types[] =
 193   {
 194     /* FIXME: insert supported block types here */
 195     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 196   };
 197   struct GNUNET_BLOCK_PluginFunctions *api;
 198
 199   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 200   api->evaluate = &block_plugin_template_evaluate;
 201   api->get_key = &block_plugin_template_get_key;
 202   api->create_group = &block_plugin_template_create_group;
 203   api->types = types;
 204   return api;
 205 }
 206
 207
 208 /**
 209  * Exit point from the plugin.
 210  */
 211 void *
 212 libgnunet_plugin_block_template_done (void *cls)
 213 {
 214   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 215
 216   GNUNET_free (api);
 217   return NULL;
 218 }
 219
 220 /* end of plugin_block_template.c */