lib/bup/bloom.py

   1 """Discussion of bloom constants for bup:
   2
   3 There are four basic things to consider when building a bloom filter:
   4 The size, in bits, of the filter
   5 The capacity, in entries, of the filter
   6 The probability of a false positive that is tolerable
   7 The number of bits readily available to use for addressing filter bits
   8
   9 There is one major tunable that is not directly related to the above:
  10 k: the number of bits set in the filter per entry
  11
  12 Here's a wall of numbers showing the relationship between k; the ratio between
  13 the filter size in bits and the entries in the filter; and pfalse_positive:
  14
  15 mn|k=3    |k=4    |k=5    |k=6    |k=7    |k=8    |k=9    |k=10   |k=11
  16  8|3.05794|2.39687|2.16792|2.15771|2.29297|2.54917|2.92244|3.41909|4.05091
  17  9|2.27780|1.65770|1.40703|1.32721|1.34892|1.44631|1.61138|1.84491|2.15259
  18 10|1.74106|1.18133|0.94309|0.84362|0.81937|0.84555|0.91270|1.01859|1.16495
  19 11|1.36005|0.86373|0.65018|0.55222|0.51259|0.50864|0.53098|0.57616|0.64387
  20 12|1.08231|0.64568|0.45945|0.37108|0.32939|0.31424|0.31695|0.33387|0.36380
  21 13|0.87517|0.49210|0.33183|0.25527|0.21689|0.19897|0.19384|0.19804|0.21013
  22 14|0.71759|0.38147|0.24433|0.17934|0.14601|0.12887|0.12127|0.12012|0.12399
  23 15|0.59562|0.30019|0.18303|0.12840|0.10028|0.08523|0.07749|0.07440|0.07468
  24 16|0.49977|0.23941|0.13925|0.09351|0.07015|0.05745|0.05049|0.04700|0.04587
  25 17|0.42340|0.19323|0.10742|0.06916|0.04990|0.03941|0.03350|0.03024|0.02870
  26 18|0.36181|0.15765|0.08392|0.05188|0.03604|0.02748|0.02260|0.01980|0.01827
  27 19|0.31160|0.12989|0.06632|0.03942|0.02640|0.01945|0.01549|0.01317|0.01182
  28 20|0.27026|0.10797|0.05296|0.03031|0.01959|0.01396|0.01077|0.00889|0.00777
  29 21|0.23591|0.09048|0.04269|0.02356|0.01471|0.01014|0.00759|0.00609|0.00518
  30 22|0.20714|0.07639|0.03473|0.01850|0.01117|0.00746|0.00542|0.00423|0.00350
  31 23|0.18287|0.06493|0.02847|0.01466|0.00856|0.00555|0.00392|0.00297|0.00240
  32 24|0.16224|0.05554|0.02352|0.01171|0.00663|0.00417|0.00286|0.00211|0.00166
  33 25|0.14459|0.04779|0.01957|0.00944|0.00518|0.00316|0.00211|0.00152|0.00116
  34 26|0.12942|0.04135|0.01639|0.00766|0.00408|0.00242|0.00157|0.00110|0.00082
  35 27|0.11629|0.03595|0.01381|0.00626|0.00324|0.00187|0.00118|0.00081|0.00059
  36 28|0.10489|0.03141|0.01170|0.00515|0.00259|0.00146|0.00090|0.00060|0.00043
  37 29|0.09492|0.02756|0.00996|0.00426|0.00209|0.00114|0.00069|0.00045|0.00031
  38 30|0.08618|0.02428|0.00853|0.00355|0.00169|0.00090|0.00053|0.00034|0.00023
  39 31|0.07848|0.02147|0.00733|0.00297|0.00138|0.00072|0.00041|0.00025|0.00017
  40 32|0.07167|0.01906|0.00633|0.00250|0.00113|0.00057|0.00032|0.00019|0.00013
  41
  42 Here's a table showing available repository size for a given pfalse_positive
  43 and three values of k (assuming we only use the 160 bit SHA1 for addressing the
  44 filter and 8192bytes per object):
  45
  46 pfalse|obj k=4     |cap k=4    |obj k=5  |cap k=5    |obj k=6 |cap k=6
  47 2.500%|139333497228|1038.11 TiB|558711157|4262.63 GiB|13815755|105.41 GiB
  48 1.000%|104489450934| 778.50 TiB|436090254|3327.10 GiB|11077519| 84.51 GiB
  49 0.125%| 57254889824| 426.58 TiB|261732190|1996.86 GiB| 7063017| 55.89 GiB
  50
  51 This eliminates pretty neatly any k>6 as long as we use the raw SHA for
  52 addressing.
  53
  54 filter size scales linearly with repository size for a given k and pfalse.
  55
  56 Here's a table of filter sizes for a 1 TiB repository:
  57
  58 pfalse| k=3        | k=4        | k=5        | k=6
  59 2.500%| 138.78 MiB | 126.26 MiB | 123.00 MiB | 123.37 MiB
  60 1.000%| 197.83 MiB | 168.36 MiB | 157.58 MiB | 153.87 MiB
  61 0.125%| 421.14 MiB | 307.26 MiB | 262.56 MiB | 241.32 MiB
  62
  63 For bup:
  64 * We want the bloom filter to fit in memory; if it doesn't, the k pagefaults
  65 per lookup will be worse than the two required for midx.
  66 * We want the pfalse_positive to be low enough that the cost of sometimes
  67 faulting on the midx doesn't overcome the benefit of the bloom filter.
  68 * We have readily available 160 bits for addressing the filter.
  69 * We want to be able to have a single bloom address entire repositories of
  70 reasonable size.
  71
  72 Based on these parameters, a combination of k=4 and k=5 provides the behavior
  73 that bup needs.  As such, I've implemented bloom addressing, adding and
  74 checking functions in C for these two values.  Because k=5 requires less space
  75 and gives better overall pfalse_positive performance, it is preferred if a
  76 table with k=5 can represent the repository.
  77
  78 None of this tells us what max_pfalse_positive to choose.
  79
  80 Brandon Low <lostlogic@lostlogicx.com> 2011-02-04
  81 """
  82
  83 from __future__ import absolute_import
  84 import os, math, struct
  85
  86 from bup import _helpers
  87 from bup.compat import pending_raise
  88 from bup.helpers import (debug1, debug2, log, mmap_read, mmap_readwrite,
  89                          mmap_readwrite_private, unlink)
  90
  91
  92 BLOOM_VERSION = 2
  93 MAX_BITS_EACH = 32 # Kinda arbitrary, but 4 bytes per entry is pretty big
  94 MAX_BLOOM_BITS = {4: 37, 5: 29} # 160/k-log2(8)
  95 MAX_PFALSE_POSITIVE = 1. # Totally arbitrary, needs benchmarking
  96
  97 _total_searches = 0
  98 _total_steps = 0
  99
 100 bloom_contains = _helpers.bloom_contains
 101 bloom_add = _helpers.bloom_add
 102
 103 # FIXME: check bloom create() and ShaBloom handling/ownership of "f".
 104 # The ownership semantics should be clarified since the caller needs
 105 # to know who is responsible for closing it.
 106
 107 class ShaBloom:
 108     """Wrapper which contains data from multiple index files. """
 109     def __init__(self, filename, f=None, readwrite=False, expected=-1):
 110         self.name = filename
 111         self.readwrite = readwrite
 112         self.file = None
 113         self.map = None
 114         assert(filename.endswith(b'.bloom'))
 115         if readwrite:
 116             assert(expected > 0)
 117             self.file = f = f or open(filename, 'r+b')
 118             f.seek(0)
 119
 120             # Decide if we want to mmap() the pages as writable ('immediate'
 121             # write) or else map them privately for later writing back to
 122             # the file ('delayed' write).  A bloom table's write access
 123             # pattern is such that we dirty almost all the pages after adding
 124             # very few entries.  But the table is so big that dirtying
 125             # *all* the pages often exceeds Linux's default
 126             # /proc/sys/vm/dirty_ratio or /proc/sys/vm/dirty_background_ratio,
 127             # thus causing it to start flushing the table before we're
 128             # finished... even though there's more than enough space to
 129             # store the bloom table in RAM.
 130             #
 131             # To work around that behaviour, if we calculate that we'll
 132             # probably end up touching the whole table anyway (at least
 133             # one bit flipped per memory page), let's use a "private" mmap,
 134             # which defeats Linux's ability to flush it to disk.  Then we'll
 135             # flush it as one big lump during close().
 136             pages = os.fstat(f.fileno()).st_size // 4096 * 5 # assume k=5
 137             self.delaywrite = expected > pages
 138             debug1('bloom: delaywrite=%r\n' % self.delaywrite)
 139             if self.delaywrite:
 140                 self.map = mmap_readwrite_private(self.file, close=False)
 141             else:
 142                 self.map = mmap_readwrite(self.file, close=False)
 143         else:
 144             self.file = f or open(filename, 'rb')
 145             self.map = mmap_read(self.file)
 146         got = self.map[0:4]
 147         if got != b'BLOM':
 148             log('Warning: invalid BLOM header (%r) in %r\n' % (got, filename))
 149             self._init_failed()
 150             return
 151         ver = struct.unpack('!I', self.map[4:8])[0]
 152         if ver < BLOOM_VERSION:
 153             log('Warning: ignoring old-style (v%d) bloom %r\n'
 154                 % (ver, filename))
 155             self._init_failed()
 156             return
 157         if ver > BLOOM_VERSION:
 158             log('Warning: ignoring too-new (v%d) bloom %r\n'
 159                 % (ver, filename))
 160             self._init_failed()
 161             return
 162
 163         self.bits, self.k, self.entries = struct.unpack('!HHI', self.map[8:16])
 164         idxnamestr = self.map[16 + 2**self.bits:]
 165         if idxnamestr:
 166             self.idxnames = idxnamestr.split(b'\0')
 167         else:
 168             self.idxnames = []
 169
 170     def _init_failed(self):
 171         self.idxnames = []
 172         self.bits = self.entries = 0
 173         self.map, tmp_map = None, self.map
 174         self.file, tmp_file = None, self.file
 175         try:
 176             if tmp_map:
 177                 tmp_map.close()
 178         finally:  # This won't handle pending exceptions correctly in py2
 179             if self.file:
 180                 tmp_file.close()
 181
 182     def valid(self):
 183         return self.map and self.bits
 184
 185     def close(self):
 186         try:
 187             if self.map and self.readwrite:
 188                 debug2("bloom: closing with %d entries\n" % self.entries)
 189                 self.map[12:16] = struct.pack('!I', self.entries)
 190                 if self.delaywrite:
 191                     self.file.seek(0)
 192                     self.file.write(self.map)
 193                 else:
 194                     self.map.flush()
 195                 self.file.seek(16 + 2**self.bits)
 196                 if self.idxnames:
 197                     self.file.write(b'\0'.join(self.idxnames))
 198         finally:  # This won't handle pending exceptions correctly in py2
 199             self._init_failed()
 200
 201     def __enter__(self):
 202         return self
 203
 204     def __exit__(self, type, value, traceback):
 205         with pending_raise(value, rethrow=False):
 206             self.close()
 207
 208     def pfalse_positive(self, additional=0):
 209         n = self.entries + additional
 210         m = 8*2**self.bits
 211         k = self.k
 212         return 100*(1-math.exp(-k*float(n)/m))**k
 213
 214     def add(self, ids):
 215         """Add the hashes in ids (packed binary 20-bytes) to the filter."""
 216         if not self.map:
 217             raise Exception("Cannot add to closed bloom")
 218         self.entries += bloom_add(self.map, ids, self.bits, self.k)
 219
 220     def add_idx(self, ix):
 221         """Add the object to the filter."""
 222         self.add(ix.shatable)
 223         self.idxnames.append(os.path.basename(ix.name))
 224
 225     def exists(self, sha):
 226         """Return nonempty if the object probably exists in the bloom filter.
 227
 228         If this function returns false, the object definitely does not exist.
 229         If it returns true, there is a small probability that it exists
 230         anyway, so you'll have to check it some other way.
 231         """
 232         global _total_searches, _total_steps
 233         _total_searches += 1
 234         if not self.map:
 235             return None
 236         found, steps = bloom_contains(self.map, sha, self.bits, self.k)
 237         _total_steps += steps
 238         return found
 239
 240     def __len__(self):
 241         return int(self.entries)
 242
 243
 244 def create(name, expected, delaywrite=None, f=None, k=None):
 245     """Create and return a bloom filter for `expected` entries."""
 246     bits = int(math.floor(math.log(expected * MAX_BITS_EACH // 8, 2)))
 247     k = k or ((bits <= MAX_BLOOM_BITS[5]) and 5 or 4)
 248     if bits > MAX_BLOOM_BITS[k]:
 249         log('bloom: warning, max bits exceeded, non-optimal\n')
 250         bits = MAX_BLOOM_BITS[k]
 251     debug1('bloom: using 2^%d bytes and %d hash functions\n' % (bits, k))
 252     f = f or open(name, 'w+b')
 253     f.write(b'BLOM')
 254     f.write(struct.pack('!IHHI', BLOOM_VERSION, bits, k, 0))
 255     assert(f.tell() == 16)
 256     # NOTE: On some systems this will not extend+zerofill, but it does on
 257     # darwin, linux, bsd and solaris.
 258     f.truncate(16+2**bits)
 259     f.seek(0)
 260     if delaywrite != None and not delaywrite:
 261         # tell it to expect very few objects, forcing a direct mmap
 262         expected = 1
 263     return ShaBloom(name, f=f, readwrite=True, expected=expected)
 264
 265
 266 def clear_bloom(dir):
 267     unlink(os.path.join(dir, b'bup.bloom'))