← 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: 2010-06-25 06:47:40 UTC
  • mto: (5050.3.16 2.2)
  • mto: This revision was merged to the branch mainline in revision 5365.
  • Revision ID: andrew.bennetts@canonical.com-20100625064740-k93ngat248kdcqdm
Remove merge_into_helper for now, as it currently has no callers.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
1
 
# Copyright (C) 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2007-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Indexing facilities."""
18
18
 
39
39
from bzrlib import (
40
40
    debug,
41
41
    errors,
42
 
    symbol_versioning,
43
42
    )
 
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()
97
96
        # A dict of {key: (absent, ref_lists, value)}
98
97
        self._nodes = {}
 
98
        # Keys that are referenced but not actually present in this index
 
99
        self._absent_keys = set()
99
100
        self._nodes_by_key = None
100
101
        self._key_length = key_elements
101
102
        self._optimize_for_size = False
 
103
        self._combine_backing_indices = True
102
104
 
103
105
    def _check_key(self, key):
104
106
        """Raise BadIndexKey if key is not a valid key for this index."""
105
 
        if type(key) != tuple:
 
107
        if type(key) not in (tuple, StaticTuple):
106
108
            raise errors.BadIndexKey(key)
107
109
        if self._key_length != len(key):
108
110
            raise errors.BadIndexKey(key)
164
166
            return
165
167
        key_dict = self._nodes_by_key
166
168
        if self.reference_lists:
167
 
            key_value = key, value, node_refs
 
169
            key_value = StaticTuple(key, value, node_refs)
168
170
        else:
169
 
            key_value = key, value
 
171
            key_value = StaticTuple(key, value)
170
172
        for subkey in key[:-1]:
171
173
            key_dict = key_dict.setdefault(subkey, {})
172
174
        key_dict[key[-1]] = key_value
188
190
                                This may contain duplicates if the same key is
189
191
                                referenced in multiple lists.
190
192
        """
 
193
        as_st = StaticTuple.from_sequence
191
194
        self._check_key(key)
192
195
        if _newline_null_re.search(value) is not None:
193
196
            raise errors.BadIndexValue(value)
202
205
                if reference not in self._nodes:
203
206
                    self._check_key(reference)
204
207
                    absent_references.append(reference)
205
 
            node_refs.append(tuple(reference_list))
206
 
        return tuple(node_refs), absent_references
 
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
207
212
 
208
213
    def add_node(self, key, value, references=()):
209
214
        """Add a node to the index.
224
229
            # There may be duplicates, but I don't think it is worth worrying
225
230
            # about
226
231
            self._nodes[reference] = ('a', (), '')
 
232
        self._absent_keys.update(absent_references)
 
233
        self._absent_keys.discard(key)
227
234
        self._nodes[key] = ('', node_refs, value)
228
 
        self._keys.add(key)
229
235
        if self._nodes_by_key is not None and self._key_length > 1:
230
236
            self._update_nodes_by_key(key, value, node_refs)
231
237
 
 
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
        
232
245
    def finish(self):
233
246
        lines = [_SIGNATURE]
234
247
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
235
248
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
236
 
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
 
249
        key_count = len(self._nodes) - len(self._absent_keys)
 
250
        lines.append(_OPTION_LEN + str(key_count) + '\n')
237
251
        prefix_length = sum(len(x) for x in lines)
238
252
        # references are byte offsets. To avoid having to do nasty
239
253
        # polynomial work to resolve offsets (references to later in the
246
260
        # one to pad all the data with reference-length and determine entry
247
261
        # addresses.
248
262
        # One to serialise.
249
 
        
 
263
 
250
264
        # forward sorted by key. In future we may consider topological sorting,
251
265
        # at the cost of table scans for direct lookup, or a second index for
252
266
        # direct lookup
315
329
                (len(result.getvalue()), expected_bytes))
316
330
        return result
317
331
 
318
 
    def set_optimize(self, for_size=True):
 
332
    def set_optimize(self, for_size=None, combine_backing_indices=None):
319
333
        """Change how the builder tries to optimize the result.
320
334
 
321
335
        :param for_size: Tell the builder to try and make the index as small as
322
336
            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.)
323
341
        :return: None
324
342
        """
325
343
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
326
344
        # other builders do.
327
 
        self._optimize_for_size = for_size
 
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
328
365
 
329
366
 
