~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Aaron Bentley
  • Date: 2005-10-03 16:53:39 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1419.
  • Revision ID: abentley@panoramicfeedback.com-20051003165339-9ee4d484477fd164
Ignored user-installed plugins

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
 
22
22
"""Weave - storage of related text file versions"""
23
23
 
 
24
# before intset (r923) 2000 versions in 41.5s
 
25
# with intset (r926) 2000 versions in 93s !!!
 
26
# better to just use plain sets.
 
27
 
 
28
# making _extract build and return a list, rather than being a generator
 
29
# takes 37.94s
 
30
 
 
31
# with python -O, r923 does 2000 versions in 36.87s
 
32
 
 
33
# with optimizations to avoid mutating lists - 35.75!  I guess copying
 
34
# all the elements every time costs more than the small manipulations.
 
35
# a surprisingly small change.
 
36
 
 
37
# r931, which avoids using a generator for extract, does 36.98s
 
38
 
 
39
# with memoized inclusions, takes 41.49s; not very good
 
40
 
 
41
# with slots, takes 37.35s; without takes 39.16, a bit surprising
 
42
 
 
43
# with the delta calculation mixed in with the add method, rather than
 
44
# separated, takes 36.78s
 
45
 
 
46
# with delta folded in and mutation of the list, 36.13s
 
47
 
 
48
# with all this and simplification of add code, 33s
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
# TODO: Perhaps have copy method for Weave instances?
24
55
 
25
56
# XXX: If we do weaves this way, will a merge still behave the same
26
57
# way if it's done in a different order?  That's a pretty desirable
43
74
 
44
75
# TODO: Parallel-extract that passes back each line along with a
45
76
# description of which revisions include it.  Nice for checking all
46
 
# shas or calculating stats in parallel.
 
77
# shas in parallel.
47
78
 
48
79
# TODO: Using a single _extract routine and then processing the output
49
80
# is probably inefficient.  It's simple enough that we can afford to
50
81
# have slight specializations for different ways its used: annotate,
51
82
# basis for add, get, etc.
52
83
 
53
 
# TODO: Probably the API should work only in names to hide the integer
54
 
# indexes from the user.
 
84
# TODO: Perhaps the API should work only in names to hide the integer
 
85
# indexes from the user?
55
86
 
56
87
# TODO: Is there any potential performance win by having an add()
57
88
# variant that is passed a pre-cooked version of the single basis
58
89
# version?
59
90
 
60
 
# TODO: Reweave can possibly be made faster by remembering diffs
61
 
# where the basis and destination are unchanged.
62
 
 
63
 
# FIXME: Sometimes we will be given a parents list for a revision
64
 
# that includes some redundant parents (i.e. already a parent of 
65
 
# something in the list.)  We should eliminate them.  This can 
66
 
# be done fairly efficiently because the sequence numbers constrain
67
 
# the possible relationships.
68
 
 
69
 
 
70
 
import os
 
91
 
 
92
 
71
93
import sha
72
94
from difflib import SequenceMatcher
73
95
 
74
 
from bzrlib.trace import mutter
75
 
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
76
 
        WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent)
77
 
import bzrlib.errors as errors
78
 
from bzrlib.tsort import topo_sort
79
 
 
 
96
 
 
97
 
 
98
 
 
99
class WeaveError(Exception):
 
100
    """Exception in processing weave"""
 
101
 
 
102
 
 
103
class WeaveFormatError(WeaveError):
 
104
    """Weave invariant violated"""
 
105
    
80
106
 
81
107
class Weave(object):
82
108
    """weave - versioned text file storage.
178
204
        self._name_map = {}
179
205
        self._weave_name = weave_name
180
206
 
181
 
    def __repr__(self):
182
 
        return "Weave(%r)" % self._weave_name
183
 
 
184
 
 
185
 
    def copy(self):
186
 
        """Return a deep copy of self.
