~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revfile.py

  • Committer: Martin Pool
  • Date: 2005-05-05 09:49:08 UTC
  • Revision ID: mbp@sourcefrog.net-20050505094908-d8b9f83c4379c8d7
- Slight optimization for Inventory.__getitem__

Show diffs side-by-side

added added

removed removed

Lines of Context:
52
52
is that sequence numbers are stable references.  But not every
53
53
repository in the world will assign the same sequence numbers,
54
54
therefore the SHA-1 is the only universally unique reference.
55
 
 
56
 
This is meant to scale to hold 100,000 revisions of a single file, by
57
 
which time the index file will be ~4.8MB and a bit big to read
58
 
sequentially.
59
 
 
60
 
Some of the reserved fields could be used to implement a (semi?)
61
 
balanced tree indexed by SHA1 so we can much more efficiently find the
62
 
index associated with a particular hash.  For 100,000 revs we would be
63
 
able to find it in about 17 random reads, which is not too bad.
64
 
 
65
 
This performs pretty well except when trying to calculate deltas of
66
 
really large files.  For that the main thing would be to plug in
67
 
something faster than difflib, which is after all pure Python.
68
 
Another approach is to just store the gzipped full text of big files,
69
 
though perhaps that's too perverse?
70
 
 
71
55
The iter method here will generally read through the whole index file
72
56
in one go.  With readahead in the kernel and python/libc (typically
73
57
128kB) this means that there should be no seeks and often only one
89
73
# if there are gaps and that can happen if we're interrupted while
90
74
# writing to the datafile.  Overlapping would be very bad though.
91
75
 
92
 
# TODO: Shouldn't need to lock if we always write in append mode and
93
 
# then ftell after writing to see where it went.  In any case we
94
 
# assume the whole branch is protected by a lock.
 
76
 
95
77
 
96
78
import sys, zlib, struct, mdiff, stat, os, sha
97
79
from binascii import hexlify, unhexlify
98
80
 
 
81
factor = 10
 
82
 
99
83
_RECORDSIZE = 48
100
84
 
101
85
_HEADER = "bzr revfile v1\n"
112
96
FL_GZIP = 1
113
97
 
114
98
# maximum number of patches in a row before recording a whole text.
115
 
CHAIN_LIMIT = 10
 
99
CHAIN_LIMIT = 50
116
100
 
117
101
 
118
102
class RevfileError(Exception):
121
105
class LimitHitException(Exception):
122
106
    pass
123
107
 
124
 
class Revfile(object):
 
108
class Revfile:
125
109
    def __init__(self, basename, mode):
126
110
        # TODO: Lock file  while open
127
111
 
149
133
            self.idxfile = open(idxname, 'w+b')
150
134
            self.datafile = open(dataname, 'w+b')
151
135
            
 
136
            print 'init empty file'
152
137
            self.idxfile.write(_HEADER)
153
138
            self.idxfile.flush()
154
139
        else:
242
227
        return self._add_compressed(text_sha, text, _NO_RECORD, compress)
243
228
 
244
229
 
245
 
    # NOT USED
246
 
    def _choose_base(self, seed, base):
247
 
        while seed & 3 == 3:
248
 
            if base == _NO_RECORD:
249
 
                return _NO_RECORD
250
 
            idxrec = self[base]
251
 
            if idxrec[I_BASE] == _NO_RECORD:
252
 
                return base
253
 
 
254
 
            base = idxrec[I_BASE]
255
 
            seed >>= 2
256
 
                
257
 
        return base        # relative to this full text
258
 
        
259
 
 
260
 
 
261
230
    def _add_delta(self, text, text_sha, base, compress):
262
231
        """Add a text stored relative to a previous text."""
263
232
        self._check_index(base)
264
 
 
 
233
        
265
234
        try:
266
 
            base_text = self.get(base, CHAIN_LIMIT)
 
235
            base_text = self.get(base, recursion_limit=CHAIN_LIMIT)
267
236
        except LimitHitException:
268
237
            return self._add_full_text(text, text_sha, compress)
269
238
        
270
239
        data = mdiff.bdiff(base_text, text)
271
 
 
272
 
 
273
 
        if True: # paranoid early check for bad diff
274
 
            result = mdiff.bpatch(base_text, data)
275
 
            assert result == text
276
 
            
277
240
        
278
241
        # If the delta is larger than the text, we might as well just
279
242
        # store the text.  (OK, the delta might be more compressible,
285
248
            return self._add_compressed(text_sha, data, base, compress)
286
249
 
287
250
 
288
 
    def add(self, text, base=None, compress=True):
 
251
    def add(self, text, base=_NO_RECORD, compress=True):
289
252
        """Add a new text to the revfile.
290
253
 
291
254
        If the text is already present them its existing id is
299
262
        only be used if it would be a size win and if the existing
300
263
        base is not at too long of a delta chain already.
301
264
        """
302
 
        if base == None:
303
 
            base = _NO_RECORD
304
 
        
305
265
        self._check_write()
306
266
        
307
267
        text_sha = sha.new(text).digest()
312
272
            # it's the same, in case someone ever breaks SHA-1.
313
273
            return idx                  # already present
314
274
        
315
 
        # base = self._choose_base(ord(text_sha[0]), base)
316
 
 
317
275
        if base == _NO_RECORD:
318
276
            return self._add_full_text(text, text_sha, compress)
319
277
        else:
338
296
            text = self._get_patched(idx, idxrec, recursion_limit)
339
297
 
340
298
        if sha.new(text).digest() != idxrec[I_SHA]:
341
 
            raise RevfileError("corrupt SHA-1 digest on record %d in %s"
342
 
                               % (idx, self.basename))
 
299
            raise RevfileError("corrupt SHA-1 digest on record %d"
 
300
                               % idx)
343
301
 
344
302
        return text
345
303
 
414
372
        self._seek_index(idx)
415
373
        idxrec = self._read_next_index()
416
374
        if idxrec == None:
417
 
            raise IndexError("no index %d" % idx)
 
375
            raise IndexError()
418
376
        else:
419
377
            return idxrec
420
378
 
430
388
        """Read back all index records.
431
389
 
432
390
        Do not seek the index file while this is underway!"""
433
 
        ## sys.stderr.write(" ** iter called ** \n")
 
391
        sys.stderr.write(" ** iter called ** \n")
434
392
        self._seek_index(0)
435
393
        while True:
436
394
            idxrec = self._read_next_index()
478
436
        for idx in range(len(self)):
479
437
            t += len(self.get(idx))
480
438
        return t
481
 
 
482
 
 
483
 
    def check(self, pb=None):
484
 
        """Extract every version and check its hash."""
485
 
        total = len(self)
486
 
        for i in range(total):
487
 
            if pb:
488
 
                pb.update("check revision", i, total)
489
 
            # the get method implicitly checks the SHA-1
490
 
            self.get(i)
491
 
        if pb:
492
 
            pb.clear()
493
439
        
494
440
 
495
441
 
496
442
def main(argv):
497
443
    try:
498
444
        cmd = argv[1]
499
 
        filename = argv[2]
500
445
    except IndexError:
501
 
        sys.stderr.write("usage: revfile dump REVFILE\n"
502
 
                         "       revfile add REVFILE < INPUT\n"
503
 
                         "       revfile add-delta REVFILE BASE < INPUT\n"
504
 
                         "       revfile add-series REVFILE BASE FILE...\n"
505
 
                         "       revfile get REVFILE IDX\n"
506
 
                         "       revfile find-sha REVFILE HEX\n"
507
 
                         "       revfile total-text-size REVFILE\n"
508
 
                         "       revfile last REVFILE\n")
 
446
        sys.stderr.write("usage: revfile dump\n"
 
447
                         "       revfile add\n"
 
448
                         "       revfile add-delta BASE\n"
 
449
                         "       revfile get IDX\n"
 
450
                         "       revfile find-sha HEX\n"
 
451
                         "       revfile total-text-size\n"
 
452
                         "       revfile last\n")
509
453
        return 1
510
454
 
511
 
    if filename.endswith('.drev') or filename.endswith('.irev'):
512
 
        filename = filename[:-5]
513
 
 
514
455
    def rw():
515
 
        return Revfile(filename, 'w')
 
456
        return Revfile('testrev', 'w')
516
457
 
517
458
    def ro():
518
 
        return Revfile(filename, 'r')
 
459
        return Revfile('testrev', 'r')
519
460
 
520
461
    if cmd == 'add':
521
462
        print rw().add(sys.stdin.read())
522
463
    elif cmd == 'add-delta':
523
 
        print rw().add(sys.stdin.read(), int(argv[3]))
524
 
    elif cmd == 'add-series':
525
 
        r = rw()
526
 
        rev = int(argv[3])
527
 
        for fn in argv[4:]:
528
 
            print rev
529
 
            rev = r.add(file(fn).read(), rev)
 
464
        print rw().add(sys.stdin.read(), int(argv[2]))
530
465
    elif cmd == 'dump':
531
466
        ro().dump()
532
467
    elif cmd == 'get':
533
468
        try:
534
 
            idx = int(argv[3])
 
469
            idx = int(argv[2])
535
470
        except IndexError:
536
 
            sys.stderr.write("usage: revfile get FILE IDX\n")
 
471
            sys.stderr.write("usage: revfile get IDX\n")
537
472
            return 1
538
473
 
539
 
        r = ro()
540
 
 
541
474
        if idx < 0 or idx >= len(r):
542
475
            sys.stderr.write("invalid index %r\n" % idx)
543
476
            return 1
544
477
 
545
 
        sys.stdout.write(r.get(idx))
 
478
        sys.stdout.write(ro().get(idx))
546
479
    elif cmd == 'find-sha':
547
480
        try:
548
 
            s = unhexlify(argv[3])
 
481
            s = unhexlify(argv[2])
549
482
        except IndexError:
550
 
            sys.stderr.write("usage: revfile find-sha FILE HEX\n")
 
483
            sys.stderr.write("usage: revfile find-sha HEX\n")
551
484
            return 1
552
485
 
553
486
        idx = ro().find_sha(s)
560
493
        print ro().total_text_size()
561
494
    elif cmd == 'last':
562
495
        print len(ro())-1
563
 
    elif cmd == 'check':
564
 
        import bzrlib.progress
565
 
        pb = bzrlib.progress.ProgressBar()
566
 
        ro().check(pb)
567
496
    else:
568
497
        sys.stderr.write("unknown command %r\n" % cmd)
569
498
        return 1