~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/chk_map.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 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
26
26
 
27
27
Updates to a CHKMap are done preferentially via the apply_delta method, to
28
28
allow optimisation of the update operation; but individual map/unmap calls are
29
 
possible and supported. Individual changes via map/unmap are buffered in memory
30
 
until the _save method is called to force serialisation of the tree.
31
 
apply_delta records its changes immediately by performing an implicit _save.
 
29
possible and supported. All changes via map/unmap are buffered in memory until
 
30
the _save method is called to force serialisation of the tree. apply_delta
 
31
performs a _save implicitly.
32
32
 
33
33
TODO:
34
34
-----
38
38
"""
39
39
 
40
40
import heapq
41
 
import threading
 
41
import time
42
42
 
43
43
from bzrlib import lazy_import
44
44
lazy_import.lazy_import(globals(), """
 
45
from bzrlib import versionedfile
 
46
""")
45
47
from bzrlib import (
46
48
    errors,
47
 
    versionedfile,
48
 
    )
49
 
""")
50
 
from bzrlib import (
51
49
    lru_cache,
52
50
    osutils,
53
51
    registry,
54
 
    static_tuple,
55
52
    trace,
56
53
    )
57
 
from bzrlib.static_tuple import StaticTuple
58
54
 
59
55
# approx 4MB
60
56
# If each line is 50 bytes, and you have 255 internal pages, with 255-way fan
61
57
# out, it takes 3.1MB to cache the layer.
62
58
_PAGE_CACHE_SIZE = 4*1024*1024
63
 
# Per thread caches for 2 reasons:
64
 
# - in the server we may be serving very different content, so we get less
65
 
#   cache thrashing.
66
 
# - we avoid locking on every cache lookup.
67
 
_thread_caches = threading.local()
68
 
# The page cache.
69
 
_thread_caches.page_cache = None
70
 
 
71
 
def _get_cache():
72
 
    """Get the per-thread page cache.
73
 
 
74
 
    We need a function to do this because in a new thread the _thread_caches
75
 
    threading.local object does not have the cache initialized yet.
76
 
    """
77
 
    page_cache = getattr(_thread_caches, 'page_cache', None)
78
 
    if page_cache is None:
79
 
        # We are caching bytes so len(value) is perfectly accurate
80
 
        page_cache = lru_cache.LRUSizeCache(_PAGE_CACHE_SIZE)
81
 
        _thread_caches.page_cache = page_cache
82
 
    return page_cache
83
 
 
84
 
 
85
 
def clear_cache():
86
 
    _get_cache().clear()
87
 
 
 
59
# We are caching bytes so len(value) is perfectly accurate
 
60
_page_cache = lru_cache.LRUSizeCache(_PAGE_CACHE_SIZE)
88
61
 
89
62
# If a ChildNode falls below this many bytes, we check for a remap
90
63
_INTERESTING_NEW_SIZE = 50
106
79
class CHKMap(object):
107
80
    """A persistent map from string to string backed by a CHK store."""
108
81
 
109
 
    __slots__ = ('_store', '_root_node', '_search_key_func')
110
 
 
111
82
    def __init__(self, store, root_key, search_key_func=None):
112
83
        """Create a CHKMap object.
113
84
 
136
107
            of old_key is removed.
137
108
        """
138
109
        delete_count = 0
139
 
        # Check preconditions first.
140
 
        as_st = StaticTuple.from_sequence
141
 
        new_items = set([as_st(key) for (old, key, value) in delta
142
 
                         if key is not None and old is None])
143
 
        existing_new = list(self.iteritems(key_filter=new_items))
144
 
        if existing_new:
145
 
            raise errors.InconsistentDeltaDelta(delta,
146
 
                "New items are already in the map %r." % existing_new)
147
 
        # Now apply changes.
148
110
        for old, new, value in delta:
149
111
            if old is not None and old != new:
150
112
                self.unmap(old, check_remap=False)
159
121
 
160
122
    def _ensure_root(self):
161
123
        """Ensure that the root node is an object not a key."""
162
 
        if type(self._root_node) is StaticTuple:
 
124
        if type(self._root_node) == tuple:
163
125
            # Demand-load the root
164
126
            self._root_node = self._get_node(self._root_node)
165
127
 
173
135
        :param node: A tuple key or node object.
174
136
        :return: A node object.
175
137
        """
176
 
        if type(node) is StaticTuple:
 
138
        if type(node) == tuple:
177
139
            bytes = self._read_bytes(node)
178
140
            return _deserialise(bytes, node,
179
141
                search_key_func=self._search_key_func)
182
144
 
183
145
    def _read_bytes(self, key):
184
146
        try:
185
 
            return _get_cache()[key]
 
147
            return _page_cache[key]
186
148
        except KeyError:
187
149
            stream = self._store.get_record_stream([key], 'unordered', True)
188
150
            bytes = stream.next().get_bytes_as('fulltext')
189
 
            _get_cache()[key] = bytes
 
151
            _page_cache[key] = bytes
190
152
            return bytes
191
153
 
192
154
    def _dump_tree(self, include_keys=False):
220
182
            for key, value in sorted(node._items.iteritems()):
221
183
                # Don't use prefix nor indent here to line up when used in
222
184
                # tests in conjunction with assertEqualDiff
223
 
                result.append('      %r %r' % (tuple(key), value))
 
185
                result.append('      %r %r' % (key, value))
224
186
        return result
225
187
 
226
188
    @classmethod
241
203
            multiple pages.
242
204
        :return: The root chk of the resulting CHKMap.
243
205
        """