187
 
        
188
 
        The copy can be modified without affecting the original weave."""
189
 
        other = Weave()
190
 
        other._weave = self._weave[:]
191
 
        other._parents = self._parents[:]
192
 
        other._sha1s = self._sha1s[:]
193
 
        other._names = self._names[:]
194
 
        other._name_map = self._name_map.copy()
195
 
        other._weave_name = self._weave_name
196
 
        return other
197
207
 
198
208
    def __eq__(self, other):
199
209
        if not isinstance(other, Weave):
206
216
    def __ne__(self, other):
207
217
        return not self.__eq__(other)
208
218
 
209
 
    def __contains__(self, name):
210
 
        return self._name_map.has_key(name)
211
219
 
212
220
    def maybe_lookup(self, name_or_index):
213
221
        """Convert possible symbolic name to index, or pass through indexes."""
222
230
        try:
223
231
            return self._name_map[name]
224
232
        except KeyError:
225
 
            raise WeaveRevisionNotPresent(name, self)
226
 
 
227
 
    def names(self):
228
 
        return self._names[:]
229
 
 
230
 
    def iter_names(self):
231
 
        """Yield a list of all names in this weave."""
232
 
        return iter(self._names)
 
233
            raise WeaveError("name %r not present in weave %r" %
 
234
                             (name, self._weave_name))
 
235
 
233
236
 
234
237
    def idx_to_name(self, version):
235
238
        return self._names[version]
236
239
 
 
240
 
237
241
    def _check_repeated_add(self, name, parents, text, sha1):
238
242
        """Check that a duplicated add is OK.
239
243
 
240
244
        If it is, return the (old) index; otherwise raise an exception.
241
245
        """
242
246
        idx = self.lookup(name)
243
 
        if sorted(self._parents[idx]) != sorted(parents) \
244
 
            or sha1 != self._sha1s[idx]:
245
 
            raise WeaveRevisionAlreadyPresent(name, self)
 
247
        if sorted(self._parents[idx]) != sorted(parents):
 
248
            raise WeaveError("name \"%s\" already present in weave "
 
249
                             "with different parents" % name)
 
250
        if sha1 != self._sha1s[idx]:
 
251
            raise WeaveError("name \"%s\" already present in weave "
 
252
                             "with different text" % name)            
246
253
        return idx
247
254
        
 
255
 
 
256
        
248
257
    def add(self, name, parents, text, sha1=None):
249
258
        """Add a single text on top of the weave.
250
259
  
370
379
 
371
380
        return new_version
372
381
 
373
 
    def add_identical(self, old_rev_id, new_rev_id, parents):
374
 
        """Add an identical text to old_rev_id as new_rev_id."""
375
 
        old_lines = self.get(self.lookup(old_rev_id))
376
 
        self.add(new_rev_id, parents, old_lines)
377
382
 
378
383
    def inclusions(self, versions):
379
384
        """Return set of all ancestors of given version(s)."""
391
396
        return self._parents[version]
392
397
 
393
398
 
394
 
    def parent_names(self, version):
395
 
        """Return version names for parents of a version."""
396
 
        return map(self.idx_to_name, self._parents[self.lookup(version)])
397
 
 
398
 
 
399
399
    def minimal_parents(self, version):
400
400
        """Find the minimal set of parents for the version."""
401
401
        included = self._parents[version]
451
451
        for origin, lineno, text in self._extract(incls):
452
452
            yield origin, text
453
453
 
 
454
 
454
455
    def _walk(self):
455
456
        """Walk the weave.
456
457
 
478
479
                elif c == ']':
479
480
                    dset.remove(v)
480
481
                else:
481
 
                    raise WeaveFormatError('unexpected instruction %r' % v)
 
482
                    raise WeaveFormatError('unexpected instruction %r'
 
483
                                           % v)
482
484
            else:
483
485
                assert isinstance(l, basestring)
484
486
                assert istack
485
487
                yield lineno, istack[-1], dset, l
486
488
            lineno += 1
487
489
 
488
 
        if istack:
489
 
            raise WeaveFormatError("unclosed insertion blocks "
490
 
                    "at end of weave: %s" % istack)
491
 
        if dset:
492
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
493
 
                                   % dset)
 
490
 
494
491
 
495
492
    def _extract(self, versions):
496
493
        """Yield annotation of lines in included set.
543
540
                if isactive:
544
541
                    result.append((istack[-1], lineno, l))
545
542
            lineno += 1
 
543
 
546
544
        if istack:
547
 
            raise WeaveFormatError("unclosed insertion blocks "
548
 
                    "at end of weave: %s" % istack)
 
545
            raise WFE("unclosed insertion blocks at end of weave",
 
546
                                   istack)
549
547
        if dset:
550
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
551
 
                                   % dset)
 
548
            raise WFE("unclosed deletion blocks at end of weave",
 
549
                                   dset)
 
550
 
552
551
        return result
 
552
    
553
553
 
554
554
 
555
555
    def get_iter(self, name_or_index):
556
556
        """Yield lines for the specified version."""
557
557
        incls = [self.maybe_lookup(name_or_index)]
558
 
        if len(incls) == 1:
559
 
            index = incls[0]
560
 
            cur_sha = sha.new()
561
 
        else:
562
 
            # We don't have sha1 sums for multiple entries
563
 
            cur_sha = None
564
558
        for origin, lineno, line in self._extract(incls):
565
 
            if cur_sha:
566
 
                cur_sha.update(line)
567
559
            yield line
568
 
        if cur_sha:
569
 
            expected_sha1 = self._sha1s[index]
570
 
            measured_sha1 = cur_sha.hexdigest() 
571
 
            if measured_sha1 != expected_sha1:
572
 
                raise errors.WeaveInvalidChecksum(
573
 
                        'file %s, revision %s, expected: %s, measured %s' 
574
 
                        % (self._weave_name, self._names[index],
575
 
                           expected_sha1, measured_sha1))
576
560
 
577
561
 
578
562
    def get_text(self, name_or_index):
587
571
    get = get_lines
588
572
 
589
573
 
590
 
    def get_sha1(self, name):
591
 
        """Get the stored sha1 sum for the given revision.
592
 
        
593
 
        :param name: The name of the version to lookup
594
 
        """
595
 
        return self._sha1s[self.lookup(name)]
596
 
 
597
574
    def mash_iter(self, included):
598
575
        """Return composed version of multiple included versions."""
599
576
        included = map(self.maybe_lookup, included)
619
596
    def __len__(self):
620
597
        return self.numversions()
621
598
 
 
599
 
622
600
    def check(self, progress_bar=None):
623
601
        # check no circular inclusions
624
602
        for version in range(self.numversions()):
629
607
                    raise WeaveFormatError("invalid included version %d for index %d"
630
608
                                           % (inclusions[-1], version))
631
609
 
632
 
        # try extracting all versions; parallel extraction is used
 
610
        # try extracting all versions; this is a bit slow and parallel
 
611
        # extraction could be used
633
612
        nv = self.numversions()
634
 
        sha1s = [sha.new() for i in range(nv)]
635
 
        texts = [[] for i in range(nv)]
636
 
        inclusions = []
637
 
        for i in range(nv):
638
 
            # For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
639
 
            # The problem is that set membership is much more expensive
640
 
            new_inc = set([i])
641
 
            for p in self._parents[i]:
642
 
                new_inc.update(inclusions[p])
643
 
 
644
 
            #assert set(new_inc) == self.inclusions([i]), 'failed %s != %s' % (new_inc, self.inclusions([i]))
645
 
            inclusions.append(new_inc)
646
 
 
647
 
        nlines = len(self._weave)
648
 
 
649
 
        update_text = 'checking weave'
650
 
        if self._weave_name:
651
 
            short_name = os.path.basename(self._weave_name)
652
 
            update_text = 'checking %s' % (short_name,)
653
 
            update_text = update_text[:25]
654
 
 
655
 
        for lineno, insert, deleteset, line in self._walk():
 
613
        for version in range(nv):
656
614
            if progress_bar:
657
 
                progress_bar.update(update_text, lineno, nlines)
658
 
 
659
 
            for j, j_inc in enumerate(inclusions):
660
 
                # The active inclusion must be an ancestor,
661
 
                # and no ancestors must have deleted this line,
662
 
                # because we don't support resurrection.
663
 
                if (insert in j_inc) and not (deleteset & j_inc):
664
 
                    sha1s[j].update(line)
665
 
 
666
 
        for version in range(nv):
667
 
            hd = sha1s[version].hexdigest()
 
615
                progress_bar.update('checking text', version, nv)
 
616
            s = sha.new()
 
617
            for l in self.get_iter(version):
 
618
                s.update(l)
 
619
            hd = s.hexdigest()
668
620
            expected = self._sha1s[version]
669
621
            if hd != expected:
670
 
                raise errors.WeaveInvalidChecksum(
671
 
                        "mismatched sha1 for version %s: "
672
 
                        "got %s, expected %s"
673
 
                        % (self._names[version], hd, expected))
 
622
                raise WeaveError("mismatched sha1 for version %d; "
 
623
                                 "got %s, expected %s"
 
624
                                 % (version, hd, expected))
674
625
 
675
626
        # TODO: check insertions are properly nested, that there are
676
627
        # no lines outside of insertion blocks, that deletions are
677
628
        # properly paired, etc.
678
629
 
 
630
 
 
631
 
 
632
    def merge(self, merge_versions):
 
633
        """Automerge and mark conflicts between versions.
 
634
 
 
635
        This returns a sequence, each entry describing alternatives
 
636
        for a chunk of the file.  Each of the alternatives is given as
 
637
        a list of lines.
 
638
 
 
639
        If there is a chunk of the file where there's no diagreement,
 
640
        only one alternative is given.
 
641
        """
 
