← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Aaron Bentley
  • Date: 2008-11-15 19:41:37 UTC
  • mto: This revision was merged to the branch mainline in revision 3841.
  • Revision ID: aaron@aaronbentley.com-20081115194137-wghezl9da7aluk3p
Add tests for plugins

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 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="
53
53
_newline_null_re = re.compile('[\n\0]')
54
54
 
55
55
 
56
 
def _has_key_from_parent_map(self, key):
57
 
    """Check if this index has one key.
58
 
 
59
 
    If it's possible to check for multiple keys at once through
60
 
    calling get_parent_map that should be faster.
61
 
    """
62
 
    return (key in self.get_parent_map([key]))
63
 
 
64
 
 
65
 
def _missing_keys_from_parent_map(self, keys):
66
 
    return set(keys) - set(self.get_parent_map(keys))
67
 
 
68
 
 
69
56
class GraphIndexBuilder(object):
70
57
    """A builder that can build a GraphIndex.
71
 
 
 
58
    
72
59
    The resulting graph has the structure:
73
 
 
 
60
    
74
61
    _SIGNATURE OPTIONS NODES NEWLINE
75
62
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
76
63
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
93
80
        :param key_elements: The number of bytestrings in each key.
94
81
        """
95
82
        self.reference_lists = reference_lists
 
83
        self._keys = set()
96
84
        # A dict of {key: (absent, ref_lists, value)}
97
85
        self._nodes = {}
98
 
        # Keys that are referenced but not actually present in this index
99
 
        self._absent_keys = set()
100
86
        self._nodes_by_key = None
101
87
        self._key_length = key_elements
102
88
        self._optimize_for_size = False
103
 
        self._combine_backing_indices = True
104
89
 
105
90
    def _check_key(self, key):
106
91
        """Raise BadIndexKey if key is not a valid key for this index."""
107
 
        if type(key) not in (tuple, StaticTuple):
 
92
        if type(key) != tuple:
108
93
            raise errors.BadIndexKey(key)
109
94
        if self._key_length != len(key):
110
95
            raise errors.BadIndexKey(key)
112
97
            if not element or _whitespace_re.search(element) is not None:
113
98
                raise errors.BadIndexKey(element)
114
99
 
115
 
    def _external_references(self):
116
 
        """Return references that are not present in this index.
117
 
        """
118
 
        keys = set()
119
 
        refs = set()
120
 
        # TODO: JAM 2008-11-21 This makes an assumption about how the reference
121
 
        #       lists are used. It is currently correct for pack-0.92 through
122
 
        #       1.9, which use the node references (3rd column) second
123
 
        #       reference list as the compression parent. Perhaps this should
124
 
        #       be moved into something higher up the stack, since it
125
 
        #       makes assumptions about how the index is used.
126
 
        if self.reference_lists > 1:
127
 
            for node in self.iter_all_entries():
128
 
                keys.add(node[1])
129
 
                refs.update(node[3][1])
130
 
            return refs - keys
131
 
        else:
132
 
            # If reference_lists == 0 there can be no external references, and
133
 
            # if reference_lists == 1, then there isn't a place to store the
134
 
            # compression parent
135
 
            return set()
136
 
 
137
100
    def _get_nodes_by_key(self):
138
101
        if self._nodes_by_key is None:
139
102
            nodes_by_key = {}
166
129
            return
167
130
        key_dict = self._nodes_by_key
168
131
        if self.reference_lists:
169
 
            key_value = StaticTuple(key, value, node_refs)
 
132
            key_value = key, value, node_refs
170
133
        else:
171
 
            key_value = StaticTuple(key, value)
 
134
            key_value = key, value
172
135
        for subkey in key[:-1]:
173
136
            key_dict = key_dict.setdefault(subkey, {})
174
137
        key_dict[key[-1]] = key_value
190
153
                                This may contain duplicates if the same key is
191
154
                                referenced in multiple lists.
