← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Andrew Bennetts
  • Date: 2009-08-07 04:17:51 UTC
  • mto: This revision was merged to the branch mainline in revision 4608.
  • Revision ID: andrew.bennetts@canonical.com-20090807041751-0vhb0y0g7k49hr45
Review comments from John.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
1
 
# Copyright (C) 2007-2011 Canonical Ltd
 
1
# Copyright (C) 2007, 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
31
31
 
32
32
from bzrlib.lazy_import import lazy_import
33
33
lazy_import(globals(), """
34
 
from bzrlib import (
35
 
    bisect_multi,
36
 
    revision as _mod_revision,
37
 
    trace,
38
 
    )
 
34
from bzrlib import trace
 
35
from bzrlib.bisect_multi import bisect_multi_bytes
 
36
from bzrlib.revision import NULL_REVISION
 
37
from bzrlib.trace import mutter
39
38
""")
40
39
from bzrlib import (
41
40
    debug,
42
41
    errors,
43
42
    )
44
 
from bzrlib.static_tuple import StaticTuple
45
43
 
46
44
_HEADER_READV = (0, 200)
47
45
_OPTION_KEY_ELEMENTS = "key_elements="
70
68
class GraphIndexBuilder(object):
71
69
    """A builder that can build a GraphIndex.
72
70
 
73
 
    The resulting graph has the structure::
 
71
    The resulting graph has the structure:
74
72
 
75
 
      _SIGNATURE OPTIONS NODES NEWLINE
76
 
      _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
77
 
      OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
78
 
      NODES          := NODE*
79
 
      NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
80
 
      KEY            := Not-whitespace-utf8
81
 
      ABSENT         := 'a'
82
 
      REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
83
 
      REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
84
 
      REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
85
 
                                ; referenced key.
86
 
      VALUE          := no-newline-no-null-bytes
 
73
    _SIGNATURE OPTIONS NODES NEWLINE
 
74
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
 
75
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
 
76
    NODES          := NODE*
 
77
    NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
 
78
    KEY            := Not-whitespace-utf8
 
79
    ABSENT         := 'a'
 
80
    REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
 
81
    REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
 
82
    REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
 
83
                              ; referenced key.
 
84
    VALUE          := no-newline-no-null-bytes
87
85
    """
88
86
 
89
87
    def __init__(self, reference_lists=0, key_elements=1):
94
92
        :param key_elements: The number of bytestrings in each key.
95
93
        """
96
94
        self.reference_lists = reference_lists
 
95
        self._keys = set()
97
96
        # A dict of {key: (absent, ref_lists, value)}
98
97
        self._nodes = {}
99
 
        # Keys that are referenced but not actually present in this index
100
 
        self._absent_keys = set()
101
98
        self._nodes_by_key = None
102
99
        self._key_length = key_elements
103
100
        self._optimize_for_size = False
105
102
 
106
103
    def _check_key(self, key):
107
104
        """Raise BadIndexKey if key is not a valid key for this index."""
108
 
        if type(key) not in (tuple, StaticTuple):
 
105
        if type(key) != tuple:
109
106
            raise errors.BadIndexKey(key)
110
107
        if self._key_length != len(key):
111
108
            raise errors.BadIndexKey(key)
167
164
            return
168
165
        key_dict = self._nodes_by_key
169
166
        if self.reference_lists:
170
 
            key_value = StaticTuple(key, value, node_refs)
 
167
            key_value = key, value, node_refs
171
168
        else:
172
 
            key_value = StaticTuple(key, value)
 
169
            key_value = key, value
173
170
        for subkey in key[:-1]:
174
171
            key_dict = key_dict.setdefault(subkey, {})
175
172
        key_dict[key[-1]] = key_value
185
182
        :param value: The value associate with this key. Must not contain
186
183
            newlines or null characters.
187
184
        :return: (node_refs, absent_references)
188
 
        
189
 
            * node_refs: basically a packed form of 'references' where all
190
 
              iterables are tuples
191
 
            * absent_references: reference keys that are not in self._nodes.
192
 
              This may contain duplicates if the same key is referenced in
193
 
              multiple lists.
 
185
            node_refs   basically a packed form of 'references' where all
 
186
                        iterables are tuples
 
187
            absent_references   reference keys that are not in self._nodes.
 
188
                                This may contain duplicates if the same key is
 
189
                                referenced in multiple lists.
194
190
        """
