~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/btree_index.py

  • Committer: John Arbash Meinel
  • Date: 2008-10-14 21:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3805.
  • Revision ID: john@arbash-meinel.com-20081014213527-4j9uc93aq1qmn43b
Add in a shortcut when we haven't cached much yet.

Document the current algorithm more completely, including the proper
justification for the various steps.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
#
17
17
 
18
18
"""B+Tree indices"""
19
19
 
20
 
import cStringIO
 
20
import array
 
21
import bisect
21
22
from bisect import bisect_right
 
23
from copy import deepcopy
22
24
import math
 
25
import struct
23
26
import tempfile
24
27
import zlib
25
28
 
27
30
    chunk_writer,
28
31
    debug,
29
32
    errors,
30
 
    fifo_cache,
31
33
    index,
32
34
    lru_cache,
33
35
    osutils,
34
 
    static_tuple,
35
36
    trace,
36
37
    )
37
38
from bzrlib.index import _OPTION_NODE_REFS, _OPTION_KEY_ELEMENTS, _OPTION_LEN
62
63
    def __init__(self):
63
64
        """Create a _BuilderRow."""
64
65
        self.nodes = 0
65
 
        self.spool = None# tempfile.TemporaryFile(prefix='bzr-index-row-')
 
66
        self.spool = tempfile.TemporaryFile()
66
67
        self.writer = None
67
68
 
68
69
    def finish_node(self, pad=True):
69
70
        byte_lines, _, padding = self.writer.finish()
70
71
        if self.nodes == 0:
71
 
            self.spool = cStringIO.StringIO()
72
72
            # padded note:
73
73
            self.spool.write("\x00" * _RESERVED_HEADER_BYTES)
74
 
        elif self.nodes == 1:
75
 
            # We got bigger than 1 node, switch to a temp file
76
 
            spool = tempfile.TemporaryFile(prefix='bzr-index-row-')
77
 
            spool.write(self.spool.getvalue())
78
 
            self.spool = spool
79
74
        skipped_bytes = 0
80
75
        if not pad and padding:
81
76
            del byte_lines[-1]
144
139
        self._nodes = {}
145
140
        # Indicate it hasn't been built yet
146
141
        self._nodes_by_key = None
147
 
        self._optimize_for_size = False
148
142
 
149
143
    def add_node(self, key, value, references=()):
150
144
        """Add a node to the index.
160
154
        :param value: The value to associate with the key. It may be any
161
155
            bytes as long as it does not contain \0 or \n.
162
156
        """
163
 
        # Ensure that 'key' is a StaticTuple
164
 
        key = static_tuple.StaticTuple.from_sequence(key).intern()
165
157
        # we don't care about absent_references
166
158
        node_refs, _ = self._check_key_ref_value(key, references, value)
167
159
        if key in self._nodes:
168
160
            raise errors.BadIndexDuplicateKey(key, self)
169
 
        self._nodes[key] = static_tuple.StaticTuple(node_refs, value)
 
161
        self._nodes[key] = (node_refs, value)
 
162
        self._keys.add(key)
170
163
        if self._nodes_by_key is not None and self._key_length > 1:
171
164
            self._update_nodes_by_key(key, value, node_refs)
172
 
        if len(self._nodes) < self._spill_at:
 
165
        if len(self._keys) < self._spill_at:
173
166
            return
174
167
        self._spill_mem_keys_to_disk()
175
168
 
186
179
        combine mem with the first and second indexes, creating a new one of
187
180
        size 4x. On the fifth create a single new one, etc.
188
181
        """
189
 
        if self._combine_backing_indices:
190
 
            (new_backing_file, size,
191
 
             backing_pos) = self._spill_mem_keys_and_combine()
192
 
        else:
193
 
            new_backing_file, size = self._spill_mem_keys_without_combining()
194
 
        # Note: The transport here isn't strictly needed, because we will use
195
 
        #       direct access to the new_backing._file object
196
 
        new_backing = BTreeGraphIndex(get_transport('.'), '<temp>', size)
197
 
        # GC will clean up the file
198
 
        new_backing._file = new_backing_file
199
 
        if self._combine_backing_indices:
200
 
            if len(self._backing_indices) == backing_pos:
201
 
                self._backing_indices.append(None)
202
 
            self._backing_indices[backing_pos] = new_backing
203
 
            for backing_pos in range(backing_pos):
204
 
                self._backing_indices[backing_pos] = None
205
 
        else:
206
 
            self._backing_indices.append(new_backing)
207
 
        self._nodes = {}
208
 
        self._nodes_by_key = None
209
 
 
210
 
    def _spill_mem_keys_without_combining(self):
211
 
        return self._write_nodes(self._iter_mem_nodes(), allow_optimize=False)
212
 
 
213
 
    def _spill_mem_keys_and_combine(self):
214
182
        iterators_to_combine = [self._iter_mem_nodes()]
215
183
        pos = -1
216
184
        for pos, backing in enumerate(self._backing_indices):
220
188
            iterators_to_combine.append(backing.iter_all_entries())
221
189
        backing_pos = pos + 1
222
190
        new_backing_file, size = \
223
 
            self._write_nodes(self._iter_smallest(iterators_to_combine),
224
 
                              allow_optimize=False)
225
 
        return new_backing_file, size, backing_pos
 
191
            self._write_nodes(self._iter_smallest(iterators_to_combine))
 
192
        dir_path, base_name = osutils.split(new_backing_file.name)
 
193
        # Note: The transport here isn't strictly needed, because we will use
 
194
        #       direct access to the new_backing._file object
 
195
        new_backing = BTreeGraphIndex(get_transport(dir_path),
 
196
                                      base_name, size)
 
197
        # GC will clean up the file
 
198
        new_backing._file = new_backing_file
 
199
        if len(self._backing_indices) == backing_pos:
 
200
            self._backing_indices.append(None)
 
201
        self._backing_indices[backing_pos] = new_backing
 
202
        for pos in range(backing_pos):
 
203
            self._backing_indices[pos] = None
 
204
        self._keys = set()
 
205
        self._nodes = {}
 
206
        self._nodes_by_key = None
226
207
 
227
208
    def add_nodes(self, nodes):
228
209
        """Add nodes to the index.
280
261
            except StopIteration:
281
262
                current_values[pos] = None
282
263
 
283
 
    def _add_key(self, string_key, line, rows, allow_optimize=True):
 
264
    def _add_key(self, string_key, line, rows):
284
265
        """Add a key to the current chunk.
285
266
 
286
267
        :param string_key: The key to add.
287
268
        :param line: The fully serialised key and value.
288
 
        :param allow_optimize: If set to False, prevent setting the optimize
289
 
            flag when writing out. This is used by the _spill_mem_keys_to_disk
290
 
            functionality.
291
269
        """
292
270
        if rows[-1].writer is None:
293
271
            # opening a new leaf chunk;
298
276
                    length = _PAGE_SIZE
299
277
                    if internal_row.nodes == 0:
300
278
                        length -= _RESERVED_HEADER_BYTES # padded
301
 
                    if allow_optimize:
302
 
                        optimize_for_size = self._optimize_for_size
303
 
                    else:
304
 
                        optimize_for_size = False
305
 
                    internal_row.writer = chunk_writer.ChunkWriter(length, 0,
306
 
                        optimize_for_size=optimize_for_size)
 
279
                    internal_row.writer = chunk_writer.ChunkWriter(length, 0)
307
280
                    internal_row.writer.write(_INTERNAL_FLAG)
308
281
                    internal_row.writer.write(_INTERNAL_OFFSET +
309
282
                        str(rows[pos + 1].nodes) + "\n")
311
284
            length = _PAGE_SIZE
312
285
            if rows[-1].nodes == 0:
313
286
                length -= _RESERVED_HEADER_BYTES # padded
314
 
            rows[-1].writer = chunk_writer.ChunkWriter(length,
315
 
                optimize_for_size=self._optimize_for_size)
 
287
            rows[-1].writer = chunk_writer.ChunkWriter(length)
316
288
            rows[-1].writer.write(_LEAF_FLAG)
317
289
        if rows[-1].writer.write(line):
318
290
            # this key did not fit in the node:
321
293
            new_row = True
322
294
            for row in reversed(rows[:-1]):
323
295
                # Mark the start of the next node in the node above. If it
324
 
                # doesn't fit then propagate upwards until we find one that
 
296
                # doesn't fit then propogate upwards until we find one that
325
297
                # it does fit into.
326
298
                if row.writer.write(key_line):
327
299
                    row.finish_node()
341
313
                # This will be padded, hence the -100
342
314
                new_row.writer = chunk_writer.ChunkWriter(
343
315
                    _PAGE_SIZE - _RESERVED_HEADER_BYTES,
344
 
                    reserved_bytes,
345
 
                    optimize_for_size=self._optimize_for_size)
 
316
                    reserved_bytes)
346
317
                new_row.writer.write(_INTERNAL_FLAG)
347
318
                new_row.writer.write(_INTERNAL_OFFSET +
348
319
                    str(rows[1].nodes - 1) + "\n")
349
320
                new_row.writer.write(key_line)
350
 
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
 
321
            self._add_key(string_key, line, rows)
351
322
 
352
 
    def _write_nodes(self, node_iterator, allow_optimize=True):
 
323
    def _write_nodes(self, node_iterator):
353
324
        """Write node_iterator out as a B+Tree.
354
325
 
355
326
        :param node_iterator: An iterator of sorted nodes. Each node should
356
327
            match the output given by iter_all_entries.
357
 
        :param allow_optimize: If set to False, prevent setting the optimize
358
 
            flag when writing out. This is used by the _spill_mem_keys_to_disk
359
 
            functionality.
360
328
        :return: A file handle for a temporary file containing a B+Tree for
361
329
            the nodes.
362
330
        """
372
340
        self.row_lengths = []
373
341
        # Loop over all nodes adding them to the bottom row
374
342
        # (rows[-1]). When we finish a chunk in a row,
375
 
        # propagate the key that didn't fit (comes after the chunk) to the
 
343
        # propogate the key that didn't fit (comes after the chunk) to the
376
344
        # row above, transitively.
377
345
        for node in node_iterator:
378
346
            if key_count == 0:
381
349
            key_count += 1
382
350
            string_key, line = _btree_serializer._flatten_node(node,
383
351
                                    self.reference_lists)
384
 
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
 
352
            self._add_key(string_key, line, rows)
385
353
        for row in reversed(rows):
386
354
            pad = (type(row) != _LeafBuilderRow)
387
355
            row.finish_node(pad=pad)
 
356
        result = tempfile.NamedTemporaryFile()
388
357
        lines = [_BTSIGNATURE]
389
358
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
390
359
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
391
360
        lines.append(_OPTION_LEN + str(key_count) + '\n')
392
361
        row_lengths = [row.nodes for row in rows]
393
362
        lines.append(_OPTION_ROW_LENGTHS + ','.join(map(str, row_lengths)) + '\n')
394
 
        if row_lengths and row_lengths[-1] > 1:
395
 
            result = tempfile.NamedTemporaryFile(prefix='bzr-index-')
396
 
        else:
397
 
            result = cStringIO.StringIO()
398
363
        result.writelines(lines)
399
364
        position = sum(map(len, lines))
400
365
        root_row = True
411
376
            # Special case the first node as it may be prefixed
412
377
            node = row.spool.read(_PAGE_SIZE)
413
378
            result.write(node[reserved:])
414
 
            if len(node) == _PAGE_SIZE:
415
 
                result.write("\x00" * (reserved - position))
 
379
            result.write("\x00" * (reserved - position))
416
380
            position = 0 # Only the root row actually has an offset
417
381
            copied_len = osutils.pumpfile(row.spool, result)
418
382
            if copied_len != (row.nodes - 1) * _PAGE_SIZE:
437
401
    def iter_all_entries(self):
438
402
        """Iterate over all keys within the index
439
403
 
440
 
        :return: An iterable of (index, key, value, reference_lists). There is
441
 
            no defined order for the result iteration - it will be in the most
 
404
        :return: An iterable of (index, key, reference_lists, value). There is no
 
405
            defined order for the result iteration - it will be in the most
442
406
            efficient order for the index (in this case dictionary hash order).
443
407
        """
444
408
        if 'evil' in debug.debug_flags:
463
427
            efficient order for the index (keys iteration order in this case).
464
428
        """
465
429
        keys = set(keys)
466
 
        # Note: We don't use keys.intersection() here. If you read the C api,
467
 
        #       set.intersection(other) special cases when other is a set and
468
 
        #       will iterate the smaller of the two and lookup in the other.
469
 
        #       It does *not* do this for any other type (even dict, unlike
470
 
        #       some other set functions.) Since we expect keys is generally <<
471
 
        #       self._nodes, it is faster to iterate over it in a list
472
 
        #       comprehension
473
 
        nodes = self._nodes
474
 
        local_keys = [key for key in keys if key in nodes]
475
430
        if self.reference_lists:
476
 
            for key in local_keys:
477
 
                node = nodes[key]
 
431
            for key in keys.intersection(self._keys):
 
432
                node = self._nodes[key]
478
433
                yield self, key, node[1], node[0]
479
434
        else:
480
 
            for key in local_keys:
481
 
                node = nodes[key]
 
435
            for key in keys.intersection(self._keys):
 
436
                node = self._nodes[key]
482
437
                yield self, key, node[1]
483
 
        # Find things that are in backing indices that have not been handled
484
 
        # yet.
485
 
        if not self._backing_indices:
486
 
            return # We won't find anything there either
487
 
        # Remove all of the keys that we found locally
488
 
        keys.difference_update(local_keys)
 
438
        keys.difference_update(self._keys)
489
439
        for backing in self._backing_indices:
490
440
            if backing is None:
491
441
                continue
567
517
                    else:
568
518
                        # yield keys
569
519
                        for value in key_dict.itervalues():
570
 
                            yield (self, ) + tuple(value)
 
520
                            yield (self, ) + value
571
521
            else:
572
522
                yield (self, ) + key_dict
573
523
 
594
544
 
595
545
        For InMemoryGraphIndex the estimate is exact.
596
546
        """
