consensus now implemented with primitive conclusion group selection
[oweals/gnunet.git] / src / consensus / ibf.c
index fb3bbe7cdc4bec9196ea2d5cc058337d457e213e..d3218ff9b7d9b9f11fe81c631392c568e167280d 100644 (file)
       Boston, MA 02111-1307, USA.
 */
 
-
 /**
  * @file consensus/ibf.c
  * @brief implementation of the invertible bloom filter
  * @author Florian Dold
  */
 
-
 #include "ibf.h"
 
-
 /**
  * Create a key from a hashcode.
  *
  * @param hash the hashcode
  * @return a key
  */
-uint64_t
+struct IBF_Key
 ibf_key_from_hashcode (const struct GNUNET_HashCode *hash)
 {
-  return GNUNET_ntohll (*(uint64_t *) hash);
+  /* FIXME: endianess */
+  return *(struct IBF_Key *) hash;
 }
 
-
 /**
  * Create a hashcode from a key, by replicating the key
  * until the hascode is filled
@@ -50,12 +47,13 @@ ibf_key_from_hashcode (const struct GNUNET_HashCode *hash)
  * @param dst hashcode to store the result in
  */
 void
-ibf_hashcode_from_key (uint64_t key, struct GNUNET_HashCode *dst)
+ibf_hashcode_from_key (struct IBF_Key key, struct GNUNET_HashCode *dst)
 {
-  uint64_t *p;
-  int i;
-  p = (uint64_t *) dst;
-  for (i = 0; i < 8; i++)
+  struct IBF_Key *p;
+  unsigned int i;
+  const unsigned int keys_per_hashcode = sizeof (struct GNUNET_HashCode) / sizeof (struct IBF_Key);
+  p = (struct IBF_Key *) dst;
+  for (i = 0; i < keys_per_hashcode; i++)
     *p++ = key;
 }
 
@@ -70,14 +68,16 @@ ibf_hashcode_from_key (uint64_t key, struct GNUNET_HashCode *dst)
  * @return the newly created invertible bloom filter
  */
 struct InvertibleBloomFilter *
