~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

Exclude more files from dumb-rsync upload

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?
55
24
 
56
25
# XXX: If we do weaves this way, will a merge still behave the same
57
26
# way if it's done in a different order?  That's a pretty desirable
74
43
 
75
44
# TODO: Parallel-extract that passes back each line along with a
76
45
# description of which revisions include it.  Nice for checking all
77
 
# shas in parallel.
 
46
# shas or calculating stats in parallel.
78
47
 
79
48
# TODO: Using a single _extract routine and then processing the output
80
49
# is probably inefficient.  It's simple enough that we can afford to
81
50
# have slight specializations for different ways its used: annotate,
82
51
# basis for add, get, etc.
83
52
 
84
 
# TODO: Perhaps the API should work only in names to hide the integer
85
 
# indexes from the user?
 
53
# TODO: Probably the API should work only in names to hide the integer
 
54
# indexes from the user.
86
55
 
87
56
# TODO: Is there any potential performance win by having an add()
88
57
# variant that is passed a pre-cooked version of the single basis
89
58
# version?
90
59
 
 
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.
91
68
 
92
69
 
93
70
import sha
94
71
from difflib import SequenceMatcher
95
72
 
96
 
 
97
 
 
98
 
 
99
 
class WeaveError(Exception):
100
 
    """Exception in processing weave"""
101
 
 
102
 
 
103
 
class WeaveFormatError(WeaveError):
104
 
    """Weave invariant violated"""
105
 
    
 
73
from bzrlib.trace import mutter
 
74
from bzrlib.errors import WeaveError, WeaveFormatError, WeaveParentMismatch, \
 
75
        WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent
 
76
from bzrlib.tsort import topo_sort
 
77
 
106
78
 
107
79
class Weave(object):
108
80
    """weave - versioned text file storage.
204
176
        self._name_map = {}
205
177
        self._weave_name = weave_name
206
178
 
 
179
    def __repr__(self):
 
180
        return "Weave(%r)" % self._weave_name
 
181
 
 
182
 
 
183
    def copy(self):
 
184
        """Return a deep copy of self.
 
185
        
 
186
        The copy can be modified without affecting the original weave."""
 
187
        other = Weave()
 
188
        other._weave = self._weave[:]
 
189
        other._parents = self._parents[:]
 
190
        other._sha1s = self._sha1s[:]
 
191
        other._names = self._names[:]
 
192
        other._name_map = self._name_map.copy()
 
193
        other._weave_name = self._weave_name
 
194
        return other
207
195
 
208
196
    def __eq__(self, other):
209
197
        if not isinstance(other, Weave):
216
204
    def __ne__(self, other):
217
205
        return not self.__eq__(other)
218
206
 
 
207
    def __contains__(self, name):
 
208
        return self._name_map.has_key(name)
219
209
 
220
210
    def maybe_lookup(self, name_or_index):
221
211
        """Convert possible symbolic name to index, or pass through indexes."""
230
220
        try:
231
221
            return self._name_map[name]
232
222
        except KeyError:
233
 
            raise WeaveError("name %r not present in weave %r" %
234
 
                             (name, self._weave_name))
235
 
 
 
223
            raise WeaveRevisionNotPresent(name, self)
 
224
 
 
225
    def names(self):
 
226
        return self._names[:]
 
227
 
 
228
    def iter_names(self):
 
229
        """Yield a list of all names in this weave."""
 
230
        return iter(self._names)
236
231
 
237
232
    def idx_to_name(self, version):
238
233
        return self._names[version]
239
234
 
240
 
 
241
235
    def _check_repeated_add(self, name, parents, text, sha1):
242
236
        """Check that a duplicated add is OK.
243
237
 
244
238
        If it is, return the (old) index; otherwise raise an exception.
245
239
        """
246
240
        idx = self.lookup(name)
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)            
 
241
        if sorted(self._parents[idx]) != sorted(parents) \
 
242
            or sha1 != self._sha1s[idx]:
 
243
            raise WeaveRevisionAlreadyPresent(name, self)
253
244
        return idx
254
245
        
255
 
 
256
 
        
257
246
    def add(self, name, parents, text, sha1=None):
258
247
        """Add a single text on top of the weave.