192
155
        """
193
 
        as_st = StaticTuple.from_sequence
194
156
        self._check_key(key)
195
157
        if _newline_null_re.search(value) is not None:
196
158
            raise errors.BadIndexValue(value)
205
167
                if reference not in self._nodes:
206
168
                    self._check_key(reference)
207
169
                    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
 
170
            node_refs.append(tuple(reference_list))
 
171
        return tuple(node_refs), absent_references
212
172
 
213
173
    def add_node(self, key, value, references=()):
214
174
        """Add a node to the index.
229
189
            # There may be duplicates, but I don't think it is worth worrying
230
190
            # about
231
191
            self._nodes[reference] = ('a', (), '')
232
 
        self._absent_keys.update(absent_references)
233
 
        self._absent_keys.discard(key)
234
192
        self._nodes[key] = ('', node_refs, value)
 
193
        self._keys.add(key)
235
194
        if self._nodes_by_key is not None and self._key_length > 1:
236
195
            self._update_nodes_by_key(key, value, node_refs)
237
196
 
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
197
    def finish(self):
246
198
        lines = [_SIGNATURE]
247
199
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
248
200
        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')
 
201
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
251
202
        prefix_length = sum(len(x) for x in lines)
252
203
        # references are byte offsets. To avoid having to do nasty
253
204
        # polynomial work to resolve offsets (references to later in the
260
211
        # one to pad all the data with reference-length and determine entry
261
212
        # addresses.
262
213
        # One to serialise.
263
 
 
 
214
        
264
215
        # forward sorted by key. In future we may consider topological sorting,
265
216
        # at the cost of table scans for direct lookup, or a second index for
266
217
        # direct lookup
329
280
                (len(result.getvalue()), expected_bytes))
330
281
        return result
331
282
 
332
 
    def set_optimize(self, for_size=None, combine_backing_indices=None):
 
283
    def set_optimize(self, for_size=True):
333
284
        """Change how the builder tries to optimize the result.
334
285
 
335
286
        :param for_size: Tell the builder to try and make the index as small as
336
287
            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
288
        :return: None
342
289
        """
343
290
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
344
291
        # 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
 
292
        self._optimize_for_size = for_size
365
293
 
366
294
 
367
295
class GraphIndex(object):
368
296
    """An index for data with embedded graphs.
369
 
 
 
297
 
370
298
    The index maps keys to a list of key reference lists, and a value.
371
299
    Each node has the same number of key reference lists. Each key reference
372
300
    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
 
301
    terminated string without any newlines. The storage of the index is 
374
302
    hidden in the interface: keys and key references are always tuples of
375
303
    bytestrings, never the internal representation (e.g. dictionary offsets).
376
304
 
382
310
    suitable for production use. :XXX
383
311
    """
384
312
 
385
 
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
 
313
    def __init__(self, transport, name, size):
386
314
        """Open an index called name on transport.
387
315
 
388
316
        :param transport: A bzrlib.transport.Transport.
394
322
            avoided by having it supplied. If size is None, then bisection
395
323
            support will be disabled and accessing the index will just stream
396
324
            all the data.
397
 
        :param offset: Instead of starting the index data at offset 0, start it
398
 
            at an arbitrary offset.
399
325
        """
400
326
        self._transport = transport
401
327
        self._name = name
418
344
        self._size = size
419
345
        # The number of bytes we've read so far in trying to process this file
420
346
        self._bytes_read = 0
421
 
        self._base_offset = offset
422
347
 
423
348
    def __eq__(self, other):
424
349
        """Equal when self and other were created with the same parameters."""
447
372
            mutter('Reading entire index %s', self._transport.abspath(self._name))
448
373
        if stream is None:
449
374
            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
375
        self._read_prefix(stream)
455
376
        self._expected_elements = 3 + self._key_length
456
377
        line_count = 0
462
383
        trailers = 0
463
384
        pos = stream.tell()
464
385
        lines = stream.read().split('\n')
465
 
        stream.close()
466
386
        del lines[-1]
