plugin_block_consensus.c File Reference

consensus block, either nested block or marker More...

#include "platform.h"
#include "consensus_protocol.h"
#include "gnunet_block_plugin.h"
#include "gnunet_block_group_lib.h"

Include dependency graph for plugin_block_consensus.c:

Go to the source code of this file.

Data Structures
struct	BlockContext
	Our closure. More...

Functions
static enum GNUNET_GenericReturnValue	block_plugin_consensus_check_query (void *cls, enum GNUNET_BLOCK_Type type, const struct GNUNET_HashCode *query, const void *xquery, size_t xquery_size)
	Function called to validate a query. More...
static enum GNUNET_GenericReturnValue	block_plugin_consensus_check_block (void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size)
	Function called to validate a block for storage. More...
static enum GNUNET_BLOCK_ReplyEvaluationResult	block_plugin_consensus_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)
	Function called to validate a reply to a request. More...
static enum GNUNET_GenericReturnValue	block_plugin_consensus_get_key (void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size, struct GNUNET_HashCode *key)
	Function called to obtain the key for a block. More...
void *	libgnunet_plugin_block_consensus_init (void *cls)
	Entry point for the plugin. More...
void *	libgnunet_plugin_block_consensus_done (void *cls)
	Exit point from the plugin. More...

Detailed Description

consensus block, either nested block or marker

Author

Christian Grothoff

Definition in file plugin_block_consensus.c.

Function Documentation

block_plugin_consensus_check_query()

static enum GNUNET_GenericReturnValue block_plugin_consensus_check_query ( void *  cls, enum GNUNET_BLOCK_Type  type, const struct GNUNET_HashCode *  query, const void *  xquery, size_t  xquery_size  )

static

Function called to validate a query.

Parameters

cls	closure
type	block type
query	original query (hash)
xquery	extrended query data (can be NULL, depending on type)
xquery_size	number of bytes in xquery

Returns

GNUNET_OK if the query is fine, GNUNET_NO if not

Definition at line 62 of file plugin_block_consensus.c.

{
  /* consensus does not use queries/DHT */
  GNUNET_break (0);
  return GNUNET_SYSERR;
}

References GNUNET_break, and GNUNET_SYSERR.

Referenced by libgnunet_plugin_block_consensus_init().

Here is the caller graph for this function:

block_plugin_consensus_check_block()

static enum GNUNET_GenericReturnValue block_plugin_consensus_check_block ( void *  cls, enum GNUNET_BLOCK_Type  type, const void *  block, size_t  block_size  )

static

Function called to validate a block for storage.

Parameters

cls	closure
type	block type
block	block data to validate
block_size	number of bytes in block

Returns

GNUNET_OK if the block is fine, GNUNET_NO if not

Definition at line 84 of file plugin_block_consensus.c.

{
  struct BlockContext *ctx = cls;
  const struct ConsensusElement *ce = block;
 
  if (block_size < sizeof(*ce))
  {
    GNUNET_break_op (0);
    return GNUNET_NO;
  }
  if ( (0 != ce->marker) ||
       (0 == ce->payload_type) )
    return GNUNET_OK;
  if (NULL == ctx->bc)
    ctx->bc = GNUNET_BLOCK_context_create (ctx->cfg);
  return GNUNET_BLOCK_check_block (ctx->bc,
                                   ntohl (ce->payload_type),
                                   &ce[1],
                                   block_size - sizeof(*ce));
}

References GNUNET_FS_Handle::cfg, ctx, GNUNET_BLOCK_check_block(), GNUNET_BLOCK_context_create(), GNUNET_break_op, GNUNET_NO, GNUNET_OK, ConsensusElement::marker, and ConsensusElement::payload_type.

Referenced by libgnunet_plugin_block_consensus_init().

Here is the call graph for this function:

Here is the caller graph for this function:

block_plugin_consensus_check_reply()

static enum GNUNET_BLOCK_ReplyEvaluationResult block_plugin_consensus_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  )

static

Function called to validate a reply to a request.

Note that it is assumed that the reply has already been matched to the key (and signatures checked) as it would be done with the GetKeyFunction and the BlockEvaluationFunction.

Parameters

cls	closure
type	block type
group	which block group to use for evaluation
query	original query (hash)
xquery	extrended query data (can be NULL, depending on type)
xquery_size	number of bytes in xquery
reply_block	response to validate
reply_block_size	number of bytes in reply_block

Returns

characterization of result