244
 
        root_key = klass._create_directly(store, initial_value,
245
 
            maximum_size=maximum_size, key_width=key_width,
246
 
            search_key_func=search_key_func)
247
 
        if type(root_key) is not StaticTuple:
248
 
            raise AssertionError('we got a %s instead of a StaticTuple'
249
 
                                 % (type(root_key),))
250
 
        return root_key
251
 
 
252
 
    @classmethod
253
 
    def _create_via_map(klass, store, initial_value, maximum_size=0,
254
 
                        key_width=1, search_key_func=None):
255
 
        result = klass(store, None, search_key_func=search_key_func)
 
206
        result = CHKMap(store, None, search_key_func=search_key_func)
256
207
        result._root_node.set_maximum_size(maximum_size)
257
208
        result._root_node._key_width = key_width
258
209
        delta = []
259
210
        for key, value in initial_value.items():
260
211
            delta.append((None, key, value))
261
 
        root_key = result.apply_delta(delta)
262
 
        return root_key
263
 
 
264
 
    @classmethod
265
 
    def _create_directly(klass, store, initial_value, maximum_size=0,
266
 
                         key_width=1, search_key_func=None):
267
 
        node = LeafNode(search_key_func=search_key_func)
268
 
        node.set_maximum_size(maximum_size)
269
 
        node._key_width = key_width
270
 
        as_st = StaticTuple.from_sequence
271
 
        node._items = dict([(as_st(key), val) for key, val
272
 
                                               in initial_value.iteritems()])
273
 
        node._raw_size = sum([node._key_value_len(key, value)
274
 
                              for key,value in node._items.iteritems()])
275
 
        node._len = len(node._items)
276
 
        node._compute_search_prefix()
277
 
        node._compute_serialised_prefix()
278
 
        if (node._len > 1
279
 
            and maximum_size
280
 
            and node._current_size() > maximum_size):
281
 
            prefix, node_details = node._split(store)
282
 
            if len(node_details) == 1:
283
 
                raise AssertionError('Failed to split using node._split')
284
 
            node = InternalNode(prefix, search_key_func=search_key_func)
285
 
            node.set_maximum_size(maximum_size)
286
 
            node._key_width = key_width
287
 
            for split, subnode in node_details:
288
 
                node.add_node(split, subnode)
289
 
        keys = list(node.serialise(store))
290
 
        return keys[-1]
 
212
        return result.apply_delta(delta)
291
213
 
292
214
    def iter_changes(self, basis):
293
215
        """Iterate over the changes between basis and self.
513
435
    def iteritems(self, key_filter=None):
514
436
        """Iterate over the entire CHKMap's contents."""
515
437
        self._ensure_root()
516
 
        if key_filter is not None:
517
 
            as_st = StaticTuple.from_sequence
518
 
            key_filter = [as_st(key) for key in key_filter]
519
438
        return self._root_node.iteritems(self._store, key_filter=key_filter)
520
439
 
521
440
    def key(self):
522
441
        """Return the key for this map."""
523
 
        if type(self._root_node) is StaticTuple:
 
442
        if type(self._root_node) is tuple:
524
443
            return self._root_node
525
444
        else:
526
445
            return self._root_node._key
530
449
        return len(self._root_node)
531
450
 
532
451
    def map(self, key, value):
533
 
        """Map a key tuple to value.
534
 
        
535
 
        :param key: A key to map.
536
 
        :param value: The value to assign to key.
537
 
        """
538
 
        key = StaticTuple.from_sequence(key)
 
452
        """Map a key tuple to value."""
539
453
        # Need a root object.
540
454
        self._ensure_root()
541
455
        prefix, node_details = self._root_node.map(self._store, key, value)
551
465
 
552
466
    def _node_key(self, node):
553
467
        """Get the key for a node whether it's a tuple or node."""
554
 
        if type(node) is tuple:
555
 
            node = StaticTuple.from_sequence(node)
556
 
        if type(node) is StaticTuple:
 
468
        if type(node) == tuple:
557
469
            return node
558
470
        else:
559
471
            return node._key
560
472
 
561
473
    def unmap(self, key, check_remap=True):
562
474
        """remove key from the map."""
563
 
        key = StaticTuple.from_sequence(key)
564
475
        self._ensure_root()
565
476
        if type(self._root_node) is InternalNode:
566
477
            unmapped = self._root_node.unmap(self._store, key,
580
491
 
581
492
        :return: The key of the root node.
582
493
        """
583
 
        if type(self._root_node) is StaticTuple:
 
494
        if type(self._root_node) == tuple:
584
495
            # Already saved.
585
496
            return self._root_node
586
497
        keys = list(self._root_node.serialise(self._store))
594
505
        adding the header bytes, and without prefix compression.
595
506
    """
596
507
 
597
 
    __slots__ = ('_key', '_len', '_maximum_size', '_key_width',
598
 
                 '_raw_size', '_items', '_search_prefix', '_search_key_func'
599
 
                )
600
 
 
601
508
    def __init__(self, key_width=1):
602
509
        """Create a node.
603
510
 
652
559
        """
653
560
        if key.startswith(prefix):
654
561
            return prefix
655
 
        pos = -1
656
562
        # Is there a better way to do this?
657
563
        for pos, (left, right) in enumerate(zip(prefix, key)):
658
564
            if left != right:
692
598
        the key/value pairs.
693
599
    """
694
600
 
695
 
    __slots__ = ('_common_serialised_prefix',)
696
 
 
697
601
    def __init__(self, search_key_func=None):
698
602
        Node.__init__(self)
699
603
        # All of the keys in this leaf node share this common prefix
700
604
        self._common_serialised_prefix = None
 
605
        self._serialise_key = '\x00'.join
701
606
        if search_key_func is None:
702
607
            self._search_key_func = _search_key_plain
703
608
        else:
741
646
        :param bytes: The bytes of the node.
742
647
        :param key: The key that the serialised node has.
743
648
        """
744
 
        key = static_tuple.expect_static_tuple(key)
745
649
        return _deserialise_leaf_node(bytes, key,
746
650
                                      search_key_func=search_key_func)
747
651
 
859
763
                result[prefix] = node
860
764
            else:
861
765
                node = result[prefix]
862
 
            sub_prefix, node_details = node.map(store, key, value)
863
 
            if len(node_details) > 1:
864
 
                if prefix != sub_prefix:
865
 
                    # This node has been split and is now found via a different
866
 
                    # path
867
 
                    result.pop(prefix)
868
 
                new_node = InternalNode(sub_prefix,
869
 
                    search_key_func=self._search_key_func)
870
 
                new_node.set_maximum_size(self._maximum_size)
871
 
                new_node._key_width = self._key_width
872
 
                for split, node in node_details:
873
 
                    new_node.add_node(split, node)
874
 
                result[prefix] = new_node
 
766
            node.map(store, key, value)
875
767
        return common_prefix, result.items()
876
768
 
877
769
    def map(self, store, key, value):
887
779
                raise AssertionError('%r must be known' % self._search_prefix)
888
780
            return self._search_prefix, [("", self)]
889
781
 
890
 
    _serialise_key = '\x00'.join
891
 
 
892
782
    def serialise(self, store):
893
783
        """Serialise the LeafNode to store.
894
784
 
919
809
            lines.append(serialized[prefix_len:])
920
810
            lines.extend(value_lines)
921
811
        sha1, _, _ = store.add_lines((None,), (), lines)
922
 
        self._key = StaticTuple("sha1:" + sha1,).intern()
 
812
        self._key = ("sha1:" + sha1,)
923
813
        bytes = ''.join(lines)
924
814
        if len(bytes) != self._current_size():
925
815
            raise AssertionError('Invalid _current_size')
926
 
        _get_cache().add(self._key, bytes)
 
816
        _page_cache.add(self._key, bytes)
927
817
        return [self._key]
928
818
 
929
819
    def refs(self):
993
883
        LeafNode or InternalNode.
994
884
    """
995
885
 
996
 
    __slots__ = ('_node_width',)
997
 
 
998
886
    def __init__(self, prefix='', search_key_func=None):
999
887
        Node.__init__(self)
1000
888
        # The size of an internalnode with default values and no children.
1042
930
        :param key: The key that the serialised node has.
1043
931
        :return: An InternalNode instance.
1044
932
        """
1045
 
        key = static_tuple.expect_static_tuple(key)
1046
933
        return _deserialise_internal_node(bytes, key,
1047
934
                                          search_key_func=search_key_func)
1048
935
 
1067
954
        # prefix is the key in self._items to use, key_filter is the key_filter
1068
955
        # entries that would match this node
1069
956
        keys = {}
1070
 
        shortcut = False
1071
957
        if key_filter is None:
1072
 
            # yielding all nodes, yield whatever we have, and queue up a read
1073
 
            # for whatever we are missing
1074
 
            shortcut = True
1075
958
            for prefix, node in self._items.iteritems():
1076
 
                if node.__class__ is StaticTuple:
 
959
                if type(node) == tuple:
1077
960
                    keys[node] = (prefix, None)
1078
961
                else:
1079
962
                    yield node, None
1080
 
        elif len(key_filter) == 1:
1081
 
            # Technically, this path could also be handled by the first check
1082
 
            # in 'self._node_width' in length_filters. However, we can handle
1083
 
            # this case without spending any time building up the
1084
 
            # prefix_to_keys, etc state.
1085
 
 
1086
 
            # This is a bit ugly, but TIMEIT showed it to be by far the fastest
1087
 
            # 0.626us   list(key_filter)[0]
1088
 
            #       is a func() for list(), 2 mallocs, and a getitem
1089
 
            # 0.489us   [k for k in key_filter][0]
1090
 
            #       still has the mallocs, avoids the func() call
1091
 
            # 0.350us   iter(key_filter).next()
1092
 
            #       has a func() call, and mallocs an iterator
1093
 
            # 0.125us   for key in key_filter: pass
1094
 
            #       no func() overhead, might malloc an iterator
1095
 
            # 0.105us   for key in key_filter: break
1096
 
            #       no func() overhead, might malloc an iterator, probably
1097
 
            #       avoids checking an 'else' clause as part of the for
1098
 
            for key in key_filter:
1099
 
                break
1100
 
            search_prefix = self._search_prefix_filter(key)
1101
 
            if len(search_prefix) == self._node_width:
1102
 
                # This item will match exactly, so just do a dict lookup, and
1103
 
                # see what we can return
1104
 
                shortcut = True
1105
 
                try:
1106
 
                    node = self._items[search_prefix]
1107
 
                except KeyError:
1108
 
                    # A given key can only match 1 child node, if it isn't
1109
 
                    # there, then we can just return nothing
1110
 
                    return
1111
 
                if node.__class__ is StaticTuple:
1112
 
                    keys[node] = (search_prefix, [key])
1113
 
                else:
1114
 
                    # This is loaded, and the only thing that can match,
1115
 
                    # return
1116
 
                    yield node, [key]
1117
 
                    return
1118
 
        if not shortcut:
1119
 
            # First, convert all keys into a list of search prefixes
1120
 
            # Aggregate common prefixes, and track the keys they come from
 
963
        else:
 
964
            # XXX defaultdict ?
1121
965
            prefix_to_keys = {}
1122
966
            length_filters = {}
1123
967
            for key in key_filter:
1124
 
                search_prefix = self._search_prefix_filter(key)
 
968
                search_key = self._search_prefix_filter(key)
1125
969
                length_filter = length_filters.setdefault(
1126
 
                                    len(search_prefix), set())
1127
 
                length_filter.add(search_prefix)
1128
 
                prefix_to_keys.setdefault(search_prefix, []).append(key)
1129
 
 
1130
 
            if (self._node_width in length_filters
1131
 
                and len(length_filters) == 1):
1132
 
                # all of the search prefixes match exactly _node_width. This
1133
 
                # means that everything is an exact match, and we can do a
1134
 
                # lookup into self._items, rather than iterating over the items
1135
 
                # dict.
1136
 
                search_prefixes = length_filters[self._node_width]
1137
 
                for search_prefix in search_prefixes:
1138
 
                    try:
1139
 
                        node = self._items[search_prefix]
1140
 
                    except KeyError:
1141
 
                        # We can ignore this one
1142
 
                        continue
1143
 
                    node_key_filter = prefix_to_keys[search_prefix]
1144
 
                    if node.__class__ is StaticTuple:
1145
 
                        keys[node] = (search_prefix, node_key_filter)
 
970
                                    len(search_key), set())
 
971
                length_filter.add(search_key)
 
972
                prefix_to_keys.setdefault(search_key, []).append(key)
 
973
            length_filters = length_filters.items()
 
974
            for prefix, node in self._items.iteritems():
 
975
                node_key_filter = []
 
976
                for length, length_filter in length_filters:
 
977
                    sub_prefix = prefix[:length]
 
978
                    if sub_prefix in length_filter:
 
979
                        node_key_filter.extend(prefix_to_keys[sub_prefix])
 
980
                if node_key_filter: # this key matched something, yield it
 
981
                    if type(node) == tuple:
 
982
                        keys[node] = (prefix, node_key_filter)
1146
983
                    else:
1147
984
                        yield node, node_key_filter
1148
 
            else:
1149
 
                # The slow way. We walk every item in self._items, and check to
1150
 
                # see if there are any matches
1151
 
                length_filters = length_filters.items()
1152
 
                for prefix, node in self._items.iteritems():
1153
 
                    node_key_filter = []
1154
 
                    for length, length_filter in length_filters:
1155
 
                        sub_prefix = prefix[:length]
1156
 
                        if sub_prefix in length_filter:
1157
 
                            node_key_filter.extend(prefix_to_keys[sub_prefix])
1158
 
                    if node_key_filter: # this key matched something, yield it
1159
 
                        if node.__class__ is StaticTuple:
1160
 
                            keys[node] = (prefix, node_key_filter)
1161
 
                        else:
1162
 
                            yield node, node_key_filter
1163
985
        if keys:
1164
986
            # Look in the page cache for some more bytes
1165
987
            found_keys = set()
1166
988
            for key in keys:
1167
989
                try:
1168
 
                    bytes = _get_cache()[key]
 
990
                    bytes = _page_cache[key]
1169
991
                except KeyError:
1170
992
                    continue
1171
993
                else:
1196
1018
                    prefix, node_key_filter = keys[record.key]
1197
1019
                    node_and_filters.append((node, node_key_filter))
1198
1020
                    self._items[prefix] = node
1199
 
                    _get_cache().add(record.key, bytes)
 
1021
                    _page_cache.add(record.key, bytes)
1200
1022
                for info in node_and_filters:
1201
1023
                    yield info
1202
1024
 
1294
1116
        :return: An iterable of the keys inserted by this operation.
1295
1117
        """
1296
1118
        for node in self._items.itervalues():
1297
 
            if type(node) is StaticTuple:
 
1119
            if type(node) == tuple:
1298
1120
                # Never deserialised.
1299
1121
                continue
1300
1122
            if node._key is not None:
1311
1133
        lines.append('%s\n' % (self._search_prefix,))
1312
1134
        prefix_len = len(self._search_prefix)
1313
1135
        for prefix, node in sorted(self._items.items()):
1314
 
            if type(node) is StaticTuple:
 
1136
            if type(node) == tuple:
1315
1137
                key = node[0]
1316
1138
            else:
1317
1139
                key = node._key[0]
1321
1143
                    % (serialised, self._search_prefix))