195
 
        as_st = StaticTuple.from_sequence
196
191
        self._check_key(key)
197
192
        if _newline_null_re.search(value) is not None:
198
193
            raise errors.BadIndexValue(value)
207
202
                if reference not in self._nodes:
208
203
                    self._check_key(reference)
209
204
                    absent_references.append(reference)
210
 
            reference_list = as_st([as_st(ref).intern()
211
 
                                    for ref in reference_list])
212
 
            node_refs.append(reference_list)
213
 
        return as_st(node_refs), absent_references
 
205
            node_refs.append(tuple(reference_list))
 
206
        return tuple(node_refs), absent_references
214
207
 
215
208
    def add_node(self, key, value, references=()):
216
209
        """Add a node to the index.
221
214
        :param references: An iterable of iterables of keys. Each is a
222
215
            reference to another key.
223
216
        :param value: The value to associate with the key. It may be any
224
 
            bytes as long as it does not contain \\0 or \\n.
 
217
            bytes as long as it does not contain \0 or \n.
225
218
        """
226
219
        (node_refs,
227
220
         absent_references) = self._check_key_ref_value(key, references, value)
231
224
            # There may be duplicates, but I don't think it is worth worrying
232
225
            # about
233
226
            self._nodes[reference] = ('a', (), '')
234
 
        self._absent_keys.update(absent_references)
235
 
        self._absent_keys.discard(key)
236
227
        self._nodes[key] = ('', node_refs, value)
 
228
        self._keys.add(key)
237
229
        if self._nodes_by_key is not None and self._key_length > 1:
238
230
            self._update_nodes_by_key(key, value, node_refs)
239
231
 
240
 
    def clear_cache(self):
241
 
        """See GraphIndex.clear_cache()
242
 
 
243
 
        This is a no-op, but we need the api to conform to a generic 'Index'
244
 
        abstraction.
245
 
        """
246
 
        
247
232
    def finish(self):
248
233
        lines = [_SIGNATURE]
249
234
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
250
235
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
251
 
        key_count = len(self._nodes) - len(self._absent_keys)
252
 
        lines.append(_OPTION_LEN + str(key_count) + '\n')
 
236
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
253
237
        prefix_length = sum(len(x) for x in lines)
254
238
        # references are byte offsets. To avoid having to do nasty
255
239
        # polynomial work to resolve offsets (references to later in the
349
333
        if combine_backing_indices is not None:
350
334
            self._combine_backing_indices = combine_backing_indices
351
335
 
352
 
    def find_ancestry(self, keys, ref_list_num):
353
 
        """See CombinedGraphIndex.find_ancestry()"""
354
 
        pending = set(keys)
355
 
        parent_map = {}
356
 
        missing_keys = set()
357
 
        while pending:
358
 
            next_pending = set()
359
 
            for _, key, value, ref_lists in self.iter_entries(pending):
360
 
                parent_keys = ref_lists[ref_list_num]
361
 
                parent_map[key] = parent_keys
362
 
                next_pending.update([p for p in parent_keys if p not in
363
 
                                     parent_map])
364
 
                missing_keys.update(pending.difference(parent_map))
365
 
            pending = next_pending
366
 
        return parent_map, missing_keys
367
 
 
368
336
 
369
337
class GraphIndex(object):
370
338
    """An index for data with embedded graphs.
384
352
    suitable for production use. :XXX
385
353
    """
386
354
 
387
 
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
 
355
    def __init__(self, transport, name, size):
388
356
        """Open an index called name on transport.
389
357
 
390
358
        :param transport: A bzrlib.transport.Transport.
396
364
            avoided by having it supplied. If size is None, then bisection
397
365
            support will be disabled and accessing the index will just stream
398
366
            all the data.
399
 
        :param offset: Instead of starting the index data at offset 0, start it
400
 
            at an arbitrary offset.
401
367
        """
