lib/bitsig.c

   1 /*
   2  *      Bit Array Signatures -- A Dubious Detector of Duplicates
   3  *
   4  *      (c) 2002 Martin Mares <mj@ucw.cz>
   5  *
   6  *      Greatly inspired by: Faloutsos, C. and Christodoulakis, S.: Signature files
   7  *      (An access method for documents and its analytical performance evaluation),
   8  *      ACM Trans. Office Inf. Syst., 2(4):267--288, Oct. 1984.
   9  *
  10  *      This data structure provides a very compact representation
  11  *      of a set of strings with insertion and membership search,
  12  *      but with a certain low probability it cheats by incidentally
  13  *      reporting a non-member as a member. Generally the larger you
  14  *      create the structure, the lower this probability is.
  15  *
  16  *      How does it work: the structure is just an array of M bits
  17  *      and each possible element is hashed to a set of (at most) L
  18  *      bit positions. For each element of the represented set, we
  19  *      set its L bits to ones and we report as present all elements
  20  *      whose all L bits ar set.
  21  *
  22  *      Analysis: Let's assume N items have already been stored and let A
  23  *      denote L/M (density of the hash function). The probability that
  24  *      a fixed bit of the array is set by any of the N items is
  25  *      1 - (1-1/M)^(NL) = 1 - ((1-1/M)^M)^NA = approx. 1 - e^-NA.
  26  *      This is minimized by setting A=(ln 2)/N (try taking derivative).
  27  *      Given a non-present item, the probability that all of the bits
  28  *      corresponding to this item are set by the other items (that is,
  29  *      the structure gives a false answer) is (1-e^-NA)^L = 2^-L.
  30  *      Hence, if we want to give false answers with probability less
  31  *      than epsilon, we take L := -log_2 epsilon, M := 1.45*N*L.
  32  *
  33  *      Example: For a set of 10^7 items with P[error] < 10^-6, we set
  34  *      L := 20 and M :=  290*10^6 bits = cca 34.5 MB (29 bits per item).
  35  *
  36  *      We leave L and an upper bound for N as parameters set during
  37  *      creation of the structure. Currently, the structure is limited
  38  *      to 4 Gb = 512 MB.
  39  */
  40
  41 #include "lib/lib.h"
  42 #include "lib/bitsig.h"
  43 #include "lib/md5.h"
  44
  45 #include <string.h>
  46 #include <stdlib.h>
  47
  48 struct bitsig {
  49   uns l, m, n, maxn, max_m_mult;
  50   u32 hash[4];
  51   uns hindex;
  52   byte array[0];
  53 };
  54
  55 struct bitsig *
  56 bitsig_init(uns perrlog, uns maxn)
  57 {
  58   struct bitsig *b;
  59   u64 m;
  60   uns mbytes;
  61
  62   m = ((u64) maxn * perrlog * 145 + 99) / 100;
  63   if (m >= (u64) 1 << 32)
  64     die("bitsig_init: bitsig array too large (maximum is 4 Gb)");
  65   mbytes = (m + 7) >> 3U;
  66   b = xmalloc(sizeof(struct bitsig) + mbytes);
  67   b->l = perrlog;
  68   b->m = m;
  69   b->n = 0;
  70   b->maxn = maxn;
  71   b->max_m_mult = (0xffffffff / m) * m;
  72   bzero(b->array, mbytes);
  73   log(L_DEBUG, "Initialized bitsig array with l=%d, m=%u (%u KB), expecting %d items", b->l, b->m, (mbytes+1023)/1024, maxn);
  74   return b;
  75 }
  76
  77 void
  78 bitsig_free(struct bitsig *b)
  79 {
  80   xfree(b);
  81 }
  82
  83 static void
  84 bitsig_hash_init(struct bitsig *b, byte *item)
  85 {
  86   struct MD5Context c;
  87
  88   MD5Init(&c);
  89   MD5Update(&c, item, strlen(item));
  90   MD5Final((byte *) b->hash, &c);
  91   b->hindex = 0;
  92 }
  93
  94 static inline uns
  95 bitsig_hash_bit(struct bitsig *b)
  96 {
  97   u32 h;
  98   do
  99     {
 100       h = b->hash[b->hindex];
 101       b->hash[b->hindex] *= 3006477127U;
 102       b->hindex = (b->hindex+1) % 4;
 103     }
 104   while (h >= b->max_m_mult);
 105   return h % b->m;
 106 }
 107
 108 int
 109 bitsig_member(struct bitsig *b, byte *item)
 110 {
 111   uns i, bit;
 112
 113   bitsig_hash_init(b, item);
 114   for (i=0; i<b->l; i++)
 115     {
 116       bit = bitsig_hash_bit(b);
 117       if (!(b->array[bit >> 3] & (1 << (bit & 7))))
 118         return 0;
 119     }
 120   return 1;
 121 }
 122
 123 int
 124 bitsig_insert(struct bitsig *b, byte *item)
 125 {
 126   uns i, bit, was;
 127
 128   bitsig_hash_init(b, item);
 129   was = 1;
 130   for (i=0; i<b->l; i++)
 131     {
 132       bit = bitsig_hash_bit(b);
 133       if (!(b->array[bit >> 3] & (1 << (bit & 7))))
 134         {
 135           was = 0;
 136           b->array[bit >> 3] |= (1 << (bit & 7));
 137         }
 138     }
 139   if (!was && b->n++ == b->maxn+1)
 140     log(L_ERROR, "bitsig: Too many items inserted, error rate will be higher than estimated!");
 141   return was;
 142 }
 143
 144 #ifdef TEST
 145
 146 #include <stdio.h>
 147 #include <stdlib.h>
 148
 149 int main(int argc, char **argv)
 150 {
 151   struct bitsig *b = bitsig_init(atol(argv[1]), atol(argv[2]));
 152   byte buf[1024];
 153
 154   while (fgets(buf, 1024, stdin))
 155     printf("%d\n", bitsig_insert(b, buf));
 156
 157   return 0;
 158 }
 159
 160 #endif