/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/btree_index.py

  • Committer: Colin D Bennett
  • Date: 2009-02-12 16:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4008.
  • Revision ID: colin@gibibit.com-20090212165739-02xv63odccfmxomw
Generate PDF version of the User Guide.

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