← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/knit.py

  • Committer: Andrew Bennetts
  • Date: 2009-03-04 07:10:07 UTC
  • mto: (4086.1.2 hpss-integration)
  • mto: This revision was merged to the branch mainline in revision 4087.
  • Revision ID: andrew.bennetts@canonical.com-20090304071007-8iqoi1m44ypmzg2a
Rough prototype of allowing a SearchResult to be passed to fetch, and using that to improve network conversations.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/knit.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Knit versionedfile implementation.
18
18
 
53
53
 
54
54
 
55
55
from cStringIO import StringIO
56
 
from itertools import izip
 
56
from itertools import izip, chain
57
57
import operator
58
58
import os
59
59
import sys
68
68
    index as _mod_index,
69
69
    lru_cache,
70
70
    pack,
71
 
    patiencediff,
72
71
    progress,
73
 
    static_tuple,
74
72
    trace,
75
73
    tsort,
76
74
    tuned_gzip,
77
 
    ui,
78
75
    )
79
76
""")
80
77
from bzrlib import (
81
78
    errors,
82
79
    osutils,
 
80
    patiencediff,
83
81
    )
84
82
from bzrlib.errors import (
85
83
    FileExists,
105
103
    ConstantMapper,
106
104
    ContentFactory,
107
105
    ChunkedContentFactory,
108
 
    sort_groupcompress,
109
106
    VersionedFile,
110
107
    VersionedFiles,
111
108
    )
301
298
            if self._network_bytes is None:
302
299
                self._create_network_bytes()
303
300
            return self._network_bytes
304
 
        if ('-ft-' in self.storage_kind and
305
 
            storage_kind in ('chunked', 'fulltext')):
306
 
            adapter_key = (self.storage_kind, 'fulltext')
307
 
            adapter_factory = adapter_registry.get(adapter_key)
308
 
            adapter = adapter_factory(None)
309
 
            bytes = adapter.get_bytes(self)
310
 
            if storage_kind == 'chunked':
311
 
                return [bytes]
312
 
            else:
313
 
                return bytes
314
301
        if self._knit is not None:
315
 
            # Not redundant with direct conversion above - that only handles
316
 
            # fulltext cases.
317
302
            if storage_kind == 'chunked':
318
303
                return self._knit.get_lines(self.key[0])
319
304
            elif storage_kind == 'fulltext':
666
651
 
667
652
        see parse_fulltext which this inverts.
668
653
        """
 
654
        # TODO: jam 20070209 We only do the caching thing to make sure that
 
655
        #       the origin is a valid utf-8 line, eventually we could remove it
669
656
        return ['%s %s' % (o, t) for o, t in content._lines]
670
657
 
671
658
    def lower_line_delta(self, delta):
686
673
        content = knit._get_content(key)
687
674
        # adjust for the fact that serialised annotations are only key suffixes
688
675
        # for this factory.
689
 
        if type(key) is tuple:
 
676
        if type(key) == tuple:
690
677
            prefix = key[:-1]
691
678
            origins = content.annotate()
692
679
            result = []
758
745
 
759
746
    def annotate(self, knit, key):
760
747
        annotator = _KnitAnnotator(knit)
761
 
        return annotator.annotate_flat(key)
 
748
        return annotator.annotate(key)
762
749
 
763
750
 
764
751
 
909
896
            # indexes can't directly store that, so we give them
910
897
            # an empty tuple instead.
911
898
            parents = ()
912
 
        line_bytes = ''.join(lines)
913
899
        return self._add(key, lines, parents,
914
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
915
 
            line_bytes=line_bytes)
916
 
 
917
 
    def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
918
 
        """See VersionedFiles._add_text()."""
919
 
        self._index._check_write_ok()
920
 
        self._check_add(key, None, random_id, check_content=False)
921
 
        if text.__class__ is not str:
922
 
            raise errors.BzrBadParameterUnicode("text")
923
 
        if parents is None:
924
 
            # The caller might pass None if there is no graph data, but kndx
925
 
            # indexes can't directly store that, so we give them
926
 
            # an empty tuple instead.
927
 
            parents = ()
928
 
        return self._add(key, None, parents,
929
 
            None, None, nostore_sha, random_id,
930
 
            line_bytes=text)
 
900
            parent_texts, left_matching_blocks, nostore_sha, random_id)
931
901
 
932
902
    def _add(self, key, lines, parents, parent_texts,
933
 
        left_matching_blocks, nostore_sha, random_id,
934
 
        line_bytes):
 
903
        left_matching_blocks, nostore_sha, random_id):
935
904
        """Add a set of lines on top of version specified by parents.
936
905
 
937
906
        Any versions not present will be converted into ghosts.
938
 
 
939
 
        :param lines: A list of strings where each one is a single line (has a
940
 
            single newline at the end of the string) This is now optional
941
 
            (callers can pass None). It is left in its location for backwards
942
 
            compatibility. It should ''.join(lines) must == line_bytes
943
 
        :param line_bytes: A single string containing the content
944
 
 
945
 
        We pass both lines and line_bytes because different routes bring the
946
 
        values to this function. And for memory efficiency, we don't want to
947
 
        have to split/join on-demand.
948
907
        """
949
908
        # first thing, if the content is something we don't need to store, find
950
909
        # that out.
 
910
        line_bytes = ''.join(lines)
951
911
        digest = sha_string(line_bytes)
952
912
        if nostore_sha == digest:
953
913
            raise errors.ExistingContent
974
934
 
975
935
        text_length = len(line_bytes)
976
936
        options = []
977
 
        no_eol = False
978
 
        # Note: line_bytes is not modified to add a newline, that is tracked
979
 
        #       via the no_eol flag. 'lines' *is* modified, because that is the
980
 
        #       general values needed by the Content code.
981
 
        if line_bytes and line_bytes[-1] != '\n':
982
 
            options.append('no-eol')
983
 
            no_eol = True
984
 
            # Copy the existing list, or create a new one
985
 
            if lines is None:
986
 
                lines = osutils.split_lines(line_bytes)
987
 
            else:
 
937
        if lines:
 
938
            if lines[-1][-1] != '\n':
 
939
                # copy the contents of lines.
988
940
                lines = lines[:]
989
 
            # Replace the last line with one that ends in a final newline
990
 
            lines[-1] = lines[-1] + '\n'
991
 
        if lines is None:
992
 
            lines = osutils.split_lines(line_bytes)
 
941
                options.append('no-eol')
 
942
                lines[-1] = lines[-1] + '\n'
 
943
                line_bytes += '\n'
993
944
 
994
 
        for element in key[:-1]:
995
 
            if type(element) is not str:
996
 
                raise TypeError("key contains non-strings: %r" % (key,))
997
 
        if key[-1] is None:
998
 
            key = key[:-1] + ('sha1:' + digest,)
999
 
        elif type(key[-1]) is not str:
 
945
        for element in key:
 
946
            if type(element) != str:
1000
947
                raise TypeError("key contains non-strings: %r" % (key,))
1001
948
        # Knit hunks are still last-element only
1002
949
        version_id = key[-1]
1003
950
        content = self._factory.make(lines, version_id)
1004
 
        if no_eol:
 
951
        if 'no-eol' in options:
1005
952
            # Hint to the content object that its text() call should strip the
1006
953
            # EOL.
1007
954
            content._should_strip_eol = True
1019
966
        else:
1020
967
            options.append('fulltext')
1021
968
            # isinstance is slower and we have no hierarchy.
1022
 
            if self._factory.__class__ is KnitPlainFactory:
 
969
            if self._factory.__class__ == KnitPlainFactory:
1023
970
                # Use the already joined bytes saving iteration time in
1024
971
                # _record_to_data.
1025
 
                dense_lines = [line_bytes]
1026
 
                if no_eol:
1027
 
                    dense_lines.append('\n')
1028
972
                size, bytes = self._record_to_data(key, digest,
1029
 
                    lines, dense_lines)
 
973
                    lines, [line_bytes])
1030
974
            else:
1031
975
                # get mixed annotation + content and feed it into the
1032
976
                # serialiser.
1044
988
        """See VersionedFiles.annotate."""
1045
989
        return self._factory.annotate(self, key)
1046
990
 
1047
 
    def get_annotator(self):
1048
 
        return _KnitAnnotator(self)
1049
 
 
1050
 
    def check(self, progress_bar=None, keys=None):
 
991
    def check(self, progress_bar=None):
1051
992
        """See VersionedFiles.check()."""
1052
 
        if keys is None:
1053
 
            return self._logical_check()
1054
 
        else:
1055
 
            # At the moment, check does not extra work over get_record_stream
1056
 
            return self.get_record_stream(keys, 'unordered', True)
1057
 
 
1058
 
    def _logical_check(self):
1059
993
        # This doesn't actually test extraction of everything, but that will
1060
994
        # impact 'bzr check' substantially, and needs to be integrated with
1061
995
        # care. However, it does check for the obvious problem of a delta with
1075
1009
    def _check_add(self, key, lines, random_id, check_content):
1076
1010
        """check that version_id and lines are safe to add."""
1077
1011
        version_id = key[-1]
1078
 
        if version_id is not None:
1079
 
            if contains_whitespace(version_id):
1080
 
                raise InvalidRevisionId(version_id, self)
1081
 
            self.check_not_reserved_id(version_id)
 
1012
        if contains_whitespace(version_id):
 
1013
            raise InvalidRevisionId(version_id, self)
 
1014
        self.check_not_reserved_id(version_id)
1082
1015
        # TODO: If random_id==False and the key is already present, we should
1083
1016
        # probably check that the existing content is identical to what is
1084
1017
        # being inserted, and otherwise raise an exception.  This would make
1192
1125
        generator = _VFContentMapGenerator(self, [key])
1193
1126
        return generator._get_content(key)
1194
1127
 
1195
 
    def get_known_graph_ancestry(self, keys):
1196
 
        """Get a KnownGraph instance with the ancestry of keys."""
1197
 
        parent_map, missing_keys = self._index.find_ancestry(keys)
1198
 
        for fallback in self._fallback_vfs:
1199
 
            if not missing_keys:
1200
 
                break
1201
 
            (f_parent_map, f_missing_keys) = fallback._index.find_ancestry(
1202
 
                                                missing_keys)
1203
 
            parent_map.update(f_parent_map)
1204
 
            missing_keys = f_missing_keys
1205
 
        kg = _mod_graph.KnownGraph(parent_map)
1206
 
        return kg
1207
 
 
1208
1128
    def get_parent_map(self, keys):
1209
1129
        """Get a map of the graph parents of keys.
1210
1130
 
1377
1297
        if cur_keys:
1378
1298
            result.append((cur_keys, cur_non_local))
1379
1299
            sizes.append(cur_size)
 
1300
        trace.mutter('Collapsed %d keys into %d requests w/ %d file_ids'
 
1301
                     ' w/ sizes: %s', total_keys, len(result),
 
1302
                     len(prefix_split_keys), sizes)
1380
1303
        return result
1381
1304
 
1382
1305
    def get_record_stream(self, keys, ordering, include_delta_closure):
1396
1319
        if not keys:
1397
1320
            return
1398
1321
        if not self._index.has_graph:
1399
 
            # Cannot sort when no graph has been stored.
 
1322
            # Cannot topological order when no graph has been stored.
1400
1323
            ordering = 'unordered'
1401
1324
 
1402
1325
        remaining_keys = keys
1458
1381
                    needed_from_fallback.add(key)
1459
1382
        # Double index lookups here : need a unified api ?
1460
1383
        global_map, parent_maps = self._get_parent_map_with_sources(keys)
1461
 
        if ordering in ('topological', 'groupcompress'):
1462
 
            if ordering == 'topological':
1463
 
                # Global topological sort
1464
 
                present_keys = tsort.topo_sort(global_map)
1465
 
            else:
1466
 
                present_keys = sort_groupcompress(global_map)
 
1384
        if ordering == 'topological':
 
1385
            # Global topological sort
 
1386
            present_keys = tsort.topo_sort(global_map)
1467
1387
            # Now group by source:
1468
1388
            source_keys = []
1469
1389
            current_source = None
1479
1399
        else:
1480
1400
            if ordering != 'unordered':
1481
1401
                raise AssertionError('valid values for ordering are:'
1482
 
                    ' "unordered", "groupcompress" or "topological" not: %r'
 
1402
                    ' "unordered" or "topological" not: %r'
1483
1403
                    % (ordering,))
1484
1404
            # Just group by source; remote sources first.
1485
1405
            present_keys = []
1511
1431
                                                                non_local_keys,
1512
1432
                                                                positions):
1513
1433
                generator = _VFContentMapGenerator(self, keys, non_local_keys,
1514
 
                                                   global_map,
1515
 
                                                   ordering=ordering)
 
1434
                                                   global_map)
1516
1435
                for record in generator.get_record_stream():
1517
1436
                    yield record
1518
1437
        else:
1520
1439
                if source is parent_maps[0]:
1521
1440
                    # this KnitVersionedFiles
1522
1441
                    records = [(key, positions[key][1]) for key in keys]
1523
 
                    for key, raw_data in self._read_records_iter_unchecked(records):
 
1442
                    for key, raw_data, sha1 in self._read_records_iter_raw(records):
1524
1443
                        (record_details, index_memo, _) = positions[key]
1525
1444
                        yield KnitContentFactory(key, global_map[key],
1526
 
                            record_details, None, raw_data, self._factory.annotated, None)
 
1445
                            record_details, sha1, raw_data, self._factory.annotated, None)
1527
1446
                else:
1528
1447
                    vf = self._fallback_vfs[parent_maps.index(source) - 1]
1529
1448
                    for record in vf.get_record_stream(keys, ordering,
1598
1517
        # key = basis_parent, value = index entry to add
1599
1518
        buffered_index_entries = {}
1600
1519
        for record in stream:
1601
 
            kind = record.storage_kind
1602
 
            if kind.startswith('knit-') and kind.endswith('-gz'):
1603
 
                # Check that the ID in the header of the raw knit bytes matches
1604
 
                # the record metadata.
1605
 
                raw_data = record._raw_record
1606
 
                df, rec = self._parse_record_header(record.key, raw_data)
1607
 
                df.close()
1608
1520
            buffered = False
1609
1521
            parents = record.parents
1610
1522
            if record.storage_kind in delta_types:
1684
1596
                # KnitVersionedFiles doesn't permit deltas (_max_delta_chain ==
1685
1597
                # 0) or because it depends on a base only present in the
1686
1598
                # fallback kvfs.
1687
 
                self._access.flush()
1688
1599
                try:
1689
1600
                    # Try getting a fulltext directly from the record.
1690
1601
                    bytes = record.get_bytes_as('fulltext')
1712
1623
            # There were index entries buffered at the end of the stream,
1713
1624
            # So these need to be added (if the index supports holding such
1714
1625
            # entries for later insertion)
1715
 
            all_entries = []
1716
1626
            for key in buffered_index_entries:
1717
1627
                index_entries = buffered_index_entries[key]
1718
 
                all_entries.extend(index_entries)
1719
 
            self._index.add_records(
1720
 
                all_entries, missing_compression_parents=True)
 
1628
                self._index.add_records(index_entries,
 
1629
                    missing_compression_parents=True)
1721
1630
 
1722
1631
    def get_missing_compression_parent_keys(self):
1723
1632
        """Return an iterable of keys of missing compression parents.
1752
1661
         * If a requested key did not change any lines (or didn't have any
1753
1662
           lines), it may not be mentioned at all in the result.
1754
1663
 
1755
 
        :param pb: Progress bar supplied by caller.
1756
1664
        :return: An iterator over (line, key).
1757
1665
        """
1758
1666
        if pb is None:
1759
 
            pb = ui.ui_factory.nested_progress_bar()
 
1667
            pb = progress.DummyProgress()
1760
1668
        keys = set(keys)
1761
1669
        total = len(keys)
1762
1670
        done = False
1772
1680
                        key_records.append((key, details[0]))
1773
1681
                records_iter = enumerate(self._read_records_iter(key_records))
1774
1682
                for (key_idx, (key, data, sha_value)) in records_iter:
1775
 
                    pb.update('Walking content', key_idx, total)
 
1683
                    pb.update('Walking content.', key_idx, total)
1776
1684
                    compression_parent = build_details[key][1]
1777
1685
                    if compression_parent is None:
1778
1686
                        # fulltext
1808
1716
                source_keys.add(key)
1809
1717
                yield line, key
1810
1718
            keys.difference_update(source_keys)
1811
 
        pb.update('Walking content', total, total)
 
1719
        pb.update('Walking content.', total, total)
1812
1720
 
1813
1721
    def _make_line_delta(self, delta_seq, new_content):
1814
1722
        """Generate a line delta from delta_seq and new_content."""
1960
1868
            df.close()
1961
1869
            yield key, data, rec[3]
1962
1870
 
 
1871
    # XXX: server should be using this directly, rather than
 
1872
    # _read_records_iter_raw. 3/3/2009
1963
1873
    def _read_records_iter_unchecked(self, records):
1964
1874
        """Read text records from data file and yield raw data.
1965
1875
 
1992
1902
            function spends less time resizing the final string.
1993
1903
        :return: (len, a StringIO instance with the raw data ready to read.)
1994
1904
        """
1995
 
        chunks = ["version %s %d %s\n" % (key[-1], len(lines), digest)]
1996
 
        chunks.extend(dense_lines or lines)
1997
 
        chunks.append("end %s\n" % key[-1])
1998
 
        for chunk in chunks:
1999
 
            if type(chunk) is not str:
2000
 
                raise AssertionError(
2001
 
                    'data must be plain bytes was %s' % type(chunk))
 
1905
        # Note: using a string copy here increases memory pressure with e.g.
 
1906
        # ISO's, but it is about 3 seconds faster on a 1.2Ghz intel machine
 
1907
        # when doing the initial commit of a mozilla tree. RBC 20070921
 
1908
        bytes = ''.join(chain(
 
1909
            ["version %s %d %s\n" % (key[-1],
 
1910
                                     len(lines),
 
1911
                                     digest)],
 
1912
            dense_lines or lines,
 
1913
            ["end %s\n" % key[-1]]))
 
1914
        if type(bytes) != str:
 
1915
            raise AssertionError(
 
1916
                'data must be plain bytes was %s' % type(bytes))
2002
1917
        if lines and lines[-1][-1] != '\n':
2003
1918
            raise ValueError('corrupt lines value %r' % lines)
2004
 
        compressed_bytes = tuned_gzip.chunks_to_gzip(chunks)
 
1919
        compressed_bytes = tuned_gzip.bytes_to_gzip(bytes)
2005
1920
        return len(compressed_bytes), compressed_bytes
2006
1921
 
2007
1922
    def _split_header(self, line):
2025
1940
class _ContentMapGenerator(object):
2026
1941
    """Generate texts or expose raw deltas for a set of texts."""
2027
1942
 
2028
 
    def __init__(self, ordering='unordered'):
2029
 
        self._ordering = ordering
2030
 
 
2031
1943
    def _get_content(self, key):
2032
1944
        """Get the content object for key."""
2033
1945
        # Note that _get_content is only called when the _ContentMapGenerator
2067
1979
            # Loop over fallback repositories asking them for texts - ignore
2068
1980
            # any missing from a particular fallback.
2069
1981
            for record in source.get_record_stream(missing_keys,
2070
 
                self._ordering, True):
 
1982
                'unordered', True):
2071
1983
                if record.storage_kind == 'absent':
2072
1984
                    # Not in thie particular stream, may be in one of the
2073
1985
                    # other fallback vfs objects.
2075
1987
                missing_keys.remove(record.key)
2076
1988
                yield record
2077
1989
 
2078
 
        if self._raw_record_map is None:
2079
 
            raise AssertionError('_raw_record_map should have been filled')
 
1990
        self._raw_record_map = self.vf._get_record_map_unparsed(self.keys,
 
1991
            allow_missing=True)
2080
1992
        first = True
2081
1993
        for key in self.keys:
2082
1994
            if key in self.nonlocal_keys:
2205
2117
    """Content map generator reading from a VersionedFiles object."""
2206
2118
 
2207
2119
    def __init__(self, versioned_files, keys, nonlocal_keys=None,
2208
 
        global_map=None, raw_record_map=None, ordering='unordered'):
 
2120
        global_map=None, raw_record_map=None):
2209
2121
        """Create a _ContentMapGenerator.
2210
2122
 
2211
2123
        :param versioned_files: The versioned files that the texts are being
2219
2131
        :param raw_record_map: A unparsed raw record map to use for answering
2220
2132
            contents.
2221
2133
        """
2222
 
        _ContentMapGenerator.__init__(self, ordering=ordering)
2223
2134
        # The vf to source data from
2224
2135
        self.vf = versioned_files
2225
2136
        # The keys desired
2369
2280
    FLAGS is a comma separated list of flags about the record. Values include
2370
2281
        no-eol, line-delta, fulltext.
2371
2282
    BYTE_OFFSET is the ascii representation of the byte offset in the data file
2372
 
        that the compressed data starts at.
 
2283
        that the the compressed data starts at.
2373
2284
    LENGTH is the ascii representation of the length of the data file.
2374
2285
    PARENT_ID a utf-8 revision id prefixed by a '.' that is a parent of
2375
2286
        REVISION_ID.
2446
2357
                    line = "\n%s %s %s %s %s :" % (
2447
2358
                        key[-1], ','.join(options), pos, size,
2448
2359
                        self._dictionary_compress(parents))
2449
 
                    if type(line) is not str:
 
2360
                    if type(line) != str:
2450
2361
                        raise AssertionError(
2451
2362
                            'data must be utf8 was %s' % type(line))
2452
2363
                    lines.append(line)
2584
2495
        except KeyError:
2585
2496
            raise RevisionNotPresent(key, self)
2586
2497
 
2587
 
    def find_ancestry(self, keys):
2588
 
        """See CombinedGraphIndex.find_ancestry()"""
2589
 
        prefixes = set(key[:-1] for key in keys)
2590
 
        self._load_prefixes(prefixes)
2591
 
        result = {}
2592
 
        parent_map = {}
2593
 
        missing_keys = set()
2594
 
        pending_keys = list(keys)
2595
 
        # This assumes that keys will not reference parents in a different
2596
 
        # prefix, which is accurate so far.
2597
 
        while pending_keys:
2598
 
            key = pending_keys.pop()
2599
 
            if key in parent_map:
2600
 
                continue
2601
 
            prefix = key[:-1]
2602
 
            try:
2603
 
                suffix_parents = self._kndx_cache[prefix][0][key[-1]][4]
2604
 
            except KeyError:
2605
 
                missing_keys.add(key)
2606
 
            else:
2607
 
                parent_keys = tuple([prefix + (suffix,)
2608
 
                                     for suffix in suffix_parents])
2609
 
                parent_map[key] = parent_keys
2610
 
                pending_keys.extend([p for p in parent_keys
2611
 
                                        if p not in parent_map])
2612
 
        return parent_map, missing_keys
2613
 
 
2614
2498
    def get_parent_map(self, keys):
2615
2499
        """Get a map of the parents of keys.
2616
2500
 
2668
2552
        result = set()
2669
2553
        # Identify all key prefixes.
2670
2554
        # XXX: A bit hacky, needs polish.
2671
 
        if type(self._mapper) is ConstantMapper:
 
2555
        if type(self._mapper) == ConstantMapper:
2672
2556
            prefixes = [()]
2673
2557
        else:
2674
2558
            relpaths = set()
2706
2590
                    del self._history
2707
2591
                except NoSuchFile:
2708
2592
                    self._kndx_cache[prefix] = ({}, [])
2709
 
                    if type(self._mapper) is ConstantMapper:
 
2593
                    if type(self._mapper) == ConstantMapper:
2710
2594
                        # preserve behaviour for revisions.kndx etc.
2711
2595
                        self._init_index(path)
2712
2596
                    del self._cache
2786
2670
        return key[:-1], key[-1]
2787
2671
 
2788
2672
 
2789
 
class _KeyRefs(object):
2790
 
 
2791
 
    def __init__(self, track_new_keys=False):
2792
 
        # dict mapping 'key' to 'set of keys referring to that key'
2793
 
        self.refs = {}
2794
 
        if track_new_keys:
2795
 
            # set remembering all new keys
2796
 
            self.new_keys = set()
2797
 
        else:
2798
 
            self.new_keys = None
2799
 
 
2800
 
    def clear(self):
2801
 
        if self.refs:
2802
 
            self.refs.clear()
2803
 
        if self.new_keys:
2804
 
            self.new_keys.clear()
2805
 
 
2806
 
    def add_references(self, key, refs):
2807
 
        # Record the new references
2808
 
        for referenced in refs:
2809
 
            try:
2810
 
                needed_by = self.refs[referenced]
2811
 
            except KeyError:
2812
 
                needed_by = self.refs[referenced] = set()
2813
 
            needed_by.add(key)
2814
 
        # Discard references satisfied by the new key
2815
 
        self.add_key(key)
2816
 
 
2817
 
    def get_new_keys(self):
2818
 
        return self.new_keys
2819
 
    
2820
 
    def get_unsatisfied_refs(self):
2821
 
        return self.refs.iterkeys()
2822
 
 
2823
 
    def _satisfy_refs_for_key(self, key):
2824
 
        try:
2825
 
            del self.refs[key]
2826
 
        except KeyError:
2827
 
            # No keys depended on this key.  That's ok.
2828
 
            pass
2829
 
 
2830
 
    def add_key(self, key):
2831
 
        # satisfy refs for key, and remember that we've seen this key.
2832
 
        self._satisfy_refs_for_key(key)
2833
 
        if self.new_keys is not None:
2834
 
            self.new_keys.add(key)
2835
 
 
2836
 
    def satisfy_refs_for_keys(self, keys):
2837
 
        for key in keys:
2838
 
            self._satisfy_refs_for_key(key)
2839
 
 
2840
 
    def get_referrers(self):
2841
 
        result = set()
2842
 
        for referrers in self.refs.itervalues():
2843
 
            result.update(referrers)
2844
 
        return result
2845
 
 
2846
 
 
2847
2673
class _KnitGraphIndex(object):
2848
2674
    """A KnitVersionedFiles index layered on GraphIndex."""
2849
2675
 
2850
2676
    def __init__(self, graph_index, is_locked, deltas=False, parents=True,
2851
 
        add_callback=None, track_external_parent_refs=False):
 
2677
        add_callback=None):
2852
2678
        """Construct a KnitGraphIndex on a graph_index.
2853
2679
 
2854
2680
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
2862
2688
            [(node, value, node_refs), ...]
2863
2689
        :param is_locked: A callback, returns True if the index is locked and
2864
2690
            thus usable.
2865
 
        :param track_external_parent_refs: If True, record all external parent
2866
 
            references parents from added records.  These can be retrieved
2867
 
            later by calling get_missing_parents().
2868
2691
        """
2869
2692
        self._add_callback = add_callback
2870
2693
        self._graph_index = graph_index
2878
2701
        self.has_graph = parents
2879
2702
        self._is_locked = is_locked
2880
2703
        self._missing_compression_parents = set()
2881
 
        if track_external_parent_refs:
2882
 
            self._key_dependencies = _KeyRefs()
2883
 
        else:
2884
 
            self._key_dependencies = None
2885
2704
 
2886
2705
    def __repr__(self):
2887
2706
        return "%s(%r)" % (self.__class__.__name__, self._graph_index)
2911
2730
 
2912
2731
        keys = {}
2913
2732
        compression_parents = set()
2914
 
        key_dependencies = self._key_dependencies
2915
2733
        for (key, options, access_memo, parents) in records:
2916
2734
            if self._parents:
2917
2735
                parents = tuple(parents)
2918
 
                if key_dependencies is not None:
2919
 
                    key_dependencies.add_references(key, parents)
2920
2736
            index, pos, size = access_memo
2921
2737
            if 'no-eol' in options:
2922
2738
                value = 'N'
2946
2762
        if not random_id:
2947
2763
            present_nodes = self._get_entries(keys)
2948
2764
            for (index, key, value, node_refs) in present_nodes:
2949
 
                parents = node_refs[:1]
2950
 
                # Sometimes these are passed as a list rather than a tuple
2951
 
                passed = static_tuple.as_tuples(keys[key])
2952
 
                passed_parents = passed[1][:1]
2953
2765
                if (value[0] != keys[key][0][0] or
2954
 
                    parents != passed_parents):
2955
 
                    node_refs = static_tuple.as_tuples(node_refs)
 
2766
                    node_refs[:1] != keys[key][1][:1]):
2956
2767
                    raise KnitCorrupt(self, "inconsistent details in add_records"
2957
 
                        ": %s %s" % ((value, node_refs), passed))
 
2768
                        ": %s %s" % ((value, node_refs), keys[key]))
2958
2769
                del keys[key]
2959
2770
        result = []
2960
2771
        if self._parents:
2989
2800
            new_missing = graph_index.external_references(ref_list_num=1)
2990
2801
            new_missing.difference_update(self.get_parent_map(new_missing))
2991
2802
            self._missing_compression_parents.update(new_missing)
2992
 
        if self._key_dependencies is not None:
2993
 
            # Add parent refs from graph_index (and discard parent refs that
2994
 
            # the graph_index has).
2995
 
            for node in graph_index.iter_all_entries():
2996
 
                self._key_dependencies.add_references(node[1], node[3][0])
2997
2803
 
2998
2804
    def get_missing_compression_parents(self):
2999
2805
        """Return the keys of missing compression parents.
3003
2809
        """
3004
2810
        return frozenset(self._missing_compression_parents)
3005
2811
 
3006
 
    def get_missing_parents(self):
3007
 
        """Return the keys of missing parents."""
3008
 
        # If updating this, you should also update
3009
 
        # groupcompress._GCGraphIndex.get_missing_parents
3010
 
        # We may have false positives, so filter those out.
3011
 
        self._key_dependencies.satisfy_refs_for_keys(
3012
 
            self.get_parent_map(self._key_dependencies.get_unsatisfied_refs()))
3013
 
        return frozenset(self._key_dependencies.get_unsatisfied_refs())
3014
 
 
3015
2812
    def _check_read(self):
3016
2813
        """raise if reads are not permitted."""
3017
2814
        if not self._is_locked():
3125
2922
            options.append('no-eol')
3126
2923
        return options
3127
2924
 
3128
 
    def find_ancestry(self, keys):
3129
 
        """See CombinedGraphIndex.find_ancestry()"""
3130
 
        return self._graph_index.find_ancestry(keys, 0)
3131
 
 
3132
2925
    def get_parent_map(self, keys):
3133
2926
        """Get a map of the parents of keys.
3134
2927
 
3221
3014
            opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3222
3015
            length), where the key is the record key.
3223
3016
        """
3224
 
        if type(raw_data) is not str:
 
3017
        if type(raw_data) != str:
3225
3018
            raise AssertionError(
3226
3019
                'data must be plain bytes was %s' % type(raw_data))
3227
3020
        result = []
3244
3037
            result.append((key, base, size))
3245
3038
        return result
3246
3039
 
3247
 
    def flush(self):
3248
 
        """Flush pending writes on this access object.
3249
 
        
3250
 
        For .knit files this is a no-op.
3251
 
        """
3252
 
        pass
3253
 
 
3254
3040
    def get_raw_records(self, memos_for_retrieval):
3255
3041
        """Get the raw bytes for a records.
3256
3042
 
3281
3067
class _DirectPackAccess(object):
3282
3068
    """Access to data in one or more packs with less translation."""
3283
3069
 
3284
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
 
3070
    def __init__(self, index_to_packs, reload_func=None):
3285
3071
        """Create a _DirectPackAccess object.
3286
3072
 
3287
3073
        :param index_to_packs: A dict mapping index objects to the transport
3294
3080
        self._write_index = None
3295
3081
        self._indices = index_to_packs
3296
3082
        self._reload_func = reload_func
3297
 
        self._flush_func = flush_func
3298
3083
 
3299
3084
    def add_raw_records(self, key_sizes, raw_data):
3300
3085
        """Add raw knit bytes to a storage area.
3310
3095
            length), where the index field is the write_index object supplied
3311
3096
            to the PackAccess object.
3312
3097
        """
3313
 
        if type(raw_data) is not str:
 
3098
        if type(raw_data) != str:
3314
3099
            raise AssertionError(
3315
3100
                'data must be plain bytes was %s' % type(raw_data))
3316
3101
        result = []
3322
3107
            result.append((self._write_index, p_offset, p_length))
3323
3108
        return result
3324
3109
 
3325
 
    def flush(self):
3326
 
        """Flush pending writes on this access object.
3327
 
 
3328
 
        This will flush any buffered writes to a NewPack.
3329
 
        """
3330
 
        if self._flush_func is not None:
3331
 
            self._flush_func()
3332
 
            
3333
3110
    def get_raw_records(self, memos_for_retrieval):
3334
3111
        """Get the raw bytes for a records.
3335
3112
 
3417
3194
            raise exc_class, exc_value, exc_traceback
3418
3195
 
3419
3196
 
 
3197
# Deprecated, use PatienceSequenceMatcher instead
 
3198
KnitSequenceMatcher = patiencediff.PatienceSequenceMatcher
 
3199
 
 
3200
 
3420
3201
def annotate_knit(knit, revision_id):
3421
3202
    """Annotate a knit with no cached annotations.
3422
3203
 
3425
3206
    recommended.
3426
3207
    """
3427
3208
    annotator = _KnitAnnotator(knit)
3428
 
    return iter(annotator.annotate_flat(revision_id))
3429
 
 
3430
 
 
3431
 
class _KnitAnnotator(annotate.Annotator):
 
3209
    return iter(annotator.annotate(revision_id))
 
3210
 
 
3211
 
 
3212
class _KnitAnnotator(object):
3432
3213
    """Build up the annotations for a text."""
3433
3214
 
3434
 
    def __init__(self, vf):
3435
 
        annotate.Annotator.__init__(self, vf)
3436
 
 
3437
 
        # TODO: handle Nodes which cannot be extracted
3438
 
        # self._ghosts = set()
3439
 
 
3440
 
        # Map from (key, parent_key) => matching_blocks, should be 'use once'
3441
 
        self._matching_blocks = {}
3442
 
 
3443
 
        # KnitContent objects
3444
 
        self._content_objects = {}
3445
 
        # The number of children that depend on this fulltext content object
3446
 
        self._num_compression_children = {}
3447
 
        # Delta records that need their compression parent before they can be
3448
 
        # expanded
3449
 
        self._pending_deltas = {}
3450
 
        # Fulltext records that are waiting for their parents fulltexts before
3451
 
        # they can be yielded for annotation
3452
 
        self._pending_annotation = {}
 
3215
    def __init__(self, knit):
 
3216
        self._knit = knit
 
3217
 
 
3218
        # Content objects, differs from fulltexts because of how final newlines
 
3219
        # are treated by knits. the content objects here will always have a
 
3220
        # final newline
 
3221
        self._fulltext_contents = {}
 
3222
 
 
3223
        # Annotated lines of specific revisions
 
3224
        self._annotated_lines = {}
 
3225
 
 
3226
        # Track the raw data for nodes that we could not process yet.
 
3227
        # This maps the revision_id of the base to a list of children that will
 
3228
        # annotated from it.
 
3229
        self._pending_children = {}
 
3230
 
 
3231
        # Nodes which cannot be extracted
 
3232
        self._ghosts = set()
 
3233
 
 
3234
        # Track how many children this node has, so we know if we need to keep
 
3235
        # it
 
3236
        self._annotate_children = {}
 
3237
        self._compression_children = {}
3453
3238
 
3454
3239
        self._all_build_details = {}
 
3240
        # The children => parent revision_id graph
 
3241
        self._revision_id_graph = {}
 
3242
 
 
3243
        self._heads_provider = None
 
3244
 
 
3245
        self._nodes_to_keep_annotations = set()
 
3246
        self._generations_until_keep = 100
 
3247
 
 
3248
    def set_generations_until_keep(self, value):
 
3249
        """Set the number of generations before caching a node.
 
3250
 
 
3251
        Setting this to -1 will cache every merge node, setting this higher
 
3252
        will cache fewer nodes.
 
3253
        """
 
3254
        self._generations_until_keep = value
 
3255
 
 
3256
    def _add_fulltext_content(self, revision_id, content_obj):
 
3257
        self._fulltext_contents[revision_id] = content_obj
 
3258
        # TODO: jam 20080305 It might be good to check the sha1digest here
 
3259
        return content_obj.text()
 
3260
 
 
3261
    def _check_parents(self, child, nodes_to_annotate):
 
3262
        """Check if all parents have been processed.
 
3263
 
 
3264
        :param child: A tuple of (rev_id, parents, raw_content)
 
3265
        :param nodes_to_annotate: If child is ready, add it to
 
3266
            nodes_to_annotate, otherwise put it back in self._pending_children
 
3267
        """
 
3268
        for parent_id in child[1]:
 
3269
            if (parent_id not in self._annotated_lines):
 
3270
                # This parent is present, but another parent is missing
 
3271
                self._pending_children.setdefault(parent_id,
 
3272
                                                  []).append(child)
 
3273
                break
 
3274
        else:
 
3275
            # This one is ready to be processed
 
3276
            nodes_to_annotate.append(child)
 
3277
 
 
3278
    def _add_annotation(self, revision_id, fulltext, parent_ids,
 
3279
                        left_matching_blocks=None):
 
3280
        """Add an annotation entry.
 
3281
 
 
3282
        All parents should already have been annotated.
 
3283
        :return: A list of children that now have their parents satisfied.
 
3284
        """
 
3285
        a = self._annotated_lines
 
3286
        annotated_parent_lines = [a[p] for p in parent_ids]
 
3287
        annotated_lines = list(annotate.reannotate(annotated_parent_lines,
 
3288
            fulltext, revision_id, left_matching_blocks,
 
3289
            heads_provider=self._get_heads_provider()))
 
3290
        self._annotated_lines[revision_id] = annotated_lines
 
3291
        for p in parent_ids:
 
3292
            ann_children = self._annotate_children[p]
 
3293
            ann_children.remove(revision_id)
 
3294
            if (not ann_children
 
3295
                and p not in self._nodes_to_keep_annotations):
 
3296
                del self._annotated_lines[p]
 
3297
                del self._all_build_details[p]
 
3298
                if p in self._fulltext_contents:
 
3299
                    del self._fulltext_contents[p]
 
3300
        # Now that we've added this one, see if there are any pending
 
3301
        # deltas to be done, certainly this parent is finished
 
3302
        nodes_to_annotate = []
 
3303
        for child in self._pending_children.pop(revision_id, []):
 
3304
            self._check_parents(child, nodes_to_annotate)
 
3305
        return nodes_to_annotate
3455
3306
 
3456
3307
    def _get_build_graph(self, key):
3457
3308
        """Get the graphs for building texts and annotations.
3462
3313
        fulltext.)
3463
3314
 
3464
3315
        :return: A list of (key, index_memo) records, suitable for
3465
 
            passing to read_records_iter to start reading in the raw data from
 
3316
            passing to read_records_iter to start reading in the raw data fro/
3466
3317
            the pack file.
3467
3318
        """
 
3319
        if key in self._annotated_lines:
 
3320
            # Nothing to do
 
3321
            return []
3468
3322
        pending = set([key])
3469
3323
        records = []
3470
 
        ann_keys = set()
3471
 
        self._num_needed_children[key] = 1
 
3324
        generation = 0
 
3325
        kept_generation = 0
3472
3326
        while pending:
3473
3327
            # get all pending nodes
 
3328
            generation += 1
3474
3329
            this_iteration = pending
3475
 
            build_details = self._vf._index.get_build_details(this_iteration)
 
3330
            build_details = self._knit._index.get_build_details(this_iteration)
3476
3331
            self._all_build_details.update(build_details)
3477
 
            # new_nodes = self._vf._index._get_entries(this_iteration)
 
3332
            # new_nodes = self._knit._index._get_entries(this_iteration)
3478
3333
            pending = set()
3479
3334
            for key, details in build_details.iteritems():
3480
 
                (index_memo, compression_parent, parent_keys,
 
3335
                (index_memo, compression_parent, parents,
3481
3336
                 record_details) = details
3482
 
                self._parent_map[key] = parent_keys
3483
 
                self._heads_provider = None
 
3337
                self._revision_id_graph[key] = parents
3484
3338
                records.append((key, index_memo))
3485
3339
                # Do we actually need to check _annotated_lines?
3486
 
                pending.update([p for p in parent_keys
3487
 
                                   if p not in self._all_build_details])
3488
 
                if parent_keys:
3489
 
                    for parent_key in parent_keys:
3490
 
                        if parent_key in self._num_needed_children:
3491
 
                            self._num_needed_children[parent_key] += 1
3492
 
                        else:
3493
 
                            self._num_needed_children[parent_key] = 1
 
3340
                pending.update(p for p in parents
 
3341
                                 if p not in self._all_build_details)
3494
3342
                if compression_parent:
3495
 
                    if compression_parent in self._num_compression_children:
3496
 
                        self._num_compression_children[compression_parent] += 1
3497
 
                    else:
3498
 
                        self._num_compression_children[compression_parent] = 1
 
3343
                    self._compression_children.setdefault(compression_parent,
 
3344
                        []).append(key)
 
3345
                if parents:
 
3346
                    for parent in parents:
 
3347
                        self._annotate_children.setdefault(parent,
 
3348
                            []).append(key)
 
3349
                    num_gens = generation - kept_generation
 
3350
                    if ((num_gens >= self._generations_until_keep)
 
3351
                        and len(parents) > 1):
 
3352
                        kept_generation = generation
 
3353
                        self._nodes_to_keep_annotations.add(key)
3499
3354
 
3500
3355
            missing_versions = this_iteration.difference(build_details.keys())
3501
 
            if missing_versions:
3502
 
                for key in missing_versions:
3503
 
                    if key in self._parent_map and key in self._text_cache:
3504
 
                        # We already have this text ready, we just need to
3505
 
                        # yield it later so we get it annotated
3506
 
                        ann_keys.add(key)
3507
 
                        parent_keys = self._parent_map[key]
3508
 
                        for parent_key in parent_keys:
3509
 
                            if parent_key in self._num_needed_children:
3510
 
                                self._num_needed_children[parent_key] += 1
3511
 
                            else:
3512
 
                                self._num_needed_children[parent_key] = 1
3513
 
                        pending.update([p for p in parent_keys
3514
 
                                           if p not in self._all_build_details])
3515
 
                    else:
3516
 
                        raise errors.RevisionNotPresent(key, self._vf)
 
3356
            self._ghosts.update(missing_versions)
 
3357
            for missing_version in missing_versions:
 
3358
                # add a key, no parents
 
3359
                self._revision_id_graph[missing_version] = ()
 
3360
                pending.discard(missing_version) # don't look for it
 
3361
        if self._ghosts.intersection(self._compression_children):
 
3362
            raise KnitCorrupt(
 
3363
                "We cannot have nodes which have a ghost compression parent:\n"
 
3364
                "ghosts: %r\n"
 
3365
                "compression children: %r"
 
3366
                % (self._ghosts, self._compression_children))
 
3367
        # Cleanout anything that depends on a ghost so that we don't wait for
 
3368
        # the ghost to show up
 
3369
        for node in self._ghosts:
 
3370
            if node in self._annotate_children:
 
3371
                # We won't be building this node
 
3372
                del self._annotate_children[node]
3517
3373
        # Generally we will want to read the records in reverse order, because
3518
3374
        # we find the parent nodes after the children
3519
3375
        records.reverse()
3520
 
        return records, ann_keys
3521
 
 
3522
 
    def _get_needed_texts(self, key, pb=None):
3523
 
        # if True or len(self._vf._fallback_vfs) > 0:
3524
 
        if len(self._vf._fallback_vfs) > 0:
3525
 
            # If we have fallbacks, go to the generic path
3526
 
            for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3527
 
                yield v
3528
 
            return
3529
 
        while True:
3530
 
            try:
3531
 
                records, ann_keys = self._get_build_graph(key)
3532
 
                for idx, (sub_key, text, num_lines) in enumerate(
3533
 
                                                self._extract_texts(records)):
3534
 
                    if pb is not None:
3535
 
                        pb.update('annotating', idx, len(records))
3536
 
                    yield sub_key, text, num_lines
3537
 
                for sub_key in ann_keys:
3538
 
                    text = self._text_cache[sub_key]
3539
 
                    num_lines = len(text) # bad assumption
3540
 
                    yield sub_key, text, num_lines
3541
 
                return
3542
 
            except errors.RetryWithNewPacks, e:
3543
 
                self._vf._access.reload_or_raise(e)
3544
 
                # The cached build_details are no longer valid
3545
 
                self._all_build_details.clear()
3546
 
 
3547
 
    def _cache_delta_blocks(self, key, compression_parent, delta, lines):
3548
 
        parent_lines = self._text_cache[compression_parent]
3549
 
        blocks = list(KnitContent.get_line_delta_blocks(delta, parent_lines, lines))
3550
 
        self._matching_blocks[(key, compression_parent)] = blocks
3551
 
 
3552
 
    def _expand_record(self, key, parent_keys, compression_parent, record,
3553
 
                       record_details):
3554
 
        delta = None
3555
 
        if compression_parent:
3556
 
            if compression_parent not in self._content_objects:
3557
 
                # Waiting for the parent
3558
 
                self._pending_deltas.setdefault(compression_parent, []).append(
3559
 
                    (key, parent_keys, record, record_details))
3560
 
                return None
3561
 
            # We have the basis parent, so expand the delta
3562
 
            num = self._num_compression_children[compression_parent]
3563
 
            num -= 1
3564
 
            if num == 0:
3565
 
                base_content = self._content_objects.pop(compression_parent)
3566
 
                self._num_compression_children.pop(compression_parent)
3567
 
            else:
3568
 
                self._num_compression_children[compression_parent] = num
3569
 
                base_content = self._content_objects[compression_parent]
3570
 
            # It is tempting to want to copy_base_content=False for the last
3571
 
            # child object. However, whenever noeol=False,
3572
 
            # self._text_cache[parent_key] is content._lines. So mutating it
3573
 
            # gives very bad results.
3574
 
            # The alternative is to copy the lines into text cache, but then we
3575
 
            # are copying anyway, so just do it here.
3576
 
            content, delta = self._vf._factory.parse_record(
3577
 
                key, record, record_details, base_content,
3578
 
                copy_base_content=True)
3579
 
        else:
3580
 
            # Fulltext record
3581
 
            content, _ = self._vf._factory.parse_record(
3582
 
                key, record, record_details, None)
3583
 
        if self._num_compression_children.get(key, 0) > 0:
3584
 
            self._content_objects[key] = content
3585
 
        lines = content.text()
3586
 
        self._text_cache[key] = lines
3587
 
        if delta is not None:
3588
 
            self._cache_delta_blocks(key, compression_parent, delta, lines)
3589
 
        return lines
3590
 
 
3591
 
    def _get_parent_annotations_and_matches(self, key, text, parent_key):
3592
 
        """Get the list of annotations for the parent, and the matching lines.
3593
 
 
3594
 
        :param text: The opaque value given by _get_needed_texts
3595
 
        :param parent_key: The key for the parent text
3596
 
        :return: (parent_annotations, matching_blocks)
3597
 
            parent_annotations is a list as long as the number of lines in
3598
 
                parent
3599
 
            matching_blocks is a list of (parent_idx, text_idx, len) tuples
3600
 
                indicating which lines match between the two texts
3601
 
        """
3602
 
        block_key = (key, parent_key)
3603
 
        if block_key in self._matching_blocks:
3604
 
            blocks = self._matching_blocks.pop(block_key)
3605
 
            parent_annotations = self._annotations_cache[parent_key]
3606
 
            return parent_annotations, blocks
3607
 
        return annotate.Annotator._get_parent_annotations_and_matches(self,
3608
 
            key, text, parent_key)
3609
 
 
3610
 
    def _process_pending(self, key):
3611
 
        """The content for 'key' was just processed.
3612
 
 
3613
 
        Determine if there is any more pending work to be processed.
3614
 
        """
3615
 
        to_return = []
3616
 
        if key in self._pending_deltas:
3617
 
            compression_parent = key
3618
 
            children = self._pending_deltas.pop(key)
3619
 
            for child_key, parent_keys, record, record_details in children:
3620
 
                lines = self._expand_record(child_key, parent_keys,
3621
 
                                            compression_parent,
3622
 
                                            record, record_details)
3623
 
                if self._check_ready_for_annotations(child_key, parent_keys):
3624
 
                    to_return.append(child_key)
3625
 
        # Also check any children that are waiting for this parent to be
3626
 
        # annotation ready
3627
 
        if key in self._pending_annotation:
3628
 
            children = self._pending_annotation.pop(key)
3629
 
            to_return.extend([c for c, p_keys in children
3630
 
                              if self._check_ready_for_annotations(c, p_keys)])
3631
 
        return to_return
3632
 
 
3633
 
    def _check_ready_for_annotations(self, key, parent_keys):
3634
 
        """return true if this text is ready to be yielded.
3635
 
 
3636
 
        Otherwise, this will return False, and queue the text into
3637
 
        self._pending_annotation
