~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/btree_index.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-02 06:24:16 UTC
  • mfrom: (3635.1.3 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080902062416-dxdxccqki90bcynl
(robertc) Fix repack operations on SMB connections. (Robert Collins,
        bug 255656).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2008-2011 Canonical Ltd
 
1
# Copyright (C) 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
#
17
17
 
18
18
"""B+Tree indices"""
19
19
 
20
 
from __future__ import absolute_import
21
 
 
22
 
import cStringIO
23
 
 
24
 
from bzrlib.lazy_import import lazy_import
25
 
lazy_import(globals(), """
 
20
import array
26
21
import bisect
 
22
from bisect import bisect_right
 
23
from copy import deepcopy
27
24
import math
 
25
import sha
 
26
import struct
28
27
import tempfile
29
28
import zlib
30
 
""")
31
29
 
32
30
from bzrlib import (
33
31
    chunk_writer,
34
32
    debug,
35
33
    errors,
36
 
    fifo_cache,
37
34
    index,
38
35
    lru_cache,
39
36
    osutils,
40
 
    static_tuple,
41
37
    trace,
42
 
    transport,
43
38
    )
44
39
from bzrlib.index import _OPTION_NODE_REFS, _OPTION_KEY_ELEMENTS, _OPTION_LEN
 
40
from bzrlib.osutils import basename, dirname
 
41
from bzrlib.transport import get_transport
45
42
 
46
43
 
47
44
_BTSIGNATURE = "B+Tree Graph Index 2\n"
68
65
    def __init__(self):
69
66
        """Create a _BuilderRow."""
70
67
        self.nodes = 0
71
 
        self.spool = None# tempfile.TemporaryFile(prefix='bzr-index-row-')
 
68
        self.spool = tempfile.TemporaryFile()
72
69
        self.writer = None
73
70
 
74
71
    def finish_node(self, pad=True):
75
72
        byte_lines, _, padding = self.writer.finish()
76
73
        if self.nodes == 0:
77
 
            self.spool = cStringIO.StringIO()
78
74
            # padded note:
79
75
            self.spool.write("\x00" * _RESERVED_HEADER_BYTES)
80
 
        elif self.nodes == 1:
81
 
            # We got bigger than 1 node, switch to a temp file
82
 
            spool = tempfile.TemporaryFile(prefix='bzr-index-row-')
83
 
            spool.write(self.spool.getvalue())
84
 
            self.spool = spool
85
76
        skipped_bytes = 0
86
77
        if not pad and padding:
87
78
            del byte_lines[-1]
88
79
            skipped_bytes = padding
89
80
        self.spool.writelines(byte_lines)
90
 
        remainder = (self.spool.tell() + skipped_bytes) % _PAGE_SIZE
91
 
        if remainder != 0:
92
 
            raise AssertionError("incorrect node length: %d, %d"
93
 
                                 % (self.spool.tell(), remainder))
 
81
        if (self.spool.tell() + skipped_bytes) % _PAGE_SIZE != 0:
 
82
            raise AssertionError("incorrect node length")
94
83
        self.nodes += 1
95
84
        self.writer = None
96
85
 
146
135
            key_elements=key_elements)
147
136
        self._spill_at = spill_at
148
137
        self._backing_indices = []
149
 
        # A map of {key: (node_refs, value)}
150
 
        self._nodes = {}
151
 
        # Indicate it hasn't been built yet
152
 
        self._nodes_by_key = None
153
 
        self._optimize_for_size = False
154
138
 
155
139
    def add_node(self, key, value, references=()):
156
140
        """Add a node to the index.
164
148
        :param references: An iterable of iterables of keys. Each is a
165
149
            reference to another key.
166
150
        :param value: The value to associate with the key. It may be any
167
 
            bytes as long as it does not contain \\0 or \\n.
 
151
            bytes as long as it does not contain \0 or \n.
168
152
        """
169
 
        # Ensure that 'key' is a StaticTuple
170
 
        key = static_tuple.StaticTuple.from_sequence(key).intern()
171
 
        # we don't care about absent_references
172
 
        node_refs, _ = self._check_key_ref_value(key, references, value)
173
 
        if key in self._nodes:
174
 
            raise errors.BadIndexDuplicateKey(key, self)
175
 
        self._nodes[key] = static_tuple.StaticTuple(node_refs, value)
176
 
        if self._nodes_by_key is not None and self._key_length > 1:
177
 
            self._update_nodes_by_key(key, value, node_refs)
178
 
        if len(self._nodes) < self._spill_at:
 
153
        index.GraphIndexBuilder.add_node(self, key, value, references=references)
 
154
        if len(self._keys) < self._spill_at:
179
155
            return
180
 
        self._spill_mem_keys_to_disk()
181
 
 
182
 
    def _spill_mem_keys_to_disk(self):
183
 
        """Write the in memory keys down to disk to cap memory consumption.
184
 
 
185
 
        If we already have some keys written to disk, we will combine them so
186
 
        as to preserve the sorted order.  The algorithm for combining uses
187
 
        powers of two.  So on the first spill, write all mem nodes into a
188
 
        single index. On the second spill, combine the mem nodes with the nodes
189
 
        on disk to create a 2x sized disk index and get rid of the first index.
190
 
        On the third spill, create a single new disk index, which will contain
191
 
        the mem nodes, and preserve the existing 2x sized index.  On the fourth,
192
 
        combine mem with the first and second indexes, creating a new one of
193
 
        size 4x. On the fifth create a single new one, etc.
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):
221
 
        iterators_to_combine = [self._iter_mem_nodes()]
 
156
        iterators_to_combine = [iter(sorted(self._iter_mem_nodes()))]
222
157
        pos = -1
223
158
        for pos, backing in enumerate(self._backing_indices):
224
159
            if backing is None:
227
162
            iterators_to_combine.append(backing.iter_all_entries())
228
163
        backing_pos = pos + 1
229
164
        new_backing_file, size = \
230
 
            self._write_nodes(self._iter_smallest(iterators_to_combine),
231
 
                              allow_optimize=False)
232
 
        return new_backing_file, size, backing_pos
 
165
            self._write_nodes(self._iter_smallest(iterators_to_combine))
 
166
        new_backing = BTreeGraphIndex(
 
167
            get_transport(dirname(new_backing_file.name)),
 
168
            basename(new_backing_file.name), size)
 
169
        # GC will clean up the file
 
170
        new_backing._file = new_backing_file
 
171
        if len(self._backing_indices) == backing_pos:
 
172
            self._backing_indices.append(None)
 
173
        self._backing_indices[backing_pos] = new_backing
 
174
        for pos in range(backing_pos):
 
175
            self._backing_indices[pos] = None
 
176
        self._keys = set()
 
177
        self._nodes = {}
 
178
        self._nodes_by_key = {}
233
179
 
234
180
    def add_nodes(self, nodes):
235
181
        """Add nodes to the index.
245
191
 
246
192
    def _iter_mem_nodes(self):
247
193
        """Iterate over the nodes held in memory."""
248
 
        nodes = self._nodes
249
194
        if self.reference_lists:
250
 
            for key in sorted(nodes):
251
 
                references, value = nodes[key]
252
 
                yield self, key, value, references
 
195
            for key, (absent, references, value) in self._nodes.iteritems():
 
196
                if not absent:
 
197
                    yield self, key, value, references
253
198
        else:
254
 
            for key in sorted(nodes):
255
 
                references, value = nodes[key]
256
 
                yield self, key, value
 
199
            for key, (absent, references, value) in self._nodes.iteritems():
 
200
                if not absent:
 
201
                    yield self, key, value
257
202
 
258
203
    def _iter_smallest(self, iterators_to_combine):
259
204
        if len(iterators_to_combine) == 1:
287
232
            except StopIteration:
288
233
                current_values[pos] = None
289
234
 
290
 
    def _add_key(self, string_key, line, rows, allow_optimize=True):
 
235
    def _add_key(self, string_key, line, rows):
291
236
        """Add a key to the current chunk.
292
237
 
293
238
        :param string_key: The key to add.
294
239
        :param line: The fully serialised key and value.
295
 
        :param allow_optimize: If set to False, prevent setting the optimize
296
 
            flag when writing out. This is used by the _spill_mem_keys_to_disk
297
 
            functionality.
298
240
        """
299
 
        new_leaf = False
300
241
        if rows[-1].writer is None:
301
242
            # opening a new leaf chunk;
302
 
            new_leaf = True
303
243
            for pos, internal_row in enumerate(rows[:-1]):
304
244
                # flesh out any internal nodes that are needed to
305
245
                # preserve the height of the tree
307
247
                    length = _PAGE_SIZE
308
248
                    if internal_row.nodes == 0:
309
249
                        length -= _RESERVED_HEADER_BYTES # padded
310
 
                    if allow_optimize:
311
 
                        optimize_for_size = self._optimize_for_size
312
 
                    else:
313
 
                        optimize_for_size = False
314
 
                    internal_row.writer = chunk_writer.ChunkWriter(length, 0,
315
 
                        optimize_for_size=optimize_for_size)
 
250
                    internal_row.writer = chunk_writer.ChunkWriter(length, 0)
316
251
                    internal_row.writer.write(_INTERNAL_FLAG)
317
252
                    internal_row.writer.write(_INTERNAL_OFFSET +
318
253
                        str(rows[pos + 1].nodes) + "\n")
320
255
            length = _PAGE_SIZE
321
256
            if rows[-1].nodes == 0:
322
257
                length -= _RESERVED_HEADER_BYTES # padded
323
 
            rows[-1].writer = chunk_writer.ChunkWriter(length,
324
 
                optimize_for_size=self._optimize_for_size)
 
258
            rows[-1].writer = chunk_writer.ChunkWriter(length)
325
259
            rows[-1].writer.write(_LEAF_FLAG)
326
260
        if rows[-1].writer.write(line):
327
 
            # if we failed to write, despite having an empty page to write to,
328
 
            # then line is too big. raising the error avoids infinite recursion
329
 
            # searching for a suitably large page that will not be found.
330
 
            if new_leaf:
331
 
                raise errors.BadIndexKey(string_key)
332
261
            # this key did not fit in the node:
333
262
            rows[-1].finish_node()
334
263
            key_line = string_key + "\n"
335
264
            new_row = True
336
265
            for row in reversed(rows[:-1]):
337
266
                # Mark the start of the next node in the node above. If it
338
 
                # doesn't fit then propagate upwards until we find one that
 
267
                # doesn't fit then propogate upwards until we find one that
339
268
                # it does fit into.
340
269
                if row.writer.write(key_line):
341
270
                    row.finish_node()
355
284
                # This will be padded, hence the -100
356
285
                new_row.writer = chunk_writer.ChunkWriter(
357
286
                    _PAGE_SIZE - _RESERVED_HEADER_BYTES,
358
 
                    reserved_bytes,
359
 
                    optimize_for_size=self._optimize_for_size)
 
287
                    reserved_bytes)
360
288
                new_row.writer.write(_INTERNAL_FLAG)
361
289
                new_row.writer.write(_INTERNAL_OFFSET +
362
290
                    str(rows[1].nodes - 1) + "\n")
363
291
                new_row.writer.write(key_line)
364
 
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
 
292
            self._add_key(string_key, line, rows)
365
293
 
366
 
    def _write_nodes(self, node_iterator, allow_optimize=True):
 
294
    def _write_nodes(self, node_iterator):
367
295
        """Write node_iterator out as a B+Tree.
368
296
 
369
297
        :param node_iterator: An iterator of sorted nodes. Each node should
370
298
            match the output given by iter_all_entries.
371
 
        :param allow_optimize: If set to False, prevent setting the optimize
372
 
            flag when writing out. This is used by the _spill_mem_keys_to_disk
373
 
            functionality.
374
299
        :return: A file handle for a temporary file containing a B+Tree for
375
300
            the nodes.
376
301
        """
386
311
        self.row_lengths = []
387
312
        # Loop over all nodes adding them to the bottom row
388
313
        # (rows[-1]). When we finish a chunk in a row,
389
 
        # propagate the key that didn't fit (comes after the chunk) to the
 
314
        # propogate the key that didn't fit (comes after the chunk) to the
390
315
        # row above, transitively.
391
316
        for node in node_iterator:
392
317
            if key_count == 0:
393
318
                # First key triggers the first row
394
319
                rows.append(_LeafBuilderRow())
395
320
            key_count += 1
 
321
            # TODO: Flattening the node into a string key and a line should
 
322
            #       probably be put into a pyrex function. We can do a quick
 
323
            #       iter over all the entries to determine the final length,
 
324
            #       and then do a single malloc() rather than lots of
 
325
            #       intermediate mallocs as we build everything up.
 
