/*
This file is part of GNUnet.
- (C) 2010 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
struct GNUNET_BLOCK_Context
{
/**
- * NULL-terminated array of our plugins.
+ * Array of our plugins.
*/
struct Plugin **plugins;
+ /**
+ * Size of the 'plugins' array.
+ */
+ unsigned int num_plugins;
+
/**
* Our configuration.
*/
* @param hc where to store the result.
*/
void
-GNUNET_BLOCK_mingle_hash (const GNUNET_HashCode * in, uint32_t mingle_number,
- GNUNET_HashCode * hc)
+GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode *in,
+ uint32_t mingle_number,
+ struct GNUNET_HashCode *hc)
{
- GNUNET_HashCode m;
+ struct GNUNET_HashCode m;
GNUNET_CRYPTO_hash (&mingle_number, sizeof (uint32_t), &m);
GNUNET_CRYPTO_hash_xor (&m, in, hc);
}
+/**
+ * Add a plugin to the list managed by the block library.
+ *
+ * @param cls the block context
+ * @param library_name name of the plugin
+ * @param lib_ret the plugin API
+ */
+static void
+add_plugin (void *cls,
+ const char *library_name,
+ void *lib_ret)
+{
+ struct GNUNET_BLOCK_Context *ctx = cls;
+ struct GNUNET_BLOCK_PluginFunctions *api = lib_ret;
+ struct Plugin *plugin;
+
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Loading block plugin `%s'\n",
+ library_name);
+ plugin = GNUNET_new (struct Plugin);
+ plugin->api = api;
+ plugin->library_name = GNUNET_strdup (library_name);
+ GNUNET_array_append (ctx->plugins, ctx->num_plugins, plugin);
+}
+
+
+
/**
* Create a block context. Loads the block plugins.
*
GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg)
{
struct GNUNET_BLOCK_Context *ctx;
- struct GNUNET_BLOCK_PluginFunctions *api;
- struct Plugin *plugin;
- unsigned int num_plugins;
- char *plugs;
- char *pos;
- char *libname;
- ctx = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_Context));
+ ctx = GNUNET_new (struct GNUNET_BLOCK_Context);
ctx->cfg = cfg;
- num_plugins = 0;
- if (GNUNET_OK ==
- GNUNET_CONFIGURATION_get_value_string (cfg, "block", "PLUGINS", &plugs))
- {
- GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Loading block plugins `%s'\n"),
- plugs);
- pos = strtok (plugs, " ");
- while (pos != NULL)
- {
- GNUNET_asprintf (&libname, "libgnunet_plugin_block_%s", pos);
- api = GNUNET_PLUGIN_load (libname, NULL);
- if (api == NULL)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _("Failed to load block plugin `%s'\n"), pos);
- GNUNET_free (libname);
- }
- else
- {
- plugin = GNUNET_malloc (sizeof (struct Plugin));
- plugin->api = api;
- plugin->library_name = libname;
- GNUNET_array_append (ctx->plugins, num_plugins, plugin);
- }
- pos = strtok (NULL, " ");
- }
- GNUNET_free (plugs);
- }
- GNUNET_array_append (ctx->plugins, num_plugins, NULL);
+ GNUNET_PLUGIN_load_all ("libgnunet_plugin_block_", NULL, &add_plugin, ctx);
return ctx;
}
unsigned int i;
struct Plugin *plugin;
- i = 0;
- while (NULL != (plugin = ctx->plugins[i]))
+ for (i = 0; i < ctx->num_plugins; i++)
{
+ plugin = ctx->plugins[i];
GNUNET_break (NULL ==
GNUNET_PLUGIN_unload (plugin->library_name, plugin->api));
GNUNET_free (plugin->library_name);
GNUNET_free (plugin);
- i++;
}
GNUNET_free (ctx->plugins);
GNUNET_free (ctx);
* @return NULL if no matching plugin exists
*/
static struct GNUNET_BLOCK_PluginFunctions *
-find_plugin (struct GNUNET_BLOCK_Context *ctx, enum GNUNET_BLOCK_Type type)
+find_plugin (struct GNUNET_BLOCK_Context *ctx,
+ enum GNUNET_BLOCK_Type type)
{
struct Plugin *plugin;
unsigned int i;
unsigned int j;
- i = 0;
- while (NULL != (plugin = ctx->plugins[i]))
+ for (i = 0; i < ctx->num_plugins; i++)
{
+ plugin = ctx->plugins[i];
j = 0;
while (0 != (plugin->api->types[j]))
{
return plugin->api;
j++;
}
- i++;
}
return NULL;
}
*
* @param ctx block contxt
* @param type block type
+ * @param eo control flags
* @param query original query (hash)
* @param bf pointer to bloom filter associated with query; possibly updated (!)
- * @param bf_mutator mutation value for bf
+ * @param bf_mutator mutation value for @a bf
* @param xquery extended query data (can be NULL, depending on type)
- * @param xquery_size number of bytes in xquery
+ * @param xquery_size number of bytes in @a xquery
* @param reply_block response to validate
- * @param reply_block_size number of bytes in reply block
+ * @param reply_block_size number of bytes in @a reply_block
* @return characterization of result
*/
enum GNUNET_BLOCK_EvaluationResult
GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
enum GNUNET_BLOCK_Type type,
- const GNUNET_HashCode * query,
+ enum GNUNET_BLOCK_EvaluationOptions eo,
+ const struct GNUNET_HashCode *query,
struct GNUNET_CONTAINER_BloomFilter **bf,
- int32_t bf_mutator, const void *xquery,
- size_t xquery_size, const void *reply_block,
+ int32_t bf_mutator,
+ const void *xquery,
+ size_t xquery_size,
+ const void *reply_block,
size_t reply_block_size)
{
struct GNUNET_BLOCK_PluginFunctions *plugin = find_plugin (ctx, type);
if (plugin == NULL)
return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
- return plugin->evaluate (plugin->cls, type, query, bf, bf_mutator, xquery,
- xquery_size, reply_block, reply_block_size);
+ return plugin->evaluate (plugin->cls,
+ type,
+ eo,
+ query,
+ bf,
+ bf_mutator,
+ xquery,
+ xquery_size,
+ reply_block,
+ reply_block_size);
}
* @param ctx block context
* @param type block type
* @param block block to get the key for
- * @param block_size number of bytes in block
+ * @param block_size number of bytes in @a block
* @param key set to the key (query) for the given block
- * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
* (or if extracting a key from a block of this type does not work)
*/
int
GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
- enum GNUNET_BLOCK_Type type, const void *block,
- size_t block_size, GNUNET_HashCode * key)
+ enum GNUNET_BLOCK_Type type,
+ const void *block,
+ size_t block_size,
+ struct GNUNET_HashCode *key)
{
struct GNUNET_BLOCK_PluginFunctions *plugin = find_plugin (ctx, type);
/**
* How many bytes should a bloomfilter be if we have already seen
- * entry_count responses? Note that GNUNET_CONSTANTS_BLOOMFILTER_K gives us the number
- * of bits set per entry. Furthermore, we should not re-size the
- * filter too often (to keep it cheap).
+ * entry_count responses? Note that #GNUNET_CONSTANTS_BLOOMFILTER_K
+ * gives us the number of bits set per entry. Furthermore, we should
+ * not re-size the filter too often (to keep it cheap).
*
* Since other peers will also add entries but not resize the filter,
* we should generally pick a slightly larger size than what the
* strict math would suggest.
*
+ * @param entry_count expected number of entries in the Bloom filter
* @return must be a power of two and smaller or equal to 2^15.
*/
static size_t
*
* @param bf_mutator mutation value to use
* @param seen_results results already seen
- * @param seen_results_count number of entries in 'seen_results'
+ * @param seen_results_count number of entries in @a seen_results
* @return NULL if seen_results_count is 0, otherwise a BF
* that would match the given results.
*/
struct GNUNET_CONTAINER_BloomFilter *
GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator,
- const GNUNET_HashCode *seen_results,
- unsigned int seen_results_count)
+ const struct GNUNET_HashCode *seen_results,
+ unsigned int seen_results_count)
{
struct GNUNET_CONTAINER_BloomFilter *bf;
- GNUNET_HashCode mhash;
+ struct GNUNET_HashCode mhash;
unsigned int i;
size_t nsize;
nsize = compute_bloomfilter_size (seen_results_count);
- bf = GNUNET_CONTAINER_bloomfilter_init (NULL, nsize, GNUNET_CONSTANTS_BLOOMFILTER_K);
+ bf = GNUNET_CONTAINER_bloomfilter_init (NULL, nsize,
+ GNUNET_CONSTANTS_BLOOMFILTER_K);
for (i = 0; i < seen_results_count; i++)
{
GNUNET_BLOCK_mingle_hash (&seen_results[i], bf_mutator, &mhash);