~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/btree_index.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:06:36 UTC
  • mfrom: (3932.2.3 1.11)
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113030636-dqx4t8yaaqgdvam5
MergeĀ 1.11rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2008-2011 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
 
from __future__ import absolute_import
21
 
 
22
 
import cStringIO
23
 
 
24
 
from bzrlib.lazy_import import lazy_import
25
 
lazy_import(globals(), """
 
20
import array
26
21
import bisect
 
22
from bisect import bisect_right
 
23
from copy import deepcopy
27
24
import math
 
25
import struct
28
26
import tempfile
29
27
import zlib
30
 
""")
31
28
 
32
29
from bzrlib import (
33
30
    chunk_writer,
34
31
    debug,
35
32
    errors,
36
 
    fifo_cache,
37
33
    index,
38
34
    lru_cache,
39
35
    osutils,
40
 
    static_tuple,
41
36
    trace,
42
 
    transport,
43
37
    )
44
38
from bzrlib.index import _OPTION_NODE_REFS, _OPTION_KEY_ELEMENTS, _OPTION_LEN
 
39
from bzrlib.transport import get_transport
45
40
 
46
41
 
47
42
_BTSIGNATURE = "B+Tree Graph Index 2\n"
68
63
    def __init__(self):
69
64
        """Create a _BuilderRow."""
70
65
        self.nodes = 0
71
 
        self.spool = None# tempfile.TemporaryFile(prefix='bzr-index-row-')
 
66
        self.spool = tempfile.TemporaryFile()
72
67
        self.writer = None
73
68
 
74
69
    def finish_node(self, pad=True):
75
70
        byte_lines, _, padding = self.writer.finish()
76
71
        if self.nodes == 0:
77
 
            self.spool = cStringIO.StringIO()
78
72
            # padded note:
79
73
            self.spool.write("\x00" * _RESERVED_HEADER_BYTES)
80
 
        elif self.nodes == 1:
81
 
            # We got bigger than 1 node, switch to a temp file
82
 
            spool = tempfile.TemporaryFile(prefix='bzr-index-row-')
83
 
            spool.write(self.spool.getvalue())
84
 
            self.spool = spool
85
74
        skipped_bytes = 0
86
75
        if not pad and padding:
87
76
            del byte_lines[-1]
164
153
        :param references: An iterable of iterables of keys. Each is a
165
154
            reference to another key.
166
155
        :param value: The value to associate with the key. It may be any
167
 
            bytes as long as it does not contain \\0 or \\n.
 
156
            bytes as long as it does not contain \0 or \n.
168
157
        """
169
 
        # Ensure that 'key' is a StaticTuple
170
 
        key = static_tuple.StaticTuple.from_sequence(key).intern()
171
158
        # we don't care about absent_references
172
159
        node_refs, _ = self._check_key_ref_value(key, references, value)
173
160
        if key in self._nodes:
174
161
            raise errors.BadIndexDuplicateKey(key, self)
175
 
        self._nodes[key] = static_tuple.StaticTuple(node_refs, value)
 
162
        self._nodes[key] = (node_refs, value)
 
163
        self._keys.add(key)
176
164
        if self._nodes_by_key is not None and self._key_length > 1:
177
165
            self._update_nodes_by_key(key, value, node_refs)
178
 
        if len(self._nodes) < self._spill_at:
 
166
        if len(self._keys) < self._spill_at:
179
167
            return
180
168
        self._spill_mem_keys_to_disk()
181
169
 
192
180
        combine mem with the first and second indexes, creating a new one of
193
181
        size 4x. On the fifth create a single new one, etc.
194
182
        """
195
 
        if self._combine_backing_indices:
196
 
            (new_backing_file, size,
197
 
             backing_pos) = self._spill_mem_keys_and_combine()
198
 
        else:
199
 
            new_backing_file, size = self._spill_mem_keys_without_combining()
200
 
        # Note: The transport here isn't strictly needed, because we will use
201
 
        #       direct access to the new_backing._file object
202
 
        new_backing = BTreeGraphIndex(transport.get_transport_from_path('.'),
203
 
                                      '<temp>', size)
204
 
        # GC will clean up the file
205
 
        new_backing._file = new_backing_file
206
 
        if self._combine_backing_indices:
207
 
            if len(self._backing_indices) == backing_pos:
208
 
                self._backing_indices.append(None)
209
 
            self._backing_indices[backing_pos] = new_backing
210
 
            for backing_pos in range(backing_pos):
211
 
                self._backing_indices[backing_pos] = None
212
 
        else:
213
 
            self._backing_indices.append(new_backing)
214
 
        self._nodes = {}
215
 
        self._nodes_by_key = None
216
 
 
217
 
    def _spill_mem_keys_without_combining(self):
218
 
        return self._write_nodes(self._iter_mem_nodes(), allow_optimize=False)
219
 
 
220
 
    def _spill_mem_keys_and_combine(self):
221
183
        iterators_to_combine = [self._iter_mem_nodes()]
222
184
        pos = -1
223
185
        for pos, backing in enumerate(self._backing_indices):
227
189
            iterators_to_combine.append(backing.iter_all_entries())
228
190
        backing_pos = pos + 1
229
191
        new_backing_file, size = \
230
 
            self._write_nodes(self._iter_smallest(iterators_to_combine),
231
 
                              allow_optimize=False)
232
 
        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
233
208
 
234
209
    def add_nodes(self, nodes):
235
210
        """Add nodes to the index.
287
262
            except StopIteration:
288
263
                current_values[pos] = None
289
264
 
290
 
    def _add_key(self, string_key, line, rows, allow_optimize=True):
 
265
    def _add_key(self, string_key, line, rows):
291
266
        """Add a key to the current chunk.
292
267
 
293
268
        :param string_key: The key to add.
294
269
        :param line: The fully serialised key and value.
295
 
        :param allow_optimize: If set to False, prevent setting the optimize
296
 
            flag when writing out. This is used by the _spill_mem_keys_to_disk
297
 
            functionality.
298
270
        """
299
 
        new_leaf = False
300
271
        if rows[-1].writer is None:
301
272
            # opening a new leaf chunk;
302
 
            new_leaf = True
303
273
            for pos, internal_row in enumerate(rows[:-1]):
304
274
                # flesh out any internal nodes that are needed to
305
275
                # preserve the height of the tree
307
277
                    length = _PAGE_SIZE
308
278
                    if internal_row.nodes == 0:
309
279
                        length -= _RESERVED_HEADER_BYTES # padded
310
 
                    if allow_optimize:
311
 
                        optimize_for_size = self._optimize_for_size
312
 
                    else:
313
 
                        optimize_for_size = False
314
280
                    internal_row.writer = chunk_writer.ChunkWriter(length, 0,
315
 
                        optimize_for_size=optimize_for_size)
 
281
                        optimize_for_size=self._optimize_for_size)
316
282
                    internal_row.writer.write(_INTERNAL_FLAG)
317
283
                    internal_row.writer.write(_INTERNAL_OFFSET +
318
284
                        str(rows[pos + 1].nodes) + "\n")
324
290
                optimize_for_size=self._optimize_for_size)
325
291
            rows[-1].writer.write(_LEAF_FLAG)
326
292
        if rows[-1].writer.write(line):
327
 
            # if we failed to write, despite having an empty page to write to,
328
 
            # then line is too big. raising the error avoids infinite recursion
329
 
            # searching for a suitably large page that will not be found.
330
 
            if new_leaf:
331
 
                raise errors.BadIndexKey(string_key)
332
293
            # this key did not fit in the node:
333
294
            rows[-1].finish_node()
334
295
            key_line = string_key + "\n"
335
296
            new_row = True
336
297
            for row in reversed(rows[:-1]):
337
298
                # Mark the start of the next node in the node above. If it
338
 
                # doesn't fit then propagate upwards until we find one that
 
299
                # doesn't fit then propogate upwards until we find one that
339
300
                # it does fit into.
340
301
                if row.writer.write(key_line):
341
302
                    row.finish_node()
361
322
                new_row.writer.write(_INTERNAL_OFFSET +
362
323
                    str(rows[1].nodes - 1) + "\n")
363
324
                new_row.writer.write(key_line)
364
 
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
 
325
            self._add_key(string_key, line, rows)
365
326
 
366
 
    def _write_nodes(self, node_iterator, allow_optimize=True):
 
327
    def _write_nodes(self, node_iterator):
367
328
        """Write node_iterator out as a B+Tree.
368
329
 
369
330
        :param node_iterator: An iterator of sorted nodes. Each node should
