~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/btree_index.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2008 Canonical Ltd
 
1
# Copyright (C) 2008-2011 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
#
17
17
 
18
18
"""B+Tree indices"""
19
19
 
20
 
import array
 
20
from __future__ import absolute_import
 
21
 
 
22
import cStringIO
 
23
 
 
24
from bzrlib.lazy_import import lazy_import
 
25
lazy_import(globals(), """
21
26
import bisect
22
 
from bisect import bisect_right
23
 
from copy import deepcopy
24
27
import math
25
 
import struct
26
28
import tempfile
27
29
import zlib
 
30
""")
28
31
 
29
32
from bzrlib import (
30
33
    chunk_writer,
31
34
    debug,
32
35
    errors,
 
36
    fifo_cache,
33
37
    index,
34
38
    lru_cache,
35
39
    osutils,
 
40
    static_tuple,
36
41
    trace,
 
42
    transport,
37
43
    )
38
44
from bzrlib.index import _OPTION_NODE_REFS, _OPTION_KEY_ELEMENTS, _OPTION_LEN
39
 
from bzrlib.transport import get_transport
40
45
 
41
46
 
42
47
_BTSIGNATURE = "B+Tree Graph Index 2\n"
63
68
    def __init__(self):
64
69
        """Create a _BuilderRow."""
65
70
        self.nodes = 0
66
 
        self.spool = tempfile.TemporaryFile()
 
71
        self.spool = None# tempfile.TemporaryFile(prefix='bzr-index-row-')
67
72
        self.writer = None
68
73
 
69
74
    def finish_node(self, pad=True):
70
75
        byte_lines, _, padding = self.writer.finish()
71
76
        if self.nodes == 0:
 
77
            self.spool = cStringIO.StringIO()
72
78
            # padded note:
73
79
            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
74
85
        skipped_bytes = 0
75
86
        if not pad and padding:
76
87
            del byte_lines[-1]
153
164
        :param references: An iterable of iterables of keys. Each is a
154
165
            reference to another key.
155
166
        :param value: The value to associate with the key. It may be any
156
 
            bytes as long as it does not contain \0 or \n.
 
167
            bytes as long as it does not contain \\0 or \\n.
157
168
        """
 
169
        # Ensure that 'key' is a StaticTuple
 
170
        key = static_tuple.StaticTuple.from_sequence(key).intern()
158
171
        # we don't care about absent_references
159
172
        node_refs, _ = self._check_key_ref_value(key, references, value)
160
173
        if key in self._nodes:
161
174
            raise errors.BadIndexDuplicateKey(key, self)
162
 
        self._nodes[key] = (node_refs, value)
163
 
        self._keys.add(key)
 
175
        self._nodes[key] = static_tuple.StaticTuple(node_refs, value)
164
176
        if self._nodes_by_key is not None and self._key_length > 1:
165
177
            self._update_nodes_by_key(key, value, node_refs)
166
 
        if len(self._keys) < self._spill_at:
 
178
        if len(self._nodes) < self._spill_at:
167
179
            return
168
180
        self._spill_mem_keys_to_disk()
169
181
 
180
192
        combine mem with the first and second indexes, creating a new one of
181
193
        size 4x. On the fifth create a single new one, etc.
182
194
        """
 
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):
183
221
        iterators_to_combine = [self._iter_mem_nodes()]
184
222
        pos = -1
185
223
        for pos, backing in enumerate(self._backing_indices):
189
227
            iterators_to_combine.append(backing.iter_all_entries())
190
228
        backing_pos = pos + 1
191
229
        new_backing_file, size = \
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
 
230
            self._write_nodes(self._iter_smallest(iterators_to_combine),
 
231
                              allow_optimize=False)
 
232
        return new_backing_file, size, backing_pos
208
233
 
209
234
    def add_nodes(self, nodes):
210
235
        """Add nodes to the index.
262
287
            except StopIteration:
263
288
                current_values[pos] = None
264
289
 
265
 
    def _add_key(self, string_key, line, rows):
 
290
    def _add_key(self, string_key, line, rows, allow_optimize=True):
266
291
        """Add a key to the current chunk.