1322
1144
            lines.append(serialised[prefix_len:])
1323
1145
        sha1, _, _ = store.add_lines((None,), (), lines)
1324
 
        self._key = StaticTuple("sha1:" + sha1,).intern()
1325
 
        _get_cache().add(self._key, ''.join(lines))
 
1146
        self._key = ("sha1:" + sha1,)
 
1147
        _page_cache.add(self._key, ''.join(lines))
1326
1148
        yield self._key
1327
1149
 
1328
1150
    def _search_key(self, key):
1356
1178
            raise AssertionError("unserialised nodes have no refs.")
1357
1179
        refs = []
1358
1180
        for value in self._items.itervalues():
1359
 
            if type(value) is StaticTuple:
 
1181
            if type(value) == tuple:
1360
1182
                refs.append(value)
1361
1183
            else:
1362
1184
                refs.append(value.key())
1463
1285
    return node
1464
1286
 
1465
1287
 
1466
 
class CHKMapDifference(object):
1467
 
    """Iterate the stored pages and key,value pairs for (new - old).
1468
 
 
1469
 
    This class provides a generator over the stored CHK pages and the
1470
 
    (key, value) pairs that are in any of the new maps and not in any of the
1471
 
    old maps.
1472
 
 
1473
 
    Note that it may yield chk pages that are common (especially root nodes),
1474
 
    but it won't yield (key,value) pairs that are common.
1475
 
    """
