~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/btree_index.py

  • Committer: Andrew Bennetts
  • Date: 2008-12-12 03:53:56 UTC
  • mto: This revision was merged to the branch mainline in revision 3900.
  • Revision ID: andrew.bennetts@canonical.com-20081212035356-uqcu89gy4nqf017x
Fix compilation error in _dirstate_helpers_c on SunOS/Solaris. (Jari Aalto)

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
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
 
18
18
"""B+Tree indices"""
19
19
 
20
 
import cStringIO
 
20
import array
 
21
import bisect
21
22
from bisect import bisect_right
 
23
from copy import deepcopy
22
24
import math
 
25
import struct
23
26
import tempfile
24
27
import zlib
25
28
 
27
30
    chunk_writer,
28
31
    debug,
29
32
    errors,
30
 
    fifo_cache,
31
33
    index,
32
34
    lru_cache,
33
35
    osutils,
34
 
    static_tuple,
35
36
    trace,
36
37
    )
37
38
from bzrlib.index import _OPTION_NODE_REFS, _OPTION_KEY_ELEMENTS, _OPTION_LEN
62
63
    def __init__(self):
63
64
        """Create a _BuilderRow."""
64
65
        self.nodes = 0
65
 
        self.spool = None# tempfile.TemporaryFile(prefix='bzr-index-row-')
 
66
        self.spool = tempfile.TemporaryFile()
66
67
        self.writer = None
67
68
 
68
69
    def finish_node(self, pad=True):
69
70
        byte_lines, _, padding = self.writer.finish()
70
71
        if self.nodes == 0:
71
 
            self.spool = cStringIO.StringIO()
72
72
            # padded note:
73
73
            self.spool.write("\x00" * _RESERVED_HEADER_BYTES)
74
 
        elif self.nodes == 1:
75
 
            # We got bigger than 1 node, switch to a temp file
76
 
            spool = tempfile.TemporaryFile(prefix='bzr-index-row-')
77
 
            spool.write(self.spool.getvalue())
78
 
            self.spool = spool
79
74
        skipped_bytes = 0
80
75
        if not pad and padding:
81
76
            del byte_lines[-1]
160
155
        :param value: The value to associate with the key. It may be any
161
156
            bytes as long as it does not contain \0 or \n.
162
157
        """
163
 
        # Ensure that 'key' is a StaticTuple
164
 
        key = static_tuple.StaticTuple.from_sequence(key).intern()
165
158
        # we don't care about absent_references
166
159
        node_refs, _ = self._check_key_ref_value(key, references, value)
167
160
        if key in self._nodes:
168
161
            raise errors.BadIndexDuplicateKey(key, self)
169
 
        self._nodes[key] = static_tuple.StaticTuple(node_refs, value)
 
162
        self._nodes[key] = (node_refs, value)
 
163
        self._keys.add(key)
170
164
        if self._nodes_by_key is not None and self._key_length > 1:
171
165
            self._update_nodes_by_key(key, value, node_refs)
172
 
        if len(self._nodes) < self._spill_at:
 
166
        if len(self._keys) < self._spill_at:
173
167
            return
174
168
        self._spill_mem_keys_to_disk()
175
169
 
186
180
        combine mem with the first and second indexes, creating a new one of
187
181
        size 4x. On the fifth create a single new one, etc.
188
182
        """
189
 
        if self._combine_backing_indices:
190
 
            (new_backing_file, size,
191
 
             backing_pos) = self._spill_mem_keys_and_combine()
192
 
        else:
193
 
            new_backing_file, size = self._spill_mem_keys_without_combining()
194
 
        # Note: The transport here isn't strictly needed, because we will use
195
 
        #       direct access to the new_backing._file object
196
 
        new_backing = BTreeGraphIndex(get_transport('.'), '<temp>', size)
197
 
        # GC will clean up the file
198
 
        new_backing._file = new_backing_file
199
 
        if self._combine_backing_indices:
200
 
            if len(self._backing_indices) == backing_pos:
201
 
                self._backing_indices.append(None)