267
292
 
268
293
        :param string_key: The key to add.
269
294
        :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.
270
298
        """
 
299
        new_leaf = False
271
300
        if rows[-1].writer is None:
272
301
            # opening a new leaf chunk;
 
302
            new_leaf = True
273
303
            for pos, internal_row in enumerate(rows[:-1]):
274
304
                # flesh out any internal nodes that are needed to
275
305
                # preserve the height of the tree
277
307
                    length = _PAGE_SIZE
278
308
                    if internal_row.nodes == 0:
279
309
                        length -= _RESERVED_HEADER_BYTES # padded
 
310
                    if allow_optimize:
 
311
                        optimize_for_size = self._optimize_for_size
 
312
                    else:
 
313
                        optimize_for_size = False
280
314
                    internal_row.writer = chunk_writer.ChunkWriter(length, 0,
281
 
                        optimize_for_size=self._optimize_for_size)
 
315
                        optimize_for_size=optimize_for_size)
282
316
                    internal_row.writer.write(_INTERNAL_FLAG)
283
317
                    internal_row.writer.write(_INTERNAL_OFFSET +
284
318
                        str(rows[pos + 1].nodes) + "\n")
290
324
                optimize_for_size=self._optimize_for_size)
291
325
            rows[-1].writer.write(_LEAF_FLAG)
292
326
        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)
293
332
            # this key did not fit in the node:
294
333
            rows[-1].finish_node()
295
334
            key_line = string_key + "\n"
296
335
            new_row = True
297
336
            for row in reversed(rows[:-1]):
298
337
                # Mark the start of the next node in the node above. If it
299
 
                # doesn't fit then propogate upwards until we find one that
 
338
                # doesn't fit then propagate upwards until we find one that
300
339
                # it does fit into.
301
340
                if row.writer.write(key_line):
302
341
                    row.finish_node()
322
361
                new_row.writer.write(_INTERNAL_OFFSET +
323
362
                    str(rows[1].nodes - 1) + "\n")
324
363
                new_row.writer.write(key_line)
325
 
            self._add_key(string_key, line, rows)
 
364
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
326
365
 
327
 
    def _write_nodes(self, node_iterator):
 
366
    def _write_nodes(self, node_iterator, allow_optimize=True):
328
367
        """Write node_iterator out as a B+Tree.
329
368
 
330
369
        :param node_iterator: An iterator of sorted nodes. Each node should
331
370
            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.
332
374
        :return: A file handle for a temporary file containing a B+Tree for
333
375
            the nodes.
334
376
        """
344
386
        self.row_lengths = []
345
387
        # Loop over all nodes adding them to the bottom row
346
388
        # (rows[-1]). When we finish a chunk in a row,
347
 
        # propogate the key that didn't fit (comes after the chunk) to the
 
389
        # propagate the key that didn't fit (comes after the chunk) to the
348
390
        # row above, transitively.
349
391
        for node in node_iterator:
350
392
            if key_count == 0:
353
395
            key_count += 1
354
396
            string_key, line = _btree_serializer._flatten_node(node,
355
397
                                    self.reference_lists)
356
 
            self._add_key(string_key, line, rows)
 
398
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
357
399
        for row in reversed(rows):
358
400
            pad = (type(row) != _LeafBuilderRow)
359
401
            row.finish_node(pad=pad)
360
 
        result = tempfile.NamedTemporaryFile()
361
402
        lines = [_BTSIGNATURE]
362
403
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
363
404
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
364
405
        lines.append(_OPTION_LEN + str(key_count) + '\n')
365
406
        row_lengths = [row.nodes for row in rows]
366
407
        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()
367
412
        result.writelines(lines)
368
413
        position = sum(map(len, lines))
369
414
        root_row = True
380
425
            # Special case the first node as it may be prefixed
381
426
            node = row.spool.read(_PAGE_SIZE)
382
427
            result.write(node[reserved:])
383
 
            result.write("\x00" * (reserved - position))
 
428
            if len(node) == _PAGE_SIZE:
 
429
                result.write("\x00" * (reserved - position))
384
430
            position = 0 # Only the root row actually has an offset
385
431
            copied_len = osutils.pumpfile(row.spool, result)
386
432
            if copied_len != (row.nodes - 1) * _PAGE_SIZE:
405
451
    def iter_all_entries(self):
406
452
        """Iterate over all keys within the index