1476
 
 
1477
 
    def __init__(self, store, new_root_keys, old_root_keys,
1478
 
                 search_key_func, pb=None):
1479
 
        # TODO: Should we add a StaticTuple barrier here? It would be nice to
1480
 
        #       force callers to use StaticTuple, because there will often be
1481
 
        #       lots of keys passed in here. And even if we cast it locally,
1482
 
        #       that just meanst that we will have *both* a StaticTuple and a
1483
 
        #       tuple() in memory, referring to the same object. (so a net
1484
 
        #       increase in memory, not a decrease.)
1485
 
        self._store = store
1486
 
        self._new_root_keys = new_root_keys
1487
 
        self._old_root_keys = old_root_keys
1488
 
        self._pb = pb
1489
 
        # All uninteresting chks that we have seen. By the time they are added
1490
 
        # here, they should be either fully ignored, or queued up for
1491
 
        # processing
1492
 
        # TODO: This might grow to a large size if there are lots of merge
1493
 
        #       parents, etc. However, it probably doesn't scale to O(history)
1494
 
        #       like _processed_new_refs does.
1495
 
        self._all_old_chks = set(self._old_root_keys)
1496
 
        # All items that we have seen from the old_root_keys
1497
 
        self._all_old_items = set()
1498
 
        # These are interesting items which were either read, or already in the
1499
 
        # interesting queue (so we don't need to walk them again)
1500
 
        # TODO: processed_new_refs becomes O(all_chks), consider switching to
1501
 
        #       SimpleSet here.
1502
 
        self._processed_new_refs = set()
1503
 
        self._search_key_func = search_key_func
1504
 
 
1505
 
        # The uninteresting and interesting nodes to be searched
1506
 
        self._old_queue = []
1507
 
        self._new_queue = []
1508
 
        # Holds the (key, value) items found when processing the root nodes,
1509
 
        # waiting for the uninteresting nodes to be walked
1510
 
        self._new_item_queue = []
1511
 
        self._state = None
1512
 
 
1513
 
    def _read_nodes_from_store(self, keys):
1514
 
        # We chose not to use _get_cache(), because we think in
1515
 
        # terms of records to be yielded. Also, we expect to touch each page
1516
 
        # only 1 time during this code. (We may want to evaluate saving the
1517
 
        # raw bytes into the page cache, which would allow a working tree
1518
 
        # update after the fetch to not have to read the bytes again.)
1519
 
        as_st = StaticTuple.from_sequence
1520
 
        stream = self._store.get_record_stream(keys, 'unordered', True)
1521
 
        for record in stream:
1522
 
            if self._pb is not None:
1523
 
                self._pb.tick()
1524
 
            if record.storage_kind == 'absent':
1525
 
                raise errors.NoSuchRevision(self._store, record.key)
 
1288
def _find_children_info(store, interesting_keys, uninteresting_keys, pb):
 
1289
    """Read the associated records, and determine what is interesting."""
 
1290
    uninteresting_keys = set(uninteresting_keys)
 
1291
    chks_to_read = uninteresting_keys.union(interesting_keys)
 
1292
    next_uninteresting = set()
 
1293
    next_interesting = set()
 
1294
    uninteresting_items = set()
 
1295
    interesting_items = set()
 
1296
    interesting_to_yield = []
 
1297
    for record in store.get_record_stream(chks_to_read, 'unordered', True):
 
1298
        # records_read.add(record.key())
 
1299
        if pb is not None:
 
1300
            pb.tick()
 
1301
        bytes = record.get_bytes_as('fulltext')
 
1302
        # We don't care about search_key_func for this code, because we only
 
1303
        # care about external references.
 
1304
        node = _deserialise(bytes, record.key, search_key_func=None)
 
1305
        if record.key in uninteresting_keys:
 
1306
            if type(node) is InternalNode:
 
1307
                next_uninteresting.update(node.refs())
 
1308
            else:
 
1309
                # We know we are at a LeafNode, so we can pass None for the
 
1310
                # store
 
1311
                uninteresting_items.update(node.iteritems(None))
 
1312
        else:
 
1313
            interesting_to_yield.append(record.key)
 
1314
            if type(node) is InternalNode:
 
1315
                next_interesting.update(node.refs())
 
1316
            else:
 
1317
                interesting_items.update(node.iteritems(None))
 
1318
    return (next_uninteresting, uninteresting_items,
 
1319
            next_interesting, interesting_to_yield, interesting_items)
 
1320
 
 
1321
 
 
1322
def _find_all_uninteresting(store, interesting_root_keys,
 
1323
                            uninteresting_root_keys, pb):
 
1324
    """Determine the full set of uninteresting keys."""
 
1325
    # What about duplicates between interesting_root_keys and
 
1326
    # uninteresting_root_keys?
 
1327
    if not uninteresting_root_keys:
 
1328
        # Shortcut case. We know there is nothing uninteresting to filter out
 
1329
        # So we just let the rest of the algorithm do the work
 
1330
        # We know there is nothing uninteresting, and we didn't have to read
 
1331
        # any interesting records yet.
 
1332
        return (set(), set(), set(interesting_root_keys), [], set())
 
1333
    all_uninteresting_chks = set(uninteresting_root_keys)
 
1334
    all_uninteresting_items = set()
 
1335
 
 
1336
    # First step, find the direct children of both the interesting and
 
1337
    # uninteresting set
 
1338
    (uninteresting_keys, uninteresting_items,
 
1339
     interesting_keys, interesting_to_yield,
 
1340
     interesting_items) = _find_children_info(store, interesting_root_keys,
 
1341
                                              uninteresting_root_keys,
 
1342
                                              pb=pb)
 