402
368
        self._transport = transport
403
369
        self._name = name
420
386
        self._size = size
421
387
        # The number of bytes we've read so far in trying to process this file
422
388
        self._bytes_read = 0
423
 
        self._base_offset = offset
424
389
 
425
390
    def __eq__(self, other):
426
391
        """Equal when self and other were created with the same parameters."""
446
411
            # We already did this
447
412
            return
448
413
        if 'index' in debug.debug_flags:
449
 
            trace.mutter('Reading entire index %s',
450
 
                          self._transport.abspath(self._name))
 
414
            mutter('Reading entire index %s', self._transport.abspath(self._name))
451
415
        if stream is None:
452
416
            stream = self._transport.get(self._name)
453
 
            if self._base_offset != 0:
454
 
                # This is wasteful, but it is better than dealing with
455
 
                # adjusting all the offsets, etc.
456
 
                stream = StringIO(stream.read()[self._base_offset:])
457
417
        self._read_prefix(stream)
458
418
        self._expected_elements = 3 + self._key_length
459
419
        line_count = 0
465
425
        trailers = 0
466
426
        pos = stream.tell()
467
427
        lines = stream.read().split('\n')
468
 
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
469
 
        stream.close()
470
428
        del lines[-1]
471
429
        _, _, _, trailers = self._parse_lines(lines, pos)
472
430
        for key, absent, references, value in self._keys_by_offset.itervalues():
479
437
                node_value = value
480
438
            self._nodes[key] = node_value
481
439
        # cache the keys for quick set intersections
 
440
        self._keys = set(self._nodes)
482
441
        if trailers != 1:
483
442
            # there must be one line - the empty trailer line.
484
443
            raise errors.BadIndexData(self)
485
444
 
486
 
    def clear_cache(self):
487
 
        """Clear out any cached/memoized values.
488
 
 
489
 
        This can be called at any time, but generally it is used when we have
490
 
        extracted some information, but don't expect to be requesting any more
491
 
        from this index.
492
 
        """
493
 
 
494
445
    def external_references(self, ref_list_num):
495
446
        """Return references that are not present in this index.
496
447
        """
499
450
            raise ValueError('No ref list %d, index has %d ref lists'
500
451
                % (ref_list_num, self.node_ref_lists))
501
452
        refs = set()
502
 
        nodes = self._nodes
503
 
        for key, (value, ref_lists) in nodes.iteritems():
 
453
        for key, (value, ref_lists) in self._nodes.iteritems():
504
454
            ref_list = ref_lists[ref_list_num]
505
 
            refs.update([ref for ref in ref_list if ref not in nodes])
506
 
        return refs
 
455
            refs.update(ref_list)
 
456
        return refs - self._keys
507
457
 
508
458
    def _get_nodes_by_key(self):
509
459
        if self._nodes_by_key is None:
636
586
 
637
587
    def _iter_entries_from_total_buffer(self, keys):
638
588
        """Iterate over keys when the entire index is parsed."""
639
 
        # Note: See the note in BTreeBuilder.iter_entries for why we don't use
640
 
        #       .intersection() here
641
 
        nodes = self._nodes
642
 
        keys = [key for key in keys if key in nodes]
 
589
        keys = keys.intersection(self._keys)
643
590
        if self.node_ref_lists:
644
591
            for key in keys:
645
 
                value, node_refs = nodes[key]
 
592
                value, node_refs = self._nodes[key]
646
593
                yield self, key, value, node_refs
647
594
        else:
648
595
            for key in keys:
649
 
                yield self, key, nodes[key]
 
596
                yield self, key, self._nodes[key]
650
597
 
651
598
    def iter_entries(self, keys):