326
            #       ATM 3 / 13s are spent flattening nodes (10s is compressing)
396
327
            string_key, line = _btree_serializer._flatten_node(node,
397
328
                                    self.reference_lists)
398
 
            self._add_key(string_key, line, rows, allow_optimize=allow_optimize)
 
329
            self._add_key(string_key, line, rows)
399
330
        for row in reversed(rows):
400
331
            pad = (type(row) != _LeafBuilderRow)
401
332
            row.finish_node(pad=pad)
 
333
        result = tempfile.NamedTemporaryFile()
402
334
        lines = [_BTSIGNATURE]
403
335
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
404
336
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
405
337
        lines.append(_OPTION_LEN + str(key_count) + '\n')
406
338
        row_lengths = [row.nodes for row in rows]
407
339
        lines.append(_OPTION_ROW_LENGTHS + ','.join(map(str, row_lengths)) + '\n')
408
 
        if row_lengths and row_lengths[-1] > 1:
409
 
            result = tempfile.NamedTemporaryFile(prefix='bzr-index-')
410
 
        else:
411
 
            result = cStringIO.StringIO()
412
340
        result.writelines(lines)
413
341
        position = sum(map(len, lines))
414
342
        root_row = True
425
353
            # Special case the first node as it may be prefixed
426
354
            node = row.spool.read(_PAGE_SIZE)
427
355
            result.write(node[reserved:])
428
 
            if len(node) == _PAGE_SIZE:
429
 
                result.write("\x00" * (reserved - position))
 
356
            result.write("\x00" * (reserved - position))
430
357
            position = 0 # Only the root row actually has an offset
431
358
            copied_len = osutils.pumpfile(row.spool, result)
432
359
            if copied_len != (row.nodes - 1) * _PAGE_SIZE:
433
360
                if type(row) != _LeafBuilderRow:
434
 
                    raise AssertionError("Incorrect amount of data copied"
435
 
                        " expected: %d, got: %d"
436
 
                        % ((row.nodes - 1) * _PAGE_SIZE,
437
 
                           copied_len))
 
361
                    raise AssertionError("Not enough data copied")
438
362
        result.flush()
439
363
        size = result.tell()
440
364
        result.seek(0)
451
375
    def iter_all_entries(self):
452
376
        """Iterate over all keys within the index
453
377
 
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
 
378
        :return: An iterable of (index, key, reference_lists, value). There is no
 
379
            defined order for the result iteration - it will be in the most
456
380
            efficient order for the index (in this case dictionary hash order).
457
381
        """
458
382
        if 'evil' in debug.debug_flags:
460
384
                "iter_all_entries scales with size of history.")
461
385
        # Doing serial rather than ordered would be faster; but this shouldn't
462
386
        # be getting called routinely anyway.
463
 
        iterators = [self._iter_mem_nodes()]
 
387
        iterators = [iter(sorted(self._iter_mem_nodes()))]
464
388
        for backing in self._backing_indices:
465
389
            if backing is not None:
466
390
                iterators.append(backing.iter_all_entries())
477
401
            efficient order for the index (keys iteration order in this case).
478
402
        """
479
403
        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]
489
404
        if self.reference_lists:
490
 
            for key in local_keys:
491
 
                node = nodes[key]
492
 
                yield self, key, node[1], node[0]
 
405
            for key in keys.intersection(self._keys):
 
406
                node = self._nodes[key]
 
407
                if not node[0]:
 
408
                    yield self, key, node[2], node[1]
493
409
        else:
494
 
            for key in local_keys:
495
 
                node = nodes[key]
496
 
                yield self, key, node[1]
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)
 
410
            for key in keys.intersection(self._keys):
 
411
                node = self._nodes[key]
 
412
                if not node[0]:
 
413
                    yield self, key, node[2]
 
414
        keys.difference_update(self._keys)
503
415
        for backing in self._backing_indices:
504
416
            if backing is None:
505
417
                continue
547
459
                    node = self._nodes[key]
548
460
                except KeyError:
549
461
                    continue
 
462
                if node[0]:
 
463
                    continue
550
464
                if self.reference_lists:
551
 
                    yield self, key, node[1], node[0]
 
465
                    yield self, key, node[2], node[1]
552
466
                else:
553
 
                    yield self, key, node[1]
 
467
                    yield self, key, node[2]
554
468
            return
555
469
        for key in keys:
556
470
            # sanity check
559
473
            if len(key) != self._key_length:
560
474
                raise errors.BadIndexKey(key)
561
475
            # find what it refers to:
562
 
            key_dict = self._get_nodes_by_key()
 
476
            key_dict = self._nodes_by_key
563
477
            elements = list(key)
564
478
            # find the subdict to return
565
479
            try:
581
495
                    else:
582
496
                        # yield keys
583
497
                        for value in key_dict.itervalues():
584
 
                            yield (self, ) + tuple(value)
 
498
                            yield (self, ) + value
585
499
            else:
586
500
                yield (self, ) + key_dict
587
501
 
588
 
    def _get_nodes_by_key(self):
589
 
        if self._nodes_by_key is None:
590
 
            nodes_by_key = {}
591
 
            if self.reference_lists:
592
 
                for key, (references, value) in self._nodes.iteritems():
593
 
                    key_dict = nodes_by_key
594
 
                    for subkey in key[:-1]:
595
 
                        key_dict = key_dict.setdefault(subkey, {})
596
 
                    key_dict[key[-1]] = key, value, references
597
 
            else:
598
 
                for key, (references, value) in self._nodes.iteritems():
599
 
                    key_dict = nodes_by_key
600
 
                    for subkey in key[:-1]:
601
 
                        key_dict = key_dict.setdefault(subkey, {})
602
 
                    key_dict[key[-1]] = key, value
603
 
            self._nodes_by_key = nodes_by_key
604
 
        return self._nodes_by_key
605
 
 
606
502
    def key_count(self):
607
503
        """Return an estimate of the number of keys in this index.
608
504
 
609
505
        For InMemoryGraphIndex the estimate is exact.
610
506
        """
611
 
        return len(self._nodes) + sum(backing.key_count() for backing in
 
507
        return len(self._keys) + sum(backing.key_count() for backing in
612
508
            self._backing_indices if backing is not None)
613
509
 
614
510
    def validate(self):
615
511
        """In memory index's have no known corruption at the moment."""
616
512
 
617
513
 
618
 
class _LeafNode(dict):
 
