~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/versionedfile.py

  • Committer: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
 
2
#
 
3
# Authors:
 
4
#   Johan Rydberg <jrydberg@gnu.org>
2
5
#
3
6
# This program is free software; you can redistribute it and/or modify
4
7
# it under the terms of the GNU General Public License as published by
28
31
 
29
32
from bzrlib import (
30
33
    annotate,
31
 
    bencode,
32
34
    errors,
33
35
    graph as _mod_graph,
34
36
    groupcompress,
38
40
    multiparent,
39
41
    tsort,
40
42
    revision,
 
43
    ui,
41
44
    )
 
45
from bzrlib.graph import DictParentsProvider, Graph, StackedParentsProvider
 
46
from bzrlib.transport.memory import MemoryTransport
42
47
""")
 
48
from bzrlib.inter import InterObject
43
49
from bzrlib.registry import Registry
 
50
from bzrlib.symbol_versioning import *
44
51
from bzrlib.textmerge import TextMerge
 
52
from bzrlib import bencode
45
53
 
46
54
 
47
55
adapter_registry = Registry()
199
207
            yield record
200
208
 
201
209
 
202
 
class _MPDiffGenerator(object):
203
 
    """Pull out the functionality for generating mp_diffs."""
204
 
 
205
 
    def __init__(self, vf, keys):
206
 
        self.vf = vf
207
 
        # This is the order the keys were requested in
208
 
        self.ordered_keys = tuple(keys)
209
 
        # keys + their parents, what we need to compute the diffs
210
 
        self.needed_keys = ()
211
 
        # Map from key: mp_diff
212
 
        self.diffs = {}
213
 
        # Map from key: parents_needed (may have ghosts)
214
 
        self.parent_map = {}
215
 
        # Parents that aren't present
216
 
        self.ghost_parents = ()
217
 
        # Map from parent_key => number of children for this text
218
 
        self.refcounts = {}
219
 
        # Content chunks that are cached while we still need them
220
 
        self.chunks = {}
221
 
 
222
 
    def _find_needed_keys(self):
223
 
        """Find the set of keys we need to request.
224
 
 
225
 
        This includes all the original keys passed in, and the non-ghost
226
 
        parents of those keys.
227
 
 
228
 
        :return: (needed_keys, refcounts)
229
 
            needed_keys is the set of all texts we need to extract
230
 
            refcounts is a dict of {key: num_children} letting us know when we
231
 
                no longer need to cache a given parent text
