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