407
453
 
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
 
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
410
456
            efficient order for the index (in this case dictionary hash order).
411
457
        """
412
458
        if 'evil' in debug.debug_flags:
431
477
            efficient order for the index (keys iteration order in this case).
432
478
        """
433
479
        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
489
        if self.reference_lists:
435
 
            for key in keys.intersection(self._keys):
436
 
                node = self._nodes[key]
 
490
            for key in local_keys:
 
491
                node = nodes[key]
437
492
                yield self, key, node[1], node[0]
438
493
        else:
439
 
            for key in keys.intersection(self._keys):
440
 
                node = self._nodes[key]
 
494
            for key in local_keys:
 
495
                node = nodes[key]
441
496
                yield self, key, node[1]
442
 
        keys.difference_update(self._keys)
 
497
        # Find things that are in backing indices that have not been handled
 
498
        # yet.
 
499
        if not self._backing_indices:
 
500
            return # We won't find anything there either
 
501
        # Remove all of the keys that we found locally
 
502
        keys.difference_update(local_keys)
443
503
        for backing in self._backing_indices:
444
504
            if backing is None:
445
505
                continue
521
581
                    else:
522
582
                        # yield keys
523
583
                        for value in key_dict.itervalues():
524
 
                            yield (self, ) + value
 
584
                            yield (self, ) + tuple(value)
525
585
            else:
526
586
                yield (self, ) + key_dict
527
587
 
548
608
 
549
609
        For InMemoryGraphIndex the estimate is exact.
550
610
        """
551
 
        return len(self._keys) + sum(backing.key_count() for backing in
 
611
        return len(self._nodes) + sum(backing.key_count() for backing in
552
612
            self._backing_indices if backing is not None)
553
613
 
554
614
    def validate(self):
555
615
        """In memory index's have no known corruption at the moment."""
556
616
 
557
617
 
558
 
class _LeafNode(object):
 
618
class _LeafNode(dict):
559
619
    """A leaf node for a serialised B+Tree index."""
560
620
 
 
621
    __slots__ = ('min_key', 'max_key', '_keys')
 
622
 
561
623
    def __init__(self, bytes, key_length, ref_list_length):
562
624
        """Parse bytes to create a leaf node object."""
563
625
        # splitlines mangles the \r delimiters.. don't use it.
564
 
        self.keys = dict(_btree_serializer._parse_leaf_lines(bytes,
565
 
            key_length, ref_list_length))
 
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
566
647
 
567
648
 
568
649
class _InternalNode(object):
569
650
    """An internal node for a serialised B+Tree index."""
570
651
 
 
652
    __slots__ = ('keys', 'offset')
 
653
 
571
654
    def __init__(self, bytes):
572
655
        """Parse bytes to create an internal node object."""
573
656
        # splitlines mangles the \r delimiters.. don't use it.
576
659
    def _parse_lines(self, lines):
577
660
        nodes = []
578
661
        self.offset = int(lines[1][7:])
 
662
        as_st = static_tuple.StaticTuple.from_sequence
579
663
        for line in lines[2:]:
580
664
            if line == '':
581
665
                break
582
 
            nodes.append(tuple(line.split('\0')))
 
666
            nodes.append(as_st(map(intern, line.split('\0'))).intern())
583
667
        return nodes
584
668
 
585
669
 
590
674
    memory except when very large walks are done.
591
675
    """
592
676
 
593
 
    def __init__(self, transport, name, size):
 
677
    def __init__(self, transport, name, size, unlimited_cache=False,
 
678
                 offset=0):
594
679
        """Create a B+Tree index object on the index name.