467
387
        _, _, _, trailers = self._parse_lines(lines, pos)
468
388
        for key, absent, references, value in self._keys_by_offset.itervalues():
475
395
                node_value = value
476
396
            self._nodes[key] = node_value
477
397
        # cache the keys for quick set intersections
 
398
        self._keys = set(self._nodes)
478
399
        if trailers != 1:
479
400
            # there must be one line - the empty trailer line.
480
401
            raise errors.BadIndexData(self)
481
402
 
482
 
    def clear_cache(self):
483
 
        """Clear out any cached/memoized values.
484
 
 
485
 
        This can be called at any time, but generally it is used when we have
486
 
        extracted some information, but don't expect to be requesting any more
487
 
        from this index.
488
 
        """
489
 
 
490
 
    def external_references(self, ref_list_num):
491
 
        """Return references that are not present in this index.
492
 
        """
493
 
        self._buffer_all()
494
 
        if ref_list_num + 1 > self.node_ref_lists:
495
 
            raise ValueError('No ref list %d, index has %d ref lists'
496
 
                % (ref_list_num, self.node_ref_lists))
497
 
        refs = set()
498
 
        nodes = self._nodes
499
 
        for key, (value, ref_lists) in nodes.iteritems():
500
 
            ref_list = ref_lists[ref_list_num]
501
 
            refs.update([ref for ref in ref_list if ref not in nodes])
502
 
        return refs
503
 
 
504
403
    def _get_nodes_by_key(self):
505
404
        if self._nodes_by_key is None:
506
405
            nodes_by_key = {}
568
467
 
569
468
    def _resolve_references(self, references):
570
469
        """Return the resolved key references for references.
571
 
 
 
470
        
572
471
        References are resolved by looking up the location of the key in the
573
472
        _keys_by_offset map and substituting the key name, preserving ordering.
574
473
 
575
 
        :param references: An iterable of iterables of key locations. e.g.
 
474
        :param references: An iterable of iterables of key locations. e.g. 
576
475
            [[123, 456], [123]]
577
476
        :return: A tuple of tuples of keys.
578
477
        """
632
531
 
633
532
    def _iter_entries_from_total_buffer(self, keys):
634
533
        """Iterate over keys when the entire index is parsed."""
635
 
        # Note: See the note in BTreeBuilder.iter_entries for why we don't use
636
 
        #       .intersection() here
637
 
        nodes = self._nodes
638
 
        keys = [key for key in keys if key in nodes]
 
534
        keys = keys.intersection(self._keys)
639
535
        if self.node_ref_lists:
640
536
            for key in keys:
641
 
                value, node_refs = nodes[key]
 
537
                value, node_refs = self._nodes[key]
642
538
                yield self, key, value, node_refs
643
539
        else:
644
540
            for key in keys:
645
 
                yield self, key, nodes[key]
 
541
                yield self, key, self._nodes[key]
646
542
 
647
543
    def iter_entries(self, keys):
648
544
        """Iterate over keys within the index.
739
635
                    # can't be empty or would not exist
740
636
                    item, value = key_dict.iteritems().next()
741
637
                    if type(value) == dict:
742
 
                        # push keys
 
638
                        # push keys 
743
639
                        dicts.extend(key_dict.itervalues())
744
640
                    else:
745
641
                        # yield keys
751
647
                # the last thing looked up was a terminal element
752
648
                yield (self, ) + key_dict
753
649
 
754
 
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
755
 
        """See BTreeIndex._find_ancestors."""
756
 
        # The api can be implemented as a trivial overlay on top of
757
 
        # iter_entries, it is not an efficient implementation, but it at least
758
 
        # gets the job done.
759
 
        found_keys = set()
760
 
        search_keys = set()
761
 
        for index, key, value, refs in self.iter_entries(keys):
762
 
            parent_keys = refs[ref_list_num]
763
 
            found_keys.add(key)
764
 
            parent_map[key] = parent_keys
765
 
            search_keys.update(parent_keys)
766
 
        # Figure out what, if anything, was missing
767
 
        missing_keys.update(set(keys).difference(found_keys))
768
 
        search_keys = search_keys.difference(parent_map)
769
 
        return search_keys
770
 
 
771
650
    def key_count(self):
772
651
        """Return an estimate of the number of keys in this index.