330
367
class GraphIndex(object):
331
368
    """An index for data with embedded graphs.
332
 
 
 
369
 
333
370
    The index maps keys to a list of key reference lists, and a value.
334
371
    Each node has the same number of key reference lists. Each key reference
335
372
    list can be empty or an arbitrary length. The value is an opaque NULL
336
 
    terminated string without any newlines. The storage of the index is 
 
373
    terminated string without any newlines. The storage of the index is
337
374
    hidden in the interface: keys and key references are always tuples of
338
375
    bytestrings, never the internal representation (e.g. dictionary offsets).
339
376
 
345
382
    suitable for production use. :XXX
346
383
    """
347
384
 
348
 
    def __init__(self, transport, name, size):
 
385
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
349
386
        """Open an index called name on transport.
350
387
 
351
388
        :param transport: A bzrlib.transport.Transport.
357
394
            avoided by having it supplied. If size is None, then bisection
358
395
            support will be disabled and accessing the index will just stream
359
396
            all the data.
 
397
        :param offset: Instead of starting the index data at offset 0, start it
 
398
            at an arbitrary offset.
360
399
        """
361
400
        self._transport = transport
362
401
        self._name = name
379
418
        self._size = size
380
419
        # The number of bytes we've read so far in trying to process this file
381
420
        self._bytes_read = 0
 
421
        self._base_offset = offset
382
422
 
383
423
    def __eq__(self, other):
384
424
        """Equal when self and other were created with the same parameters."""
407
447
            mutter('Reading entire index %s', self._transport.abspath(self._name))
408
448
        if stream is None:
409
449
            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:])
410
454
        self._read_prefix(stream)
411
455
        self._expected_elements = 3 + self._key_length
412
456
        line_count = 0
418
462
        trailers = 0
419
463
        pos = stream.tell()
420
464
        lines = stream.read().split('\n')
 
465
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
 
466
        stream.close()
421
467
        del lines[-1]
422
468
        _, _, _, trailers = self._parse_lines(lines, pos)
423
469
        for key, absent, references, value in self._keys_by_offset.itervalues():
430
476
                node_value = value
431
477
            self._nodes[key] = node_value
432
478
        # cache the keys for quick set intersections
433
 
        self._keys = set(self._nodes)
434
479
        if trailers != 1:
435
480
            # there must be one line - the empty trailer line.
436
481
            raise errors.BadIndexData(self)
437
482
 
 
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
 
438
505
    def _get_nodes_by_key(self):
439
506
        if self._nodes_by_key is None:
440
507
            nodes_by_key = {}
502
569
 
503
570
    def _resolve_references(self, references):
504
571
        """Return the resolved key references for references.
505
 
        
 
572
 
506
573
        References are resolved by looking up the location of the key in the
507
574
        _keys_by_offset map and substituting the key name, preserving ordering.
508
575
 
509
 
        :param references: An iterable of iterables of key locations. e.g. 
 
576
        :param references: An iterable of iterables of key locations. e.g.
510
577
            [[123, 456], [123]]
511
578
        :return: A tuple of tuples of keys.
512
579
        """
566
633
 
567
634
    def _iter_entries_from_total_buffer(self, keys):
568
635
        """Iterate over keys when the entire index is parsed."""
569
 
        keys = keys.intersection(self._keys)
 
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]
570
640
        if self.node_ref_lists:
571
641
            for key in keys:
572
 
                value, node_refs = self._nodes[key]
 
642
                value, node_refs = nodes[key]
573
643
                yield self, key, value, node_refs
574
644
        else:
575
645
            for key in keys:
576
 
                yield self, key, self._nodes[key]
 
646
                yield self, key, nodes[key]
577
647
 
578
648
    def iter_entries(self, keys):
579
649
        """Iterate over keys within the index.
670
740
                    # can't be empty or would not exist
671
741
                    item, value = key_dict.iteritems().next()
672
742
                    if type(value) == dict:
673
 
                        # push keys 
 
743
                        # push keys
674
744
                        dicts.extend(key_dict.itervalues())
675
745
                    else:
676
746
                        # yield keys
682
752
                # the last thing looked up was a terminal element
683
753
                yield (self, ) + key_dict
684
754
 
 
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
 
685
772
    def key_count(self):
686
773
        """Return an estimate of the number of keys in this index.
687
 
        
 
774
 
688
775
        For GraphIndex the estimate is exact.