514
class _LeafNode(object):
619
515
    """A leaf node for a serialised B+Tree index."""
620
516
 
621
 
    __slots__ = ('min_key', 'max_key', '_keys')
622
 
 
623
517
    def __init__(self, bytes, key_length, ref_list_length):
624
518
        """Parse bytes to create a leaf node object."""
625
519
        # splitlines mangles the \r delimiters.. don't use it.
626
 
        key_list = _btree_serializer._parse_leaf_lines(bytes,
627
 
            key_length, ref_list_length)
628
 
        if key_list:
629
 
            self.min_key = key_list[0][0]
630
 
            self.max_key = key_list[-1][0]
631
 
        else:
632
 
            self.min_key = self.max_key = None
633
 
        super(_LeafNode, self).__init__(key_list)
634
 
        self._keys = dict(self)
635
 
 
636
 
    def all_items(self):
637
 
        """Return a sorted list of (key, (value, refs)) items"""
638
 
        items = self.items()
639
 
        items.sort()
640
 
        return items
641
 
 
642
 
    def all_keys(self):
643
 
        """Return a sorted list of all keys."""
644
 
        keys = self.keys()
645
 
        keys.sort()
646
 
        return keys
 
520
        self.keys = dict(_btree_serializer._parse_leaf_lines(bytes,
 
521
            key_length, ref_list_length))
647
522
 
648
523
 
649
524
class _InternalNode(object):
650
525
    """An internal node for a serialised B+Tree index."""
651
526
 
652
 
    __slots__ = ('keys', 'offset')
653
 
 
654
527
    def __init__(self, bytes):
655
528
        """Parse bytes to create an internal node object."""
656
529
        # splitlines mangles the \r delimiters.. don't use it.
659
532
    def _parse_lines(self, lines):
660
533
        nodes = []
661
534
        self.offset = int(lines[1][7:])
662
 
        as_st = static_tuple.StaticTuple.from_sequence
663
535
        for line in lines[2:]:
664
536
            if line == '':
665
537
                break
666
 
            nodes.append(as_st(map(intern, line.split('\0'))).intern())
 
538
            nodes.append(tuple(line.split('\0')))
667
539
        return nodes
668
540
 
669
541
 
674
546
    memory except when very large walks are done.
675
547
    """
676
548
 
677
 
    def __init__(self, transport, name, size, unlimited_cache=False,
678
 
                 offset=0):
 
549
    def __init__(self, transport, name, size):
679
550
        """Create a B+Tree index object on the index name.
680
551
 
681
552
        :param transport: The transport to read data for the index from.
685
556
            the initial read (to read the root node header) can be done
686
557
            without over-reading even on empty indices, and on small indices
687
558
            allows single-IO to read the entire index.
688
 
        :param unlimited_cache: If set to True, then instead of using an
689
 
            LRUCache with size _NODE_CACHE_SIZE, we will use a dict and always
690
 
            cache all leaf nodes.
691
 
        :param offset: The start of the btree index data isn't byte 0 of the
692
 
            file. Instead it starts at some point later.
693
559
        """
694
560
        self._transport = transport
695
561
        self._name = name
696
562
        self._size = size
697
563
        self._file = None
698
 
        self._recommended_pages = self._compute_recommended_pages()
 
564
        self._page_size = transport.recommended_page_size()
699
565
        self._root_node = None
700
 
        self._base_offset = offset
701
 
        self._leaf_factory = _LeafNode
702
566
        # Default max size is 100,000 leave values
703
567
        self._leaf_value_cache = None # lru_cache.LRUCache(100*1000)
704
 
        if unlimited_cache:
705
 
            self._leaf_node_cache = {}
706
 
            self._internal_node_cache = {}
707
 
        else:
708
 
            self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
709
 
            # We use a FIFO here just to prevent possible blowout. However, a
710
 
            # 300k record btree has only 3k leaf nodes, and only 20 internal
711
 
            # nodes. A value of 100 scales to ~100*100*100 = 1M records.
712
 
            self._internal_node_cache = fifo_cache.FIFOCache(100)
 
568
        self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
 
569
        self._internal_node_cache = lru_cache.LRUCache()
713
570
        self._key_count = None
714
571
        self._row_lengths = None
715
572
        self._row_offsets = None # Start of each row, [-1] is the end
725
582
    def __ne__(self, other):
726
583
        return not self.__eq__(other)
727
584
 
728
 
    def _get_and_cache_nodes(self, nodes):
 
585
    def _get_root_node(self):
 
586
        if self._root_node is None:
 
587
            # We may not have a root node yet
 
588
            nodes = list(self._read_nodes([0]))
 
589
            if len(nodes):
 
590
                self._root_node = nodes[0][1]
 
591
        return self._root_node
 
592
 
 
593
    def _cache_nodes(self, nodes, cache):
729
594
        """Read nodes and cache them in the lru.
730
595
 
731
596
        The nodes list supplied is sorted and then read from disk, each node
738
603
 
739
604
        :return: A dict of {node_pos: node}
740
605
        """
 
606
        if len(nodes) > cache._max_cache:
 
607
            trace.mutter('Requesting %s > %s nodes, not all will be cached',
 
608
                         len(nodes), cache._max_cache)
741
609
        found = {}
742
 
        start_of_leaves = None
743
610
        for node_pos, node in self._read_nodes(sorted(nodes)):
744
611
            if node_pos == 0: # Special case
745
612
                self._root_node = node
746
613
            else:
747
 
                if start_of_leaves is None:
748
 
                    start_of_leaves = self._row_offsets[-2]
749
 
                if node_pos < start_of_leaves:
750
 
                    self._internal_node_cache[node_pos] = node
751
 
                else:
752
 
                    self._leaf_node_cache[node_pos] = node
 
614
                cache.add(node_pos, node)
753
615
            found[node_pos] = node
754
616
        return found
755
617
 
756
 
    def _compute_recommended_pages(self):
757
 
        """Convert transport's recommended_page_size into btree pages.
758
 
 
759
 
        recommended_page_size is in bytes, we want to know how many _PAGE_SIZE
760
 
        pages fit in that length.
761
 
        """
762
 
        recommended_read = self._transport.recommended_page_size()
763
 
        recommended_pages = int(math.ceil(recommended_read /
764
 
                                          float(_PAGE_SIZE)))
765
 
        return recommended_pages
766
 
 
767
 
    def _compute_total_pages_in_index(self):
768
 
        """How many pages are in the index.
