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         if self.mtime < -0x80000000:  # can happen in NTFS on 64-bit linux
 124             self.mtime = 0
 125         if self.ctime < -0x80000000:
 126             self.ctime = 0
 127         if self.mtime > 0x7fffffff:
 128             self.mtime = 0x7fffffff
 129         if self.ctime > 0x7fffffff:
 130             self.ctime = 0x7fffffff
 131
 132     def is_valid(self):
 133         f = IX_HASHVALID|IX_EXISTS
 134         return (self.flags & f) == f
 135
 136     def invalidate(self):
 137         self.flags &= ~IX_HASHVALID
 138
 139     def validate(self, gitmode, sha):
 140         assert(sha)
 141         assert(gitmode)
 142         assert(gitmode+0 == gitmode)
 143         self.gitmode = gitmode
 144         self.sha = sha
 145         self.flags |= IX_HASHVALID|IX_EXISTS
 146
 147     def exists(self):
 148         return not self.is_deleted()
 149
 150     def sha_missing(self):
 151         return (self.flags & IX_SHAMISSING) or not (self.flags & IX_HASHVALID)
 152
 153     def is_deleted(self):
 154         return (self.flags & IX_EXISTS) == 0
 155
 156     def set_deleted(self):
 157         if self.flags & IX_EXISTS:
 158             self.flags &= ~(IX_EXISTS | IX_HASHVALID)
 159
 160     def is_real(self):
 161         return not self.is_fake()
 162
 163     def is_fake(self):
 164         return not self.ctime
 165
 166     def __cmp__(a, b):
 167         return (cmp(b.name, a.name)
 168                 or cmp(a.is_valid(), b.is_valid())
 169                 or cmp(a.is_fake(), b.is_fake()))
 170
 171     def write(self, f):
 172         f.write(self.basename + '\0' + self.packed())
 173
 174
 175 class NewEntry(Entry):
 176     def __init__(self, basename, name, dev, ctime, mtime, uid, gid,
 177                  size, mode, gitmode, sha, flags, children_ofs, children_n):
 178         Entry.__init__(self, basename, name)
 179         (self.dev, self.ctime, self.mtime, self.uid, self.gid,
 180          self.size, self.mode, self.gitmode, self.sha,
 181          self.flags, self.children_ofs, self.children_n
 182          ) = (dev, int(ctime), int(mtime), uid, gid,
 183               size, mode, gitmode, sha, flags, children_ofs, children_n)
 184         self._fixup()
 185
 186
 187 class BlankNewEntry(NewEntry):
 188     def __init__(self, basename):
 189         NewEntry.__init__(self, basename, basename,
 190                           0, 0, 0, 0, 0, 0, 0,
 191                           0, EMPTY_SHA, 0, 0, 0)
 192
 193
 194 class ExistingEntry(Entry):
 195     def __init__(self, parent, basename, name, m, ofs):
 196         Entry.__init__(self, basename, name)
 197         self.parent = parent
 198         self._m = m
 199         self._ofs = ofs
 200         (self.dev, self.ctime, self.mtime, self.uid, self.gid,
 201          self.size, self.mode, self.gitmode, self.sha,
 202          self.flags, self.children_ofs, self.children_n
 203          ) = struct.unpack(INDEX_SIG, str(buffer(m, ofs, ENTLEN)))
 204
 205     # effectively, we don't bother messing with IX_SHAMISSING if
 206     # not IX_HASHVALID, since it's redundant, and repacking is more
 207     # expensive than not repacking.
 208     # This is implemented by having sha_missing() check IX_HASHVALID too.
 209     def set_sha_missing(self, val):
 210         val = val and 1 or 0
 211         oldval = self.sha_missing() and 1 or 0
 212         if val != oldval:
 213             flag = val and IX_SHAMISSING or 0
 214             newflags = (self.flags & (~IX_SHAMISSING)) | flag
 215             self.flags = newflags
 216             self.repack()
 217
 218     def unset_sha_missing(self, flag):
 219         if self.flags & IX_SHAMISSING:
 220             self.flags &= ~IX_SHAMISSING
 221             self.repack()
 222
 223     def repack(self):
 224         self._m[self._ofs:self._ofs+ENTLEN] = self.packed()
 225         if self.parent and not self.is_valid():
 226             self.parent.invalidate()
 227             self.parent.repack()
 228
 229     def iter(self, name=None, wantrecurse=None):
 230         dname = name
 231         if dname and not dname.endswith('/'):
 232             dname += '/'
 233         ofs = self.children_ofs
 234         assert(ofs <= len(self._m))
 235         assert(self.children_n < 1000000)
 236         for i in xrange(self.children_n):
 237             eon = self._m.find('\0', ofs)
 238             assert(eon >= 0)
 239             assert(eon >= ofs)
 240             assert(eon > ofs)
 241             basename = str(buffer(self._m, ofs, eon-ofs))
 242             child = ExistingEntry(self, basename, self.name + basename,
 243                                   self._m, eon+1)
 244             if (not dname
 245                  or child.name.startswith(dname)
 246                  or child.name.endswith('/') and dname.startswith(child.name)):
 247                 if not wantrecurse or wantrecurse(child):
 248                     for e in child.iter(name=name, wantrecurse=wantrecurse):
 249                         yield e
 250             if not name or child.name == name or child.name.startswith(dname):
 251                 yield child
 252             ofs = eon + 1 + ENTLEN
 253
 254     def __iter__(self):
 255         return self.iter()
 256
 257
 258 class Reader:
 259     def __init__(self, filename):
 260         self.filename = filename
 261         self.m = ''
 262         self.writable = False
 263         self.count = 0
 264         f = None
 265         try:
 266             f = open(filename, 'r+')
 267         except IOError, e:
 268             if e.errno == errno.ENOENT:
 269                 pass
 270             else:
 271                 raise
 272         if f:
 273             b = f.read(len(INDEX_HDR))
 274             if b != INDEX_HDR:
 275                 log('warning: %s: header: expected %r, got %r'
 276                                  % (filename, INDEX_HDR, b))
 277             else:
 278                 st = os.fstat(f.fileno())
 279                 if st.st_size:
 280                     self.m = mmap_readwrite(f)
 281                     self.writable = True
 282                     self.count = struct.unpack(FOOTER_SIG,
 283                           str(buffer(self.m, st.st_size-FOOTLEN, FOOTLEN)))[0]
 284
 285     def __del__(self):
 286         self.close()
 287
 288     def __len__(self):
 289         return int(self.count)
 290
 291     def forward_iter(self):
 292         ofs = len(INDEX_HDR)
 293         while ofs+ENTLEN <= len(self.m)-FOOTLEN:
 294             eon = self.m.find('\0', ofs)
 295             assert(eon >= 0)
 296             assert(eon >= ofs)
 297             assert(eon > ofs)
 298             basename = str(buffer(self.m, ofs, eon-ofs))
 299             yield ExistingEntry(None, basename, basename, self.m, eon+1)
 300             ofs = eon + 1 + ENTLEN
 301
 302     def iter(self, name=None, wantrecurse=None):
 303         if len(self.m) > len(INDEX_HDR)+ENTLEN:
 304             dname = name
 305             if dname and not dname.endswith('/'):
 306                 dname += '/'
 307             root = ExistingEntry(None, '/', '/',
 308                                  self.m, len(self.m)-FOOTLEN-ENTLEN)
 309             for sub in root.iter(name=name, wantrecurse=wantrecurse):
 310                 yield sub
 311             if not dname or dname == root.name:
 312                 yield root
 313
 314     def __iter__(self):
 315         return self.iter()
 316
 317     def exists(self):
 318         return self.m
 319
 320     def save(self):
 321         if self.writable and self.m:
 322             self.m.flush()
 323
 324     def close(self):
 325         self.save()
 326         if self.writable and self.m:
 327             self.m.close()
 328             self.m = None
 329             self.writable = False
 330
 331     def filter(self, prefixes, wantrecurse=None):
 332         for (rp, path) in reduce_paths(prefixes):
 333             for e in self.iter(rp, wantrecurse=wantrecurse):
 334                 assert(e.name.startswith(rp))
 335                 name = path + e.name[len(rp):]
 336                 yield (name, e)
 337
 338
 339 # FIXME: this function isn't very generic, because it splits the filename
 340 # in an odd way and depends on a terminating '/' to indicate directories.
 341 def pathsplit(p):
 342     """Split a path into a list of elements of the file system hierarchy."""
 343     l = p.split('/')
 344     l = [i+'/' for i in l[:-1]] + l[-1:]
 345     if l[-1] == '':
 346         l.pop()  # extra blank caused by terminating '/'
 347     return l
 348
 349
 350 class Writer:
 351     def __init__(self, filename):
 352         self.rootlevel = self.level = Level([], None)
 353         self.f = None
 354         self.count = 0
 355         self.lastfile = None
 356         self.filename = None
 357         self.filename = filename = realpath(filename)
 358         (dir,name) = os.path.split(filename)
 359         (ffd,self.tmpname) = tempfile.mkstemp('.tmp', filename, dir)
 360         self.f = os.fdopen(ffd, 'wb', 65536)
 361         self.f.write(INDEX_HDR)
 362
 363     def __del__(self):
 364         self.abort()
 365
 366     def abort(self):
 367         f = self.f
 368         self.f = None
 369         if f:
 370             f.close()
 371             os.unlink(self.tmpname)
 372
 373     def flush(self):
 374         if self.level:
 375             self.level = _golevel(self.level, self.f, [], None)
 376             self.count = self.rootlevel.count
 377             if self.count:
 378                 self.count += 1
 379             self.f.write(struct.pack(FOOTER_SIG, self.count))
 380             self.f.flush()
 381         assert(self.level == None)
 382
 383     def close(self):
 384         self.flush()
 385         f = self.f
 386         self.f = None
 387         if f:
 388             f.close()
 389             os.rename(self.tmpname, self.filename)
 390
 391     def _add(self, ename, entry):
 392         if self.lastfile and self.lastfile <= ename:
 393             raise Error('%r must come before %r'
 394                              % (''.join(e.name), ''.join(self.lastfile)))
 395             self.lastfile = e.name
 396         self.level = _golevel(self.level, self.f, ename, entry)
 397
 398     def add(self, name, st, hashgen = None):
 399         endswith = name.endswith('/')
 400         ename = pathsplit(name)
 401         basename = ename[-1]
 402         #log('add: %r %r\n' % (basename, name))
 403         flags = IX_EXISTS
 404         sha = None
 405         if hashgen:
 406             (gitmode, sha) = hashgen(name)
 407             flags |= IX_HASHVALID
 408         else:
 409             (gitmode, sha) = (0, EMPTY_SHA)
 410         if st:
 411             isdir = stat.S_ISDIR(st.st_mode)
 412             assert(isdir == endswith)
 413             e = NewEntry(basename, name, st.st_dev,
 414                          xstat.fstime_floor_secs(st.st_ctime),
 415                          xstat.fstime_floor_secs(st.st_mtime),
 416                          st.st_uid, st.st_gid,
 417                          st.st_size, st.st_mode, gitmode, sha, flags,
 418                          0, 0)
 419         else:
 420             assert(endswith)
 421             e = BlankNewEntry(basename)
 422             e.gitmode = gitmode
 423             e.sha = sha
 424             e.flags = flags
 425         self._add(ename, e)
 426
 427     def add_ixentry(self, e):
 428         e.children_ofs = e.children_n = 0
 429         self._add(pathsplit(e.name), e)
 430
 431     def new_reader(self):
 432         self.flush()
 433         return Reader(self.tmpname)
 434
 435
 436 def reduce_paths(paths):
 437     xpaths = []
 438     for p in paths:
 439         rp = realpath(p)
 440         try:
 441             st = os.lstat(rp)
 442             if stat.S_ISDIR(st.st_mode):
 443                 rp = slashappend(rp)
 444                 p = slashappend(p)
 445             xpaths.append((rp, p))
 446         except OSError, e:
 447             add_error('reduce_paths: %s' % e)
 448     xpaths.sort()
 449
 450     paths = []
 451     prev = None
 452     for (rp, p) in xpaths:
 453         if prev and (prev == rp
 454                      or (prev.endswith('/') and rp.startswith(prev))):
 455             continue # already superceded by previous path
 456         paths.append((rp, p))
 457         prev = rp
 458     paths.sort(reverse=True)
 459     return paths
 460
 461 def merge(*iters):
 462     def pfunc(count, total):
 463         qprogress('bup: merging indexes (%d/%d)\r' % (count, total))
 464     def pfinal(count, total):
 465         progress('bup: merging indexes (%d/%d), done.\n' % (count, total))
 466     return merge_iter(iters, 1024, pfunc, pfinal, key='name')