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