652
599
        """Iterate over keys within the index.
674
621
        if self._nodes is not None:
675
622
            return self._iter_entries_from_total_buffer(keys)
676
623
        else:
677
 
            return (result[1] for result in bisect_multi.bisect_multi_bytes(
 
624
            return (result[1] for result in bisect_multi_bytes(
678
625
                self._lookup_keys_via_location, self._size, keys))
679
626
 
680
627
    def iter_entries_prefix(self, keys):
755
702
                # the last thing looked up was a terminal element
756
703
                yield (self, ) + key_dict
757
704
 
758
 
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
759
 
        """See BTreeIndex._find_ancestors."""
760
 
        # The api can be implemented as a trivial overlay on top of
761
 
        # iter_entries, it is not an efficient implementation, but it at least
762
 
        # gets the job done.
763
 
        found_keys = set()
764
 
        search_keys = set()
765
 
        for index, key, value, refs in self.iter_entries(keys):
766
 
            parent_keys = refs[ref_list_num]
767
 
            found_keys.add(key)
768
 
            parent_map[key] = parent_keys
769
 
            search_keys.update(parent_keys)
770
 
        # Figure out what, if anything, was missing
771
 
        missing_keys.update(set(keys).difference(found_keys))
772
 
        search_keys = search_keys.difference(parent_map)
773
 
        return search_keys
774
 
 
775
705
    def key_count(self):
776
706
        """Return an estimate of the number of keys in this index.
777
707
 
1189
1119
            self._parsed_key_map.insert(index + 1, new_key)
1190
1120
 
1191
1121
    def _read_and_parse(self, readv_ranges):
1192
 
        """Read the ranges and parse the resulting data.
 
1122
        """Read the the ranges and parse the resulting data.
1193
1123
 
1194
1124
        :param readv_ranges: A prepared readv range list.
1195
1125
        """
1201
1131
            self._buffer_all()
1202
1132
            return
1203
1133
 
1204
 
        base_offset = self._base_offset
1205
 
        if base_offset != 0:
1206
 
            # Rewrite the ranges for the offset
1207
 
            readv_ranges = [(start+base_offset, size)
1208
 
                            for start, size in readv_ranges]
1209
1134
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1210
 
            self._size + self._base_offset)
 
1135
            self._size)
1211
1136
        # parse
1212
1137
        for offset, data in readv_data:
1213
 
            offset -= base_offset
1214
1138
            self._bytes_read += len(data)
1215
 
            if offset < 0:
1216
 
                # transport.readv() expanded to extra data which isn't part of
1217
 
                # this index
1218
 
                data = data[-offset:]
1219
 
                offset = 0
1220
1139
            if offset == 0 and len(data) == self._size:
1221
1140
                # We read the whole range, most likely because the
1222
1141
                # Transport upcast our readv ranges into one long request
1249
1168
    static data.
1250
1169
 
1251
1170
    Queries against the combined index will be made against the first index,
1252
 
    and then the second and so on. The order of indices can thus influence
 
1171
    and then the second and so on. The order of index's can thus influence
1253
1172
    performance significantly. For example, if one index is on local disk and a
1254
1173
    second on a remote server, the local disk index should be before the other
1255
1174
    in the index list.
1256
 
    
1257
 
    Also, queries tend to need results from the same indices as previous
1258
 
    queries.  So the indices will be reordered after every query to put the
1259
 
    indices that had the result(s) of that query first (while otherwise
1260
 
    preserving the relative ordering).
1261
1175
    """
1262
1176
 
1263
1177
    def __init__(self, indices, reload_func=None):