232
 
        """
233
 
        # All the keys and their parents
234
 
        needed_keys = set(self.ordered_keys)
235
 
        parent_map = self.vf.get_parent_map(needed_keys)
236
 
        self.parent_map = parent_map
237
 
        # TODO: Should we be using a different construct here? I think this
238
 
        #       uses difference_update internally, and we expect the result to
239
 
        #       be tiny
240
 
        missing_keys = needed_keys.difference(parent_map)
241
 
        if missing_keys:
242
 
            raise errors.RevisionNotPresent(list(missing_keys)[0], self.vf)
243
 
        # Parents that might be missing. They are allowed to be ghosts, but we
244
 
        # should check for them
245
 
        refcounts = {}
246
 
        setdefault = refcounts.setdefault
247
 
        just_parents = set()
248
 
        for child_key, parent_keys in parent_map.iteritems():
249
 
            if not parent_keys:
250
 
                # parent_keys may be None if a given VersionedFile claims to
251
 
                # not support graph operations.
252
 
                continue
253
 
            just_parents.update(parent_keys)
254
 
            needed_keys.update(parent_keys)
255
 
            for p in parent_keys:
256
 
                refcounts[p] = setdefault(p, 0) + 1
257
 
        just_parents.difference_update(parent_map)
258
 
        # Remove any parents that are actually ghosts from the needed set
259
 
        self.present_parents = set(self.vf.get_parent_map(just_parents))
260
 
        self.ghost_parents = just_parents.difference(self.present_parents)
261
 
        needed_keys.difference_update(self.ghost_parents)
262
 
        self.needed_keys = needed_keys
263
 
        self.refcounts = refcounts
264
 
        return needed_keys, refcounts
265
 
 
266
 
    def _compute_diff(self, key, parent_lines, lines):
267
 
        """Compute a single mp_diff, and store it in self._diffs"""
268
 
        if len(parent_lines) > 0:
269
 
            # XXX: _extract_blocks is not usefully defined anywhere...
270
 
            #      It was meant to extract the left-parent diff without
271
 
            #      having to recompute it for Knit content (pack-0.92,
272
 
            #      etc). That seems to have regressed somewhere
273
 
            left_parent_blocks = self.vf._extract_blocks(key,
274
 
                parent_lines[0], lines)
275
 
        else:
276
 
            left_parent_blocks = None
277
 
        diff = multiparent.MultiParent.from_lines(lines,
278
 
                    parent_lines, left_parent_blocks)
279
 
        self.diffs[key] = diff
280
 
 
281
 
    def _process_one_record(self, key, this_chunks):
282
 
        parent_keys = None
283
 
        if key in self.parent_map:
284
 
            # This record should be ready to diff, since we requested
285
 
            # content in 'topological' order
286
 
            parent_keys = self.parent_map.pop(key)
287
 
            # If a VersionedFile claims 'no-graph' support, then it may return
288
 
            # None for any parent request, so we replace it with an empty tuple
289
 
            if parent_keys is None:
290
 
                parent_keys = ()
291
 
            parent_lines = []
292
 
            for p in parent_keys:
293
 
                # Alternatively we could check p not in self.needed_keys, but
294
 
                # ghost_parents should be tiny versus huge
295
 
                if p in self.ghost_parents:
296
 
                    continue
297
 
                refcount = self.refcounts[p]
298
 
                if refcount == 1: # Last child reference
299
 
                    self.refcounts.pop(p)
300
 
                    parent_chunks = self.chunks.pop(p)
301
 
                else:
302
 
                    self.refcounts[p] = refcount - 1
303
 
                    parent_chunks = self.chunks[p]
304
 
                p_lines = osutils.chunks_to_lines(parent_chunks)
305
 
                # TODO: Should we cache the line form? We did the
306
 
                #       computation to get it, but storing it this way will
307
 
                #       be less memory efficient...
308
 
                parent_lines.append(p_lines)
309
 
                del p_lines
310
 
            lines = osutils.chunks_to_lines(this_chunks)
311
 
            # Since we needed the lines, we'll go ahead and cache them this way
312
 
            this_chunks = lines
313
 
            self._compute_diff(key, parent_lines, lines)
314
 
            del lines
315
 
        # Is this content required for any more children?
316
 
        if key in self.refcounts:
317
 
            self.chunks[key] = this_chunks
318
 
 
319
 
    def _extract_diffs(self):
320
 
        needed_keys, refcounts = self._find_needed_keys()
321
 
        for record in self.vf.get_record_stream(needed_keys,
322
 
                                                'topological', True):
323
 
            if record.storage_kind == 'absent':
324
 
                raise errors.RevisionNotPresent(record.key, self.vf)
325
 
            self._process_one_record(record.key,
326
 
                                     record.get_bytes_as('chunked'))
327
 
        
328
 
    def compute_diffs(self):
329
 
        self._extract_diffs()
330
 
        dpop = self.diffs.pop
331
 
        return [dpop(k) for k in self.ordered_keys]
332
 
 
333
 
 
334
210
class VersionedFile(object):
335
211
    """Versioned text file storage.
336
212
 
473
349
 
474
350
    def make_mpdiffs(self, version_ids):
475
351
        """Create multiparent diffs for specified versions."""
476
 
        # XXX: Can't use _MPDiffGenerator just yet. This is because version_ids
477
 
        #      is a list of strings, not keys. And while self.get_record_stream
