LRN: Fix automake deps to allow -j* builds again
[oweals/gnunet.git] / src / util / container_bloomfilter.c
index 39baed6c77eb3cf36bb879813ffcc4f8eff21dd7..b4c3ad08da0b20a8751ea94877d94338e1264fc5 100644 (file)
@@ -75,6 +75,38 @@ struct GNUNET_CONTAINER_BloomFilter
 };
 
 
+
+/**
+ * Get size of the bloom filter.
+ *
+ * @param bf the filter
+ * @return number of bytes used for the data of the bloom filter
+ */
+size_t 
+GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter
+                                      *bf)
+{
+  if (bf == NULL)
+    return 0;
+  return bf->bitArraySize;
+}
+
+
+/**
+ * Copy an existing memory.  Any association with a file
+ * on-disk will be lost in the process.
+ * @param bf the filter to copy
+ * @return copy of the bf
+ */
+struct GNUNET_CONTAINER_BloomFilter *
+GNUNET_CONTAINER_bloomfilter_copy (const struct GNUNET_CONTAINER_BloomFilter *bf)
+{
+  return GNUNET_CONTAINER_bloomfilter_init (bf->bitArray,
+                                           bf->bitArraySize,
+                                           bf->addressesPerElement);                                       
+}
+
+
 /**
  * Sets a bit active in the bitArray. Increment bit-specific
  * usage counter on disk only if below 4bit max (==15).
@@ -142,7 +174,8 @@ testBit (char *bitArray, unsigned int bitIdx)
  * @param fh A file to keep the 4 bit address usage counters in
  */
 static void
-incrementBit (char *bitArray, unsigned int bitIdx, const struct GNUNET_DISK_FileHandle *fh)
+incrementBit (char *bitArray, unsigned int bitIdx,
+              const struct GNUNET_DISK_FileHandle *fh)
 {
   off_t fileSlot;
   unsigned char value;
@@ -157,8 +190,8 @@ incrementBit (char *bitArray, unsigned int bitIdx, const struct GNUNET_DISK_File
   fileSlot = bitIdx / 2;
   targetLoc = bitIdx % 2;
 
-  GNUNET_assert (fileSlot == 
-                GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_DISK_SEEK_SET));
+  GNUNET_assert (fileSlot ==
+                 GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_DISK_SEEK_SET));
   if (1 != GNUNET_DISK_file_read (fh, &value, 1))
     value = 0;
   low = value & 0xF;
@@ -175,9 +208,9 @@ incrementBit (char *bitArray, unsigned int bitIdx, const struct GNUNET_DISK_File
         high++;
     }
   value = ((high << 4) | low);
-  GNUNET_assert (fileSlot == GNUNET_DISK_file_seek (fh, 
-                                                   fileSlot, 
-                                                   GNUNET_DISK_SEEK_SET));
+  GNUNET_assert (fileSlot == GNUNET_DISK_file_seek (fh,
+                                                    fileSlot,
+                                                    GNUNET_DISK_SEEK_SET));
   GNUNET_assert (1 == GNUNET_DISK_file_write (fh, &value, 1));
 }
 