Definition at line 126 of file plugin_block_consensus.c.

{
  struct BlockContext *ctx = cls;
  const struct ConsensusElement *ce = reply_block;
 
  GNUNET_assert (reply_block_size >= sizeof(struct ConsensusElement));
  if ( (0 != ce->marker) ||
       (0 == ce->payload_type) )
    return GNUNET_BLOCK_REPLY_OK_MORE;
  if (NULL == ctx->bc)
    ctx->bc = GNUNET_BLOCK_context_create (ctx->cfg);
  return GNUNET_BLOCK_check_reply (ctx->bc,
                                   ntohl (ce->payload_type),
                                   group,
                                   query,
                                   xquery,
                                   xquery_size,
                                   &ce[1],
                                   reply_block_size - sizeof(*ce));
}

References GNUNET_FS_Handle::cfg, ctx, GNUNET_assert, GNUNET_BLOCK_check_reply(), GNUNET_BLOCK_context_create(), GNUNET_BLOCK_REPLY_OK_MORE, ConsensusElement::marker, and ConsensusElement::payload_type.

Referenced by libgnunet_plugin_block_consensus_init().

Here is the call graph for this function:

Here is the caller graph for this function:

block_plugin_consensus_get_key()

static enum GNUNET_GenericReturnValue block_plugin_consensus_get_key ( void *  cls, enum GNUNET_BLOCK_Type  type, const void *  block, size_t  block_size, struct GNUNET_HashCode *  key  )

static

Function called to obtain the key for a block.

Parameters

cls	closure
type	block type
block	block to get the key for
block_size	number of bytes in block
key	set to the key (query) for the given block

Returns

GNUNET_OK on success, GNUNET_SYSERR if type not supported (or if extracting a key from a block of this type does not work)

Definition at line 168 of file plugin_block_consensus.c.

{
  return GNUNET_SYSERR;
}

References GNUNET_SYSERR.

Referenced by libgnunet_plugin_block_consensus_init().

Here is the caller graph for this function:

libgnunet_plugin_block_consensus_init()

void * libgnunet_plugin_block_consensus_init

(

void *

cls

)

Entry point for the plugin.

Definition at line 185 of file plugin_block_consensus.c.

{
  static const enum GNUNET_BLOCK_Type types[] = {
    GNUNET_BLOCK_TYPE_CONSENSUS_ELEMENT,
    GNUNET_BLOCK_TYPE_ANY       /* end of list */
  };
  const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
  struct BlockContext *ctx;
  struct GNUNET_BLOCK_PluginFunctions *api;
 
  ctx = GNUNET_new (struct BlockContext);
  ctx->cfg = cfg;
  api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
  api->cls = ctx;
  api->get_key = &block_plugin_consensus_get_key;
  api->check_query = &block_plugin_consensus_check_query;
  api->check_block = &block_plugin_consensus_check_block;
  api->check_reply = &block_plugin_consensus_check_reply;
  api->types = types;
  return api;
}

References block_plugin_consensus_check_block(), block_plugin_consensus_check_query(), block_plugin_consensus_check_reply(), block_plugin_consensus_get_key(), cfg, GNUNET_FS_Handle::cfg, GNUNET_BLOCK_PluginFunctions::check_block, GNUNET_BLOCK_PluginFunctions::check_query, GNUNET_BLOCK_PluginFunctions::check_reply, GNUNET_BLOCK_PluginFunctions::cls, ctx, GNUNET_BLOCK_PluginFunctions::get_key, GNUNET_BLOCK_TYPE_ANY, GNUNET_BLOCK_TYPE_CONSENSUS_ELEMENT, GNUNET_new, and GNUNET_BLOCK_PluginFunctions::types.

Here is the call graph for this function:

libgnunet_plugin_block_consensus_done()

void * libgnunet_plugin_block_consensus_done

(

void *

cls

)

Exit point from the plugin.

Definition at line 214 of file plugin_block_consensus.c.

{
  struct GNUNET_BLOCK_PluginFunctions *api = cls;
  struct BlockContext *ctx = api->cls;
 
  if (NULL != ctx->bc)
    GNUNET_BLOCK_context_destroy (ctx->bc);
  GNUNET_free (ctx);
  GNUNET_free (api);
  return NULL;
}

References GNUNET_BLOCK_PluginFunctions::cls, ctx, GNUNET_BLOCK_context_destroy(), and GNUNET_free.

Here is the call graph for this function: