/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/knit.py

  • Committer: Frank Aspell
  • Date: 2009-02-22 16:54:02 UTC
  • mto: This revision was merged to the branch mainline in revision 4256.
  • Revision ID: frankaspell@googlemail.com-20090222165402-2myrucnu7er5w4ha
Fixing various typos

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
20
20
updates.
21
21
 
22
22
Knit file layout:
23
 
lifeless: the data file is made up of "delta records".  each delta record has a delta header
24
 
that contains; (1) a version id, (2) the size of the delta (in lines), and (3)  the digest of
25
 
the -expanded data- (ie, the delta applied to the parent).  the delta also ends with a
 
23
lifeless: the data file is made up of "delta records".  each delta record has a delta header 
 
24
that contains; (1) a version id, (2) the size of the delta (in lines), and (3)  the digest of 
 
25
the -expanded data- (ie, the delta applied to the parent).  the delta also ends with a 
26
26
end-marker; simply "end VERSION"
27
27
 
28
28
delta can be line or full contents.a
35
35
130,130,2
36
36
8         if elt.get('executable') == 'yes':
37
37
8             ie.executable = True
38
 
end robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad
 
38
end robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad 
39
39
 
40
40
 
41
41
whats in an index:
51
51
 
52
52
"""
53
53
 
 
54
# TODOS:
 
55
# 10:16 < lifeless> make partial index writes safe
 
56
# 10:16 < lifeless> implement 'knit.check()' like weave.check()
 
57
# 10:17 < lifeless> record known ghosts so we can detect when they are filled in rather than the current 'reweave 
 
58
#                    always' approach.
 
59
# move sha1 out of the content so that join is faster at verifying parents
 
60
# record content length ?
 
61
                  
54
62
 
55
63
from cStringIO import StringIO
56
 
from itertools import izip
 
64
from itertools import izip, chain
57
65
import operator
58
66
import os
59
67
import sys
69
77
    lru_cache,
70
78
    pack,
71
79
    progress,
72
 
    static_tuple,
73
80
    trace,
74
81
    tsort,
75
82
    tuned_gzip,
76
 
    ui,
77
83
    )
78
84
""")
79
85
from bzrlib import (
105
111
    ConstantMapper,
106
112
    ContentFactory,
107
113
    ChunkedContentFactory,
108
 
    sort_groupcompress,
109
114
    VersionedFile,
110
115
    VersionedFiles,
111
116
    )
126
131
 
127
132
DATA_SUFFIX = '.knit'
128
133
INDEX_SUFFIX = '.kndx'
129
 
_STREAM_MIN_BUFFER_SIZE = 5*1024*1024
130
134
 
131
135
 
132
136
class KnitAdapter(object):
134
138
 
135
139
    def __init__(self, basis_vf):
136
140
        """Create an adapter which accesses full texts from basis_vf.
137
 
 
 
141
        
138
142
        :param basis_vf: A versioned file to access basis texts of deltas from.
139
143
            May be None for adapters that do not need to access basis texts.
140
144
        """
244
248
 
245
249
class KnitContentFactory(ContentFactory):
246
250
    """Content factory for streaming from knits.
247
 
 
 
251
    
248
252
    :seealso ContentFactory:
249
253
    """
250
254
 
251
255
    def __init__(self, key, parents, build_details, sha1, raw_record,
252
256
        annotated, knit=None, network_bytes=None):
253
257
        """Create a KnitContentFactory for key.
254
 
 
 
258
        
255
259
        :param key: The key.
256
260
        :param parents: The parents.
257
261
        :param build_details: The build details as returned from
301
305
            if self._network_bytes is None:
302
306
                self._create_network_bytes()
303
307
            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
308
        if self._knit is not None:
315
 
            # Not redundant with direct conversion above - that only handles
316
 
            # fulltext cases.
317
309
            if storage_kind == 'chunked':
318
310
                return self._knit.get_lines(self.key[0])
319
311
            elif storage_kind == 'fulltext':
330
322
 
331
323
    def __init__(self, key, parents, generator, first):
332
324
        """Create a LazyKnitContentFactory.
333
 
 
 
325
        
334
326
        :param key: The key of the record.
335
327
        :param parents: The parents of the record.
336
328
        :param generator: A _ContentMapGenerator containing the record for this
411
403
 
412
404
class KnitContent(object):
413
405
    """Content of a knit version to which deltas can be applied.
414
 
 
 
406
    
415
407
    This is always stored in memory as a list of lines with \n at the end,
416
 
    plus a flag saying if the final ending is really there or not, because that
 
408
    plus a flag saying if the final ending is really there or not, because that 
417
409
    corresponds to the on-disk knit representation.
418
410
    """
419
411
 
508
500
 
509
501
class PlainKnitContent(KnitContent):
510
502
    """Unannotated content.
511
 
 
 
503
    
512
504
    When annotate[_iter] is called on this content, the same version is reported
513
505
    for all lines. Generally, annotate[_iter] is not useful on PlainKnitContent
514
506
    objects.
666
658
 
667
659
        see parse_fulltext which this inverts.
668
660
        """
 
661
        # TODO: jam 20070209 We only do the caching thing to make sure that
 
662
        #       the origin is a valid utf-8 line, eventually we could remove it
669
663
        return ['%s %s' % (o, t) for o, t in content._lines]
670
664
 
671
665
    def lower_line_delta(self, delta):
686
680
        content = knit._get_content(key)
687
681
        # adjust for the fact that serialised annotations are only key suffixes
688
682
        # for this factory.
689
 
        if type(key) is tuple:
 
683
        if type(key) == tuple:
690
684
            prefix = key[:-1]
691
685
            origins = content.annotate()
692
686
            result = []
758
752
 
759
753
    def annotate(self, knit, key):
760
754
        annotator = _KnitAnnotator(knit)
761
 
        return annotator.annotate_flat(key)
 
755
        return annotator.annotate(key)
762
756
 
763
757
 
764
758
 
767
761
 
768
762
    This is only functional enough to run interface tests, it doesn't try to
769
763
    provide a full pack environment.
770
 
 
 
764
    
771
765
    :param annotated: knit annotations are wanted.
772
766
    :param mapper: The mapper from keys to paths.
773
767
    """
783
777
 
784
778
    This is only functional enough to run interface tests, it doesn't try to
785
779
    provide a full pack environment.
786
 
 
 
780
    
787
781
    :param graph: Store a graph.
788
782
    :param delta: Delta compress contents.
789
783
    :param keylength: How long should keys be.
820
814
    versioned_files.writer.end()
821
815
 
822
816
 
823
 
def _get_total_build_size(self, keys, positions):
824
 
    """Determine the total bytes to build these keys.
825
 
 
826
 
    (helper function because _KnitGraphIndex and _KndxIndex work the same, but
827
 
    don't inherit from a common base.)
828
 
 
829
 
    :param keys: Keys that we want to build
830
 
    :param positions: dict of {key, (info, index_memo, comp_parent)} (such
831
 
        as returned by _get_components_positions)
832
 
    :return: Number of bytes to build those keys
833
 
    """
834
 
    all_build_index_memos = {}
835
 
    build_keys = keys
836
 
    while build_keys:
837
 
        next_keys = set()
838
 
        for key in build_keys:
839
 
            # This is mostly for the 'stacked' case
840
 
            # Where we will be getting the data from a fallback
841
 
            if key not in positions:
842
 
                continue
843
 
            _, index_memo, compression_parent = positions[key]
844
 
            all_build_index_memos[key] = index_memo
845
 
            if compression_parent not in all_build_index_memos:
846
 
                next_keys.add(compression_parent)
847
 
        build_keys = next_keys
848
 
    return sum([index_memo[2] for index_memo
849
 
                in all_build_index_memos.itervalues()])
850
 
 
851
 
 
852
817
class KnitVersionedFiles(VersionedFiles):
853
818
    """Storage for many versioned files using knit compression.
854
819
 
855
820
    Backend storage is managed by indices and data objects.
856
821
 
857
 
    :ivar _index: A _KnitGraphIndex or similar that can describe the
858
 
        parents, graph, compression and data location of entries in this
859
 
        KnitVersionedFiles.  Note that this is only the index for
 
822
    :ivar _index: A _KnitGraphIndex or similar that can describe the 
 
823
        parents, graph, compression and data location of entries in this 
 
824
        KnitVersionedFiles.  Note that this is only the index for 
860
825
        *this* vfs; if there are fallbacks they must be queried separately.
861
826
    """
862
827
 
909
874
            # indexes can't directly store that, so we give them
910
875
            # an empty tuple instead.
911
876
            parents = ()
912
 
        line_bytes = ''.join(lines)
913
877
        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)
 
878
            parent_texts, left_matching_blocks, nostore_sha, random_id)
931
879
 
932
880
    def _add(self, key, lines, parents, parent_texts,
933
 
        left_matching_blocks, nostore_sha, random_id,
934
 
        line_bytes):
 
881
        left_matching_blocks, nostore_sha, random_id):
935
882
        """Add a set of lines on top of version specified by parents.
936
883
 
937
884
        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
885
        """
949
886
        # first thing, if the content is something we don't need to store, find
950
887
        # that out.
 
888
        line_bytes = ''.join(lines)
951
889
        digest = sha_string(line_bytes)
952
890
        if nostore_sha == digest:
953
891
            raise errors.ExistingContent
974
912
 
975
913
        text_length = len(line_bytes)
976
914
        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:
 
915
        if lines:
 
916
            if lines[-1][-1] != '\n':
 
917
                # copy the contents of lines.
988
918
                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)
 
919
                options.append('no-eol')
 
920
                lines[-1] = lines[-1] + '\n'
 
921
                line_bytes += '\n'
993
922
 
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:
 
923
        for element in key:
 
924
            if type(element) != str:
1000
925
                raise TypeError("key contains non-strings: %r" % (key,))
1001
926
        # Knit hunks are still last-element only
1002
927
        version_id = key[-1]
1003
928
        content = self._factory.make(lines, version_id)
1004
 
        if no_eol:
 
929
        if 'no-eol' in options:
1005
930
            # Hint to the content object that its text() call should strip the
1006
931
            # EOL.
1007
932
            content._should_strip_eol = True
1019
944
        else:
1020
945
            options.append('fulltext')
1021
946
            # isinstance is slower and we have no hierarchy.
1022
 
            if self._factory.__class__ is KnitPlainFactory:
 
947
            if self._factory.__class__ == KnitPlainFactory:
1023
948
                # Use the already joined bytes saving iteration time in
1024
949
                # _record_to_data.
1025
 
                dense_lines = [line_bytes]
1026
 
                if no_eol:
1027
 
                    dense_lines.append('\n')
1028
950
                size, bytes = self._record_to_data(key, digest,
1029
 
                    lines, dense_lines)
 
951
                    lines, [line_bytes])
1030
952
            else:
1031
953
                # get mixed annotation + content and feed it into the
1032
954
                # serialiser.
1044
966
        """See VersionedFiles.annotate."""
1045
967
        return self._factory.annotate(self, key)
1046
968
 
1047
 
    def get_annotator(self):
1048
 
        return _KnitAnnotator(self)
1049
 
 
1050
 
    def check(self, progress_bar=None, keys=None):
 
969
    def check(self, progress_bar=None):
1051
970
        """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
971
        # This doesn't actually test extraction of everything, but that will
1060
972
        # impact 'bzr check' substantially, and needs to be integrated with
1061
973
        # care. However, it does check for the obvious problem of a delta with
1075
987
    def _check_add(self, key, lines, random_id, check_content):
1076
988
        """check that version_id and lines are safe to add."""
1077
989
        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)
 
990
        if contains_whitespace(version_id):
 
991
            raise InvalidRevisionId(version_id, self)
 
992
        self.check_not_reserved_id(version_id)
1082
993
        # TODO: If random_id==False and the key is already present, we should
1083
994
        # probably check that the existing content is identical to what is
1084
995
        # being inserted, and otherwise raise an exception.  This would make
1094
1005
 
1095
1006
    def _check_header_version(self, rec, version_id):
1096
1007
        """Checks the header version on original format knit records.
1097
 
 
 
1008
        
1098
1009
        These have the last component of the key embedded in the record.
1099
1010
        """
1100
1011
        if rec[1] != version_id:
1179
1090
            if missing and not allow_missing:
1180
1091
                raise errors.RevisionNotPresent(missing.pop(), self)
1181
1092
        return component_data
1182
 
 
 
1093
       
1183
1094
    def _get_content(self, key, parent_texts={}):
1184
1095
        """Returns a content object that makes up the specified
1185
1096
        version."""
1192
1103
        generator = _VFContentMapGenerator(self, [key])
1193
1104
        return generator._get_content(key)
1194
1105
 
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
1106
    def get_parent_map(self, keys):
1209
1107
        """Get a map of the graph parents of keys.
1210
1108
 
1239
1137
 
1240
1138
    def _get_record_map(self, keys, allow_missing=False):
1241
1139
        """Produce a dictionary of knit records.
1242
 
 
 
1140
        
1243
1141
        :return: {key:(record, record_details, digest, next)}
1244
1142
            record
1245
1143
                data returned from read_records (a KnitContentobject)
1251
1149
                build-parent of the version, i.e. the leftmost ancestor.
1252
1150
                Will be None if the record is not a delta.
1253
1151
        :param keys: The keys to build a map for
1254
 
        :param allow_missing: If some records are missing, rather than
 
1152
        :param allow_missing: If some records are missing, rather than 
1255
1153
            error, just return the data that could be generated.
1256
1154
        """
1257
1155
        raw_map = self._get_record_map_unparsed(keys,
1260
1158
 
1261
1159
    def _raw_map_to_record_map(self, raw_map):
1262
1160
        """Parse the contents of _get_record_map_unparsed.
1263
 
 
 
1161
        
1264
1162
        :return: see _get_record_map.
1265
1163
        """
1266
1164
        result = {}
1272
1170
 
1273
1171
    def _get_record_map_unparsed(self, keys, allow_missing=False):
1274
1172
        """Get the raw data for reconstructing keys without parsing it.
1275
 
 
 
1173
        
1276
1174
        :return: A dict suitable for parsing via _raw_map_to_record_map.
1277
1175
            key-> raw_bytes, (method, noeol), compression_parent
1278
1176
        """
1291
1189
                # n = next
1292
1190
                records = [(key, i_m) for key, (r, i_m, n)
1293
1191
                                       in position_map.iteritems()]
1294
 
                # Sort by the index memo, so that we request records from the
1295
 
                # same pack file together, and in forward-sorted order
1296
 
                records.sort(key=operator.itemgetter(1))
1297
1192
                raw_record_map = {}
1298
1193
                for key, data in self._read_records_iter_unchecked(records):
1299
1194
                    (record_details, index_memo, next) = position_map[key]
1302
1197
            except errors.RetryWithNewPacks, e:
1303
1198
                self._access.reload_or_raise(e)
1304
1199
 
1305
 
    @classmethod
1306
 
    def _split_by_prefix(cls, keys):
 
1200
    def _split_by_prefix(self, keys):
1307
1201
        """For the given keys, split them up based on their prefix.
1308
1202
 
1309
1203
        To keep memory pressure somewhat under control, split the
1312
1206
        This should be revisited if _get_content_maps() can ever cross
1313
1207
        file-id boundaries.
1314
1208
 
1315
 
        The keys for a given file_id are kept in the same relative order.
1316
 
        Ordering between file_ids is not, though prefix_order will return the
1317
 
        order that the key was first seen.
1318
 
 
1319
1209
        :param keys: An iterable of key tuples
1320
 
        :return: (split_map, prefix_order)
1321
 
            split_map       A dictionary mapping prefix => keys
1322
 
            prefix_order    The order that we saw the various prefixes
 
1210
        :return: A dict of {prefix: [key_list]}
1323
1211
        """
1324
1212
        split_by_prefix = {}
1325
 
        prefix_order = []
1326
1213
        for key in keys:
1327
1214
            if len(key) == 1:
1328
 
                prefix = ''
1329
 
            else:
1330
 
                prefix = key[0]
1331
 
 
1332
 
            if prefix in split_by_prefix:
1333
 
                split_by_prefix[prefix].append(key)
1334
 
            else:
1335
 
                split_by_prefix[prefix] = [key]
1336
 
                prefix_order.append(prefix)
1337
 
        return split_by_prefix, prefix_order
1338
 
 
1339
 
    def _group_keys_for_io(self, keys, non_local_keys, positions,
1340
 
                           _min_buffer_size=_STREAM_MIN_BUFFER_SIZE):
1341
 
        """For the given keys, group them into 'best-sized' requests.
1342
 
 
1343
 
        The idea is to avoid making 1 request per file, but to never try to
1344
 
        unpack an entire 1.5GB source tree in a single pass. Also when
1345
 
        possible, we should try to group requests to the same pack file
1346
 
        together.
1347
 
 
1348
 
        :return: list of (keys, non_local) tuples that indicate what keys
1349
 
            should be fetched next.
1350
 
        """
1351
 
        # TODO: Ideally we would group on 2 factors. We want to extract texts
1352
 
        #       from the same pack file together, and we want to extract all
1353
 
        #       the texts for a given build-chain together. Ultimately it
1354
 
        #       probably needs a better global view.
1355
 
        total_keys = len(keys)
1356
 
        prefix_split_keys, prefix_order = self._split_by_prefix(keys)
1357
 
        prefix_split_non_local_keys, _ = self._split_by_prefix(non_local_keys)
1358
 
        cur_keys = []
1359
 
        cur_non_local = set()
1360
 
        cur_size = 0
1361
 
        result = []
1362
 
        sizes = []
1363
 
        for prefix in prefix_order:
1364
 
            keys = prefix_split_keys[prefix]
1365
 
            non_local = prefix_split_non_local_keys.get(prefix, [])
1366
 
 
1367
 
            this_size = self._index._get_total_build_size(keys, positions)
1368
 
            cur_size += this_size
1369
 
            cur_keys.extend(keys)
1370
 
            cur_non_local.update(non_local)
1371
 
            if cur_size > _min_buffer_size:
1372
 
                result.append((cur_keys, cur_non_local))
1373
 
                sizes.append(cur_size)
1374
 
                cur_keys = []
1375
 
                cur_non_local = set()
1376
 
                cur_size = 0
1377
 
        if cur_keys:
1378
 
            result.append((cur_keys, cur_non_local))
1379
 
            sizes.append(cur_size)
1380
 
        return result
 
1215
                split_by_prefix.setdefault('', []).append(key)
 
1216
            else:
 
1217
                split_by_prefix.setdefault(key[0], []).append(key)
 
1218
        return split_by_prefix
1381
1219
 
1382
1220
    def get_record_stream(self, keys, ordering, include_delta_closure):
1383
1221
        """Get a stream of records for keys.
1396
1234
        if not keys:
1397
1235
            return
1398
1236
        if not self._index.has_graph:
1399
 
            # Cannot sort when no graph has been stored.
 
1237
            # Cannot topological order when no graph has been stored.
1400
1238
            ordering = 'unordered'
1401
1239
 
1402
1240
        remaining_keys = keys
1458
1296
                    needed_from_fallback.add(key)
1459
1297
        # Double index lookups here : need a unified api ?
1460
1298
        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)
 
1299
        if ordering == 'topological':
 
1300
            # Global topological sort
 
1301
            present_keys = tsort.topo_sort(global_map)
1467
1302
            # Now group by source:
1468
1303
            source_keys = []
1469
1304
            current_source = None
1479
1314
        else:
1480
1315
            if ordering != 'unordered':
1481
1316
                raise AssertionError('valid values for ordering are:'
1482
 
                    ' "unordered", "groupcompress" or "topological" not: %r'
 
1317
                    ' "unordered" or "topological" not: %r'
1483
1318
                    % (ordering,))
1484
1319
            # Just group by source; remote sources first.
1485
1320
            present_keys = []
1507
1342
            # XXX: get_content_maps performs its own index queries; allow state
1508
1343
            # to be passed in.
1509
1344
            non_local_keys = needed_from_fallback - absent_keys
1510
 
            for keys, non_local_keys in self._group_keys_for_io(present_keys,
1511
 
                                                                non_local_keys,
1512
 
                                                                positions):
1513
 
                generator = _VFContentMapGenerator(self, keys, non_local_keys,
1514
 
                                                   global_map,
1515
 
                                                   ordering=ordering)
 
1345
            prefix_split_keys = self._split_by_prefix(present_keys)
 
1346
            prefix_split_non_local_keys = self._split_by_prefix(non_local_keys)
 
1347
            for prefix, keys in prefix_split_keys.iteritems():
 
1348
                non_local = prefix_split_non_local_keys.get(prefix, [])
 
1349
                non_local = set(non_local)
 
1350
                generator = _VFContentMapGenerator(self, keys, non_local,
 
1351
                    global_map)
1516
1352
                for record in generator.get_record_stream():
1517
1353
                    yield record
1518
1354
        else:
1520
1356
                if source is parent_maps[0]:
1521
1357
                    # this KnitVersionedFiles
1522
1358
                    records = [(key, positions[key][1]) for key in keys]
1523
 
                    for key, raw_data in self._read_records_iter_unchecked(records):
 
1359
                    for key, raw_data, sha1 in self._read_records_iter_raw(records):
1524
1360
                        (record_details, index_memo, _) = positions[key]
1525
1361
                        yield KnitContentFactory(key, global_map[key],
1526
 
                            record_details, None, raw_data, self._factory.annotated, None)
 
1362
                            record_details, sha1, raw_data, self._factory.annotated, None)
1527
1363
                else:
1528
1364
                    vf = self._fallback_vfs[parent_maps.index(source) - 1]
1529
1365
                    for record in vf.get_record_stream(keys, ordering,
1552
1388
    def insert_record_stream(self, stream):
1553
1389
        """Insert a record stream into this container.
1554
1390
 
1555
 
        :param stream: A stream of records to insert.
 
1391
        :param stream: A stream of records to insert. 
1556
1392
        :return: None
1557
1393
        :seealso VersionedFiles.get_record_stream:
1558
1394
        """
1598
1434
        # key = basis_parent, value = index entry to add
1599
1435
        buffered_index_entries = {}
1600
1436
        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
 
            buffered = False
1609
1437
            parents = record.parents
1610
1438
            if record.storage_kind in delta_types:
1611
1439
                # TODO: eventually the record itself should track
1657
1485
                access_memo = self._access.add_raw_records(
1658
1486
                    [(record.key, len(bytes))], bytes)[0]
1659
1487
                index_entry = (record.key, options, access_memo, parents)
 
1488
                buffered = False
1660
1489
                if 'fulltext' not in options:
1661
1490
                    # Not a fulltext, so we need to make sure the compression
1662
1491
                    # parent will also be present.
1684
1513
                # KnitVersionedFiles doesn't permit deltas (_max_delta_chain ==
1685
1514
                # 0) or because it depends on a base only present in the
1686
1515
                # fallback kvfs.
1687
 
                self._access.flush()
1688
1516
                try:
1689
1517
                    # Try getting a fulltext directly from the record.
1690
1518
                    bytes = record.get_bytes_as('fulltext')
1698
1526
                except errors.RevisionAlreadyPresent:
1699
1527
                    pass
1700
1528
            # Add any records whose basis parent is now available.
1701
 
            if not buffered:
1702
 
                added_keys = [record.key]
1703
 
                while added_keys:
1704
 
                    key = added_keys.pop(0)
1705
 
                    if key in buffered_index_entries:
1706
 
                        index_entries = buffered_index_entries[key]
1707
 
                        self._index.add_records(index_entries)
1708
 
                        added_keys.extend(
1709
 
                            [index_entry[0] for index_entry in index_entries])
1710
 
                        del buffered_index_entries[key]
 
1529
            added_keys = [record.key]
 
1530
            while added_keys:
 
1531
                key = added_keys.pop(0)
 
1532
                if key in buffered_index_entries:
 
1533
                    index_entries = buffered_index_entries[key]
 
1534
                    self._index.add_records(index_entries)
 
1535
                    added_keys.extend(
 
1536
                        [index_entry[0] for index_entry in index_entries])
 
1537
                    del buffered_index_entries[key]
1711
1538
        if buffered_index_entries:
1712
1539
            # There were index entries buffered at the end of the stream,
1713
1540
            # So these need to be added (if the index supports holding such
1714
1541
            # entries for later insertion)
1715
 
            all_entries = []
1716
1542
            for key in buffered_index_entries:
1717
1543
                index_entries = buffered_index_entries[key]
1718
 
                all_entries.extend(index_entries)
1719
 
            self._index.add_records(
1720
 
                all_entries, missing_compression_parents=True)
 
1544
                self._index.add_records(index_entries,
 
1545
                    missing_compression_parents=True)
1721
1546
 
1722
1547
    def get_missing_compression_parent_keys(self):
1723
1548
        """Return an iterable of keys of missing compression parents.
1752
1577
         * If a requested key did not change any lines (or didn't have any
1753
1578
           lines), it may not be mentioned at all in the result.
1754
1579
 
1755
 
        :param pb: Progress bar supplied by caller.
1756
1580
        :return: An iterator over (line, key).
1757
1581
        """
1758
1582
        if pb is None:
1759
 
            pb = ui.ui_factory.nested_progress_bar()
 
1583
            pb = progress.DummyProgress()
1760
1584
        keys = set(keys)
1761
1585
        total = len(keys)
1762
1586
        done = False
1772
1596
                        key_records.append((key, details[0]))
1773
1597
                records_iter = enumerate(self._read_records_iter(key_records))
1774
1598
                for (key_idx, (key, data, sha_value)) in records_iter:
1775
 
                    pb.update('Walking content', key_idx, total)
 
1599
                    pb.update('Walking content.', key_idx, total)
1776
1600
                    compression_parent = build_details[key][1]
1777
1601
                    if compression_parent is None:
1778
1602
                        # fulltext
1779
1603
                        line_iterator = self._factory.get_fulltext_content(data)
1780
1604
                    else:
1781
 
                        # Delta
 
1605
                        # Delta 
1782
1606
                        line_iterator = self._factory.get_linedelta_content(data)
1783
1607
                    # Now that we are yielding the data for this key, remove it
1784
1608
                    # from the list
1795
1619
        # If there are still keys we've not yet found, we look in the fallback
1796
1620
        # vfs, and hope to find them there.  Note that if the keys are found
1797
1621
        # but had no changes or no content, the fallback may not return
1798
 
        # anything.
 
1622
        # anything.  
1799
1623
        if keys and not self._fallback_vfs:
1800
1624
            # XXX: strictly the second parameter is meant to be the file id
1801
1625
            # but it's not easily accessible here.
1808
1632
                source_keys.add(key)
1809
1633
                yield line, key
1810
1634
            keys.difference_update(source_keys)
1811
 
        pb.update('Walking content', total, total)
 
1635
        pb.update('Walking content.', total, total)
1812
1636
 
1813
1637
    def _make_line_delta(self, delta_seq, new_content):
1814
1638
        """Generate a line delta from delta_seq and new_content."""
1823
1647
                           delta=None, annotated=None,
1824
1648
                           left_matching_blocks=None):
1825
1649
        """Merge annotations for content and generate deltas.
1826
 
 
 
1650
        
1827
1651
        This is done by comparing the annotations based on changes to the text
1828
1652
        and generating a delta on the resulting full texts. If annotations are
1829
1653
        not being created then a simple delta is created.
1911
1735
                                 rec[1], record_contents))
1912
1736
        if last_line != 'end %s\n' % rec[1]:
1913
1737
            raise KnitCorrupt(self,
1914
 
                              'unexpected version end line %r, wanted %r'
 
1738
                              'unexpected version end line %r, wanted %r' 
1915
1739
                              % (last_line, rec[1]))
1916
1740
        df.close()
1917
1741
        return rec, record_contents
1934
1758
        if not needed_records:
1935
1759
            return
1936
1760
 
1937
 
        # The transport optimizes the fetching as well
 
1761
        # The transport optimizes the fetching as well 
1938
1762
        # (ie, reads continuous ranges.)
1939
1763
        raw_data = self._access.get_raw_records(
1940
1764
            [index_memo for key, index_memo in needed_records])
1981
1805
 
1982
1806
    def _record_to_data(self, key, digest, lines, dense_lines=None):
1983
1807
        """Convert key, digest, lines into a raw data block.
1984
 
 
 
1808
        
1985
1809
        :param key: The key of the record. Currently keys are always serialised
1986
1810
            using just the trailing component.
1987
1811
        :param dense_lines: The bytes of lines but in a denser form. For
1992
1816
            function spends less time resizing the final string.
1993
1817
        :return: (len, a StringIO instance with the raw data ready to read.)
1994
1818
        """
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))
 
1819
        # Note: using a string copy here increases memory pressure with e.g.
 
1820
        # ISO's, but it is about 3 seconds faster on a 1.2Ghz intel machine
 
1821
        # when doing the initial commit of a mozilla tree. RBC 20070921
 
1822
        bytes = ''.join(chain(
 
1823
            ["version %s %d %s\n" % (key[-1],
 
1824
                                     len(lines),
 
1825
                                     digest)],
 
1826
            dense_lines or lines,
 
1827
            ["end %s\n" % key[-1]]))
 
1828
        if type(bytes) != str:
 
1829
            raise AssertionError(
 
1830
                'data must be plain bytes was %s' % type(bytes))
2002
1831
        if lines and lines[-1][-1] != '\n':
2003
1832
            raise ValueError('corrupt lines value %r' % lines)
2004
 
        compressed_bytes = tuned_gzip.chunks_to_gzip(chunks)
 
1833
        compressed_bytes = tuned_gzip.bytes_to_gzip(bytes)
2005
1834
        return len(compressed_bytes), compressed_bytes
2006
1835
 
2007
1836
    def _split_header(self, line):
2025
1854
class _ContentMapGenerator(object):
2026
1855
    """Generate texts or expose raw deltas for a set of texts."""
2027
1856
 
2028
 
    def __init__(self, ordering='unordered'):
2029
 
        self._ordering = ordering
2030
 
 
2031
1857
    def _get_content(self, key):
2032
1858
        """Get the content object for key."""
2033
1859
        # Note that _get_content is only called when the _ContentMapGenerator
2048
1874
 
2049
1875
    def _work(self):
2050
1876
        """Produce maps of text and KnitContents as dicts.
2051
 
 
 
1877
        
2052
1878
        :return: (text_map, content_map) where text_map contains the texts for
2053
1879
            the requested versions and content_map contains the KnitContents.
2054
1880
        """
2067
1893
            # Loop over fallback repositories asking them for texts - ignore
2068
1894
            # any missing from a particular fallback.
2069
1895
            for record in source.get_record_stream(missing_keys,
2070
 
                self._ordering, True):
 
1896
                'unordered', True):
2071
1897
                if record.storage_kind == 'absent':
2072
1898
                    # Not in thie particular stream, may be in one of the
2073
1899
                    # other fallback vfs objects.
2075
1901
                missing_keys.remove(record.key)
2076
1902
                yield record
2077
1903
 
2078
 
        if self._raw_record_map is None:
2079
 
            raise AssertionError('_raw_record_map should have been filled')
 
1904
        self._raw_record_map = self.vf._get_record_map_unparsed(self.keys,
 
1905
            allow_missing=True)
2080
1906
        first = True
2081
1907
        for key in self.keys:
2082
1908
            if key in self.nonlocal_keys:
2101
1927
                self._raw_record_map)
2102
1928
        record_map = self._record_map
2103
1929
        # raw_record_map is key:
2104
 
        # Have read and parsed records at this point.
 
1930
        # Have read and parsed records at this point. 
2105
1931
        for key in self.keys:
2106
1932
            if key in self.nonlocal_keys:
2107
1933
                # already handled
2205
2031
    """Content map generator reading from a VersionedFiles object."""
2206
2032
 
2207
2033
    def __init__(self, versioned_files, keys, nonlocal_keys=None,
2208
 
        global_map=None, raw_record_map=None, ordering='unordered'):
 
2034
        global_map=None, raw_record_map=None):
2209
2035
        """Create a _ContentMapGenerator.
2210
 
 
 
2036
        
2211
2037
        :param versioned_files: The versioned files that the texts are being
2212
2038
            extracted from.
2213
2039
        :param keys: The keys to produce content maps for.
2219
2045
        :param raw_record_map: A unparsed raw record map to use for answering
2220
2046
            contents.
2221
2047
        """
2222
 
        _ContentMapGenerator.__init__(self, ordering=ordering)
2223
2048
        # The vf to source data from
2224
2049
        self.vf = versioned_files
2225
2050
        # The keys desired
2355
2180
 
2356
2181
    Duplicate entries may be written to the index for a single version id
2357
2182
    if this is done then the latter one completely replaces the former:
2358
 
    this allows updates to correct version and parent information.
 
2183
    this allows updates to correct version and parent information. 
2359
2184
    Note that the two entries may share the delta, and that successive
2360
2185
    annotations and references MUST point to the first entry.
2361
2186
 
2362
2187
    The index file on disc contains a header, followed by one line per knit
2363
2188
    record. The same revision can be present in an index file more than once.
2364
 
    The first occurrence gets assigned a sequence number starting from 0.
2365
 
 
 
2189
    The first occurrence gets assigned a sequence number starting from 0. 
 
2190
    
2366
2191
    The format of a single line is
2367
2192
    REVISION_ID FLAGS BYTE_OFFSET LENGTH( PARENT_ID|PARENT_SEQUENCE_ID)* :\n
2368
2193
    REVISION_ID is a utf8-encoded revision id
2369
 
    FLAGS is a comma separated list of flags about the record. Values include
 
2194
    FLAGS is a comma separated list of flags about the record. Values include 
2370
2195
        no-eol, line-delta, fulltext.
2371
2196
    BYTE_OFFSET is the ascii representation of the byte offset in the data file
2372
 
        that the compressed data starts at.
 
2197
        that the the compressed data starts at.
2373
2198
    LENGTH is the ascii representation of the length of the data file.
2374
2199
    PARENT_ID a utf-8 revision id prefixed by a '.' that is a parent of
2375
2200
        REVISION_ID.
2376
2201
    PARENT_SEQUENCE_ID the ascii representation of the sequence number of a
2377
2202
        revision id already in the knit that is a parent of REVISION_ID.
2378
2203
    The ' :' marker is the end of record marker.
2379
 
 
 
2204
    
2380
2205
    partial writes:
2381
2206
    when a write is interrupted to the index file, it will result in a line
2382
2207
    that does not end in ' :'. If the ' :' is not present at the end of a line,
2409
2234
 
2410
2235
    def add_records(self, records, random_id=False, missing_compression_parents=False):
2411
2236
        """Add multiple records to the index.
2412
 
 
 
2237
        
2413
2238
        :param records: a list of tuples:
2414
2239
                         (key, options, access_memo, parents).
2415
2240
        :param random_id: If True the ids being added were randomly generated
2446
2271
                    line = "\n%s %s %s %s %s :" % (
2447
2272
                        key[-1], ','.join(options), pos, size,
2448
2273
                        self._dictionary_compress(parents))
2449
 
                    if type(line) is not str:
 
2274
                    if type(line) != str:
2450
2275
                        raise AssertionError(
2451
2276
                            'data must be utf8 was %s' % type(line))
2452
2277
                    lines.append(line)
2471
2296
        # Because kndx files do not support atomic insertion via separate index
2472
2297
        # files, they do not support this method.
2473
2298
        raise NotImplementedError(self.get_missing_compression_parents)
2474
 
 
 
2299
    
2475
2300
    def _cache_key(self, key, options, pos, size, parent_keys):
2476
2301
        """Cache a version record in the history array and index cache.
2477
2302
 
2584
2409
        except KeyError:
2585
2410
            raise RevisionNotPresent(key, self)
2586
2411
 
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
2412
    def get_parent_map(self, keys):
2615
2413
        """Get a map of the parents of keys.
2616
2414
 
2637
2435
 
2638
2436
    def get_position(self, key):
2639
2437
        """Return details needed to access the version.
2640
 
 
 
2438
        
2641
2439
        :return: a tuple (key, data position, size) to hand to the access
2642
2440
            logic to get the record.
2643
2441
        """
2647
2445
        return key, entry[2], entry[3]
2648
2446
 
2649
2447
    has_key = _mod_index._has_key_from_parent_map
2650
 
 
 
2448
    
2651
2449
    def _init_index(self, path, extra_lines=[]):
2652
2450
        """Initialize an index."""
2653
2451
        sio = StringIO()
2662
2460
 
2663
2461
    def keys(self):
2664
2462
        """Get all the keys in the collection.
2665
 
 
 
2463
        
2666
2464
        The keys are not ordered.
2667
2465
        """
2668
2466
        result = set()
2669
2467
        # Identify all key prefixes.
2670
2468
        # XXX: A bit hacky, needs polish.
2671
 
        if type(self._mapper) is ConstantMapper:
 
2469
        if type(self._mapper) == ConstantMapper:
2672
2470
            prefixes = [()]
2673
2471
        else:
2674
2472
            relpaths = set()
2681
2479
            for suffix in self._kndx_cache[prefix][1]:
2682
2480
                result.add(prefix + (suffix,))
2683
2481
        return result
2684
 
 
 
2482
    
2685
2483
    def _load_prefixes(self, prefixes):
2686
2484
        """Load the indices for prefixes."""
2687
2485
        self._check_read()
2706
2504
                    del self._history
2707
2505
                except NoSuchFile:
2708
2506
                    self._kndx_cache[prefix] = ({}, [])
2709
 
                    if type(self._mapper) is ConstantMapper:
 
2507
                    if type(self._mapper) == ConstantMapper:
2710
2508
                        # preserve behaviour for revisions.kndx etc.
2711
2509
                        self._init_index(path)
2712
2510
                    del self._cache
2725
2523
 
2726
2524
    def _dictionary_compress(self, keys):
2727
2525
        """Dictionary compress keys.
2728
 
 
 
2526
        
2729
2527
        :param keys: The keys to generate references to.
2730
2528
        :return: A string representation of keys. keys which are present are
2731
2529
            dictionary compressed, and others are emitted as fulltext with a
2779
2577
            return index_memo[0][:-1], index_memo[1]
2780
2578
        return keys.sort(key=get_sort_key)
2781
2579
 
2782
 
    _get_total_build_size = _get_total_build_size
2783
 
 
2784
2580
    def _split_key(self, key):
2785
2581
        """Split key into a prefix and suffix."""
2786
2582
        return key[:-1], key[-1]
2787
2583
 
2788
2584
 
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
2585
class _KnitGraphIndex(object):
2848
2586
    """A KnitVersionedFiles index layered on GraphIndex."""
2849
2587
 
2850
2588
    def __init__(self, graph_index, is_locked, deltas=False, parents=True,
2851
 
        add_callback=None, track_external_parent_refs=False):
 
2589
        add_callback=None):
2852
2590
        """Construct a KnitGraphIndex on a graph_index.
2853
2591
 
2854
2592
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
2855
2593
        :param is_locked: A callback to check whether the object should answer
2856
2594
            queries.
2857
2595
        :param deltas: Allow delta-compressed records.
2858
 
        :param parents: If True, record knits parents, if not do not record
 
2596
        :param parents: If True, record knits parents, if not do not record 
2859
2597
            parents.
2860
2598
        :param add_callback: If not None, allow additions to the index and call
2861
2599
            this callback with a list of added GraphIndex nodes:
2862
2600
            [(node, value, node_refs), ...]
2863
2601
        :param is_locked: A callback, returns True if the index is locked and
2864
2602
            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
2603
        """
2869
2604
        self._add_callback = add_callback
2870
2605
        self._graph_index = graph_index
2878
2613
        self.has_graph = parents
2879
2614
        self._is_locked = is_locked
2880
2615
        self._missing_compression_parents = set()
2881
 
        if track_external_parent_refs:
2882
 
            self._key_dependencies = _KeyRefs()
2883
 
        else:
2884
 
            self._key_dependencies = None
2885
2616
 
2886
2617
    def __repr__(self):
2887
2618
        return "%s(%r)" % (self.__class__.__name__, self._graph_index)
2889
2620
    def add_records(self, records, random_id=False,
2890
2621
        missing_compression_parents=False):
2891
2622
        """Add multiple records to the index.
2892
 
 
 
2623
        
2893
2624
        This function does not insert data into the Immutable GraphIndex
2894
2625
        backing the KnitGraphIndex, instead it prepares data for insertion by
2895
2626
        the caller and checks that it is safe to insert then calls
2911
2642
 
2912
2643
        keys = {}
2913
2644
        compression_parents = set()
2914
 
        key_dependencies = self._key_dependencies
2915
2645
        for (key, options, access_memo, parents) in records:
2916
2646
            if self._parents:
2917
2647
                parents = tuple(parents)
2918
 
                if key_dependencies is not None:
2919
 
                    key_dependencies.add_references(key, parents)
2920
2648
            index, pos, size = access_memo
2921
2649
            if 'no-eol' in options:
2922
2650
                value = 'N'
2946
2674
        if not random_id:
2947
2675
            present_nodes = self._get_entries(keys)
2948
2676
            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
2677
                if (value[0] != keys[key][0][0] or
2954
 
                    parents != passed_parents):
2955
 
                    node_refs = static_tuple.as_tuples(node_refs)
 
2678
                    node_refs[:1] != keys[key][1][:1]):
2956
2679
                    raise KnitCorrupt(self, "inconsistent details in add_records"
2957
 
                        ": %s %s" % ((value, node_refs), passed))
 
2680
                        ": %s %s" % ((value, node_refs), keys[key]))
2958
2681
                del keys[key]
2959
2682
        result = []
2960
2683
        if self._parents:
2975
2698
            self._missing_compression_parents.update(compression_parents)
2976
2699
        # Adding records may have satisfied missing compression parents.
2977
2700
        self._missing_compression_parents.difference_update(keys)
2978
 
 
 
2701
        
2979
2702
    def scan_unvalidated_index(self, graph_index):
2980
2703
        """Inform this _KnitGraphIndex that there is an unvalidated index.
2981
2704
 
2989
2712
            new_missing = graph_index.external_references(ref_list_num=1)
2990
2713
            new_missing.difference_update(self.get_parent_map(new_missing))
2991
2714
            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
2715
 
2998
2716
    def get_missing_compression_parents(self):
2999
2717
        """Return the keys of missing compression parents.
3003
2721
        """
3004
2722
        return frozenset(self._missing_compression_parents)
3005
2723
 
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
2724
    def _check_read(self):
3016
2725
        """raise if reads are not permitted."""
3017
2726
        if not self._is_locked():
3077
2786
 
3078
2787
    def _get_entries(self, keys, check_present=False):
3079
2788
        """Get the entries for keys.
3080
 
 
 
2789
        
3081
2790
        :param keys: An iterable of index key tuples.
3082
2791
        """
3083
2792
        keys = set(keys)
3125
2834
            options.append('no-eol')
3126
2835
        return options
3127
2836
 
3128
 
    def find_ancestry(self, keys):
3129
 
        """See CombinedGraphIndex.find_ancestry()"""
3130
 
        return self._graph_index.find_ancestry(keys, 0)
3131
 
 
3132
2837
    def get_parent_map(self, keys):
3133
2838
        """Get a map of the parents of keys.
3134
2839
 
3149
2854
 
3150
2855
    def get_position(self, key):
3151
2856
        """Return details needed to access the version.
3152
 
 
 
2857
        
3153
2858
        :return: a tuple (index, data position, size) to hand to the access
3154
2859
            logic to get the record.
3155
2860
        """
3160
2865
 
3161
2866
    def keys(self):
3162
2867
        """Get all the keys in the collection.
3163
 
 
 
2868
        
3164
2869
        The keys are not ordered.
3165
2870
        """
3166
2871
        self._check_read()
3167
2872
        return [node[1] for node in self._graph_index.iter_all_entries()]
3168
 
 
 
2873
    
3169
2874
    missing_keys = _mod_index._missing_keys_from_parent_map
3170
2875
 
3171
2876
    def _node_to_position(self, node):
3193
2898
            return positions[key][1]
3194
2899
        return keys.sort(key=get_index_memo)
3195
2900
 
3196
 
    _get_total_build_size = _get_total_build_size
3197
 
 
3198
2901
 
3199
2902
class _KnitKeyAccess(object):
3200
2903
    """Access to records in .knit files."""
3221
2924
            opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3222
2925
            length), where the key is the record key.
3223
2926
        """
3224
 
        if type(raw_data) is not str:
 
2927
        if type(raw_data) != str:
3225
2928
            raise AssertionError(
3226
2929
                'data must be plain bytes was %s' % type(raw_data))
3227
2930
        result = []
3244
2947
            result.append((key, base, size))
3245
2948
        return result
3246
2949
 
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
2950
    def get_raw_records(self, memos_for_retrieval):
3255
2951
        """Get the raw bytes for a records.
3256
2952
 
3281
2977
class _DirectPackAccess(object):
3282
2978
    """Access to data in one or more packs with less translation."""
3283
2979
 
3284
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
 
2980
    def __init__(self, index_to_packs, reload_func=None):
3285
2981
        """Create a _DirectPackAccess object.
3286
2982
 
3287
2983
        :param index_to_packs: A dict mapping index objects to the transport
3294
2990
        self._write_index = None
3295
2991
        self._indices = index_to_packs
3296
2992
        self._reload_func = reload_func
3297
 
        self._flush_func = flush_func
3298
2993
 
3299
2994
    def add_raw_records(self, key_sizes, raw_data):
3300
2995
        """Add raw knit bytes to a storage area.
3310
3005
            length), where the index field is the write_index object supplied
3311
3006
            to the PackAccess object.
3312
3007
        """
3313
 
        if type(raw_data) is not str:
 
3008
        if type(raw_data) != str:
3314
3009
            raise AssertionError(
3315
3010
                'data must be plain bytes was %s' % type(raw_data))
3316
3011
        result = []
3322
3017
            result.append((self._write_index, p_offset, p_length))
3323
3018
        return result
3324
3019
 
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
3020
    def get_raw_records(self, memos_for_retrieval):
3334
3021
        """Get the raw bytes for a records.
3335
3022
 
3336
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
 
3023
        :param memos_for_retrieval: An iterable containing the (index, pos, 
3337
3024
            length) memo for retrieving the bytes. The Pack access method
3338
3025
            looks up the pack to use for a given record in its index_to_pack
3339
3026
            map.
3429
3116
    recommended.
3430
3117
    """
3431
3118
    annotator = _KnitAnnotator(knit)
3432
 
    return iter(annotator.annotate_flat(revision_id))
3433
 
 
3434
 
 
3435
 
class _KnitAnnotator(annotate.Annotator):
 
3119
    return iter(annotator.annotate(revision_id))
 
3120
 
 
3121
 
 
3122
class _KnitAnnotator(object):
3436
3123
    """Build up the annotations for a text."""
3437
3124
 
3438
 
    def __init__(self, vf):
3439
 
        annotate.Annotator.__init__(self, vf)
3440
 
 
3441
 
        # TODO: handle Nodes which cannot be extracted
3442
 
        # self._ghosts = set()
3443
 
 
3444
 
        # Map from (key, parent_key) => matching_blocks, should be 'use once'
3445
 
        self._matching_blocks = {}
3446
 
 
3447
 
        # KnitContent objects
3448
 
        self._content_objects = {}
3449
 
        # The number of children that depend on this fulltext content object
3450
 
        self._num_compression_children = {}
3451
 
        # Delta records that need their compression parent before they can be
3452
 
        # expanded
3453
 
        self._pending_deltas = {}
3454
 
        # Fulltext records that are waiting for their parents fulltexts before
3455
 
        # they can be yielded for annotation
3456
 
        self._pending_annotation = {}
 
3125
    def __init__(self, knit):
 
3126
        self._knit = knit
 
3127
 
 
3128
        # Content objects, differs from fulltexts because of how final newlines
 
3129
        # are treated by knits. the content objects here will always have a
 
3130
        # final newline
 
3131
        self._fulltext_contents = {}
 
3132
 
 
3133
        # Annotated lines of specific revisions
 
3134
        self._annotated_lines = {}
 
3135
 
 
3136
        # Track the raw data for nodes that we could not process yet.
 
3137
        # This maps the revision_id of the base to a list of children that will
 
3138
        # annotated from it.
 
3139
        self._pending_children = {}
 
3140
 
 
3141
        # Nodes which cannot be extracted
 
3142
        self._ghosts = set()
 
3143
 
 
3144
        # Track how many children this node has, so we know if we need to keep
 
3145
        # it
 
3146
        self._annotate_children = {}
 
3147
        self._compression_children = {}
3457
3148
 
3458
3149
        self._all_build_details = {}
 
3150
        # The children => parent revision_id graph
 
3151
        self._revision_id_graph = {}
 
3152
 
 
3153
        self._heads_provider = None
 
3154
 
 
3155
        self._nodes_to_keep_annotations = set()
 
3156
        self._generations_until_keep = 100
 
3157
 
 
3158
    def set_generations_until_keep(self, value):
 
3159
        """Set the number of generations before caching a node.
 
3160
 
 
3161
        Setting this to -1 will cache every merge node, setting this higher
 
3162
        will cache fewer nodes.
 
3163
        """
 
3164
        self._generations_until_keep = value
 
3165
 
 
3166
    def _add_fulltext_content(self, revision_id, content_obj):
 
3167
        self._fulltext_contents[revision_id] = content_obj
 
3168
        # TODO: jam 20080305 It might be good to check the sha1digest here
 
3169
        return content_obj.text()
 
3170
 
 
3171
    def _check_parents(self, child, nodes_to_annotate):
 
3172
        """Check if all parents have been processed.
 
3173
 
 
3174
        :param child: A tuple of (rev_id, parents, raw_content)
 
3175
        :param nodes_to_annotate: If child is ready, add it to
 
3176
            nodes_to_annotate, otherwise put it back in self._pending_children
 
3177
        """
 
3178
        for parent_id in child[1]:
 
3179
            if (parent_id not in self._annotated_lines):
 
3180
                # This parent is present, but another parent is missing
 
3181
                self._pending_children.setdefault(parent_id,
 
3182
                                                  []).append(child)
 
3183
                break
 
3184
        else:
 
3185
            # This one is ready to be processed
 
3186
            nodes_to_annotate.append(child)
 
3187
 
 
3188
    def _add_annotation(self, revision_id, fulltext, parent_ids,
 
3189
                        left_matching_blocks=None):
 
3190
        """Add an annotation entry.
 
3191
 
 
3192
        All parents should already have been annotated.
 
3193
        :return: A list of children that now have their parents satisfied.
 
3194
        """
 
3195
        a = self._annotated_lines
 
3196
        annotated_parent_lines = [a[p] for p in parent_ids]
 
3197
        annotated_lines = list(annotate.reannotate(annotated_parent_lines,
 
3198
            fulltext, revision_id, left_matching_blocks,
 
3199
            heads_provider=self._get_heads_provider()))
 
3200
        self._annotated_lines[revision_id] = annotated_lines
 
3201
        for p in parent_ids:
 
3202
            ann_children = self._annotate_children[p]
 
3203
            ann_children.remove(revision_id)
 
3204
            if (not ann_children
 
3205
                and p not in self._nodes_to_keep_annotations):
 
3206
                del self._annotated_lines[p]
 
3207
                del self._all_build_details[p]
 
3208
                if p in self._fulltext_contents:
 
3209
                    del self._fulltext_contents[p]
 
3210
        # Now that we've added this one, see if there are any pending
 
3211
        # deltas to be done, certainly this parent is finished
 
3212
        nodes_to_annotate = []
 
3213
        for child in self._pending_children.pop(revision_id, []):
 
3214
            self._check_parents(child, nodes_to_annotate)
 
3215
        return nodes_to_annotate
3459
3216
 
3460
3217
    def _get_build_graph(self, key):
3461
3218
        """Get the graphs for building texts and annotations.
3466
3223
        fulltext.)
3467
3224
 
3468
3225
        :return: A list of (key, index_memo) records, suitable for
3469
 
            passing to read_records_iter to start reading in the raw data from
 
3226
            passing to read_records_iter to start reading in the raw data fro/
3470
3227
            the pack file.
3471
3228
        """
 
3229
        if key in self._annotated_lines:
 
3230
            # Nothing to do
 
3231
            return []
3472
3232
        pending = set([key])
3473
3233
        records = []
3474
 
        ann_keys = set()
3475
 
        self._num_needed_children[key] = 1
 
3234
        generation = 0
 
3235
        kept_generation = 0
3476
3236
        while pending:
3477
3237
            # get all pending nodes
 
3238
            generation += 1
3478
3239
            this_iteration = pending
3479
 
            build_details = self._vf._index.get_build_details(this_iteration)
 
3240
            build_details = self._knit._index.get_build_details(this_iteration)
3480
3241
            self._all_build_details.update(build_details)
3481
 
            # new_nodes = self._vf._index._get_entries(this_iteration)
 
3242
            # new_nodes = self._knit._index._get_entries(this_iteration)
3482
3243
            pending = set()
3483
3244
            for key, details in build_details.iteritems():
3484
 
                (index_memo, compression_parent, parent_keys,
 
3245
                (index_memo, compression_parent, parents,
3485
3246
                 record_details) = details
3486
 
                self._parent_map[key] = parent_keys
3487
 
                self._heads_provider = None
 
3247
                self._revision_id_graph[key] = parents
3488
3248
                records.append((key, index_memo))
3489
3249
                # Do we actually need to check _annotated_lines?
3490
 
                pending.update([p for p in parent_keys
3491
 
                                   if p not in self._all_build_details])
3492
 
                if parent_keys:
3493
 
                    for parent_key in parent_keys:
3494
 
                        if parent_key in self._num_needed_children:
3495
 
                            self._num_needed_children[parent_key] += 1
3496
 
                        else:
3497
 
                            self._num_needed_children[parent_key] = 1
 
3250
                pending.update(p for p in parents
 
3251
                                 if p not in self._all_build_details)
3498
3252
                if compression_parent:
3499
 
                    if compression_parent in self._num_compression_children:
3500
 
                        self._num_compression_children[compression_parent] += 1
3501
 
                    else:
3502
 
                        self._num_compression_children[compression_parent] = 1
 
3253
                    self._compression_children.setdefault(compression_parent,
 
3254
                        []).append(key)
 
3255
                if parents:
 
3256
                    for parent in parents:
 
3257
                        self._annotate_children.setdefault(parent,
 
3258
                            []).append(key)
 
3259
                    num_gens = generation - kept_generation
 
3260
                    if ((num_gens >= self._generations_until_keep)
 
3261
                        and len(parents) > 1):
 
3262
                        kept_generation = generation
 
3263
                        self._nodes_to_keep_annotations.add(key)
3503
3264
 
3504
3265
            missing_versions = this_iteration.difference(build_details.keys())
3505
 
            if missing_versions:
3506
 
                for key in missing_versions:
3507
 
                    if key in self._parent_map and key in self._text_cache:
3508
 
                        # We already have this text ready, we just need to
3509
 
                        # yield it later so we get it annotated
3510
 
                        ann_keys.add(key)
3511
 
                        parent_keys = self._parent_map[key]
3512
 
                        for parent_key in parent_keys:
3513
 
                            if parent_key in self._num_needed_children:
3514
 
                                self._num_needed_children[parent_key] += 1
3515
 
                            else:
3516
 
                                self._num_needed_children[parent_key] = 1
3517
 
                        pending.update([p for p in parent_keys
3518
 
                                           if p not in self._all_build_details])
3519
 
                    else:
3520
 
                        raise errors.RevisionNotPresent(key, self._vf)
 
3266
            self._ghosts.update(missing_versions)
 
3267
            for missing_version in missing_versions:
 
3268
                # add a key, no parents
 
3269
                self._revision_id_graph[missing_version] = ()
 
3270
                pending.discard(missing_version) # don't look for it
 
3271
        if self._ghosts.intersection(self._compression_children):
 
3272
            raise KnitCorrupt(
 
3273
                "We cannot have nodes which have a ghost compression parent:\n"
 
3274
                "ghosts: %r\n"
 
3275
                "compression children: %r"
 
3276
                % (self._ghosts, self._compression_children))
 
3277
        # Cleanout anything that depends on a ghost so that we don't wait for
 
3278
        # the ghost to show up
 
3279
        for node in self._ghosts:
 
3280
            if node in self._annotate_children:
 
3281
                # We won't be building this node
 
3282
                del self._annotate_children[node]
3521
3283
        # Generally we will want to read the records in reverse order, because
3522
3284
        # we find the parent nodes after the children
3523
3285
        records.reverse()
3524
 
        return records, ann_keys
3525
 
 
3526
 
    def _get_needed_texts(self, key, pb=None):
3527
 
        # if True or len(self._vf._fallback_vfs) > 0:
3528
 
        if len(self._vf._fallback_vfs) > 0:
3529
 
            # If we have fallbacks, go to the generic path
3530
 
            for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3531
 
                yield v
3532
 
            return
3533
 
        while True:
3534
 
            try:
3535
 
                records, ann_keys = self._get_build_graph(key)
3536
 
                for idx, (sub_key, text, num_lines) in enumerate(
3537
 
                                                self._extract_texts(records)):
3538
 
                    if pb is not None:
3539
 
                        pb.update('annotating', idx, len(records))
3540
 
                    yield sub_key, text, num_lines
3541
 
                for sub_key in ann_keys:
3542
 
                    text = self._text_cache[sub_key]
3543
 
                    num_lines = len(text) # bad assumption
3544
 
                    yield sub_key, text, num_lines
3545
 
                return
3546
 
            except errors.RetryWithNewPacks, e:
3547
 
                self._vf._access.reload_or_raise(e)
3548
 
                # The cached build_details are no longer valid
3549
 
                self._all_build_details.clear()
3550
 
 
3551
 
    def _cache_delta_blocks(self, key, compression_parent, delta, lines):
3552
 
        parent_lines = self._text_cache[compression_parent]
3553
 
        blocks = list(KnitContent.get_line_delta_blocks(delta, parent_lines, lines))
3554
 
        self._matching_blocks[(key, compression_parent)] = blocks
3555
 
 
3556
 
    def _expand_record(self, key, parent_keys, compression_parent, record,
3557
 
                       record_details):
3558
 
        delta = None
3559
 
        if compression_parent:
3560
 
            if compression_parent not in self._content_objects:
3561
 
                # Waiting for the parent
3562
 
                self._pending_deltas.setdefault(compression_parent, []).append(
3563
 
                    (key, parent_keys, record, record_details))
3564
 
                return None
3565
 
            # We have the basis parent, so expand the delta
3566
 
            num = self._num_compression_children[compression_parent]
3567
 
            num -= 1
3568
 
            if num == 0:
3569
 
                base_content = self._content_objects.pop(compression_parent)
3570
 
                self._num_compression_children.pop(compression_parent)
3571
 
            else:
3572
 
                self._num_compression_children[compression_parent] = num
3573
 
                base_content = self._content_objects[compression_parent]
3574
 
            # It is tempting to want to copy_base_content=False for the last
3575
 
            # child object. However, whenever noeol=False,
3576
 
            # self._text_cache[parent_key] is content._lines. So mutating it
3577
 
            # gives very bad results.
3578
 
            # The alternative is to copy the lines into text cache, but then we
3579
 
            # are copying anyway, so just do it here.
3580
 
            content, delta = self._vf._factory.parse_record(
3581
 
                key, record, record_details, base_content,
3582
 
                copy_base_content=True)
3583
 
        else:
3584
 
            # Fulltext record
3585
 
            content, _ = self._vf._factory.parse_record(
3586
 
                key, record, record_details, None)
3587
 
        if self._num_compression_children.get(key, 0) > 0:
3588
 
            self._content_objects[key] = content
3589
 
        lines = content.text()
3590
 
        self._text_cache[key] = lines
3591
 
        if delta is not None:
3592
 
            self._cache_delta_blocks(key, compression_parent, delta, lines)
3593
 
        return lines
3594
 
 
3595
 
    def _get_parent_annotations_and_matches(self, key, text, parent_key):
3596
 
        """Get the list of annotations for the parent, and the matching lines.
3597
 
 
3598
 
        :param text: The opaque value given by _get_needed_texts
3599
 
        :param parent_key: The key for the parent text
3600
 
        :return: (parent_annotations, matching_blocks)
3601
 
            parent_annotations is a list as long as the number of lines in
3602
 
                parent
3603
 
            matching_blocks is a list of (parent_idx, text_idx, len) tuples
3604
 
                indicating which lines match between the two texts
3605
 
        """
3606
 
        block_key = (key, parent_key)
3607
 
        if block_key in self._matching_blocks:
3608
 
            blocks = self._matching_blocks.pop(block_key)
3609
 
            parent_annotations = self._annotations_cache[parent_key]
3610
 
            return parent_annotations, blocks
3611
 
        return annotate.Annotator._get_parent_annotations_and_matches(self,
3612
 
            key, text, parent_key)
3613
 
 
3614
 
    def _process_pending(self, key):
3615
 
        """The content for 'key' was just processed.
3616
 
 
3617
 
        Determine if there is any more pending work to be processed.
3618
 
        """
3619
 
        to_return = []
3620
 
        if key in self._pending_deltas:
3621
 
            compression_parent = key
3622
 
            children = self._pending_deltas.pop(key)
3623
 
            for child_key, parent_keys, record, record_details in children:
3624
 
                lines = self._expand_record(child_key, parent_keys,
3625
 
                                            compression_parent,
3626
 
                                            record, record_details)
3627
 
                if self._check_ready_for_annotations(child_key, parent_keys):
3628
 
                    to_return.append(child_key)
3629
 
        # Also check any children that are waiting for this parent to be
3630
 
        # annotation ready
3631
 
        if key in self._pending_annotation:
3632
 
            children = self._pending_annotation.pop(key)
3633
 
            to_return.extend([c for c, p_keys in children
3634
 
                              if self._check_ready_for_annotations(c, p_keys)])
3635
 
        return to_return
3636
 
 
3637
 
    def _check_ready_for_annotations(self, key, parent_keys):
3638
 
        """return true if this text is ready to be yielded.
3639
 
 
3640
 
        Otherwise, this will return False, and queue the text into
3641
 
        self._pending_annotation