1343
    all_uninteresting_chks.update(uninteresting_keys)
 
1344
    all_uninteresting_items.update(uninteresting_items)
 
1345
    del uninteresting_items
 
1346
    # Note: Exact matches between interesting and uninteresting do not need
 
1347
    #       to be search further. Non-exact matches need to be searched in case
 
1348
    #       there is a future exact-match
 
1349
    uninteresting_keys.difference_update(interesting_keys)
 
1350
 
 
1351
    # Second, find the full set of uninteresting bits reachable by the
 
1352
    # uninteresting roots
 
1353
    chks_to_read = uninteresting_keys
 
1354
    while chks_to_read:
 
1355
        next_chks = set()
 
1356
        for record in store.get_record_stream(chks_to_read, 'unordered', False):
 
1357
            # TODO: Handle 'absent'
 
1358
            if pb is not None:
 
1359
                pb.tick()
1526
1360
            bytes = record.get_bytes_as('fulltext')
1527
 
            node = _deserialise(bytes, record.key,
1528
 
                                search_key_func=self._search_key_func)
 
1361
            # We don't care about search_key_func for this code, because we
 
1362
            # only care about external references.
 
1363
            node = _deserialise(bytes, record.key, search_key_func=None)
1529
1364
            if type(node) is InternalNode:
1530
 
                # Note we don't have to do node.refs() because we know that
1531
 
                # there are no children that have been pushed into this node
1532
 
                # Note: Using as_st() here seemed to save 1.2MB, which would
1533
 
                #       indicate that we keep 100k prefix_refs around while
1534
 
                #       processing. They *should* be shorter lived than that...
1535
 
                #       It does cost us ~10s of processing time
1536
 
                #prefix_refs = [as_st(item) for item in node._items.iteritems()]
1537
 
                prefix_refs = node._items.items()
1538
 
                items = []
 
1365
                # uninteresting_prefix_chks.update(node._items.iteritems())
 
1366
                chks = node._items.values()
 
1367
                # TODO: We remove the entries that are already in
 
1368
                #       uninteresting_chks ?
 
1369
                next_chks.update(chks)
 
1370
                all_uninteresting_chks.update(chks)
1539
1371
            else:
1540
 
                prefix_refs = []
1541
 
                # Note: We don't use a StaticTuple here. Profiling showed a
1542
 
                #       minor memory improvement (0.8MB out of 335MB peak 0.2%)
1543
 
                #       But a significant slowdown (15s / 145s, or 10%)
1544
 
                items = node._items.items()
1545
 
            yield record, node, prefix_refs, items
1546
 
 
1547
 
    def _read_old_roots(self):
1548
 
        old_chks_to_enqueue = []
1549
 
        all_old_chks = self._all_old_chks
1550
 
        for record, node, prefix_refs, items in \
1551
 
                self._read_nodes_from_store(self._old_root_keys):
1552
 
            # Uninteresting node
1553
 
            prefix_refs = [p_r for p_r in prefix_refs
1554
 
                                if p_r[1] not in all_old_chks]
1555
 
            new_refs = [p_r[1] for p_r in prefix_refs]
1556
 
            all_old_chks.update(new_refs)
1557
 
            # TODO: This might be a good time to turn items into StaticTuple
1558
 
            #       instances and possibly intern them. However, this does not
1559
 
            #       impact 'initial branch' performance, so I'm not worrying
1560
 
            #       about this yet
1561
 
            self._all_old_items.update(items)
1562
 
            # Queue up the uninteresting references
1563
 
            # Don't actually put them in the 'to-read' queue until we have
1564
 
            # finished checking the interesting references
1565
 
            old_chks_to_enqueue.extend(prefix_refs)
1566
 
        return old_chks_to_enqueue
1567
 
 
1568
 
    def _enqueue_old(self, new_prefixes, old_chks_to_enqueue):
1569
 
        # At this point, we have read all the uninteresting and interesting
1570
 
        # items, so we can queue up the uninteresting stuff, knowing that we've
1571
 
        # handled the interesting ones
1572
 
        for prefix, ref in old_chks_to_enqueue:
1573
 
            not_interesting = True
1574
 
            for i in xrange(len(prefix), 0, -1):
1575
 
                if prefix[:i] in new_prefixes:
1576
 
                    not_interesting = False
1577
 
                    break
1578
 
            if not_interesting:
1579
 
                # This prefix is not part of the remaining 'interesting set'
1580
 
                continue
1581
 
            self._old_queue.append(ref)
1582
 
 
1583
 
    def _read_all_roots(self):
1584
 
        """Read the root pages.
1585
 
 
1586
 
        This is structured as a generator, so that the root records can be
1587
 
        yielded up to whoever needs them without any buffering.
1588
 
        """
1589
 
        # This is the bootstrap phase
1590
 
        if not self._old_root_keys:
1591
 
            # With no old_root_keys we can just shortcut and be ready
1592
 
            # for _flush_new_queue
1593
 
            self._new_queue = list(self._new_root_keys)
1594
 
            return
1595
 
        old_chks_to_enqueue = self._read_old_roots()
1596
 
        # filter out any root keys that are already known to be uninteresting
1597
 
        new_keys = set(self._new_root_keys).difference(self._all_old_chks)
1598
 
        # These are prefixes that are present in new_keys that we are
1599
 
        # thinking to yield
1600
 
        new_prefixes = set()
1601
 
        # We are about to yield all of these, so we don't want them getting
1602
 
        # added a second time
1603
 
        processed_new_refs = self._processed_new_refs