595
680
 
596
681
        :param transport: The transport to read data for the index from.
600
685
            the initial read (to read the root node header) can be done
601
686
            without over-reading even on empty indices, and on small indices
602
687
            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.
603
693
        """
604
694
        self._transport = transport
605
695
        self._name = name
607
697
        self._file = None
608
698
        self._recommended_pages = self._compute_recommended_pages()
609
699
        self._root_node = None
 
700
        self._base_offset = offset
 
701
        self._leaf_factory = _LeafNode
610
702
        # Default max size is 100,000 leave values
611
703
        self._leaf_value_cache = None # lru_cache.LRUCache(100*1000)
612
 
        self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
613
 
        self._internal_node_cache = lru_cache.LRUCache()
 
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)
614
713
        self._key_count = None
615
714
        self._row_lengths = None
616
715
        self._row_offsets = None # Start of each row, [-1] is the end
648
747
                if start_of_leaves is None:
649
748
                    start_of_leaves = self._row_offsets[-2]
650
749
                if node_pos < start_of_leaves:
651
 
                    self._internal_node_cache.add(node_pos, node)
 
750
                    self._internal_node_cache[node_pos] = node
652
751
                else:
653
 
                    self._leaf_node_cache.add(node_pos, node)
 
752
                    self._leaf_node_cache[node_pos] = node
654
753
            found[node_pos] = node
655
754
        return found
656
755
 
795
894
            new_tips = next_tips
796
895
        return final_offsets
797
896
 
 
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
 
798
923
    def _find_layer_first_and_end(self, offset):
799
924
        """Find the start/stop nodes for the layer corresponding to offset.
800
925
 
848
973
        """
849
974
        return self._get_nodes(self._internal_node_cache, node_indexes)
850
975
 
851
 
    def _get_leaf_nodes(self, node_indexes):
852
 
        """Get a bunch of nodes, from cache or disk."""
853
 
        found = self._get_nodes(self._leaf_node_cache, node_indexes)
 
976
    def _cache_leaf_values(self, nodes):
 
977
        """Cache directly from key => value, skipping the btree."""
854
978
        if self._leaf_value_cache is not None:
855
 
            for node in found.itervalues():
856
 
                for key, value in node.keys.iteritems():
 
979
            for node in nodes.itervalues():
 
980
                for key, value in node.all_items():
857
981
                    if key in self._leaf_value_cache:
858
982
                        # Don't add the rest of the keys, we've seen this node
859
983
                        # before.
860
984
                        break
861
985
                    self._leaf_value_cache[key] = value
 
986
 
 
987
    def _get_leaf_nodes(self, node_indexes):
 
988
        """Get a bunch of nodes, from cache or disk."""
 
989
        found = self._get_nodes(self._leaf_node_cache, node_indexes)
 
990
        self._cache_leaf_values(found)
862
991
        return found
863
992
 
864
993
    def iter_all_entries(self):
875
1004
                "iter_all_entries scales with size of history.")
876
1005
        if not self.key_count():
877
1006
            return
 
1007
        if self._row_offsets[-1] == 1:
 
1008
            # There is only the root node, and we read that via key_count()
 
1009
            if self.node_ref_lists:
 
1010
                for key, (value, refs) in self._root_node.all_items():
 
1011
                    yield (self, key, value, refs)
 
1012
            else:
 
1013
                for key, (value, refs) in self._root_node.all_items():
 
1014
                    yield (self, key, value)
 
1015
            return
878
1016
        start_of_leaves = self._row_offsets[-2]
879
1017
        end_of_leaves = self._row_offsets[-1]
880
 
        needed_nodes = range(start_of_leaves, end_of_leaves)
 
1018
        needed_offsets = range(start_of_leaves, end_of_leaves)
 
1019
        if needed_offsets == [0]:
 
1020
            # Special case when we only have a root node, as we have already
 
1021
            # read everything
 
1022
            nodes = [(0, self._root_node)]
 
1023
        else:
 
1024
            nodes = self._read_nodes(needed_offsets)
881
1025
        # We iterate strictly in-order so that we can use this function
882
1026
        # for spilling index builds to disk.
883
1027
        if self.node_ref_lists:
884
 
            for _, node in self._read_nodes(needed_nodes):
885
 
                for key, (value, refs) in sorted(node.keys.items()):
 
1028
            for _, node in nodes:
 
1029
                for key, (value, refs) in node.all_items():
886
1030
                    yield (self, key, value, refs)
887
1031
        else:
888
 
            for _, node in self._read_nodes(needed_nodes):
889
 
                for key, (value, refs) in sorted(node.keys.items()):
 
1032
            for _, node in nodes:
 
1033
                for key, (value, refs) in node.all_items():
890
1034
                    yield (self, key, value)
891
1035
 
892
1036
    @staticmethod
916
1060
        # iter_steps = len(in_keys) + len(fixed_keys)
917
1061
        # bisect_steps = len(in_keys) * math.log(len(fixed_keys), 2)
918
1062
        if len(in_keys) == 1: # Bisect will always be faster for M = 1
919
 
            return [(bisect_right(fixed_keys, in_keys[0]), in_keys)]
 
1063
            return [(bisect.bisect_right(fixed_keys, in_keys[0]), in_keys)]
920
1064
        # elif bisect_steps < iter_steps:
921
1065
        #     offsets = {}
922
1066
        #     for key in in_keys:
971
1115
            output.append(cur_out)
972
1116
        return output
973
1117
 
 
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
 
974
1151
    def iter_entries(self, keys):
975
1152
        """Iterate over keys within the index.