1270
1184
        """
1271
1185
        self._indices = indices
1272
1186
        self._reload_func = reload_func
1273
 
        # Sibling indices are other CombinedGraphIndex that we should call
1274
 
        # _move_to_front_by_name on when we auto-reorder ourself.
1275
 
        self._sibling_indices = []
1276
 
        # A list of names that corresponds to the instances in self._indices,
1277
 
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
1278
 
        # indices must all use the same set of names as each other.
1279
 
        self._index_names = [None] * len(self._indices)
1280
1187
 
1281
1188
    def __repr__(self):
1282
1189
        return "%s(%s)" % (
1283
1190
                self.__class__.__name__,
1284
1191
                ', '.join(map(repr, self._indices)))
1285
1192
 
1286
 
    def clear_cache(self):
1287
 
        """See GraphIndex.clear_cache()"""
1288
 
        for index in self._indices:
1289
 
            index.clear_cache()
1290
 
 
1291
1193
    def get_parent_map(self, keys):
1292
1194
        """See graph.StackedParentsProvider.get_parent_map"""
1293
1195
        search_keys = set(keys)
1294
 
        if _mod_revision.NULL_REVISION in search_keys:
1295
 
            search_keys.discard(_mod_revision.NULL_REVISION)
1296
 
            found_parents = {_mod_revision.NULL_REVISION:[]}
 
1196
        if NULL_REVISION in search_keys:
 
1197
            search_keys.discard(NULL_REVISION)
 
1198
            found_parents = {NULL_REVISION:[]}
1297
1199
        else:
1298
1200
            found_parents = {}
1299
1201
        for index, key, value, refs in self.iter_entries(search_keys):
1300
1202
            parents = refs[0]
1301
1203
            if not parents:
1302
 
                parents = (_mod_revision.NULL_REVISION,)
 
1204
                parents = (NULL_REVISION,)
1303
1205
            found_parents[key] = parents
1304
1206
        return found_parents
1305
1207
 
1306
1208
    has_key = _has_key_from_parent_map
1307
1209
 
1308
 
    def insert_index(self, pos, index, name=None):
 
1210
    def insert_index(self, pos, index):
1309
1211
        """Insert a new index in the list of indices to query.
1310
1212
 
1311
1213
        :param pos: The position to insert the index.
1312
1214
        :param index: The index to insert.
1313
 
        :param name: a name for this index, e.g. a pack name.  These names can
1314
 
            be used to reflect index reorderings to related CombinedGraphIndex
1315
 
            instances that use the same names.  (see set_sibling_indices)
1316
1215
        """
1317
1216
        self._indices.insert(pos, index)
1318
 
        self._index_names.insert(pos, name)
1319
1217
 
1320
1218
    def iter_all_entries(self):
1321
1219
        """Iterate over all keys within the index
1346
1244
        value and are only reported once.
1347
1245
 
1348
1246
        :param keys: An iterable providing the keys to be retrieved.
1349
 
        :return: An iterable of (index, key, reference_lists, value). There is
1350
 
            no defined order for the result iteration - it will be in the most
 
1247
        :return: An iterable of (index, key, reference_lists, value). There is no
 
1248
            defined order for the result iteration - it will be in the most
1351
1249
            efficient order for the index.
1352
1250
        """
1353
1251
        keys = set(keys)
1354
 
        hit_indices = []
1355
1252
        while True:
1356
1253
            try:
1357
1254
                for index in self._indices:
1358
1255
                    if not keys:
1359
 
                        break
1360
 
                    index_hit = False
 
1256
                        return
1361
1257
                    for node in index.iter_entries(keys):
1362
1258
                        keys.remove(node[1])
1363
1259
                        yield node
1364
 
                        index_hit = True
1365
 
                    if index_hit:
1366
 
                        hit_indices.append(index)
1367
 
                break
 
1260
                return
1368
1261
            except errors.NoSuchFile:
1369
1262
                self._reload_or_raise()
1370
 
        self._move_to_front(hit_indices)
1371
1263
 
1372
1264
    def iter_entries_prefix(self, keys):
1373
1265
        """Iterate over keys within the index using prefix matching.
1393
1285
        if not keys:
1394
1286
            return
1395
1287
        seen_keys = set()
1396
 
        hit_indices = []
1397
1288
        while True:
1398
1289
            try:
1399
1290
                for index in self._indices:
1400
 
                    index_hit = False
1401
1291
                    for node in index.iter_entries_prefix(keys):
1402
1292
                        if node[1] in seen_keys:
1403
1293
                            continue
1404
1294
                        seen_keys.add(node[1])
1405
1295
                        yield node
1406
 
                        index_hit = True
1407
 
                    if index_hit:
1408
 
                        hit_indices.append(index)
1409
 
                break
 
1296
                return
1410
1297
            except errors.NoSuchFile:
1411
1298
                self._reload_or_raise()
1412
 
        self._move_to_front(hit_indices)