769
 
 
770
 
        If we have read the header we will use the value stored there.
771
 
        Otherwise it will be computed based on the length of the index.
772
 
        """
773
 
        if self._size is None:
774
 
            raise AssertionError('_compute_total_pages_in_index should not be'
775
 
                                 ' called when self._size is None')
776
 
        if self._root_node is not None:
777
 
            # This is the number of pages as defined by the header
778
 
            return self._row_offsets[-1]
779
 
        # This is the number of pages as defined by the size of the index. They
780
 
        # should be indentical.
781
 
        total_pages = int(math.ceil(self._size / float(_PAGE_SIZE)))
782
 
        return total_pages
783
 
 
784
 
    def _expand_offsets(self, offsets):
785
 
        """Find extra pages to download.
786
 
 
787
 
        The idea is that we always want to make big-enough requests (like 64kB
788
 
        for http), so that we don't waste round trips. So given the entries
789
 
        that we already have cached and the new pages being downloaded figure
790
 
        out what other pages we might want to read.
791
 
 
792
 
        See also doc/developers/btree_index_prefetch.txt for more details.
793
 
 
794
 
        :param offsets: The offsets to be read
795
 
        :return: A list of offsets to download
796
 
        """
797
 
        if 'index' in debug.debug_flags:
798
 
            trace.mutter('expanding: %s\toffsets: %s', self._name, offsets)
799
 
 
800
 
        if len(offsets) >= self._recommended_pages:
801
 
            # Don't add more, we are already requesting more than enough
802
 
            if 'index' in debug.debug_flags:
803
 
                trace.mutter('  not expanding large request (%s >= %s)',
804
 
                             len(offsets), self._recommended_pages)
805
 
            return offsets
806
 
        if self._size is None:
807
 
            # Don't try anything, because we don't know where the file ends
808
 
            if 'index' in debug.debug_flags:
809
 
                trace.mutter('  not expanding without knowing index size')
810
 
            return offsets
811
 
        total_pages = self._compute_total_pages_in_index()
812
 
        cached_offsets = self._get_offsets_to_cached_pages()
813
 
        # If reading recommended_pages would read the rest of the index, just
814
 
        # do so.
815
 
        if total_pages - len(cached_offsets) <= self._recommended_pages:
816
 
            # Read whatever is left
817
 
            if cached_offsets:
818
 
                expanded = [x for x in xrange(total_pages)
819
 
                               if x not in cached_offsets]
820
 
            else:
821
 
                expanded = range(total_pages)
822
 
            if 'index' in debug.debug_flags:
823
 
                trace.mutter('  reading all unread pages: %s', expanded)
824
 
            return expanded
825
 
 
826
 
        if self._root_node is None:
827
 
            # ATM on the first read of the root node of a large index, we don't
828
 
            # bother pre-reading any other pages. This is because the
829
 
            # likelyhood of actually reading interesting pages is very low.
830
 
            # See doc/developers/btree_index_prefetch.txt for a discussion, and
831
 
            # a possible implementation when we are guessing that the second
832
 
            # layer index is small
833
 
            final_offsets = offsets
834
 
        else:
835
 
            tree_depth = len(self._row_lengths)
836
 
            if len(cached_offsets) < tree_depth and len(offsets) == 1:
837
 
                # We haven't read enough to justify expansion
838
 
                # If we are only going to read the root node, and 1 leaf node,
839
 
                # then it isn't worth expanding our request. Once we've read at
840
 
                # least 2 nodes, then we are probably doing a search, and we
841
 
                # start expanding our requests.
842
 
                if 'index' in debug.debug_flags:
843
 
                    trace.mutter('  not expanding on first reads')
844
 
                return offsets
845
 
            final_offsets = self._expand_to_neighbors(offsets, cached_offsets,
846
 
                                                      total_pages)
847
 
 
848
 
        final_offsets = sorted(final_offsets)
849
 
        if 'index' in debug.debug_flags:
850
 
            trace.mutter('expanded:  %s', final_offsets)
851
 
        return final_offsets
852
 
 
853
 
    def _expand_to_neighbors(self, offsets, cached_offsets, total_pages):
854
 
        """Expand requests to neighbors until we have enough pages.
855
 
 
856
 
        This is called from _expand_offsets after policy has determined that we
857
 
        want to expand.
858
 
        We only want to expand requests within a given layer. We cheat a little
859
 
        bit and assume all requests will be in the same layer. This is true
860
 
        given the current design, but if it changes this algorithm may perform
861
 
        oddly.
862
 
 
863
 
        :param offsets: requested offsets
864
 
        :param cached_offsets: offsets for pages we currently have cached
865
 
        :return: A set() of offsets after expansion
866
 
        """
867
 
        final_offsets = set(offsets)
868
 
        first = end = None
869
 
        new_tips = set(final_offsets)
870
 
        while len(final_offsets) < self._recommended_pages and new_tips:
871
 
            next_tips = set()
872
 
            for pos in new_tips:
873
 
                if first is None:
874
 
                    first, end = self._find_layer_first_and_end(pos)
875
 
                previous = pos - 1
876
 
                if (previous > 0
877
 
                    and previous not in cached_offsets
878
 
                    and previous not in final_offsets
879
 
                    and previous >= first):
880
 
                    next_tips.add(previous)
881
 
                after = pos + 1
882
 
                if (after < total_pages
883
 
                    and after not in cached_offsets
884
 
                    and after not in final_offsets
885
 
                    and after < end):
886
 
                    next_tips.add(after)
887
 
                # This would keep us from going bigger than
888
 
                # recommended_pages by only expanding the first offsets.
889
 
                # However, if we are making a 'wide' request, it is
890
 
                # reasonable to expand all points equally.
891
 
                # if len(final_offsets) > recommended_pages:
892
 
                #     break
893
 
            final_offsets.update(next_tips)
894
 
            new_tips = next_tips
895
 
        return final_offsets
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
 
 
923
 
    def _find_layer_first_and_end(self, offset):
924
 
        """Find the start/stop nodes for the layer corresponding to offset.
925
 
 
926
 
        :return: (first, end)
927
 
            first is the first node in this layer
928
 
            end is the first node of the next layer