478
 
        #      is supported, it takes *keys*, while self.get_parent_map() takes
479
 
        #      strings... *sigh*
480
352
        knit_versions = set()
481
353
        knit_versions.update(version_ids)
482
354
        parent_map = self.get_parent_map(version_ids)
924
796
 
925
797
    The use of tuples allows a single code base to support several different
926
798
    uses with only the mapping logic changing from instance to instance.
927
 
 
928
 
    :ivar _immediate_fallback_vfs: For subclasses that support stacking,
929
 
        this is a list of other VersionedFiles immediately underneath this
930
 
        one.  They may in turn each have further fallbacks.
931
799
    """
932
800
 
933
801
    def add_lines(self, key, parents, lines, parent_texts=None,
972
840
    def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
973
841
        """Add a text to the store.
974
842
 
975
 
        This is a private function for use by VersionedFileCommitBuilder.
 
843
        This is a private function for use by CommitBuilder.
976
844
 
977
845
        :param key: The key tuple of the text to add. If the last element is
978
846
            None, a CHK string will be generated during the addition.
1180
1048
 
1181
1049
    def make_mpdiffs(self, keys):
1182
1050
        """Create multiparent diffs for specified keys."""
1183
 
        generator = _MPDiffGenerator(self, keys)
1184
 
        return generator.compute_diffs()
1185
 
 
1186
 
    def get_annotator(self):
1187
 
        return annotate.Annotator(self)
 
1051
        keys_order = tuple(keys)
 
1052
        keys = frozenset(keys)
 
1053
        knit_keys = set(keys)
 
1054
        parent_map = self.get_parent_map(keys)
 
1055
        for parent_keys in parent_map.itervalues():
 
1056
            if parent_keys:
 
1057
                knit_keys.update(parent_keys)
 
1058
        missing_keys = keys - set(parent_map)
 
1059
        if missing_keys:
 
1060
            raise errors.RevisionNotPresent(list(missing_keys)[0], self)
 
1061
        # We need to filter out ghosts, because we can't diff against them.
 
1062
        maybe_ghosts = knit_keys - keys
 
1063
        ghosts = maybe_ghosts - set(self.get_parent_map(maybe_ghosts))
 
1064
        knit_keys.difference_update(ghosts)
 
1065
        lines = {}
 
1066
        chunks_to_lines = osutils.chunks_to_lines
 
1067
        for record in self.get_record_stream(knit_keys, 'topological', True):
 
1068
            lines[record.key] = chunks_to_lines(record.get_bytes_as('chunked'))
 
1069
            # line_block_dict = {}
 
1070
            # for parent, blocks in record.extract_line_blocks():
 
1071
            #   line_blocks[parent] = blocks
 
1072
            # line_blocks[record.key] = line_block_dict
 
1073
        diffs = []
 
1074
        for key in keys_order:
 
1075
            target = lines[key]
 
1076
            parents = parent_map[key] or []
 
1077
            # Note that filtering knit_keys can lead to a parent difference
 
1078
            # between the creation and the application of the mpdiff.
 
1079
            parent_lines = [lines[p] for p in parents if p in knit_keys]
 
1080
            if len(parent_lines) > 0:
 
1081
                left_parent_blocks = self._extract_blocks(key, parent_lines[0],
 
1082
                    target)
 
1083
            else:
 
1084
                left_parent_blocks = None
 
1085
            diffs.append(multiparent.MultiParent.from_lines(target,
 
1086
                parent_lines, left_parent_blocks))
 
1087
        return diffs
1188
1088
 
1189
1089
    missing_keys = index._missing_keys_from_parent_map
1190
1090
 
1191
1091
    def _extract_blocks(self, version_id, source, target):
1192
1092
        return None
1193
1093
 
1194
 
    def _transitive_fallbacks(self):
1195
 
        """Return the whole stack of fallback versionedfiles.
1196
 
 
1197
 
        This VersionedFiles may have a list of fallbacks, but it doesn't
1198
 
        necessarily know about the whole stack going down, and it can't know
1199
 
        at open time because they may change after the objects are opened.
1200
 
        """