976
1153
 
1014
1191
        needed_keys = keys
1015
1192
        if not needed_keys:
1016
1193
            return
1017
 
        # 6 seconds spent in miss_torture using the sorted() line.
1018
 
        # Even with out of order disk IO it seems faster not to sort it when
1019
 
        # large queries are being made.
1020
 
        needed_keys = sorted(needed_keys)
1021
 
 
1022
 
        nodes_and_keys = [(0, needed_keys)]
1023
 
 
1024
 
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
1025
 
            node_indexes = [idx for idx, s_keys in nodes_and_keys]
1026
 
            nodes = self._get_internal_nodes(node_indexes)
1027
 
 
1028
 
            next_nodes_and_keys = []
1029
 
            for node_index, sub_keys in nodes_and_keys:
1030
 
                node = nodes[node_index]
1031
 
                positions = self._multi_bisect_right(sub_keys, node.keys)
1032
 
                node_offset = next_row_start + node.offset
1033
 
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
1034
 
                                           for pos, s_keys in positions])
1035
 
            nodes_and_keys = next_nodes_and_keys
1036
 
        # We should now be at the _LeafNodes
1037
 
        node_indexes = [idx for idx, s_keys in nodes_and_keys]
1038
 
 
1039
 
        # TODO: We may *not* want to always read all the nodes in one
1040
 
        #       big go. Consider setting a max size on this.
1041
 
 
1042
 
        nodes = self._get_leaf_nodes(node_indexes)
 
1194
        nodes, nodes_and_keys = self._walk_through_internal_nodes(needed_keys)
1043
1195
        for node_index, sub_keys in nodes_and_keys:
1044
1196
            if not sub_keys:
1045
1197
                continue
1046
1198
            node = nodes[node_index]
1047
1199
            for next_sub_key in sub_keys:
1048
 
                if next_sub_key in node.keys:
1049
 
                    value, refs = node.keys[next_sub_key]
 
1200
                if next_sub_key in node:
 
1201
                    value, refs = node[next_sub_key]
1050
1202
                    if self.node_ref_lists:
1051
1203
                        yield (self, next_sub_key, value, refs)
1052
1204
                    else:
1053
1205
                        yield (self, next_sub_key, value)
1054
1206
 
 
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
 
1055
1333
    def iter_entries_prefix(self, keys):
