lib/bup/index.py

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