929
 
        """
930
 
        first = end = 0
931
 
        for roffset in self._row_offsets:
932
 
            first = end
933
 
            end = roffset
934
 
            if offset < roffset:
935
 
                break
936
 
        return first, end
937
 
 
938
 
    def _get_offsets_to_cached_pages(self):
939
 
        """Determine what nodes we already have cached."""
940
 
        cached_offsets = set(self._internal_node_cache.keys())
941
 
        cached_offsets.update(self._leaf_node_cache.keys())
942
 
        if self._root_node is not None:
943
 
            cached_offsets.add(0)
944
 
        return cached_offsets
945
 
 
946
 
    def _get_root_node(self):
947
 
        if self._root_node is None:
948
 
            # We may not have a root node yet
949
 
            self._get_internal_nodes([0])
950
 
        return self._root_node
951
 
 
952
618
    def _get_nodes(self, cache, node_indexes):
953
619
        found = {}
954
620
        needed = []
960
626
                found[idx] = cache[idx]
961
627
            except KeyError:
962
628
                needed.append(idx)
963
 
        if not needed:
964
 
            return found
965
 
        needed = self._expand_offsets(needed)
966
 
        found.update(self._get_and_cache_nodes(needed))
 
629
        found.update(self._cache_nodes(needed, cache))
967
630
        return found
968
631
 
969
632
    def _get_internal_nodes(self, node_indexes):
973
636
        """
974
637
        return self._get_nodes(self._internal_node_cache, node_indexes)
975
638
 
976
 
    def _cache_leaf_values(self, nodes):
977
 
        """Cache directly from key => value, skipping the btree."""
 
639
    def _get_leaf_nodes(self, node_indexes):
 
640
        """Get a bunch of nodes, from cache or disk."""
 
641
        found = self._get_nodes(self._leaf_node_cache, node_indexes)
978
642
        if self._leaf_value_cache is not None:
979
 
            for node in nodes.itervalues():
980
 
                for key, value in node.all_items():
 
643
            for node in found.itervalues():
 
644
                for key, value in node.keys.iteritems():
981
645
                    if key in self._leaf_value_cache:
982
646
                        # Don't add the rest of the keys, we've seen this node
983
647
                        # before.
984
648
                        break
985
649
                    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)
991
650
        return found
992
651
 
993
652
    def iter_all_entries(self):
1004
663
                "iter_all_entries scales with size of history.")
1005
664
        if not self.key_count():
1006
665
            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
1016
666
        start_of_leaves = self._row_offsets[-2]
1017
667
        end_of_leaves = self._row_offsets[-1]
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)
 
668
        needed_nodes = range(start_of_leaves, end_of_leaves)
1025
669
        # We iterate strictly in-order so that we can use this function
1026
670
        # for spilling index builds to disk.
1027
671
        if self.node_ref_lists:
1028
 
            for _, node in nodes:
1029
 
                for key, (value, refs) in node.all_items():
 
672
            for _, node in self._read_nodes(needed_nodes):
 
673
                for key, (value, refs) in sorted(node.keys.items()):
1030
674
                    yield (self, key, value, refs)
1031
675
        else:
1032
 
            for _, node in nodes:
1033
 
                for key, (value, refs) in node.all_items():
 
676
            for _, node in self._read_nodes(needed_nodes):
 
677
                for key, (value, refs) in sorted(node.keys.items()):
1034
678
                    yield (self, key, value)
1035
679
 
1036
680
    @staticmethod
1060
704
        # iter_steps = len(in_keys) + len(fixed_keys)
1061
705
        # bisect_steps = len(in_keys) * math.log(len(fixed_keys), 2)
1062
706
        if len(in_keys) == 1: # Bisect will always be faster for M = 1
1063
 
            return [(bisect.bisect_right(fixed_keys, in_keys[0]), in_keys)]
 
707
            return [(bisect_right(fixed_keys, in_keys[0]), in_keys)]
1064
708
        # elif bisect_steps < iter_steps:
1065
709
        #     offsets = {}
1066
710
        #     for key in in_keys:
1115
759
            output.append(cur_out)
1116
760
        return output
1117
761
 
1118
 
    def _walk_through_internal_nodes(self, keys):
1119
 
        """Take the given set of keys, and find the corresponding LeafNodes.
1120
 
 
1121
 
        :param keys: An unsorted iterable of keys to search for
1122
 
        :return: (nodes, index_and_keys)
1123
 
            nodes is a dict mapping {index: LeafNode}
1124
 
            keys_at_index is a list of tuples of [(index, [keys for Leaf])]
1125
 
        """
1126
 
        # 6 seconds spent in miss_torture using the sorted() line.
1127
 
        # Even with out of order disk IO it seems faster not to sort it when
1128
 
        # large queries are being made.
1129
 
        keys_at_index = [(0, sorted(keys))]
1130
 
 
1131
 
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
1132
 
            node_indexes = [idx for idx, s_keys in keys_at_index]
1133
 
            nodes = self._get_internal_nodes(node_indexes)
1134
 
 
1135
 
            next_nodes_and_keys = []
1136
 
            for node_index, sub_keys in keys_at_index:
1137
 
                node = nodes[node_index]
1138
 
                positions = self._multi_bisect_right(sub_keys, node.keys)
1139
 
                node_offset = next_row_start + node.offset
1140
 
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
1141
 
                                           for pos, s_keys in positions])
1142
 
            keys_at_index = next_nodes_and_keys
1143
 
        # We should now be at the _LeafNodes
1144
 
        node_indexes = [idx for idx, s_keys in keys_at_index]
1145
 
 
1146
 
        # TODO: We may *not* want to always read all the nodes in one
1147
 
        #       big go. Consider setting a max size on this.
1148
 
        nodes = self._get_leaf_nodes(node_indexes)
1149
 
        return nodes, keys_at_index
1150
 
 
1151
762
    def iter_entries(self, keys):
