index.py

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