← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Frank Aspell
  • Date: 2009-02-17 11:40:05 UTC
  • mto: (4054.1.1 doc)
  • mto: This revision was merged to the branch mainline in revision 4056.
  • Revision ID: frankaspell@googlemail.com-20090217114005-ojufrp6rqht664um
Fixed typos.

Fixed some typos in bzr doc's using "aspell -l en -c FILENAME".

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
1
 
# Copyright (C) 2007-2010 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
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
"""Indexing facilities."""
18
18
 
39
39
from bzrlib import (
40
40
    debug,
41
41
    errors,
 
42
    symbol_versioning,
42
43
    )
43
 
from bzrlib.static_tuple import StaticTuple
44
44
 
45
45
_HEADER_READV = (0, 200)
46
46
_OPTION_KEY_ELEMENTS = "key_elements="
56
56
def _has_key_from_parent_map(self, key):
57
57
    """Check if this index has one key.
58
58
 
59
 
    If it's possible to check for multiple keys at once through
 
59
    If it's possible to check for multiple keys at once through 
60
60
    calling get_parent_map that should be faster.
61
61
    """
62
62
    return (key in self.get_parent_map([key]))
68
68
 
69
69
class GraphIndexBuilder(object):
70
70
    """A builder that can build a GraphIndex.
71
 
 
 
71
    
72
72
    The resulting graph has the structure:
73
 
 
 
73
    
74
74
    _SIGNATURE OPTIONS NODES NEWLINE
75
75
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
76
76
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
93
93
        :param key_elements: The number of bytestrings in each key.
94
94
        """
95
95
        self.reference_lists = reference_lists
 
96
        self._keys = set()
96
97
        # A dict of {key: (absent, ref_lists, value)}
97
98
        self._nodes = {}
98
 
        # Keys that are referenced but not actually present in this index
99
 
        self._absent_keys = set()
100
99
        self._nodes_by_key = None
101
100
        self._key_length = key_elements
102
101
        self._optimize_for_size = False
103
 
        self._combine_backing_indices = True
104
102
 
105
103
    def _check_key(self, key):
106
104
        """Raise BadIndexKey if key is not a valid key for this index."""
107
 
        if type(key) not in (tuple, StaticTuple):
 
105
        if type(key) != tuple:
108
106
            raise errors.BadIndexKey(key)
109
107
        if self._key_length != len(key):
110
108
            raise errors.BadIndexKey(key)
166
164
            return
167
165
        key_dict = self._nodes_by_key
168
166
        if self.reference_lists:
169
 
            key_value = StaticTuple(key, value, node_refs)
 
167
            key_value = key, value, node_refs
170
168
        else:
171
 
            key_value = StaticTuple(key, value)
 
169
            key_value = key, value
172
170
        for subkey in key[:-1]:
173
171
            key_dict = key_dict.setdefault(subkey, {})
174
172
        key_dict[key[-1]] = key_value
190
188
                                This may contain duplicates if the same key is
191
189
                                referenced in multiple lists.
192
190
        """
193
 
        as_st = StaticTuple.from_sequence
194
191
        self._check_key(key)
195
192
        if _newline_null_re.search(value) is not None:
196
193
            raise errors.BadIndexValue(value)
205
202
                if reference not in self._nodes:
206
203
                    self._check_key(reference)
207
204
                    absent_references.append(reference)
208
 
            reference_list = as_st([as_st(ref).intern()
209
 
                                    for ref in reference_list])
210
 
            node_refs.append(reference_list)
211
 
        return as_st(node_refs), absent_references
 
205
            node_refs.append(tuple(reference_list))
 
206
        return tuple(node_refs), absent_references
212
207
 
213
208
    def add_node(self, key, value, references=()):
214
209
        """Add a node to the index.
229
224
            # There may be duplicates, but I don't think it is worth worrying
230
225
            # about
231
226
            self._nodes[reference] = ('a', (), '')
232
 
        self._absent_keys.update(absent_references)
233
 
        self._absent_keys.discard(key)
234
227
        self._nodes[key] = ('', node_refs, value)
 
228
        self._keys.add(key)
235
229
        if self._nodes_by_key is not None and self._key_length > 1:
236
230
            self._update_nodes_by_key(key, value, node_refs)
237
231
 
238
 
    def clear_cache(self):
239
 
        """See GraphIndex.clear_cache()
240
 
 
241
 
        This is a no-op, but we need the api to conform to a generic 'Index'
242
 
        abstraction.
243
 
        """
244
 
        
245
232
    def finish(self):
246
233
        lines = [_SIGNATURE]
247
234
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
248
235
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
249
 
        key_count = len(self._nodes) - len(self._absent_keys)
250
 
        lines.append(_OPTION_LEN + str(key_count) + '\n')
 
236
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
251
237
        prefix_length = sum(len(x) for x in lines)
252
238
        # references are byte offsets. To avoid having to do nasty
253
239
        # polynomial work to resolve offsets (references to later in the
260
246
        # one to pad all the data with reference-length and determine entry
261
247
        # addresses.
262
248
        # One to serialise.
263
 
 
 
249
        
264
250
        # forward sorted by key. In future we may consider topological sorting,
265
251
        # at the cost of table scans for direct lookup, or a second index for
266
252
        # direct lookup
329
315
                (len(result.getvalue()), expected_bytes))
330
316
        return result
331
317
 
332
 
    def set_optimize(self, for_size=None, combine_backing_indices=None):
 
318
    def set_optimize(self, for_size=True):
333
319
        """Change how the builder tries to optimize the result.
334
320
 
335
321
        :param for_size: Tell the builder to try and make the index as small as
336
322
            possible.
337
 
        :param combine_backing_indices: If the builder spills to disk to save
338
 
            memory, should the on-disk indices be combined. Set to True if you
339
 
            are going to be probing the index, but to False if you are not. (If
340
 
            you are not querying, then the time spent combining is wasted.)
341
323
        :return: None
342
324
        """
343
325
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
344
326
        # other builders do.
345
 
        if for_size is not None:
346
 
            self._optimize_for_size = for_size
347
 
        if combine_backing_indices is not None:
348
 
            self._combine_backing_indices = combine_backing_indices
349
 
 
350
 
    def find_ancestry(self, keys, ref_list_num):
351
 
        """See CombinedGraphIndex.find_ancestry()"""
352
 
        pending = set(keys)
353
 
        parent_map = {}
354
 
        missing_keys = set()
355
 
        while pending:
356
 
            next_pending = set()
357
 
            for _, key, value, ref_lists in self.iter_entries(pending):
358
 
                parent_keys = ref_lists[ref_list_num]
359
 
                parent_map[key] = parent_keys
360
 
                next_pending.update([p for p in parent_keys if p not in
361
 
                                     parent_map])
362
 
                missing_keys.update(pending.difference(parent_map))
363
 
            pending = next_pending
364
 
        return parent_map, missing_keys
 
327
        self._optimize_for_size = for_size
365
328
 
366
329
 
367
330
class GraphIndex(object):
368
331
    """An index for data with embedded graphs.
369
 
 
 
332
 
370
333
    The index maps keys to a list of key reference lists, and a value.
371
334
    Each node has the same number of key reference lists. Each key reference
372
335
    list can be empty or an arbitrary length. The value is an opaque NULL
373
 
    terminated string without any newlines. The storage of the index is
 
336
    terminated string without any newlines. The storage of the index is 
374
337
    hidden in the interface: keys and key references are always tuples of
375
338
    bytestrings, never the internal representation (e.g. dictionary offsets).
376
339
 
382
345
    suitable for production use. :XXX
383
346
    """
384
347
 
385
 
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
 
348
    def __init__(self, transport, name, size):
386
349
        """Open an index called name on transport.
387
350
 
388
351
        :param transport: A bzrlib.transport.Transport.
394
357
            avoided by having it supplied. If size is None, then bisection
395
358
            support will be disabled and accessing the index will just stream
396
359
            all the data.
397
 
        :param offset: Instead of starting the index data at offset 0, start it
398
 
            at an arbitrary offset.
399
360
        """