202
 
            self._backing_indices[backing_pos] = new_backing
203
 
            for backing_pos in range(backing_pos):
204
 
                self._backing_indices[backing_pos] = None
205
 
        else:
206
 
            self._backing_indices.append(new_backing)
207
 
        self._nodes = {}
208
 
        self._nodes_by_key = None
209
 
 
210
 
    def _spill_mem_keys_without_combining(self):
211
 
        return self._write_nodes(self._iter_mem_nodes(), allow_optimize=False)
212
 
 
213
 
    def _spill_mem_keys_and_combine(self):
214
183
        iterators_to_combine = [self._iter_mem_nodes()]
215
184
        pos = -1
216
185
        for pos, backing in enumerate(self._backing_indices):
220
189
            iterators_to_combine.append(backing.iter_all_entries())
221
190
        backing_pos = pos + 1
222
191
        new_backing_file, size = \
223
 
            self._write_nodes(self._iter_smallest(iterators_to_combine),
224
 
                              allow_optimize=False)
225
 
        return new_backing_file, size, backing_pos
 
192
            self._write_nodes(self._iter_smallest(iterators_to_combine))
 
193
        dir_path, base_name = osutils.split(new_backing_file.name)
 
194
        # Note: The transport here isn't strictly needed, because we will use
 
195
        #       direct access to the new_backing._file object
 
196
        new_backing = BTreeGraphIndex(get_transport(dir_path),
 
197
                                      base_name, size)
 
198
        # GC will clean up the file
 
199
        new_backing._file = new_backing_file
 
200
        if len(self._backing_indices) == backing_pos:
 
201
            self._backing_indices.append(None)
 
202
        self._backing_indices[backing_pos] = new_backing
 
203
        for pos in range(backing_pos):
 
204
            self._backing_indices[pos] = None
 
205
        self._keys = set()
 
206
        self._nodes = {}
 
207
        self._nodes_by_key = None
226
208
 
227
209
    def add_nodes(self, nodes):
228
210
        """Add nodes to the index.
280
262
            except StopIteration:
281
263
                current_values[pos] = None
282
264
 
283
 
    def _add_key(self, string_key, line, rows, allow_optimize=True):
 
265
    def _add_key(self, string_key, line, rows):
284
266
        """Add a key to the current chunk.
285
267
 
286
268
        :param string_key: The key to add.
287
269
        :param line: The fully serialised key and value.
288
 
        :param allow_optimize: If set to False, prevent setting the optimize
289
 
            flag when writing out. This is used by the _spill_mem_keys_to_disk
290
 
            functionality.
291
270
        """
292
271
        if rows[-1].writer is None:
293
272
            # opening a new leaf chunk;
298
277
                    length = _PAGE_SIZE
299
278
                    if internal_row.nodes == 0:
300
279
                        length -= _RESERVED_HEADER_BYTES # padded
301
 
                    if allow_optimize:
302
 
                        optimize_for_size = self._optimize_for_size
303
 
                    else:
304
 
                        optimize_for_size = False
305
280
                    internal_row.writer = chunk_writer.ChunkWriter(length, 0,
306
 
                        optimize_for_size=optimize_for_size)
 
281
                        optimize_for_size=self._optimize_for_size)
307
282
                    internal_row.writer.write(_INTERNAL_FLAG)
308
283
                    internal_row.writer.write(_INTERNAL_OFFSET +
309
284
                        str(rows[pos + 1].nodes) + "\n")
321
296
            new_row = True
322
297
            for row in reversed(rows[:-1]):
323
298
                # Mark the start of the next node in the node above. If it
324
 
                # doesn't fit then propagate upwards until we find one that
 
299
                # doesn't fit then propogate upwards until we find one that
325
300
                # it does fit into.
326
301
                if row.writer.write(key_line):
327
302
                    row.finish_node()
347
322
                new_row.writer.write(_INTERNAL_OFFSET +
348
323
                    str(rows[1].nodes - 1) + "\n")
349
324
                new_row.writer.write(key_line)
350
 
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
 
325
            self._add_key(string_key, line, rows)
351
326
 
352
 
    def _write_nodes(self, node_iterator, allow_optimize=True):
 
327
    def _write_nodes(self, node_iterator):
353
328
        """Write node_iterator out as a B+Tree.