370
331
            match the output given by iter_all_entries.
371
 
        :param allow_optimize: If set to False, prevent setting the optimize
372
 
            flag when writing out. This is used by the _spill_mem_keys_to_disk
373
 
            functionality.
374
332
        :return: A file handle for a temporary file containing a B+Tree for
375
333
            the nodes.
376
334
        """
386
344
        self.row_lengths = []
387
345
        # Loop over all nodes adding them to the bottom row
388
346
        # (rows[-1]). When we finish a chunk in a row,
389
 
        # 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
390
348
        # row above, transitively.
391
349
        for node in node_iterator:
392
350
            if key_count == 0:
395
353
            key_count += 1
396
354
            string_key, line = _btree_serializer._flatten_node(node,
397
355
                                    self.reference_lists)
398
 
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
 
356
            self._add_key(string_key, line, rows)
399
357
        for row in reversed(rows):
400
358
            pad = (type(row) != _LeafBuilderRow)
401
359
            row.finish_node(pad=pad)
 
360
        result = tempfile.NamedTemporaryFile()
402
361
        lines = [_BTSIGNATURE]
403
362
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
404
363
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
405
364
        lines.append(_OPTION_LEN + str(key_count) + '\n')
406
365
        row_lengths = [row.nodes for row in rows]
407
366
        lines.append(_OPTION_ROW_LENGTHS + ','.join(map(str, row_lengths)) + '\n')
408
 
        if row_lengths and row_lengths[-1] > 1:
409
 
            result = tempfile.NamedTemporaryFile(prefix='bzr-index-')
410
 
        else:
411
 
            result = cStringIO.StringIO()
412
367
        result.writelines(lines)
413
368
        position = sum(map(len, lines))
414
369
        root_row = True
425
380
            # Special case the first node as it may be prefixed
426
381
            node = row.spool.read(_PAGE_SIZE)
427
382
            result.write(node[reserved:])
428
 
            if len(node) == _PAGE_SIZE:
429
 
                result.write("\x00" * (reserved - position))
 
383
            result.write("\x00" * (reserved - position))
430
384
            position = 0 # Only the root row actually has an offset
431
385
            copied_len = osutils.pumpfile(row.spool, result)
432
386
            if copied_len != (row.nodes - 1) * _PAGE_SIZE:
451
405
    def iter_all_entries(self):
452
406
        """Iterate over all keys within the index
453
407
 
454
 
        :return: An iterable of (index, key, value, reference_lists). There is
455
 
            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
456
410
            efficient order for the index (in this case dictionary hash order).
457
411
        """
458
412
        if 'evil' in debug.debug_flags:
477
431
            efficient order for the index (keys iteration order in this case).
478
432
        """
479
433
        keys = set(keys)
480
 
        # Note: We don't use keys.intersection() here. If you read the C api,
481
 
        #       set.intersection(other) special cases when other is a set and
482
 
        #       will iterate the smaller of the two and lookup in the other.
483
 
        #       It does *not* do this for any other type (even dict, unlike
484
 
        #       some other set functions.) Since we expect keys is generally <<
485
 
        #       self._nodes, it is faster to iterate over it in a list
486
 
        #       comprehension
487
 
        nodes = self._nodes
488
 
        local_keys = [key for key in keys if key in nodes]
 
434
        local_keys = keys.intersection(self._keys)
489
435
        if self.reference_lists:
490
436
            for key in local_keys:
491
 
                node = nodes[key]
 
437
                node = self._nodes[key]
492
438
                yield self, key, node[1], node[0]
493
439
        else:
494
440
            for key in local_keys:
495
 
                node = nodes[key]
 
441
                node = self._nodes[key]
496
442
                yield self, key, node[1]
497
443
        # Find things that are in backing indices that have not been handled
498
444
        # yet.
581
527
                    else:
582
528
                        # yield keys
583
529
                        for value in key_dict.itervalues():
584
 
                            yield (self, ) + tuple(value)
 
530
                            yield (self, ) + value
585
531
            else:
586
532
                yield (self, ) + key_dict
587
533
 
608
554
 
609
555
        For InMemoryGraphIndex the estimate is exact.
