~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/btree_index.py

  • Committer: Gordon Tyler
  • Date: 2010-02-02 06:30:43 UTC
  • mto: (5037.3.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5046.
  • Revision ID: gordon@doxxx.net-20100202063043-3ygr1114d25m3f7m
Added cmdline.split function, which replaces commands.shlex_split_unicode.

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
 
18
18
"""B+Tree indices"""
19
19
 
20
 
import array
21
 
import bisect
 
20
import cStringIO
22
21
from bisect import bisect_right
23
 
from copy import deepcopy
24
22
import math
25
 
import struct
26
23
import tempfile
27
24
import zlib
28
25
 
34
31
    index,
35
32
    lru_cache,
36
33
    osutils,
 
34
    static_tuple,
37
35
    trace,
38
36
    )
39
37
from bzrlib.index import _OPTION_NODE_REFS, _OPTION_KEY_ELEMENTS, _OPTION_LEN
64
62
    def __init__(self):
65
63
        """Create a _BuilderRow."""
66
64
        self.nodes = 0
67
 
        self.spool = tempfile.TemporaryFile()
 
65
        self.spool = None# tempfile.TemporaryFile(prefix='bzr-index-row-')
68
66
        self.writer = None
69
67
 
70
68
    def finish_node(self, pad=True):
71
69
        byte_lines, _, padding = self.writer.finish()
72
70
        if self.nodes == 0:
 
71
            self.spool = cStringIO.StringIO()
73
72
            # padded note:
74
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
75
79
        skipped_bytes = 0
76
80
        if not pad and padding:
77
81
            del byte_lines[-1]
156
160
        :param value: The value to associate with the key. It may be any
157
161
            bytes as long as it does not contain \0 or \n.
158
162
        """
 
163
        # Ensure that 'key' is a StaticTuple
 
164
        key = static_tuple.StaticTuple.from_sequence(key).intern()
159
165
        # we don't care about absent_references
160
166
        node_refs, _ = self._check_key_ref_value(key, references, value)
161
167
        if key in self._nodes:
162
168
            raise errors.BadIndexDuplicateKey(key, self)
163
 
        self._nodes[key] = (node_refs, value)
164
 
        self._keys.add(key)
 
169
        self._nodes[key] = static_tuple.StaticTuple(node_refs, value)
165
170
        if self._nodes_by_key is not None and self._key_length > 1:
166
171
            self._update_nodes_by_key(key, value, node_refs)
167
 
        if len(self._keys) < self._spill_at:
 
172
        if len(self._nodes) < self._spill_at:
168
173
            return
169
174
        self._spill_mem_keys_to_disk()
170
175
 
186
191
             backing_pos) = self._spill_mem_keys_and_combine()
187
192
        else:
188
193
            new_backing_file, size = self._spill_mem_keys_without_combining()
189
 
        dir_path, base_name = osutils.split(new_backing_file.name)
190
194
        # Note: The transport here isn't strictly needed, because we will use
191
195
        #       direct access to the new_backing._file object
192
 
        new_backing = BTreeGraphIndex(get_transport(dir_path),
193
 
                                      base_name, size)
 
196
        new_backing = BTreeGraphIndex(get_transport('.'), '<temp>', size)
194
197
        # GC will clean up the file
195
198
        new_backing._file = new_backing_file
196
199
        if self._combine_backing_indices:
201
204
                self._backing_indices[backing_pos] = None
202
205
        else:
203
206
            self._backing_indices.append(new_backing)
204
 
        self._keys = set()
205
207
        self._nodes = {}
206
208
        self._nodes_by_key = None
207
209
 
319
321
            new_row = True
320
322
            for row in reversed(rows[:-1]):
321
323
                # Mark the start of the next node in the node above. If it
322
 
                # doesn't fit then propogate upwards until we find one that
 
324
                # doesn't fit then propagate upwards until we find one that
323
325
                # it does fit into.
324
326
                if row.writer.write(key_line):
325
327
                    row.finish_node()
370
372
        self.row_lengths = []
371
373
        # Loop over all nodes adding them to the bottom row
372
374
        # (rows[-1]). When we finish a chunk in a row,
373
 
        # propogate the key that didn't fit (comes after the chunk) to the
 
375
        # propagate the key that didn't fit (comes after the chunk) to the
374
376
        # row above, transitively.
375
377
        for node in node_iterator:
376
378
            if key_count == 0:
383
385
        for row in reversed(rows):
384
386
            pad = (type(row) != _LeafBuilderRow)
385
387
            row.finish_node(pad=pad)
386
 
        result = tempfile.NamedTemporaryFile(prefix='bzr-index-')
387
388
        lines = [_BTSIGNATURE]
388
389
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
389
390
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
390
391
        lines.append(_OPTION_LEN + str(key_count) + '\n')
391
392
        row_lengths = [row.nodes for row in rows]
392
393
        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()
393
398
        result.writelines(lines)
394
399
        position = sum(map(len, lines))
395
400
        root_row = True
406
411
            # Special case the first node as it may be prefixed
407
412
            node = row.spool.read(_PAGE_SIZE)
408
413
            result.write(node[reserved:])
409
 
            result.write("\x00" * (reserved - position))
 
414
            if len(node) == _PAGE_SIZE:
 
415
                result.write("\x00" * (reserved - position))
410
416
            position = 0 # Only the root row actually has an offset
411
417
            copied_len = osutils.pumpfile(row.spool, result)
412
418
            if copied_len != (row.nodes - 1) * _PAGE_SIZE:
431
437
    def iter_all_entries(self):
432
438
        """Iterate over all keys within the index
433
439
 
434
 
        :return: An iterable of (index, key, reference_lists, value). There is no
435
 
            defined order for the result iteration - it will be in the most
 
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
436
442
            efficient order for the index (in this case dictionary hash order).
437
443
        """
438
444
        if 'evil' in debug.debug_flags:
457
463
            efficient order for the index (keys iteration order in this case).
458
464
        """
459
465
        keys = set(keys)
460
 
        local_keys = keys.intersection(self._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]
461
475
        if self.reference_lists:
462
476
            for key in local_keys:
463
 
                node = self._nodes[key]
 
477
                node = nodes[key]
464
478
                yield self, key, node[1], node[0]
465
479
        else:
466
480
            for key in local_keys:
467
 
                node = self._nodes[key]
 
481
                node = nodes[key]
468
482
                yield self, key, node[1]
469
483
        # Find things that are in backing indices that have not been handled
470
484
        # yet.
580
594
 
581
595
        For InMemoryGraphIndex the estimate is exact.
582
596
        """
583
 
        return len(self._keys) + sum(backing.key_count() for backing in
 
597
        return len(self._nodes) + sum(backing.key_count() for backing in
584
598
            self._backing_indices if backing is not None)
585
599
 
586
600
    def validate(self):
590
604
class _LeafNode(object):
591
605
    """A leaf node for a serialised B+Tree index."""
592
606
 
 
607
    __slots__ = ('keys', 'min_key', 'max_key')
 
608
 
593
609
    def __init__(self, bytes, key_length, ref_list_length):
594
610
        """Parse bytes to create a leaf node object."""
595
611
        # splitlines mangles the \r delimiters.. don't use it.
596
 
        self.keys = dict(_btree_serializer._parse_leaf_lines(bytes,
597
 
            key_length, ref_list_length))
 
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)
598
620
 
599
621
 
600
622
class _InternalNode(object):
601
623
    """An internal node for a serialised B+Tree index."""
602
624
 
 
625
    __slots__ = ('keys', 'offset')
 
626
 
603
627
    def __init__(self, bytes):
604
628
        """Parse bytes to create an internal node object."""
605
629
        # splitlines mangles the \r delimiters.. don't use it.
608
632
    def _parse_lines(self, lines):
609
633
        nodes = []
610
634
        self.offset = int(lines[1][7:])
 
635
        as_st = static_tuple.StaticTuple.from_sequence
611
636
        for line in lines[2:]:
612
637
            if line == '':
613
638
                break
614
 
            nodes.append(tuple(line.split('\0')))
 
639
            nodes.append(as_st(map(intern, line.split('\0'))).intern())
615
640
        return nodes
616
641
 
617
642
 
622
647
    memory except when very large walks are done.
623
648
    """
624
649
 
625
 
    def __init__(self, transport, name, size):
 
650
    def __init__(self, transport, name, size, unlimited_cache=False):
626
651
        """Create a B+Tree index object on the index name.
627
652
 
628
653
        :param transport: The transport to read data for the index from.
632
657
            the initial read (to read the root node header) can be done
633
658
            without over-reading even on empty indices, and on small indices
634
659
            allows single-IO to read the entire index.
 
660
        :param unlimited_cache: If set to True, then instead of using an
 
661
            LRUCache with size _NODE_CACHE_SIZE, we will use a dict and always
 
662
            cache all leaf nodes.
635
663
        """
636
664
        self._transport = transport
637
665
        self._name = name
641
669
        self._root_node = None
642
670
        # Default max size is 100,000 leave values
643
671
        self._leaf_value_cache = None # lru_cache.LRUCache(100*1000)
644
 
        self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
645
 
        # We could limit this, but even a 300k record btree has only 3k leaf
646
 
        # nodes, and only 20 internal nodes. So the default of 100 nodes in an
647
 
        # LRU would mean we always cache everything anyway, no need to pay the
648
 
        # overhead of LRU
649
 
        self._internal_node_cache = fifo_cache.FIFOCache(100)
 
672
        if unlimited_cache:
 
673
            self._leaf_node_cache = {}
 
674
            self._internal_node_cache = {}
 
675
        else:
 
676
            self._leaf_node_cache = lru_cache.LRUCache(_NODE_CACHE_SIZE)
 
677
            # We use a FIFO here just to prevent possible blowout. However, a
 
678
            # 300k record btree has only 3k leaf nodes, and only 20 internal
 
679
            # nodes. A value of 100 scales to ~100*100*100 = 1M records.
 
680
            self._internal_node_cache = fifo_cache.FIFOCache(100)
650
681
        self._key_count = None
651
682
        self._row_lengths = None
652
683
        self._row_offsets = None # Start of each row, [-1] is the end
684
715
                if start_of_leaves is None:
685
716
                    start_of_leaves = self._row_offsets[-2]
686
717
                if node_pos < start_of_leaves:
687
 
                    self._internal_node_cache.add(node_pos, node)
 
718
                    self._internal_node_cache[node_pos] = node
688
719
                else:
689
 
                    self._leaf_node_cache.add(node_pos, node)
 
720
                    self._leaf_node_cache[node_pos] = node
690
721
            found[node_pos] = node
691
722
        return found
692
723
 
831
862
            new_tips = next_tips
832
863
        return final_offsets
833
864
 
 
865
    def clear_cache(self):
 
866
        """Clear out any cached/memoized values.
 
867
 
 
868
        This can be called at any time, but generally it is used when we have
 
869
        extracted some information, but don't expect to be requesting any more
 
870
        from this index.
 
871
        """
 
872
        # Note that we don't touch self._root_node or self._internal_node_cache
 
873
        # We don't expect either of those to be big, and it can save
 
874
        # round-trips in the future. We may re-evaluate this if InternalNode
 
875
        # memory starts to be an issue.
 
876
        self._leaf_node_cache.clear()
 
877
 
834
878
    def external_references(self, ref_list_num):
835
879
        if self._root_node is None:
836
880
            self._get_root_node()
1039
1083
            output.append(cur_out)
1040
1084
        return output
1041
1085
 
 
1086
    def _walk_through_internal_nodes(self, keys):
 
1087
        """Take the given set of keys, and find the corresponding LeafNodes.
 
1088
 
 
1089
        :param keys: An unsorted iterable of keys to search for
 
1090
        :return: (nodes, index_and_keys)
 
1091
            nodes is a dict mapping {index: LeafNode}
 
1092
            keys_at_index is a list of tuples of [(index, [keys for Leaf])]
 
1093
        """
 
1094
        # 6 seconds spent in miss_torture using the sorted() line.
 
1095
        # Even with out of order disk IO it seems faster not to sort it when
 
1096
        # large queries are being made.
 
1097
        keys_at_index = [(0, sorted(keys))]
 
1098
 
 
1099
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
 
1100
            node_indexes = [idx for idx, s_keys in keys_at_index]
 
1101
            nodes = self._get_internal_nodes(node_indexes)
 
1102
 
 
1103
            next_nodes_and_keys = []
 
1104
            for node_index, sub_keys in keys_at_index:
 
1105
                node = nodes[node_index]
 
1106
                positions = self._multi_bisect_right(sub_keys, node.keys)
 
1107
                node_offset = next_row_start + node.offset
 
1108
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
 
1109
                                           for pos, s_keys in positions])
 
1110
            keys_at_index = next_nodes_and_keys
 
1111
        # We should now be at the _LeafNodes
 
1112
        node_indexes = [idx for idx, s_keys in keys_at_index]
 
1113
 
 
1114
        # TODO: We may *not* want to always read all the nodes in one
 
1115
        #       big go. Consider setting a max size on this.
 
1116
        nodes = self._get_leaf_nodes(node_indexes)
 
1117
        return nodes, keys_at_index
 
1118
 
1042
1119
    def iter_entries(self, keys):