773
 
 
 
652
        
774
653
        For GraphIndex the estimate is exact.
775
654
        """
776
655
        if self._key_count is None:
792
671
        # Possible improvements:
793
672
        #  - only bisect lookup each key once
794
673
        #  - sort the keys first, and use that to reduce the bisection window
795
 
        # -----
 
674
        # ----- 
796
675
        # this progresses in three parts:
797
676
        # read data
798
677
        # parse it
807
686
                # We have the key parsed.
808
687
                continue
809
688
            index = self._parsed_key_index(key)
810
 
            if (len(self._parsed_key_map) and
 
689
            if (len(self._parsed_key_map) and 
811
690
                self._parsed_key_map[index][0] <= key and
812
691
                (self._parsed_key_map[index][1] >= key or
813
692
                 # end of the file has been parsed
817
696
                continue
818
697
            # - if we have examined this part of the file already - yes
819
698
            index = self._parsed_byte_index(location)
820
 
            if (len(self._parsed_byte_map) and
 
699
            if (len(self._parsed_byte_map) and 
821
700
                self._parsed_byte_map[index][0] <= location and
822
701
                self._parsed_byte_map[index][1] > location):
823
702
                # the byte region has been parsed, so no read is needed.
1078
957
        # adjust offset and data to the parseable data.
1079
958
        trimmed_data = data[trim_start:trim_end]
1080
959
        if not (trimmed_data):
1081
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
 
960
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
1082
961
                % (trim_start, trim_end, offset, offset + len(data)))
1083
962
        if trim_start:
1084
963
            offset += trim_start
1185
1064
            self._parsed_key_map.insert(index + 1, new_key)
1186
1065
 
1187
1066
    def _read_and_parse(self, readv_ranges):
1188
 
        """Read the ranges and parse the resulting data.
 
1067
        """Read the the ranges and parse the resulting data.
1189
1068
 
1190
1069
        :param readv_ranges: A prepared readv range list.
1191
1070
        """
1197
1076
            self._buffer_all()
1198
1077
            return
1199
1078
 
1200
 
        base_offset = self._base_offset
1201
 
        if base_offset != 0:
1202
 
            # Rewrite the ranges for the offset
1203
 
            readv_ranges = [(start+base_offset, size)
1204
 
                            for start, size in readv_ranges]
1205
1079
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1206
 
            self._size + self._base_offset)
 
1080
            self._size)
1207
1081
        # parse
1208
1082
        for offset, data in readv_data:
1209
 
            offset -= base_offset
1210
1083
            self._bytes_read += len(data)
1211
 
            if offset < 0:
1212
 
                # transport.readv() expanded to extra data which isn't part of
1213
 
                # this index
1214
 
                data = data[-offset:]
1215
 
                offset = 0
1216
1084
            if offset == 0 and len(data) == self._size:
1217
1085
                # We read the whole range, most likely because the
1218
1086
                # Transport upcast our readv ranges into one long request
1240
1108
 
1241
1109
class CombinedGraphIndex(object):
1242
1110
    """A GraphIndex made up from smaller GraphIndices.
1243
 
 
 
1111
    
1244
1112
    The backing indices must implement GraphIndex, and are presumed to be
1245
1113
    static data.
1246
1114
 
1247
1115
    Queries against the combined index will be made against the first index,
1248
 
    and then the second and so on. The order of indices can thus influence
 
1116
    and then the second and so on. The order of index's can thus influence
1249
1117
    performance significantly. For example, if one index is on local disk and a
1250
1118
    second on a remote server, the local disk index should be before the other
1251
1119
    in the index list.
1252
 
    
1253
 
    Also, queries tend to need results from the same indices as previous
1254
 
    queries.  So the indices will be reordered after every query to put the
1255
 
    indices that had the result(s) of that query first (while otherwise
1256
 
    preserving the relative ordering).
1257
1120
    """