597
 
        return len(self._nodes) + sum(backing.key_count() for backing in
 
547
        return len(self._keys) + sum(backing.key_count() for backing in
598
548
            self._backing_indices if backing is not None)
599
549
 
600
550
    def validate(self):
604
554
class _LeafNode(object):
605
555
    """A leaf node for a serialised B+Tree index."""
606
556
 
607
 
    __slots__ = ('keys', 'min_key', 'max_key')
608
 
 
609
557
    def __init__(self, bytes, key_length, ref_list_length):
610
558
        """Parse bytes to create a leaf node object."""
611
559
        # splitlines mangles the \r delimiters.. don't use it.
612
 
        key_list = _btree_serializer._parse_leaf_lines(bytes,
613
 
            key_length, ref_list_length)
614
 
        if key_list:
615
 
            self.min_key = key_list[0][0]
616
 
            self.max_key = key_list[-1][0]
617
 
        else:
618
 
            self.min_key = self.max_key = None
619
 
        self.keys = dict(key_list)
 
560
        self.keys = dict(_btree_serializer._parse_leaf_lines(bytes,
 
561
            key_length, ref_list_length))
620
562
 
621
563
 
622
564
class _InternalNode(object):
623
565
    """An internal node for a serialised B+Tree index."""
624
566
 
625
 
    __slots__ = ('keys', 'offset')
626
 
 
627
567
    def __init__(self, bytes):
628
568
        """Parse bytes to create an internal node object."""
629
569
        # splitlines mangles the \r delimiters.. don't use it.
632
572
    def _parse_lines(self, lines):
633
573
        nodes = []
634
574
        self.offset = int(lines[1][7:])
635
 
        as_st = static_tuple.StaticTuple.from_sequence
636
575
        for line in lines[2:]:
637
576
            if line == '':
638
577
                break
639
 
            nodes.append(as_st(map(intern, line.split('\0'))).intern())
 
578
            nodes.append(tuple(line.split('\0')))
640
579
        return nodes
641
580
 
642
581
 
647
586
    memory except when very large walks are done.
648
587
    """
649
588
 
650
 
    def __init__(self, transport, name, size, unlimited_cache=False,
651
 
                 offset=0):
 
589
    def __init__(self, transport, name, size):
652
590
        """Create a B+Tree index object on the index name.
653
591
 
654
592
        :param transport: The transport to read data for the index from.
658
596
            the initial read (to read the root node header) can be done
659
597
            without over-reading even on empty indices, and on small indices
660
598
            allows single-IO to read the entire index.
661
 
        :param unlimited_cache: If set to True, then instead of using an
662
 
            LRUCache with size _NODE_CACHE_SIZE, we will use a dict and always
663
 
            cache all leaf nodes.
664
 
        :param offset: The start of the btree index data isn't byte 0 of the
665
 
            file. Instead it starts at some point later.
666
599
        """
667
600
        self._transport = transport
668
601
        self._name = name
670
603
        self._file = None
671
604
        self._recommended_pages = self._compute_recommended_pages()
672
605
        self._root_node = None
673
 
        self._base_offset = offset
674
606
        # Default max size is 100,000 leave values
675
607
        self._leaf_value_cache = None # lru_cache.LRUCache(100*1000)
676
 
        if unlimited_cache:
677
 
            self._leaf_node_cache = {}
678
 
            self._internal_node_cache = {}
679
 
        else:
680
 
            self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
681
 
            # We use a FIFO here just to prevent possible blowout. However, a
682
 
            # 300k record btree has only 3k leaf nodes, and only 20 internal
683
 
            # nodes. A value of 100 scales to ~100*100*100 = 1M records.
684
 
            self._internal_node_cache = fifo_cache.FIFOCache(100)
 
608
        self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
 
609
        self._internal_node_cache = lru_cache.LRUCache()
685
610
        self._key_count = None
686
611
        self._row_lengths = None
687
612
        self._row_offsets = None # Start of each row, [-1] is the end
719
644
                if start_of_leaves is None:
720
645
                    start_of_leaves = self._row_offsets[-2]
721
646
                if node_pos < start_of_leaves:
722
 
                    self._internal_node_cache[node_pos] = node
 
647
                    self._internal_node_cache.add(node_pos, node)
723
648
                else:
724
 
                    self._leaf_node_cache[node_pos] = node
 
649
                    self._leaf_node_cache.add(node_pos, node)
725
650
            found[node_pos] = node
726
651
        return found
727
652
 
728
653
    def _compute_recommended_pages(self):
729
 
        """Convert transport's recommended_page_size into btree pages.
730
 
 
731
 
        recommended_page_size is in bytes, we want to know how many _PAGE_SIZE
732
 
        pages fit in that length.
733
 
        """
 
654
        """Given the transport's recommended_page_size, determine num pages."""
734
655
        recommended_read = self._transport.recommended_page_size()
735
656
        recommended_pages = int(math.ceil(recommended_read /
736
657
                                          float(_PAGE_SIZE)))
737
658
        return recommended_pages
738
659
 
739
 
    def _compute_total_pages_in_index(self):
740
 
        """How many pages are in the index.
741
 
 
742
 
        If we have read the header we will use the value stored there.
743
 
        Otherwise it will be computed based on the length of the index.
744
 
        """
 
660
    def _compute_num_pages(self):
 
661
        """Determine the offset to the last page in this index."""
745
662
        if self._size is None:
746
 
            raise AssertionError('_compute_total_pages_in_index should not be'
747
 
                                 ' called when self._size is None')
 
663
            raise AssertionError('_compute_num_pages should not be called'
 
664
                                 ' when self._size is None')
748
665
        if self._root_node is not None:
749
666
            # This is the number of pages as defined by the header
750
667
            return self._row_offsets[-1]
751
668
        # This is the number of pages as defined by the size of the index. They
752
669
        # should be indentical.
753
 
        total_pages = int(math.ceil(self._size / float(_PAGE_SIZE)))
754
 
        return total_pages
 
670
        num_pages = int(math.ceil(self._size / float(_PAGE_SIZE)))
 
671
        return num_pages
755
672
 
756
 
    def _expand_offsets(self, offsets):
757
 
        """Find extra pages to download.
 
673
    def _expand_nodes(self, node_indexes):
 
674
        """Find extra nodes to download.
758
675
 
759
676
        The idea is that we always want to make big-enough requests (like 64kB
760
677
        for http), so that we don't waste round trips. So given the entries
761
 
        that we already have cached and the new pages being downloaded figure
 
678
        that we already have cached, and the new nodes being downloaded, figure
762
679
        out what other pages we might want to read.
763
680
 
764
 
        See also doc/developers/btree_index_prefetch.txt for more details.
765
 
 
766
 
        :param offsets: The offsets to be read
767
 
        :return: A list of offsets to download
 
681
        :param node_indexes: The nodes that have been requested to read.
 
682
        :return: A new list of nodes to download
768
683
        """
769
684
        if 'index' in debug.debug_flags:
770
 
            trace.mutter('expanding: %s\toffsets: %s', self._name, offsets)
 
685
            trace.mutter('expanding: %s\tnodes: %s', self._name, node_indexes)
771
686
 
772
 
        if len(offsets) >= self._recommended_pages:
 
687
        if len(node_indexes) >= self._recommended_pages:
773
688
            # Don't add more, we are already requesting more than enough
774
689
            if 'index' in debug.debug_flags:
775
690
                trace.mutter('  not expanding large request (%s >= %s)',
776
 
                             len(offsets), self._recommended_pages)
777
 
            return offsets
 
691
                             len(node_indexes), self._recommended_pages)
 
692
            return node_indexes
778
693
        if self._size is None:
779
694
            # Don't try anything, because we don't know where the file ends
780
695
            if 'index' in debug.debug_flags:
781
696
                trace.mutter('  not expanding without knowing index size')
782
 
            return offsets
783
 
        total_pages = self._compute_total_pages_in_index()
784
 
        cached_offsets = self._get_offsets_to_cached_pages()
 
697
            return node_indexes
 
698
        num_pages = self._compute_num_pages()
 
699
        # The idea here is to get nodes "next to" the ones we are already
 
700
        # getting.
 
701
        cached_keys = self._get_cached_keys()
 
702
 
785
703
        # If reading recommended_pages would read the rest of the index, just
786
704
        # do so.
787
 
        if total_pages - len(cached_offsets) <= self._recommended_pages:
 
705
        if num_pages - len(cached_keys) <= self._recommended_pages:
788
706
            # Read whatever is left
789
 
            if cached_offsets:
790
 
                expanded = [x for x in xrange(total_pages)
791
 
                               if x not in cached_offsets]
 
707
            if cached_keys:
 
708
                expanded = [x for x in xrange(num_pages)
 
709
                               if x not in cached_keys]
792
710
            else:
793
 
                expanded = range(total_pages)
 
711
                expanded = range(num_pages)
794
712
            if 'index' in debug.debug_flags:
795
713
                trace.mutter('  reading all unread pages: %s', expanded)
796
714
            return expanded
802
720
            # See doc/developers/btree_index_prefetch.txt for a discussion, and
803
721
            # a possible implementation when we are guessing that the second
804
722
            # layer index is small
805
 
            final_offsets = offsets
 
723
            final_nodes = node_indexes
806
724
        else:
807
725
            tree_depth = len(self._row_lengths)
808
 
            if len(cached_offsets) < tree_depth and len(offsets) == 1:
 
726
            if len(cached_keys) < tree_depth and len(node_indexes) == 1:
809
727
                # We haven't read enough to justify expansion
810
728
                # If we are only going to read the root node, and 1 leaf node,
811
729
                # then it isn't worth expanding our request. Once we've read at
813
731
                # start expanding our requests.
814
732
                if 'index' in debug.debug_flags:
815
733
                    trace.mutter('  not expanding on first reads')
816
 
                return offsets
817
 
            final_offsets = self._expand_to_neighbors(offsets, cached_offsets,
818
 
                                                      total_pages)
819
 
 
820
 
        final_offsets = sorted(final_offsets)
 
734
                return node_indexes
 
735
 
 
736
            # Expand requests to neighbors until we have at least
 
737
            # recommended_pages to request. We only want to expand requests
 
738
            # within a given layer. We cheat a little bit and assume all
 
739
            # requests will be in the same layer. This is true given the
 
740
            # current design, but if it changes this algorithm may perform
 
741
            # oddly.
 
742
            final_nodes = set(node_indexes)
 
743
            first = end = None
 
744
            new_tips = set(final_nodes)
 
745
            while len(final_nodes) < self._recommended_pages and new_tips:
 
746
                next_tips = set()
 
747
                for pos in new_tips:
 
748
                    if first is None:
 
749
                        first, end = self._find_layer_first_and_end(pos)
 
750
                    previous = pos - 1
 
751
                    if (previous > 0
 
752
                        and previous not in cached_keys
 
753
                        and previous not in final_nodes
 
754
                        and previous >= first):
 
755
                        next_tips.add(previous)
 
756
                    after = pos + 1
 
757
                    if (after < num_pages
 
758
                        and after not in cached_keys
 
759
                        and after not in final_nodes
 
760
                        and after < end):
 
761
                        next_tips.add(after)
 
762
                    # This would keep us from going bigger than
 
763
                    # recommended_pages by only expanding the first nodes.
 
764
                    # However, if we are making a 'wide' request, it is
 
765
                    # reasonable to expand all points equally.
 
766
                    # if len(final_nodes) > recommended_pages:
 
767
                    #     break
 
768
                final_nodes.update(next_tips)
 
769
                new_tips = next_tips
 
770
 
 
771
        final_nodes = sorted(final_nodes)
821
772
        if 'index' in debug.debug_flags:
822
 
            trace.mutter('expanded:  %s', final_offsets)
823
 
        return final_offsets
824
 
 
825
 
    def _expand_to_neighbors(self, offsets, cached_offsets, total_pages):
826
 
        """Expand requests to neighbors until we have enough pages.
827
 
 
828
 
        This is called from _expand_offsets after policy has determined that we
829
 
        want to expand.
830
 
        We only want to expand requests within a given layer. We cheat a little
831
 
        bit and assume all requests will be in the same layer. This is true
832
 
        given the current design, but if it changes this algorithm may perform
833
 
        oddly.
834
 
 
835
 
        :param offsets: requested offsets
836
 
        :param cached_offsets: offsets for pages we currently have cached
837
 
        :return: A set() of offsets after expansion
838
 
        """
839
 
        final_offsets = set(offsets)
840
 
        first = end = None
841
 
        new_tips = set(final_offsets)
842
 
        while len(final_offsets) < self._recommended_pages and new_tips:
843
 
            next_tips = set()
844
 
            for pos in new_tips:
845
 
                if first is None:
846
 
                    first, end = self._find_layer_first_and_end(pos)
847
 
                previous = pos - 1
848
 
                if (previous > 0
849
 
                    and previous not in cached_offsets
850
 
                    and previous not in final_offsets
851
 
                    and previous >= first):
852
 
                    next_tips.add(previous)
853
 
                after = pos + 1
854
 
                if (after < total_pages
855
 
                    and after not in cached_offsets
856
 
                    and after not in final_offsets
857
 
                    and after < end):
858
 
                    next_tips.add(after)
859
 
                # This would keep us from going bigger than
860
 
                # recommended_pages by only expanding the first offsets.
861
 
                # However, if we are making a 'wide' request, it is
862
 
                # reasonable to expand all points equally.
863
 
                # if len(final_offsets) > recommended_pages:
864
 
                #     break
865
 
            final_offsets.update(next_tips)
866
 
            new_tips = next_tips
867
 
        return final_offsets
868
 
 
869
 
    def clear_cache(self):
870
 
        """Clear out any cached/memoized values.
871
 
 
872
 
        This can be called at any time, but generally it is used when we have
873
 
        extracted some information, but don't expect to be requesting any more
874
 
        from this index.
875
 
        """
876
 
        # Note that we don't touch self._root_node or self._internal_node_cache
877
 
        # We don't expect either of those to be big, and it can save
878
 
        # round-trips in the future. We may re-evaluate this if InternalNode
879
 
        # memory starts to be an issue.
880
 
        self._leaf_node_cache.clear()
881
 
 
882
 
    def external_references(self, ref_list_num):
883
 
        if self._root_node is None:
884
 
            self._get_root_node()
885
 
        if ref_list_num + 1 > self.node_ref_lists:
886
 
            raise ValueError('No ref list %d, index has %d ref lists'
887
 
                % (ref_list_num, self.node_ref_lists))
888
 
        keys = set()
889
 
        refs = set()
890
 
        for node in self.iter_all_entries():
891
 
            keys.add(node[1])
892
 
            refs.update(node[3][ref_list_num])
893
 
        return refs - keys
 
773
            trace.mutter('expanded:  %s', final_nodes)
 
774
        return final_nodes
894
775
 
895
776
    def _find_layer_first_and_end(self, offset):
896
777
        """Find the start/stop nodes for the layer corresponding to offset.
907
788
                break
908
789
        return first, end
909
790
 
910
 
    def _get_offsets_to_cached_pages(self):
 
791
    def _get_cached_keys(self):
911
792
        """Determine what nodes we already have cached."""
912
 
        cached_offsets = set(self._internal_node_cache.keys())
913
 
        cached_offsets.update(self._leaf_node_cache.keys())
 
793
        cached_keys = set(self._internal_node_cache.keys())
 
794
        cached_keys.update(self._leaf_node_cache.keys())
914
795
        if self._root_node is not None:
915
 
            cached_offsets.add(0)
916
 
        return cached_offsets
 
796
            cached_keys.add(0)
 
797
        return cached_keys
917
798
 
918
799
    def _get_root_node(self):
919
800
        if self._root_node is None:
934
815
                needed.append(idx)
935
816
        if not needed:
936
817
            return found
937
 
        needed = self._expand_offsets(needed)
 
818
        needed = self._expand_nodes(needed)
938
819
        found.update(self._get_and_cache_nodes(needed))
939
820
        return found
940
821
 
945
826
        """
946
827
        return self._get_nodes(self._internal_node_cache, node_indexes)
947
828
 
948
 
    def _cache_leaf_values(self, nodes):
949
 
        """Cache directly from key => value, skipping the btree."""
 
829
    def _get_leaf_nodes(self, node_indexes):
 
830
        """Get a bunch of nodes, from cache or disk."""
 
831
        found = self._get_nodes(self._leaf_node_cache, node_indexes)
950
832
        if self._leaf_value_cache is not None:
951
 
            for node in nodes.itervalues():
 
833
            for node in found.itervalues():
952
834
                for key, value in node.keys.iteritems():
953
835
                    if key in self._leaf_value_cache:
954
836
                        # Don't add the rest of the keys, we've seen this node
955
837
                        # before.
956
838
                        break
957
839
                    self._leaf_value_cache[key] = value
958
 
 
959
 
    def _get_leaf_nodes(self, node_indexes):
960
 
        """Get a bunch of nodes, from cache or disk."""
961
 
        found = self._get_nodes(self._leaf_node_cache, node_indexes)
962
 
        self._cache_leaf_values(found)
963
840
        return found
964
841
 
965
842
    def iter_all_entries(self):
976
853
                "iter_all_entries scales with size of history.")
977
854
        if not self.key_count():
978
855
            return
979
 
        if self._row_offsets[-1] == 1:
980
 
            # There is only the root node, and we read that via key_count()
981
 
            if self.node_ref_lists:
982
 
                for key, (value, refs) in sorted(self._root_node.keys.items()):
983
 
                    yield (self, key, value, refs)
984
 
            else:
985
 
                for key, (value, refs) in sorted(self._root_node.keys.items()):
986
 
                    yield (self, key, value)
987
 
            return
988
856
        start_of_leaves = self._row_offsets[-2]
989
857
        end_of_leaves = self._row_offsets[-1]
990
 
        needed_offsets = range(start_of_leaves, end_of_leaves)
991
 
        if needed_offsets == [0]:
992
 
            # Special case when we only have a root node, as we have already
993
 
            # read everything
994
 
            nodes = [(0, self._root_node)]
995
 
        else:
996
 
            nodes = self._read_nodes(needed_offsets)
 
858
        needed_nodes = range(start_of_leaves, end_of_leaves)
997
859
        # We iterate strictly in-order so that we can use this function
998
860
        # for spilling index builds to disk.
999
861
        if self.node_ref_lists:
1000
 
            for _, node in nodes:
 
862
            for _, node in self._read_nodes(needed_nodes):
1001
863
                for key, (value, refs) in sorted(node.keys.items()):
1002
864
                    yield (self, key, value, refs)
1003
865
        else:
1004
 
            for _, node in nodes:
 
866
            for _, node in self._read_nodes(needed_nodes):
1005
867
                for key, (value, refs) in sorted(node.keys.items()):
1006
868
                    yield (self, key, value)
1007
869
 
1087
949
            output.append(cur_out)
1088
950
        return output
1089
951
 
1090
 
    def _walk_through_internal_nodes(self, keys):
1091
 
        """Take the given set of keys, and find the corresponding LeafNodes.
1092
 
 
1093
 
        :param keys: An unsorted iterable of keys to search for
1094
 
        :return: (nodes, index_and_keys)
1095
 
            nodes is a dict mapping {index: LeafNode}
1096
 
            keys_at_index is a list of tuples of [(index, [keys for Leaf])]
1097
 
        """
1098
 
        # 6 seconds spent in miss_torture using the sorted() line.
1099
 
        # Even with out of order disk IO it seems faster not to sort it when
1100
 
        # large queries are being made.
1101
 
        keys_at_index = [(0, sorted(keys))]
1102
 
 
1103
 
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
1104
 
            node_indexes = [idx for idx, s_keys in keys_at_index]
1105
 
            nodes = self._get_internal_nodes(node_indexes)
1106
 
 
1107
 
            next_nodes_and_keys = []
1108
 
            for node_index, sub_keys in keys_at_index:
1109
 
                node = nodes[node_index]
1110
 
                positions = self._multi_bisect_right(sub_keys, node.keys)
1111
 
                node_offset = next_row_start + node.offset
1112
 
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
1113
 
                                           for pos, s_keys in positions])
1114
 
            keys_at_index = next_nodes_and_keys
1115
 
        # We should now be at the _LeafNodes
1116
 
        node_indexes = [idx for idx, s_keys in keys_at_index]
1117
 
 
1118
 
        # TODO: We may *not* want to always read all the nodes in one
1119
 
        #       big go. Consider setting a max size on this.
1120
 
        nodes = self._get_leaf_nodes(node_indexes)
1121
 
        return nodes, keys_at_index
1122
 
 
1123
952
    def iter_entries(self, keys):
1124
953
        """Iterate over keys within the index.
1125
954
 
1163
992
        needed_keys = keys
1164
993
        if not needed_keys:
1165
994
            return
1166
 
        nodes, nodes_and_keys = self._walk_through_internal_nodes(needed_keys)
 
995
        # 6 seconds spent in miss_torture using the sorted() line.
 
996
        # Even with out of order disk IO it seems faster not to sort it when
 
997
        # large queries are being made.
 
998
        needed_keys = sorted(needed_keys)
 
999
 
 
1000
        nodes_and_keys = [(0, needed_keys)]
 
1001
 
 
1002
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
 
1003
            node_indexes = [idx for idx, s_keys in nodes_and_keys]
 
1004
            nodes = self._get_internal_nodes(node_indexes)
 
1005
 
 
1006
            next_nodes_and_keys = []
 
1007
            for node_index, sub_keys in nodes_and_keys:
 
1008
                node = nodes[node_index]
 
1009
                positions = self._multi_bisect_right(sub_keys, node.keys)
 
1010
                node_offset = next_row_start + node.offset
 
1011
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
 
1012
                                           for pos, s_keys in positions])
 