689
776
        """
690
777
        if self._key_count is None:
706
793
        # Possible improvements:
707
794
        #  - only bisect lookup each key once
708
795
        #  - sort the keys first, and use that to reduce the bisection window
709
 
        # ----- 
 
796
        # -----
710
797
        # this progresses in three parts:
711
798
        # read data
712
799
        # parse it
721
808
                # We have the key parsed.
722
809
                continue
723
810
            index = self._parsed_key_index(key)
724
 
            if (len(self._parsed_key_map) and 
 
811
            if (len(self._parsed_key_map) and
725
812
                self._parsed_key_map[index][0] <= key and
726
813
                (self._parsed_key_map[index][1] >= key or
727
814
                 # end of the file has been parsed
731
818
                continue
732
819
            # - if we have examined this part of the file already - yes
733
820
            index = self._parsed_byte_index(location)
734
 
            if (len(self._parsed_byte_map) and 
 
821
            if (len(self._parsed_byte_map) and
735
822
                self._parsed_byte_map[index][0] <= location and
736
823
                self._parsed_byte_map[index][1] > location):
737
824
                # the byte region has been parsed, so no read is needed.
992
1079
        # adjust offset and data to the parseable data.
993
1080
        trimmed_data = data[trim_start:trim_end]
994
1081
        if not (trimmed_data):
995
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
 
1082
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
996
1083
                % (trim_start, trim_end, offset, offset + len(data)))
997
1084
        if trim_start:
998
1085
            offset += trim_start
1099
1186
            self._parsed_key_map.insert(index + 1, new_key)
1100
1187
 
1101
1188
    def _read_and_parse(self, readv_ranges):
1102
 
        """Read the the ranges and parse the resulting data.
 
1189
        """Read the ranges and parse the resulting data.
1103
1190
 
1104
1191
        :param readv_ranges: A prepared readv range list.
1105
1192
        """
1111
1198
            self._buffer_all()
1112
1199
            return
1113
1200
 
 
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]
1114
1206
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1115
 
            self._size)
 
1207
            self._size + self._base_offset)
1116
1208
        # parse
1117
1209
        for offset, data in readv_data:
 
1210
            offset -= base_offset
1118
1211
            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
1119
1217
            if offset == 0 and len(data) == self._size:
1120
1218
                # We read the whole range, most likely because the
1121
1219
                # Transport upcast our readv ranges into one long request
1143
1241
 
1144
1242
class CombinedGraphIndex(object):
1145
1243
    """A GraphIndex made up from smaller GraphIndices.
1146
 
    
 
1244
 
1147
1245
    The backing indices must implement GraphIndex, and are presumed to be
1148
1246
    static data.
1149
1247
 
1150
1248
    Queries against the combined index will be made against the first index,
1151
 
    and then the second and so on. The order of index's can thus influence
 
1249
    and then the second and so on. The order of indices can thus influence
1152
1250
    performance significantly. For example, if one index is on local disk and a
1153
1251
    second on a remote server, the local disk index should be before the other
1154
1252
    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).
1155
1258
    """
1156
1259
 
1157
1260
    def __init__(self, indices, reload_func=None):
1164
1267
        """
1165
1268
        self._indices = indices
1166
1269
        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)
1167
1277
 
1168
1278
    def __repr__(self):
1169
1279
        return "%s(%s)" % (
1170
1280
                self.__class__.__name__,
1171
1281
                ', '.join(map(repr, self._indices)))
1172
1282
 
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]
 
1283
    def clear_cache(self):
 
1284
        """See GraphIndex.clear_cache()"""
 
1285
        for index in self._indices:
 
1286
            index.clear_cache()
1189
1287
 
1190
1288
    def get_parent_map(self, keys):
1191
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
1289
        """See graph.StackedParentsProvider.get_parent_map"""
1192
1290
        search_keys = set(keys)
1193
1291
        if NULL_REVISION in search_keys:
1194
1292
            search_keys.discard(NULL_REVISION)
1204
1302
 
1205
1303
    has_key = _has_key_from_parent_map
1206
1304
 
1207
 
    def insert_index(self, pos, index):
 
1305
    def insert_index(self, pos, index, name=None):
1208
1306
        """Insert a new index in the list of indices to query.
1209
1307
 
1210
1308
        :param pos: The position to insert the index.
1211
1309
        :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)
1212
1313
        """
1213
1314
        self._indices.insert(pos, index)
 
1315
        self._index_names.insert(pos, name)
1214
1316
 
1215
1317
    def iter_all_entries(self):
1216
1318
        """Iterate over all keys within the index
1241
1343
        value and are only reported once.
1242
1344
 
1243
1345
        :param keys: An iterable providing the keys to be retrieved.
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
 
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
1246
1348
            efficient order for the index.
1247
1349
        """
1248
1350
        keys = set(keys)
 
1351
        hit_indices = []
1249
1352
        while True:
1250
1353
            try:
1251
1354
                for index in self._indices:
1252
1355
                    if not keys:
1253
 
                        return
 
1356
                        break
 
1357
                    index_hit = False
1254
1358
                    for node in index.iter_entries(keys):
1255
1359
                        keys.remove(node[1])
1256
1360
                        yield node
1257
 
                return
 
1361
                        index_hit = True
 
1362
                    if index_hit:
 
1363
                        hit_indices.append(index)
 
1364
                break
1258
1365
            except errors.NoSuchFile:
1259
1366
                self._reload_or_raise()
 
1367
        self._move_to_front(hit_indices)
1260
1368
 
1261
1369
    def iter_entries_prefix(self, keys):
1262
1370
        """Iterate over keys within the index using prefix matching.