1258
1121
 
1259
1122
    def __init__(self, indices, reload_func=None):
1266
1129
        """
1267
1130
        self._indices = indices
1268
1131
        self._reload_func = reload_func
1269
 
        # Sibling indices are other CombinedGraphIndex that we should call
1270
 
        # _move_to_front_by_name on when we auto-reorder ourself.
1271
 
        self._sibling_indices = []
1272
 
        # A list of names that corresponds to the instances in self._indices,
1273
 
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
1274
 
        # indices must all use the same set of names as each other.
1275
 
        self._index_names = [None] * len(self._indices)
1276
1132
 
1277
1133
    def __repr__(self):
1278
1134
        return "%s(%s)" % (
1279
1135
                self.__class__.__name__,
1280
1136
                ', '.join(map(repr, self._indices)))
1281
1137
 
1282
 
    def clear_cache(self):
1283
 
        """See GraphIndex.clear_cache()"""
1284
 
        for index in self._indices:
1285
 
            index.clear_cache()
 
1138
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
1139
    def get_parents(self, revision_ids):
 
1140
        """See graph._StackedParentsProvider.get_parents.
 
1141
        
 
1142
        This implementation thunks the graph.Graph.get_parents api across to
 
1143
        GraphIndex.
 
1144
 
 
1145
        :param revision_ids: An iterable of graph keys for this graph.
 
1146
        :return: A list of parent details for each key in revision_ids.
 
1147
            Each parent details will be one of:
 
1148
             * None when the key was missing
 
1149
             * (NULL_REVISION,) when the key has no parents.
 
1150
             * (parent_key, parent_key...) otherwise.
 
1151
        """
 
1152
        parent_map = self.get_parent_map(revision_ids)
 
1153
        return [parent_map.get(r, None) for r in revision_ids]
1286
1154
 
1287
1155
    def get_parent_map(self, keys):
1288
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
1156
        """See graph._StackedParentsProvider.get_parent_map"""
1289
1157
        search_keys = set(keys)
1290
1158
        if NULL_REVISION in search_keys:
1291
1159
            search_keys.discard(NULL_REVISION)
1299
1167
            found_parents[key] = parents
1300
1168
        return found_parents
1301
1169
 
1302
 
    has_key = _has_key_from_parent_map
1303
 
 
1304
 
    def insert_index(self, pos, index, name=None):
 
1170
    def insert_index(self, pos, index):
1305
1171
        """Insert a new index in the list of indices to query.
1306
1172
 
1307
1173
        :param pos: The position to insert the index.
1308
1174
        :param index: The index to insert.
1309
 
        :param name: a name for this index, e.g. a pack name.  These names can
1310
 
            be used to reflect index reorderings to related CombinedGraphIndex
1311
 
            instances that use the same names.  (see set_sibling_indices)
1312
1175
        """
1313
1176
        self._indices.insert(pos, index)
1314
 
        self._index_names.insert(pos, name)
1315
1177
 
1316
1178
    def iter_all_entries(self):
1317
1179
        """Iterate over all keys within the index
1342
1204
        value and are only reported once.
1343
1205
 
1344
1206
        :param keys: An iterable providing the keys to be retrieved.
1345
 
        :return: An iterable of (index, key, reference_lists, value). There is
1346
 
            no defined order for the result iteration - it will be in the most
 
1207
        :return: An iterable of (index, key, reference_lists, value). There is no
 
1208
            defined order for the result iteration - it will be in the most
1347
1209
            efficient order for the index.
