-check return value
[oweals/gnunet.git] / src / block / plugin_block_test.c
index 76853a1f0819b4feff14113d1ef290ea395608ec..01ed14fc2cb9085250d9eb7b2223b97d4e18b54b 100644 (file)
@@ -28,8 +28,6 @@
 #include "platform.h"
 #include "gnunet_block_plugin.h"
 
-#define DEBUG_TEST GNUNET_NO
-
 
 /**
  * Number of bits we set per entry in the bloomfilter.
  * @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 extrended 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
  */
 static enum GNUNET_BLOCK_EvaluationResult
 block_plugin_test_evaluate (void *cls, 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,
                             size_t reply_block_size)
 {
-  GNUNET_HashCode chash;
-  GNUNET_HashCode mhash;
+  struct GNUNET_HashCode chash;
+  struct GNUNET_HashCode mhash;
 
-  if (type != GNUNET_BLOCK_TYPE_TEST)
+  if ( GNUNET_BLOCK_TYPE_TEST != type)
     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
-  if (xquery_size != 0)
+  if (0 != xquery_size)
+  {
+    GNUNET_break_op (0);
     return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
-  if (reply_block_size == 0)
+  }
+  if (NULL == reply_block)
     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 
   if (NULL != bf)
@@ -75,14 +76,14 @@ block_plugin_test_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
     GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
     GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
     if (NULL != *bf)
-      {
-       if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
-         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
-      }
+    {
+      if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
+        return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
+    }
     else
-      {
-       *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
-      }
+    {
+      *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
+    }
     GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
   }
   return GNUNET_BLOCK_EVALUATION_OK_MORE;
@@ -95,15 +96,15 @@ block_plugin_test_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
  * @param cls closure
  * @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)
  */
 static int
 block_plugin_test_get_key (void *cls, enum GNUNET_BLOCK_Type type,
                            const void *block, size_t block_size,
-                           GNUNET_HashCode * key)
+                           struct GNUNET_HashCode * key)
 {
   /* always fails since there is no fixed relationship between
    * keys and values for test values */
@@ -113,6 +114,9 @@ block_plugin_test_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 
 /**
  * Entry point for the plugin.
+ *
+ * @param cls NULL
+ * @return the exported block API
  */
 void *
 libgnunet_plugin_block_test_init (void *cls)
@@ -124,7 +128,7 @@ libgnunet_plugin_block_test_init (void *cls)
   };
   struct GNUNET_BLOCK_PluginFunctions *api;
 
-  api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
+  api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
   api->evaluate = &block_plugin_test_evaluate;
   api->get_key = &block_plugin_test_get_key;
   api->types = types;
@@ -134,11 +138,14 @@ libgnunet_plugin_block_test_init (void *cls)
 
 /**
  * Exit point from the plugin.
+ *
+ * @param cls the return value from #libgnunet_plugin_block_test_init
+ * @return NULL
  */
 void *
 libgnunet_plugin_block_test_done (void *cls)
 {
-  struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
+  struct GNUNET_BLOCK_PluginFunctions *api = cls;
 
   GNUNET_free (api);
   return NULL;