lib/bup/index.py

   1
   2 from __future__ import absolute_import, print_function
   3 import errno, os, stat, struct, tempfile
   4
   5 from bup import metadata, xstat
   6 from bup._helpers import UINT_MAX, bytescmp
   7 from bup.compat import pending_raise, range
   8 from bup.helpers import (add_error, log, merge_iter, mmap_readwrite,
   9                          progress, qprogress, resolve_parent, slashappend)
  10
  11 EMPTY_SHA = b'\0' * 20
  12 FAKE_SHA = b'\x01' * 20
  13
  14 INDEX_HDR = b'BUPI\0\0\0\7'
  15
  16 # Time values are handled as integer nanoseconds since the epoch in
  17 # memory, but are written as xstat/metadata timespecs.  This behavior
  18 # matches the existing metadata/xstat/.bupm code.
  19
  20 # Record times (mtime, ctime, atime) as xstat/metadata timespecs, and
  21 # store all of the times in the index so they won't interfere with the
  22 # forthcoming metadata cache.
  23 INDEX_SIG = ('!'
  24              'Q'                # dev
  25              'Q'                # ino
  26              'Q'                # nlink
  27              'qQ'               # ctime_s, ctime_ns
  28              'qQ'               # mtime_s, mtime_ns
  29              'qQ'               # atime_s, atime_ns
  30              'Q'                # size
  31              'I'                # mode
  32              'I'                # gitmode
  33              '20s'              # sha
  34              'H'                # flags
  35              'Q'                # children_ofs
  36              'I'                # children_n
  37              'Q')               # meta_ofs
  38
  39 ENTLEN = struct.calcsize(INDEX_SIG)
  40 FOOTER_SIG = '!Q'
  41 FOOTLEN = struct.calcsize(FOOTER_SIG)
  42
  43 IX_EXISTS = 0x8000        # file exists on filesystem
  44 IX_HASHVALID = 0x4000     # the stored sha1 matches the filesystem
  45 IX_SHAMISSING = 0x2000    # the stored sha1 object doesn't seem to exist
  46
  47 class Error(Exception):
  48     pass
  49
  50
  51 class MetaStoreReader:
  52     def __init__(self, filename):
  53         self._file = None
  54         self._file = open(filename, 'rb')
  55
  56     def close(self):
  57         if self._file:
  58             self._file.close()
  59             self._file = None
  60
  61     def __enter__(self):
  62         return self
  63
  64     def __exit__(self, type, value, traceback):
  65         with pending_raise(value, rethrow=True):
  66             self.close()
  67
  68     def metadata_at(self, ofs):
  69         self._file.seek(ofs)
  70         return metadata.Metadata.read(self._file)
  71
  72
  73 class MetaStoreWriter:
  74     # For now, we just append to the file, and try to handle any
  75     # truncation or corruption somewhat sensibly.
  76
  77     def __init__(self, filename):
  78         # Map metadata hashes to bupindex.meta offsets.
  79         self._offsets = {}
  80         self._filename = filename
  81         self._file = None
  82         # FIXME: see how slow this is; does it matter?
  83         m_file = open(filename, 'ab+')
  84         try:
  85             m_file.seek(0)
  86             try:
  87                 m_off = m_file.tell()
  88                 m = metadata.Metadata.read(m_file)
  89                 while m:
  90                     m_encoded = m.encode()
  91                     self._offsets[m_encoded] = m_off
  92                     m_off = m_file.tell()
  93                     m = metadata.Metadata.read(m_file)
  94             except EOFError:
  95                 pass
  96             except:
  97                 log('index metadata in %r appears to be corrupt\n' % filename)
  98                 raise
  99         finally:
 100             m_file.close()
 101         self._file = open(filename, 'ab')
 102
 103     def close(self):
 104         if self._file:
 105             self._file.close()
 106             self._file = None
 107
 108     def __enter__(self):
 109         return self
 110
 111     def __exit__(self, type, value, traceback):
 112         with pending_raise(value, rethrow=False):
 113             self.close()
 114
 115     def store(self, metadata):
 116         meta_encoded = metadata.encode(include_path=False)
 117         ofs = self._offsets.get(meta_encoded)
 118         if ofs:
 119             return ofs
 120         ofs = self._file.tell()
 121         self._file.write(meta_encoded)
 122         self._offsets[meta_encoded] = ofs
 123         return ofs
 124
 125
 126 class Level:
 127     def __init__(self, ename, parent):
 128         self.parent = parent
 129         self.ename = ename
 130         self.list = []
 131         self.count = 0
 132
 133     def write(self, f):
 134         (ofs,n) = (f.tell(), len(self.list))
 135         if self.list:
 136             count = len(self.list)
 137             #log('popping %r with %d entries\n'
 138             #    % (''.join(self.ename), count))
 139             for e in self.list:
 140                 e.write(f)
 141             if self.parent:
 142                 self.parent.count += count + self.count
 143         return (ofs,n)
 144
 145
 146 def _golevel(level, f, ename, newentry, metastore, tmax):
 147     # close nodes back up the tree
 148     assert(level)
 149     default_meta_ofs = metastore.store(metadata.Metadata())
 150     while ename[:len(level.ename)] != level.ename:
 151         n = BlankNewEntry(level.ename[-1], default_meta_ofs, tmax)
 152         n.flags |= IX_EXISTS
 153         (n.children_ofs,n.children_n) = level.write(f)
 154         level.parent.list.append(n)
 155         level = level.parent
 156
 157     # create nodes down the tree
 158     while len(level.ename) < len(ename):
 159         level = Level(ename[:len(level.ename)+1], level)
 160
 161     # are we in precisely the right place?
 162     assert(ename == level.ename)
 163     n = newentry or \
 164         BlankNewEntry(ename and level.ename[-1] or None, default_meta_ofs, tmax)
 165     (n.children_ofs,n.children_n) = level.write(f)
 166     if level.parent:
 167         level.parent.list.append(n)
 168     level = level.parent
 169
 170     return level
 171
 172
 173 class Entry:
 174     def __init__(self, basename, name, meta_ofs, tmax):
 175         assert basename is None or isinstance(basename, bytes)
 176         assert name is None or isinstance(name, bytes)
 177         self.basename = basename
 178         self.name = name
 179         self.meta_ofs = meta_ofs
 180         self.tmax = tmax
 181         self.children_ofs = 0
 182         self.children_n = 0
 183
 184     def __repr__(self):
 185         return ("(%r,0x%04x,%d,%d,%d,%d,%d,%d,%s/%s,0x%04x,%d,0x%08x/%d)"
 186                 % (self.name, self.dev, self.ino, self.nlink,
 187                    self.ctime, self.mtime, self.atime,
 188                    self.size, self.mode, self.gitmode,
 189                    self.flags, self.meta_ofs,
 190                    self.children_ofs, self.children_n))
 191
 192     def packed(self):
 193         try:
 194             ctime = xstat.nsecs_to_timespec(self.ctime)
 195             mtime = xstat.nsecs_to_timespec(self.mtime)
 196             atime = xstat.nsecs_to_timespec(self.atime)
 197             return struct.pack(INDEX_SIG,
 198                                self.dev, self.ino, self.nlink,
 199                                ctime[0], ctime[1],
 200                                mtime[0], mtime[1],
 201                                atime[0], atime[1],
 202                                self.size, self.mode,
 203                                self.gitmode, self.sha, self.flags,
 204                                self.children_ofs, self.children_n,
 205                                self.meta_ofs)
 206         except (DeprecationWarning, struct.error) as e:
 207             log('pack error: %s (%r)\n' % (e, self))
 208             raise
 209
 210     def stale(self, st, check_device=True):
 211         if self.size != st.st_size:
 212             return True
 213         if self.mtime != st.st_mtime:
 214             return True
 215         if self.sha == EMPTY_SHA:
 216             return True
 217         if not self.gitmode:
 218             return True
 219         if self.ctime != st.st_ctime:
 220             return True
 221         if self.ino != st.st_ino:
 222             return True
 223         if self.nlink != st.st_nlink:
 224             return True
 225         if not (self.flags & IX_EXISTS):
 226             return True
 227         if check_device and (self.dev != st.st_dev):
 228             return True
 229         return False
 230
 231     def update_from_stat(self, st, meta_ofs):
 232         # Should only be called when the entry is stale(), and
 233         # invalidate() should almost certainly be called afterward.
 234         self.dev = st.st_dev
 235         self.ino = st.st_ino
 236         self.nlink = st.st_nlink
 237         self.ctime = st.st_ctime
 238         self.mtime = st.st_mtime
 239         self.atime = st.st_atime
 240         self.size = st.st_size
 241         self.mode = st.st_mode
 242         self.flags |= IX_EXISTS
 243         self.meta_ofs = meta_ofs
 244         self._fixup()
 245
 246     def _fixup(self):
 247         self.mtime = self._fixup_time(self.mtime)
 248         self.ctime = self._fixup_time(self.ctime)
 249
 250     def _fixup_time(self, t):
 251         if self.tmax != None and t > self.tmax:
 252             return self.tmax
 253         else:
 254             return t
 255
 256     def is_valid(self):
 257         f = IX_HASHVALID|IX_EXISTS
 258         return (self.flags & f) == f
 259
 260     def invalidate(self):
 261         self.flags &= ~IX_HASHVALID
 262
 263     def validate(self, gitmode, sha):
 264         assert(sha)
 265         assert(gitmode)
 266         assert(gitmode+0 == gitmode)
 267         self.gitmode = gitmode
 268         self.sha = sha
 269         self.flags |= IX_HASHVALID|IX_EXISTS
 270
 271     def exists(self):
 272         return not self.is_deleted()
 273
 274     def sha_missing(self):
 275         return (self.flags & IX_SHAMISSING) or not (self.flags & IX_HASHVALID)
 276
 277     def is_deleted(self):
 278         return (self.flags & IX_EXISTS) == 0
 279
 280     def set_deleted(self):
 281         if self.flags & IX_EXISTS:
 282             self.flags &= ~(IX_EXISTS | IX_HASHVALID)
 283
 284     def is_real(self):
 285         return not self.is_fake()
 286
 287     def is_fake(self):
 288         return not self.ctime
 289
 290     def _cmp(self, other):
 291         # Note reversed name ordering
 292         bc = bytescmp(other.name, self.name)
 293         if bc != 0:
 294             return bc
 295         vc = self.is_valid() - other.is_valid()
 296         if vc != 0:
 297             return vc
 298         fc = self.is_fake() - other.is_fake()
 299         if fc != 0:
 300             return fc
 301         return 0
 302
 303     def __eq__(self, other):
 304         return self._cmp(other) == 0
 305
 306     def __ne__(self, other):
 307         return self._cmp(other) != 0
 308
 309     def __lt__(self, other):
 310         return self._cmp(other) < 0
 311
 312     def __gt__(self, other):
 313         return self._cmp(other) > 0
 314
 315     def __le__(self, other):
 316         return self._cmp(other) <= 0
 317
 318     def __ge__(self, other):
 319         return self._cmp(other) >= 0
 320
 321     def write(self, f):
 322         f.write(self.basename + b'\0' + self.packed())
 323
 324
 325 class NewEntry(Entry):
 326     def __init__(self, basename, name, tmax, dev, ino, nlink,
 327                  ctime, mtime, atime,
 328                  size, mode, gitmode, sha, flags, meta_ofs,
 329                  children_ofs, children_n):
 330         Entry.__init__(self, basename, name, meta_ofs, tmax)
 331         (self.dev, self.ino, self.nlink, self.ctime, self.mtime, self.atime,
 332          self.size, self.mode, self.gitmode, self.sha,
 333          self.flags, self.children_ofs, self.children_n
 334          ) = (dev, ino, nlink, ctime, mtime, atime,
 335               size, mode, gitmode, sha, flags, children_ofs, children_n)
 336         self._fixup()
 337
 338
 339 class BlankNewEntry(NewEntry):
 340     def __init__(self, basename, meta_ofs, tmax):
 341         NewEntry.__init__(self, basename, basename, tmax,
 342                           0, 0, 0, 0, 0, 0, 0, 0,
 343                           0, EMPTY_SHA, 0, meta_ofs, 0, 0)
 344
 345
 346 class ExistingEntry(Entry):
 347     def __init__(self, parent, basename, name, m, ofs):
 348         Entry.__init__(self, basename, name, None, None)
 349         self.parent = parent
 350         self._m = m
 351         self._ofs = ofs
 352         (self.dev, self.ino, self.nlink,
 353          self.ctime, ctime_ns, self.mtime, mtime_ns, self.atime, atime_ns,
 354          self.size, self.mode, self.gitmode, self.sha,
 355          self.flags, self.children_ofs, self.children_n, self.meta_ofs
 356          ) = struct.unpack(INDEX_SIG, m[ofs : ofs + ENTLEN])
 357         self.atime = xstat.timespec_to_nsecs((self.atime, atime_ns))
 358         self.mtime = xstat.timespec_to_nsecs((self.mtime, mtime_ns))
 359         self.ctime = xstat.timespec_to_nsecs((self.ctime, ctime_ns))
 360
 361     # effectively, we don't bother messing with IX_SHAMISSING if
 362     # not IX_HASHVALID, since it's redundant, and repacking is more
 363     # expensive than not repacking.
 364     # This is implemented by having sha_missing() check IX_HASHVALID too.
 365     def set_sha_missing(self, val):
 366         val = val and 1 or 0
 367         oldval = self.sha_missing() and 1 or 0
 368         if val != oldval:
 369             flag = val and IX_SHAMISSING or 0
 370             newflags = (self.flags & (~IX_SHAMISSING)) | flag
 371             self.flags = newflags
 372             self.repack()
 373
 374     def unset_sha_missing(self, flag):
 375         if self.flags & IX_SHAMISSING:
 376             self.flags &= ~IX_SHAMISSING
 377             self.repack()
 378
 379     def repack(self):
 380         self._m[self._ofs:self._ofs+ENTLEN] = self.packed()
 381         if self.parent and not self.is_valid():
 382             self.parent.invalidate()
 383             self.parent.repack()
 384
 385     def iter(self, name=None, wantrecurse=None):
 386         dname = name
 387         if dname and not dname.endswith(b'/'):
 388             dname += b'/'
 389         ofs = self.children_ofs
 390         assert(ofs <= len(self._m))
 391         assert(self.children_n <= UINT_MAX)  # i.e. python struct 'I'
 392         for i in range(self.children_n):
 393             eon = self._m.find(b'\0', ofs)
 394             assert(eon >= 0)
 395             assert(eon >= ofs)
 396             assert(eon > ofs)
 397             basename = self._m[ofs : ofs + (eon - ofs)]
 398             child = ExistingEntry(self, basename, self.name + basename,
 399                                   self._m, eon+1)
 400             if (not dname
 401                  or child.name.startswith(dname)
 402                  or child.name.endswith(b'/') and dname.startswith(child.name)):
 403                 if not wantrecurse or wantrecurse(child):
 404                     for e in child.iter(name=name, wantrecurse=wantrecurse):
 405                         yield e
 406             if not name or child.name == name or child.name.startswith(dname):
 407                 yield child
 408             ofs = eon + 1 + ENTLEN
 409
 410     def __iter__(self):
 411         return self.iter()
 412
 413
 414 class Reader:
 415     def __init__(self, filename):
 416         self.filename = filename
 417         self.m = b''
 418         self.writable = False
 419         self.count = 0
 420         f = None
 421         try:
 422             f = open(filename, 'rb+')
 423         except IOError as e:
 424             if e.errno == errno.ENOENT:
 425                 pass
 426             else:
 427                 raise
 428         if f:
 429             b = f.read(len(INDEX_HDR))
 430             if b != INDEX_HDR:
 431                 log('warning: %s: header: expected %r, got %r\n'
 432                                  % (filename, INDEX_HDR, b))
 433             else:
 434                 st = os.fstat(f.fileno())
 435                 if st.st_size:
 436                     self.m = mmap_readwrite(f)
 437                     self.writable = True
 438                     self.count = struct.unpack(FOOTER_SIG,
 439                                                self.m[st.st_size - FOOTLEN
 440                                                       : st.st_size])[0]
 441
 442     def __enter__(self):
 443         return self
 444
 445     def __exit__(self, type, value, traceback):
 446         with pending_raise(value, rethrow=False):
 447             self.close()
 448
 449     def __len__(self):
 450         return int(self.count)
 451
 452     def forward_iter(self):
 453         ofs = len(INDEX_HDR)
 454         while ofs+ENTLEN <= len(self.m)-FOOTLEN:
 455             eon = self.m.find(b'\0', ofs)
 456             assert(eon >= 0)
 457             assert(eon >= ofs)
 458             assert(eon > ofs)
 459             basename = self.m[ofs : ofs + (eon - ofs)]
 460             yield ExistingEntry(None, basename, basename, self.m, eon+1)
 461             ofs = eon + 1 + ENTLEN
 462
 463     def iter(self, name=None, wantrecurse=None):
 464         if len(self.m) > len(INDEX_HDR)+ENTLEN:
 465             dname = name
 466             if dname and not dname.endswith(b'/'):
 467                 dname += b'/'
 468             root = ExistingEntry(None, b'/', b'/',
 469                                  self.m, len(self.m)-FOOTLEN-ENTLEN)
 470             for sub in root.iter(name=name, wantrecurse=wantrecurse):
 471                 yield sub
 472             if not dname or dname == root.name:
 473                 yield root
 474
 475     def __iter__(self):
 476         return self.iter()
 477
 478     def find(self, name):
 479         return next((e for e in self.iter(name, wantrecurse=lambda x : True)
 480                      if e.name == name),
 481                     None)
 482
 483     def exists(self):
 484         return self.m
 485
 486     def save(self):
 487         if self.writable and self.m:
 488             self.m.flush()
 489
 490     def close(self):
 491         self.save()
 492         if self.writable and self.m:
 493             self.m.close()
 494             self.m = None
 495             self.writable = False
 496
 497     def filter(self, prefixes, wantrecurse=None):
 498         for (rp, path) in reduce_paths(prefixes):
 499             any_entries = False
 500             for e in self.iter(rp, wantrecurse=wantrecurse):
 501                 any_entries = True
 502                 assert(e.name.startswith(rp))
 503                 name = path + e.name[len(rp):]
 504                 yield (name, e)
 505             if not any_entries:
 506                 # Always return at least the top for each prefix.
 507                 # Otherwise something like "save x/y" will produce
 508                 # nothing if x is up to date.
 509                 pe = self.find(rp)
 510                 assert(pe)
 511                 name = path + pe.name[len(rp):]
 512                 yield (name, pe)
 513
 514 # FIXME: this function isn't very generic, because it splits the filename
 515 # in an odd way and depends on a terminating '/' to indicate directories.
 516 def pathsplit(p):
 517     """Split a path into a list of elements of the file system hierarchy."""
 518     l = p.split(b'/')
 519     l = [i + b'/' for i in l[:-1]] + l[-1:]
 520     if l[-1] == b'':
 521         l.pop()  # extra blank caused by terminating '/'
 522     return l
 523
 524
 525 class Writer:
 526     def __init__(self, filename, metastore, tmax):
 527         self.rootlevel = self.level = Level([], None)
 528         self.f = None
 529         self.count = 0
 530         self.lastfile = None
 531         self.filename = None
 532         self.filename = filename = resolve_parent(filename)
 533         self.metastore = metastore
 534         self.tmax = tmax
 535         (dir,name) = os.path.split(filename)
 536         ffd, self.tmpname = tempfile.mkstemp(b'.tmp', filename, dir)
 537         self.f = os.fdopen(ffd, 'wb', 65536)
 538         self.f.write(INDEX_HDR)
 539
 540     def __enter__(self):
 541         return self
 542
 543     def __exit__(self, type, value, traceback):
 544         with pending_raise(value, rethrow=False):
 545             self.abort()
 546
 547     def abort(self):
 548         f = self.f
 549         self.f = None
 550         if f:
 551             f.close()
 552             os.unlink(self.tmpname)
 553
 554     def flush(self):
 555         if self.level:
 556             self.level = _golevel(self.level, self.f, [], None,
 557                                   self.metastore, self.tmax)
 558             self.count = self.rootlevel.count
 559             if self.count:
 560                 self.count += 1
 561             self.f.write(struct.pack(FOOTER_SIG, self.count))
 562             self.f.flush()
 563         assert(self.level == None)
 564
 565     def close(self):
 566         self.flush()
 567         f = self.f
 568         self.f = None
 569         if f:
 570             f.close()
 571             os.rename(self.tmpname, self.filename)
 572
 573     def _add(self, ename, entry):
 574         if self.lastfile and self.lastfile <= ename:
 575             raise Error('%r must come before %r'
 576                              % (''.join(ename), ''.join(self.lastfile)))
 577         self.lastfile = ename
 578         self.level = _golevel(self.level, self.f, ename, entry,
 579                               self.metastore, self.tmax)
 580
 581     def add(self, name, st, meta_ofs, hashgen = None):
 582         endswith = name.endswith(b'/')
 583         ename = pathsplit(name)
 584         basename = ename[-1]
 585         #log('add: %r %r\n' % (basename, name))
 586         flags = IX_EXISTS
 587         sha = None
 588         if hashgen:
 589             (gitmode, sha) = hashgen(name)
 590             flags |= IX_HASHVALID
 591         else:
 592             (gitmode, sha) = (0, EMPTY_SHA)
 593         if st:
 594             isdir = stat.S_ISDIR(st.st_mode)
 595             assert(isdir == endswith)
 596             e = NewEntry(basename, name, self.tmax,
 597                          st.st_dev, st.st_ino, st.st_nlink,
 598                          st.st_ctime, st.st_mtime, st.st_atime,
 599                          st.st_size, st.st_mode, gitmode, sha, flags,
 600                          meta_ofs, 0, 0)
 601         else:
 602             assert(endswith)
 603             meta_ofs = self.metastore.store(metadata.Metadata())
 604             e = BlankNewEntry(basename, meta_ofs, self.tmax)
 605             e.gitmode = gitmode
 606             e.sha = sha
 607             e.flags = flags
 608         self._add(ename, e)
 609
 610     def add_ixentry(self, e):
 611         e.children_ofs = e.children_n = 0
 612         self._add(pathsplit(e.name), e)
 613
 614     def new_reader(self):
 615         self.flush()
 616         return Reader(self.tmpname)
 617
 618
 619 def _slashappend_or_add_error(p, caller):
 620     """Return p, after ensuring it has a single trailing slash if it names
 621     a directory, unless there's an OSError, in which case, call
 622     add_error() and return None."""
 623     try:
 624         st = os.lstat(p)
 625     except OSError as e:
 626         add_error('%s: %s' % (caller, e))
 627         return None
 628     else:
 629         if stat.S_ISDIR(st.st_mode):
 630             return slashappend(p)
 631         return p
 632
 633
 634 def unique_resolved_paths(paths):
 635     "Return a collection of unique resolved paths."
 636     rps = (_slashappend_or_add_error(resolve_parent(p), 'unique_resolved_paths')
 637            for p in paths)
 638     return frozenset((x for x in rps if x is not None))
 639
 640
 641 def reduce_paths(paths):
 642     xpaths = []
 643     for p in paths:
 644         rp = _slashappend_or_add_error(resolve_parent(p), 'reduce_paths')
 645         if rp:
 646             xpaths.append((rp, slashappend(p) if rp.endswith(b'/') else p))
 647     xpaths.sort()
 648
 649     paths = []
 650     prev = None
 651     for (rp, p) in xpaths:
 652         if prev and (prev == rp
 653                      or (prev.endswith(b'/') and rp.startswith(prev))):
 654             continue # already superceded by previous path
 655         paths.append((rp, p))
 656         prev = rp
 657     paths.sort(reverse=True)
 658     return paths
 659
 660
 661 def merge(*iters):
 662     def pfunc(count, total):
 663         qprogress('bup: merging indexes (%d/%d)\r' % (count, total))
 664     def pfinal(count, total):
 665         progress('bup: merging indexes (%d/%d), done.\n' % (count, total))
 666     return merge_iter(iters, 1024, pfunc, pfinal, key='name')