1043
1120
        """Iterate over keys within the index.
1044
1121
 
1082
1159
        needed_keys = keys
1083
1160
        if not needed_keys:
1084
1161
            return
1085
 
        # 6 seconds spent in miss_torture using the sorted() line.
1086
 
        # Even with out of order disk IO it seems faster not to sort it when
1087
 
        # large queries are being made.
1088
 
        needed_keys = sorted(needed_keys)
1089
 
 
1090
 
        nodes_and_keys = [(0, needed_keys)]
1091
 
 
1092
 
        for row_pos, next_row_start in enumerate(self._row_offsets[1:-1]):
1093
 
            node_indexes = [idx for idx, s_keys in nodes_and_keys]
1094
 
            nodes = self._get_internal_nodes(node_indexes)
1095
 
 
1096
 
            next_nodes_and_keys = []
1097
 
            for node_index, sub_keys in nodes_and_keys:
1098
 
                node = nodes[node_index]
1099
 
                positions = self._multi_bisect_right(sub_keys, node.keys)
1100
 
                node_offset = next_row_start + node.offset
1101
 
                next_nodes_and_keys.extend([(node_offset + pos, s_keys)
1102
 
                                           for pos, s_keys in positions])
1103
 
            nodes_and_keys = next_nodes_and_keys
1104
 
        # We should now be at the _LeafNodes
1105
 
        node_indexes = [idx for idx, s_keys in nodes_and_keys]
1106
 
 
1107
 
        # TODO: We may *not* want to always read all the nodes in one
1108
 
        #       big go. Consider setting a max size on this.
1109
 
 
1110
 
        nodes = self._get_leaf_nodes(node_indexes)
 
1162
        nodes, nodes_and_keys = self._walk_through_internal_nodes(needed_keys)
1111
1163
        for node_index, sub_keys in nodes_and_keys:
1112
1164
            if not sub_keys:
1113
1165
                continue
1120
1172
                    else:
1121
1173
                        yield (self, next_sub_key, value)
1122
1174
 
 
1175
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
 
1176
        """Find the parent_map information for the set of keys.
 
1177
 
 
1178
        This populates the parent_map dict and missing_keys set based on the
 
1179
        queried keys. It also can fill out an arbitrary number of parents that
 
1180
        it finds while searching for the supplied keys.
 
1181
 
 
1182
        It is unlikely that you want to call this directly. See
 
1183
        "CombinedGraphIndex.find_ancestry()" for a more appropriate API.
 
1184
 
 
1185
        :param keys: A keys whose ancestry we want to return
 
1186
            Every key will either end up in 'parent_map' or 'missing_keys'.
 
1187
        :param ref_list_num: This index in the ref_lists is the parents we
 
1188
            care about.
 
1189
        :param parent_map: {key: parent_keys} for keys that are present in this
 
1190
            index. This may contain more entries than were in 'keys', that are
 
1191
            reachable ancestors of the keys requested.
 
1192
        :param missing_keys: keys which are known to be missing in this index.
 
1193
            This may include parents that were not directly requested, but we
 
1194
            were able to determine that they are not present in this index.
 
1195
        :return: search_keys    parents that were found but not queried to know
 
1196
            if they are missing or present. Callers can re-query this index for
 
1197
            those keys, and they will be placed into parent_map or missing_keys
 
