src/util/container_bloomfilter.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2006, 2008, 2011, 2012 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file util/container_bloomfilter.c
  22  * @brief data structure used to reduce disk accesses.
  23  *
  24  * The idea basically: Create a signature for each element in the
  25  * database. Add those signatures to a bit array. When doing a lookup,
  26  * check if the bit array matches the signature of the requested
  27  * element. If yes, address the disk, otherwise return 'not found'.
  28  *
  29  * A property of the bloom filter is that sometimes we will have
  30  * a match even if the element is not on the disk (then we do
  31  * an unnecessary disk access), but what's most important is that
  32  * we never get a single "false negative".
  33  *
  34  * To be able to delete entries from the bloom filter, we maintain
  35  * a 4 bit counter in the file on the drive (we still use only one
  36  * bit in memory).
  37  *
  38  * @author Igor Wronsky
  39  * @author Christian Grothoff
  40  */
  41
  42 #include "platform.h"
  43 #include "gnunet_common.h"
  44 #include "gnunet_container_lib.h"
  45 #include "gnunet_disk_lib.h"
  46
  47 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
  48
  49 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
  50
  51 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
  52
  53 struct GNUNET_CONTAINER_BloomFilter
  54 {
  55
  56   /**
  57    * The actual bloomfilter bit array
  58    */
  59   char *bitArray;
  60
  61   /**
  62    * Filename of the filter
  63    */
  64   char *filename;
  65
  66   /**
  67    * The bit counter file on disk
  68    */
  69   struct GNUNET_DISK_FileHandle *fh;
  70
  71   /**
  72    * How many bits we set for each stored element
  73    */
  74   unsigned int addressesPerElement;
  75
  76   /**
  77    * Size of bitArray in bytes
  78    */
  79   size_t bitArraySize;
  80
  81 };
  82
  83
  84
  85 /**
  86  * Get size of the bloom filter.
  87  *
  88  * @param bf the filter
  89  * @return number of bytes used for the data of the bloom filter
  90  */
  91 size_t
  92 GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter
  93                                        *bf)
  94 {
  95   if (bf == NULL)
  96     return 0;
  97   return bf->bitArraySize;
  98 }
  99
 100
 101 /**
 102  * Copy an existing memory.  Any association with a file
 103  * on-disk will be lost in the process.
 104  * @param bf the filter to copy
 105  * @return copy of the bf
 106  */
 107 struct GNUNET_CONTAINER_BloomFilter *
 108 GNUNET_CONTAINER_bloomfilter_copy (const struct GNUNET_CONTAINER_BloomFilter
 109                                    *bf)
 110 {
 111   return GNUNET_CONTAINER_bloomfilter_init (bf->bitArray, bf->bitArraySize,
 112                                             bf->addressesPerElement);
 113 }
 114
 115
 116 /**
 117  * Sets a bit active in the bitArray. Increment bit-specific
 118  * usage counter on disk only if below 4bit max (==15).
 119  *
 120  * @param bitArray memory area to set the bit in
 121  * @param bitIdx which bit to set
 122  */
 123 static void
 124 setBit (char *bitArray, unsigned int bitIdx)
 125 {
 126   size_t arraySlot;
 127   unsigned int targetBit;
 128
 129   arraySlot = bitIdx / 8;
 130   targetBit = (1L << (bitIdx % 8));
 131   bitArray[arraySlot] |= targetBit;
 132 }
 133
 134 /**
 135  * Clears a bit from bitArray. Bit is cleared from the array
 136  * only if the respective usage counter on the disk hits/is zero.
 137  *
 138  * @param bitArray memory area to set the bit in
 139  * @param bitIdx which bit to unset
 140  */
 141 static void
 142 clearBit (char *bitArray, unsigned int bitIdx)
 143 {
 144   size_t slot;
 145   unsigned int targetBit;
 146
 147   slot = bitIdx / 8;
 148   targetBit = (1L << (bitIdx % 8));
 149   bitArray[slot] = bitArray[slot] & (~targetBit);
 150 }
 151
 152 /**
 153  * Checks if a bit is active in the bitArray
 154  *
 155  * @param bitArray memory area to set the bit in
 156  * @param bitIdx which bit to test
 157  * @return GNUNET_YES if the bit is set, GNUNET_NO if not.
 158  */
 159 static int
 160 testBit (char *bitArray, unsigned int bitIdx)
 161 {
 162   size_t slot;
 163   unsigned int targetBit;
 164
 165   slot = bitIdx / 8;
 166   targetBit = (1L << (bitIdx % 8));
 167   if (bitArray[slot] & targetBit)
 168     return GNUNET_YES;
 169   else
 170     return GNUNET_NO;
 171 }
 172
 173 /**
 174  * Sets a bit active in the bitArray and increments
 175  * bit-specific usage counter on disk (but only if
 176  * the counter was below 4 bit max (==15)).
 177  *
 178  * @param bitArray memory area to set the bit in
 179  * @param bitIdx which bit to test
 180  * @param fh A file to keep the 4 bit address usage counters in
 181  */
 182 static void
 183 incrementBit (char *bitArray, unsigned int bitIdx,
 184               const struct GNUNET_DISK_FileHandle *fh)
 185 {
 186   OFF_T fileSlot;
 187   unsigned char value;
 188   unsigned int high;
 189   unsigned int low;
 190   unsigned int targetLoc;
 191
 192   setBit (bitArray, bitIdx);
 193   if (GNUNET_DISK_handle_invalid (fh))
 194     return;
 195   /* Update the counter file on disk */
 196   fileSlot = bitIdx / 2;
 197   targetLoc = bitIdx % 2;
 198
 199   GNUNET_assert (fileSlot ==
 200                  GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_DISK_SEEK_SET));
 201   if (1 != GNUNET_DISK_file_read (fh, &value, 1))
 202     value = 0;
 203   low = value & 0xF;
 204   high = (value & (~0xF)) >> 4;
 205
 206   if (targetLoc == 0)
 207   {
 208     if (low < 0xF)
 209       low++;
 210   }
 211   else
 212   {
 213     if (high < 0xF)
 214       high++;
 215   }
 216   value = ((high << 4) | low);
 217   GNUNET_assert (fileSlot ==
 218                  GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_DISK_SEEK_SET));
 219   GNUNET_assert (1 == GNUNET_DISK_file_write (fh, &value, 1));
 220 }
 221
 222 /**
 223  * Clears a bit from bitArray if the respective usage
 224  * counter on the disk hits/is zero.
 225  *
 226  * @param bitArray memory area to set the bit in
 227  * @param bitIdx which bit to test
 228  * @param fh A file to keep the 4bit address usage counters in
 229  */
 230 static void
 231 decrementBit (char *bitArray, unsigned int bitIdx,
 232               const struct GNUNET_DISK_FileHandle *fh)
 233 {
 234   OFF_T fileSlot;
 235   unsigned char value;
 236   unsigned int high;
 237   unsigned int low;
 238   unsigned int targetLoc;
 239
 240   if (GNUNET_DISK_handle_invalid (fh))
 241     return;                     /* cannot decrement! */
 242   /* Each char slot in the counter file holds two 4 bit counters */
 243   fileSlot = bitIdx / 2;
 244   targetLoc = bitIdx % 2;
 245   GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_DISK_SEEK_SET);
 246   if (1 != GNUNET_DISK_file_read (fh, &value, 1))
 247     value = 0;
 248   low = value & 0xF;
 249   high = (value & 0xF0) >> 4;
 250
 251   /* decrement, but once we have reached the max, never go back! */
 252   if (targetLoc == 0)
 253   {
 254     if ((low > 0) && (low < 0xF))
 255       low--;
 256     if (low == 0)
 257     {
 258       clearBit (bitArray, bitIdx);
 259     }
 260   }
 261   else
 262   {
 263     if ((high > 0) && (high < 0xF))
 264       high--;
 265     if (high == 0)
 266     {
 267       clearBit (bitArray, bitIdx);
 268     }
 269   }
 270   value = ((high << 4) | low);
 271   GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_DISK_SEEK_SET);
 272   GNUNET_assert (1 == GNUNET_DISK_file_write (fh, &value, 1));
 273 }
 274
 275 #define BUFFSIZE 65536
 276
 277 /**
 278  * Creates a file filled with zeroes
 279  *
 280  * @param fh the file handle
 281  * @param size the size of the file
 282  * @return GNUNET_OK if created ok, GNUNET_SYSERR otherwise
 283  */
 284 static int
 285 make_empty_file (const struct GNUNET_DISK_FileHandle *fh, size_t size)
 286 {
 287   char buffer[BUFFSIZE];
 288   size_t bytesleft = size;
 289   int res = 0;
 290
 291   if (GNUNET_DISK_handle_invalid (fh))
 292     return GNUNET_SYSERR;
 293   memset (buffer, 0, sizeof (buffer));
 294   GNUNET_DISK_file_seek (fh, 0, GNUNET_DISK_SEEK_SET);
 295   while (bytesleft > 0)
 296   {
 297     if (bytesleft > sizeof (buffer))
 298     {
 299       res = GNUNET_DISK_file_write (fh, buffer, sizeof (buffer));
 300       if (res >= 0)
 301         bytesleft -= res;
 302     }
 303     else
 304     {
 305       res = GNUNET_DISK_file_write (fh, buffer, bytesleft);
 306       if (res >= 0)
 307         bytesleft -= res;
 308     }
 309     if (GNUNET_SYSERR == res)
 310       return GNUNET_SYSERR;
 311   }
 312   return GNUNET_OK;
 313 }
 314
 315 /* ************** GNUNET_CONTAINER_BloomFilter iterator ********* */
 316
 317 /**
 318  * Iterator (callback) method to be called by the
 319  * bloomfilter iterator on each bit that is to be
 320  * set or tested for the key.
 321  *
 322  * @param cls closure
 323  * @param bf the filter to manipulate
 324  * @param bit the current bit
 325  * @return GNUNET_YES to continue, GNUNET_NO to stop early
 326  */
 327 typedef int (*BitIterator) (void *cls,
 328                             const struct GNUNET_CONTAINER_BloomFilter * bf,
 329                             unsigned int bit);
 330
 331
 332 /**
 333  * Call an iterator for each bit that the bloomfilter
 334  * must test or set for this element.
 335  *
 336  * @param bf the filter
 337  * @param callback the method to call
 338  * @param arg extra argument to callback
 339  * @param key the key for which we iterate over the BF bits
 340  */
 341 static void
 342 iterateBits (const struct GNUNET_CONTAINER_BloomFilter *bf,
 343              BitIterator callback, void *arg, const GNUNET_HashCode * key)
 344 {
 345   GNUNET_HashCode tmp[2];
 346   int bitCount;
 347   unsigned int round;
 348   unsigned int slot = 0;
 349
 350   bitCount = bf->addressesPerElement;
 351   tmp[0] = *key;
 352   round = 0;
 353   GNUNET_assert (bf->bitArraySize > 0);
 354   GNUNET_assert (bf->bitArraySize * 8LL > bf->bitArraySize);
 355   while (bitCount > 0)
 356   {
 357     while (slot < (sizeof (GNUNET_HashCode) / sizeof (uint32_t)))
 358     {
 359       if (GNUNET_YES !=
 360           callback (arg, bf,
 361                     (((uint32_t *) & tmp[round & 1])[slot]) %
 362                     ((bf->bitArraySize * 8LL))))
 363         return;
 364       slot++;
 365       bitCount--;
 366       if (bitCount == 0)
 367         break;
 368     }
 369     if (bitCount > 0)
 370     {
 371       GNUNET_CRYPTO_hash (&tmp[round & 1], sizeof (GNUNET_HashCode),
 372                           &tmp[(round + 1) & 1]);
 373       round++;
 374       slot = 0;
 375     }
 376   }
 377 }
 378
 379
 380 /**
 381  * Callback: increment bit
 382  *
 383  * @param cls pointer to writeable form of bf
 384  * @param bf the filter to manipulate
 385  * @param bit the bit to increment
 386  * @return GNUNET_YES
 387  */
 388 static int
 389 incrementBitCallback (void *cls, const struct GNUNET_CONTAINER_BloomFilter *bf,
 390                       unsigned int bit)
 391 {
 392   struct GNUNET_CONTAINER_BloomFilter *b = cls;
 393
 394   incrementBit (b->bitArray, bit, bf->fh);
 395   return GNUNET_YES;
 396 }
 397
 398
 399 /**
 400  * Callback: decrement bit
 401  *
 402  * @param cls pointer to writeable form of bf
 403  * @param bf the filter to manipulate
 404  * @param bit the bit to decrement
 405  * @return GNUNET_YES
 406  */
 407 static int
 408 decrementBitCallback (void *cls, const struct GNUNET_CONTAINER_BloomFilter *bf,
 409                       unsigned int bit)
 410 {
 411   struct GNUNET_CONTAINER_BloomFilter *b = cls;
 412
 413   decrementBit (b->bitArray, bit, bf->fh);
 414   return GNUNET_YES;
 415 }
 416
 417
 418 /**
 419  * Callback: test if all bits are set
 420  *
 421  * @param cls pointer set to GNUNET_NO if bit is not set
 422  * @param bf the filter
 423  * @param bit the bit to test
 424  * @return YES if the bit is set, NO if not
 425  */
 426 static int
 427 testBitCallback (void *cls, const struct GNUNET_CONTAINER_BloomFilter *bf,
 428                  unsigned int bit)
 429 {
 430   int *arg = cls;
 431
 432   if (GNUNET_NO == testBit (bf->bitArray, bit))
 433   {
 434     *arg = GNUNET_NO;
 435     return GNUNET_NO;
 436   }
 437   return GNUNET_YES;
 438 }
 439
 440 /* *********************** INTERFACE **************** */
 441
 442 /**
 443  * Load a bloom-filter from a file.
 444  *
 445  * @param filename the name of the file (or the prefix)
 446  * @param size the size of the bloom-filter (number of
 447  *        bytes of storage space to use); will be rounded up
 448  *        to next power of 2
 449  * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
 450  *        element (number of bits set per element in the set)
 451  * @return the bloomfilter
 452  */
 453 struct GNUNET_CONTAINER_BloomFilter *
 454 GNUNET_CONTAINER_bloomfilter_load (const char *filename, size_t size,
 455                                    unsigned int k)
 456 {
 457   struct GNUNET_CONTAINER_BloomFilter *bf;
 458   char *rbuff;
 459   OFF_T pos;
 460   int i;
 461   size_t ui;
 462   OFF_T fsize;
 463   int must_read;
 464
 465   GNUNET_assert (NULL != filename);
 466   if ((k == 0) || (size == 0))
 467     return NULL;
 468   if (size < BUFFSIZE)
 469     size = BUFFSIZE;
 470   ui = 1;
 471   while ( (ui < size) &&
 472           (ui * 2 > ui) )
 473     ui *= 2;
 474   size = ui;                    /* make sure it's a power of 2 */
 475
 476   bf = GNUNET_malloc (sizeof (struct GNUNET_CONTAINER_BloomFilter));
 477   /* Try to open a bloomfilter file */
 478   if (GNUNET_YES == GNUNET_DISK_file_test (filename))
 479     bf->fh =
 480       GNUNET_DISK_file_open (filename,
 481                              GNUNET_DISK_OPEN_READWRITE,
 482                              GNUNET_DISK_PERM_USER_READ |
 483                              GNUNET_DISK_PERM_USER_WRITE);
 484   if (NULL != bf->fh)
 485   {
 486     /* file existed, try to read it! */
 487     must_read = GNUNET_YES;
 488     if (GNUNET_OK !=
 489         GNUNET_DISK_file_handle_size (bf->fh, &fsize))
 490     {
 491       GNUNET_DISK_file_close (bf->fh);
 492       GNUNET_free (bf);
 493       return NULL;
 494     }
 495     if (fsize == 0)
 496     {
 497       /* found existing empty file, just overwrite */
 498       if (GNUNET_OK != make_empty_file (bf->fh, size * 4LL))
 499       {
 500         GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
 501                              "write");
 502         GNUNET_DISK_file_close (bf->fh);
 503         GNUNET_free (bf);
 504         return NULL;
 505       }
 506     }
 507     else if (fsize != size * 4LL)
 508     {
 509       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 510                   _("Size of file on disk is incorrect for this Bloom filter (want %llu, have %llu)\n"),
 511                   (unsigned long long) (size * 4LL),
 512                   (unsigned long long) fsize);
 513       GNUNET_DISK_file_close (bf->fh);
 514       GNUNET_free (bf);
 515       return NULL;
 516     }
 517   }
 518   else
 519   {
 520     /* file did not exist, don't read, just create */
 521     must_read = GNUNET_NO;
 522     bf->fh =
 523       GNUNET_DISK_file_open (filename,
 524                              GNUNET_DISK_OPEN_CREATE |
 525                              GNUNET_DISK_OPEN_READWRITE,
 526                              GNUNET_DISK_PERM_USER_READ |
 527                              GNUNET_DISK_PERM_USER_WRITE);
 528     if (NULL == bf->fh)
 529       {
 530         GNUNET_free (bf);
 531         return NULL;
 532       }
 533     if (GNUNET_OK != make_empty_file (bf->fh, size * 4LL))
 534     {
 535       GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
 536                            "write");
 537       GNUNET_DISK_file_close (bf->fh);
 538       GNUNET_free (bf);
 539       return NULL;
 540     }
 541   }
 542   bf->filename = GNUNET_strdup (filename);
 543   /* Alloc block */
 544   bf->bitArray = GNUNET_malloc_large (size);
 545   if (bf->bitArray == NULL)
 546   {
 547     if (bf->fh != NULL)
 548       GNUNET_DISK_file_close (bf->fh);
 549     GNUNET_free (bf->filename);
 550     GNUNET_free (bf);
 551     return NULL;
 552   }
 553   bf->bitArraySize = size;
 554   bf->addressesPerElement = k;
 555   if (GNUNET_YES != must_read)
 556     return bf; /* already done! */
 557   /* Read from the file what bits we can */
 558   rbuff = GNUNET_malloc (BUFFSIZE);
 559   pos = 0;
 560   while (pos < size * 8LL)
 561   {
 562     int res;
 563
 564     res = GNUNET_DISK_file_read (bf->fh, rbuff, BUFFSIZE);
 565     if (res == -1)
 566     {
 567       LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "read", bf->filename);
 568       GNUNET_free (rbuff);
 569       GNUNET_free (bf->filename);
 570       GNUNET_DISK_file_close (bf->fh);
 571       GNUNET_free (bf);
 572       return NULL;
 573     }
 574     if (res == 0)
 575       break;                    /* is ok! we just did not use that many bits yet */
 576     for (i = 0; i < res; i++)
 577     {
 578       if ((rbuff[i] & 0x0F) != 0)
 579         setBit (bf->bitArray, pos + i * 2);
 580       if ((rbuff[i] & 0xF0) != 0)
 581         setBit (bf->bitArray, pos + i * 2 + 1);
 582     }
 583     if (res < BUFFSIZE)
 584       break;
 585     pos += BUFFSIZE * 2;        /* 2 bits per byte in the buffer */
 586   }
 587   GNUNET_free (rbuff);
 588   return bf;
 589 }
 590
 591
 592 /**
 593  * Create a bloom filter from raw bits.
 594  *
 595  * @param data the raw bits in memory (maybe NULL,
 596  *        in which case all bits should be considered
 597  *        to be zero).
 598  * @param size the size of the bloom-filter (number of
 599  *        bytes of storage space to use); also size of data
 600  *        -- unless data is NULL
 601  * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
 602  *        element (number of bits set per element in the set)
 603  * @return the bloomfilter
 604  */
 605 struct GNUNET_CONTAINER_BloomFilter *
 606 GNUNET_CONTAINER_bloomfilter_init (const char *data, size_t size,
 607                                    unsigned int k)
 608 {
 609   struct GNUNET_CONTAINER_BloomFilter *bf;
 610
 611   if ((0 == k) || (0 == size))
 612     return NULL;
 613   bf = GNUNET_malloc (sizeof (struct GNUNET_CONTAINER_BloomFilter));
 614   bf->filename = NULL;
 615   bf->fh = NULL;
 616   bf->bitArray = GNUNET_malloc_large (size);
 617   if (NULL == bf->bitArray)
 618   {
 619     GNUNET_free (bf);
 620     return NULL;
 621   }
 622   bf->bitArraySize = size;
 623   bf->addressesPerElement = k;
 624   if (NULL != data)
 625     memcpy (bf->bitArray, data, size);
 626   return bf;
 627 }
 628
 629
 630 /**
 631  * Copy the raw data of this bloomfilter into
 632  * the given data array.
 633  *
 634  * @param bf bloomfilter to take the raw data from
 635  * @param data where to write the data
 636  * @param size the size of the given data array
 637  * @return GNUNET_SYSERR if the data array is not big enough
 638  */
 639 int
 640 GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct
 641                                            GNUNET_CONTAINER_BloomFilter *bf,
 642                                            char *data, size_t size)
 643 {
 644   if (NULL == bf)
 645     return GNUNET_SYSERR;
 646   if (bf->bitArraySize != size)
 647     return GNUNET_SYSERR;
 648   memcpy (data, bf->bitArray, size);
 649   return GNUNET_OK;
 650 }
 651
 652
 653 /**
 654  * Free the space associated with a filter
 655  * in memory, flush to drive if needed (do not
 656  * free the space on the drive)
 657  *
 658  * @param bf the filter
 659  */
 660 void
 661 GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter *bf)
 662 {
 663   if (NULL == bf)
 664     return;
 665   if (bf->fh != NULL)
 666     GNUNET_DISK_file_close (bf->fh);
 667   GNUNET_free_non_null (bf->filename);
 668   GNUNET_free (bf->bitArray);
 669   GNUNET_free (bf);
 670 }
 671
 672
 673 /**
 674  * Reset a bloom filter to empty. Clears the file on disk.
 675  *
 676  * @param bf the filter
 677  */
 678 void
 679 GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter *bf)
 680 {
 681   if (NULL == bf)
 682     return;
 683
 684   memset (bf->bitArray, 0, bf->bitArraySize);
 685   if (bf->filename != NULL)
 686     make_empty_file (bf->fh, bf->bitArraySize * 4LL);
 687 }
 688
 689
 690 /**
 691  * Test if an element is in the filter.
 692  *
 693  * @param e the element
 694  * @param bf the filter
 695  * @return GNUNET_YES if the element is in the filter, GNUNET_NO if not
 696  */
 697 int
 698 GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter
 699                                    *bf, const GNUNET_HashCode * e)
 700 {
 701   int res;
 702
 703   if (NULL == bf)
 704     return GNUNET_YES;
 705   res = GNUNET_YES;
 706   iterateBits (bf, &testBitCallback, &res, e);
 707   return res;
 708 }
 709
 710
 711 /**
 712  * Add an element to the filter
 713  *
 714  * @param bf the filter
 715  * @param e the element
 716  */
 717 void
 718 GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter *bf,
 719                                   const GNUNET_HashCode * e)
 720 {
 721   if (NULL == bf)
 722     return;
 723   iterateBits (bf, &incrementBitCallback, bf, e);
 724 }
 725
 726
 727 /**
 728  * Or the entries of the given raw data array with the
 729  * data of the given bloom filter.  Assumes that
 730  * the size of the data array and the current filter
 731  * match.
 732  *
 733  * @param bf the filter
 734  * @param data the data to or-in
 735  * @param size number of bytes in data
 736  */
 737 int
 738 GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
 739                                  const char *data, size_t size)
 740 {
 741   unsigned int i;
 742   unsigned int n;
 743   unsigned long long *fc;
 744   const unsigned long long *dc;
 745
 746   if (NULL == bf)
 747     return GNUNET_YES;
 748   if (bf->bitArraySize != size)
 749     return GNUNET_SYSERR;
 750   fc = (unsigned long long *) bf->bitArray;
 751   dc = (const unsigned long long *) data;
 752   n = size / sizeof (unsigned long long);
 753
 754   for (i = 0; i < n; i++)
 755     fc[i] |= dc[i];
 756   for (i = n * sizeof (unsigned long long); i < size; i++)
 757     bf->bitArray[i] |= data[i];
 758   return GNUNET_OK;
 759 }
 760
 761 /**
 762  * Or the entries of the given raw data array with the
 763  * data of the given bloom filter.  Assumes that
 764  * the size of the data array and the current filter
 765  * match.
 766  *
 767  * @param bf the filter
 768  * @param to_or the bloomfilter to or-in
 769  * @param size number of bytes in data
 770  */
 771 int
 772 GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
 773                                   const struct GNUNET_CONTAINER_BloomFilter
 774                                   *to_or, size_t size)
 775 {
 776   unsigned int i;
 777   unsigned int n;
 778   unsigned long long *fc;
 779   const unsigned long long *dc;
 780
 781   if (NULL == bf)
 782     return GNUNET_YES;
 783   if (bf->bitArraySize != size)
 784     return GNUNET_SYSERR;
 785   fc = (unsigned long long *) bf->bitArray;
 786   dc = (const unsigned long long *) to_or->bitArray;
 787   n = size / sizeof (unsigned long long);
 788
 789   for (i = 0; i < n; i++)
 790     fc[i] |= dc[i];
 791   for (i = n * sizeof (unsigned long long); i < size; i++)
 792     bf->bitArray[i] |= to_or->bitArray[i];
 793   return GNUNET_OK;
 794 }
 795
 796 /**
 797  * Remove an element from the filter.
 798  *
 799  * @param bf the filter
 800  * @param e the element to remove
 801  */
 802 void
 803 GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter *bf,
 804                                      const GNUNET_HashCode * e)
 805 {
 806   if (NULL == bf)
 807     return;
 808   if (bf->filename == NULL)
 809     return;
 810   iterateBits (bf, &decrementBitCallback, bf, e);
 811 }
 812
 813 /**
 814  * Resize a bloom filter.  Note that this operation
 815  * is pretty costly.  Essentially, the bloom filter
 816  * needs to be completely re-build.
 817  *
 818  * @param bf the filter
 819  * @param iterator an iterator over all elements stored in the BF
 820  * @param iterator_cls argument to the iterator function
 821  * @param size the new size for the filter
 822  * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
 823  */
 824 void
 825 GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
 826                                      GNUNET_HashCodeIterator iterator,
 827                                      void *iterator_cls, size_t size,
 828                                      unsigned int k)
 829 {
 830   GNUNET_HashCode hc;
 831   unsigned int i;
 832
 833   GNUNET_free (bf->bitArray);
 834   i = 1;
 835   while (i < size)
 836     i *= 2;
 837   size = i;                     /* make sure it's a power of 2 */
 838
 839   bf->bitArraySize = size;
 840   bf->bitArray = GNUNET_malloc (size);
 841   if (bf->filename != NULL)
 842     make_empty_file (bf->fh, bf->bitArraySize * 4LL);
 843   while (GNUNET_YES == iterator (iterator_cls, &hc))
 844     GNUNET_CONTAINER_bloomfilter_add (bf, &hc);
 845 }
 846
 847 /* end of container_bloomfilter.c */