/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Andrew Bennetts
  • Date: 2010-04-13 04:33:55 UTC
  • mfrom: (5147 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5149.
  • Revision ID: andrew.bennetts@canonical.com-20100413043355-lg3id0uwtju0k3zs
Merge lp:bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
1
 
# Copyright (C) 2007 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
 
27
27
from bisect import bisect_right
28
28
from cStringIO import StringIO
29
29
import re
 
30
import sys
30
31
 
31
32
from bzrlib.lazy_import import lazy_import
32
33
lazy_import(globals(), """
38
39
from bzrlib import (
39
40
    debug,
40
41
    errors,
41
 
    symbol_versioning,
42
42
    )
 
43
from bzrlib.static_tuple import StaticTuple
43
44
 
44
45
_HEADER_READV = (0, 200)
45
46
_OPTION_KEY_ELEMENTS = "key_elements="
52
53
_newline_null_re = re.compile('[\n\0]')
53
54
 
54
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
 
55
69
class GraphIndexBuilder(object):
56
70
    """A builder that can build a GraphIndex.
57
 
    
 
71
 
58
72
    The resulting graph has the structure:
59
 
    
 
73
 
60
74
    _SIGNATURE OPTIONS NODES NEWLINE
61
75
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
62
76
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
79
93
        :param key_elements: The number of bytestrings in each key.
80
94
        """
81
95
        self.reference_lists = reference_lists
82
 
        self._keys = set()
83
96
        # A dict of {key: (absent, ref_lists, value)}
84
97
        self._nodes = {}
 
98
        # Keys that are referenced but not actually present in this index
 
99
        self._absent_keys = set()
85
100
        self._nodes_by_key = None
86
101
        self._key_length = key_elements
 
102
        self._optimize_for_size = False
 
103
        self._combine_backing_indices = True
87
104
 
88
105
    def _check_key(self, key):
89
106
        """Raise BadIndexKey if key is not a valid key for this index."""
90
 
        if type(key) != tuple:
 
107
        if type(key) not in (tuple, StaticTuple):
91
108
            raise errors.BadIndexKey(key)
92
109
        if self._key_length != len(key):
93
110
            raise errors.BadIndexKey(key)
95
112
            if not element or _whitespace_re.search(element) is not None:
96
113
                raise errors.BadIndexKey(element)
97
114
 
 
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
 
98
137
    def _get_nodes_by_key(self):
99
138
        if self._nodes_by_key is None:
100
139
            nodes_by_key = {}
127
166
            return
128
167
        key_dict = self._nodes_by_key
129
168
        if self.reference_lists:
130
 
            key_value = key, value, node_refs
 
169
            key_value = StaticTuple(key, value, node_refs)
131
170
        else:
132
 
            key_value = key, value
 
171
            key_value = StaticTuple(key, value)
133
172
        for subkey in key[:-1]:
134
173
            key_dict = key_dict.setdefault(subkey, {})
135
174
        key_dict[key[-1]] = key_value
151
190
                                This may contain duplicates if the same key is
152
191
                                referenced in multiple lists.
153
192
        """
 
193
        as_st = StaticTuple.from_sequence
154
194
        self._check_key(key)
155
195
        if _newline_null_re.search(value) is not None:
156
196
            raise errors.BadIndexValue(value)
165
205
                if reference not in self._nodes:
166
206
                    self._check_key(reference)
167
207
                    absent_references.append(reference)
168
 
            node_refs.append(tuple(reference_list))
169
 
        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
170
212
 
171
213
    def add_node(self, key, value, references=()):
172
214
        """Add a node to the index.
187
229
            # There may be duplicates, but I don't think it is worth worrying
188
230
            # about
189
231
            self._nodes[reference] = ('a', (), '')
 
232
        self._absent_keys.update(absent_references)
 
233
        self._absent_keys.discard(key)
190
234
        self._nodes[key] = ('', node_refs, value)
191
 
        self._keys.add(key)
192
235
        if self._nodes_by_key is not None and self._key_length > 1:
193
236
            self._update_nodes_by_key(key, value, node_refs)
194
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
        
195
245
    def finish(self):
196
246
        lines = [_SIGNATURE]
197
247
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
198
248
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
199
 
        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')
200
251
        prefix_length = sum(len(x) for x in lines)
201
252
        # references are byte offsets. To avoid having to do nasty
202
253
        # polynomial work to resolve offsets (references to later in the
209
260
        # one to pad all the data with reference-length and determine entry
210
261
        # addresses.
211
262
        # One to serialise.
212
 
        
 
263
 
213
264
        # forward sorted by key. In future we may consider topological sorting,
214
265
        # at the cost of table scans for direct lookup, or a second index for
215
266
        # direct lookup
278
329
                (len(result.getvalue()), expected_bytes))
279
330
        return result
280
331
 
 
332
    def set_optimize(self, for_size=None, combine_backing_indices=None):
 
333
        """Change how the builder tries to optimize the result.
 
334
 
 
335
        :param for_size: Tell the builder to try and make the index as small as
 
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.)
 
341
        :return: None
 
342
        """
 
343
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
 
344
        # 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
 
365
 
281
366
 
282
367
class GraphIndex(object):
283
368
    """An index for data with embedded graphs.
284
 
 
 
369
 
285
370
    The index maps keys to a list of key reference lists, and a value.
286
371
    Each node has the same number of key reference lists. Each key reference
287
372
    list can be empty or an arbitrary length. The value is an opaque NULL
288
 
    terminated string without any newlines. The storage of the index is 
 
373
    terminated string without any newlines. The storage of the index is
289
374
    hidden in the interface: keys and key references are always tuples of
290
375
    bytestrings, never the internal representation (e.g. dictionary offsets).
291
376
 
297
382
    suitable for production use. :XXX
298
383
    """
299
384
 
300
 
    def __init__(self, transport, name, size):
 
385
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
301
386
        """Open an index called name on transport.
302
387
 
303
388
        :param transport: A bzrlib.transport.Transport.
309
394
            avoided by having it supplied. If size is None, then bisection
310
395
            support will be disabled and accessing the index will just stream
311
396
            all the data.
 
397
        :param offset: Instead of starting the index data at offset 0, start it
 
398
            at an arbitrary offset.
312
399
        """
313
400
        self._transport = transport
314
401
        self._name = name
331
418
        self._size = size
332
419
        # The number of bytes we've read so far in trying to process this file
333
420
        self._bytes_read = 0
 
421
        self._base_offset = offset
334
422
 
335
423
    def __eq__(self, other):
336
424
        """Equal when self and other were created with the same parameters."""
359
447
            mutter('Reading entire index %s', self._transport.abspath(self._name))
360
448
        if stream is None:
361
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:])
362
454
        self._read_prefix(stream)
363
455
        self._expected_elements = 3 + self._key_length
364
456
        line_count = 0
370
462
        trailers = 0
371
463
        pos = stream.tell()
372
464
        lines = stream.read().split('\n')
 
465
        stream.close()
373
466
        del lines[-1]
374
467
        _, _, _, trailers = self._parse_lines(lines, pos)
375
468
        for key, absent, references, value in self._keys_by_offset.itervalues():
382
475
                node_value = value
383
476
            self._nodes[key] = node_value
384
477
        # cache the keys for quick set intersections
385
 
        self._keys = set(self._nodes)
386
478
        if trailers != 1:
387
479
            # there must be one line - the empty trailer line.
388
480
            raise errors.BadIndexData(self)
389
481
 
 
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
 
390
504
    def _get_nodes_by_key(self):
391
505
        if self._nodes_by_key is None:
392
506
            nodes_by_key = {}
454
568
 
455
569
    def _resolve_references(self, references):
456
570
        """Return the resolved key references for references.
457
 
        
 
571
 
458
572
        References are resolved by looking up the location of the key in the
459
573
        _keys_by_offset map and substituting the key name, preserving ordering.
460
574
 
461
 
        :param references: An iterable of iterables of key locations. e.g. 
 
575
        :param references: An iterable of iterables of key locations. e.g.
462
576
            [[123, 456], [123]]
463
577
        :return: A tuple of tuples of keys.
464
578
        """
518
632
 
519
633
    def _iter_entries_from_total_buffer(self, keys):
520
634
        """Iterate over keys when the entire index is parsed."""
521
 
        keys = keys.intersection(self._keys)
 
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]
522
639
        if self.node_ref_lists:
523
640
            for key in keys:
524
 
                value, node_refs = self._nodes[key]
 
641
                value, node_refs = nodes[key]
525
642
                yield self, key, value, node_refs
526
643
        else:
527
644
            for key in keys:
528
 
                yield self, key, self._nodes[key]
 
645
                yield self, key, nodes[key]
529
646
 
530
647
    def iter_entries(self, keys):
531
648
        """Iterate over keys within the index.
622
739
                    # can't be empty or would not exist
623
740
                    item, value = key_dict.iteritems().next()
624
741
                    if type(value) == dict:
625
 
                        # push keys 
 
742
                        # push keys
626
743
                        dicts.extend(key_dict.itervalues())
627
744
                    else:
628
745
                        # yield keys
634
751
                # the last thing looked up was a terminal element
635
752
                yield (self, ) + key_dict
636
753
 
 
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
 
637
771
    def key_count(self):
638
772
        """Return an estimate of the number of keys in this index.
639
 
        
 
773
 
640
774
        For GraphIndex the estimate is exact.
641
775
        """
642
776
        if self._key_count is None:
658
792
        # Possible improvements:
659
793
        #  - only bisect lookup each key once
660
794
        #  - sort the keys first, and use that to reduce the bisection window
661
 
        # ----- 
 
795
        # -----
662
796
        # this progresses in three parts:
663
797
        # read data
664
798
        # parse it
673
807
                # We have the key parsed.
674
808
                continue
675
809
            index = self._parsed_key_index(key)
676
 
            if (len(self._parsed_key_map) and 
 
810
            if (len(self._parsed_key_map) and
677
811
                self._parsed_key_map[index][0] <= key and
678
812
                (self._parsed_key_map[index][1] >= key or
679
813
                 # end of the file has been parsed
683
817
                continue
684
818
            # - if we have examined this part of the file already - yes
685
819
            index = self._parsed_byte_index(location)
686
 
            if (len(self._parsed_byte_map) and 
 
820
            if (len(self._parsed_byte_map) and
687
821
                self._parsed_byte_map[index][0] <= location and
688
822
                self._parsed_byte_map[index][1] > location):
689
823
                # the byte region has been parsed, so no read is needed.
944
1078
        # adjust offset and data to the parseable data.
945
1079
        trimmed_data = data[trim_start:trim_end]
946
1080
        if not (trimmed_data):
947
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
 
1081
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
948
1082
                % (trim_start, trim_end, offset, offset + len(data)))
949
1083
        if trim_start:
950
1084
            offset += trim_start
1051
1185
            self._parsed_key_map.insert(index + 1, new_key)
1052
1186
 
1053
1187
    def _read_and_parse(self, readv_ranges):
1054
 
        """Read the the ranges and parse the resulting data.
 
1188
        """Read the ranges and parse the resulting data.
1055
1189
 
1056
1190
        :param readv_ranges: A prepared readv range list.
1057
1191
        """
1063
1197
            self._buffer_all()
1064
1198
            return
1065
1199
 
 
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]
1066
1205
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1067
 
            self._size)
 
1206
            self._size + self._base_offset)
1068
1207
        # parse
1069
1208
        for offset, data in readv_data:
 
1209
            offset -= base_offset
1070
1210
            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
1071
1216
            if offset == 0 and len(data) == self._size:
1072
1217
                # We read the whole range, most likely because the
1073
1218
                # Transport upcast our readv ranges into one long request
1095
1240
 
1096
1241
class CombinedGraphIndex(object):
1097
1242
    """A GraphIndex made up from smaller GraphIndices.
1098
 
    
 
1243
 
1099
1244
    The backing indices must implement GraphIndex, and are presumed to be
1100
1245
    static data.
1101
1246
 
1102
1247
    Queries against the combined index will be made against the first index,
1103
 
    and then the second and so on. The order of index's can thus influence
 
1248
    and then the second and so on. The order of indices can thus influence
1104
1249
    performance significantly. For example, if one index is on local disk and a
1105
1250
    second on a remote server, the local disk index should be before the other
1106
1251
    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).
1107
1257
    """
1108
1258
 
1109
 
    def __init__(self, indices):
 
1259
    def __init__(self, indices, reload_func=None):
1110
1260
        """Create a CombinedGraphIndex backed by indices.
1111
1261
 
1112
1262
        :param indices: An ordered list of indices to query for data.
 
1263
        :param reload_func: A function to call if we find we are missing an
 
1264
            index. Should have the form reload_func() => True/False to indicate
 
1265
            if reloading actually changed anything.
1113
1266
        """
1114
1267
        self._indices = indices
 
1268
        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)
1115
1276
 
1116
1277
    def __repr__(self):
1117
1278
        return "%s(%s)" % (
1118
1279
                self.__class__.__name__,
1119
1280
                ', '.join(map(repr, self._indices)))
1120
1281
 
1121
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
1122
 
    def get_parents(self, revision_ids):
1123
 
        """See graph._StackedParentsProvider.get_parents.
1124
 
        
1125
 
        This implementation thunks the graph.Graph.get_parents api across to
1126
 
        GraphIndex.
1127
 
 
1128
 
        :param revision_ids: An iterable of graph keys for this graph.
1129
 
        :return: A list of parent details for each key in revision_ids.
1130
 
            Each parent details will be one of:
1131
 
             * None when the key was missing
1132
 
             * (NULL_REVISION,) when the key has no parents.
1133
 
             * (parent_key, parent_key...) otherwise.
1134
 
        """
1135
 
        parent_map = self.get_parent_map(revision_ids)
1136
 
        return [parent_map.get(r, None) for r in revision_ids]
 
1282
    def clear_cache(self):
 
1283
        """See GraphIndex.clear_cache()"""
 
1284
        for index in self._indices:
 
1285
            index.clear_cache()
1137
1286
 
1138
1287
    def get_parent_map(self, keys):
1139
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
1288
        """See graph.StackedParentsProvider.get_parent_map"""
1140
1289
        search_keys = set(keys)
1141
1290
        if NULL_REVISION in search_keys:
1142
1291
            search_keys.discard(NULL_REVISION)
1150
1299
            found_parents[key] = parents
1151
1300
        return found_parents
1152
1301
 
1153
 
    def insert_index(self, pos, index):
 
1302
    has_key = _has_key_from_parent_map
 
1303
 
 
1304
    def insert_index(self, pos, index, name=None):
1154
1305
        """Insert a new index in the list of indices to query.
1155
1306
 
1156
1307
        :param pos: The position to insert the index.
1157
1308
        :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)
1158
1312
        """
1159
1313
        self._indices.insert(pos, index)
 
1314
        self._index_names.insert(pos, name)
1160
1315
 
1161
1316
    def iter_all_entries(self):
1162
1317
        """Iterate over all keys within the index
1169
1324
            the most efficient order for the index.
1170
1325
        """
1171
1326
        seen_keys = set()
1172
 
        for index in self._indices:
1173
 
            for node in index.iter_all_entries():
1174
 
                if node[1] not in seen_keys:
1175
 
                    yield node
1176
 
                    seen_keys.add(node[1])
 
1327
        while True:
 
1328
            try:
 
1329
                for index in self._indices:
 
1330
                    for node in index.iter_all_entries():
 
1331
                        if node[1] not in seen_keys:
 
1332
                            yield node
 
1333
                            seen_keys.add(node[1])
 
1334
                return
 
1335
            except errors.NoSuchFile:
 
1336
                self._reload_or_raise()
1177
1337
 
1178
1338
    def iter_entries(self, keys):
1179
1339
        """Iterate over keys within the index.
1182
1342
        value and are only reported once.
1183
1343
 
1184
1344
        :param keys: An iterable providing the keys to be retrieved.
1185
 
        :return: An iterable of (index, key, reference_lists, value). There is no
1186
 
            defined order for the result iteration - it will be in the most
 
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
1187
1347
            efficient order for the index.
1188
1348
        """
1189
1349
        keys = set(keys)
1190
 
        for index in self._indices:
1191
 
            if not keys:
1192
 
                return
1193
 
            for node in index.iter_entries(keys):
1194
 
                keys.remove(node[1])
1195
 
                yield node
 
1350
        hit_indices = []
 
1351
        while True:
 
1352
            try:
 
1353
                for index in self._indices:
 
1354
                    if not keys:
 
1355
                        break
 
1356
                    index_hit = False
 
1357
                    for node in index.iter_entries(keys):
 
1358
                        keys.remove(node[1])
 
1359
                        yield node
 
1360
                        index_hit = True
 
1361
                    if index_hit:
 
1362
                        hit_indices.append(index)
 
1363
                break
 
1364
            except errors.NoSuchFile:
 
1365
                self._reload_or_raise()
 
1366
        self._move_to_front(hit_indices)
1196
1367
 
1197
1368
    def iter_entries_prefix(self, keys):
1198
1369
        """Iterate over keys within the index using prefix matching.
1218
1389
        if not keys:
1219
1390
            return
1220
1391
        seen_keys = set()
1221
 
        for index in self._indices:
1222
 
            for node in index.iter_entries_prefix(keys):
1223
 
                if node[1] in seen_keys:
1224
 
                    continue
1225
 
                seen_keys.add(node[1])
1226
 
                yield node
 
1392
        hit_indices = []
 
1393
        while True:
 
1394
            try:
 
1395
                for index in self._indices:
 
1396
                    index_hit = False
 
1397
                    for node in index.iter_entries_prefix(keys):
 
1398
                        if node[1] in seen_keys:
 
1399
                            continue
 
1400
                        seen_keys.add(node[1])
 
1401
                        yield node
 
1402
                        index_hit = True
 
1403
                    if index_hit:
 
1404
                        hit_indices.append(index)
 
1405
                break
 
1406
            except errors.NoSuchFile:
 
1407
                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
        hit_names = self._move_to_front_by_index(hit_indices)
 
1422
        for sibling_idx in self._sibling_indices:
 
1423
            sibling_idx._move_to_front_by_name(hit_names)
 
1424
 
 
1425
    def _move_to_front_by_index(self, hit_indices):
 
1426
        """Core logic for _move_to_front.
 
1427
        
 
1428
        Returns a list of names corresponding to the hit_indices param.
 
1429
        """
 
1430
        indices_info = zip(self._index_names, self._indices)
 
1431
        if 'index' in debug.debug_flags:
 
1432
            mutter('CombinedGraphIndex reordering: currently %r, promoting %r',
 
1433
                   indices_info, hit_indices)
 
1434
        hit_indices_info = []
 
1435
        hit_names = []
 
1436
        unhit_indices_info = []
 
1437
        for name, idx in indices_info:
 
1438
            if idx in hit_indices:
 
1439
                info = hit_indices_info
 
1440
                hit_names.append(name)
 
1441
            else:
 
1442
                info = unhit_indices_info
 
1443
            info.append((name, idx))
 
1444
        final_info = hit_indices_info + unhit_indices_info
 
1445
        self._indices = [idx for (name, idx) in final_info]
 
1446
        self._index_names = [name for (name, idx) in final_info]
 
1447
        if 'index' in debug.debug_flags:
 
1448
            mutter('CombinedGraphIndex reordered: %r', self._indices)
 
1449
        return hit_names
 
1450
 
 
1451
    def _move_to_front_by_name(self, hit_names):
 
1452
        """Moves indices named by 'hit_names' to front of the search order, as
 
1453
        described in _move_to_front.
 
1454
        """
 
1455
        # Translate names to index instances, and then call
 
1456
        # _move_to_front_by_index.
 
1457
        indices_info = zip(self._index_names, self._indices)
 
1458
        hit_indices = []
 
1459
        for name, idx in indices_info:
 
1460
            if name in hit_names:
 
1461
                hit_indices.append(idx)
 
1462
        self._move_to_front_by_index(hit_indices)
 
1463
 
 
1464
    def find_ancestry(self, keys, ref_list_num):
 
1465
        """Find the complete ancestry for the given set of keys.
 
1466
 
 
1467
        Note that this is a whole-ancestry request, so it should be used
 
1468
        sparingly.
 
1469
 
 
1470
        :param keys: An iterable of keys to look for
 
1471
        :param ref_list_num: The reference list which references the parents
 
1472
            we care about.
 
1473
        :return: (parent_map, missing_keys)
 
1474
        """
 
1475
        # XXX: make this call _move_to_front?
 
1476
        missing_keys = set()
 
1477
        parent_map = {}
 
1478
        keys_to_lookup = set(keys)
 
1479
        generation = 0
 
1480
        while keys_to_lookup:
 
1481
            # keys that *all* indexes claim are missing, stop searching them
 
1482
            generation += 1
 
1483
            all_index_missing = None
 
1484
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
 
1485
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
 
1486
            #                                   len(parent_map),
 
1487
            #                                   len(missing_keys))
 
1488
            for index_idx, index in enumerate(self._indices):
 
1489
                # TODO: we should probably be doing something with
 
1490
                #       'missing_keys' since we've already determined that
 
1491
                #       those revisions have not been found anywhere
 
1492
                index_missing_keys = set()
 
1493
                # Find all of the ancestry we can from this index
 
1494
                # keep looking until the search_keys set is empty, which means
 
1495
                # things we didn't find should be in index_missing_keys
 
1496
                search_keys = keys_to_lookup
 
1497
                sub_generation = 0
 
1498
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
 
1499
                #     index_idx, len(search_keys),
 
1500
                #     len(parent_map), len(index_missing_keys))
 
1501
                while search_keys:
 
1502
                    sub_generation += 1
 
1503
                    # TODO: ref_list_num should really be a parameter, since
 
1504
                    #       CombinedGraphIndex does not know what the ref lists
 
1505
                    #       mean.
 
1506
                    search_keys = index._find_ancestors(search_keys,
 
1507
                        ref_list_num, parent_map, index_missing_keys)
 
1508
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
 
1509
                    #     sub_generation, len(search_keys),
 
1510
                    #     len(parent_map), len(index_missing_keys))
 
1511
                # Now set whatever was missing to be searched in the next index
 
1512
                keys_to_lookup = index_missing_keys
 
1513
                if all_index_missing is None:
 
1514
                    all_index_missing = set(index_missing_keys)
 
1515
                else:
 
1516
                    all_index_missing.intersection_update(index_missing_keys)
 
1517
                if not keys_to_lookup:
 
1518
                    break
 
1519
            if all_index_missing is None:
 
1520
                # There were no indexes, so all search keys are 'missing'
 
1521
                missing_keys.update(keys_to_lookup)
 
1522
                keys_to_lookup = None
 
1523
            else:
 
1524
                missing_keys.update(all_index_missing)
 
1525
                keys_to_lookup.difference_update(all_index_missing)
 
1526
        return parent_map, missing_keys
1227
1527
 
1228
1528
    def key_count(self):
1229
1529
        """Return an estimate of the number of keys in this index.
1230
 
        
 
1530
 
1231
1531
        For CombinedGraphIndex this is approximated by the sum of the keys of
1232
1532
        the child indices. As child indices may have duplicate keys this can
1233
1533
        have a maximum error of the number of child indices * largest number of
1234
1534
        keys in any index.
1235
1535
        """
1236
 
        return sum((index.key_count() for index in self._indices), 0)
 
1536
        while True:
 
1537
            try:
 
1538
                return sum((index.key_count() for index in self._indices), 0)
 
1539
            except errors.NoSuchFile:
 
1540
                self._reload_or_raise()
 
1541
 
 
1542
    missing_keys = _missing_keys_from_parent_map
 
1543
 
 
1544
    def _reload_or_raise(self):
 
1545
        """We just got a NoSuchFile exception.
 
1546
 
 
1547
        Try to reload the indices, if it fails, just raise the current
 
1548
        exception.
 
1549
        """
 
1550
        if self._reload_func is None:
 
1551
            raise
 
1552
        exc_type, exc_value, exc_traceback = sys.exc_info()
 
1553
        trace.mutter('Trying to reload after getting exception: %s',
 
1554
                     exc_value)
 
1555
        if not self._reload_func():
 
1556
            # We tried to reload, but nothing changed, so we fail anyway
 
1557
            trace.mutter('_reload_func indicated nothing has changed.'
 
1558
                         ' Raising original exception.')
 
1559
            raise exc_type, exc_value, exc_traceback
 
1560
 
 
1561
    def set_sibling_indices(self, sibling_combined_graph_indices):
 
1562
        """Set the CombinedGraphIndex objects to reorder after reordering self.
 
1563
        """
 
1564
        self._sibling_indices = sibling_combined_graph_indices
1237
1565
 
1238
1566
    def validate(self):
1239
1567
        """Validate that everything in the index can be accessed."""
1240
 
        for index in self._indices:
1241
 
            index.validate()
 
1568
        while True:
 
1569
            try:
 
1570
                for index in self._indices:
 
1571
                    index.validate()
 
1572
                return
 
1573
            except errors.NoSuchFile:
 
1574
                self._reload_or_raise()
1242
1575
 
1243
1576
 
1244
1577
class InMemoryGraphIndex(GraphIndexBuilder):
1288
1621
            defined order for the result iteration - it will be in the most
1289
1622
            efficient order for the index (keys iteration order in this case).
1290
1623
        """
1291
 
        keys = set(keys)
 
1624
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
 
1625
        #       aren't using set().intersection() here
 
1626
        nodes = self._nodes
 
1627
        keys = [key for key in keys if key in nodes]
1292
1628
        if self.reference_lists:
1293
 
            for key in keys.intersection(self._keys):
1294
 
                node = self._nodes[key]
 
1629
            for key in keys:
 
1630
                node = nodes[key]
1295
1631
                if not node[0]:
1296
1632
                    yield self, key, node[2], node[1]
1297
1633
        else:
1298
 
            for key in keys.intersection(self._keys):
1299
 
                node = self._nodes[key]
 
1634
            for key in keys:
 
1635
                node = nodes[key]
1300
1636
                if not node[0]:
1301
1637
                    yield self, key, node[2]
1302
1638
 
1331
1667
                    raise errors.BadIndexKey(key)
1332
1668
                node = self._nodes[key]
1333
1669
                if node[0]:
1334
 
                    continue 
 
1670
                    continue
1335
1671
                if self.reference_lists:
1336
1672
                    yield self, key, node[2], node[1]
1337
1673
                else:
1362
1698
                    # can't be empty or would not exist
1363
1699
                    item, value = key_dict.iteritems().next()
1364
1700
                    if type(value) == dict:
1365
 
                        # push keys 
 
1701
                        # push keys
1366
1702
                        dicts.extend(key_dict.itervalues())
1367
1703
                    else:
1368
1704
                        # yield keys
1373
1709
 
1374
1710
    def key_count(self):
1375
1711
        """Return an estimate of the number of keys in this index.
1376
 
        
 
1712
 
1377
1713
        For InMemoryGraphIndex the estimate is exact.
1378
1714
        """
1379
 
        return len(self._keys)
 
1715
        return len(self._nodes) - len(self._absent_keys)
1380
1716
 
1381
1717
    def validate(self):
1382
1718
        """In memory index's have no known corruption at the moment."""
1387
1723
 
1388
1724
    Queries against this will emit queries against the adapted Graph with the
1389
1725
    prefix added, queries for all items use iter_entries_prefix. The returned
1390
 
    nodes will have their keys and node references adjusted to remove the 
 
1726
    nodes will have their keys and node references adjusted to remove the
1391
1727
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1392
1728
    nodes and references being added will have prefix prepended.
1393
1729
    """
1420
1756
                    adjusted_references))
1421
1757
        except ValueError:
1422
1758
            # XXX: TODO add an explicit interface for getting the reference list
1423
 
            # status, to handle this bit of user-friendliness in the API more 
 
1759
            # status, to handle this bit of user-friendliness in the API more
1424
1760
            # explicitly.
1425
1761
            for (key, value) in nodes:
1426
1762
                translated_nodes.append((self.prefix + key, value))
1498
1834
 
1499
1835
    def key_count(self):
1500
1836
        """Return an estimate of the number of keys in this index.
1501
 
        
 
1837
 
1502
1838
        For GraphIndexPrefixAdapter this is relatively expensive - key
1503
1839
        iteration with the prefix is done.
1504
1840
        """