1013
            nodes_and_keys = next_nodes_and_keys
 
1014
        # We should now be at the _LeafNodes
 
1015
        node_indexes = [idx for idx, s_keys in nodes_and_keys]
 
1016
 
 
1017
        # TODO: We may *not* want to always read all the nodes in one
 
1018
        #       big go. Consider setting a max size on this.
 
1019
 
 
1020
        nodes = self._get_leaf_nodes(node_indexes)
1167
1021
        for node_index, sub_keys in nodes_and_keys:
1168
1022
            if not sub_keys:
1169
1023
                continue
1176
1030
                    else:
1177
1031
                        yield (self, next_sub_key, value)
1178
1032
 
1179
 
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
1180
 
        """Find the parent_map information for the set of keys.
1181
 
 
1182
 
        This populates the parent_map dict and missing_keys set based on the
1183
 
        queried keys. It also can fill out an arbitrary number of parents that
1184
 
        it finds while searching for the supplied keys.
1185
 
 
1186
 
        It is unlikely that you want to call this directly. See
1187
 
        "CombinedGraphIndex.find_ancestry()" for a more appropriate API.
1188
 
 
1189
 
        :param keys: A keys whose ancestry we want to return
1190
 
            Every key will either end up in 'parent_map' or 'missing_keys'.
1191
 
        :param ref_list_num: This index in the ref_lists is the parents we
1192
 
            care about.
1193
 
        :param parent_map: {key: parent_keys} for keys that are present in this
1194
 
            index. This may contain more entries than were in 'keys', that are
1195
 
            reachable ancestors of the keys requested.
1196
 
        :param missing_keys: keys which are known to be missing in this index.
1197
 
            This may include parents that were not directly requested, but we
1198
 
            were able to determine that they are not present in this index.
1199
 
        :return: search_keys    parents that were found but not queried to know
1200
 
            if they are missing or present. Callers can re-query this index for
1201
 
            those keys, and they will be placed into parent_map or missing_keys
1202
 
        """