1604
 
        processed_new_refs.update(new_keys)
1605
 
        for record, node, prefix_refs, items in \
1606
 
                self._read_nodes_from_store(new_keys):
1607
 
            # At this level, we now know all the uninteresting references
1608
 
            # So we filter and queue up whatever is remaining
1609
 
            prefix_refs = [p_r for p_r in prefix_refs
1610
 
                           if p_r[1] not in self._all_old_chks
1611
 
                              and p_r[1] not in processed_new_refs]
1612
 
            refs = [p_r[1] for p_r in prefix_refs]
1613
 
            new_prefixes.update([p_r[0] for p_r in prefix_refs])
1614
 
            self._new_queue.extend(refs)
1615
 
            # TODO: We can potentially get multiple items here, however the
1616
 
            #       current design allows for this, as callers will do the work
1617
 
            #       to make the results unique. We might profile whether we
1618
 
            #       gain anything by ensuring unique return values for items
1619
 
            # TODO: This might be a good time to cast to StaticTuple, as
1620
 
            #       self._new_item_queue will hold the contents of multiple
1621
 
            #       records for an extended lifetime
1622
 
            new_items = [item for item in items
1623
 
                               if item not in self._all_old_items]
1624
 
            self._new_item_queue.extend(new_items)
1625
 
            new_prefixes.update([self._search_key_func(item[0])
1626
 
                                 for item in new_items])
1627
 
            processed_new_refs.update(refs)
1628
 
            yield record
1629
 
        # For new_prefixes we have the full length prefixes queued up.
1630
 
        # However, we also need possible prefixes. (If we have a known ref to
1631
 
        # 'ab', then we also need to include 'a'.) So expand the
1632
 
        # new_prefixes to include all shorter prefixes
1633
 
        for prefix in list(new_prefixes):
1634
 
            new_prefixes.update([prefix[:i] for i in xrange(1, len(prefix))])
1635
 
        self._enqueue_old(new_prefixes, old_chks_to_enqueue)
1636
 
 
1637
 
    def _flush_new_queue(self):
1638
 
        # No need to maintain the heap invariant anymore, just pull things out
1639
 
        # and process them
1640
 
        refs = set(self._new_queue)
1641
 
        self._new_queue = []
1642
 
        # First pass, flush all interesting items and convert to using direct refs
1643
 
        all_old_chks = self._all_old_chks
1644
 
        processed_new_refs = self._processed_new_refs
1645
 
        all_old_items = self._all_old_items
1646
 
        new_items = [item for item in self._new_item_queue
1647
 
                           if item not in all_old_items]
1648
 
        self._new_item_queue = []
1649
 
        if new_items:
1650
 
            yield None, new_items
1651
 
        refs = refs.difference(all_old_chks)
1652
 
        processed_new_refs.update(refs)
1653
 
        while refs:
1654
 
            # TODO: Using a SimpleSet for self._processed_new_refs and
1655
 
            #       saved as much as 10MB of peak memory. However, it requires
1656
 
            #       implementing a non-pyrex version.
1657
 
            next_refs = set()
1658
 
            next_refs_update = next_refs.update
1659
 
            # Inlining _read_nodes_from_store improves 'bzr branch bzr.dev'
1660
 
            # from 1m54s to 1m51s. Consider it.
1661
 
            for record, _, p_refs, items in self._read_nodes_from_store(refs):
1662
 
                if all_old_items:
1663
 
                    # using the 'if' check saves about 145s => 141s, when
1664
 
                    # streaming initial branch of Launchpad data.
1665
 
                    items = [item for item in items
1666
 
                             if item not in all_old_items]
1667
 
                yield record, items
1668
 
                next_refs_update([p_r[1] for p_r in p_refs])
1669
 
                del p_refs
1670
 
            # set1.difference(set/dict) walks all of set1, and checks if it
1671
 
            # exists in 'other'.
1672
 
            # set1.difference(iterable) walks all of iterable, and does a
1673
 
            # 'difference_update' on a clone of set1. Pick wisely based on the
1674
 
            # expected sizes of objects.
1675
 
            # in our case it is expected that 'new_refs' will always be quite
1676
 
            # small.
1677
 
            next_refs = next_refs.difference(all_old_chks)
1678
 
            next_refs = next_refs.difference(processed_new_refs)
1679
 
            processed_new_refs.update(next_refs)
1680
 
            refs = next_refs
1681
 
 
1682
 
    def _process_next_old(self):
1683
 
        # Since we don't filter uninteresting any further than during
1684
 
        # _read_all_roots, process the whole queue in a single pass.
1685
 
        refs = self._old_queue
1686
 
        self._old_queue = []
1687
 
        all_old_chks = self._all_old_chks
1688
 
        for record, _, prefix_refs, items in self._read_nodes_from_store(refs):
1689
 
            # TODO: Use StaticTuple here?
1690
 
            self._all_old_items.update(items)
1691
 
            refs = [r for _,r in prefix_refs if r not in all_old_chks]
1692
 
            self._old_queue.extend(refs)
1693
 
            all_old_chks.update(refs)
1694
 
 
1695
 
    def _process_queues(self):
1696
 
        while self._old_queue:
1697
 
            self._process_next_old()
1698
 
        return self._flush_new_queue()
1699
 
 
1700
 
    def process(self):
1701
 
        for record in self._read_all_roots():
1702
 
            yield record, []
1703
 
        for record, items in self._process_queues():
1704
 
            yield record, items
 
1372
                all_uninteresting_items.update(node._items.iteritems())
 
1373
        chks_to_read = next_chks
 
1374
    return (all_uninteresting_chks, all_uninteresting_items,
 
1375
            interesting_keys, interesting_to_yield, interesting_items)