610
556
        """
611
 
        return len(self._nodes) + sum(backing.key_count() for backing in
 
557
        return len(self._keys) + sum(backing.key_count() for backing in
612
558
            self._backing_indices if backing is not None)
613
559
 
614
560
    def validate(self):
615
561
        """In memory index's have no known corruption at the moment."""
616
562
 
617
563
 
618
 
class _LeafNode(dict):
 
564
class _LeafNode(object):
619
565
    """A leaf node for a serialised B+Tree index."""
620
566
 
621
 
    __slots__ = ('min_key', 'max_key', '_keys')
622
 
 
623
567
    def __init__(self, bytes, key_length, ref_list_length):
624
568
        """Parse bytes to create a leaf node object."""
625
569
        # splitlines mangles the \r delimiters.. don't use it.
626
 
        key_list = _btree_serializer._parse_leaf_lines(bytes,
627
 
            key_length, ref_list_length)
628
 
        if key_list:
629
 
            self.min_key = key_list[0][0]
630
 
            self.max_key = key_list[-1][0]
631
 
        else:
632
 
            self.min_key = self.max_key = None
633
 
        super(_LeafNode, self).__init__(key_list)
634
 
        self._keys = dict(self)
635
 
 
636
 
    def all_items(self):
637
 
        """Return a sorted list of (key, (value, refs)) items"""
638
 
        items = self.items()
639
 
        items.sort()
640
 
        return items
641
 
 
642
 
    def all_keys(self):
643
 
        """Return a sorted list of all keys."""
644
 
        keys = self.keys()
645
 
        keys.sort()
646
 
        return keys
 
570
        self.keys = dict(_btree_serializer._parse_leaf_lines(bytes,
 
571
            key_length, ref_list_length))
647
572
 
648
573
 
649
574
class _InternalNode(object):
650
575
    """An internal node for a serialised B+Tree index."""
651
576
 
652
 
    __slots__ = ('keys', 'offset')
653
 
 
654
577
    def __init__(self, bytes):
655
578
        """Parse bytes to create an internal node object."""
656
579
        # splitlines mangles the \r delimiters.. don't use it.
659
582
    def _parse_lines(self, lines):
660
583
        nodes = []
661
584
        self.offset = int(lines[1][7:])
662
 
        as_st = static_tuple.StaticTuple.from_sequence
663
585
        for line in lines[2:]:
664
586
            if line == '':
665
587
                break
666
 
            nodes.append(as_st(map(intern, line.split('\0'))).intern())
 
588
            nodes.append(tuple(line.split('\0')))
667
589
        return nodes
668
590
 
669
591
 
674
596
    memory except when very large walks are done.
675
597
    """
676
598
 
677
 
    def __init__(self, transport, name, size, unlimited_cache=False,
678
 
                 offset=0):
 
599
    def __init__(self, transport, name, size):
679
600
        """Create a B+Tree index object on the index name.
680
601
 
681
602
        :param transport: The transport to read data for the index from.
685
606
            the initial read (to read the root node header) can be done
686
607
            without over-reading even on empty indices, and on small indices
687
608
            allows single-IO to read the entire index.
688
 
        :param unlimited_cache: If set to True, then instead of using an
689
 
            LRUCache with size _NODE_CACHE_SIZE, we will use a dict and always
690
 
            cache all leaf nodes.
691
 
        :param offset: The start of the btree index data isn't byte 0 of the
692
 
            file. Instead it starts at some point later.
693
609
        """
694
610
        self._transport = transport
695
611
        self._name = name
697
613
        self._file = None
698
614
        self._recommended_pages = self._compute_recommended_pages()
699
615
        self._root_node = None
700
 
        self._base_offset = offset
701
 
        self._leaf_factory = _LeafNode
702
616
        # Default max size is 100,000 leave values
703
617
        self._leaf_value_cache = None # lru_cache.LRUCache(100*1000)
704
 
        if unlimited_cache:
705
 
            self._leaf_node_cache = {}
706
 
            self._internal_node_cache = {}
707
 
        else:
708
 
            self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
709
 
            # We use a FIFO here just to prevent possible blowout. However, a
710
 
            # 300k record btree has only 3k leaf nodes, and only 20 internal
711
 
            # nodes. A value of 100 scales to ~100*100*100 = 1M records.
712
 
            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()
713
620
        self._key_count = None
714
621
        self._row_lengths = None
715
622
        self._row_offsets = None # Start of each row, [-1] is the end
747
654
                if start_of_leaves is None:
748
655
                    start_of_leaves = self._row_offsets[-2]
749
656
                if node_pos < start_of_leaves:
750
 
                    self._internal_node_cache[node_pos] = node
 
657
                    self._internal_node_cache.add(node_pos, node)
751
658
                else:
752
 
                    self._leaf_node_cache[node_pos] = node
 
659
                    self._leaf_node_cache.add(node_pos, node)
753
660
            found[node_pos] = node
754
661
        return found
755
662
 
894
801
            new_tips = next_tips
895
802
        return final_offsets
896
803
 
897
 
    def clear_cache(self):
898
 
        """Clear out any cached/memoized values.