1201
 
        all_fallbacks = []
1202
 
        for a_vfs in self._immediate_fallback_vfs:
1203
 
            all_fallbacks.append(a_vfs)
1204
 
            all_fallbacks.extend(a_vfs._transitive_fallbacks())
1205
 
        return all_fallbacks
1206
 
 
1207
1094
 
1208
1095
class ThunkedVersionedFiles(VersionedFiles):
1209
1096
    """Storage for many versioned files thunked onto a 'VersionedFile' class.
1273
1160
            result.append((prefix + (origin,), line))
1274
1161
        return result
1275
1162
 
 
1163
    def get_annotator(self):
 
1164
        return annotate.Annotator(self)
 
1165
 
1276
1166
    def check(self, progress_bar=None, keys=None):
1277
1167
        """See VersionedFiles.check()."""
1278
1168
        # XXX: This is over-enthusiastic but as we only thunk for Weaves today
1422
1312
        return result
1423
1313
 
1424
1314
 
1425
 
class VersionedFilesWithFallbacks(VersionedFiles):
1426
 
 
1427
 
    def without_fallbacks(self):
1428
 
        """Return a clone of this object without any fallbacks configured."""
1429
 
        raise NotImplementedError(self.without_fallbacks)
1430
 
 
1431
 
    def add_fallback_versioned_files(self, a_versioned_files):
1432
 
        """Add a source of texts for texts not present in this knit.
1433
 
 
1434
 
        :param a_versioned_files: A VersionedFiles object.
1435
 
        """
1436
 
        raise NotImplementedError(self.add_fallback_versioned_files)
1437
 
 
1438
 
 
1439
1315
class _PlanMergeVersionedFile(VersionedFiles):
1440
1316
    """A VersionedFile for uncommitted and committed texts.
1441
1317
 
1462
1338
        # line data for locally held keys.
1463
1339
        self._lines = {}
1464
1340
        # key lookup providers
1465
 
        self._providers = [_mod_graph.DictParentsProvider(self._parents)]
 
1341
        self._providers = [DictParentsProvider(self._parents)]
1466
1342
 
1467
1343
    def plan_merge(self, ver_a, ver_b, base=None):
1468
1344
        """See VersionedFile.plan_merge"""
1475
1351
 
1476
1352
    def plan_lca_merge(self, ver_a, ver_b, base=None):
1477
1353
        from bzrlib.merge import _PlanLCAMerge
1478
 
        graph = _mod_graph.Graph(self)
 
1354
        graph = Graph(self)
1479
1355
        new_plan = _PlanLCAMerge(ver_a, ver_b, self, (self._file_id,), graph).plan_merge()
1480
1356
        if base is None:
1481
1357
            return new_plan
1533
1409
            result[revision.NULL_REVISION] = ()
1534
1410
        self._providers = self._providers[:1] + self.fallback_versionedfiles
1535
1411
        result.update(
1536
 
            _mod_graph.StackedParentsProvider(
1537
 
                self._providers).get_parent_map(keys))
 
1412
            StackedParentsProvider(self._providers).get_parent_map(keys))
1538
1413
        for key, parents in result.iteritems():
1539
1414
            if parents == ():
1540
1415
                result[key] = (revision.NULL_REVISION,)
1750
1625
                yield (l, key)
1751
1626
 
1752
1627
 
1753
 
class NoDupeAddLinesDecorator(object):
1754
 
    """Decorator for a VersionedFiles that skips doing an add_lines if the key
1755
 
    is already present.
1756
 
    """
1757
 
 
1758
 
    def __init__(self, store):
1759
 
        self._store = store
1760
 
 
1761
 
    def add_lines(self, key, parents, lines, parent_texts=None,
1762
 
            left_matching_blocks=None, nostore_sha=None, random_id=False,
1763
 
            check_content=True):
