src/block/plugin_block_template.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2010 Christian Grothoff (and other contributing authors)
   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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, 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
  30 #define DEBUG_TEMPLATE GNUNET_EXTRA_LOGGING
  31
  32
  33 /**
  34  * Function called to validate a reply or a request.  For
  35  * request evaluation, simply pass "NULL" for the reply_block.
  36  *
  37  * @param cls closure
  38  * @param type block type
  39  * @param query original query (hash)
  40  * @param bf pointer to bloom filter associated with query; possibly updated (!)
  41  * @param bf_mutator mutation value for bf
  42  * @param xquery extrended query data (can be NULL, depending on type)
  43  * @param xquery_size number of bytes in xquery
  44  * @param reply_block response to validate
  45  * @param reply_block_size number of bytes in reply block
  46  * @return characterization of result
  47  */
  48 static enum GNUNET_BLOCK_EvaluationResult
  49 block_plugin_template_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
  50                                 const struct GNUNET_HashCode * query,
  51                                 struct GNUNET_CONTAINER_BloomFilter **bf,
  52                                 int32_t bf_mutator, const void *xquery,
  53                                 size_t xquery_size, const void *reply_block,
  54                                 size_t reply_block_size)
  55 {
  56   struct GNUNET_HashCode chash;
  57   struct GNUNET_HashCode mhash;
  58   /* FIXME: check validity first... */
  59
  60   /* mandatory duplicate-detection code... */
  61   if (NULL != bf)
  62   {
  63     GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
  64     GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
  65     if (NULL != *bf)
  66     {
  67       if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
  68         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
  69     }
  70     else
  71     {
  72       *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, 64 /* BLOOMFILTER_K */);
  73     }
  74     GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
  75   }
  76   /* FIXME: other stuff here... */
  77   return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
  78 }
  79
  80
  81 /**
  82  * Function called to obtain the key for a block.
  83  *
  84  * @param cls closure
  85  * @param type block type
  86  * @param block block to get the key for
  87  * @param block_size number of bytes in block
  88  * @param key set to the key (query) for the given block
  89  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
  90  *         (or if extracting a key from a block of this type does not work)
  91  */
  92 static int
  93 block_plugin_template_get_key (void *cls, enum GNUNET_BLOCK_Type type,
  94                                const void *block, size_t block_size,
  95                                struct GNUNET_HashCode * key)
  96 {
  97   return GNUNET_SYSERR;
  98 }
  99
 100
 101 /**
 102  * Entry point for the plugin.
 103  */
 104 void *
 105 libgnunet_plugin_block_template_init (void *cls)
 106 {
 107   static enum GNUNET_BLOCK_Type types[] =
 108   {
 109     /* FIXME: insert supported block types here */
 110     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 111   };
 112   struct GNUNET_BLOCK_PluginFunctions *api;
 113
 114   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
 115   api->evaluate = &block_plugin_template_evaluate;
 116   api->get_key = &block_plugin_template_get_key;
 117   api->types = types;
 118   return api;
 119 }
 120
 121
 122 /**
 123  * Exit point from the plugin.
 124  */
 125 void *
 126 libgnunet_plugin_block_template_done (void *cls)
 127 {
 128   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 129
 130   GNUNET_free (api);
 131   return NULL;
 132 }
 133
 134 /* end of plugin_block_template.c */