1348
1210
        """
1349
1211
        keys = set(keys)
1350
 
        hit_indices = []
1351
1212
        while True:
1352
1213
            try:
1353
1214
                for index in self._indices:
1354
1215
                    if not keys:
1355
 
                        break
1356
 
                    index_hit = False
 
1216
                        return
1357
1217
                    for node in index.iter_entries(keys):
1358
1218
                        keys.remove(node[1])
1359
1219
                        yield node
1360
 
                        index_hit = True
1361
 
                    if index_hit:
1362
 
                        hit_indices.append(index)
1363
 
                break
 
1220
                return
1364
1221
            except errors.NoSuchFile:
1365
1222
                self._reload_or_raise()
1366
 
        self._move_to_front(hit_indices)
1367
1223
 
1368
1224
    def iter_entries_prefix(self, keys):
1369
1225
        """Iterate over keys within the index using prefix matching.
1389
1245
        if not keys:
1390
1246
            return
1391
1247
        seen_keys = set()
1392
 
        hit_indices = []
1393
1248
        while True:
1394
1249
            try:
1395
1250
                for index in self._indices:
1396
 
                    index_hit = False
1397
1251
                    for node in index.iter_entries_prefix(keys):
1398
1252
                        if node[1] in seen_keys:
1399
1253
                            continue
1400
1254
                        seen_keys.add(node[1])
1401
1255
                        yield node
1402
 
                        index_hit = True
1403
 
                    if index_hit:
1404
 
                        hit_indices.append(index)
1405
 
                break
 
1256
                return
1406
1257
            except errors.NoSuchFile:
1407
1258
                self._reload_or_raise()
1408
 
        self._move_to_front(hit_indices)
1409
 
 
1410
 
    def _move_to_front(self, hit_indices):
1411
 
        """Rearrange self._indices so that hit_indices are first.
1412
 
 
1413
 
        Order is maintained as much as possible, e.g. the first unhit index
1414
 
        will be the first index in _indices after the hit_indices, and the
1415
 
        hit_indices will be present in exactly the order they are passed to
1416
 
        _move_to_front.
1417
 
 
1418
 
        _move_to_front propagates to all objects in self._sibling_indices by
1419
 
        calling _move_to_front_by_name.
1420
 
        """
1421
 
        if self._indices[:len(hit_indices)] == hit_indices:
1422
 
            # The 'hit_indices' are already at the front (and in the same
1423
 
            # order), no need to re-order
1424
 
            return
1425
 
        hit_names = self._move_to_front_by_index(hit_indices)
1426
 
        for sibling_idx in self._sibling_indices:
1427
 
            sibling_idx._move_to_front_by_name(hit_names)
1428
 
 
1429
 
    def _move_to_front_by_index(self, hit_indices):
1430
 
        """Core logic for _move_to_front.
1431
 
        
1432
 
        Returns a list of names corresponding to the hit_indices param.
1433
 
        """
1434
 
        indices_info = zip(self._index_names, self._indices)
1435
 
        if 'index' in debug.debug_flags:
1436
 
            mutter('CombinedGraphIndex reordering: currently %r, promoting %r',
1437
 
                   indices_info, hit_indices)
1438
 
        hit_names = []
1439
 
        unhit_names = []
1440
 
        new_hit_indices = []
1441
 
        unhit_indices = []
1442
 
 
1443
 
        for offset, (name, idx) in enumerate(indices_info):
1444
 
            if idx in hit_indices:
1445
 
                hit_names.append(name)
1446
 
                new_hit_indices.append(idx)
1447
 
                if len(new_hit_indices) == len(hit_indices):
1448
 
                    # We've found all of the hit entries, everything else is
1449
 
                    # unhit
1450
 
                    unhit_names.extend(self._index_names[offset+1:])
1451
 
                    unhit_indices.extend(self._indices[offset+1:])
1452
 
                    break
1453
 
            else:
1454
 
                unhit_names.append(name)
1455
 
                unhit_indices.append(idx)
1456
 
 
1457
 
        self._indices = new_hit_indices + unhit_indices
1458
 
        self._index_names = hit_names + unhit_names
1459
 
        if 'index' in debug.debug_flags:
1460
 
            mutter('CombinedGraphIndex reordered: %r', self._indices)
