src/util/container_bloomfilter.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2006, 2008 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 struct GNUNET_CONTAINER_BloomFilter
  48 {
  49
  50   /**
  51    * The actual bloomfilter bit array
  52    */
  53   char *bitArray;
  54
  55   /**
  56    * Filename of the filter
  57    */
  58   char *filename;
  59
  60   /**
  61    * The bit counter file on disk
  62    */
  63   struct GNUNET_IO_Handle *fh;
  64
  65   /**
  66    * How many bits we set for each stored element
  67    */
  68   unsigned int addressesPerElement;
  69
  70   /**
  71    * Size of bitArray in bytes
  72    */
  73   unsigned int bitArraySize;
  74
  75 };
  76
  77
  78 /**
  79  * Sets a bit active in the bitArray. Increment bit-specific
  80  * usage counter on disk only if below 4bit max (==15).
  81  *
  82  * @param bitArray memory area to set the bit in
  83  * @param bitIdx which bit to set
  84  */
  85 static void
  86 setBit (char *bitArray, unsigned int bitIdx)
  87 {
  88   unsigned int arraySlot;
  89   unsigned int targetBit;
  90
  91   arraySlot = bitIdx / 8;
  92   targetBit = (1L << (bitIdx % 8));
  93   bitArray[arraySlot] |= targetBit;
  94 }
  95
  96 /**
  97  * Clears a bit from bitArray. Bit is cleared from the array
  98  * only if the respective usage counter on the disk hits/is zero.
  99  *
 100  * @param bitArray memory area to set the bit in
 101  * @param bitIdx which bit to unset
 102  */
 103 static void
 104 clearBit (char *bitArray, unsigned int bitIdx)
 105 {
 106   unsigned int slot;
 107   unsigned int targetBit;
 108
 109   slot = bitIdx / 8;
 110   targetBit = (1L << (bitIdx % 8));
 111   bitArray[slot] = bitArray[slot] & (~targetBit);
 112 }
 113
 114 /**
 115  * Checks if a bit is active in the bitArray
 116  *
 117  * @param bitArray memory area to set the bit in
 118  * @param bitIdx which bit to test
 119  * @return GNUNET_YES if the bit is set, GNUNET_NO if not.
 120  */
 121 static int
 122 testBit (char *bitArray, unsigned int bitIdx)
 123 {
 124   unsigned int slot;
 125   unsigned int targetBit;
 126
 127   slot = bitIdx / 8;
 128   targetBit = (1L << (bitIdx % 8));
 129   if (bitArray[slot] & targetBit)
 130     return GNUNET_YES;
 131   else
 132     return GNUNET_NO;
 133 }
 134
 135 /**
 136  * Sets a bit active in the bitArray and increments
 137  * bit-specific usage counter on disk (but only if
 138  * the counter was below 4 bit max (==15)).
 139  *
 140  * @param bitArray memory area to set the bit in
 141  * @param bitIdx which bit to test
 142  * @param fh A file to keep the 4 bit address usage counters in
 143  */
 144 static void
 145 incrementBit (char *bitArray, unsigned int bitIdx, const struct GNUNET_IO_Handle *fh)
 146 {
 147   unsigned int fileSlot;
 148   unsigned char value;
 149   unsigned int high;
 150   unsigned int low;
 151   unsigned int targetLoc;
 152
 153   setBit (bitArray, bitIdx);
 154   if (GNUNET_IO_handle_invalid (fh))
 155     return;
 156   /* Update the counter file on disk */
 157   fileSlot = bitIdx / 2;
 158   targetLoc = bitIdx % 2;
 159
 160   GNUNET_assert (fileSlot == (unsigned int) GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_SEEK_SET));
 161   if (1 != GNUNET_DISK_file_read (fh, &value, 1))
 162     value = 0;
 163   low = value & 0xF;
 164   high = (value & (~0xF)) >> 4;
 165
 166   if (targetLoc == 0)
 167     {
 168       if (low < 0xF)
 169         low++;
 170     }
 171   else
 172     {
 173       if (high < 0xF)
 174         high++;
 175     }
 176   value = ((high << 4) | low);
 177   GNUNET_assert (fileSlot == (unsigned int) GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_SEEK_SET));
 178   GNUNET_assert (1 == GNUNET_DISK_file_write (fh, &value, 1));
 179 }
 180
 181 /**
 182  * Clears a bit from bitArray if the respective usage
 183  * counter on the disk hits/is zero.
 184  *
 185  * @param bitArray memory area to set the bit in
 186  * @param bitIdx which bit to test
 187  * @param fh A file to keep the 4bit address usage counters in
 188  */
 189 static void
 190 decrementBit (char *bitArray, unsigned int bitIdx, const struct GNUNET_IO_Handle *fh)
 191 {
 192   unsigned int fileSlot;
 193   unsigned char value;
 194   unsigned int high;
 195   unsigned int low;
 196   unsigned int targetLoc;
 197
 198   if (GNUNET_IO_handle_invalid (fh))
 199     return;                     /* cannot decrement! */
 200   /* Each char slot in the counter file holds two 4 bit counters */
 201   fileSlot = bitIdx / 2;
 202   targetLoc = bitIdx % 2;
 203   GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_SEEK_SET);
 204   if (1 != GNUNET_DISK_file_read (fh, &value, 1))
 205     value = 0;
 206   low = value & 0xF;
 207   high = (value & 0xF0) >> 4;
 208
 209   /* decrement, but once we have reached the max, never go back! */
 210   if (targetLoc == 0)
 211     {
 212       if ((low > 0) && (low < 0xF))
 213         low--;
 214       if (low == 0)
 215         {
 216           clearBit (bitArray, bitIdx);
 217         }
 218     }
 219   else
 220     {
 221       if ((high > 0) && (high < 0xF))
 222         high--;
 223       if (high == 0)
 224         {
 225           clearBit (bitArray, bitIdx);
 226         }
 227     }
 228   value = ((high << 4) | low);
 229   GNUNET_DISK_file_seek (fh, fileSlot, GNUNET_SEEK_SET);
 230   GNUNET_assert (1 == GNUNET_DISK_file_write (fh, &value, 1));
 231 }
 232
 233 #define BUFFSIZE 65536
 234
 235 /**
 236  * Creates a file filled with zeroes
 237  *
 238  * @param fh the file handle
 239  * @param size the size of the file
 240  * @return GNUNET_OK if created ok, GNUNET_SYSERR otherwise
 241  */
 242 static int
 243 makeEmptyFile (const struct GNUNET_IO_Handle *fh, unsigned int size)
 244 {
 245   char *buffer;
 246   unsigned int bytesleft = size;
 247   int res = 0;
 248
 249   if (GNUNET_IO_handle_invalid (fh))
 250     return GNUNET_SYSERR;
 251   buffer = GNUNET_malloc (BUFFSIZE);
 252   memset (buffer, 0, BUFFSIZE);
 253   GNUNET_DISK_file_seek (fh, 0, GNUNET_SEEK_SET);
 254
 255   while (bytesleft > 0)
 256     {
 257       if (bytesleft > BUFFSIZE)
 258         {
 259           res = GNUNET_DISK_file_write (fh, buffer, BUFFSIZE);
 260           bytesleft -= BUFFSIZE;
 261         }
 262       else
 263         {
 264           res = GNUNET_DISK_file_write (fh, buffer, bytesleft);
 265           bytesleft = 0;
 266         }
 267       GNUNET_assert (res != GNUNET_SYSERR);
 268     }
 269   GNUNET_free (buffer);
 270   return GNUNET_OK;
 271 }
 272
 273 /* ************** GNUNET_CONTAINER_BloomFilter GNUNET_CRYPTO_hash iterator ********* */
 274
 275 /**
 276  * Iterator (callback) method to be called by the
 277  * bloomfilter iterator on each bit that is to be
 278  * set or tested for the key.
 279  *
 280  * @param bf the filter to manipulate
 281  * @param bit the current bit
 282  * @param additional context specific argument
 283  */
 284 typedef void (*BitIterator) (struct GNUNET_CONTAINER_BloomFilter * bf,
 285                              unsigned int bit, void *arg);
 286
 287 /**
 288  * Call an iterator for each bit that the bloomfilter
 289  * must test or set for this element.
 290  *
 291  * @param bf the filter
 292  * @param callback the method to call
 293  * @param arg extra argument to callback
 294  * @param key the key for which we iterate over the BF bits
 295  */
 296 static void
 297 iterateBits (struct GNUNET_CONTAINER_BloomFilter *bf,
 298              BitIterator callback, void *arg, const GNUNET_HashCode * key)
 299 {
 300   GNUNET_HashCode tmp[2];
 301   int bitCount;
 302   int round;
 303   unsigned int slot = 0;
 304
 305   bitCount = bf->addressesPerElement;
 306   memcpy (&tmp[0], key, sizeof (GNUNET_HashCode));
 307   round = 0;
 308   while (bitCount > 0)
 309     {
 310       while (slot < (sizeof (GNUNET_HashCode) / sizeof (unsigned int)))
 311         {
 312           callback (bf,
 313                     (((unsigned int *) &tmp[round & 1])[slot]) &
 314                     ((bf->bitArraySize * 8) - 1), arg);
 315           slot++;
 316           bitCount--;
 317           if (bitCount == 0)
 318             break;
 319         }
 320       if (bitCount > 0)
 321         {
 322           GNUNET_CRYPTO_hash (&tmp[round & 1], sizeof (GNUNET_HashCode),
 323                               &tmp[(round + 1) & 1]);
 324           round++;
 325           slot = 0;
 326         }
 327     }
 328 }
 329
 330 /**
 331  * Callback: increment bit
 332  *
 333  * @param bf the filter to manipulate
 334  * @param bit the bit to increment
 335  * @param arg not used
 336  */
 337 static void
 338 incrementBitCallback (struct GNUNET_CONTAINER_BloomFilter *bf,
 339                       unsigned int bit, void *arg)
 340 {
 341   incrementBit (bf->bitArray, bit, bf->fh);
 342 }
 343
 344 /**
 345  * Callback: decrement bit
 346  *
 347  * @param bf the filter to manipulate
 348  * @param bit the bit to decrement
 349  * @param arg not used
 350  */
 351 static void
 352 decrementBitCallback (struct GNUNET_CONTAINER_BloomFilter *bf,
 353                       unsigned int bit, void *arg)
 354 {
 355   decrementBit (bf->bitArray, bit, bf->fh);
 356 }
 357
 358 /**
 359  * Callback: test if all bits are set
 360  *
 361  * @param bf the filter
 362  * @param bit the bit to test
 363  * @param arg pointer set to GNUNET_NO if bit is not set
 364  */
 365 static void
 366 testBitCallback (struct GNUNET_CONTAINER_BloomFilter *bf, unsigned int bit,
 367                  void *cls)
 368 {
 369   int *arg = cls;
 370   if (GNUNET_NO == testBit (bf->bitArray, bit))
 371     *arg = GNUNET_NO;
 372 }
 373
 374 /* *********************** INTERFACE **************** */
 375
 376 /**
 377  * Load a bloom-filter from a file.
 378  *
 379  * @param filename the name of the file (or the prefix)
 380  * @param size the size of the bloom-filter (number of
 381  *        bytes of storage space to use)
 382  * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
 383  *        element (number of bits set per element in the set)
 384  * @return the bloomfilter
 385  */
 386 struct GNUNET_CONTAINER_BloomFilter *
 387 GNUNET_CONTAINER_bloomfilter_load (const char *filename, unsigned int size,
 388                                    unsigned int k)
 389 {
 390   struct GNUNET_CONTAINER_BloomFilter *bf;
 391   char *rbuff;
 392   unsigned int pos;
 393   int i;
 394   unsigned int ui;
 395
 396   if ((k == 0) || (size == 0))
 397     return NULL;
 398   if (size < BUFFSIZE)
 399     size = BUFFSIZE;
 400   ui = 1;
 401   while (ui < size)
 402     ui *= 2;
 403   size = ui;                    /* make sure it's a power of 2 */
 404
 405   bf = GNUNET_malloc (sizeof (struct GNUNET_CONTAINER_BloomFilter));
 406   /* Try to open a bloomfilter file */
 407   if (filename != NULL)
 408     {
 409       bf->fh = GNUNET_DISK_file_open (filename,
 410           GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_CREATE,
 411           GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE);
 412       if (!bf->fh)
 413         {
 414           GNUNET_free (bf);
 415           return NULL;
 416         }
 417       bf->filename = GNUNET_strdup (filename);
 418     }
 419   else
 420     {
 421       bf->filename = NULL;
 422       bf->fh = NULL;
 423     }
 424   /* Alloc block */
 425   bf->bitArray = GNUNET_malloc_large (size);
 426   bf->bitArraySize = size;
 427   bf->addressesPerElement = k;
 428   memset (bf->bitArray, 0, bf->bitArraySize);
 429
 430   if (bf->filename != NULL)
 431     {
 432       /* Read from the file what bits we can */
 433       rbuff = GNUNET_malloc (BUFFSIZE);
 434       pos = 0;
 435       while (pos < size * 8)
 436         {
 437           int res;
 438
 439           res = GNUNET_DISK_file_read (bf->fh, rbuff, BUFFSIZE);
 440           if (res == 0)
 441             break;              /* is ok! we just did not use that many bits yet */
 442           for (i = 0; i < res; i++)
 443             {
 444               if ((rbuff[i] & 0x0F) != 0)
 445                 setBit (bf->bitArray, pos + i * 2);
 446               if ((rbuff[i] & 0xF0) != 0)
 447                 setBit (bf->bitArray, pos + i * 2 + 1);
 448             }
 449           if (res < BUFFSIZE)
 450             break;
 451           pos += BUFFSIZE * 2;  /* 2 bits per byte in the buffer */
 452         }
 453       GNUNET_free (rbuff);
 454     }
 455   return bf;
 456 }
 457
 458
 459 /**
 460  * Create a bloom filter from raw bits.
 461  *
 462  * @param data the raw bits in memory (maybe NULL,
 463  *        in which case all bits should be considered
 464  *        to be zero).
 465  * @param size the size of the bloom-filter (number of
 466  *        bytes of storage space to use); also size of data
 467  *        -- unless data is NULL
 468  * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
 469  *        element (number of bits set per element in the set)
 470  * @return the bloomfilter
 471  */
 472 struct GNUNET_CONTAINER_BloomFilter *
 473 GNUNET_CONTAINER_bloomfilter_init (const char *data, unsigned int size,
 474                                    unsigned int k)
 475 {
 476   struct GNUNET_CONTAINER_BloomFilter *bf;
 477   unsigned int ui;
 478
 479   if ((k == 0) || (size == 0))
 480     return NULL;
 481   ui = 1;
 482   while (ui < size)
 483     ui *= 2;
 484   if (size != ui)
 485     {
 486       GNUNET_break (0);
 487       return NULL;
 488     }
 489   bf = GNUNET_malloc (sizeof (struct GNUNET_CONTAINER_BloomFilter));
 490   bf->filename = NULL;
 491   bf->fh = NULL;
 492   bf->bitArray = GNUNET_malloc_large (size);
 493   bf->bitArraySize = size;
 494   bf->addressesPerElement = k;
 495   if (data != NULL)
 496     memcpy (bf->bitArray, data, size);
 497   else
 498     memset (bf->bitArray, 0, bf->bitArraySize);
 499   return bf;
 500 }
 501
 502
 503 /**
 504  * Copy the raw data of this bloomfilter into
 505  * the given data array.
 506  *
 507  * @param data where to write the data
 508  * @param size the size of the given data array
 509  * @return GNUNET_SYSERR if the data array is not big enough
 510  */
 511 int
 512 GNUNET_CONTAINER_bloomfilter_get_raw_data (struct GNUNET_CONTAINER_BloomFilter
 513                                            *bf, char *data, unsigned int size)
 514 {
 515   if (NULL == bf)
 516     return GNUNET_SYSERR;
 517
 518   if (bf->bitArraySize != size)
 519     return GNUNET_SYSERR;
 520   memcpy (data, bf->bitArray, size);
 521   return GNUNET_OK;
 522 }
 523
 524 /**
 525  * Free the space associated with a filter
 526  * in memory, flush to drive if needed (do not
 527  * free the space on the drive)
 528  *
 529  * @param bf the filter
 530  */
 531 void
 532 GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter *bf)
 533 {
 534   if (NULL == bf)
 535     return;
 536   if (bf->filename != NULL)
 537     {
 538       GNUNET_DISK_file_close (&bf->fh);
 539       GNUNET_free (bf->filename);
 540     }
 541   GNUNET_free (bf->bitArray);
 542   GNUNET_free (bf);
 543 }
 544
 545 /**
 546  * Reset a bloom filter to empty. Clears the file on disk.
 547  *
 548  * @param bf the filter
 549  */
 550 void
 551 GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter *bf)
 552 {
 553   if (NULL == bf)
 554     return;
 555
 556   memset (bf->bitArray, 0, bf->bitArraySize);
 557   if (bf->filename != NULL)
 558     makeEmptyFile (bf->fh, bf->bitArraySize * 4);
 559 }
 560
 561
 562 /**
 563  * Test if an element is in the filter.
 564  *
 565  * @param e the element
 566  * @param bf the filter
 567  * @return GNUNET_YES if the element is in the filter, GNUNET_NO if not
 568  */
 569 int
 570 GNUNET_CONTAINER_bloomfilter_test (struct GNUNET_CONTAINER_BloomFilter *bf,
 571                                    const GNUNET_HashCode * e)
 572 {
 573   int res;
 574
 575   if (NULL == bf)
 576     return GNUNET_YES;
 577   res = GNUNET_YES;
 578   iterateBits (bf, &testBitCallback, &res, e);
 579   return res;
 580 }
 581
 582 /**
 583  * Add an element to the filter
 584  *
 585  * @param bf the filter
 586  * @param e the element
 587  */
 588 void
 589 GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter *bf,
 590                                   const GNUNET_HashCode * e)
 591 {
 592
 593   if (NULL == bf)
 594     return;
 595   iterateBits (bf, &incrementBitCallback, NULL, e);
 596 }
 597
 598
 599 /**
 600  * Or the entries of the given raw data array with the
 601  * data of the given bloom filter.  Assumes that
 602  * the size of the data array and the current filter
 603  * match.
 604  * @param bf the filter
 605  */
 606 int
 607 GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
 608                                  const char *data, unsigned int size)
 609 {
 610   unsigned int i;
 611
 612   if (NULL == bf)
 613     return GNUNET_YES;
 614   if (bf->bitArraySize != size)
 615     return GNUNET_SYSERR;
 616   /* FIXME: we could do this 4-8x faster by
 617      going over int/long arrays */
 618   for (i = 0; i < size; i++)
 619     bf->bitArray[i] |= data[i];
 620   return GNUNET_OK;
 621 }
 622
 623 /**
 624  * Remove an element from the filter.
 625  *
 626  * @param bf the filter
 627  * @param e the element to remove
 628  */
 629 void
 630 GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter *bf,
 631                                      const GNUNET_HashCode * e)
 632 {
 633   if (NULL == bf)
 634     return;
 635   if (bf->filename == NULL)
 636     return;
 637   iterateBits (bf, &decrementBitCallback, NULL, e);
 638 }
 639
 640 /**
 641  * Resize a bloom filter.  Note that this operation
 642  * is pretty costly.  Essentially, the bloom filter
 643  * needs to be completely re-build.
 644  *
 645  * @param bf the filter
 646  * @param iterator an iterator over all elements stored in the BF
 647  * @param iterator_arg argument to the iterator function
 648  * @param size the new size for the filter
 649  * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
 650  */
 651 void
 652 GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
 653                                      GNUNET_HashCodeIterator iterator,
 654                                      void *iterator_arg, unsigned int size,
 655                                      unsigned int k)
 656 {
 657   GNUNET_HashCode hc;
 658   unsigned int i;
 659
 660   GNUNET_free (bf->bitArray);
 661   i = 1;
 662   while (i < size)
 663     i *= 2;
 664   size = i;                     /* make sure it's a power of 2 */
 665
 666   bf->bitArraySize = size;
 667   bf->bitArray = GNUNET_malloc (size);
 668   memset (bf->bitArray, 0, bf->bitArraySize);
 669   if (bf->filename != NULL)
 670     makeEmptyFile (bf->fh, bf->bitArraySize * 4);
 671   while (GNUNET_YES == iterator (&hc, iterator_arg))
 672     GNUNET_CONTAINER_bloomfilter_add (bf, &hc);
 673 }
 674
 675 /* end of container_bloomfilter.c */