1764
 
        """See VersionedFiles.add_lines.
1765
 
        
1766
 
        This implementation may return None as the third element of the return
1767
 
        value when the original store wouldn't.
1768
 
        """
1769
 
        if nostore_sha:
1770
 
            raise NotImplementedError(
1771
 
                "NoDupeAddLinesDecorator.add_lines does not implement the "
1772
 
                "nostore_sha behaviour.")
1773
 
        if key[-1] is None:
1774
 
            sha1 = osutils.sha_strings(lines)
1775
 
            key = ("sha1:" + sha1,)
1776
 
        else:
1777
 
            sha1 = None
1778
 
        if key in self._store.get_parent_map([key]):
1779
 
            # This key has already been inserted, so don't do it again.
1780
 
            if sha1 is None:
1781
 
                sha1 = osutils.sha_strings(lines)
1782
 
            return sha1, sum(map(len, lines)), None
1783
 
        return self._store.add_lines(key, parents, lines,
1784
 
                parent_texts=parent_texts,
1785
 
                left_matching_blocks=left_matching_blocks,
1786
 
                nostore_sha=nostore_sha, random_id=random_id,
1787
 
                check_content=check_content)
1788
 
 
1789
 
    def __getattr__(self, name):
1790
 
        return getattr(self._store, name)
1791
 
 
1792
 
 
1793
1628
def network_bytes_to_kind_and_offset(network_bytes):
1794
1629
    """Strip of a record kind from the front of network_bytes.
1795
1630
 
1886
1721
    for prefix in sorted(per_prefix_map):
1887
1722
        present_keys.extend(reversed(tsort.topo_sort(per_prefix_map[prefix])))
1888
1723
    return present_keys
1889
 
 
1890
 
 
1891
 
class _KeyRefs(object):
1892
 
 
1893
 
    def __init__(self, track_new_keys=False):
1894
 
        # dict mapping 'key' to 'set of keys referring to that key'
1895
 
        self.refs = {}
1896
 
        if track_new_keys:
1897
 
            # set remembering all new keys
1898
 
            self.new_keys = set()
1899
 
        else:
1900
 
            self.new_keys = None
1901
 
 
1902
 
    def clear(self):
1903
 
        if self.refs:
1904
 
            self.refs.clear()
1905
 
        if self.new_keys:
1906
 
            self.new_keys.clear()
1907
 
 
1908
 
    def add_references(self, key, refs):
1909
 
        # Record the new references
1910
 
        for referenced in refs:
1911
 
            try:
1912
 
                needed_by = self.refs[referenced]
1913
 
            except KeyError:
1914
 
                needed_by = self.refs[referenced] = set()
1915
 
            needed_by.add(key)
1916
 
        # Discard references satisfied by the new key
1917
 
        self.add_key(key)
1918
 
 
1919
 
    def get_new_keys(self):
1920
 
        return self.new_keys
1921
 
    
1922
 
    def get_unsatisfied_refs(self):
1923
 
        return self.refs.iterkeys()
1924
 
 
1925
 
    def _satisfy_refs_for_key(self, key):
1926
 
        try:
1927
 
            del self.refs[key]
1928
 
        except KeyError:
1929
 
            # No keys depended on this key.  That's ok.
1930
 
            pass
1931
 
 
1932
 
    def add_key(self, key):
1933
 
        # satisfy refs for key, and remember that we've seen this key.
1934
 
        self._satisfy_refs_for_key(key)
1935
 
        if self.new_keys is not None:
1936
 
            self.new_keys.add(key)
1937
 
 
1938
 
    def satisfy_refs_for_keys(self, keys):
1939
 
        for key in keys:
1940
 
            self._satisfy_refs_for_key(key)
1941
 
 
1942
 
    def get_referrers(self):
1943
 
        result = set()
1944
 
        for referrers in self.refs.itervalues():
1945
 
            result.update(referrers)
1946
 
        return result
1947
 
 
1948
 
 
1949