642
 
 
643
        # approach: find the included versions common to all the
 
644
        # merged versions
 
645
        raise NotImplementedError()
 
646
 
 
647
 
 
648
 
679
649
    def _delta(self, included, lines):
680
650
        """Return changes from basis to new revision.
681
651
 
695
665
        If line1=line2, this is a pure insert; if newlines=[] this is a
696
666
        pure delete.  (Similar to difflib.)
697
667
        """
698
 
        raise NotImplementedError()
 
668
 
699
669
 
700
670
            
701
671
    def plan_merge(self, ver_a, ver_b):
750
720
        lines_a = []
751
721
        lines_b = []
752
722
        ch_a = ch_b = False
753
 
        # TODO: Return a structured form of the conflicts (e.g. 2-tuples for
754
 
        # conflicted regions), rather than just inserting the markers.
755
 
        # 
756
 
        # TODO: Show some version information (e.g. author, date) on 
757
 
        # conflicted regions.
 
723
 
758
724
        for state, line in plan:
759
725
            if state == 'unchanged' or state == 'killed-both':
760
726
                # resync and flush queued conflicts changes if any
768
734
                elif lines_a == lines_b:
769
735
                    for l in lines_a: yield l
770
736
                else:
771
 
                    yield '<<<<<<<\n'
 
737
                    yield '<<<<\n'
772
738
                    for l in lines_a: yield l
773
 
                    yield '=======\n'
 
739
                    yield '====\n'
774
740
                    for l in lines_b: yield l
775
 
                    yield '>>>>>>>\n'
 
741
                    yield '>>>>\n'
776
742
 
777
743
                del lines_a[:]
778
744
                del lines_b[:]
798
764
                                 'killed-both'), \
799
765
                       state
800
766
 
801
 
 
802
 
    def join(self, other):
803
 
        import sys, time
804
 
        """Integrate versions from other into this weave.
805
 
 
806
 
        The resulting weave contains all the history of both weaves; 
807
 
        any version you could retrieve from either self or other can be 
808
 
        retrieved from self after this call.
809
 
 
810
 
        It is illegal for the two weaves to contain different values 
811
 
        or different parents for any version.  See also reweave().
812
 
        """
813
 
        if other.numversions() == 0:
814
 
            return          # nothing to update, easy
815
 
        # two loops so that we do not change ourselves before verifying it
816
 
        # will be ok
817
 
        # work through in index order to make sure we get all dependencies
818
 
        for other_idx, name in enumerate(other._names):
819
 
            self._check_version_consistent(other, other_idx, name)
820
 
 
821
 
        merged = 0
822
 
        processed = 0
823
 
        time0 = time.time( )
824
 
        for other_idx, name in enumerate(other._names):
825
 
            # TODO: If all the parents of the other version are already
826
 
            # present then we can avoid some work by just taking the delta
827
 
            # and adjusting the offsets.
828
 
            new_parents = self._imported_parents(other, other_idx)
829
 
            sha1 = other._sha1s[other_idx]
830
 
 
831
 
            processed += 1
832
 
           
833
 
            if name in self._names:
834
 
                idx = self.lookup(name)
835
 
                n1 = map(other.idx_to_name, other._parents[other_idx] )
836
 
                n2 = map(self.idx_to_name, self._parents[other_idx] )
837
 
                if sha1 ==  self._sha1s[idx] and n1 == n2:
838
 
                        continue
839
 
 
840
 
            merged += 1
841
 
            lines = other.get_lines(other_idx)
842
 
            self.add(name, new_parents, lines, sha1)
843
 
 
844
 
        mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
845
 
                merged,processed,self._weave_name, time.time( )-time0))
846
 
 
847
 
 
848
 
 
849
 
 
850
 
    def _imported_parents(self, other, other_idx):
851
 
        """Return list of parents in self corresponding to indexes in other."""
852
 
        new_parents = []
853
 
        for parent_idx in other._parents[other_idx]:
854
 
            parent_name = other._names[parent_idx]
855
 
            if parent_name not in self._names:
856
 
                # should not be possible
857
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
858
 
                                 % (parent_name, other._name_map[other_idx], self))
859
 
            new_parents.append(self._name_map[parent_name])
860
 
        return new_parents
861
 
 
862
 
    def _check_version_consistent(self, other, other_idx, name):