1413
 
 
1414
 
    def _move_to_front(self, hit_indices):
1415
 
        """Rearrange self._indices so that hit_indices are first.
1416
 
 
1417
 
        Order is maintained as much as possible, e.g. the first unhit index
1418
 
        will be the first index in _indices after the hit_indices, and the
1419
 
        hit_indices will be present in exactly the order they are passed to
1420
 
        _move_to_front.
1421
 
 
1422
 
        _move_to_front propagates to all objects in self._sibling_indices by
1423
 
        calling _move_to_front_by_name.
1424
 
        """
1425
 
        if self._indices[:len(hit_indices)] == hit_indices:
1426
 
            # The 'hit_indices' are already at the front (and in the same
1427
 
            # order), no need to re-order
1428
 
            return
1429
 
        hit_names = self._move_to_front_by_index(hit_indices)
1430
 
        for sibling_idx in self._sibling_indices:
1431
 
            sibling_idx._move_to_front_by_name(hit_names)
1432
 
 
1433
 
    def _move_to_front_by_index(self, hit_indices):
1434
 
        """Core logic for _move_to_front.
1435
 
        
1436
 
        Returns a list of names corresponding to the hit_indices param.
1437
 
        """
1438
 
        indices_info = zip(self._index_names, self._indices)
1439
 
        if 'index' in debug.debug_flags:
1440
 
            trace.mutter('CombinedGraphIndex reordering: currently %r, '
1441
 
                         'promoting %r', indices_info, hit_indices)
1442
 
        hit_names = []
1443
 
        unhit_names = []
1444
 
        new_hit_indices = []
1445
 
        unhit_indices = []
1446
 
 
1447
 
        for offset, (name, idx) in enumerate(indices_info):
1448
 
            if idx in hit_indices:
1449
 
                hit_names.append(name)
1450
 
                new_hit_indices.append(idx)
1451
 
                if len(new_hit_indices) == len(hit_indices):
1452
 
                    # We've found all of the hit entries, everything else is
1453
 
                    # unhit
1454
 
                    unhit_names.extend(self._index_names[offset+1:])
1455
 
                    unhit_indices.extend(self._indices[offset+1:])
1456
 
                    break
1457
 
            else:
1458
 
                unhit_names.append(name)
1459
 
                unhit_indices.append(idx)
1460
 
 
1461
 
        self._indices = new_hit_indices + unhit_indices
1462
 
        self._index_names = hit_names + unhit_names
1463
 
        if 'index' in debug.debug_flags:
1464
 
            trace.mutter('CombinedGraphIndex reordered: %r', self._indices)
1465
 
        return hit_names
1466
 
 
1467
 
    def _move_to_front_by_name(self, hit_names):
1468
 
        """Moves indices named by 'hit_names' to front of the search order, as
1469
 
        described in _move_to_front.
1470
 
        """
1471
 
        # Translate names to index instances, and then call
1472
 
        # _move_to_front_by_index.
1473
 
        indices_info = zip(self._index_names, self._indices)
1474
 
        hit_indices = []
1475
 
        for name, idx in indices_info:
1476
 
            if name in hit_names:
1477
 
                hit_indices.append(idx)
1478
 
        self._move_to_front_by_index(hit_indices)
1479
 
 
1480
 
    def find_ancestry(self, keys, ref_list_num):
1481
 
        """Find the complete ancestry for the given set of keys.
1482
 
 
1483
 
        Note that this is a whole-ancestry request, so it should be used
1484
 
        sparingly.
1485
 
 
1486
 
        :param keys: An iterable of keys to look for
1487
 
        :param ref_list_num: The reference list which references the parents
1488
 
            we care about.
1489
 
        :return: (parent_map, missing_keys)
1490
 
        """
1491
 
        # XXX: make this call _move_to_front?
1492
 
        missing_keys = set()
1493
 
        parent_map = {}
1494
 
        keys_to_lookup = set(keys)
1495
 
        generation = 0
1496
 
        while keys_to_lookup:
1497
 
            # keys that *all* indexes claim are missing, stop searching them
1498
 
            generation += 1
1499
 
            all_index_missing = None