354
329
 
355
330
        :param node_iterator: An iterator of sorted nodes. Each node should
356
331
            match the output given by iter_all_entries.
357
 
        :param allow_optimize: If set to False, prevent setting the optimize
358
 
            flag when writing out. This is used by the _spill_mem_keys_to_disk
359
 
            functionality.
360
332
        :return: A file handle for a temporary file containing a B+Tree for
361
333
            the nodes.
362
334
        """
372
344
        self.row_lengths = []
373
345
        # Loop over all nodes adding them to the bottom row
374
346
        # (rows[-1]). When we finish a chunk in a row,
375
 
        # propagate the key that didn't fit (comes after the chunk) to the
 
347
        # propogate the key that didn't fit (comes after the chunk) to the
376
348
        # row above, transitively.
377
349
        for node in node_iterator:
378
350
            if key_count == 0:
381
353
            key_count += 1
382
354
            string_key, line = _btree_serializer._flatten_node(node,
383
355
                                    self.reference_lists)
384
 
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
 
356
            self._add_key(string_key, line, rows)
385
357
        for row in reversed(rows):
386
358
            pad = (type(row) != _LeafBuilderRow)
387
359
            row.finish_node(pad=pad)
 
360
        result = tempfile.NamedTemporaryFile()
388
361
        lines = [_BTSIGNATURE]
389
362
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
390
363
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
391
364
        lines.append(_OPTION_LEN + str(key_count) + '\n')
392
365
        row_lengths = [row.nodes for row in rows]
393
366
        lines.append(_OPTION_ROW_LENGTHS + ','.join(map(str, row_lengths)) + '\n')
394
 
        if row_lengths and row_lengths[-1] > 1:
395
 
            result = tempfile.NamedTemporaryFile(prefix='bzr-index-')
396
 
        else:
397
 
            result = cStringIO.StringIO()
398
367
        result.writelines(lines)
399
368
        position = sum(map(len, lines))
400
369
        root_row = True
411
380
            # Special case the first node as it may be prefixed
412
381
            node = row.spool.read(_PAGE_SIZE)
413
382
            result.write(node[reserved:])
414
 
            if len(node) == _PAGE_SIZE:
415
 
                result.write("\x00" * (reserved - position))
 
383
            result.write("\x00" * (reserved - position))
416
384
            position = 0 # Only the root row actually has an offset
417
385
            copied_len = osutils.pumpfile(row.spool, result)
418
386
            if copied_len != (row.nodes - 1) * _PAGE_SIZE:
437
405
    def iter_all_entries(self):
438
406
        """Iterate over all keys within the index
439
407
 
440
 
        :return: An iterable of (index, key, value, reference_lists). There is
441
 
            no defined order for the result iteration - it will be in the most
 
408
        :return: An iterable of (index, key, reference_lists, value). There is no
 
409
            defined order for the result iteration - it will be in the most
442
410
            efficient order for the index (in this case dictionary hash order).
443
411
        """
444
412
        if 'evil' in debug.debug_flags:
463
431
            efficient order for the index (keys iteration order in this case).
464
432
        """
465
433
        keys = set(keys)
466
 
        # Note: We don't use keys.intersection() here. If you read the C api,
467
 
        #       set.intersection(other) special cases when other is a set and
468
 
        #       will iterate the smaller of the two and lookup in the other.
469
 
        #       It does *not* do this for any other type (even dict, unlike
470
 
        #       some other set functions.) Since we expect keys is generally <<
471
 
        #       self._nodes, it is faster to iterate over it in a list
472
 
        #       comprehension
473
 
        nodes = self._nodes
474
 
        local_keys = [key for key in keys if key in nodes]
 
434
        local_keys = keys.intersection(self._keys)
475
435
        if self.reference_lists:
476
436
            for key in local_keys:
477
 
                node = nodes[key]
 
437
                node = self._nodes[key]
478
438
                yield self, key, node[1], node[0]
479
439
        else:
480
440
            for key in local_keys:
481
 
                node = nodes[key]
 
441
                node = self._nodes[key]
482
442
                yield self, key, node[1]
483
443
        # Find things that are in backing indices that have not been handled
484
444
        # yet.
567
527
                    else:
568
528
                        # yield keys
569
529
                        for value in key_dict.itervalues():
570
 
                            yield (self, ) + tuple(value)
 
530
                            yield (self, ) + value
571
531
            else:
572
532
                yield (self, ) + key_dict
573
533
 
594
554
 
595
555
        For InMemoryGraphIndex the estimate is exact.
596
556
        """
597
 
        return len(self._nodes) + sum(backing.key_count() for backing in
 
557
        return len(self._keys) + sum(backing.key_count() for backing in
598
558
            self._backing_indices if backing is not None)
599
559
 
600
560
    def validate(self):
604
564
class _LeafNode(object):
605
565
    """A leaf node for a serialised B+Tree index."""
606
566
 
607
 
    __slots__ = ('keys', 'min_key', 'max_key')
608
 
 
609
567
    def __init__(self, bytes, key_length, ref_list_length):
610
568
        """Parse bytes to create a leaf node object."""
611
569
        # splitlines mangles the \r delimiters.. don't use it.
612
 
        key_list = _btree_serializer._parse_leaf_lines(bytes,
613
 
            key_length, ref_list_length)
614
 
        if key_list:
615
 
            self.min_key = key_list[0][0]
616
 
            self.max_key = key_list[-1][0]
617
 
        else:
618
 
            self.min_key = self.max_key = None
619
 
        self.keys = dict(key_list)
 
570
        self.keys = dict(_btree_serializer._parse_leaf_lines(bytes,
 
571
            key_length, ref_list_length))
620
572
 
621
573
 
622
574
class _InternalNode(object):
623
575
    """An internal node for a serialised B+Tree index."""
624
576
 
625
 
    __slots__ = ('keys', 'offset')
626
 
 
627
577
    def __init__(self, bytes):
628
578
        """Parse bytes to create an internal node object."""
629
579
        # splitlines mangles the \r delimiters.. don't use it.
632
582
    def _parse_lines(self, lines):
633
583
        nodes = []
634
584
        self.offset = int(lines[1][7:])
635
 
        as_st = static_tuple.StaticTuple.from_sequence
636
585
        for line in lines[2:]:
637
586
            if line == '':
638
587
                break
639
 
            nodes.append(as_st(map(intern, line.split('\0'))).intern())
 
588
            nodes.append(tuple(line.split('\0')))
640
589
        return nodes
641
590
 
642
591
 
647
596
    memory except when very large walks are done.
648
597
    """
649
598
 
650
 
    def __init__(self, transport, name, size, unlimited_cache=False,
651
 
                 offset=0):
 
599
    def __init__(self, transport, name, size):
652
600
        """Create a B+Tree index object on the index name.
653
601
 
654
602
        :param transport: The transport to read data for the index from.
658
606
            the initial read (to read the root node header) can be done
659
607
            without over-reading even on empty indices, and on small indices
660
608
            allows single-IO to read the entire index.
661
 
        :param unlimited_cache: If set to True, then instead of using an
662
 
            LRUCache with size _NODE_CACHE_SIZE, we will use a dict and always
663
 
            cache all leaf nodes.
664
 
        :param offset: The start of the btree index data isn't byte 0 of the
665
 
            file. Instead it starts at some point later.
666
609
        """
667
610
        self._transport = transport
668
611
        self._name = name
670
613
        self._file = None
671
614
        self._recommended_pages = self._compute_recommended_pages()
672
615
        self._root_node = None
673
 
        self._base_offset = offset
674
616
        # Default max size is 100,000 leave values
675
617
        self._leaf_value_cache = None # lru_cache.LRUCache(100*1000)