1152
763
        """Iterate over keys within the index.
1153
764
 
1191
802
        needed_keys = keys
1192
803
        if not needed_keys:
1193
804
            return
1194
 
        nodes, nodes_and_keys = self._walk_through_internal_nodes(needed_keys)
 
805
        # 6 seconds spent in miss_torture using the sorted() line.
 
806
        # Even with out of order disk IO it seems faster not to sort it when
 
807
        # large queries are being made.
 
808
        needed_keys = sorted(needed_keys)
 
809
 
 
810
        nodes_and_keys = [(0, needed_keys)]
 
811
 
 
812
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
 
813
            node_indexes = [idx for idx, s_keys in nodes_and_keys]
 
814
            nodes = self._get_internal_nodes(node_indexes)
 
815
 
 
816
            next_nodes_and_keys = []
 
817
            for node_index, sub_keys in nodes_and_keys:
 
818
                node = nodes[node_index]
 
819
                positions = self._multi_bisect_right(sub_keys, node.keys)
 
820
                node_offset = next_row_start + node.offset
 
821
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
 
822
                                           for pos, s_keys in positions])
 
823
            nodes_and_keys = next_nodes_and_keys
 
824
        # We should now be at the _LeafNodes
 
825
        node_indexes = [idx for idx, s_keys in nodes_and_keys]
 
826
 
 
827
        # TODO: We may *not* want to always read all the nodes in one
 
828
        #       big go. Consider setting a max size on this.
 
829
 
 
830
        nodes = self._get_leaf_nodes(node_indexes)
1195
831
        for node_index, sub_keys in nodes_and_keys:
1196
832
            if not sub_keys:
1197
833
                continue
1198
834
            node = nodes[node_index]
1199
835
            for next_sub_key in sub_keys:
1200
 
                if next_sub_key in node:
1201
 
                    value, refs = node[next_sub_key]
 
836
                if next_sub_key in node.keys:
 
837
                    value, refs = node.keys[next_sub_key]
1202
838
                    if self.node_ref_lists:
1203
839
                        yield (self, next_sub_key, value, refs)
1204
840
                    else:
1205
841
                        yield (self, next_sub_key, value)
1206
842
 
1207
 
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
1208
 
        """Find the parent_map information for the set of keys.
1209
 
 
1210
 
        This populates the parent_map dict and missing_keys set based on the
1211
 
        queried keys. It also can fill out an arbitrary number of parents that
1212
 
        it finds while searching for the supplied keys.
1213
 
 
1214
 
        It is unlikely that you want to call this directly. See
1215
 
        "CombinedGraphIndex.find_ancestry()" for a more appropriate API.
1216
 
 
1217
 
        :param keys: A keys whose ancestry we want to return
1218
 
            Every key will either end up in 'parent_map' or 'missing_keys'.
1219
 
        :param ref_list_num: This index in the ref_lists is the parents we
1220
 
            care about.
1221
 
        :param parent_map: {key: parent_keys} for keys that are present in this
1222
 
            index. This may contain more entries than were in 'keys', that are
1223
 
            reachable ancestors of the keys requested.
1224
 
        :param missing_keys: keys which are known to be missing in this index.
1225
 
            This may include parents that were not directly requested, but we
1226
 
            were able to determine that they are not present in this index.
1227
 
        :return: search_keys    parents that were found but not queried to know
1228
 
            if they are missing or present. Callers can re-query this index for
1229
 
            those keys, and they will be placed into parent_map or missing_keys
1230
 
        """
1231
 
        if not self.key_count():
1232
 
            # We use key_count() to trigger reading the root node and
1233
 
            # determining info about this BTreeGraphIndex
1234
 
            # If we don't have any keys, then everything is missing
1235
 
            missing_keys.update(keys)
1236
 
            return set()
1237
 
        if ref_list_num >= self.node_ref_lists:
1238
 
            raise ValueError('No ref list %d, index has %d ref lists'
1239
 
                % (ref_list_num, self.node_ref_lists))
1240
 
 
1241
 
        # The main trick we are trying to accomplish is that when we find a
1242
 
        # key listing its parents, we expect that the parent key is also likely
1243
 
        # to sit on the same page. Allowing us to expand parents quickly
1244
 
        # without suffering the full stack of bisecting, etc.
1245
 
        nodes, nodes_and_keys = self._walk_through_internal_nodes(keys)
1246
 
 
1247
 
        # These are parent keys which could not be immediately resolved on the
1248
 
        # page where the child was present. Note that we may already be
1249
 
        # searching for that key, and it may actually be present [or known
1250
 
        # missing] on one of the other pages we are reading.
1251
 
        # TODO:
1252
 
        #   We could try searching for them in the immediate previous or next
1253
 
        #   page. If they occur "later" we could put them in a pending lookup
1254
 
        #   set, and then for each node we read thereafter we could check to
1255
 
        #   see if they are present.
1256
 
        #   However, we don't know the impact of keeping this list of things
1257
 
        #   that I'm going to search for every node I come across from here on
1258
 
        #   out.
1259
 
        #   It doesn't handle the case when the parent key is missing on a
1260
 
        #   page that we *don't* read. So we already have to handle being
1261
 
        #   re-entrant for that.
1262
 
        #   Since most keys contain a date string, they are more likely to be
1263
 
        #   found earlier in the file than later, but we would know that right
1264
 
        #   away (key < min_key), and wouldn't keep searching it on every other
1265
 
        #   page that we read.
1266
 
        #   Mostly, it is an idea, one which should be benchmarked.
1267
 
        parents_not_on_page = set()
1268
 
 
1269
 
        for node_index, sub_keys in nodes_and_keys:
1270
 
            if not sub_keys:
1271
 
                continue
1272
 
            # sub_keys is all of the keys we are looking for that should exist
1273
 
            # on this page, if they aren't here, then they won't be found
1274
 
            node = nodes[node_index]
1275
 
            parents_to_check = set()
1276
 
            for next_sub_key in sub_keys:
1277
 
                if next_sub_key not in node:
1278
 
                    # This one is just not present in the index at all
1279
 
                    missing_keys.add(next_sub_key)
1280
 
                else:
1281
 
                    value, refs = node[next_sub_key]
1282
 
                    parent_keys = refs[ref_list_num]
1283
 
                    parent_map[next_sub_key] = parent_keys
1284
 
                    parents_to_check.update(parent_keys)
1285
 
            # Don't look for things we've already found
1286
 
            parents_to_check = parents_to_check.difference(parent_map)
1287
 
            # this can be used to test the benefit of having the check loop
1288
 
            # inlined.
1289
 
            # parents_not_on_page.update(parents_to_check)
1290
 
            # continue
1291
 
            while parents_to_check:
1292
 
                next_parents_to_check = set()
1293
 
                for key in parents_to_check:
1294
 
                    if key in node:
1295
 
                        value, refs = node[key]
1296
 
                        parent_keys = refs[ref_list_num]
1297
 
                        parent_map[key] = parent_keys
1298
 
                        next_parents_to_check.update(parent_keys)
1299
 
                    else:
1300
 
                        # This parent either is genuinely missing, or should be
1301
 
                        # found on another page. Perf test whether it is better
1302
 
                        # to check if this node should fit on this page or not.
1303
 
                        # in the 'everything-in-one-pack' scenario, this *not*
1304
 
                        # doing the check is 237ms vs 243ms.
1305
 
                        # So slightly better, but I assume the standard 'lots
1306
 
                        # of packs' is going to show a reasonable improvement
1307
 
                        # from the check, because it avoids 'going around
1308
 
                        # again' for everything that is in another index
1309
 
                        # parents_not_on_page.add(key)
1310
 
                        # Missing for some reason
1311
 
                        if key < node.min_key:
1312
 
                            # in the case of bzr.dev, 3.4k/5.3k misses are
1313
 
                            # 'earlier' misses (65%)
1314
 
                            parents_not_on_page.add(key)
1315
 
                        elif key > node.max_key:
1316
 
                            # This parent key would be present on a different
1317
 
                            # LeafNode
1318
 
                            parents_not_on_page.add(key)
1319
 
                        else:
1320
 
                            # assert key != node.min_key and key != node.max_key
1321
 
                            # If it was going to be present, it would be on
1322
 
                            # *this* page, so mark it missing.
1323
 
                            missing_keys.add(key)
1324
 
                parents_to_check = next_parents_to_check.difference(parent_map)
1325
 
                # Might want to do another .difference() from missing_keys
1326
 
        # parents_not_on_page could have been found on a different page, or be
1327
 
        # known to be missing. So cull out everything that has already been
1328
 
        # found.
1329
 
        search_keys = parents_not_on_page.difference(
1330
 
            parent_map).difference(missing_keys)
1331
 
        return search_keys
1332
 
 
1333
843
    def iter_entries_prefix(self, keys):
1334
844
        """Iterate over keys within the index using prefix matching.
