← 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-07-01 10:46:27 UTC
  • mto: This revision was merged to the branch mainline in revision 4504.
  • Revision ID: andrew.bennetts@canonical.com-20090701104627-fgiuxcyfiotm386r
Remove more unused imports.

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