1203
 
        if not self.key_count():
1204
 
            # We use key_count() to trigger reading the root node and
1205
 
            # determining info about this BTreeGraphIndex
1206
 
            # If we don't have any keys, then everything is missing
1207
 
            missing_keys.update(keys)
1208
 
            return set()
1209
 
        if ref_list_num >= self.node_ref_lists:
1210
 
            raise ValueError('No ref list %d, index has %d ref lists'
1211
 
                % (ref_list_num, self.node_ref_lists))
1212
 
 
1213
 
        # The main trick we are trying to accomplish is that when we find a
1214
 
        # key listing its parents, we expect that the parent key is also likely
1215
 
        # to sit on the same page. Allowing us to expand parents quickly
1216
 
        # without suffering the full stack of bisecting, etc.
1217
 
        nodes, nodes_and_keys = self._walk_through_internal_nodes(keys)
1218
 
 
1219
 
        # These are parent keys which could not be immediately resolved on the
1220
 
        # page where the child was present. Note that we may already be
1221
 
        # searching for that key, and it may actually be present [or known
1222
 
        # missing] on one of the other pages we are reading.
1223
 
        # TODO:
1224
 
        #   We could try searching for them in the immediate previous or next
1225
 
        #   page. If they occur "later" we could put them in a pending lookup