1335
845
 
1452
962
            self._get_root_node()
1453
963
        return self._key_count
1454
964
 
1455
 
    def _compute_row_offsets(self):
1456
 
        """Fill out the _row_offsets attribute based on _row_lengths."""
1457
 
        offsets = []
1458
 
        row_offset = 0
1459
 
        for row in self._row_lengths:
1460
 
            offsets.append(row_offset)
1461
 
            row_offset += row
1462
 
        offsets.append(row_offset)
1463
 
        self._row_offsets = offsets
1464
 
 
1465
965
    def _parse_header_from_bytes(self, bytes):
1466
966
        """Parse the header from a region of bytes.
1467
967
 
1503
1003
                if len(length)])
1504
1004
        except ValueError:
1505
1005
            raise errors.BadIndexOptions(self)
1506
 
        self._compute_row_offsets()
 
1006
        offsets = []
 
1007
        row_offset = 0
 
1008
        for row in self._row_lengths:
 
1009
            offsets.append(row_offset)
 
1010
            row_offset += row
 
1011
        offsets.append(row_offset)
 
1012
        self._row_offsets = offsets
1507
1013
 
1508
1014
        # calculate the bytes we have processed
1509
1015
        header_end = (len(signature) + sum(map(len, lines[0:4])) + 4)
1513
1019
        """Read some nodes from disk into the LRU cache.
1514
1020
 
1515
1021
        This performs a readv to get the node data into memory, and parses each
1516
 
        node, then yields it to the caller. The nodes are requested in the
 
1022
        node, the yields it to the caller. The nodes are requested in the
1517
1023
        supplied order. If possible doing sort() on the list before requesting
1518
1024
        a read may improve performance.
1519
1025
 
1520
1026
        :param nodes: The nodes to read. 0 - first node, 1 - second node etc.
1521
1027
        :return: None
1522
1028
        """
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
1527
1029
        ranges = []
1528
 
        base_offset = self._base_offset
1529
1030
        for index in nodes:
1530
 
            offset = (index * _PAGE_SIZE)
 
1031
            offset = index * _PAGE_SIZE
1531
1032
            size = _PAGE_SIZE
1532
1033
            if index == 0:
1533
1034
                # Root node - special case
1534
1035
                if self._size:
1535
1036
                    size = min(_PAGE_SIZE, self._size)
1536
1037
                else:
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
 
1038
                    stream = self._transport.get(self._name)
 
1039
                    start = stream.read(_PAGE_SIZE)
 
1040
                    # Avoid doing this again
 
1041
                    self._size = len(start)
 
1042
                    size = min(_PAGE_SIZE, self._size)
1546
1043
            else:
1547
 
                if offset > self._size:
1548
 
                    raise AssertionError('tried to read past the end'
1549
 
                                         ' of the file %s > %s'
1550
 
                                         % (offset, self._size))
1551
1044
                size = min(size, self._size - offset)
1552
 
            ranges.append((base_offset + offset, size))
 
1045
            ranges.append((offset, size))
1553
1046
        if not ranges:
1554
1047
            return
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:
 
1048
        if self._file is None:
1560
1049
            data_ranges = self._transport.readv(self._name, ranges)
1561
1050
        else:
1562
1051
            data_ranges = []
1564
1053
                self._file.seek(offset)
1565
1054
                data_ranges.append((offset, self._file.read(size)))
1566
1055
        for offset, data in data_ranges:
1567
 
            offset -= base_offset
1568
1056
            if offset == 0:
1569
1057
                # extract the header
1570
1058
                offset, data = self._parse_header_from_bytes(data)
1572
1060
                    continue
1573
1061
            bytes = zlib.decompress(data)
1574
1062
            if bytes.startswith(_LEAF_FLAG):
1575
 
                node = self._leaf_factory(bytes, self._key_length,
1576
 
                                          self.node_ref_lists)
 
1063
                node = _LeafNode(bytes, self._key_length, self.node_ref_lists)
1577
1064
            elif bytes.startswith(_INTERNAL_FLAG):
1578
1065
                node = _InternalNode(bytes)
1579
1066
            else:
1598
1085
            pass
1599
1086
 
1600
1087
 
1601
 
_gcchk_factory = _LeafNode
1602
 
 
1603
1088
try:
1604
 
    from bzrlib import _btree_serializer_pyx as _btree_serializer
1605
 
    _gcchk_factory = _btree_serializer._parse_into_chk
1606
 
except ImportError, e:
1607
 
    osutils.failed_to_load_extension(e)
 
1089
    from bzrlib import _btree_serializer_c as _btree_serializer
 
1090
except ImportError:
1608
1091
    from bzrlib import _btree_serializer_py as _btree_serializer