400
361
        self._transport = transport
401
362
        self._name = name
418
379
        self._size = size
419
380
        # The number of bytes we've read so far in trying to process this file
420
381
        self._bytes_read = 0
421
 
        self._base_offset = offset
422
382
 
423
383
    def __eq__(self, other):
424
384
        """Equal when self and other were created with the same parameters."""
447
407
            mutter('Reading entire index %s', self._transport.abspath(self._name))
448
408
        if stream is None:
449
409
            stream = self._transport.get(self._name)
450
 
            if self._base_offset != 0:
451
 
                # This is wasteful, but it is better than dealing with
452
 
                # adjusting all the offsets, etc.
453
 
                stream = StringIO(stream.read()[self._base_offset:])
454
410
        self._read_prefix(stream)
455
411
        self._expected_elements = 3 + self._key_length
456
412
        line_count = 0
462
418
        trailers = 0
463
419
        pos = stream.tell()
464
420
        lines = stream.read().split('\n')
465
 
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
466
 
        stream.close()
467
421
        del lines[-1]
468
422
        _, _, _, trailers = self._parse_lines(lines, pos)
469
423
        for key, absent, references, value in self._keys_by_offset.itervalues():
476
430
                node_value = value
477
431
            self._nodes[key] = node_value
478
432
        # cache the keys for quick set intersections
 
433
        self._keys = set(self._nodes)
479
434
        if trailers != 1:
480
435
            # there must be one line - the empty trailer line.
481
436
            raise errors.BadIndexData(self)
482
437
 
483
 
    def clear_cache(self):
484
 
        """Clear out any cached/memoized values.
485
 
 
486
 
        This can be called at any time, but generally it is used when we have
487
 
        extracted some information, but don't expect to be requesting any more
488
 
        from this index.
489
 
        """
490
 
 
491
 
    def external_references(self, ref_list_num):
492
 
        """Return references that are not present in this index.
493
 
        """
494
 
        self._buffer_all()
495
 
        if ref_list_num + 1 > self.node_ref_lists:
496
 
            raise ValueError('No ref list %d, index has %d ref lists'
497
 
                % (ref_list_num, self.node_ref_lists))
498
 
        refs = set()
499
 
        nodes = self._nodes
500
 
        for key, (value, ref_lists) in nodes.iteritems():
501
 
            ref_list = ref_lists[ref_list_num]
502
 
            refs.update([ref for ref in ref_list if ref not in nodes])
503
 
        return refs
504
 
 
505
438
    def _get_nodes_by_key(self):
506
439
        if self._nodes_by_key is None:
507
440
            nodes_by_key = {}
569
502
 
570
503
    def _resolve_references(self, references):
571
504
        """Return the resolved key references for references.
572
 
 
 
505
        
573
506
        References are resolved by looking up the location of the key in the
574
507
        _keys_by_offset map and substituting the key name, preserving ordering.
575
508
 
576
 
        :param references: An iterable of iterables of key locations. e.g.
 
509
        :param references: An iterable of iterables of key locations. e.g. 
577
510
            [[123, 456], [123]]
578
511
        :return: A tuple of tuples of keys.
579
512
        """
633
566
 
634
567
    def _iter_entries_from_total_buffer(self, keys):
635
568
        """Iterate over keys when the entire index is parsed."""
636
 
        # Note: See the note in BTreeBuilder.iter_entries for why we don't use
637
 
        #       .intersection() here
638
 
        nodes = self._nodes
639
 
        keys = [key for key in keys if key in nodes]
 
569
        keys = keys.intersection(self._keys)
640
570
        if self.node_ref_lists:
641
571
            for key in keys:
642
 
                value, node_refs = nodes[key]
 
572
                value, node_refs = self._nodes[key]
643
573
                yield self, key, value, node_refs
644
574
        else:
645
575
            for key in keys:
646
 
                yield self, key, nodes[key]
 
576
                yield self, key, self._nodes[key]
647
577
 
648
578
    def iter_entries(self, keys):
649
579
        """Iterate over keys within the index.
740
670
                    # can't be empty or would not exist
741
671
                    item, value = key_dict.iteritems().next()
742
672
                    if type(value) == dict:
743
 
                        # push keys
 
673
                        # push keys 
744
674
                        dicts.extend(key_dict.itervalues())
745
675
                    else:
746
676
                        # yield keys
752
682
                # the last thing looked up was a terminal element
753
683
                yield (self, ) + key_dict
754
684
 
755
 
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
756
 
        """See BTreeIndex._find_ancestors."""
757
 
        # The api can be implemented as a trivial overlay on top of
758
 
        # iter_entries, it is not an efficient implementation, but it at least
759
 
        # gets the job done.
760
 
        found_keys = set()
761
 
        search_keys = set()
762
 
        for index, key, value, refs in self.iter_entries(keys):
763
 
            parent_keys = refs[ref_list_num]
764
 
            found_keys.add(key)
765
 
            parent_map[key] = parent_keys
766
 
            search_keys.update(parent_keys)
767
 
        # Figure out what, if anything, was missing
768
 
        missing_keys.update(set(keys).difference(found_keys))
769
 
        search_keys = search_keys.difference(parent_map)
770
 
        return search_keys
771
 
 
772
685
    def key_count(self):
773
686
        """Return an estimate of the number of keys in this index.
774
 
 
 
687
        
775
688
        For GraphIndex the estimate is exact.
776
689
        """
777
690
        if self._key_count is None:
793
706
        # Possible improvements:
794
707
        #  - only bisect lookup each key once
795
708
        #  - sort the keys first, and use that to reduce the bisection window
796
 
        # -----
 
709
        # ----- 
797
710
        # this progresses in three parts:
798
711
        # read data
799
712
        # parse it
808
721
                # We have the key parsed.
809
722
                continue
810
723
            index = self._parsed_key_index(key)
811
 
            if (len(self._parsed_key_map) and
 
724
            if (len(self._parsed_key_map) and 
812
725
                self._parsed_key_map[index][0] <= key and
813
726
                (self._parsed_key_map[index][1] >= key or
814
727
                 # end of the file has been parsed
818
731
                continue
819
732
            # - if we have examined this part of the file already - yes
820
733
            index = self._parsed_byte_index(location)
821
 
            if (len(self._parsed_byte_map) and
 
734
            if (len(self._parsed_byte_map) and 
822
735
                self._parsed_byte_map[index][0] <= location and
823
736
                self._parsed_byte_map[index][1] > location):
824
737
                # the byte region has been parsed, so no read is needed.
1079
992
        # adjust offset and data to the parseable data.
1080
993
        trimmed_data = data[trim_start:trim_end]
1081
994
        if not (trimmed_data):
1082
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
 
995
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
1083
996
                % (trim_start, trim_end, offset, offset + len(data)))
1084
997
        if trim_start:
1085
998
            offset += trim_start
1186
1099
            self._parsed_key_map.insert(index + 1, new_key)
1187
1100
 
1188
1101
    def _read_and_parse(self, readv_ranges):
1189
 
        """Read the ranges and parse the resulting data.
 
1102
        """Read the the ranges and parse the resulting data.
1190
1103
 
1191
1104
        :param readv_ranges: A prepared readv range list.
1192
1105
        """
1198
1111
            self._buffer_all()
1199
1112
            return
1200
1113
 
1201
 
        base_offset = self._base_offset
1202
 
        if base_offset != 0:
1203
 
            # Rewrite the ranges for the offset
1204
 
            readv_ranges = [(start+base_offset, size)
1205
 
                            for start, size in readv_ranges]
1206
1114
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1207
 
            self._size + self._base_offset)
 
1115
            self._size)
1208
1116
        # parse
1209
1117
        for offset, data in readv_data:
1210
 
            offset -= base_offset
1211
1118
            self._bytes_read += len(data)
1212
 
            if offset < 0:
1213
 
                # transport.readv() expanded to extra data which isn't part of
1214
 
                # this index
1215
 
                data = data[-offset:]
1216
 
                offset = 0
1217
1119
            if offset == 0 and len(data) == self._size:
1218
1120
                # We read the whole range, most likely because the
1219
1121
                # Transport upcast our readv ranges into one long request
1241
1143
 
1242
1144
class CombinedGraphIndex(object):
1243
1145
    """A GraphIndex made up from smaller GraphIndices.
1244
 
 
 
1146
    
1245
1147
    The backing indices must implement GraphIndex, and are presumed to be
1246
1148
    static data.
1247
1149
 
1248
1150
    Queries against the combined index will be made against the first index,
1249
 
    and then the second and so on. The order of indices can thus influence
 
1151
    and then the second and so on. The order of index's can thus influence
1250
1152
    performance significantly. For example, if one index is on local disk and a
1251
1153
    second on a remote server, the local disk index should be before the other
1252
1154
    in the index list.
1253
 
    
1254
 
    Also, queries tend to need results from the same indices as previous
1255
 
    queries.  So the indices will be reordered after every query to put the
1256
 
    indices that had the result(s) of that query first (while otherwise
1257
 
    preserving the relative ordering).
1258
1155
    """
1259
1156
 
1260
1157
    def __init__(self, indices, reload_func=None):
1267
1164
        """
1268
1165
        self._indices = indices
1269
1166
        self._reload_func = reload_func
1270
 
        # Sibling indices are other CombinedGraphIndex that we should call
1271
 
        # _move_to_front_by_name on when we auto-reorder ourself.
1272
 
        self._sibling_indices = []
1273
 
        # A list of names that corresponds to the instances in self._indices,
1274
 
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
1275
 
        # indices must all use the same set of names as each other.
1276
 
        self._index_names = [None] * len(self._indices)
1277
1167
 
1278
1168
    def __repr__(self):
1279
1169
        return "%s(%s)" % (
1280
1170
                self.__class__.__name__,
1281
1171
                ', '.join(map(repr, self._indices)))
1282
1172
 
1283
 
    def clear_cache(self):
1284
 
        """See GraphIndex.clear_cache()"""
1285
 
        for index in self._indices:
1286
 
            index.clear_cache()
 
1173
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
1174
    def get_parents(self, revision_ids):
 
1175
        """See graph._StackedParentsProvider.get_parents.
 
1176
        
 
1177
        This implementation thunks the graph.Graph.get_parents api across to
 
1178
        GraphIndex.
 
1179
 
 
1180
        :param revision_ids: An iterable of graph keys for this graph.
 
1181
        :return: A list of parent details for each key in revision_ids.
 
1182
            Each parent details will be one of:
 
1183
             * None when the key was missing
 
1184
             * (NULL_REVISION,) when the key has no parents.
 
1185
             * (parent_key, parent_key...) otherwise.
 
1186
        """
 
1187
        parent_map = self.get_parent_map(revision_ids)
 
1188
        return [parent_map.get(r, None) for r in revision_ids]
1287
1189
 
1288
1190
    def get_parent_map(self, keys):
1289
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
1191
        """See graph._StackedParentsProvider.get_parent_map"""
1290
1192
        search_keys = set(keys)
1291
1193
        if NULL_REVISION in search_keys:
1292
1194
            search_keys.discard(NULL_REVISION)
1302
1204
 
1303
1205
    has_key = _has_key_from_parent_map
1304
1206
 
1305
 
    def insert_index(self, pos, index, name=None):
 
1207
    def insert_index(self, pos, index):
1306
1208
        """Insert a new index in the list of indices to query.
1307
1209
 
1308
1210
        :param pos: The position to insert the index.
1309
1211
        :param index: The index to insert.
1310
 
        :param name: a name for this index, e.g. a pack name.  These names can
1311
 
            be used to reflect index reorderings to related CombinedGraphIndex
1312
 
            instances that use the same names.  (see set_sibling_indices)
1313
1212
        """
1314
1213
        self._indices.insert(pos, index)
1315
 
        self._index_names.insert(pos, name)
1316
1214
 
1317
1215
    def iter_all_entries(self):
1318
1216
        """Iterate over all keys within the index
1343
1241
        value and are only reported once.
1344
1242
 
1345
1243
        :param keys: An iterable providing the keys to be retrieved.
1346
 
        :return: An iterable of (index, key, reference_lists, value). There is
1347
 
            no defined order for the result iteration - it will be in the most
 
1244
        :return: An iterable of (index, key, reference_lists, value). There is no
 
1245
            defined order for the result iteration - it will be in the most
1348
1246
            efficient order for the index.
1349
1247
        """
1350
1248
        keys = set(keys)
1351
 
        hit_indices = []
1352
1249
        while True:
1353
1250
            try:
1354
1251
                for index in self._indices:
1355
1252
                    if not keys:
1356
 
                        break
1357
 
                    index_hit = False
 
1253
                        return
1358
1254
                    for node in index.iter_entries(keys):
1359
1255
                        keys.remove(node[1])
1360
1256
                        yield node
1361
 
                        index_hit = True
1362
 
                    if index_hit:
1363
 
                        hit_indices.append(index)
1364
 
                break
 
1257
                return
1365
1258
            except errors.NoSuchFile:
1366
1259
                self._reload_or_raise()
1367
 
        self._move_to_front(hit_indices)
1368
1260
 
1369
1261
    def iter_entries_prefix(self, keys):
1370
1262
        """Iterate over keys within the index using prefix matching.
1390
1282
        if not keys:
1391
1283
            return
1392
1284
        seen_keys = set()
1393
 
        hit_indices = []
1394
1285
        while True:
1395
1286
            try:
1396
1287
                for index in self._indices:
1397
 
                    index_hit = False
1398
1288
                    for node in index.iter_entries_prefix(keys):
1399
1289
                        if node[1] in seen_keys:
1400
1290
                            continue
1401
1291
                        seen_keys.add(node[1])
1402
1292
                        yield node
1403
 
                        index_hit = True
1404
 
                    if index_hit:
1405
 
                        hit_indices.append(index)
1406
 
                break
 
1293
                return
1407
1294
            except errors.NoSuchFile:
1408
1295
                self._reload_or_raise()
1409
 
        self._move_to_front(hit_indices)
1410
 
 
1411
 
    def _move_to_front(self, hit_indices):
1412
 
        """Rearrange self._indices so that hit_indices are first.
1413
 
 
1414
 
        Order is maintained as much as possible, e.g. the first unhit index
1415
 
        will be the first index in _indices after the hit_indices, and the
1416
 
        hit_indices will be present in exactly the order they are passed to
1417
 
        _move_to_front.
1418
 
 
1419
 
        _move_to_front propagates to all objects in self._sibling_indices by
1420
 
        calling _move_to_front_by_name.
1421
 
        """
1422
 
        if self._indices[:len(hit_indices)] == hit_indices:
1423
 
            # The 'hit_indices' are already at the front (and in the same
1424
 
            # order), no need to re-order
1425
 
            return
1426
 
        hit_names = self._move_to_front_by_index(hit_indices)
1427
 
        for sibling_idx in self._sibling_indices:
1428
 
            sibling_idx._move_to_front_by_name(hit_names)
1429
 
 
1430
 
    def _move_to_front_by_index(self, hit_indices):
1431
 
        """Core logic for _move_to_front.
1432
 
        
1433
 
        Returns a list of names corresponding to the hit_indices param.
1434
 
        """
1435
 
        indices_info = zip(self._index_names, self._indices)
1436
 
        if 'index' in debug.debug_flags:
1437
 
            mutter('CombinedGraphIndex reordering: currently %r, promoting %r',
1438
 
                   indices_info, hit_indices)
1439
 
        hit_names = []
1440
 
        unhit_names = []
1441
 
        new_hit_indices = []
1442
 
        unhit_indices = []
1443
 
 
1444
 
        for offset, (name, idx) in enumerate(indices_info):
1445
 
            if idx in hit_indices:
1446
 
                hit_names.append(name)
1447
 
                new_hit_indices.append(idx)
1448
 
                if len(new_hit_indices) == len(hit_indices):
1449
 
                    # We've found all of the hit entries, everything else is
1450
 
                    # unhit
1451
 
                    unhit_names.extend(self._index_names[offset+1:])
1452
 
                    unhit_indices.extend(self._indices[offset+1:])
1453
 
                    break
1454
 
            else:
1455
 
                unhit_names.append(name)
1456
 
                unhit_indices.append(idx)
1457
 
 
1458
 
        self._indices = new_hit_indices + unhit_indices
1459
 
        self._index_names = hit_names + unhit_names
1460
 
        if 'index' in debug.debug_flags:
1461
 
            mutter('CombinedGraphIndex reordered: %r', self._indices)
1462
 
        return hit_names
1463
 
 
1464
 
    def _move_to_front_by_name(self, hit_names):
1465
 
        """Moves indices named by 'hit_names' to front of the search order, as
1466
 
        described in _move_to_front.
1467
 
        """
1468
 
        # Translate names to index instances, and then call
1469
 
        # _move_to_front_by_index.
1470
 
        indices_info = zip(self._index_names, self._indices)
1471
 
        hit_indices = []
1472
 
        for name, idx in indices_info:
1473
 
            if name in hit_names:
1474
 
                hit_indices.append(idx)
1475
 
        self._move_to_front_by_index(hit_indices)
1476
 
 
1477
 
    def find_ancestry(self, keys, ref_list_num):
1478
 
        """Find the complete ancestry for the given set of keys.
1479
 
 
1480
 
        Note that this is a whole-ancestry request, so it should be used
1481
 
        sparingly.
1482
 
 
1483
 
        :param keys: An iterable of keys to look for
1484
 
        :param ref_list_num: The reference list which references the parents
1485
 
            we care about.
1486
 
        :return: (parent_map, missing_keys)
1487
 
        """
1488
 
        # XXX: make this call _move_to_front?
1489
 
        missing_keys = set()
1490
 
        parent_map = {}
1491
 
        keys_to_lookup = set(keys)
1492
 
        generation = 0
1493
 
        while keys_to_lookup:
1494
 
            # keys that *all* indexes claim are missing, stop searching them
1495
 
            generation += 1
1496
 
            all_index_missing = None
1497
 
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
1498
 
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
1499
 
            #                                   len(parent_map),
1500
 
            #                                   len(missing_keys))
1501
 
            for index_idx, index in enumerate(self._indices):
1502
 
                # TODO: we should probably be doing something with
1503
 
                #       'missing_keys' since we've already determined that
1504
 
                #       those revisions have not been found anywhere
1505
 
                index_missing_keys = set()
1506
 
                # Find all of the ancestry we can from this index
1507
 
                # keep looking until the search_keys set is empty, which means
1508
 
                # things we didn't find should be in index_missing_keys
1509
 
                search_keys = keys_to_lookup
1510
 
                sub_generation = 0
1511
 
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
1512
 
                #     index_idx, len(search_keys),
1513
 
                #     len(parent_map), len(index_missing_keys))
1514
 
                while search_keys:
1515
 
                    sub_generation += 1
1516
 
                    # TODO: ref_list_num should really be a parameter, since
1517
 
                    #       CombinedGraphIndex does not know what the ref lists
1518
 
                    #       mean.
1519
 
                    search_keys = index._find_ancestors(search_keys,
1520
 
                        ref_list_num, parent_map, index_missing_keys)
1521
 
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
1522
 
                    #     sub_generation, len(search_keys),
1523
 
                    #     len(parent_map), len(index_missing_keys))
1524
 
                # Now set whatever was missing to be searched in the next index
1525
 
                keys_to_lookup = index_missing_keys
1526
 
                if all_index_missing is None:
1527
 
                    all_index_missing = set(index_missing_keys)
1528
 
                else:
1529
 
                    all_index_missing.intersection_update(index_missing_keys)
1530
 
                if not keys_to_lookup:
1531
 
                    break
1532
 
            if all_index_missing is None:
1533
 
                # There were no indexes, so all search keys are 'missing'
1534
 
                missing_keys.update(keys_to_lookup)
1535
 
                keys_to_lookup = None
1536
 
            else:
1537
 
                missing_keys.update(all_index_missing)
1538
 
                keys_to_lookup.difference_update(all_index_missing)
1539
 
        return parent_map, missing_keys
1540
1296
 
1541
1297
    def key_count(self):
1542
1298
        """Return an estimate of the number of keys in this index.
1571
1327
                         ' Raising original exception.')
1572
1328
            raise exc_type, exc_value, exc_traceback
1573
1329
 
1574
 
    def set_sibling_indices(self, sibling_combined_graph_indices):
1575
 
        """Set the CombinedGraphIndex objects to reorder after reordering self.
1576
 
        """
1577
 
        self._sibling_indices = sibling_combined_graph_indices
1578
 
 
1579
1330
    def validate(self):
1580
1331
        """Validate that everything in the index can be accessed."""
1581
1332
        while True:
1634
1385
            defined order for the result iteration - it will be in the most
1635
1386
            efficient order for the index (keys iteration order in this case).
1636
1387
        """
1637
 
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
1638
 
        #       aren't using set().intersection() here
1639
 
        nodes = self._nodes
1640
 
        keys = [key for key in keys if key in nodes]
 
1388
        keys = set(keys)
1641
1389
        if self.reference_lists:
1642
 
            for key in keys:
1643
 
                node = nodes[key]
 
1390
            for key in keys.intersection(self._keys):
 
1391
                node = self._nodes[key]
1644
1392
                if not node[0]:
1645
1393
                    yield self, key, node[2], node[1]
1646
1394
        else:
1647
 
            for key in keys:
1648
 
                node = nodes[key]
 
1395
            for key in keys.intersection(self._keys):
 
1396
                node = self._nodes[key]
1649
1397
                if not node[0]:
1650
1398
                    yield self, key, node[2]
1651
1399
 
1680
1428
                    raise errors.BadIndexKey(key)
1681
1429
                node = self._nodes[key]
1682
1430
                if node[0]:
1683
 
                    continue
 
1431
                    continue 
1684
1432
                if self.reference_lists:
1685
1433
                    yield self, key, node[2], node[1]
1686
1434
                else:
1711
1459
                    # can't be empty or would not exist
1712
1460
                    item, value = key_dict.iteritems().next()
1713
1461
                    if type(value) == dict:
1714
 
                        # push keys
 
1462
                        # push keys 
1715
1463
                        dicts.extend(key_dict.itervalues())
1716
1464
                    else:
1717
1465
                        # yield keys
1722
1470
 
1723
1471
    def key_count(self):
1724
1472
        """Return an estimate of the number of keys in this index.
1725
 
 
 
1473
        
1726
1474
        For InMemoryGraphIndex the estimate is exact.
1727
1475
        """
1728
 
        return len(self._nodes) - len(self._absent_keys)
 
1476
        return len(self._keys)
1729
1477
 
1730
1478
    def validate(self):
1731
1479
        """In memory index's have no known corruption at the moment."""
1736
1484
 
1737
1485
    Queries against this will emit queries against the adapted Graph with the
1738
1486
    prefix added, queries for all items use iter_entries_prefix. The returned
1739
 
    nodes will have their keys and node references adjusted to remove the
 
1487
    nodes will have their keys and node references adjusted to remove the 
1740
1488
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1741
1489
    nodes and references being added will have prefix prepended.
1742
1490
    """
1769
1517
                    adjusted_references))
1770
1518
        except ValueError:
1771
1519
            # XXX: TODO add an explicit interface for getting the reference list
1772
 
            # status, to handle this bit of user-friendliness in the API more
 
1520
            # status, to handle this bit of user-friendliness in the API more 
1773
1521
            # explicitly.
1774
1522
            for (key, value) in nodes:
1775
1523
                translated_nodes.append((self.prefix + key, value))
1847
1595
 
1848
1596
    def key_count(self):
1849
1597
        """Return an estimate of the number of keys in this index.
1850
 
 
 
1598
        
1851
1599
        For GraphIndexPrefixAdapter this is relatively expensive - key
1852
1600
        iteration with the prefix is done.
1853
1601
        """