899
 
 
900
 
        This can be called at any time, but generally it is used when we have
901
 
        extracted some information, but don't expect to be requesting any more
902
 
        from this index.
903
 
        """
904
 
        # Note that we don't touch self._root_node or self._internal_node_cache
905
 
        # We don't expect either of those to be big, and it can save
906
 
        # round-trips in the future. We may re-evaluate this if InternalNode
907
 
        # memory starts to be an issue.
908
 
        self._leaf_node_cache.clear()
909
 
 
910
 
    def external_references(self, ref_list_num):
911
 
        if self._root_node is None:
912
 
            self._get_root_node()
913
 
        if ref_list_num + 1 > self.node_ref_lists:
914
 
            raise ValueError('No ref list %d, index has %d ref lists'
915
 
                % (ref_list_num, self.node_ref_lists))
916
 
        keys = set()
917
 
        refs = set()
918
 
        for node in self.iter_all_entries():
919
 
            keys.add(node[1])
920
 
            refs.update(node[3][ref_list_num])
921
 
        return refs - keys
922
 
 
923
804
    def _find_layer_first_and_end(self, offset):
924
805
        """Find the start/stop nodes for the layer corresponding to offset.
925
806
 
977
858
        """Cache directly from key => value, skipping the btree."""
978
859
        if self._leaf_value_cache is not None:
979
860
            for node in nodes.itervalues():
980
 
                for key, value in node.all_items():
 
861
                for key, value in node.keys.iteritems():
981
862
                    if key in self._leaf_value_cache:
982
863
                        # Don't add the rest of the keys, we've seen this node
983
864
                        # before.
1007
888
        if self._row_offsets[-1] == 1:
1008
889
            # There is only the root node, and we read that via key_count()
1009
890
            if self.node_ref_lists:
1010
 
                for key, (value, refs) in self._root_node.all_items():
 
891
                for key, (value, refs) in sorted(self._root_node.keys.items()):
1011
892
                    yield (self, key, value, refs)
1012
893
            else:
1013
 
                for key, (value, refs) in self._root_node.all_items():
 
894
                for key, (value, refs) in sorted(self._root_node.keys.items()):
1014
895
                    yield (self, key, value)
1015
896
            return
1016
897
        start_of_leaves = self._row_offsets[-2]
1026
907
        # for spilling index builds to disk.
1027
908
        if self.node_ref_lists:
1028
909
            for _, node in nodes:
1029
 
                for key, (value, refs) in node.all_items():
 
910
                for key, (value, refs) in sorted(node.keys.items()):
1030
911
                    yield (self, key, value, refs)
1031
912
        else:
1032
913
            for _, node in nodes:
1033
 
                for key, (value, refs) in node.all_items():
 
914
                for key, (value, refs) in sorted(node.keys.items()):
1034
915
                    yield (self, key, value)
1035
916
 
1036
917
    @staticmethod
1060
941
        # iter_steps = len(in_keys) + len(fixed_keys)
1061
942
        # bisect_steps = len(in_keys) * math.log(len(fixed_keys), 2)
1062
943
        if len(in_keys) == 1: # Bisect will always be faster for M = 1
1063
 
            return [(bisect.bisect_right(fixed_keys, in_keys[0]), in_keys)]
 
944
            return [(bisect_right(fixed_keys, in_keys[0]), in_keys)]
1064
945
        # elif bisect_steps < iter_steps:
1065
946
        #     offsets = {}
1066
947
        #     for key in in_keys:
1115
996
            output.append(cur_out)
1116
997
        return output
1117
998
 
1118
 
    def _walk_through_internal_nodes(self, keys):