3642
 
        """
3643
 
        for parent_key in parent_keys:
3644
 
            if parent_key not in self._annotations_cache:
3645
 
                # still waiting on at least one parent text, so queue it up
3646
 
                # Note that if there are multiple parents, we need to wait
3647
 
                # for all of them.
3648
 
                self._pending_annotation.setdefault(parent_key,
3649
 
                    []).append((key, parent_keys))
3650
 
                return False
3651
 
        return True
3652
 
 
3653
 
    def _extract_texts(self, records):
3654
 
        """Extract the various texts needed based on records"""
 
3286
        return records
 
3287
 
 
3288
    def _annotate_records(self, records):
 
3289
        """Build the annotations for the listed records."""
3655
3290
        # We iterate in the order read, rather than a strict order requested
3656
3291
        # However, process what we can, and put off to the side things that
3657
3292
        # still need parents, cleaning them up when those parents are
3658
3293
        # processed.
3659
 
        # Basic data flow:
3660
 
        #   1) As 'records' are read, see if we can expand these records into
3661
 
        #      Content objects (and thus lines)
3662
 
        #   2) If a given line-delta is waiting on its compression parent, it
3663
 
        #      gets queued up into self._pending_deltas, otherwise we expand
3664
 
        #      it, and put it into self._text_cache and self._content_objects
3665
 
        #   3) If we expanded the text, we will then check to see if all
3666
 
        #      parents have also been processed. If so, this text gets yielded,
3667
 
        #      else this record gets set aside into pending_annotation
3668
 
        #   4) Further, if we expanded the text in (2), we will then check to
3669
 
        #      see if there are any children in self._pending_deltas waiting to
3670
 
        #      also be processed. If so, we go back to (2) for those
3671
 
        #   5) Further again, if we yielded the text, we can then check if that
3672
 
        #      'unlocks' any of the texts in pending_annotations, which should
3673
 
        #      then get yielded as well
3674
 
        # Note that both steps 4 and 5 are 'recursive' in that unlocking one
3675
 
        # compression child could unlock yet another, and yielding a fulltext
3676
 
        # will also 'unlock' the children that are waiting on that annotation.
3677
 
        # (Though also, unlocking 1 parent's fulltext, does not unlock a child
3678
 
        # if other parents are also waiting.)
3679
 
        # We want to yield content before expanding child content objects, so
3680
 
        # that we know when we can re-use the content lines, and the annotation
3681
 
        # code can know when it can stop caching fulltexts, as well.
3682
 
 
3683
 
        # Children that are missing their compression parent
3684
 
        pending_deltas = {}
3685
 
        for (key, record, digest) in self._vf._read_records_iter(records):
3686
 
            # ghosts?
3687
 
            details = self._all_build_details[key]
3688
 
            (_, compression_parent, parent_keys, record_details) = details
3689
 
            lines = self._expand_record(key, parent_keys, compression_parent,
3690
 
                                        record, record_details)
3691
 
            if lines is None:
3692
 
                # Pending delta should be queued up
 
3294
        for (rev_id, record,
 
3295
             digest) in self._knit._read_records_iter(records):
 
3296
            if rev_id in self._annotated_lines:
3693
3297
                continue
3694
 
            # At this point, we may be able to yield this content, if all
3695
 
            # parents are also finished
3696
 
            yield_this_text = self._check_ready_for_annotations(key,
3697
 
                                                                parent_keys)
3698
 
            if yield_this_text:
3699
 
                # All parents present
3700
 
                yield key, lines, len(lines)
3701
 
            to_process = self._process_pending(key)
3702
 
            while to_process:
3703
 
                this_process = to_process
3704
 
                to_process = []
3705
 
                for key in this_process:
3706
 
                    lines = self._text_cache[key]
3707
 
                    yield key, lines, len(lines)
3708
 
                    to_process.extend(self._process_pending(key))
 
3298
            parent_ids = self._revision_id_graph[rev_id]
 
3299
            parent_ids = [p for p in parent_ids if p not in self._ghosts]
 
3300
            details = self._all_build_details[rev_id]
 
3301
            (index_memo, compression_parent, parents,
 
3302
             record_details) = details
 
3303
            nodes_to_annotate = []
 
3304
            # TODO: Remove the punning between compression parents, and
 
3305
            #       parent_ids, we should be able to do this without assuming
 
3306
            #       the build order
 
3307
            if len(parent_ids) == 0:
 
3308
                # There are no parents for this node, so just add it
 
3309
                # TODO: This probably needs to be decoupled
 
3310
                fulltext_content, delta = self._knit._factory.parse_record(
 
3311
                    rev_id, record, record_details, None)
 
3312
                fulltext = self._add_fulltext_content(rev_id, fulltext_content)
 
3313
                nodes_to_annotate.extend(self._add_annotation(rev_id, fulltext,
 
3314
                    parent_ids, left_matching_blocks=None))
 
3315
            else:
 
3316
                child = (rev_id, parent_ids, record)
 
3317
                # Check if all the parents are present
 
3318
                self._check_parents(child, nodes_to_annotate)
 
3319
            while nodes_to_annotate:
 
3320
                # Should we use a queue here instead of a stack?
 
3321
                (rev_id, parent_ids, record) = nodes_to_annotate.pop()
 
3322
                (index_memo, compression_parent, parents,
 
3323
                 record_details) = self._all_build_details[rev_id]
 
3324
                blocks = None
 
3325
                if compression_parent is not None:
 
3326
                    comp_children = self._compression_children[compression_parent]
 
3327
                    if rev_id not in comp_children:
 
3328
                        raise AssertionError("%r not in compression children %r"
 
3329
                            % (rev_id, comp_children))
 
3330
                    # If there is only 1 child, it is safe to reuse this
 
3331
                    # content
 
3332
                    reuse_content = (len(comp_children) == 1
 
3333
                        and compression_parent not in
 
3334
                            self._nodes_to_keep_annotations)
 
3335
                    if reuse_content:
 
3336
                        # Remove it from the cache since it will be changing
 
3337
                        parent_fulltext_content = self._fulltext_contents.pop(compression_parent)
 
3338
                        # Make sure to copy the fulltext since it might be
 
3339
                        # modified
 
3340
                        parent_fulltext = list(parent_fulltext_content.text())
 
3341
                    else:
 
3342
                        parent_fulltext_content = self._fulltext_contents[compression_parent]
 
3343
                        parent_fulltext = parent_fulltext_content.text()
 
3344
                    comp_children.remove(rev_id)
 
3345
                    fulltext_content, delta = self._knit._factory.parse_record(
 
3346
                        rev_id, record, record_details,
 
3347
                        parent_fulltext_content,
 
3348
                        copy_base_content=(not reuse_content))
 
3349
                    fulltext = self._add_fulltext_content(rev_id,
 
3350
                                                          fulltext_content)
 
3351
                    if compression_parent == parent_ids[0]:
 
3352
                        # the compression_parent is the left parent, so we can
 
3353
                        # re-use the delta
 
3354
                        blocks = KnitContent.get_line_delta_blocks(delta,
 
3355
                                parent_fulltext, fulltext)
 
3356
                else:
 
3357
                    fulltext_content = self._knit._factory.parse_fulltext(
 
3358
                        record, rev_id)
 
3359
                    fulltext = self._add_fulltext_content(rev_id,
 
3360
                        fulltext_content)
 
3361
                nodes_to_annotate.extend(
 
3362
                    self._add_annotation(rev_id, fulltext, parent_ids,
 
3363
                                     left_matching_blocks=blocks))
 
3364
 
 
3365
    def _get_heads_provider(self):
 
3366
        """Create a heads provider for resolving ancestry issues."""
 
3367
        if self._heads_provider is not None:
 
3368
            return self._heads_provider
 
3369
        parent_provider = _mod_graph.DictParentsProvider(
 
3370
            self._revision_id_graph)
 
3371
        graph_obj = _mod_graph.Graph(parent_provider)
 
3372
        head_cache = _mod_graph.FrozenHeadsCache(graph_obj)
 
3373
        self._heads_provider = head_cache
 
3374
        return head_cache
 
3375
 
 
3376
    def annotate(self, key):
 
3377
        """Return the annotated fulltext at the given key.
 
3378
 
 
3379
        :param key: The key to annotate.
 
3380
        """
 
3381
        if len(self._knit._fallback_vfs) > 0:
 
3382
            # stacked knits can't use the fast path at present.
 
3383
            return self._simple_annotate(key)
 
3384
        while True:
 
3385
            try:
 
3386
                records = self._get_build_graph(key)
 
3387
                if key in self._ghosts:
 
3388
                    raise errors.RevisionNotPresent(key, self._knit)
 
3389
                self._annotate_records(records)
 
3390
                return self._annotated_lines[key]
 
3391
            except errors.RetryWithNewPacks, e:
 
3392
                self._knit._access.reload_or_raise(e)
 
3393
                # The cached build_details are no longer valid
 
3394
                self._all_build_details.clear()
 
3395
 
 
3396
    def _simple_annotate(self, key):
 
3397
        """Return annotated fulltext, rediffing from the full texts.
 
3398
 
 
3399
        This is slow but makes no assumptions about the repository
 
3400
        being able to produce line deltas.
 
3401
        """
 
3402
        # TODO: this code generates a parent maps of present ancestors; it
 
3403
        # could be split out into a separate method, and probably should use
 
3404
        # iter_ancestry instead. -- mbp and robertc 20080704
 
3405
        graph = _mod_graph.Graph(self._knit)
 
3406
        head_cache = _mod_graph.FrozenHeadsCache(graph)
 
3407
        search = graph._make_breadth_first_searcher([key])
 
3408
        keys = set()
 
3409
        while True:
 
3410
            try:
 
3411
                present, ghosts = search.next_with_ghosts()
 
3412
            except StopIteration:
 
3413
                break
 
3414
            keys.update(present)
 
3415
        parent_map = self._knit.get_parent_map(keys)
 
3416
        parent_cache = {}
 
3417
        reannotate = annotate.reannotate
 
3418
        for record in self._knit.get_record_stream(keys, 'topological', True):
 
3419
            key = record.key
 
3420
            fulltext = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
 
3421
            parents = parent_map[key]
 
3422
            if parents is not None:
 
3423
                parent_lines = [parent_cache[parent] for parent in parent_map[key]]
 
3424
            else:
 
3425
                parent_lines = []
 
3426
            parent_cache[key] = list(
 
3427
                reannotate(parent_lines, fulltext, key, None, head_cache))
 
3428
        try:
 
3429
            return parent_cache[key]
 
3430
        except KeyError, e:
 
3431
            raise errors.RevisionNotPresent(key, self._knit)
 
3432
 
3709
3433
 
3710
3434
try:
3711
 
    from bzrlib._knit_load_data_pyx import _load_data_c as _load_data
3712
 
except ImportError, e:
3713
 
    osutils.failed_to_load_extension(e)
 
3435
    from bzrlib._knit_load_data_c import _load_data_c as _load_data
 
3436
except ImportError:
3714
3437
    from bzrlib._knit_load_data_py import _load_data_py as _load_data