259
248
  
400
389
        return self._parents[version]
401
390
 
402
391
 
 
392
    def parent_names(self, version):
 
393
        """Return version names for parents of a version."""
 
394
        return map(self.idx_to_name, self._parents[self.lookup(version)])
 
395
 
 
396
 
403
397
    def minimal_parents(self, version):
404
398
        """Find the minimal set of parents for the version."""
405
399
        included = self._parents[version]
455
449
        for origin, lineno, text in self._extract(incls):
456
450
            yield origin, text
457
451
 
458
 
 
459
452
    def _walk(self):
460
453
        """Walk the weave.
461
454
 
483
476
                elif c == ']':
484
477
                    dset.remove(v)
485
478
                else:
486
 
                    raise WeaveFormatError('unexpected instruction %r'
487
 
                                           % v)
 
479
                    raise WeaveFormatError('unexpected instruction %r' % v)
488
480
            else:
489
481
                assert isinstance(l, basestring)
490
482
                assert istack
544
536
                if isactive:
545
537
                    result.append((istack[-1], lineno, l))
546
538
            lineno += 1
547
 
 
548
539
        if istack:
549
 
            raise WFE("unclosed insertion blocks at end of weave",
550
 
                                   istack)
 
540
            raise WeaveFormatError("unclosed insertion blocks "
 
541
                    "at end of weave: %s" % istack)
551
542
        if dset:
552
 
            raise WFE("unclosed deletion blocks at end of weave",
553
 
                                   dset)
554
 
 
 
543
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
 
544
                                   % dset)
555
545
        return result
556
 
    
557
546
 
558
547
 
559
548
    def get_iter(self, name_or_index):
643
632
        If there is a chunk of the file where there's no diagreement,
644
633
        only one alternative is given.
645
634
        """
646
 
 
647
635
        # approach: find the included versions common to all the
648
636
        # merged versions
649
637
        raise NotImplementedError()
669
657
        If line1=line2, this is a pure insert; if newlines=[] this is a
670
658
        pure delete.  (Similar to difflib.)
671
659
        """
672
 
 
 
660
        raise NotImplementedError()
673
661
 
674
662
            
675
663
    def plan_merge(self, ver_a, ver_b):
738
726
                elif lines_a == lines_b:
739
727
                    for l in lines_a: yield l
740
728
                else:
741
 
                    yield '<<<<\n'
 
729
                    yield '<<<<<<<\n'
742
730
                    for l in lines_a: yield l
743
 
                    yield '====\n'
 
731
                    yield '=======\n'
744
732
                    for l in lines_b: yield l
745
 
                    yield '>>>>\n'
 
733
                    yield '>>>>>>>\n'
746
734
 
747
735
                del lines_a[:]
748
736
                del lines_b[:]
769
757
                       state
770
758
 
771
759
                
772
 
 
773
 
 
774
 
 
 
760
    def join(self, other):
 
761
        """Integrate versions from other into this weave.
 
762
 
 
763
        The resulting weave contains all the history of both weaves; 
 
764
        any version you could retrieve from either self or other can be 
 
765
        retrieved from self after this call.
 
766
 
 
767
        It is illegal for the two weaves to contain different values 
 
768
        or different parents for any version.  See also reweave().
 
769
        """
 
770
        if other.numversions() == 0:
 
771
            return          # nothing to update, easy
 
772
        # two loops so that we do not change ourselves before verifying it
 
773
        # will be ok
 
774
        # work through in index order to make sure we get all dependencies
 
775
        for other_idx, name in enumerate(other._names):
 
776
            if self._check_version_consistent(other, other_idx, name):
 
777
                continue
 
778
        for other_idx, name in enumerate(other._names):
 
779
            # TODO: If all the parents of the other version are already 
 
780
            # present then we can avoid some work by just taking the delta
 
781
            # and adjusting the offsets.
 
782
            new_parents = self._imported_parents(other, other_idx)
 
783
            lines = other.get_lines(other_idx)
 
784
            sha1 = other._sha1s[other_idx]
 
785
            self.add(name, new_parents, lines, sha1)
 
786
 
 
787
 
 
788
    def _imported_parents(self, other, other_idx):
 
789
        """Return list of parents in self corresponding to indexes in other."""
 
790
        new_parents = []
 
791
        for parent_idx in other._parents[other_idx]:
 
792
            parent_name = other._names[parent_idx]
 
793
            if parent_name not in self._names:
 
794
                # should not be possible
 
795
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
796
                                 % (parent_name, other._name_map[other_idx], self))
 
797
            new_parents.append(self._name_map[parent_name])
 
798
        return new_parents
 
799
 
 
800
    def _check_version_consistent(self, other, other_idx, name):
 
801
        """Check if a version in consistent in this and other.
 