1119
 
        """Take the given set of keys, and find the corresponding LeafNodes.
1120
 
 
1121
 
        :param keys: An unsorted iterable of keys to search for
1122
 
        :return: (nodes, index_and_keys)
1123
 
            nodes is a dict mapping {index: LeafNode}
1124
 
            keys_at_index is a list of tuples of [(index, [keys for Leaf])]
1125
 
        """
1126
 
        # 6 seconds spent in miss_torture using the sorted() line.
1127
 
        # Even with out of order disk IO it seems faster not to sort it when
1128
 
        # large queries are being made.
1129
 
        keys_at_index = [(0, sorted(keys))]
1130
 
 
1131
 
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
1132
 
            node_indexes = [idx for idx, s_keys in keys_at_index]
1133
 
            nodes = self._get_internal_nodes(node_indexes)
1134
 
 
1135
 
            next_nodes_and_keys = []
1136
 
            for node_index, sub_keys in keys_at_index:
1137
 
                node = nodes[node_index]
1138
 
                positions = self._multi_bisect_right(sub_keys, node.keys)
1139
 
                node_offset = next_row_start + node.offset
1140
 
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
1141
 
                                           for pos, s_keys in positions])
1142
 
            keys_at_index = next_nodes_and_keys
1143
 
        # We should now be at the _LeafNodes
1144
 
        node_indexes = [idx for idx, s_keys in keys_at_index]
1145
 
 
1146
 
        # TODO: We may *not* want to always read all the nodes in one
1147
 
        #       big go. Consider setting a max size on this.
1148
 
        nodes = self._get_leaf_nodes(node_indexes)
1149
 
        return nodes, keys_at_index
1150
 
 
1151
999
    def iter_entries(self, keys):
1152
1000
        """Iterate over keys within the index.
1153
1001
 
1191
1039
        needed_keys = keys
1192
1040
        if not needed_keys:
1193
1041
            return
1194
 
        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)
1195
1068
        for node_index, sub_keys in nodes_and_keys:
1196
1069
            if not sub_keys:
1197
1070
                continue
1198
1071
            node = nodes[node_index]
1199
1072
            for next_sub_key in sub_keys:
1200
 
                if next_sub_key in node:
1201
 
                    value, refs = node[next_sub_key]
 
1073
                if next_sub_key in node.keys:
 
1074
                    value, refs = node.keys[next_sub_key]
1202
1075
                    if self.node_ref_lists:
1203
1076
                        yield (self, next_sub_key, value, refs)
1204
1077
                    else:
1205
1078
                        yield (self, next_sub_key, value)
1206
1079
 
1207
 
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
1208
 
        """Find the parent_map information for the set of keys.
1209
 
 
1210
 
        This populates the parent_map dict and missing_keys set based on the
1211
 
        queried keys. It also can fill out an arbitrary number of parents that
1212
 
        it finds while searching for the supplied keys.
1213
 
 
1214
 
        It is unlikely that you want to call this directly. See
1215
 
        "CombinedGraphIndex.find_ancestry()" for a more appropriate API.
1216
 
 
1217
 
        :param keys: A keys whose ancestry we want to return
1218
 
            Every key will either end up in 'parent_map' or 'missing_keys'.
1219
 
        :param ref_list_num: This index in the ref_lists is the parents we
1220
 
            care about.
1221
 
        :param parent_map: {key: parent_keys} for keys that are present in this
1222
 
            index. This may contain more entries than were in 'keys', that are
1223
 
            reachable ancestors of the keys requested.
1224
 
        :param missing_keys: keys which are known to be missing in this index.
1225
 
            This may include parents that were not directly requested, but we
1226
 
            were able to determine that they are not present in this index.
1227
 
        :return: search_keys    parents that were found but not queried to know
1228
 
            if they are missing or present. Callers can re-query this index for
1229
 
            those keys, and they will be placed into parent_map or missing_keys
