plugin_block_template.c

Go to the documentation of this file.

/*
     This file is part of GNUnet
     Copyright (C) 2010, 2021, 2022 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#include "platform.h"
#include "gnunet_block_plugin.h"
#include "gnunet_block_group_lib.h"
 
#define DEBUG_TEMPLATE GNUNET_EXTRA_LOGGING
 
#define BLOOMFILTER_K 16
 
 
#define TEMPLATE_BF_SIZE 8
 
 
static struct GNUNET_BLOCK_Group *
block_plugin_template_create_group (void *ctx,
                                    enum GNUNET_BLOCK_Type type,
                                    const void *raw_data,
                                    size_t raw_data_size,
                                    va_list va)
{
  unsigned int bf_size;
  const char *guard;
 
  guard = va_arg (va, const char *);
  if (0 == strcmp (guard,
                   "seen-set-size"))
    bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned
                                                                   int),
                                                           BLOOMFILTER_K);
  else if (0 == strcmp (guard,
                        "filter-size"))
    bf_size = va_arg (va, unsigned int);
  else
  {
    GNUNET_break (0);
    bf_size = TEMPLATE_BF_SIZE;
  }
  GNUNET_break (NULL == va_arg (va, const char *));
  return GNUNET_BLOCK_GROUP_bf_create (ctx,
                                       bf_size,
                                       BLOOMFILTER_K,
                                       type,
                                       raw_data,
                                       raw_data_size);
}
 
 
static enum GNUNET_GenericReturnValue
block_plugin_template_check_query (void *cls,
                                   enum GNUNET_BLOCK_Type type,
                                   const struct GNUNET_HashCode *query,
                                   const void *xquery,
                                   size_t xquery_size)
{
  return GNUNET_SYSERR;
}
 
 
static enum GNUNET_GenericReturnValue
block_plugin_template_check_block (void *cls,
                                   enum GNUNET_BLOCK_Type type,
                                   const void *block,
                                   size_t block_size)
{
  return GNUNET_SYSERR;
}
 
 
static enum GNUNET_BLOCK_ReplyEvaluationResult
block_plugin_template_check_reply (
  void *cls,
  enum GNUNET_BLOCK_Type type,
  struct GNUNET_BLOCK_Group *group,
  const struct GNUNET_HashCode *query,
  const void *xquery,
  size_t xquery_size,
  const void *reply_block,
  size_t reply_block_size)
{
  return GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED;
}
 
 
static enum GNUNET_GenericReturnValue
block_plugin_template_get_key (void *cls,
                               enum GNUNET_BLOCK_Type type,
                               const void *block,
                               size_t block_size,
                               struct GNUNET_HashCode *key)
{
  return GNUNET_SYSERR;
}
 
 
void *
libgnunet_plugin_block_template_init (void *cls)
{
  static const enum GNUNET_BLOCK_Type types[] = {
    /* NOTE: insert supported block types here */
    GNUNET_BLOCK_TYPE_ANY       /* end of list */
  };
  struct GNUNET_BLOCK_PluginFunctions *api;
 
  api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
  api->get_key = &block_plugin_template_get_key;
  api->check_query = &block_plugin_template_check_query;
  api->check_block = &block_plugin_template_check_block;
  api->check_reply = &block_plugin_template_check_reply;
  api->create_group = &block_plugin_template_create_group;
  api->types = types;
  return api;
}
 
 
void *
libgnunet_plugin_block_template_done (void *cls)
{
  struct GNUNET_BLOCK_PluginFunctions *api = cls;
 
  GNUNET_free (api);
  return NULL;
}
 
 
/* end of plugin_block_template.c */