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  * 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   return GNUNET_BLOCK_GROUP_bf_create (cls,
  67                                        TEMPLATE_BF_SIZE,
  68                                        BLOOMFILTER_K,
  69                                        type,
  70                                        nonce,
  71                                        raw_data,
  72                                        raw_data_size);
  73 }
  74
  75
  76 /**
  77  * Function called to validate a reply or a request.  For
  78  * request evaluation, simply pass "NULL" for the reply_block.
  79  *
  80  * @param cls closure
  81  * @param type block type
  82  * @param group block group to use
  83  * @param eo control flags
  84  * @param query original query (hash)
  85  * @param xquery extrended query data (can be NULL, depending on type)
  86  * @param xquery_size number of bytes in xquery
  87  * @param reply_block response to validate
  88  * @param reply_block_size number of bytes in reply block
  89  * @return characterization of result
  90  */
  91 static enum GNUNET_BLOCK_EvaluationResult
  92 block_plugin_template_evaluate (void *cls,
  93                                 enum GNUNET_BLOCK_Type type,
  94                                 struct GNUNET_BLOCK_Group *group,
  95                                 enum GNUNET_BLOCK_EvaluationOptions eo,
  96                                 const struct GNUNET_HashCode *query,
  97                                 const void *xquery,
  98                                 size_t xquery_size,
  99                                 const void *reply_block,
 100                                 size_t reply_block_size)
 101 {
 102   struct GNUNET_HashCode chash;
 103
 104   if (NULL == reply_block)
 105     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 106   GNUNET_CRYPTO_hash (reply_block,
 107                       reply_block_size,
 108                       &chash);
 109   if (GNUNET_YES ==
 110       GNUNET_BLOCK_GROUP_bf_test_and_set (group,
 111                                           &chash))
 112     return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 113   return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 114 }
 115
 116
 117 /**
 118  * Function called to obtain the key for a block.
 119  *
 120  * @param cls closure
 121  * @param type block type
 122  * @param block block to get the key for
 123  * @param block_size number of bytes in block
 124  * @param key set to the key (query) for the given block
 125  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 126  *         (or if extracting a key from a block of this type does not work)
 127  */
 128 static int
 129 block_plugin_template_get_key (void *cls,
 130                                enum GNUNET_BLOCK_Type type,
 131                                const void *block,
 132                                size_t block_size,
 133                                struct GNUNET_HashCode *key)
 134 {
 135   return GNUNET_SYSERR;
 136 }
 137
 138
 139 /**
 140  * Entry point for the plugin.
 141  */
 142 void *
 143 libgnunet_plugin_block_template_init (void *cls)
 144 {
 145   static enum GNUNET_BLOCK_Type types[] =
 146   {
 147     /* FIXME: insert supported block types here */
 148     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 149   };
 150   struct GNUNET_BLOCK_PluginFunctions *api;
 151
 152   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 153   api->evaluate = &block_plugin_template_evaluate;
 154   api->get_key = &block_plugin_template_get_key;
 155   api->create_group = &block_plugin_template_create_group;
 156   api->types = types;
 157   return api;
 158 }
 159
 160
 161 /**
 162  * Exit point from the plugin.
 163  */
 164 void *
 165 libgnunet_plugin_block_template_done (void *cls)
 166 {
 167   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 168
 169   GNUNET_free (api);
 170   return NULL;
 171 }
 172
 173 /* end of plugin_block_template.c */