-ibf_create (uint32_t size, unsigned int hash_num, uint32_t salt)
+ibf_create (uint32_t size, uint8_t hash_num, uint32_t salt)
 {
   struct InvertibleBloomFilter *ibf;
 
+  /* TODO: use malloc_large */
+
   ibf = GNUNET_malloc (sizeof (struct InvertibleBloomFilter));
   ibf->count = GNUNET_malloc (size * sizeof (uint8_t));
-  ibf->id_sum = GNUNET_malloc (size * sizeof (struct GNUNET_HashCode));
-  ibf->hash_sum = GNUNET_malloc (size * sizeof (struct GNUNET_HashCode));
+  ibf->key_sum = GNUNET_malloc (size * sizeof (struct GNUNET_HashCode));
+  ibf->key_hash_sum = GNUNET_malloc (size * sizeof (struct GNUNET_HashCode));
   ibf->size = size;
   ibf->hash_num = hash_num;
 
@@ -89,7 +89,7 @@ ibf_create (uint32_t size, unsigned int hash_num, uint32_t salt)
  */
 static inline void
 ibf_get_indices (const struct InvertibleBloomFilter *ibf,
-                 uint64_t key, int *dst)
+                 struct IBF_Key key, int *dst)
 {
   struct GNUNET_HashCode bucket_indices;
   unsigned int filled = 0;
@@ -113,20 +113,20 @@ ibf_get_indices (const struct InvertibleBloomFilter *ibf,
 
 static void
 ibf_insert_into  (struct InvertibleBloomFilter *ibf,
-                  uint64_t key,
+                  struct IBF_Key key,
                   const int *buckets, int side)
 {
   int i;
   struct GNUNET_HashCode key_hash_sha;
-  uint32_t key_hash;
+  struct IBF_KeyHash key_hash;
   GNUNET_CRYPTO_hash (&key, sizeof key, &key_hash_sha);
-  key_hash = key_hash_sha.bits[0];
+  key_hash.key_hash_val = key_hash_sha.bits[0];
   for (i = 0; i < ibf->hash_num; i++)
   {
     const int bucket = buckets[i];
-    ibf->count[bucket] += side;
-    ibf->id_sum[bucket] ^= key;
-    ibf->hash_sum[bucket] ^= key_hash;
+    ibf->count[bucket].count_val += side;
+    ibf->key_sum[bucket].key_val ^= key.key_val;
+    ibf->key_hash_sum[bucket].key_hash_val ^= key_hash.key_hash_val;
   }
 }
 
@@ -138,7 +138,7 @@ ibf_insert_into  (struct InvertibleBloomFilter *ibf,
  * @param id the element's hash code
  */
 void
-ibf_insert (struct InvertibleBloomFilter *ibf, uint64_t key)
+ibf_insert (struct InvertibleBloomFilter *ibf, struct IBF_Key key)
 {
   int buckets[ibf->hash_num];
   ibf_get_indices (ibf, key, buckets);
@@ -154,11 +154,11 @@ ibf_is_empty (struct InvertibleBloomFilter *ibf)
   int i;
   for (i = 0; i < ibf->size; i++)
   {
-    if (0 != ibf->count[i])
+    if (0 != ibf->count[i].count_val)
       return GNUNET_NO;
-    if (0 != ibf->hash_sum[i])
+    if (0 != ibf->key_hash_sum[i].key_hash_val)
       return GNUNET_NO;
-    if (0 != ibf->id_sum[i])
+    if (0 != ibf->key_sum[i].key_val)
       return GNUNET_NO;
   }
   return GNUNET_YES;
@@ -179,9 +179,9 @@ ibf_is_empty (struct InvertibleBloomFilter *ibf)
  */
 int
 ibf_decode (struct InvertibleBloomFilter *ibf,
-            int *ret_side, uint64_t *ret_id)
+            int *ret_side, struct IBF_Key *ret_id)
 {
-  uint32_t hash;
+  struct IBF_KeyHash hash;
   int i;
   struct GNUNET_HashCode key_hash_sha;
   int buckets[ibf->hash_num];
@@ -194,20 +194,20 @@ ibf_decode (struct InvertibleBloomFilter *ibf,
     int hit;
 
     /* we can only decode from pure buckets */
-    if ((1 != ibf->count[i]) && (-1 != ibf->count[i]))
+    if ((1 != ibf->count[i].count_val) && (-1 != ibf->count[i].count_val))
       continue;
 
-    GNUNET_CRYPTO_hash (&ibf->id_sum[i], sizeof (uint64_t), &key_hash_sha);
-    hash = key_hash_sha.bits[0];
+    GNUNET_CRYPTO_hash (&ibf->key_sum[i], sizeof (struct IBF_Key), &key_hash_sha);
+    hash.key_hash_val = key_hash_sha.bits[0];
 
     /* test if the hash matches the key */
-    if (hash != ibf->hash_sum[i])
+    if (hash.key_hash_val != ibf->key_hash_sum[i].key_hash_val)
       continue;
 
     /* test if key in bucket hits its own location,
      * if not, the key hash was subject to collision */
     hit = GNUNET_NO;
-    ibf_get_indices (ibf, ibf->id_sum[i], buckets);
+    ibf_get_indices (ibf, ibf->key_sum[i], buckets);
     for (j = 0; j < ibf->hash_num; j++)
       if (buckets[j] == i)
         hit = GNUNET_YES;
@@ -216,12 +216,12 @@ ibf_decode (struct InvertibleBloomFilter *ibf,
       continue;
 
     if (NULL != ret_side)
-      *ret_side = ibf->count[i];
+      *ret_side = ibf->count[i].count_val;
     if (NULL != ret_id)
-      *ret_id = ibf->id_sum[i];
+      *ret_id = ibf->key_sum[i];
 
     /* insert on the opposite side, effectively removing the element */
-    ibf_insert_into (ibf, ibf->id_sum[i], buckets, -ibf->count[i]);
+    ibf_insert_into (ibf, ibf->key_sum[i], buckets, -ibf->count[i].count_val);
 
     return GNUNET_YES;
   }
@@ -232,6 +232,128 @@ ibf_decode (struct InvertibleBloomFilter *ibf,
 }
 
 
+/**
+ * Write an ibf.
+ * 
+ * @param ibf the ibf to write
+ * @param start with which bucket to start
+ * @param count how many buckets to write
+ * @param buf buffer to write the data to, will be updated to point to the
+ *            first byte after the written data
+ * @param size pointer to the size of the buffer, will be updated, can be NULL
+ */
+void
+ibf_write_slice (const struct InvertibleBloomFilter *ibf, uint32_t start, uint32_t count, void **buf, size_t *size)
+{
+  struct IBF_Key *key_dst;
+  struct IBF_KeyHash *key_hash_dst;
+  struct IBF_Count *count_dst;
+
+  /* update size and check for overflow */
+  if (NULL != size)
+  {
+    size_t old_size;
+    old_size = *size;
+    *size = *size - count * IBF_BUCKET_SIZE;
+    GNUNET_assert (*size < old_size);
+  }
+  /* copy keys */
+  key_dst = (struct IBF_Key *) *buf;
+  memcpy (key_dst, ibf->key_sum + start, count * sizeof *key_dst);
+  key_dst += count;
+  /* copy key hashes */
+  key_hash_dst = (struct IBF_KeyHash *) key_dst;
+  memcpy (key_hash_dst, ibf->key_hash_sum + start, count * sizeof *key_hash_dst);
+  key_hash_dst += count;
+  /* copy counts */
+  count_dst = (struct IBF_Count *) key_hash_dst;
+  memcpy (count_dst, ibf->count + start, count * sizeof *count_dst);
+  count_dst += count;
+  /* returned buffer is at the end of written data*/
+  *buf = (void *) count_dst;
+}
+
+
+/**
+ * Read an ibf.
+ *
+ * @param buf pointer to the buffer to write to, will point to first
+ *            byte after the written data
+ * @param size size of the buffer, will be updated
+ * @param start which bucket to start at
+ * @param count how many buckets to read
+ * @param dst ibf to write buckets to
+ * @return GNUNET_OK on success
+ */
+int
+ibf_read_slice (void **buf, size_t *size, uint32_t start, uint32_t count, struct InvertibleBloomFilter *ibf)
+{
+  struct IBF_Key *key_src;
+  struct IBF_KeyHash *key_hash_src;
+  struct IBF_Count *count_src;
+
+  /* update size and check for overflow */
+  if (NULL != size)
+  {
+    size_t old_size;
+    old_size = *size;
+    *size = *size - count * IBF_BUCKET_SIZE;
+    if (*size > old_size)
+      return GNUNET_SYSERR;
+  }
+  /* copy keys */
+  key_src = (struct IBF_Key *) *buf;
+  memcpy (ibf->key_sum + start, key_src, count * sizeof *key_src);
+  key_src += count;
+  /* copy key hashes */
+  key_hash_src = (struct IBF_KeyHash *) key_src;
+  memcpy (ibf->key_hash_sum + start, key_hash_src, count * sizeof *key_hash_src);
+  key_hash_src += count;
+  /* copy counts */
+  count_src = (struct IBF_Count *) key_hash_src;
+  memcpy (ibf->count + start, count_src, count * sizeof *count_src);
+  count_src += count;
+  /* returned buffer is at the end of written data*/
+  *buf = (void *) count_src;
+  return GNUNET_OK;
+}
+
+
+/**
+ * Write an ibf.
+ * 
+ * @param ibf the ibf to write
+ * @param start with which bucket to start
+ * @param count how many buckets to write
+ * @param buf buffer to write the data to, will be updated to point to the
+ *            first byte after the written data
+ * @param size pointer to the size of the buffer, will be updated, can be NULL
+ */
+void
+ibf_write (const struct InvertibleBloomFilter *ibf, void **buf, size_t *size)
+{
+  ibf_write_slice (ibf, 0, ibf->size, buf, size);
+}
+
+
+/**
+ * Read an ibf.
+ *
+ * @param buf pointer to the buffer to write to, will point to first
+ *            byte after the written data
+ * @param size size of the buffer, will be updated
+ * @param start which bucket to start at
+ * @param count how many buckets to read
+ * @param dst ibf to write buckets to
+ * @return GNUNET_OK on success
+ */
+int
+ibf_read (void **buf, size_t *size, struct InvertibleBloomFilter *dst)
+{
+  return ibf_read_slice (buf, size, 0, dst->size, dst);
+}
+
+
 /**
  * Subtract ibf2 from ibf1, storing the result in ibf1.
  * The two IBF's must have the same parameters size and hash_num.
@@ -250,31 +372,33 @@ ibf_subtract (struct InvertibleBloomFilter *ibf1, const struct InvertibleBloomFi
 
   for (i = 0; i < ibf1->size; i++)
   {
-    ibf1->count[i] -= ibf2->count[i];
-    ibf1->hash_sum[i] ^= ibf2->hash_sum[i];
-    ibf1->id_sum[i] ^= ibf2->id_sum[i];
+    ibf1->count[i].count_val -= ibf2->count[i].count_val;
+    ibf1->key_hash_sum[i].key_hash_val ^= ibf2->key_hash_sum[i].key_hash_val;
+    ibf1->key_sum[i].key_val ^= ibf2->key_sum[i].key_val;
   }
 }
 
+
 /**
  * Create a copy of an IBF, the copy has to be destroyed properly.
  *
  * @param ibf the IBF to copy
  */
 struct InvertibleBloomFilter *
-ibf_dup (struct InvertibleBloomFilter *ibf)
+ibf_dup (const struct InvertibleBloomFilter *ibf)
 {
   struct InvertibleBloomFilter *copy;
   copy = GNUNET_malloc (sizeof *copy);
   copy->hash_num = ibf->hash_num;
   copy->salt = ibf->salt;
   copy->size = ibf->size;
-  copy->hash_sum = GNUNET_memdup (ibf->hash_sum, ibf->size * sizeof (struct GNUNET_HashCode));
-  copy->id_sum = GNUNET_memdup (ibf->id_sum, ibf->size * sizeof (struct GNUNET_HashCode));
-  copy->count = GNUNET_memdup (ibf->count, ibf->size * sizeof (uint8_t));
+  copy->key_hash_sum = GNUNET_memdup (ibf->key_hash_sum, ibf->size * sizeof (struct IBF_KeyHash));
+  copy->key_sum = GNUNET_memdup (ibf->key_sum, ibf->size * sizeof (struct IBF_Key));
+  copy->count = GNUNET_memdup (ibf->count, ibf->size * sizeof (struct IBF_Count));
   return copy;
 }
 
+
 /**
  * Destroy all resources associated with the invertible bloom filter.
  * No more ibf_*-functions may be called on ibf after calling destroy.
@@ -284,8 +408,9 @@ ibf_dup (struct InvertibleBloomFilter *ibf)
 void
 ibf_destroy (struct InvertibleBloomFilter *ibf)
 {
-  GNUNET_free (ibf->hash_sum);
-  GNUNET_free (ibf->id_sum);
+  GNUNET_free (ibf->key_sum);
+  GNUNET_free (ibf->key_hash_sum);
   GNUNET_free (ibf->count);
   GNUNET_free (ibf);
 }
+