1500
 
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
1501
 
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
1502
 
            #                                   len(parent_map),
1503
 
            #                                   len(missing_keys))
1504
 
            for index_idx, index in enumerate(self._indices):
1505
 
                # TODO: we should probably be doing something with
1506
 
                #       'missing_keys' since we've already determined that
1507
 
                #       those revisions have not been found anywhere
1508
 
                index_missing_keys = set()
1509
 
                # Find all of the ancestry we can from this index
1510
 
                # keep looking until the search_keys set is empty, which means
1511
 
                # things we didn't find should be in index_missing_keys
1512
 
                search_keys = keys_to_lookup
1513
 
                sub_generation = 0
1514
 
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
1515
 
                #     index_idx, len(search_keys),
1516
 
                #     len(parent_map), len(index_missing_keys))
1517
 
                while search_keys:
1518
 
                    sub_generation += 1
1519
 
                    # TODO: ref_list_num should really be a parameter, since
1520
 
                    #       CombinedGraphIndex does not know what the ref lists
1521
 
                    #       mean.
1522
 
                    search_keys = index._find_ancestors(search_keys,
1523
 
                        ref_list_num, parent_map, index_missing_keys)
1524
 
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
1525
 
                    #     sub_generation, len(search_keys),
1526
 
                    #     len(parent_map), len(index_missing_keys))
1527
 
                # Now set whatever was missing to be searched in the next index
1528
 
                keys_to_lookup = index_missing_keys
1529
 
                if all_index_missing is None:
1530
 
                    all_index_missing = set(index_missing_keys)
1531
 
                else:
1532
 
                    all_index_missing.intersection_update(index_missing_keys)
1533
 
                if not keys_to_lookup:
1534
 
                    break
1535
 
            if all_index_missing is None:
1536
 
                # There were no indexes, so all search keys are 'missing'
1537
 
                missing_keys.update(keys_to_lookup)
1538
 
                keys_to_lookup = None
1539
 
            else:
1540
 
                missing_keys.update(all_index_missing)
1541
 
                keys_to_lookup.difference_update(all_index_missing)
1542
 
        return parent_map, missing_keys
1543
1299
 
1544
1300
    def key_count(self):
1545
1301
        """Return an estimate of the number of keys in this index.
1574
1330
                         ' Raising original exception.')
1575
1331
            raise exc_type, exc_value, exc_traceback
1576
1332
 
1577
 
    def set_sibling_indices(self, sibling_combined_graph_indices):
1578
 
        """Set the CombinedGraphIndex objects to reorder after reordering self.
1579
 
        """
1580
 
        self._sibling_indices = sibling_combined_graph_indices
1581
 
 
1582
1333
    def validate(self):
1583
1334
        """Validate that everything in the index can be accessed."""
1584
1335
        while True:
1637
1388
            defined order for the result iteration - it will be in the most
1638
1389
            efficient order for the index (keys iteration order in this case).
1639
1390
        """
1640
 
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
1641
 
        #       aren't using set().intersection() here
1642
 
        nodes = self._nodes
1643
 
        keys = [key for key in keys if key in nodes]
 
1391
        keys = set(keys)
1644
1392
        if self.reference_lists:
1645
 
            for key in keys:
1646
 
                node = nodes[key]
 
1393
            for key in keys.intersection(self._keys):
 
1394
                node = self._nodes[key]
1647
1395
                if not node[0]:
1648
1396
                    yield self, key, node[2], node[1]
1649
1397
        else:
1650
 
            for key in keys:
1651
 
                node = nodes[key]
 
1398
            for key in keys.intersection(self._keys):
 
1399
                node = self._nodes[key]
1652
1400
                if not node[0]:
1653
1401
                    yield self, key, node[2]
1654
1402
 
1728
1476
 
1729
1477
        For InMemoryGraphIndex the estimate is exact.
1730
1478
        """
1731
 
        return len(self._nodes) - len(self._absent_keys)
 
1479
        return len(self._keys)
1732
1480
 
1733
1481
    def validate(self):
1734
1482
        """In memory index's have no known corruption at the moment."""