1705
1376
 
1706
1377
 
1707
1378
def iter_interesting_nodes(store, interesting_root_keys,
1718
1389
    :return: Yield
1719
1390
        (interesting record, {interesting key:values})
1720
1391
    """
1721
 
    iterator = CHKMapDifference(store, interesting_root_keys,
1722
 
                                uninteresting_root_keys,
1723
 
                                search_key_func=store._search_key_func,
1724
 
                                pb=pb)
1725
 
    return iterator.process()
 
1392
    # TODO: consider that it may be more memory efficient to use the 20-byte
 
1393
    #       sha1 string, rather than tuples of hexidecimal sha1 strings.
 
1394
    # TODO: Try to factor out a lot of the get_record_stream() calls into a
 
1395
    #       helper function similar to _read_bytes. This function should be
 
1396
    #       able to use nodes from the _page_cache as well as actually
 
1397
    #       requesting bytes from the store.
 
1398
 
 
1399
    (all_uninteresting_chks, all_uninteresting_items, interesting_keys,
 
1400
     interesting_to_yield, interesting_items) = _find_all_uninteresting(store,
 
1401
        interesting_root_keys, uninteresting_root_keys, pb)
 
1402
 
 
1403
    # Now that we know everything uninteresting, we can yield information from
 
1404
    # our first request
 
1405
    interesting_items.difference_update(all_uninteresting_items)
 
1406
    interesting_to_yield = set(interesting_to_yield) - all_uninteresting_chks
 
1407
    if interesting_items:
 
1408
        yield None, interesting_items
 
1409
    if interesting_to_yield:
 
1410
        # We request these records again, rather than buffering the root
 
1411
        # records, most likely they are still in the _group_cache anyway.
 
1412
        for record in store.get_record_stream(interesting_to_yield,
 
1413
                                              'unordered', False):
 
1414
            yield record, []
 
1415
    all_uninteresting_chks.update(interesting_to_yield)
 
1416
    interesting_keys.difference_update(all_uninteresting_chks)
 
1417
 
 
1418
    chks_to_read = interesting_keys
 
1419
    counter = 0
 
1420
    while chks_to_read:
 
1421
        next_chks = set()
 
1422
        for record in store.get_record_stream(chks_to_read, 'unordered', False):
 
1423
            counter += 1
 
1424
            if pb is not None:
 
1425
                pb.update('find chk pages', counter)
 
1426
            # TODO: Handle 'absent'?
 
1427
            bytes = record.get_bytes_as('fulltext')
 
1428
            # We don't care about search_key_func for this code, because we
 
1429
            # only care about external references.
 
1430
            node = _deserialise(bytes, record.key, search_key_func=None)
 
1431
            if type(node) is InternalNode:
 
1432
                # all_uninteresting_chks grows large, as it lists all nodes we
 
1433
                # don't want to process (including already seen interesting
 
1434
                # nodes).
 
1435
                # small.difference_update(large) scales O(large), but
 
1436
                # small.difference(large) scales O(small).
 
1437
                # Also, we know we just _deserialised this node, so we can
 
1438
                # access the dict directly.
 
1439
                chks = set(node._items.itervalues()).difference(
 
1440
                            all_uninteresting_chks)
 
1441
                # Is set() and .difference_update better than:
 
1442
                # chks = [chk for chk in node.refs()
 
1443
                #              if chk not in all_uninteresting_chks]
 
1444
                next_chks.update(chks)
 
1445
                # These are now uninteresting everywhere else
 
1446
                all_uninteresting_chks.update(chks)
 
1447
                interesting_items = []
 
1448
            else:
 
1449
                interesting_items = [item for item in node._items.iteritems()
 
1450
                                     if item not in all_uninteresting_items]
 
1451
                # TODO: Do we need to filter out items that we have already
 
1452
                #       seen on other pages? We don't really want to buffer the
 
1453
                #       whole thing, but it does mean that callers need to
 
1454
                #       understand they may get duplicate values.
 
1455
                # all_uninteresting_items.update(interesting_items)
 
1456
            yield record, interesting_items
 
1457
        chks_to_read = next_chks
1726
1458
 
1727
1459
 
1728
1460
try:
1732
1464
        _deserialise_leaf_node,
1733
1465
        _deserialise_internal_node,
1734
1466
        )
1735
 
except ImportError, e:
1736
 
    osutils.failed_to_load_extension(e)
 
1467
except ImportError:
1737
1468
    from bzrlib._chk_map_py import (
1738
1469
        _search_key_16,
1739
1470
        _search_key_255,
1742
1473
        )
1743
1474
search_key_registry.register('hash-16-way', _search_key_16)
1744
1475
search_key_registry.register('hash-255-way', _search_key_255)
1745
 
 
1746
 
 
1747
 
def _check_key(key):
1748
 
    """Helper function to assert that a key is properly formatted.
1749
 
 
1750
 
    This generally shouldn't be used in production code, but it can be helpful
1751
 
    to debug problems.
1752
 
    """
1753
 
    if type(key) is not StaticTuple:
1754
 
        raise TypeError('key %r is not StaticTuple but %s' % (key, type(key)))
1755
 
    if len(key) != 1:
1756
 
        raise ValueError('key %r should have length 1, not %d' % (key, len(key),))
1757
 
    if type(key[0]) is not str:
1758
 
        raise TypeError('key %r should hold a str, not %r'
1759
 
                        % (key, type(key[0])))
1760
 
    if not key[0].startswith('sha1:'):
1761
 
        raise ValueError('key %r should point to a sha1:' % (key,))
1762
 
 
1763