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 "gnunet_block_plugin.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 extended 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, size_t reply_block_size)
  60 {
  61   switch (type)
  62   {
  63   case GNUNET_BLOCK_TYPE_DHT_HELLO:
  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   default:
  71     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
  72   }
  73 }
  74
  75
  76 /**
  77  * Function called to obtain the key for a block.
  78  *
  79  * @param cls closure
  80  * @param type block type
  81  * @param block block to get the key for
  82  * @param block_size number of bytes in block
  83  * @param key set to the key (query) for the given block
  84  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
  85  *         (or if extracting a key from a block of this type does not work)
  86  */
  87 static int
  88 block_plugin_dht_get_key (void *cls,
  89                           enum GNUNET_BLOCK_Type type,
  90                           const void *block,
  91                           size_t block_size, GNUNET_HashCode * key)
  92 {
  93   const struct GNUNET_MessageHeader *msg;
  94   const struct GNUNET_HELLO_Message *hello;
  95   struct GNUNET_PeerIdentity *pid;
  96
  97   if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
  98     return GNUNET_SYSERR;
  99   if (block_size < sizeof (struct GNUNET_MessageHeader))
 100   {
 101     GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 102                      "block-dht",
 103                      _("Block not of type %u\n"), GNUNET_BLOCK_TYPE_DHT_HELLO);
 104     return GNUNET_NO;
 105   }
 106   msg = block;
 107   if (block_size != ntohs (msg->size))
 108   {
 109     GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 110                      "block-dht",
 111                      _("Size mismatch for block\n"),
 112                      GNUNET_BLOCK_TYPE_DHT_HELLO);
 113     return GNUNET_NO;
 114   }
 115   hello = block;
 116   pid = (struct GNUNET_PeerIdentity *) key;
 117   if (GNUNET_OK != GNUNET_HELLO_get_id (hello, pid))
 118   {
 119     GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 120                      "block-dht",
 121                      _("Block of type %u is malformed\n"),
 122                      GNUNET_BLOCK_TYPE_DHT_HELLO);
 123     return GNUNET_NO;
 124   }
 125   return GNUNET_OK;
 126 }
 127
 128
 129 /**
 130  * Entry point for the plugin.
 131  */
 132 void *
 133 libgnunet_plugin_block_dht_init (void *cls)
 134 {
 135   static enum GNUNET_BLOCK_Type types[] =
 136   {
 137     GNUNET_BLOCK_TYPE_DHT_HELLO,
 138     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 139   };
 140   struct GNUNET_BLOCK_PluginFunctions *api;
 141
 142   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
 143   api->evaluate = &block_plugin_dht_evaluate;
 144   api->get_key = &block_plugin_dht_get_key;
 145   api->types = types;
 146   return api;
 147 }
 148
 149
 150 /**
 151  * Exit point from the plugin.
 152  */
 153 void *
 154 libgnunet_plugin_block_dht_done (void *cls)
 155 {
 156   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 157
 158   GNUNET_free (api);
 159   return NULL;
 160 }
 161
 162 /* end of plugin_block_dht.c */