src/block/plugin_block_dht.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_dht.c
  23  * @brief block plugin for DHT internals (right now, find-peer requests only);
  24  *        other plugins should be used to store "useful" data in the
  25  *        DHT (see fs block plugin)
  26  * @author Christian Grothoff
  27  */
  28
  29 #include "platform.h"
  30 #include "gnunet_hello_lib.h"
  31 #include "plugin_block.h"
  32
  33 #define DEBUG_DHT GNUNET_NO
  34
  35
  36 /**
  37  * Function called to validate a reply or a request.  For
  38  * request evaluation, simply pass "NULL" for the reply_block.
  39  *
  40  * @param cls closure
  41  * @param type block type
  42  * @param query original query (hash)
  43  * @param bf pointer to bloom filter associated with query; possibly updated (!)
  44  * @param bf_mutator mutation value for bf
  45  * @param xquery extrended query data (can be NULL, depending on type)
  46  * @param xquery_size number of bytes in xquery
  47  * @param reply_block response to validate
  48  * @param reply_block_size number of bytes in reply block
  49  * @return characterization of result
  50  */
  51 static enum GNUNET_BLOCK_EvaluationResult
  52 block_plugin_dht_evaluate (void *cls,
  53                            enum GNUNET_BLOCK_Type type,
  54                            const GNUNET_HashCode *query,
  55                            struct GNUNET_CONTAINER_BloomFilter **bf,
  56                            int32_t bf_mutator,
  57                            const void *xquery,
  58                            size_t xquery_size,
  59                            const void *reply_block,
  60                            size_t reply_block_size)
  61 {
  62   if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
  63     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
  64   if (xquery_size != 0)
  65     return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  66   if (reply_block_size == 0)
  67     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  68   GNUNET_break (NULL == *bf);
  69   return GNUNET_BLOCK_EVALUATION_OK_LAST;
  70 }
  71
  72
  73 /**
  74  * Function called to obtain the key for a block.
  75  *
  76  * @param cls closure
  77  * @param type block type
  78  * @param block block to get the key for
  79  * @param block_size number of bytes in block
  80  * @param key set to the key (query) for the given block
  81  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
  82  *         (or if extracting a key from a block of this type does not work)
  83  */
  84 static int
  85 block_plugin_dht_get_key (void *cls,
  86                           enum GNUNET_BLOCK_Type type,
  87                           const void *block,
  88                           size_t block_size,
  89                           GNUNET_HashCode *key)
  90 {
  91   const struct GNUNET_MessageHeader *msg;
  92   const struct GNUNET_HELLO_Message *hello;
  93   struct GNUNET_PeerIdentity *pid;
  94
  95   if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
  96     return GNUNET_SYSERR;
  97   if (block_size < sizeof (struct GNUNET_MessageHeader))
  98     {
  99       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 100                        "block-dht",
 101                        _("Block not of type %u\n"),
 102                        GNUNET_BLOCK_TYPE_DHT_HELLO);
 103       return GNUNET_SYSERR;
 104     }
 105   msg = block;
 106   if (block_size != ntohs (msg->size))
 107     {
 108       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 109                        "block-dht",
 110                        _("Size mismatch for block\n"),
 111                        GNUNET_BLOCK_TYPE_DHT_HELLO);
 112       return GNUNET_SYSERR;
 113     }
 114   hello = block;
 115   pid = (struct GNUNET_PeerIdentity*) key;
 116   if (GNUNET_OK !=
 117       GNUNET_HELLO_get_id (hello,
 118                            pid))
 119     {
 120       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 121                        "block-dht",
 122                        _("Block of type %u is malformed\n"),
 123                        GNUNET_BLOCK_TYPE_DHT_HELLO);
 124       return GNUNET_SYSERR;
 125     }
 126   return GNUNET_OK;
 127 }
 128
 129
 130 /**
 131  * Entry point for the plugin.
 132  */
 133 void *
 134 gnunet_plugin_block_dht_init (void *cls)
 135 {
 136   static enum GNUNET_BLOCK_Type types[] =
 137     {
 138       GNUNET_BLOCK_TYPE_DHT_HELLO,
 139       GNUNET_BLOCK_TYPE_ANY /* end of list */
 140     };
 141   struct GNUNET_BLOCK_PluginFunctions *api;
 142
 143   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
 144   api->evaluate = &block_plugin_dht_evaluate;
 145   api->get_key = &block_plugin_dht_get_key;
 146   api->types = types;
 147   return api;
 148 }
 149
 150
 151 /**
 152  * Exit point from the plugin.
 153  */
 154 void *
 155 gnunet_plugin_block_dht_done (void *cls)
 156 {
 157   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 158
 159   GNUNET_free (api);
 160   return NULL;
 161 }
 162
 163 /* end of plugin_block_dht.c */