1282
1390
        if not keys:
1283
1391
            return
1284
1392
        seen_keys = set()
 
1393
        hit_indices = []
1285
1394
        while True:
1286
1395
            try:
1287
1396
                for index in self._indices:
 
1397
                    index_hit = False
1288
1398
                    for node in index.iter_entries_prefix(keys):
1289
1399
                        if node[1] in seen_keys:
1290
1400
                            continue
1291
1401
                        seen_keys.add(node[1])
1292
1402
                        yield node
1293
 
                return
 
1403
                        index_hit = True
 
1404
                    if index_hit:
 
1405
                        hit_indices.append(index)
 
1406
                break
1294
1407
            except errors.NoSuchFile:
1295
1408
                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
1296
1540
 
1297
1541
    def key_count(self):
1298
1542
        """Return an estimate of the number of keys in this index.
1327
1571
                         ' Raising original exception.')
1328
1572
            raise exc_type, exc_value, exc_traceback
1329
1573
 
 
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
 
1330
1579
    def validate(self):
1331
1580
        """Validate that everything in the index can be accessed."""
1332
1581
        while True:
1385
1634
            defined order for the result iteration - it will be in the most
1386
1635
            efficient order for the index (keys iteration order in this case).
1387
1636
        """
1388
 
        keys = set(keys)
 
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]
1389
1641
        if self.reference_lists:
1390
 
            for key in keys.intersection(self._keys):
1391
 
                node = self._nodes[key]
 
1642
            for key in keys:
 
1643
                node = nodes[key]
1392
1644
                if not node[0]:
1393
1645
                    yield self, key, node[2], node[1]
1394
1646
        else:
1395
 
            for key in keys.intersection(self._keys):
1396
 
                node = self._nodes[key]
 
1647
            for key in keys:
 
1648
                node = nodes[key]
1397
1649
                if not node[0]:
1398
1650
                    yield self, key, node[2]
1399
1651
 
1428
1680
                    raise errors.BadIndexKey(key)
1429
1681
                node = self._nodes[key]
1430
1682
                if node[0]:
1431
 
                    continue 
 
1683
                    continue
1432
1684
                if self.reference_lists:
1433
1685
                    yield self, key, node[2], node[1]
1434
1686
                else:
1459
1711
                    # can't be empty or would not exist
1460
1712
                    item, value = key_dict.iteritems().next()
1461
1713
                    if type(value) == dict:
1462
 
                        # push keys 
 
1714
                        # push keys
1463
1715
                        dicts.extend(key_dict.itervalues())
1464
1716
                    else:
1465
1717
                        # yield keys
1470
1722
 
1471
1723
    def key_count(self):
1472
1724
        """Return an estimate of the number of keys in this index.
1473
 
        
 
1725
 
1474
1726
        For InMemoryGraphIndex the estimate is exact.
1475
1727
        """
1476
 
        return len(self._keys)
 
1728
        return len(self._nodes) - len(self._absent_keys)
1477
1729
 
1478
1730
    def validate(self):
1479
1731
        """In memory index's have no known corruption at the moment."""
1484
1736
 
1485
1737
    Queries against this will emit queries against the adapted Graph with the
1486
1738
    prefix added, queries for all items use iter_entries_prefix. The returned
1487
 
    nodes will have their keys and node references adjusted to remove the 
 
1739
    nodes will have their keys and node references adjusted to remove the
1488
1740
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1489
1741
    nodes and references being added will have prefix prepended.
1490
1742
    """
1517
1769
                    adjusted_references))
1518
1770
        except ValueError:
1519
1771
            # XXX: TODO add an explicit interface for getting the reference list
1520
 
            # status, to handle this bit of user-friendliness in the API more 
 
1772
            # status, to handle this bit of user-friendliness in the API more
1521
1773
            # explicitly.
1522
1774
            for (key, value) in nodes:
1523
1775
                translated_nodes.append((self.prefix + key, value))
1595
1847
 
1596
1848
    def key_count(self):
1597
1849
        """Return an estimate of the number of keys in this index.
1598
 
        
 
1850
 
1599
1851
        For GraphIndexPrefixAdapter this is relatively expensive - key
1600
1852
        iteration with the prefix is done.
1601
1853
        """