1226
 
        #   set, and then for each node we read thereafter we could check to
1227
 
        #   see if they are present.
1228
 
        #   However, we don't know the impact of keeping this list of things
1229
 
        #   that I'm going to search for every node I come across from here on
1230
 
        #   out.
1231
 
        #   It doesn't handle the case when the parent key is missing on a
1232
 
        #   page that we *don't* read. So we already have to handle being
1233
 
        #   re-entrant for that.
1234
 
        #   Since most keys contain a date string, they are more likely to be
1235
 
        #   found earlier in the file than later, but we would know that right
1236
 
        #   away (key < min_key), and wouldn't keep searching it on every other
1237
 
        #   page that we read.
1238
 
        #   Mostly, it is an idea, one which should be benchmarked.
1239
 
        parents_not_on_page = set()
1240
 
 
1241
 
        for node_index, sub_keys in nodes_and_keys:
1242
 
            if not sub_keys:
1243
 
                continue
1244
 
            # sub_keys is all of the keys we are looking for that should exist
1245
 
            # on this page, if they aren't here, then they won't be found
1246
 
            node = nodes[node_index]
1247
 
            node_keys = node.keys
1248
 
            parents_to_check = set()
1249
 
            for next_sub_key in sub_keys:
1250
 
                if next_sub_key not in node_keys:
1251
 
                    # This one is just not present in the index at all
1252
 
                    missing_keys.add(next_sub_key)
1253
 
                else:
1254
 
                    value, refs = node_keys[next_sub_key]
1255
 
                    parent_keys = refs[ref_list_num]
1256
 
                    parent_map[next_sub_key] = parent_keys
1257
 
                    parents_to_check.update(parent_keys)
1258
 
            # Don't look for things we've already found
1259
 
            parents_to_check = parents_to_check.difference(parent_map)
1260
 
            # this can be used to test the benefit of having the check loop
1261
 
            # inlined.
1262
 
            # parents_not_on_page.update(parents_to_check)
1263
 
            # continue
1264
 
            while parents_to_check:
1265
 
                next_parents_to_check = set()
1266
 
                for key in parents_to_check:
1267
 
                    if key in node_keys:
1268
 
                        value, refs = node_keys[key]
1269
 
                        parent_keys = refs[ref_list_num]
1270
 
                        parent_map[key] = parent_keys
1271
 
                        next_parents_to_check.update(parent_keys)
1272
 
                    else:
1273
 
                        # This parent either is genuinely missing, or should be
1274
 
                        # found on another page. Perf test whether it is better
1275
 
                        # to check if this node should fit on this page or not.
1276
 
                        # in the 'everything-in-one-pack' scenario, this *not*
1277
 
                        # doing the check is 237ms vs 243ms.
1278
 
                        # So slightly better, but I assume the standard 'lots
1279
 
                        # of packs' is going to show a reasonable improvement
1280
 
                        # from the check, because it avoids 'going around
1281
 
                        # again' for everything that is in another index
1282
 
                        # parents_not_on_page.add(key)
1283
 
                        # Missing for some reason
1284
 
                        if key < node.min_key:
1285
 
                            # in the case of bzr.dev, 3.4k/5.3k misses are
1286
 
                            # 'earlier' misses (65%)
1287
 
                            parents_not_on_page.add(key)
1288
 
                        elif key > node.max_key:
1289
 
                            # This parent key would be present on a different
1290
 
                            # LeafNode
1291
 
                            parents_not_on_page.add(key)
1292
 
                        else:
1293
 
                            # assert key != node.min_key and key != node.max_key
1294
 
                            # If it was going to be present, it would be on
1295
 
                            # *this* page, so mark it missing.
1296
 
                            missing_keys.add(key)
1297
 
                parents_to_check = next_parents_to_check.difference(parent_map)
1298
 
                # Might want to do another .difference() from missing_keys
1299
 
        # parents_not_on_page could have been found on a different page, or be
1300
 
        # known to be missing. So cull out everything that has already been
1301
 
        # found.
1302
 
        search_keys = parents_not_on_page.difference(
1303
 
            parent_map).difference(missing_keys)
1304
 
        return search_keys
1305
 
 
1306
1033
    def iter_entries_prefix(self, keys):
1307
1034
        """Iterate over keys within the index using prefix matching.
1308
1035
 
1486
1213
        """Read some nodes from disk into the LRU cache.
1487
1214
 
1488
1215
        This performs a readv to get the node data into memory, and parses each
1489
 
        node, then yields it to the caller. The nodes are requested in the
 
1216
        node, the yields it to the caller. The nodes are requested in the
1490
1217
        supplied order. If possible doing sort() on the list before requesting
1491
1218
        a read may improve performance.
1492
1219
 
1493
1220
        :param nodes: The nodes to read. 0 - first node, 1 - second node etc.
1494
1221
        :return: None
1495
1222
        """
1496
 
        # may be the byte string of the whole file
1497
 
        bytes = None
1498
 
        # list of (offset, length) regions of the file that should, evenually
1499
 
        # be read in to data_ranges, either from 'bytes' or from the transport
1500
1223
        ranges = []
1501
 
        base_offset = self._base_offset
1502
1224
        for index in nodes:
1503
 
            offset = (index * _PAGE_SIZE)
 
1225
            offset = index * _PAGE_SIZE
1504
1226
            size = _PAGE_SIZE
1505
1227
            if index == 0:
1506
1228
                # Root node - special case
1507
1229
                if self._size:
1508
1230
                    size = min(_PAGE_SIZE, self._size)
1509
1231
                else:
1510
 
                    # The only case where we don't know the size, is for very
1511
 
                    # small indexes. So we read the whole thing
1512
 
                    bytes = self._transport.get_bytes(self._name)
1513
 
                    num_bytes = len(bytes)
1514
 
                    self._size = num_bytes - base_offset
1515
 
                    # the whole thing should be parsed out of 'bytes'
1516
 
                    ranges = [(start, min(_PAGE_SIZE, num_bytes - start))
1517
 
                        for start in xrange(base_offset, num_bytes, _PAGE_SIZE)]
1518
 
                    break
 
1232
                    stream = self._transport.get(self._name)
 
1233
                    start = stream.read(_PAGE_SIZE)
 
1234
                    # Avoid doing this again
 
1235
                    self._size = len(start)
 
1236
                    size = min(_PAGE_SIZE, self._size)
1519
1237
            else:
1520
1238
                if offset > self._size:
1521
1239
                    raise AssertionError('tried to read past the end'
1522
1240
                                         ' of the file %s > %s'
1523
1241
                                         % (offset, self._size))
1524
1242
                size = min(size, self._size - offset)
1525
 
            ranges.append((base_offset + offset, size))
 
1243
            ranges.append((offset, size))
1526
1244
        if not ranges:
1527
1245
            return
1528
 
        elif bytes is not None:
1529
 
            # already have the whole file
1530
 
            data_ranges = [(start, bytes[start:start+size])
1531
 
                           for start, size in ranges]
1532
 
        elif self._file is None:
 
1246
        if self._file is None:
1533
1247
            data_ranges = self._transport.readv(self._name, ranges)
1534
1248
        else:
1535
1249
            data_ranges = []
1537
1251
                self._file.seek(offset)
1538
1252
                data_ranges.append((offset, self._file.read(size)))
1539
1253
        for offset, data in data_ranges:
1540
 
            offset -= base_offset
1541
1254
            if offset == 0:
1542
1255
                # extract the header
1543
1256
                offset, data = self._parse_header_from_bytes(data)
1571
1284
 
1572
1285
 
1573
1286
try:
1574
 
    from bzrlib import _btree_serializer_pyx as _btree_serializer
1575
 
except ImportError, e:
1576
 
    osutils.failed_to_load_extension(e)
 
1287
    from bzrlib import _btree_serializer_c as _btree_serializer
 
1288
except ImportError:
1577
1289
    from bzrlib import _btree_serializer_py as _btree_serializer