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 == memcmp (guard,
 102                    "seen-set-size",
 103                    strlen ("seen-set-size")))
 104     bf_size = compute_bloomfilter_size (va_arg (va, unsigned int));
 105   else if (0 == memcmp (guard,
 106                         "filter-size",
 107                         strlen ("filter-size")))
 108     bf_size = va_arg (va, unsigned int);
 109   else
 110   {
 111     GNUNET_break (0);
 112     bf_size = TEMPLATE_BF_SIZE;
 113   }
 114   GNUNET_break (NULL == va_arg (va, const char *));
 115   return GNUNET_BLOCK_GROUP_bf_create (cls,
 116                                        TEMPLATE_BF_SIZE,
 117                                        BLOOMFILTER_K,
 118                                        type,
 119                                        nonce,
 120                                        raw_data,
 121                                        raw_data_size);
 122 }
 123
 124
 125 /**
 126  * Function called to validate a reply or a request.  For
 127  * request evaluation, simply pass "NULL" for the reply_block.
 128  *
 129  * @param cls closure
 130  * @param type block type
 131  * @param group block group to use
 132  * @param eo control flags
 133  * @param query original query (hash)
 134  * @param xquery extrended query data (can be NULL, depending on type)
 135  * @param xquery_size number of bytes in xquery
 136  * @param reply_block response to validate
 137  * @param reply_block_size number of bytes in reply block
 138  * @return characterization of result
 139  */
 140 static enum GNUNET_BLOCK_EvaluationResult
 141 block_plugin_template_evaluate (void *cls,
 142                                 enum GNUNET_BLOCK_Type type,
 143                                 struct GNUNET_BLOCK_Group *group,
 144                                 enum GNUNET_BLOCK_EvaluationOptions eo,
 145                                 const struct GNUNET_HashCode *query,
 146                                 const void *xquery,
 147                                 size_t xquery_size,
 148                                 const void *reply_block,
 149                                 size_t reply_block_size)
 150 {
 151   struct GNUNET_HashCode chash;
 152
 153   if (NULL == reply_block)
 154     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 155   GNUNET_CRYPTO_hash (reply_block,
 156                       reply_block_size,
 157                       &chash);
 158   if (GNUNET_YES ==
 159       GNUNET_BLOCK_GROUP_bf_test_and_set (group,
 160                                           &chash))
 161     return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 162   return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 163 }
 164
 165
 166 /**
 167  * Function called to obtain the key for a block.
 168  *
 169  * @param cls closure
 170  * @param type block type
 171  * @param block block to get the key for
 172  * @param block_size number of bytes in block
 173  * @param key set to the key (query) for the given block
 174  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 175  *         (or if extracting a key from a block of this type does not work)
 176  */
 177 static int
 178 block_plugin_template_get_key (void *cls,
 179                                enum GNUNET_BLOCK_Type type,
 180                                const void *block,
 181                                size_t block_size,
 182                                struct GNUNET_HashCode *key)
 183 {
 184   return GNUNET_SYSERR;
 185 }
 186
 187
 188 /**
 189  * Entry point for the plugin.
 190  */
 191 void *
 192 libgnunet_plugin_block_template_init (void *cls)
 193 {
 194   static enum GNUNET_BLOCK_Type types[] =
 195   {
 196     /* FIXME: insert supported block types here */
 197     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 198   };
 199   struct GNUNET_BLOCK_PluginFunctions *api;
 200
 201   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 202   api->evaluate = &block_plugin_template_evaluate;
 203   api->get_key = &block_plugin_template_get_key;
 204   api->create_group = &block_plugin_template_create_group;
 205   api->types = types;
 206   return api;
 207 }
 208
 209
 210 /**
 211  * Exit point from the plugin.
 212  */
 213 void *
 214 libgnunet_plugin_block_template_done (void *cls)
 215 {
 216   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 217
 218   GNUNET_free (api);
 219   return NULL;
 220 }
 221
 222 /* end of plugin_block_template.c */