1230
 
        """
1231
 
        if not self.key_count():
1232
 
            # We use key_count() to trigger reading the root node and
1233
 
            # determining info about this BTreeGraphIndex
1234
 
            # If we don't have any keys, then everything is missing
1235
 
            missing_keys.update(keys)
1236
 
            return set()
1237
 
        if ref_list_num >= self.node_ref_lists:
1238
 
            raise ValueError('No ref list %d, index has %d ref lists'
1239
 
                % (ref_list_num, self.node_ref_lists))
1240
 
 
1241
 
        # The main trick we are trying to accomplish is that when we find a
1242
 
        # key listing its parents, we expect that the parent key is also likely
1243
 
        # to sit on the same page. Allowing us to expand parents quickly
1244
 
        # without suffering the full stack of bisecting, etc.
1245
 
        nodes, nodes_and_keys = self._walk_through_internal_nodes(keys)
1246
 
 
1247
 
        # These are parent keys which could not be immediately resolved on the
1248
 
        # page where the child was present. Note that we may already be
1249
 
        # searching for that key, and it may actually be present [or known
1250
 
        # missing] on one of the other pages we are reading.
1251
 
        # TODO:
1252
 
        #   We could try searching for them in the immediate previous or next
1253
 
        #   page. If they occur "later" we could put them in a pending lookup
1254
 
        #   set, and then for each node we read thereafter we could check to
1255
 
        #   see if they are present.
1256
 
        #   However, we don't know the impact of keeping this list of things
1257
 
        #   that I'm going to search for every node I come across from here on
1258
 
        #   out.
1259
 
        #   It doesn't handle the case when the parent key is missing on a
1260
 
        #   page that we *don't* read. So we already have to handle being
1261
 
        #   re-entrant for that.
1262
 
        #   Since most keys contain a date string, they are more likely to be
1263
 
        #   found earlier in the file than later, but we would know that right
1264
 
        #   away (key < min_key), and wouldn't keep searching it on every other
1265
 
        #   page that we read.
1266
 
        #   Mostly, it is an idea, one which should be benchmarked.
1267
 
        parents_not_on_page = set()
1268
 
 
1269
 
        for node_index, sub_keys in nodes_and_keys:
1270
 
            if not sub_keys:
1271
 
                continue
1272
 
            # sub_keys is all of the keys we are looking for that should exist
1273
 
            # on this page, if they aren't here, then they won't be found
1274
 
            node = nodes[node_index]
1275
 
            parents_to_check = set()
1276
 
            for next_sub_key in sub_keys:
1277
 
                if next_sub_key not in node:
1278
 
                    # This one is just not present in the index at all
1279
 
                    missing_keys.add(next_sub_key)
1280
 
                else:
1281
 
                    value, refs = node[next_sub_key]
1282
 
                    parent_keys = refs[ref_list_num]
1283
 
                    parent_map[next_sub_key] = parent_keys
1284
 
                    parents_to_check.update(parent_keys)
1285
 
            # Don't look for things we've already found
1286
 
            parents_to_check = parents_to_check.difference(parent_map)
1287
 
            # this can be used to test the benefit of having the check loop
1288
 
            # inlined.
1289
 
            # parents_not_on_page.update(parents_to_check)
1290
 
            # continue
1291
 
            while parents_to_check:
1292
 
                next_parents_to_check = set()
1293
 
                for key in parents_to_check:
1294
 
                    if key in node:
1295
 
                        value, refs = node[key]
1296
 
                        parent_keys = refs[ref_list_num]
1297
 
                        parent_map[key] = parent_keys
1298
 
                        next_parents_to_check.update(parent_keys)
1299
 
                    else:
1300
 
                        # This parent either is genuinely missing, or should be
1301
 
                        # found on another page. Perf test whether it is better
1302
 
                        # to check if this node should fit on this page or not.
1303
 
                        # in the 'everything-in-one-pack' scenario, this *not*
1304
 
                        # doing the check is 237ms vs 243ms.
1305
 
                        # So slightly better, but I assume the standard 'lots
1306
 
                        # of packs' is going to show a reasonable improvement
1307
 
                        # from the check, because it avoids 'going around
1308
 
                        # again' for everything that is in another index
1309
 
                        # parents_not_on_page.add(key)
1310
 
                        # Missing for some reason
1311
 
                        if key < node.min_key:
1312
 
                            # in the case of bzr.dev, 3.4k/5.3k misses are
1313
 
                            # 'earlier' misses (65%)
1314
 
                            parents_not_on_page.add(key)
1315
 
                        elif key > node.max_key:
1316
 
                            # This parent key would be present on a different
1317
 
                            # LeafNode
1318
 
                            parents_not_on_page.add(key)
1319
 
                        else:
1320
 
                            # assert key != node.min_key and key != node.max_key
1321
 
                            # If it was going to be present, it would be on
1322
 
                            # *this* page, so mark it missing.
1323
 
                            missing_keys.add(key)
1324
 
                parents_to_check = next_parents_to_check.difference(parent_map)
1325
 
                # Might want to do another .difference() from missing_keys
1326
 
        # parents_not_on_page could have been found on a different page, or be
1327
 
        # known to be missing. So cull out everything that has already been
1328
 
        # found.
1329
 
        search_keys = parents_not_on_page.difference(
1330
 
            parent_map).difference(missing_keys)
1331
 
        return search_keys
1332
 
 
1333
1080
    def iter_entries_prefix(self, keys):
1334
1081
        """Iterate over keys within the index using prefix matching.
