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