lib/bup/index.py

   1 import os, stat, struct, tempfile
   2 from bup.helpers import *
   3
   4 EMPTY_SHA = '\0'*20
   5 FAKE_SHA = '\x01'*20
   6 INDEX_HDR = 'BUPI\0\0\0\2'
   7
   8 # FIXME: guess I should have used 64-bit integers to store the mtime/ctime.
   9 # NTFS mtime=0 corresponds to the year 1600, which can't be stored in a 32-bit
  10 # time_t.  Next time we update the bupindex format, keep that in mind.
  11 INDEX_SIG = '!IIIIIQII20sHII'
  12
  13 ENTLEN = struct.calcsize(INDEX_SIG)
  14 FOOTER_SIG = '!Q'
  15 FOOTLEN = struct.calcsize(FOOTER_SIG)
  16
  17 IX_EXISTS = 0x8000        # file exists on filesystem
  18 IX_HASHVALID = 0x4000     # the stored sha1 matches the filesystem
  19 IX_SHAMISSING = 0x2000    # the stored sha1 object doesn't seem to exist
  20
  21 class Error(Exception):
  22     pass
  23
  24
  25 class Level:
  26     def __init__(self, ename, parent):
  27         self.parent = parent
  28         self.ename = ename
  29         self.list = []
  30         self.count = 0
  31
  32     def write(self, f):
  33         (ofs,n) = (f.tell(), len(self.list))
  34         if self.list:
  35             count = len(self.list)
  36             #log('popping %r with %d entries\n'
  37             #    % (''.join(self.ename), count))
  38             for e in self.list:
  39                 e.write(f)
  40             if self.parent:
  41                 self.parent.count += count + self.count
  42         return (ofs,n)
  43
  44
  45 def _golevel(level, f, ename, newentry):
  46     # close nodes back up the tree
  47     assert(level)
  48     while ename[:len(level.ename)] != level.ename:
  49         n = BlankNewEntry(level.ename[-1])
  50         n.flags |= IX_EXISTS
  51         (n.children_ofs,n.children_n) = level.write(f)
  52         level.parent.list.append(n)
  53         level = level.parent
  54
  55     # create nodes down the tree
  56     while len(level.ename) < len(ename):
  57         level = Level(ename[:len(level.ename)+1], level)
  58
  59     # are we in precisely the right place?
  60     assert(ename == level.ename)
  61     n = newentry or BlankNewEntry(ename and level.ename[-1] or None)
  62     (n.children_ofs,n.children_n) = level.write(f)
  63     if level.parent:
  64         level.parent.list.append(n)
  65     level = level.parent
  66
  67     return level
  68
  69
  70 class Entry:
  71     def __init__(self, basename, name):
  72         self.basename = str(basename)
  73         self.name = str(name)
  74         self.children_ofs = 0
  75         self.children_n = 0
  76
  77     def __repr__(self):
  78         return ("(%s,0x%04x,%d,%d,%d,%d,%d,%s/%s,0x%04x,0x%08x/%d)"
  79                 % (self.name, self.dev,
  80                    self.ctime, self.mtime, self.uid, self.gid,
  81                    self.size, oct(self.mode), oct(self.gitmode),
  82                    self.flags, self.children_ofs, self.children_n))
  83
  84     def packed(self):
  85         try:
  86             return struct.pack(INDEX_SIG,
  87                            self.dev, self.ctime, self.mtime,
  88                            self.uid, self.gid, self.size, self.mode,
  89                            self.gitmode, self.sha, self.flags,
  90                            self.children_ofs, self.children_n)
  91         except DeprecationWarning, e:
  92             log('pack error: %s (%r)\n' % (e, self))
  93             raise
  94
  95     def from_stat(self, st, tstart):
  96         old = (self.dev, self.ctime, self.mtime,
  97                self.uid, self.gid, self.size, self.flags & IX_EXISTS)
  98         new = (st.st_dev,
  99                int(st.st_ctime.approx_secs()),
 100                int(st.st_mtime.approx_secs()),
 101                st.st_uid, st.st_gid, st.st_size, IX_EXISTS)
 102         self.dev = st.st_dev
 103         self.ctime = int(st.st_ctime.approx_secs())
 104         self.mtime = int(st.st_mtime.approx_secs())
 105         self.uid = st.st_uid
 106         self.gid = st.st_gid
 107         self.size = st.st_size
 108         self.mode = st.st_mode
 109         self.flags |= IX_EXISTS
 110         if int(st.st_ctime.approx_secs()) >= tstart or old != new \
 111               or self.sha == EMPTY_SHA or not self.gitmode:
 112             self.invalidate()
 113         self._fixup()
 114
 115     def _fixup(self):
 116         if self.uid < 0:
 117             self.uid += 0x100000000
 118         if self.gid < 0:
 119             self.gid += 0x100000000
 120         assert(self.uid >= 0)
 121         assert(self.gid >= 0)
 122         if self.mtime < -0x80000000:  # can happen in NTFS on 64-bit linux
 123             self.mtime = 0
 124         if self.ctime < -0x80000000:
 125             self.ctime = 0
 126         if self.mtime > 0x7fffffff:
 127             self.mtime = 0x7fffffff
 128         if self.ctime > 0x7fffffff:
 129             self.ctime = 0x7fffffff
 130
 131     def is_valid(self):
 132         f = IX_HASHVALID|IX_EXISTS
 133         return (self.flags & f) == f
 134
 135     def invalidate(self):
 136         self.flags &= ~IX_HASHVALID
 137
 138     def validate(self, gitmode, sha):
 139         assert(sha)
 140         assert(gitmode)
 141         self.gitmode = gitmode
 142         self.sha = sha
 143         self.flags |= IX_HASHVALID|IX_EXISTS
 144
 145     def exists(self):
 146         return not self.is_deleted()
 147
 148     def sha_missing(self):
 149         return (self.flags & IX_SHAMISSING) or not (self.flags & IX_HASHVALID)
 150
 151     def is_deleted(self):
 152         return (self.flags & IX_EXISTS) == 0
 153
 154     def set_deleted(self):
 155         if self.flags & IX_EXISTS:
 156             self.flags &= ~(IX_EXISTS | IX_HASHVALID)
 157
 158     def is_real(self):
 159         return not self.is_fake()
 160
 161     def is_fake(self):
 162         return not self.ctime
 163
 164     def __cmp__(a, b):
 165         return (cmp(a.name, b.name)
 166                 or -cmp(a.is_valid(), b.is_valid())
 167                 or -cmp(a.is_fake(), b.is_fake()))
 168
 169     def write(self, f):
 170         f.write(self.basename + '\0' + self.packed())
 171
 172
 173 class NewEntry(Entry):
 174     def __init__(self, basename, name, dev, ctime, mtime, uid, gid,
 175                  size, mode, gitmode, sha, flags, children_ofs, children_n):
 176         Entry.__init__(self, basename, name)
 177         (self.dev, self.ctime, self.mtime, self.uid, self.gid,
 178          self.size, self.mode, self.gitmode, self.sha,
 179          self.flags, self.children_ofs, self.children_n
 180          ) = (dev, int(ctime), int(mtime), uid, gid,
 181               size, mode, gitmode, sha, flags, children_ofs, children_n)
 182         self._fixup()
 183
 184
 185 class BlankNewEntry(NewEntry):
 186     def __init__(self, basename):
 187         NewEntry.__init__(self, basename, basename,
 188                           0, 0, 0, 0, 0, 0, 0,
 189                           0, EMPTY_SHA, 0, 0, 0)
 190
 191
 192 class ExistingEntry(Entry):
 193     def __init__(self, parent, basename, name, m, ofs):
 194         Entry.__init__(self, basename, name)
 195         self.parent = parent
 196         self._m = m
 197         self._ofs = ofs
 198         (self.dev, self.ctime, self.mtime, self.uid, self.gid,
 199          self.size, self.mode, self.gitmode, self.sha,
 200          self.flags, self.children_ofs, self.children_n
 201          ) = struct.unpack(INDEX_SIG, str(buffer(m, ofs, ENTLEN)))
 202
 203     # effectively, we don't bother messing with IX_SHAMISSING if
 204     # not IX_HASHVALID, since it's redundant, and repacking is more
 205     # expensive than not repacking.
 206     # This is implemented by having sha_missing() check IX_HASHVALID too.
 207     def set_sha_missing(self, val):
 208         val = val and 1 or 0
 209         oldval = self.sha_missing() and 1 or 0
 210         if val != oldval:
 211             flag = val and IX_SHAMISSING or 0
 212             newflags = (self.flags & (~IX_SHAMISSING)) | flag
 213             self.flags = newflags
 214             self.repack()
 215
 216     def unset_sha_missing(self, flag):
 217         if self.flags & IX_SHAMISSING:
 218             self.flags &= ~IX_SHAMISSING
 219             self.repack()
 220
 221     def repack(self):
 222         self._m[self._ofs:self._ofs+ENTLEN] = self.packed()
 223         if self.parent and not self.is_valid():
 224             self.parent.invalidate()
 225             self.parent.repack()
 226
 227     def iter(self, name=None, wantrecurse=None):
 228         dname = name
 229         if dname and not dname.endswith('/'):
 230             dname += '/'
 231         ofs = self.children_ofs
 232         assert(ofs <= len(self._m))
 233         assert(self.children_n < 1000000)
 234         for i in xrange(self.children_n):
 235             eon = self._m.find('\0', ofs)
 236             assert(eon >= 0)
 237             assert(eon >= ofs)
 238             assert(eon > ofs)
 239             basename = str(buffer(self._m, ofs, eon-ofs))
 240             child = ExistingEntry(self, basename, self.name + basename,
 241                                   self._m, eon+1)
 242             if (not dname
 243                  or child.name.startswith(dname)
 244                  or child.name.endswith('/') and dname.startswith(child.name)):
 245                 if not wantrecurse or wantrecurse(child):
 246                     for e in child.iter(name=name, wantrecurse=wantrecurse):
 247                         yield e
 248             if not name or child.name == name or child.name.startswith(dname):
 249                 yield child
 250             ofs = eon + 1 + ENTLEN
 251
 252     def __iter__(self):
 253         return self.iter()
 254
 255
 256 class Reader:
 257     def __init__(self, filename):
 258         self.filename = filename
 259         self.m = ''
 260         self.writable = False
 261         self.count = 0
 262         f = None
 263         try:
 264             f = open(filename, 'r+')
 265         except IOError, e:
 266             if e.errno == errno.ENOENT:
 267                 pass
 268             else:
 269                 raise
 270         if f:
 271             b = f.read(len(INDEX_HDR))
 272             if b != INDEX_HDR:
 273                 log('warning: %s: header: expected %r, got %r'
 274                                  % (filename, INDEX_HDR, b))
 275             else:
 276                 st = os.fstat(f.fileno())
 277                 if st.st_size:
 278                     self.m = mmap_readwrite(f)
 279                     self.writable = True
 280                     self.count = struct.unpack(FOOTER_SIG,
 281                           str(buffer(self.m, st.st_size-FOOTLEN, FOOTLEN)))[0]
 282
 283     def __del__(self):
 284         self.close()
 285
 286     def __len__(self):
 287         return int(self.count)
 288
 289     def forward_iter(self):
 290         ofs = len(INDEX_HDR)
 291         while ofs+ENTLEN <= len(self.m)-FOOTLEN:
 292             eon = self.m.find('\0', ofs)
 293             assert(eon >= 0)
 294             assert(eon >= ofs)
 295             assert(eon > ofs)
 296             basename = str(buffer(self.m, ofs, eon-ofs))
 297             yield ExistingEntry(None, basename, basename, self.m, eon+1)
 298             ofs = eon + 1 + ENTLEN
 299
 300     def iter(self, name=None, wantrecurse=None):
 301         if len(self.m) > len(INDEX_HDR)+ENTLEN:
 302             dname = name
 303             if dname and not dname.endswith('/'):
 304                 dname += '/'
 305             root = ExistingEntry(None, '/', '/',
 306                                  self.m, len(self.m)-FOOTLEN-ENTLEN)
 307             for sub in root.iter(name=name, wantrecurse=wantrecurse):
 308                 yield sub
 309             if not dname or dname == root.name:
 310                 yield root
 311
 312     def __iter__(self):
 313         return self.iter()
 314
 315     def exists(self):
 316         return self.m
 317
 318     def save(self):
 319         if self.writable and self.m:
 320             self.m.flush()
 321
 322     def close(self):
 323         self.save()
 324         if self.writable and self.m:
 325             self.m.close()
 326             self.m = None
 327             self.writable = False
 328
 329     def filter(self, prefixes, wantrecurse=None):
 330         for (rp, path) in reduce_paths(prefixes):
 331             for e in self.iter(rp, wantrecurse=wantrecurse):
 332                 assert(e.name.startswith(rp))
 333                 name = path + e.name[len(rp):]
 334                 yield (name, e)
 335
 336
 337 # FIXME: this function isn't very generic, because it splits the filename
 338 # in an odd way and depends on a terminating '/' to indicate directories.
 339 def pathsplit(p):
 340     """Split a path into a list of elements of the file system hierarchy."""
 341     l = p.split('/')
 342     l = [i+'/' for i in l[:-1]] + l[-1:]
 343     if l[-1] == '':
 344         l.pop()  # extra blank caused by terminating '/'
 345     return l
 346
 347
 348 class Writer:
 349     def __init__(self, filename):
 350         self.rootlevel = self.level = Level([], None)
 351         self.f = None
 352         self.count = 0
 353         self.lastfile = None
 354         self.filename = None
 355         self.filename = filename = realpath(filename)
 356         (dir,name) = os.path.split(filename)
 357         (ffd,self.tmpname) = tempfile.mkstemp('.tmp', filename, dir)
 358         self.f = os.fdopen(ffd, 'wb', 65536)
 359         self.f.write(INDEX_HDR)
 360
 361     def __del__(self):
 362         self.abort()
 363
 364     def abort(self):
 365         f = self.f
 366         self.f = None
 367         if f:
 368             f.close()
 369             os.unlink(self.tmpname)
 370
 371     def flush(self):
 372         if self.level:
 373             self.level = _golevel(self.level, self.f, [], None)
 374             self.count = self.rootlevel.count
 375             if self.count:
 376                 self.count += 1
 377             self.f.write(struct.pack(FOOTER_SIG, self.count))
 378             self.f.flush()
 379         assert(self.level == None)
 380
 381     def close(self):
 382         self.flush()
 383         f = self.f
 384         self.f = None
 385         if f:
 386             f.close()
 387             os.rename(self.tmpname, self.filename)
 388
 389     def _add(self, ename, entry):
 390         if self.lastfile and self.lastfile <= ename:
 391             raise Error('%r must come before %r'
 392                              % (''.join(e.name), ''.join(self.lastfile)))
 393             self.lastfile = e.name
 394         self.level = _golevel(self.level, self.f, ename, entry)
 395
 396     def add(self, name, st, hashgen = None):
 397         endswith = name.endswith('/')
 398         ename = pathsplit(name)
 399         basename = ename[-1]
 400         #log('add: %r %r\n' % (basename, name))
 401         flags = IX_EXISTS
 402         sha = None
 403         if hashgen:
 404             (gitmode, sha) = hashgen(name)
 405             flags |= IX_HASHVALID
 406         else:
 407             (gitmode, sha) = (0, EMPTY_SHA)
 408         if st:
 409             isdir = stat.S_ISDIR(st.st_mode)
 410             assert(isdir == endswith)
 411             e = NewEntry(basename, name, st.st_dev,
 412                          int(st.st_ctime.approx_secs()),
 413                          int(st.st_mtime.approx_secs()),
 414                          st.st_uid, st.st_gid,
 415                          st.st_size, st.st_mode, gitmode, sha, flags,
 416                          0, 0)
 417         else:
 418             assert(endswith)
 419             e = BlankNewEntry(basename)
 420             e.gitmode = gitmode
 421             e.sha = sha
 422             e.flags = flags
 423         self._add(ename, e)
 424
 425     def add_ixentry(self, e):
 426         e.children_ofs = e.children_n = 0
 427         self._add(pathsplit(e.name), e)
 428
 429     def new_reader(self):
 430         self.flush()
 431         return Reader(self.tmpname)
 432
 433
 434 def reduce_paths(paths):
 435     xpaths = []
 436     for p in paths:
 437         rp = realpath(p)
 438         try:
 439             st = os.lstat(rp)
 440             if stat.S_ISDIR(st.st_mode):
 441                 rp = slashappend(rp)
 442                 p = slashappend(p)
 443             xpaths.append((rp, p))
 444         except OSError, e:
 445             add_error('reduce_paths: %s' % e)
 446     xpaths.sort()
 447
 448     paths = []
 449     prev = None
 450     for (rp, p) in xpaths:
 451         if prev and (prev == rp
 452                      or (prev.endswith('/') and rp.startswith(prev))):
 453             continue # already superceded by previous path
 454         paths.append((rp, p))
 455         prev = rp
 456     paths.sort(reverse=True)
 457     return paths
 458
 459
 460 class MergeIter:
 461     def __init__(self, iters):
 462         self.iters = iters
 463
 464     def __len__(self):
 465         # FIXME: doesn't remove duplicated entries between iters.
 466         # That only happens for parent directories, but will mean the
 467         # actual iteration returns fewer entries than this function counts.
 468         return sum(len(it) for it in self.iters)
 469
 470     def __iter__(self):
 471         total = len(self)
 472         l = [iter(it) for it in self.iters]
 473         l = [(next(it),it) for it in l]
 474         l = filter(lambda x: x[0], l)
 475         count = 0
 476         lastname = None
 477         while l:
 478             if not (count % 1024):
 479                 progress('bup: merging indexes (%d/%d)\r' % (count, total))
 480             l.sort()
 481             (e,it) = l.pop()
 482             if not e:
 483                 continue
 484             if e.name != lastname:
 485                 yield e
 486                 lastname = e.name
 487             n = next(it)
 488             if n:
 489                 l.append((n,it))
 490             count += 1
 491         log('bup: merging indexes (%d/%d), done.\n' % (count, total))