1335
1082
 
1525
1272
        # list of (offset, length) regions of the file that should, evenually
1526
1273
        # be read in to data_ranges, either from 'bytes' or from the transport
1527
1274
        ranges = []
1528
 
        base_offset = self._base_offset
1529
1275
        for index in nodes:
1530
 
            offset = (index * _PAGE_SIZE)
 
1276
            offset = index * _PAGE_SIZE
1531
1277
            size = _PAGE_SIZE
1532
1278
            if index == 0:
1533
1279
                # Root node - special case
1537
1283
                    # The only case where we don't know the size, is for very
1538
1284
                    # small indexes. So we read the whole thing
1539
1285
                    bytes = self._transport.get_bytes(self._name)
1540
 
                    num_bytes = len(bytes)
1541
 
                    self._size = num_bytes - base_offset
 
1286
                    self._size = len(bytes)
1542
1287
                    # the whole thing should be parsed out of 'bytes'
1543
 
                    ranges = [(start, min(_PAGE_SIZE, num_bytes - start))
1544
 
                        for start in xrange(base_offset, num_bytes, _PAGE_SIZE)]
 
1288
                    ranges.append((0, len(bytes)))
1545
1289
                    break
1546
1290
            else:
1547
1291
                if offset > self._size:
1549
1293
                                         ' of the file %s > %s'
1550
1294
                                         % (offset, self._size))
1551
1295
                size = min(size, self._size - offset)
1552
 
            ranges.append((base_offset + offset, size))
 
1296
            ranges.append((offset, size))
1553
1297
        if not ranges:
1554
1298
            return
1555
1299
        elif bytes is not None:
1556
1300
            # already have the whole file
1557
 
            data_ranges = [(start, bytes[start:start+size])
1558
 
                           for start, size in ranges]
 
1301
            data_ranges = [(start, bytes[start:start+_PAGE_SIZE])
 
1302
                           for start in xrange(0, len(bytes), _PAGE_SIZE)]
1559
1303
        elif self._file is None:
1560
1304
            data_ranges = self._transport.readv(self._name, ranges)
1561
1305
        else:
1564
1308
                self._file.seek(offset)
1565
1309
                data_ranges.append((offset, self._file.read(size)))
1566
1310
        for offset, data in data_ranges:
1567
 
            offset -= base_offset
1568
1311
            if offset == 0:
1569
1312
                # extract the header
1570
1313
                offset, data = self._parse_header_from_bytes(data)
1572
1315
                    continue
1573
1316
            bytes = zlib.decompress(data)
1574
1317
            if bytes.startswith(_LEAF_FLAG):
1575
 
                node = self._leaf_factory(bytes, self._key_length,
1576
 
                                          self.node_ref_lists)
 
1318
                node = _LeafNode(bytes, self._key_length, self.node_ref_lists)
1577
1319
            elif bytes.startswith(_INTERNAL_FLAG):
1578
1320
                node = _InternalNode(bytes)
1579
1321
            else:
1598
1340
            pass
1599
1341
 
1600
1342
 
1601
 
_gcchk_factory = _LeafNode
1602
 
 
1603
1343
try:
1604
 
    from bzrlib import _btree_serializer_pyx as _btree_serializer
1605
 
    _gcchk_factory = _btree_serializer._parse_into_chk
1606
 
except ImportError, e:
1607
 
    osutils.failed_to_load_extension(e)
 
1344
    from bzrlib import _btree_serializer_c as _btree_serializer
 
1345
except ImportError:
1608
1346
    from bzrlib import _btree_serializer_py as _btree_serializer