src/util/container_bloomfilter.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2006, 2008, 2011 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   while (bitCount > 0)
 354   {
 355     while (slot < (sizeof (GNUNET_HashCode) / sizeof (uint32_t)))
 356     {
 357       if (GNUNET_YES !=
 358           callback (arg, bf,
 359                     (((uint32_t *) & tmp[round & 1])[slot]) &
 360                     ((bf->bitArraySize * 8) - 1)))
 361         return;
 362       slot++;
 363       bitCount--;
 364       if (bitCount == 0)
 365         break;
 366     }
 367     if (bitCount > 0)
 368     {
 369       GNUNET_CRYPTO_hash (&tmp[round & 1], sizeof (GNUNET_HashCode),
 370                           &tmp[(round + 1) & 1]);
 371       round++;
 372       slot = 0;
 373     }
 374   }
 375 }
 376
 377
 378 /**
 379  * Callback: increment bit
 380  *
 381  * @param cls pointer to writeable form of bf
 382  * @param bf the filter to manipulate
 383  * @param bit the bit to increment
 384  * @return GNUNET_YES
 385  */
 386 static int
 387 incrementBitCallback (void *cls, const struct GNUNET_CONTAINER_BloomFilter *bf,
 388                       unsigned int bit)
 389 {
 390   struct GNUNET_CONTAINER_BloomFilter *b = cls;
 391
 392   incrementBit (b->bitArray, bit, bf->fh);
 393   return GNUNET_YES;
 394 }
 395
 396
 397 /**
 398  * Callback: decrement bit
 399  *
 400  * @param cls pointer to writeable form of bf
 401  * @param bf the filter to manipulate
 402  * @param bit the bit to decrement
 403  * @return GNUNET_YES
 404  */
 405 static int
 406 decrementBitCallback (void *cls, const struct GNUNET_CONTAINER_BloomFilter *bf,
 407                       unsigned int bit)
 408 {
 409   struct GNUNET_CONTAINER_BloomFilter *b = cls;
 410
 411   decrementBit (b->bitArray, bit, bf->fh);
 412   return GNUNET_YES;
 413 }
 414
 415
 416 /**
 417  * Callback: test if all bits are set
 418  *
 419  * @param cls pointer set to GNUNET_NO if bit is not set
 420  * @param bf the filter
 421  * @param bit the bit to test
 422  * @return YES if the bit is set, NO if not
 423  */
 424 static int
 425 testBitCallback (void *cls, const struct GNUNET_CONTAINER_BloomFilter *bf,
 426                  unsigned int bit)
 427 {
 428   int *arg = cls;
 429
 430   if (GNUNET_NO == testBit (bf->bitArray, bit))
 431   {
 432     *arg = GNUNET_NO;
 433     return GNUNET_NO;
 434   }
 435   return GNUNET_YES;
 436 }
 437
 438 /* *********************** INTERFACE **************** */
 439
 440 /**
 441  * Load a bloom-filter from a file.
 442  *
 443  * @param filename the name of the file (or the prefix)
 444  * @param size the size of the bloom-filter (number of
 445  *        bytes of storage space to use)
 446  * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
 447  *        element (number of bits set per element in the set)
 448  * @return the bloomfilter
 449  */
 450 struct GNUNET_CONTAINER_BloomFilter *
 451 GNUNET_CONTAINER_bloomfilter_load (const char *filename, size_t size,
 452                                    unsigned int k)
 453 {
 454   struct GNUNET_CONTAINER_BloomFilter *bf;
 455   char *rbuff;
 456   OFF_T pos;
 457   int i;
 458   size_t ui;
 459   OFF_T fsize;
 460   int must_read;
 461
 462   GNUNET_assert (NULL != filename);
 463   if ((k == 0) || (size == 0))
 464     return NULL;
 465   if (size < BUFFSIZE)
 466     size = BUFFSIZE;
 467   ui = 1;
 468   while ( (ui < size) &&
 469           (ui * 2 > ui) )
 470     ui *= 2;
 471   size = ui;                    /* make sure it's a power of 2 */
 472
 473   bf = GNUNET_malloc (sizeof (struct GNUNET_CONTAINER_BloomFilter));
 474   /* Try to open a bloomfilter file */
 475   if (GNUNET_YES == GNUNET_DISK_file_test (filename))
 476     bf->fh =
 477       GNUNET_DISK_file_open (filename,
 478                              GNUNET_DISK_OPEN_READWRITE,
 479                              GNUNET_DISK_PERM_USER_READ |
 480                              GNUNET_DISK_PERM_USER_WRITE);
 481   if (NULL != bf->fh)
 482   {
 483     /* file existed, try to read it! */
 484     must_read = GNUNET_YES;
 485     if (GNUNET_OK !=
 486         GNUNET_DISK_file_handle_size (bf->fh, &fsize))
 487     {
 488       GNUNET_DISK_file_close (bf->fh);
 489       GNUNET_free (bf);
 490       return NULL;
 491     }
 492     if (fsize == 0)
 493     {
 494       /* found existing empty file, just overwrite */
 495       if (GNUNET_OK != make_empty_file (bf->fh, size * 4LL))
 496       {
 497         GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
 498                              "write");
 499         GNUNET_DISK_file_close (bf->fh);
 500         GNUNET_free (bf);
 501         return NULL;
 502       }
 503     }
 504     else if (fsize != size * 4LL)
 505     {
 506       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 507                   _("Size of file on disk is incorrect for this Bloom filter (want %llu, have %llu)\n"),
 508                   (unsigned long long) (size * 4LL),
 509                   (unsigned long long) fsize);
 510       GNUNET_DISK_file_close (bf->fh);
 511       GNUNET_free (bf);
 512       return NULL;
 513     }
 514   }
 515   else
 516   {
 517     /* file did not exist, don't read, just create */
 518     must_read = GNUNET_NO;
 519     bf->fh =
 520       GNUNET_DISK_file_open (filename,
 521                              GNUNET_DISK_OPEN_CREATE |
 522                              GNUNET_DISK_OPEN_READWRITE,
 523                              GNUNET_DISK_PERM_USER_READ |
 524                              GNUNET_DISK_PERM_USER_WRITE);
 525     if (NULL == bf->fh)
 526       {
 527         GNUNET_free (bf);
 528         return NULL;
 529       }
 530     if (GNUNET_OK != make_empty_file (bf->fh, size * 4LL))
 531     {
 532       GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
 533                            "write");
 534       GNUNET_DISK_file_close (bf->fh);
 535       GNUNET_free (bf);
 536       return NULL;
 537     }
 538   }
 539   bf->filename = GNUNET_strdup (filename);
 540   /* Alloc block */
 541   bf->bitArray = GNUNET_malloc_large (size);
 542   if (bf->bitArray == NULL)
 543   {
 544     if (bf->fh != NULL)
 545       GNUNET_DISK_file_close (bf->fh);
 546     GNUNET_free (bf->filename);
 547     GNUNET_free (bf);
 548     return NULL;
 549   }
 550   bf->bitArraySize = size;
 551   bf->addressesPerElement = k;
 552   memset (bf->bitArray, 0, bf->bitArraySize);
 553
 554   if (GNUNET_YES != must_read)
 555     return bf; /* already done! */
 556   /* Read from the file what bits we can */
 557   rbuff = GNUNET_malloc (BUFFSIZE);
 558   pos = 0;
 559   while (pos < size * 8LL)
 560   {
 561     int res;
 562
 563     res = GNUNET_DISK_file_read (bf->fh, rbuff, BUFFSIZE);
 564     if (res == -1)
 565     {
 566       LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "read", bf->filename);
 567       GNUNET_free (rbuff);
 568       GNUNET_free (bf->filename);
 569       GNUNET_DISK_file_close (bf->fh);
 570       GNUNET_free (bf);
 571       return NULL;
 572     }
 573     if (res == 0)
 574       break;                    /* is ok! we just did not use that many bits yet */
 575     for (i = 0; i < res; i++)
 576     {
 577       if ((rbuff[i] & 0x0F) != 0)
 578         setBit (bf->bitArray, pos + i * 2);
 579       if ((rbuff[i] & 0xF0) != 0)
 580         setBit (bf->bitArray, pos + i * 2 + 1);
 581     }
 582     if (res < BUFFSIZE)
 583       break;
 584     pos += BUFFSIZE * 2;        /* 2 bits per byte in the buffer */
 585   }
 586   GNUNET_free (rbuff);
 587   return bf;
 588 }
 589
 590
 591 /**
 592  * Create a bloom filter from raw bits.
 593  *
 594  * @param data the raw bits in memory (maybe NULL,
 595  *        in which case all bits should be considered
 596  *        to be zero).
 597  * @param size the size of the bloom-filter (number of
 598  *        bytes of storage space to use); also size of data
 599  *        -- unless data is NULL
 600  * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
 601  *        element (number of bits set per element in the set)
 602  * @return the bloomfilter
 603  */
 604 struct GNUNET_CONTAINER_BloomFilter *
 605 GNUNET_CONTAINER_bloomfilter_init (const char *data, size_t size,
 606                                    unsigned int k)
 607 {
 608   struct GNUNET_CONTAINER_BloomFilter *bf;
 609   size_t ui;
 610
 611   if ((k == 0) || (size == 0))
 612     return NULL;
 613   ui = 1;
 614   while (ui < size)
 615     ui *= 2;
 616   if (size != ui)
 617   {
 618     GNUNET_break (0);
 619     return NULL;
 620   }
 621   bf = GNUNET_malloc (sizeof (struct GNUNET_CONTAINER_BloomFilter));
 622   bf->filename = NULL;
 623   bf->fh = NULL;
 624   bf->bitArray = GNUNET_malloc_large (size);
 625   if (bf->bitArray == NULL)
 626   {
 627     GNUNET_free (bf);
 628     return NULL;
 629   }
 630   bf->bitArraySize = size;
 631   bf->addressesPerElement = k;
 632   if (data != NULL)
 633     memcpy (bf->bitArray, data, size);
 634   else
 635     memset (bf->bitArray, 0, bf->bitArraySize);
 636   return bf;
 637 }
 638
 639
 640 /**
 641  * Copy the raw data of this bloomfilter into
 642  * the given data array.
 643  *
 644  * @param bf bloomfilter to take the raw data from
 645  * @param data where to write the data
 646  * @param size the size of the given data array
 647  * @return GNUNET_SYSERR if the data array is not big enough
 648  */
 649 int
 650 GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct
 651                                            GNUNET_CONTAINER_BloomFilter *bf,
 652                                            char *data, size_t size)
 653 {
 654   if (NULL == bf)
 655     return GNUNET_SYSERR;
 656   if (bf->bitArraySize != size)
 657     return GNUNET_SYSERR;
 658   memcpy (data, bf->bitArray, size);
 659   return GNUNET_OK;
 660 }
 661
 662
 663 /**
 664  * Free the space associated with a filter
 665  * in memory, flush to drive if needed (do not
 666  * free the space on the drive)
 667  *
 668  * @param bf the filter
 669  */
 670 void
 671 GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter *bf)
 672 {
 673   if (NULL == bf)
 674     return;
 675   if (bf->fh != NULL)
 676     GNUNET_DISK_file_close (bf->fh);
 677   GNUNET_free_non_null (bf->filename);
 678   GNUNET_free (bf->bitArray);
 679   GNUNET_free (bf);
 680 }
 681
 682
 683 /**
 684  * Reset a bloom filter to empty. Clears the file on disk.
 685  *
 686  * @param bf the filter
 687  */
 688 void
 689 GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter *bf)
 690 {
 691   if (NULL == bf)
 692     return;
 693
 694   memset (bf->bitArray, 0, bf->bitArraySize);
 695   if (bf->filename != NULL)
 696     make_empty_file (bf->fh, bf->bitArraySize * 4LL);
 697 }
 698
 699
 700 /**
 701  * Test if an element is in the filter.
 702  *
 703  * @param e the element
 704  * @param bf the filter
 705  * @return GNUNET_YES if the element is in the filter, GNUNET_NO if not
 706  */
 707 int
 708 GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter
 709                                    *bf, const GNUNET_HashCode * e)
 710 {
 711   int res;
 712
 713   if (NULL == bf)
 714     return GNUNET_YES;
 715   res = GNUNET_YES;
 716   iterateBits (bf, &testBitCallback, &res, e);
 717   return res;
 718 }
 719
 720
 721 /**
 722  * Add an element to the filter
 723  *
 724  * @param bf the filter
 725  * @param e the element
 726  */
 727 void
 728 GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter *bf,
 729                                   const GNUNET_HashCode * e)
 730 {
 731   if (NULL == bf)
 732     return;
 733   iterateBits (bf, &incrementBitCallback, bf, e);
 734 }
 735
 736
 737 /**
 738  * Or the entries of the given raw data array with the
 739  * data of the given bloom filter.  Assumes that
 740  * the size of the data array and the current filter
 741  * match.
 742  *
 743  * @param bf the filter
 744  * @param data the data to or-in
 745  * @param size number of bytes in data
 746  */
 747 int
 748 GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
 749                                  const char *data, size_t size)
 750 {
 751   unsigned int i;
 752   unsigned int n;
 753   unsigned long long *fc;
 754   const unsigned long long *dc;
 755
 756   if (NULL == bf)
 757     return GNUNET_YES;
 758   if (bf->bitArraySize != size)
 759     return GNUNET_SYSERR;
 760   fc = (unsigned long long *) bf->bitArray;
 761   dc = (const unsigned long long *) data;
 762   n = size / sizeof (unsigned long long);
 763
 764   for (i = 0; i < n; i++)
 765     fc[i] |= dc[i];
 766   for (i = n * sizeof (unsigned long long); i < size; i++)
 767     bf->bitArray[i] |= data[i];
 768   return GNUNET_OK;
 769 }
 770
 771 /**
 772  * Or the entries of the given raw data array with the
 773  * data of the given bloom filter.  Assumes that
 774  * the size of the data array and the current filter
 775  * match.
 776  *
 777  * @param bf the filter
 778  * @param to_or the bloomfilter to or-in
 779  * @param size number of bytes in data
 780  */
 781 int
 782 GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
 783                                   const struct GNUNET_CONTAINER_BloomFilter
 784                                   *to_or, size_t size)
 785 {
 786   unsigned int i;
 787   unsigned int n;
 788   unsigned long long *fc;
 789   const unsigned long long *dc;
 790
 791   if (NULL == bf)
 792     return GNUNET_YES;
 793   if (bf->bitArraySize != size)
 794     return GNUNET_SYSERR;
 795   fc = (unsigned long long *) bf->bitArray;
 796   dc = (const unsigned long long *) to_or->bitArray;
 797   n = size / sizeof (unsigned long long);
 798
 799   for (i = 0; i < n; i++)
 800     fc[i] |= dc[i];
 801   for (i = n * sizeof (unsigned long long); i < size; i++)
 802     bf->bitArray[i] |= to_or->bitArray[i];
 803   return GNUNET_OK;
 804 }
 805
 806 /**
 807  * Remove an element from the filter.
 808  *
 809  * @param bf the filter
 810  * @param e the element to remove
 811  */
 812 void
 813 GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter *bf,
 814                                      const GNUNET_HashCode * e)
 815 {
 816   if (NULL == bf)
 817     return;
 818   if (bf->filename == NULL)
 819     return;
 820   iterateBits (bf, &decrementBitCallback, bf, e);
 821 }
 822
 823 /**
 824  * Resize a bloom filter.  Note that this operation
 825  * is pretty costly.  Essentially, the bloom filter
 826  * needs to be completely re-build.
 827  *
 828  * @param bf the filter
 829  * @param iterator an iterator over all elements stored in the BF
 830  * @param iterator_cls argument to the iterator function
 831  * @param size the new size for the filter
 832  * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
 833  */
 834 void
 835 GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
 836                                      GNUNET_HashCodeIterator iterator,
 837                                      void *iterator_cls, size_t size,
 838                                      unsigned int k)
 839 {
 840   GNUNET_HashCode hc;
 841   unsigned int i;
 842
 843   GNUNET_free (bf->bitArray);
 844   i = 1;
 845   while (i < size)
 846     i *= 2;
 847   size = i;                     /* make sure it's a power of 2 */
 848
 849   bf->bitArraySize = size;
 850   bf->bitArray = GNUNET_malloc (size);
 851   memset (bf->bitArray, 0, bf->bitArraySize);
 852   if (bf->filename != NULL)
 853     make_empty_file (bf->fh, bf->bitArraySize * 4LL);
 854   while (GNUNET_YES == iterator (iterator_cls, &hc))
 855     GNUNET_CONTAINER_bloomfilter_add (bf, &hc);
 856 }
 857
 858 /* end of container_bloomfilter.c */