1056
1334
        """Iterate over keys within the index using prefix matching.
1057
1335
 
1235
1513
        """Read some nodes from disk into the LRU cache.
1236
1514
 
1237
1515
        This performs a readv to get the node data into memory, and parses each
1238
 
        node, the yields it to the caller. The nodes are requested in the
 
1516
        node, then yields it to the caller. The nodes are requested in the
1239
1517
        supplied order. If possible doing sort() on the list before requesting
1240
1518
        a read may improve performance.
1241
1519
 
1242
1520
        :param nodes: The nodes to read. 0 - first node, 1 - second node etc.
1243
1521
        :return: None
1244
1522
        """
 
1523
        # may be the byte string of the whole file
 
1524
        bytes = None
 
1525
        # list of (offset, length) regions of the file that should, evenually
 
1526
        # be read in to data_ranges, either from 'bytes' or from the transport
1245
1527
        ranges = []
 
1528
        base_offset = self._base_offset
1246
1529
        for index in nodes:
1247
 
            offset = index * _PAGE_SIZE
 
1530
            offset = (index * _PAGE_SIZE)
1248
1531
            size = _PAGE_SIZE
1249
1532
            if index == 0:
1250
1533
                # Root node - special case
1251
1534
                if self._size:
1252
1535
                    size = min(_PAGE_SIZE, self._size)
1253
1536
                else:
1254
 
                    stream = self._transport.get(self._name)
1255
 
                    start = stream.read(_PAGE_SIZE)
1256
 
                    # Avoid doing this again
1257
 
                    self._size = len(start)
1258
 
                    size = min(_PAGE_SIZE, self._size)
 
1537
                    # The only case where we don't know the size, is for very
 
1538
                    # small indexes. So we read the whole thing
 
1539
                    bytes = self._transport.get_bytes(self._name)
 
1540
                    num_bytes = len(bytes)
 
1541
                    self._size = num_bytes - base_offset
 
1542
                    # 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)]
 
1545
                    break
1259
1546
            else:
1260
1547
                if offset > self._size:
1261
1548
                    raise AssertionError('tried to read past the end'
1262
1549
                                         ' of the file %s > %s'
1263
1550
                                         % (offset, self._size))
1264
1551
                size = min(size, self._size - offset)
1265
 
            ranges.append((offset, size))
 
1552
            ranges.append((base_offset + offset, size))
1266
1553
        if not ranges:
1267
1554
            return
1268
 
        if self._file is None:
 
1555
        elif bytes is not None:
 
1556
            # already have the whole file
 
1557
            data_ranges = [(start, bytes[start:start+size])
 
1558
                           for start, size in ranges]
 
1559
        elif self._file is None:
1269
1560
            data_ranges = self._transport.readv(self._name, ranges)
1270
1561
        else:
1271
1562
            data_ranges = []
1273
1564
                self._file.seek(offset)
1274
1565
                data_ranges.append((offset, self._file.read(size)))
1275
1566
        for offset, data in data_ranges:
 
1567
            offset -= base_offset
1276
1568
            if offset == 0:
1277
1569
                # extract the header
1278
1570
                offset, data = self._parse_header_from_bytes(data)
1280
1572
                    continue
1281
1573
            bytes = zlib.decompress(data)
1282
1574
            if bytes.startswith(_LEAF_FLAG):
1283
 
                node = _LeafNode(bytes, self._key_length, self.node_ref_lists)
 
1575
                node = self._leaf_factory(bytes, self._key_length,
 
1576
                                          self.node_ref_lists)
1284
1577
            elif bytes.startswith(_INTERNAL_FLAG):
1285
1578
                node = _InternalNode(bytes)
1286
1579
            else:
1305
1598
            pass
1306
1599
 
1307
1600
 
 
1601
_gcchk_factory = _LeafNode
 
1602
 
1308
1603
try:
1309
 
    from bzrlib import _btree_serializer_c as _btree_serializer
1310
 
except ImportError:
 
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)
1311
1608
    from bzrlib import _btree_serializer_py as _btree_serializer