lib/bup/midx.py

   1
   2 from __future__ import absolute_import, print_function
   3 import glob, mmap, os, struct
   4
   5 from bup import _helpers
   6 from bup.compat import range
   7 from bup.helpers import log, mmap_read
   8 from bup.io import path_msg
   9
  10
  11 MIDX_VERSION = 4
  12
  13 extract_bits = _helpers.extract_bits
  14 _total_searches = 0
  15 _total_steps = 0
  16
  17
  18 class PackMidx:
  19     """Wrapper which contains data from multiple index files.
  20     Multiple index (.midx) files constitute a wrapper around index (.idx) files
  21     and make it possible for bup to expand Git's indexing capabilities to vast
  22     amounts of files.
  23     """
  24     def __init__(self, filename):
  25         self.name = filename
  26         self.force_keep = False
  27         self.map = None
  28         assert(filename.endswith(b'.midx'))
  29         self.map = mmap_read(open(filename))
  30         if self.map[0:4] != b'MIDX':
  31             log('Warning: skipping: invalid MIDX header in %r\n'
  32                 % path_msg(filename))
  33             self.force_keep = True
  34             return self._init_failed()
  35         ver = struct.unpack('!I', self.map[4:8])[0]
  36         if ver < MIDX_VERSION:
  37             log('Warning: ignoring old-style (v%d) midx %r\n'
  38                 % (ver, path_msg(filename)))
  39             self.force_keep = False  # old stuff is boring
  40             return self._init_failed()
  41         if ver > MIDX_VERSION:
  42             log('Warning: ignoring too-new (v%d) midx %r\n'
  43                 % (ver, path_msg(filename)))
  44             self.force_keep = True  # new stuff is exciting
  45             return self._init_failed()
  46
  47         self.bits = _helpers.firstword(self.map[8:12])
  48         self.entries = 2**self.bits
  49         self.fanout_ofs = 12
  50         # fanout len is self.entries * 4
  51         self.sha_ofs = self.fanout_ofs + self.entries * 4
  52         self.nsha = self._fanget(self.entries - 1)
  53         # sha table len is self.nsha * 20
  54         self.which_ofs = self.sha_ofs + 20 * self.nsha
  55         # which len is self.nsha * 4
  56         self.idxnames = self.map[self.which_ofs + 4 * self.nsha:].split(b'\0')
  57
  58     def __del__(self):
  59         self.close()
  60
  61     def __enter__(self):
  62         return self
  63
  64     def __exit__(self, type, value, traceback):
  65         self.close()
  66
  67     def _init_failed(self):
  68         self.bits = 0
  69         self.entries = 1
  70         self.idxnames = []
  71
  72     def _fanget(self, i):
  73         if i >= self.entries * 4 or i < 0:
  74             raise IndexError('invalid midx index %d' % i)
  75         ofs = self.fanout_ofs + i * 4
  76         return _helpers.firstword(self.map[ofs : ofs + 4])
  77
  78     def _get(self, i):
  79         if i >= self.nsha or i < 0:
  80             raise IndexError('invalid midx index %d' % i)
  81         ofs = self.sha_ofs + i * 20
  82         return self.map[ofs : ofs + 20]
  83
  84     def _get_idx_i(self, i):
  85         if i >= self.nsha or i < 0:
  86             raise IndexError('invalid midx index %d' % i)
  87         ofs = self.which_ofs + i * 4
  88         return struct.unpack_from('!I', self.map, offset=ofs)[0]
  89
  90     def _get_idxname(self, i):
  91         return self.idxnames[self._get_idx_i(i)]
  92
  93     def close(self):
  94         if self.map is not None:
  95             self.fanout = self.shatable = self.whichlist = self.idxnames = None
  96             self.map.close()
  97             self.map = None
  98
  99     def exists(self, hash, want_source=False):
 100         """Return nonempty if the object exists in the index files."""
 101         global _total_searches, _total_steps
 102         _total_searches += 1
 103         want = hash
 104         el = extract_bits(want, self.bits)
 105         if el:
 106             start = self._fanget(el-1)
 107             startv = el << (32-self.bits)
 108         else:
 109             start = 0
 110             startv = 0
 111         end = self._fanget(el)
 112         endv = (el+1) << (32-self.bits)
 113         _total_steps += 1   # lookup table is a step
 114         hashv = _helpers.firstword(hash)
 115         #print '(%08x) %08x %08x %08x' % (extract_bits(want, 32), startv, hashv, endv)
 116         while start < end:
 117             _total_steps += 1
 118             #print '! %08x %08x %08x   %d - %d' % (startv, hashv, endv, start, end)
 119             mid = start + (hashv - startv) * (end - start - 1) // (endv - startv)
 120             #print '  %08x %08x %08x   %d %d %d' % (startv, hashv, endv, start, mid, end)
 121             v = self._get(mid)
 122             #print '    %08x' % self._num(v)
 123             if v < want:
 124                 start = mid+1
 125                 startv = _helpers.firstword(v)
 126             elif v > want:
 127                 end = mid
 128                 endv = _helpers.firstword(v)
 129             else: # got it!
 130                 return want_source and self._get_idxname(mid) or True
 131         return None
 132
 133     def __iter__(self):
 134         start = self.sha_ofs
 135         for ofs in range(start, start + self.nsha * 20, 20):
 136             yield self.map[ofs : ofs + 20]
 137
 138     def __len__(self):
 139         return int(self.nsha)
 140
 141
 142 def clear_midxes(dir=None):
 143     for midx in glob.glob(os.path.join(dir, b'*.midx')):
 144         os.unlink(midx)