1198
        """
 
1199
        if not self.key_count():
 
1200
            # We use key_count() to trigger reading the root node and
 
1201
            # determining info about this BTreeGraphIndex
 
1202
            # If we don't have any keys, then everything is missing
 
1203
            missing_keys.update(keys)
 
1204
            return set()
 
1205
        if ref_list_num >= self.node_ref_lists:
 
1206
            raise ValueError('No ref list %d, index has %d ref lists'
 
1207
                % (ref_list_num, self.node_ref_lists))
 
1208
 
 
1209
        # The main trick we are trying to accomplish is that when we find a
 
1210
        # key listing its parents, we expect that the parent key is also likely
 
1211
        # to sit on the same page. Allowing us to expand parents quickly
 
1212
        # without suffering the full stack of bisecting, etc.
 
1213
        nodes, nodes_and_keys = self._walk_through_internal_nodes(keys)
 
1214
 
 
1215
        # These are parent keys which could not be immediately resolved on the
 
1216
        # page where the child was present. Note that we may already be
 
1217
        # searching for that key, and it may actually be present [or known
 
1218
        # missing] on one of the other pages we are reading.
 
1219
        # TODO:
 
1220
        #   We could try searching for them in the immediate previous or next
 
1221
        #   page. If they occur "later" we could put them in a pending lookup
 
1222
        #   set, and then for each node we read thereafter we could check to
 
1223
        #   see if they are present.
 
1224
        #   However, we don't know the impact of keeping this list of things
 
1225
        #   that I'm going to search for every node I come across from here on
 
1226
        #   out.
 
1227
        #   It doesn't handle the case when the parent key is missing on a
 
1228
        #   page that we *don't* read. So we already have to handle being
 
1229
        #   re-entrant for that.
 
1230
        #   Since most keys contain a date string, they are more likely to be
 
1231
        #   found earlier in the file than later, but we would know that right
 
1232
        #   away (key < min_key), and wouldn't keep searching it on every other
 
1233
        #   page that we read.
 
1234
        #   Mostly, it is an idea, one which should be benchmarked.
 
1235
        parents_not_on_page = set()
 
1236
 
 
1237
        for node_index, sub_keys in nodes_and_keys:
 
1238
            if not sub_keys:
 
1239
                continue
 
1240
            # sub_keys is all of the keys we are looking for that should exist
 
1241
            # on this page, if they aren't here, then they won't be found
 
1242
            node = nodes[node_index]
 
1243
            node_keys = node.keys
 
1244
            parents_to_check = set()
 
1245
            for next_sub_key in sub_keys:
 
1246
                if next_sub_key not in node_keys:
 
1247
                    # This one is just not present in the index at all
 
1248
                    missing_keys.add(next_sub_key)
 
1249
                else:
 
1250
                    value, refs = node_keys[next_sub_key]
 
1251
                    parent_keys = refs[ref_list_num]
 
1252
                    parent_map[next_sub_key] = parent_keys
 
1253
                    parents_to_check.update(parent_keys)
 
1254
            # Don't look for things we've already found
 
1255
            parents_to_check = parents_to_check.difference(parent_map)
 
1256
            # this can be used to test the benefit of having the check loop
 
1257
            # inlined.
 
1258
            # parents_not_on_page.update(parents_to_check)
 
1259
            # continue
 
1260
            while parents_to_check:
 
1261
                next_parents_to_check = set()
 
1262
                for key in parents_to_check:
 
1263
                    if key in node_keys:
 
1264
                        value, refs = node_keys[key]
 
1265
                        parent_keys = refs[ref_list_num]
 
1266
                        parent_map[key] = parent_keys
 
1267
                        next_parents_to_check.update(parent_keys)
 
1268
                    else:
 
1269
                        # This parent either is genuinely missing, or should be
 
1270
                        # found on another page. Perf test whether it is better
 
1271
                        # to check if this node should fit on this page or not.
 
1272
                        # in the 'everything-in-one-pack' scenario, this *not*
 
1273
                        # doing the check is 237ms vs 243ms.
 
1274
                        # So slightly better, but I assume the standard 'lots
 
1275
                        # of packs' is going to show a reasonable improvement
 
1276
                        # from the check, because it avoids 'going around
 
1277
                        # again' for everything that is in another index
 
1278
                        # parents_not_on_page.add(key)
 
1279
                        # Missing for some reason
 
1280
                        if key < node.min_key:
 
1281
                            # in the case of bzr.dev, 3.4k/5.3k misses are
 
1282
                            # 'earlier' misses (65%)
 
1283
                            parents_not_on_page.add(key)
 
1284
                        elif key > node.max_key:
 
1285
                            # This parent key would be present on a different
 
1286
                            # LeafNode
 
1287
                            parents_not_on_page.add(key)
 
1288
                        else:
 
1289
                            # assert key != node.min_key and key != node.max_key
 
1290
                            # If it was going to be present, it would be on
 
1291
                            # *this* page, so mark it missing.
 
1292
                            missing_keys.add(key)
 
1293
                parents_to_check = next_parents_to_check.difference(parent_map)
 
1294
                # Might want to do another .difference() from missing_keys
 
1295
        # parents_not_on_page could have been found on a different page, or be
 
1296
        # known to be missing. So cull out everything that has already been
 
1297
        # found.
 
1298
        search_keys = parents_not_on_page.difference(
 
1299
            parent_map).difference(missing_keys)
 
1300
        return search_keys
 
1301
 
1123
1302
    def iter_entries_prefix(self, keys):
1124
1303
        """Iterate over keys within the index using prefix matching.
1125
1304
 
1384
1563
 
1385
1564
 
1386
1565
try:
1387
 
    from bzrlib import _btree_serializer_c as _btree_serializer
1388
 
except ImportError:
 
1566
    from bzrlib import _btree_serializer_pyx as _btree_serializer
 
1567
except ImportError, e:
 
1568
    osutils.failed_to_load_extension(e)
1389
1569
    from bzrlib import _btree_serializer_py as _btree_serializer