676
 
        if unlimited_cache:
677
 
            self._leaf_node_cache = {}
678
 
            self._internal_node_cache = {}
679
 
        else:
680
 
            self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
681
 
            # We use a FIFO here just to prevent possible blowout. However, a
682
 
            # 300k record btree has only 3k leaf nodes, and only 20 internal
683
 
            # nodes. A value of 100 scales to ~100*100*100 = 1M records.
684
 
            self._internal_node_cache = fifo_cache.FIFOCache(100)
 
618
        self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
 
619
        self._internal_node_cache = lru_cache.LRUCache()
685
620
        self._key_count = None
686
621
        self._row_lengths = None
687
622
        self._row_offsets = None # Start of each row, [-1] is the end
719
654
                if start_of_leaves is None:
720
655
                    start_of_leaves = self._row_offsets[-2]
721
656
                if node_pos < start_of_leaves:
722
 
                    self._internal_node_cache[node_pos] = node
 
657
                    self._internal_node_cache.add(node_pos, node)
723
658
                else:
724
 
                    self._leaf_node_cache[node_pos] = node
 
659
                    self._leaf_node_cache.add(node_pos, node)
725
660
            found[node_pos] = node
726
661
        return found
727
662
 
866
801
            new_tips = next_tips
867
802
        return final_offsets
868
803
 
869
 
    def clear_cache(self):
870
 
        """Clear out any cached/memoized values.
871
 
 
872
 
        This can be called at any time, but generally it is used when we have
873
 
        extracted some information, but don't expect to be requesting any more
874
 
        from this index.
875
 
        """
876
 
        # Note that we don't touch self._root_node or self._internal_node_cache
877
 
        # We don't expect either of those to be big, and it can save
878
 
        # round-trips in the future. We may re-evaluate this if InternalNode
879
 
        # memory starts to be an issue.
880
 
        self._leaf_node_cache.clear()
881
 
 
882
 
    def external_references(self, ref_list_num):
883
 
        if self._root_node is None:
884
 
            self._get_root_node()
885
 
        if ref_list_num + 1 > self.node_ref_lists:
886
 
            raise ValueError('No ref list %d, index has %d ref lists'
887
 
                % (ref_list_num, self.node_ref_lists))
888
 
        keys = set()
889
 
        refs = set()
890
 
        for node in self.iter_all_entries():
891
 
            keys.add(node[1])
892
 
            refs.update(node[3][ref_list_num])
893
 
        return refs - keys
894
 
 
895
804
    def _find_layer_first_and_end(self, offset):
896
805
        """Find the start/stop nodes for the layer corresponding to offset.
897
806
 
1087
996
            output.append(cur_out)
1088
997
        return output
1089
998
 
1090
 
    def _walk_through_internal_nodes(self, keys):
1091
 
        """Take the given set of keys, and find the corresponding LeafNodes.
1092
 
 
1093
 
        :param keys: An unsorted iterable of keys to search for
1094
 
        :return: (nodes, index_and_keys)
1095
 
            nodes is a dict mapping {index: LeafNode}
1096
 
            keys_at_index is a list of tuples of [(index, [keys for Leaf])]
1097
 
        """
1098
 
        # 6 seconds spent in miss_torture using the sorted() line.
1099
 
        # Even with out of order disk IO it seems faster not to sort it when
1100
 
        # large queries are being made.
1101
 
        keys_at_index = [(0, sorted(keys))]
1102
 
 
1103
 
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
1104
 
            node_indexes = [idx for idx, s_keys in keys_at_index]
1105
 
            nodes = self._get_internal_nodes(node_indexes)
1106
 
 
1107
 
            next_nodes_and_keys = []
1108
 
            for node_index, sub_keys in keys_at_index:
1109
 
                node = nodes[node_index]
1110
 
                positions = self._multi_bisect_right(sub_keys, node.keys)
1111
 
                node_offset = next_row_start + node.offset
1112
 
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
1113
 
                                           for pos, s_keys in positions])
1114
 
            keys_at_index = next_nodes_and_keys
1115
 
        # We should now be at the _LeafNodes
1116
 
        node_indexes = [idx for idx, s_keys in keys_at_index]
1117
 
 
1118
 
        # TODO: We may *not* want to always read all the nodes in one
1119
 
        #       big go. Consider setting a max size on this.
1120
 
        nodes = self._get_leaf_nodes(node_indexes)
1121
 
        return nodes, keys_at_index
1122
 
 
1123
999
    def iter_entries(self, keys):
1124
1000
        """Iterate over keys within the index.
1125
1001
 
1163
1039
        needed_keys = keys
1164
1040
        if not needed_keys:
1165
1041
            return
1166
 
        nodes, nodes_and_keys = self._walk_through_internal_nodes(needed_keys)
 
1042
        # 6 seconds spent in miss_torture using the sorted() line.
 
1043
        # Even with out of order disk IO it seems faster not to sort it when
 
1044
        # large queries are being made.
 
1045
        needed_keys = sorted(needed_keys)
 
1046
 
 
1047
        nodes_and_keys = [(0, needed_keys)]
 
1048
 
 
1049
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
 
1050
            node_indexes = [idx for idx, s_keys in nodes_and_keys]
 
1051
            nodes = self._get_internal_nodes(node_indexes)
 
1052
 
 
1053
            next_nodes_and_keys = []
 
1054
            for node_index, sub_keys in nodes_and_keys:
 
1055
                node = nodes[node_index]
 
1056
                positions = self._multi_bisect_right(sub_keys, node.keys)
 
1057
                node_offset = next_row_start + node.offset
 
1058
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
 
1059
                                           for pos, s_keys in positions])
 
1060
            nodes_and_keys = next_nodes_and_keys
 
1061
        # We should now be at the _LeafNodes
 
1062
        node_indexes = [idx for idx, s_keys in nodes_and_keys]
 
1063
 
 
1064
        # TODO: We may *not* want to always read all the nodes in one
 
1065
        #       big go. Consider setting a max size on this.
 
1066
 
 
1067
        nodes = self._get_leaf_nodes(node_indexes)
1167
1068
        for node_index, sub_keys in nodes_and_keys:
1168
1069
            if not sub_keys:
1169
1070
                continue
1176
1077
                    else:
1177
1078
                        yield (self, next_sub_key, value)
1178
1079
 
1179
 
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
1180
 
        """Find the parent_map information for the set of keys.
1181
 
 
1182
 
        This populates the parent_map dict and missing_keys set based on the
1183
 
        queried keys. It also can fill out an arbitrary number of parents that
1184
 
        it finds while searching for the supplied keys.
1185
 
 
1186
 
        It is unlikely that you want to call this directly. See
1187
 
        "CombinedGraphIndex.find_ancestry()" for a more appropriate API.
1188
 
 
1189
 
        :param keys: A keys whose ancestry we want to return
1190
 
            Every key will either end up in 'parent_map' or 'missing_keys'.
1191
 
        :param ref_list_num: This index in the ref_lists is the parents we
1192
 
            care about.
1193
 
        :param parent_map: {key: parent_keys} for keys that are present in this
1194
 
            index. This may contain more entries than were in 'keys', that are
1195
 
            reachable ancestors of the keys requested.
1196
 
        :param missing_keys: keys which are known to be missing in this index.
1197
 
            This may include parents that were not directly requested, but we
1198
 
            were able to determine that they are not present in this index.
1199
 
        :return: search_keys    parents that were found but not queried to know
1200
 
            if they are missing or present. Callers can re-query this index for
1201
 
            those keys, and they will be placed into parent_map or missing_keys
1202
 
        """
1203
 
        if not self.key_count():
1204
 
            # We use key_count() to trigger reading the root node and
1205
 
            # determining info about this BTreeGraphIndex
1206
 
            # If we don't have any keys, then everything is missing
1207
 
            missing_keys.update(keys)
1208
 
            return set()
1209
 
        if ref_list_num >= self.node_ref_lists:
1210
 
            raise ValueError('No ref list %d, index has %d ref lists'
1211
 
                % (ref_list_num, self.node_ref_lists))
1212
 
 
1213
 
        # The main trick we are trying to accomplish is that when we find a
1214
 
        # key listing its parents, we expect that the parent key is also likely
1215
 
        # to sit on the same page. Allowing us to expand parents quickly
1216
 
        # without suffering the full stack of bisecting, etc.
1217
 
        nodes, nodes_and_keys = self._walk_through_internal_nodes(keys)
1218
 
 
1219
 
        # These are parent keys which could not be immediately resolved on the
1220
 
        # page where the child was present. Note that we may already be
1221
 
        # searching for that key, and it may actually be present [or known
1222
 
        # missing] on one of the other pages we are reading.
1223
 
        # TODO:
1224
 
        #   We could try searching for them in the immediate previous or next
1225
 
        #   page. If they occur "later" we could put them in a pending lookup
1226
 
        #   set, and then for each node we read thereafter we could check to
1227
 
        #   see if they are present.
1228
 
        #   However, we don't know the impact of keeping this list of things
1229
 
        #   that I'm going to search for every node I come across from here on
1230
 
        #   out.
1231
 
        #   It doesn't handle the case when the parent key is missing on a
1232
 
        #   page that we *don't* read. So we already have to handle being
1233
 
        #   re-entrant for that.
1234
 
        #   Since most keys contain a date string, they are more likely to be
1235
 
        #   found earlier in the file than later, but we would know that right
1236
 
        #   away (key < min_key), and wouldn't keep searching it on every other
1237
 
        #   page that we read.
1238
 
        #   Mostly, it is an idea, one which should be benchmarked.
1239
 
        parents_not_on_page = set()
1240
 
 
1241
 
        for node_index, sub_keys in nodes_and_keys:
1242
 
            if not sub_keys:
1243
 
                continue
1244
 
            # sub_keys is all of the keys we are looking for that should exist
1245
 
            # on this page, if they aren't here, then they won't be found
1246
 
            node = nodes[node_index]
1247
 
            node_keys = node.keys
1248
 
            parents_to_check = set()
1249
 
            for next_sub_key in sub_keys:
1250
 
                if next_sub_key not in node_keys:
1251
 
                    # This one is just not present in the index at all
1252
 
                    missing_keys.add(next_sub_key)
1253
 
                else:
1254
 
                    value, refs = node_keys[next_sub_key]
1255
 
                    parent_keys = refs[ref_list_num]
1256
 
                    parent_map[next_sub_key] = parent_keys
1257
 
                    parents_to_check.update(parent_keys)
1258
 
            # Don't look for things we've already found
1259
 
            parents_to_check = parents_to_check.difference(parent_map)
1260
 
            # this can be used to test the benefit of having the check loop
1261
 
            # inlined.
1262
 
            # parents_not_on_page.update(parents_to_check)
1263
 
            # continue
1264
 
            while parents_to_check:
1265
 
                next_parents_to_check = set()
1266
 
                for key in parents_to_check:
1267
 
                    if key in node_keys:
1268
 
                        value, refs = node_keys[key]
1269
 
                        parent_keys = refs[ref_list_num]
1270
 
                        parent_map[key] = parent_keys
1271
 
                        next_parents_to_check.update(parent_keys)
1272
 
                    else:
1273
 
                        # This parent either is genuinely missing, or should be
1274
 
                        # found on another page. Perf test whether it is better
1275
 
                        # to check if this node should fit on this page or not.
1276
 
                        # in the 'everything-in-one-pack' scenario, this *not*
1277
 
                        # doing the check is 237ms vs 243ms.
1278
 
                        # So slightly better, but I assume the standard 'lots
1279
 
                        # of packs' is going to show a reasonable improvement
1280
 
                        # from the check, because it avoids 'going around
1281
 
                        # again' for everything that is in another index
1282
 
                        # parents_not_on_page.add(key)
1283
 
                        # Missing for some reason
1284
 
                        if key < node.min_key:
1285
 
                            # in the case of bzr.dev, 3.4k/5.3k misses are
1286
 
                            # 'earlier' misses (65%)
1287
 
                            parents_not_on_page.add(key)
1288
 
                        elif key > node.max_key:
1289
 
                            # This parent key would be present on a different
1290
 
                            # LeafNode
1291
 
                            parents_not_on_page.add(key)
1292
 
                        else:
1293
 
                            # assert key != node.min_key and key != node.max_key
1294
 
                            # If it was going to be present, it would be on
1295
 
                            # *this* page, so mark it missing.
1296
 
                            missing_keys.add(key)
1297
 
                parents_to_check = next_parents_to_check.difference(parent_map)
1298
 
                # Might want to do another .difference() from missing_keys
1299
 
        # parents_not_on_page could have been found on a different page, or be
1300
 
        # known to be missing. So cull out everything that has already been
1301
 
        # found.
1302
 
        search_keys = parents_not_on_page.difference(
1303
 
            parent_map).difference(missing_keys)
1304
 
        return search_keys
1305
 
 
1306
1080
    def iter_entries_prefix(self, keys):
1307
1081
        """Iterate over keys within the index using prefix matching.
1308
1082
 
1498
1272
        # list of (offset, length) regions of the file that should, evenually
1499
1273
        # be read in to data_ranges, either from 'bytes' or from the transport
1500
1274
        ranges = []
1501
 
        base_offset = self._base_offset
1502
1275
        for index in nodes:
1503
 
            offset = (index * _PAGE_SIZE)
 
1276
            offset = index * _PAGE_SIZE
1504
1277
            size = _PAGE_SIZE
1505
1278
            if index == 0:
1506
1279
                # Root node - special case
1510
1283
                    # The only case where we don't know the size, is for very
1511
1284
                    # small indexes. So we read the whole thing
1512
1285
                    bytes = self._transport.get_bytes(self._name)
1513
 
                    num_bytes = len(bytes)
1514
 
                    self._size = num_bytes - base_offset
 
1286
                    self._size = len(bytes)
1515
1287
                    # the whole thing should be parsed out of 'bytes'
1516
 
                    ranges = [(start, min(_PAGE_SIZE, num_bytes - start))
1517
 
                        for start in xrange(base_offset, num_bytes, _PAGE_SIZE)]
 
1288
                    ranges.append((0, len(bytes)))
1518
1289
                    break
1519
1290
            else:
1520
1291
                if offset > self._size:
1522
1293
                                         ' of the file %s > %s'
1523
1294
                                         % (offset, self._size))
1524
1295
                size = min(size, self._size - offset)
1525
 
            ranges.append((base_offset + offset, size))
 
1296
            ranges.append((offset, size))
1526
1297
        if not ranges:
1527
1298
            return
1528
1299
        elif bytes is not None:
1529
1300
            # already have the whole file
1530
 
            data_ranges = [(start, bytes[start:start+size])
1531
 
                           for start, size in ranges]
 
1301
            data_ranges = [(start, bytes[start:start+_PAGE_SIZE])
 
1302
                           for start in xrange(0, len(bytes), _PAGE_SIZE)]
1532
1303
        elif self._file is None:
1533
1304
            data_ranges = self._transport.readv(self._name, ranges)
1534
1305
        else:
1537
1308
                self._file.seek(offset)
1538
1309
                data_ranges.append((offset, self._file.read(size)))
1539
1310
        for offset, data in data_ranges:
1540
 
            offset -= base_offset
1541
1311
            if offset == 0:
1542
1312
                # extract the header
1543
1313
                offset, data = self._parse_header_from_bytes(data)
1571
1341
 
1572
1342
 
1573
1343
try:
1574
 
    from bzrlib import _btree_serializer_pyx as _btree_serializer
1575
 
except ImportError, e:
1576
 
    osutils.failed_to_load_extension(e)
 
1344
    from bzrlib import _btree_serializer_c as _btree_serializer
 
1345
except ImportError:
1577
1346
    from bzrlib import _btree_serializer_py as _btree_serializer