3638
 
        """
3639
 
        for parent_key in parent_keys:
3640
 
            if parent_key not in self._annotations_cache:
3641
 
                # still waiting on at least one parent text, so queue it up
3642
 
                # Note that if there are multiple parents, we need to wait
3643
 
                # for all of them.
3644
 
                self._pending_annotation.setdefault(parent_key,
3645
 
                    []).append((key, parent_keys))
3646
 
                return False
3647
 
        return True
3648
 
 
3649
 
    def _extract_texts(self, records):
3650
 
        """Extract the various texts needed based on records"""
 
3376
        return records
 
3377
 
 
3378
    def _annotate_records(self, records):
 
3379
        """Build the annotations for the listed records."""
3651
3380
        # We iterate in the order read, rather than a strict order requested
3652
3381
        # However, process what we can, and put off to the side things that
3653
3382
        # still need parents, cleaning them up when those parents are
3654
3383
        # processed.
3655
 
        # Basic data flow:
3656
 
        #   1) As 'records' are read, see if we can expand these records into
3657
 
        #      Content objects (and thus lines)
3658
 
        #   2) If a given line-delta is waiting on its compression parent, it
3659
 
        #      gets queued up into self._pending_deltas, otherwise we expand
3660
 
        #      it, and put it into self._text_cache and self._content_objects
3661
 
        #   3) If we expanded the text, we will then check to see if all
3662
 
        #      parents have also been processed. If so, this text gets yielded,
3663
 
        #      else this record gets set aside into pending_annotation
3664
 
        #   4) Further, if we expanded the text in (2), we will then check to
3665
 
        #      see if there are any children in self._pending_deltas waiting to
3666
 
        #      also be processed. If so, we go back to (2) for those
3667
 
        #   5) Further again, if we yielded the text, we can then check if that
3668
 
        #      'unlocks' any of the texts in pending_annotations, which should
3669
 
        #      then get yielded as well
3670
 
        # Note that both steps 4 and 5 are 'recursive' in that unlocking one
3671
 
        # compression child could unlock yet another, and yielding a fulltext
3672
 
        # will also 'unlock' the children that are waiting on that annotation.
3673
 
        # (Though also, unlocking 1 parent's fulltext, does not unlock a child
3674
 
        # if other parents are also waiting.)
3675
 
        # We want to yield content before expanding child content objects, so
3676
 
        # that we know when we can re-use the content lines, and the annotation
3677
 
        # code can know when it can stop caching fulltexts, as well.
3678
 
 
3679
 
        # Children that are missing their compression parent
3680
 
        pending_deltas = {}
3681
 
        for (key, record, digest) in self._vf._read_records_iter(records):
3682
 
            # ghosts?
3683
 
            details = self._all_build_details[key]
3684
 
            (_, compression_parent, parent_keys, record_details) = details
3685
 
            lines = self._expand_record(key, parent_keys, compression_parent,
3686
 
                                        record, record_details)
3687
 
            if lines is None:
3688
 
                # Pending delta should be queued up
 
3384
        for (rev_id, record,
 
3385
             digest) in self._knit._read_records_iter(records):
 
3386
            if rev_id in self._annotated_lines:
3689
3387
                continue
3690
 
            # At this point, we may be able to yield this content, if all
3691
 
            # parents are also finished
3692
 
            yield_this_text = self._check_ready_for_annotations(key,
3693
 
                                                                parent_keys)
3694
 
            if yield_this_text:
3695
 
                # All parents present
3696
 
                yield key, lines, len(lines)
3697
 
            to_process = self._process_pending(key)
3698
 
            while to_process:
3699
 
                this_process = to_process
3700
 
                to_process = []
3701
 
                for key in this_process:
3702
 
                    lines = self._text_cache[key]
3703
 
                    yield key, lines, len(lines)
3704
 
                    to_process.extend(self._process_pending(key))
 
3388
            parent_ids = self._revision_id_graph[rev_id]
 
3389
            parent_ids = [p for p in parent_ids if p not in self._ghosts]
 
3390
            details = self._all_build_details[rev_id]
 
3391
            (index_memo, compression_parent, parents,
 
3392
             record_details) = details
 
3393
            nodes_to_annotate = []
 
3394
            # TODO: Remove the punning between compression parents, and
 
3395
            #       parent_ids, we should be able to do this without assuming
 
3396
            #       the build order
 
3397
            if len(parent_ids) == 0:
 
3398
                # There are no parents for this node, so just add it
 
3399
                # TODO: This probably needs to be decoupled
 
3400
                fulltext_content, delta = self._knit._factory.parse_record(
 
3401
                    rev_id, record, record_details, None)
 
3402
                fulltext = self._add_fulltext_content(rev_id, fulltext_content)
 
3403
                nodes_to_annotate.extend(self._add_annotation(rev_id, fulltext,
 
3404
                    parent_ids, left_matching_blocks=None))
 
3405
            else:
 
3406
                child = (rev_id, parent_ids, record)
 
3407
                # Check if all the parents are present
 
3408
                self._check_parents(child, nodes_to_annotate)
 
3409
            while nodes_to_annotate:
 
3410
                # Should we use a queue here instead of a stack?
 
3411
                (rev_id, parent_ids, record) = nodes_to_annotate.pop()
 
3412
                (index_memo, compression_parent, parents,
 
3413
                 record_details) = self._all_build_details[rev_id]
 
3414
                blocks = None
 
3415
                if compression_parent is not None:
 
3416
                    comp_children = self._compression_children[compression_parent]
 
3417
                    if rev_id not in comp_children:
 
3418
                        raise AssertionError("%r not in compression children %r"
 
3419
                            % (rev_id, comp_children))
 
3420
                    # If there is only 1 child, it is safe to reuse this
 
3421
                    # content
 
3422
                    reuse_content = (len(comp_children) == 1
 
3423
                        and compression_parent not in
 
3424
                            self._nodes_to_keep_annotations)
 
3425
                    if reuse_content:
 
3426
                        # Remove it from the cache since it will be changing
 
3427
                        parent_fulltext_content = self._fulltext_contents.pop(compression_parent)
 
3428
                        # Make sure to copy the fulltext since it might be
 
3429
                        # modified
 
3430
                        parent_fulltext = list(parent_fulltext_content.text())
 
3431
                    else:
 
3432
                        parent_fulltext_content = self._fulltext_contents[compression_parent]
 
3433
                        parent_fulltext = parent_fulltext_content.text()
 
3434
                    comp_children.remove(rev_id)
 
3435
                    fulltext_content, delta = self._knit._factory.parse_record(
 
3436
                        rev_id, record, record_details,
 
3437
                        parent_fulltext_content,
 
3438
                        copy_base_content=(not reuse_content))
 
3439
                    fulltext = self._add_fulltext_content(rev_id,
 
3440
                                                          fulltext_content)
 
3441
                    if compression_parent == parent_ids[0]:
 
3442
                        # the compression_parent is the left parent, so we can
 
3443
                        # re-use the delta
 
3444
                        blocks = KnitContent.get_line_delta_blocks(delta,
 
3445
                                parent_fulltext, fulltext)
 
3446
                else:
 
3447
                    fulltext_content = self._knit._factory.parse_fulltext(
 
3448
                        record, rev_id)
 
3449
                    fulltext = self._add_fulltext_content(rev_id,
 
3450
                        fulltext_content)
 
3451
                nodes_to_annotate.extend(
 
3452
                    self._add_annotation(rev_id, fulltext, parent_ids,
 
3453
                                     left_matching_blocks=blocks))
 
3454
 
 
3455
    def _get_heads_provider(self):
 
3456
        """Create a heads provider for resolving ancestry issues."""
 
3457
        if self._heads_provider is not None:
 
3458
            return self._heads_provider
 
3459
        parent_provider = _mod_graph.DictParentsProvider(
 
3460
            self._revision_id_graph)
 
3461
        graph_obj = _mod_graph.Graph(parent_provider)
 
3462
        head_cache = _mod_graph.FrozenHeadsCache(graph_obj)
 
3463
        self._heads_provider = head_cache
 
3464
        return head_cache
 
3465
 
 
3466
    def annotate(self, key):
 
3467
        """Return the annotated fulltext at the given key.
 
3468
 
 
3469
        :param key: The key to annotate.
 
3470
        """
 
3471
        if len(self._knit._fallback_vfs) > 0:
 
3472
            # stacked knits can't use the fast path at present.
 
3473
            return self._simple_annotate(key)
 
3474
        while True:
 
3475
            try:
 
3476
                records = self._get_build_graph(key)
 
3477
                if key in self._ghosts:
 
3478
                    raise errors.RevisionNotPresent(key, self._knit)
 
3479
                self._annotate_records(records)
 
3480
                return self._annotated_lines[key]
 
3481
            except errors.RetryWithNewPacks, e:
 
3482
                self._knit._access.reload_or_raise(e)
 
3483
                # The cached build_details are no longer valid
 
3484
                self._all_build_details.clear()
 
3485
 
 
3486
    def _simple_annotate(self, key):
 
3487
        """Return annotated fulltext, rediffing from the full texts.
 
3488
 
 
3489
        This is slow but makes no assumptions about the repository
 
3490
        being able to produce line deltas.
 
3491
        """
 
3492
        # TODO: this code generates a parent maps of present ancestors; it
 
3493
        # could be split out into a separate method, and probably should use
 
3494
        # iter_ancestry instead. -- mbp and robertc 20080704
 
3495
        graph = _mod_graph.Graph(self._knit)
 
3496
        head_cache = _mod_graph.FrozenHeadsCache(graph)
 
3497
        search = graph._make_breadth_first_searcher([key])
 
3498
        keys = set()
 
3499
        while True:
 
3500
            try:
 
3501
                present, ghosts = search.next_with_ghosts()
 
3502
            except StopIteration:
 
3503
                break
 
3504
            keys.update(present)
 
3505
        parent_map = self._knit.get_parent_map(keys)
 
3506
        parent_cache = {}
 
3507
        reannotate = annotate.reannotate
 
3508
        for record in self._knit.get_record_stream(keys, 'topological', True):
 
3509
            key = record.key
 
3510
            fulltext = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
 
3511
            parents = parent_map[key]
 
3512
            if parents is not None:
 
3513
                parent_lines = [parent_cache[parent] for parent in parent_map[key]]
 
3514
            else:
 
3515
                parent_lines = []
 
3516
            parent_cache[key] = list(
 
3517
                reannotate(parent_lines, fulltext, key, None, head_cache))
 
3518
        try:
 
3519
            return parent_cache[key]
 
3520
        except KeyError, e:
 
3521
            raise errors.RevisionNotPresent(key, self._knit)
 
3522
 
3705
3523
 
3706
3524
try:
3707
 
    from bzrlib._knit_load_data_pyx import _load_data_c as _load_data
3708
 
except ImportError, e:
3709
 
    osutils.failed_to_load_extension(e)
 
3525
    from bzrlib._knit_load_data_c import _load_data_c as _load_data
 
3526
except ImportError:
3710
3527
    from bzrlib._knit_load_data_py import _load_data_py as _load_data