863
 
        """Check if a version in consistent in this and other.
864
 
 
865
 
        To be consistent it must have:
866
 
 
867
 
         * the same text
868
 
         * the same direct parents (by name, not index, and disregarding
869
 
           order)
870
 
        
871
 
        If present & correct return True;
872
 
        if not present in self return False; 
873
 
        if inconsistent raise error."""
874
 
        this_idx = self._name_map.get(name, -1)
875
 
        if this_idx != -1:
876
 
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
877
 
                raise WeaveError("inconsistent texts for version {%s} "
878
 
                                 "when joining weaves"
879
 
                                 % (name))
880
 
            self_parents = self._parents[this_idx]
881
 
            other_parents = other._parents[other_idx]
882
 
            n1 = [self._names[i] for i in self_parents]
883
 
            n2 = [other._names[i] for i in other_parents]
884
 
            n1.sort()
885
 
            n2.sort()
886
 
            if n1 != n2:
887
 
                raise WeaveParentMismatch("inconsistent parents "
888
 
                    "for version {%s}: %s vs %s" % (name, n1, n2))
889
 
            else:
890
 
                return True         # ok!
891
 
        else:
892
 
            return False
893
 
 
894
 
    def reweave(self, other):
895
 
        """Reweave self with other."""
896
 
        new_weave = reweave(self, other)
897
 
        for attr in self.__slots__:
898
 
            setattr(self, attr, getattr(new_weave, attr))
899
 
 
900
 
 
901
 
def reweave(wa, wb):
902
 
    """Combine two weaves and return the result.
903
 
 
904
 
    This works even if a revision R has different parents in 
905
 
    wa and wb.  In the resulting weave all the parents are given.
906
 
 
907
 
    This is done by just building up a new weave, maintaining ordering 
908
 
    of the versions in the two inputs.  More efficient approaches
909
 
    might be possible but it should only be necessary to do 
910
 
    this operation rarely, when a new previously ghost version is 
911
 
    inserted.
912
 
    """
913
 
    wr = Weave()
914
 
    ia = ib = 0
915
 
    queue_a = range(wa.numversions())
916
 
    queue_b = range(wb.numversions())
917
 
    # first determine combined parents of all versions
918
 
    # map from version name -> all parent names
919
 
    combined_parents = _reweave_parent_graphs(wa, wb)
920
 
    mutter("combined parents: %r", combined_parents)
921
 
    order = topo_sort(combined_parents.iteritems())
922
 
    mutter("order to reweave: %r", order)
923
 
    for name in order:
924
 
        if name in wa._name_map:
925
 
            lines = wa.get_lines(name)
926
 
            if name in wb._name_map:
927
 
                assert lines == wb.get_lines(name)
928
 
        else:
929
 
            lines = wb.get_lines(name)
930
 
        wr.add(name, combined_parents[name], lines)
931
 
    return wr
932
 
 
933
 
 
934
 
def _reweave_parent_graphs(wa, wb):
935
 
    """Return combined parent ancestry for two weaves.
936
 
    
937
 
    Returned as a list of (version_name, set(parent_names))"""
938
 
    combined = {}
939
 
    for weave in [wa, wb]:
940
 
        for idx, name in enumerate(weave._names):
941
 
            p = combined.setdefault(name, set())
942
 
            p.update(map(weave.idx_to_name, weave._parents[idx]))
943
 
    return combined
 
767
                
 
768
 
 
769
 
 
770
 
944
771
 
945
772
 
946
773
def weave_toc(w):
969
796
    vers = len(w)
970
797
    for i in range(vers):
971
798
        pb.update('checking sizes', i, vers)
972
 
        for origin, lineno, line in w._extract([i]):
 
799
        for line in w.get_iter(i):
973
800
            total += len(line)
974
801
 
975
802
    pb.clear()
1189
1016
    return ret
1190
1017
 
1191
1018
 
1192
 
def lsprofile_main(argv): 
1193
 
    from bzrlib.lsprof import profile
1194
 
    ret,stats = profile(main, argv)
1195
 
    stats.sort()
1196
 
    stats.pprint()
1197
 
    return ret
1198
 
 
1199
 
 
1200
1019
if __name__ == '__main__':
1201
1020
    import sys
1202
1021
    if '--profile' in sys.argv:
1203
1022
        args = sys.argv[:]
1204
1023
        args.remove('--profile')
1205
1024
        sys.exit(profile_main(args))
1206
 
    elif '--lsprof' in sys.argv:
1207
 
        args = sys.argv[:]
1208
 
        args.remove('--lsprof')
1209
 
        sys.exit(lsprofile_main(args))
1210
1025
    else:
1211
1026
        sys.exit(main(sys.argv))
1212
1027