- add underlay api implementation
[oweals/gnunet.git] / src / block / block.c
index 582c13eb3d9156e9c491dcbc013f3f3a03ccdf74..f38e7e0bf6b682975c9dc49701c93fede6dc327e 100644 (file)
@@ -78,10 +78,11 @@ struct GNUNET_BLOCK_Context
  * @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);
@@ -104,10 +105,10 @@ add_plugin (void *cls,
   struct GNUNET_BLOCK_PluginFunctions *api = lib_ret;
   struct Plugin *plugin;
 
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO, 
-             _("Loading block plugin `%s'\n"),
-             library_name);
-  plugin = GNUNET_malloc (sizeof (struct 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);
@@ -126,12 +127,9 @@ GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
   struct GNUNET_BLOCK_Context *ctx;
 
-  ctx = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_Context));
+  ctx = GNUNET_new (struct GNUNET_BLOCK_Context);
   ctx->cfg = cfg;
-  GNUNET_PLUGIN_load_all ("libgnunet_plugin_block_",
-                         NULL,
-                         &add_plugin,
-                         ctx);
+  GNUNET_PLUGIN_load_all ("libgnunet_plugin_block_", NULL, &add_plugin, ctx);
   return ctx;
 }
 
@@ -147,7 +145,7 @@ GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx)
   unsigned int i;
   struct Plugin *plugin;
 
-  for (i = 0; i<ctx->num_plugins;i++)
+  for (i = 0; i < ctx->num_plugins; i++)
   {
     plugin = ctx->plugins[i];
     GNUNET_break (NULL ==
@@ -168,13 +166,14 @@ GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *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;
 
-  for (i=0;i<ctx->num_plugins;i++)
+  for (i = 0; i < ctx->num_plugins; i++)
   {
     plugin = ctx->plugins[i];
     j = 0;
@@ -200,17 +199,17 @@ find_plugin (struct GNUNET_BLOCK_Context *ctx, enum GNUNET_BLOCK_Type type)
  * @param type block type
  * @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,
+                       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,
@@ -231,15 +230,15 @@ GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
  * @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)
+                      size_t block_size, struct GNUNET_HashCode * key)
 {
   struct GNUNET_BLOCK_PluginFunctions *plugin = find_plugin (ctx, type);
 
@@ -259,6 +258,7 @@ GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
  * 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
@@ -285,22 +285,23 @@ compute_bloomfilter_size (unsigned int entry_count)
  *
  * @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);