802
 
 
803
        To be consistent it must have:
 
804
 
 
805
         * the same text
 
806
         * the same direct parents (by name, not index, and disregarding
 
807
           order)
 
808
        
 
809
        If present & correct return True;
 
810
        if not present in self return False; 
 
811
        if inconsistent raise error."""
 
812
        this_idx = self._name_map.get(name, -1)
 
813
        if this_idx != -1:
 
814
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
815
                raise WeaveError("inconsistent texts for version {%s} "
 
816
                                 "when joining weaves"
 
817
                                 % (name))
 
818
            self_parents = self._parents[this_idx]
 
819
            other_parents = other._parents[other_idx]
 
820
            n1 = [self._names[i] for i in self_parents]
 
821
            n2 = [other._names[i] for i in other_parents]
 
822
            n1.sort()
 
823
            n2.sort()
 
824
            if n1 != n2:
 
825
                raise WeaveParentMismatch("inconsistent parents "
 
826
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
827
            else:
 
828
                return True         # ok!
 
829
        else:
 
830
            return False
 
831
 
 
832
    def reweave(self, other):
 
833
        """Reweave self with other."""
 
834
        new_weave = reweave(self, other)
 
835
        for attr in self.__slots__:
 
836
            setattr(self, attr, getattr(new_weave, attr))
 
837
 
 
838
 
 
839
def reweave(wa, wb):
 
840
    """Combine two weaves and return the result.
 
841
 
 
842
    This works even if a revision R has different parents in 
 
843
    wa and wb.  In the resulting weave all the parents are given.
 
844
 
 
845
    This is done by just building up a new weave, maintaining ordering 
 
846
    of the versions in the two inputs.  More efficient approaches
 
847
    might be possible but it should only be necessary to do 
 
848
    this operation rarely, when a new previously ghost version is 
 
849
    inserted.
 
850
    """
 
851
    wr = Weave()
 
852
    ia = ib = 0
 
853
    queue_a = range(wa.numversions())
 
854
    queue_b = range(wb.numversions())
 
855
    # first determine combined parents of all versions
 
856
    # map from version name -> all parent names
 
857
    combined_parents = _reweave_parent_graphs(wa, wb)
 
858
    mutter("combined parents: %r", combined_parents)
 
859
    order = topo_sort(combined_parents.iteritems())
 
860
    mutter("order to reweave: %r", order)
 
861
    for name in order:
 
862
        if name in wa._name_map:
 
863
            lines = wa.get_lines(name)
 
864
            if name in wb._name_map:
 
865
                assert lines == wb.get_lines(name)
 
866
        else:
 
867
            lines = wb.get_lines(name)
 
868
        wr.add(name, combined_parents[name], lines)
 
869
    return wr
 
870
 
 
871
 
 
872
def _reweave_parent_graphs(wa, wb):
 
873
    """Return combined parent ancestry for two weaves.
 
874
    
 
875
    Returned as a list of (version_name, set(parent_names))"""
 
876
    combined = {}
 
877
    for weave in [wa, wb]:
 
878
        for idx, name in enumerate(weave._names):
 
879
            p = combined.setdefault(name, set())
 
880
            p.update(map(weave.idx_to_name, weave._parents[idx]))
 
881
    return combined
775
882
 
776
883
 
777
884
def weave_toc(w):
800
907
    vers = len(w)
801
908
    for i in range(vers):
802
909
        pb.update('checking sizes', i, vers)
803
 
        for line in w.get_iter(i):
 
910
        for origin, lineno, line in w._extract([i]):
804
911
            total += len(line)
805
912
 
806
913
    pb.clear()