1461
 
        return hit_names
1462
 
 
1463
 
    def _move_to_front_by_name(self, hit_names):
1464
 
        """Moves indices named by 'hit_names' to front of the search order, as
1465
 
        described in _move_to_front.
1466
 
        """
1467
 
        # Translate names to index instances, and then call
1468
 
        # _move_to_front_by_index.
1469
 
        indices_info = zip(self._index_names, self._indices)
1470
 
        hit_indices = []
1471
 
        for name, idx in indices_info:
1472
 
            if name in hit_names:
1473
 
                hit_indices.append(idx)
1474
 
        self._move_to_front_by_index(hit_indices)
1475
 
 
1476
 
    def find_ancestry(self, keys, ref_list_num):
1477
 
        """Find the complete ancestry for the given set of keys.
1478
 
 
1479
 
        Note that this is a whole-ancestry request, so it should be used
1480
 
        sparingly.
1481
 
 
1482
 
        :param keys: An iterable of keys to look for
1483
 
        :param ref_list_num: The reference list which references the parents
1484
 
            we care about.
1485
 
        :return: (parent_map, missing_keys)
1486
 
        """
1487
 
        # XXX: make this call _move_to_front?
1488
 
        missing_keys = set()
1489
 
        parent_map = {}
1490
 
        keys_to_lookup = set(keys)
1491
 
        generation = 0
1492
 
        while keys_to_lookup:
1493
 
            # keys that *all* indexes claim are missing, stop searching them
1494
 
            generation += 1
1495
 
            all_index_missing = None
1496
 
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
1497
 
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
1498
 
            #                                   len(parent_map),
1499
 
            #                                   len(missing_keys))
1500
 
            for index_idx, index in enumerate(self._indices):
1501
 
                # TODO: we should probably be doing something with
1502
 
                #       'missing_keys' since we've already determined that
1503
 
                #       those revisions have not been found anywhere
1504
 
                index_missing_keys = set()
1505
 
                # Find all of the ancestry we can from this index
1506
 
                # keep looking until the search_keys set is empty, which means
1507
 
                # things we didn't find should be in index_missing_keys
1508
 
                search_keys = keys_to_lookup
1509
 
                sub_generation = 0
1510
 
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
1511
 
                #     index_idx, len(search_keys),
1512
 
                #     len(parent_map), len(index_missing_keys))
1513
 
                while search_keys:
1514
 
                    sub_generation += 1
1515
 
                    # TODO: ref_list_num should really be a parameter, since
1516
 
                    #       CombinedGraphIndex does not know what the ref lists
1517
 
                    #       mean.
1518
 
                    search_keys = index._find_ancestors(search_keys,
1519
 
                        ref_list_num, parent_map, index_missing_keys)
1520
 
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
1521
 
                    #     sub_generation, len(search_keys),
1522
 
                    #     len(parent_map), len(index_missing_keys))
1523
 
                # Now set whatever was missing to be searched in the next index
1524
 
                keys_to_lookup = index_missing_keys
1525
 
                if all_index_missing is None:
1526
 
                    all_index_missing = set(index_missing_keys)
1527
 
                else:
1528
 
                    all_index_missing.intersection_update(index_missing_keys)
1529
 
                if not keys_to_lookup:
1530
 
                    break
1531
 
            if all_index_missing is None:
1532
 
                # There were no indexes, so all search keys are 'missing'
1533
 
                missing_keys.update(keys_to_lookup)
1534
 
                keys_to_lookup = None
1535
 
            else:
1536
 
                missing_keys.update(all_index_missing)
1537
 
                keys_to_lookup.difference_update(all_index_missing)
1538
 
        return parent_map, missing_keys
1539
1259
 
1540
1260
    def key_count(self):
1541
1261
        """Return an estimate of the number of keys in this index.
1551
1271
            except errors.NoSuchFile:
1552
1272
                self._reload_or_raise()
1553
1273
 
1554
 
    missing_keys = _missing_keys_from_parent_map
1555
 
 
1556
1274
    def _reload_or_raise(self):
1557
1275
        """We just got a NoSuchFile exception.
