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