@@ -190,7 +223,8 @@ incrementBit (char *bitArray, unsigned int bitIdx, const struct GNUNET_DISK_File
  * @param fh A file to keep the 4bit address usage counters in
  */
 static void
-decrementBit (char *bitArray, unsigned int bitIdx, const struct GNUNET_DISK_FileHandle *fh)
+decrementBit (char *bitArray, unsigned int bitIdx,
+              const struct GNUNET_DISK_FileHandle *fh)
 {
   off_t fileSlot;
   unsigned char value;
@@ -243,8 +277,7 @@ decrementBit (char *bitArray, unsigned int bitIdx, const struct GNUNET_DISK_File
  * @return GNUNET_OK if created ok, GNUNET_SYSERR otherwise
  */
 static int
-makeEmptyFile (const struct GNUNET_DISK_FileHandle *fh, 
-              size_t size)
+makeEmptyFile (const struct GNUNET_DISK_FileHandle *fh, size_t size)
 {
   char *buffer;
   size_t bytesleft = size;
@@ -286,7 +319,7 @@ makeEmptyFile (const struct GNUNET_DISK_FileHandle *fh,
  * @param bit the current bit
  */
 typedef void (*BitIterator) (void *cls,
-                            struct GNUNET_CONTAINER_BloomFilter * bf,
+                             const struct GNUNET_CONTAINER_BloomFilter *bf,
                              unsigned int bit);
 
 /**
@@ -299,8 +332,8 @@ typedef void (*BitIterator) (void *cls,
  * @param key the key for which we iterate over the BF bits
  */
 static void
-iterateBits (struct GNUNET_CONTAINER_BloomFilter *bf,
-             BitIterator callback, void *arg, const GNUNET_HashCode * key)
+iterateBits (const struct GNUNET_CONTAINER_BloomFilter *bf,
+             BitIterator callback, void *arg, const GNUNET_HashCode *key)
 {
   GNUNET_HashCode tmp[2];
   int bitCount;
@@ -314,8 +347,8 @@ iterateBits (struct GNUNET_CONTAINER_BloomFilter *bf,
     {
       while (slot < (sizeof (GNUNET_HashCode) / sizeof (uint32_t)))
         {
-          callback (arg, 
-                   bf,
+          callback (arg,
+                    bf,
                     (((uint32_t *) &tmp[round & 1])[slot]) &
                     ((bf->bitArraySize * 8) - 1));
           slot++;
@@ -336,31 +369,33 @@ iterateBits (struct GNUNET_CONTAINER_BloomFilter *bf,
 /**
  * Callback: increment bit
  *
- * @param cls not used
+ * @param cls pointer to writeable form of bf
  * @param bf the filter to manipulate
  * @param bit the bit to increment
  */
 static void
 incrementBitCallback (void *cls,
-                     struct GNUNET_CONTAINER_BloomFilter *bf,
+                      const struct GNUNET_CONTAINER_BloomFilter *bf,
                       unsigned int bit)
 {
-  incrementBit (bf->bitArray, bit, bf->fh);
+  struct GNUNET_CONTAINER_BloomFilter *b = cls;
+  incrementBit (b->bitArray, bit, bf->fh);
 }
 
 /**
  * Callback: decrement bit
  *
- * @param cls not used
+ * @param cls pointer to writeable form of bf
  * @param bf the filter to manipulate
  * @param bit the bit to decrement
  */
 static void
 decrementBitCallback (void *cls,
-                     struct GNUNET_CONTAINER_BloomFilter *bf,
+                      const struct GNUNET_CONTAINER_BloomFilter *bf,
                       unsigned int bit)
 {
-  decrementBit (bf->bitArray, bit, bf->fh);
+  struct GNUNET_CONTAINER_BloomFilter *b = cls;
+  decrementBit (b->bitArray, bit, bf->fh);
 }
 
 /**
@@ -372,7 +407,8 @@ decrementBitCallback (void *cls,
  */
 static void
 testBitCallback (void *cls,
-                struct GNUNET_CONTAINER_BloomFilter *bf, unsigned int bit)
+                 const struct GNUNET_CONTAINER_BloomFilter *bf,
+                unsigned int bit)
 {
   int *arg = cls;
   if (GNUNET_NO == testBit (bf->bitArray, bit))
@@ -392,9 +428,8 @@ testBitCallback (void *cls,
  * @return the bloomfilter
  */
 struct GNUNET_CONTAINER_BloomFilter *
-GNUNET_CONTAINER_bloomfilter_load (const char *filename, 
-                                  size_t size,
-                                   unsigned int k)
+GNUNET_CONTAINER_bloomfilter_load (const char *filename,
+                                   size_t size, unsigned int k)
 {
   struct GNUNET_CONTAINER_BloomFilter *bf;
   char *rbuff;
@@ -402,6 +437,7 @@ GNUNET_CONTAINER_bloomfilter_load (const char *filename,
   int i;
   size_t ui;
 
+  GNUNET_assert (NULL != filename);
   if ((k == 0) || (size == 0))
     return NULL;
   if (size < BUFFSIZE)
@@ -413,60 +449,57 @@ GNUNET_CONTAINER_bloomfilter_load (const char *filename,
 
   bf = GNUNET_malloc (sizeof (struct GNUNET_CONTAINER_BloomFilter));
   /* Try to open a bloomfilter file */
-  if (filename != NULL)
-    {
-      bf->fh = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READWRITE
-                                     | GNUNET_DISK_OPEN_CREATE,
-          GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE);
-      if (NULL == bf->fh)
-        {
-          GNUNET_free (bf);
-          return NULL;
-        }
-      bf->filename = GNUNET_strdup (filename);
-    }
-  else
+  bf->fh = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READWRITE
+                                 | GNUNET_DISK_OPEN_CREATE,
+                                 GNUNET_DISK_PERM_USER_READ |
+                                 GNUNET_DISK_PERM_USER_WRITE);
+  if (NULL == bf->fh)
     {
-      bf->filename = NULL;
-      bf->fh = NULL;
+      GNUNET_free (bf);
+      return NULL;
     }
+  bf->filename = GNUNET_strdup (filename);
   /* Alloc block */
   bf->bitArray = GNUNET_malloc_large (size);
+  if (bf->bitArray == NULL)
+    {
+      if (bf->fh != NULL)
+       GNUNET_DISK_file_close (bf->fh);
+      GNUNET_free (bf->filename);
+      GNUNET_free (bf);
+      return NULL;
+    }
   bf->bitArraySize = size;
   bf->addressesPerElement = k;
   memset (bf->bitArray, 0, bf->bitArraySize);
 
-  if (bf->filename != NULL)
+  /* Read from the file what bits we can */
+  rbuff = GNUNET_malloc (BUFFSIZE);
+  pos = 0;
+  while (pos < size * 8)
     {
-      /* Read from the file what bits we can */
-      rbuff = GNUNET_malloc (BUFFSIZE);
-      pos = 0;
-      while (pos < size * 8)
-        {
-          int res;
-
-          res = GNUNET_DISK_file_read (bf->fh, rbuff, BUFFSIZE);
-         if (res == -1)
-           {
-             GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
-                                       "read",
-                                       bf->filename);
-           }
-          if (res == 0)
-            break;              /* is ok! we just did not use that many bits yet */
-          for (i = 0; i < res; i++)
-            {
-              if ((rbuff[i] & 0x0F) != 0)
-                setBit (bf->bitArray, pos + i * 2);
-              if ((rbuff[i] & 0xF0) != 0)
-                setBit (bf->bitArray, pos + i * 2 + 1);
-            }
-          if (res < BUFFSIZE)
-            break;
-          pos += BUFFSIZE * 2;  /* 2 bits per byte in the buffer */
-        }
-      GNUNET_free (rbuff);
+      int res;
+      
+      res = GNUNET_DISK_file_read (bf->fh, rbuff, BUFFSIZE);
+      if (res == -1)
+       {
+         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
+                                   "read", bf->filename);
+       }
+      if (res == 0)
+       break;              /* is ok! we just did not use that many bits yet */
+      for (i = 0; i < res; i++)
+       {
+         if ((rbuff[i] & 0x0F) != 0)
+           setBit (bf->bitArray, pos + i * 2);
+         if ((rbuff[i] & 0xF0) != 0)
+           setBit (bf->bitArray, pos + i * 2 + 1);
+       }
+      if (res < BUFFSIZE)
+       break;
+      pos += BUFFSIZE * 2;  /* 2 bits per byte in the buffer */
     }
+  GNUNET_free (rbuff);
   return bf;
 }
 
@@ -486,8 +519,7 @@ GNUNET_CONTAINER_bloomfilter_load (const char *filename,
  */
 struct GNUNET_CONTAINER_BloomFilter *
 GNUNET_CONTAINER_bloomfilter_init (const char *data,
-                                  size_t size,
-                                   unsigned int k)
+                                   size_t size, unsigned int k)
 {
   struct GNUNET_CONTAINER_BloomFilter *bf;
   size_t ui;
@@ -506,6 +538,11 @@ GNUNET_CONTAINER_bloomfilter_init (const char *data,
   bf->filename = NULL;
   bf->fh = NULL;
   bf->bitArray = GNUNET_malloc_large (size);
+  if (bf->bitArray == NULL)
+    {
+      GNUNET_free (bf);
+      return NULL;
+    }
   bf->bitArraySize = size;
   bf->addressesPerElement = k;
   if (data != NULL)
@@ -520,18 +557,17 @@ GNUNET_CONTAINER_bloomfilter_init (const char *data,
  * Copy the raw data of this bloomfilter into
  * the given data array.
  *
+ * @param bf bloomfilter to take the raw data from
  * @param data where to write the data
  * @param size the size of the given data array
  * @return GNUNET_SYSERR if the data array is not big enough
  */
 int
-GNUNET_CONTAINER_bloomfilter_get_raw_data (struct GNUNET_CONTAINER_BloomFilter
-                                           *bf, char *data, 
-                                          size_t size)
+GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct GNUNET_CONTAINER_BloomFilter
+                                           *bf, char *data, size_t size)
 {
   if (NULL == bf)
     return GNUNET_SYSERR;
-
   if (bf->bitArraySize != size)
     return GNUNET_SYSERR;
   memcpy (data, bf->bitArray, size);
@@ -550,11 +586,9 @@ GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter *bf)
 {
   if (NULL == bf)
     return;
-  if (bf->filename != NULL)
-    {
-      GNUNET_DISK_file_close (bf->fh);
-      GNUNET_free (bf->filename);
-    }
+  if (bf->fh != NULL)
+    GNUNET_DISK_file_close (bf->fh);
+  GNUNET_free_non_null (bf->filename);
   GNUNET_free (bf->bitArray);
   GNUNET_free (bf);
 }
@@ -584,7 +618,7 @@ GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter *bf)
  * @return GNUNET_YES if the element is in the filter, GNUNET_NO if not
  */
 int
-GNUNET_CONTAINER_bloomfilter_test (struct GNUNET_CONTAINER_BloomFilter *bf,
+GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter *bf,
                                    const GNUNET_HashCode * e)
 {
   int res;
@@ -609,7 +643,7 @@ GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter *bf,
 
   if (NULL == bf)
     return;
-  iterateBits (bf, &incrementBitCallback, NULL, e);
+  iterateBits (bf, &incrementBitCallback, bf, e);
 }
 
 
@@ -625,22 +659,63 @@ GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter *bf,
  */
 int
 GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
-                                 const char *data,
-                                size_t size)
+                                 const char *data, size_t size)
 {
   unsigned int i;
+  unsigned int n;
+  unsigned long long* fc;
+  const unsigned long long* dc;
 
   if (NULL == bf)
     return GNUNET_YES;
   if (bf->bitArraySize != size)
     return GNUNET_SYSERR;
-  /* FIXME: we could do this 4-8x faster by
-     going over int/long arrays */
-  for (i = 0; i < size; i++)
+  fc = (unsigned long long*) bf->bitArray;
+  dc = (const unsigned long long*) data;
+  n = size / sizeof (unsigned long long);
+
+  for (i = 0; i < n; i++)
+    fc[i] |= dc[i];
+  for (i = n * sizeof(unsigned long long); i < size; i++)
     bf->bitArray[i] |= data[i];
   return GNUNET_OK;
 }
 
+/**
+ * Or the entries of the given raw data array with the
+ * data of the given bloom filter.  Assumes that
+ * the size of the data array and the current filter
+ * match.
+ *
+ * @param bf the filter
+ * @param to_or the bloomfilter to or-in
+ * @param size number of bytes in data
+ */
+int
+GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
+                                  const struct GNUNET_CONTAINER_BloomFilter *to_or,
+                                  size_t size)
+{
+  unsigned int i;
+  unsigned int n;
+  unsigned long long* fc;
+  const unsigned long long* dc;
+
+  if (NULL == bf)
+    return GNUNET_YES;
+  if (bf->bitArraySize != size)
+    return GNUNET_SYSERR;
+  fc = (unsigned long long*) bf->bitArray;
+  dc = (const unsigned long long*) to_or->bitArray;
+  n = size / sizeof (unsigned long long);
+
+  for (i = 0; i < n; i++)
+    fc[i] |= dc[i];
+  for (i = n * sizeof(unsigned long long); i < size; i++)
+    bf->bitArray[i] |= to_or->bitArray[i];
+  return GNUNET_OK;
+}
+
 /**
  * Remove an element from the filter.
  *
@@ -655,7 +730,7 @@ GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter *bf,
     return;
   if (bf->filename == NULL)
     return;
-  iterateBits (bf, &decrementBitCallback, NULL, e);
+  iterateBits (bf, &decrementBitCallback, bf, e);
 }
 
 /**
@@ -665,16 +740,15 @@ GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter *bf,
  *
  * @param bf the filter
  * @param iterator an iterator over all elements stored in the BF
- * @param iterator_arg argument to the iterator function
+ * @param iterator_cls argument to the iterator function
  * @param size the new size for the filter
  * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
  */
 void
 GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
                                      GNUNET_HashCodeIterator iterator,
-                                     void *iterator_arg, 
-                                    size_t size,
-                                     unsigned int k)
+                                     void *iterator_cls,
+                                     size_t size, unsigned int k)
 {
   GNUNET_HashCode hc;
   unsigned int i;
@@ -690,7 +764,7 @@ GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
   memset (bf->bitArray, 0, bf->bitArraySize);
   if (bf->filename != NULL)
     makeEmptyFile (bf->fh, bf->bitArraySize * 4);
-  while (GNUNET_YES == iterator (iterator_arg, &hc))
+  while (GNUNET_YES == iterator (iterator_cls, &hc))
     GNUNET_CONTAINER_bloomfilter_add (bf, &hc);
 }