1558
1276
 
1570
1288
                         ' Raising original exception.')
1571
1289
            raise exc_type, exc_value, exc_traceback
1572
1290
 
1573
 
    def set_sibling_indices(self, sibling_combined_graph_indices):
1574
 
        """Set the CombinedGraphIndex objects to reorder after reordering self.
1575
 
        """
1576
 
        self._sibling_indices = sibling_combined_graph_indices
1577
 
 
1578
1291
    def validate(self):
1579
1292
        """Validate that everything in the index can be accessed."""
1580
1293
        while True:
1633
1346
            defined order for the result iteration - it will be in the most
1634
1347
            efficient order for the index (keys iteration order in this case).
1635
1348
        """
1636
 
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
1637
 
        #       aren't using set().intersection() here
1638
 
        nodes = self._nodes
1639
 
        keys = [key for key in keys if key in nodes]
 
1349
        keys = set(keys)
1640
1350
        if self.reference_lists:
1641
 
            for key in keys:
1642
 
                node = nodes[key]
 
1351
            for key in keys.intersection(self._keys):
 
1352
                node = self._nodes[key]
1643
1353
                if not node[0]:
1644
1354
                    yield self, key, node[2], node[1]
1645
1355
        else:
1646
 
            for key in keys:
1647
 
                node = nodes[key]
 
1356
            for key in keys.intersection(self._keys):
 
1357
                node = self._nodes[key]
1648
1358
                if not node[0]:
1649
1359
                    yield self, key, node[2]
1650
1360
 
1679
1389
                    raise errors.BadIndexKey(key)
1680
1390
                node = self._nodes[key]
1681
1391
                if node[0]:
1682
 
                    continue
 
1392
                    continue 
1683
1393
                if self.reference_lists:
1684
1394
                    yield self, key, node[2], node[1]
1685
1395
                else:
1710
1420
                    # can't be empty or would not exist
1711
1421
                    item, value = key_dict.iteritems().next()
1712
1422
                    if type(value) == dict:
1713
 
                        # push keys
 
1423
                        # push keys 
1714
1424
                        dicts.extend(key_dict.itervalues())
1715
1425
                    else:
1716
1426
                        # yield keys
1721
1431
 
1722
1432
    def key_count(self):
1723
1433
        """Return an estimate of the number of keys in this index.
1724
 
 
 
1434
        
1725
1435
        For InMemoryGraphIndex the estimate is exact.
1726
1436
        """
1727
 
        return len(self._nodes) - len(self._absent_keys)
 
1437
        return len(self._keys)
1728
1438
 
1729
1439
    def validate(self):
1730
1440
        """In memory index's have no known corruption at the moment."""
1735
1445
 
1736
1446
    Queries against this will emit queries against the adapted Graph with the
1737
1447
    prefix added, queries for all items use iter_entries_prefix. The returned
1738
 
    nodes will have their keys and node references adjusted to remove the
 
1448
    nodes will have their keys and node references adjusted to remove the 
1739
1449
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1740
1450
    nodes and references being added will have prefix prepended.
1741
1451
    """
1768
1478
                    adjusted_references))
1769
1479
        except ValueError:
1770
1480
            # XXX: TODO add an explicit interface for getting the reference list
1771
 
            # status, to handle this bit of user-friendliness in the API more
 
1481
            # status, to handle this bit of user-friendliness in the API more 
1772
1482
            # explicitly.
1773
1483
            for (key, value) in nodes:
1774
1484
                translated_nodes.append((self.prefix + key, value))
1846
1556
 
1847
1557
    def key_count(self):
1848
1558
        """Return an estimate of the number of keys in this index.
1849
 
 
 
1559
        
1850
1560
        For GraphIndexPrefixAdapter this is relatively expensive - key
1851
1561
        iteration with the prefix is done.
1852
1562
        """