← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-04-08 06:17:41 UTC
  • mfrom: (4797.33.16 apport)
  • Revision ID: pqm@pqm.ubuntu.com-20100408061741-m7vl6z97vu33riv7
(robertc) Make sure ExecutablePath and InterpreterPath are set in
        Apport. (Martin Pool, James Westby, lp:528114)

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
366
458
        self._keys_by_offset = {}
367
459
        # ready-to-return key:value or key:value, node_ref_lists
368
460
        self._nodes = {}
369
 
        self._nodes_by_key = {}
 
461
        self._nodes_by_key = None
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():
381
474
            else:
382
475
                node_value = value
383
476
            self._nodes[key] = node_value
384
 
            if self._key_length > 1:
385
 
                # TODO: We may want to do this lazily, but if we are calling
386
 
                #       _buffer_all, we are likely to be doing
387
 
                #       iter_entries_prefix
388
 
                key_dict = self._nodes_by_key
389
 
                if self.node_ref_lists:
390
 
                    key_value = key, node_value[0], node_value[1]
391
 
                else:
392
 
                    key_value = key, node_value
393
 
                # For a key of (foo, bar, baz) create
394
 
                # _nodes_by_key[foo][bar][baz] = key_value
395
 
                for subkey in key[:-1]:
396
 
                    key_dict = key_dict.setdefault(subkey, {})
397
 
                key_dict[key[-1]] = key_value
398
477
        # cache the keys for quick set intersections
399
 
        self._keys = set(self._nodes)
400
478
        if trailers != 1:
401
479
            # there must be one line - the empty trailer line.
402
480
            raise errors.BadIndexData(self)
403
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
 
 
504
    def _get_nodes_by_key(self):
 
505
        if self._nodes_by_key is None:
 
506
            nodes_by_key = {}
 
507
            if self.node_ref_lists:
 
508
                for key, (value, references) in self._nodes.iteritems():
 
509
                    key_dict = nodes_by_key
 
510
                    for subkey in key[:-1]:
 
511
                        key_dict = key_dict.setdefault(subkey, {})
 
512
                    key_dict[key[-1]] = key, value, references
 
513
            else:
 
514
                for key, value in self._nodes.iteritems():
 
515
                    key_dict = nodes_by_key
 
516
                    for subkey in key[:-1]:
 
517
                        key_dict = key_dict.setdefault(subkey, {})
 
518
                    key_dict[key[-1]] = key, value
 
519
            self._nodes_by_key = nodes_by_key
 
520
        return self._nodes_by_key
 
521
 
404
522
    def iter_all_entries(self):
405
523
        """Iterate over all keys within the index.
406
524
 
450
568
 
451
569
    def _resolve_references(self, references):
452
570
        """Return the resolved key references for references.
453
 
        
 
571
 
454
572
        References are resolved by looking up the location of the key in the
455
573
        _keys_by_offset map and substituting the key name, preserving ordering.
456
574
 
457
 
        :param references: An iterable of iterables of key locations. e.g. 
 
575
        :param references: An iterable of iterables of key locations. e.g.
458
576
            [[123, 456], [123]]
459
577
        :return: A tuple of tuples of keys.
460
578
        """
514
632
 
515
633
    def _iter_entries_from_total_buffer(self, keys):
516
634
        """Iterate over keys when the entire index is parsed."""
517
 
        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]
518
639
        if self.node_ref_lists:
519
640
            for key in keys:
520
 
                value, node_refs = self._nodes[key]
 
641
                value, node_refs = nodes[key]
521
642
                yield self, key, value, node_refs
522
643
        else:
523
644
            for key in keys:
524
 
                yield self, key, self._nodes[key]
 
645
                yield self, key, nodes[key]
525
646
 
526
647
    def iter_entries(self, keys):
527
648
        """Iterate over keys within the index.
593
714
                else:
594
715
                    yield self, key, self._nodes[key]
595
716
            return
 
717
        nodes_by_key = self._get_nodes_by_key()
596
718
        for key in keys:
597
719
            # sanity check
598
720
            if key[0] is None:
600
722
            if len(key) != self._key_length:
601
723
                raise errors.BadIndexKey(key)
602
724
            # find what it refers to:
603
 
            key_dict = self._nodes_by_key
 
725
            key_dict = nodes_by_key
604
726
            elements = list(key)
605
727
            # find the subdict whose contents should be returned.
606
728
            try:
617
739
                    # can't be empty or would not exist
618
740
                    item, value = key_dict.iteritems().next()
619
741
                    if type(value) == dict:
620
 
                        # push keys 
 
742
                        # push keys
621
743
                        dicts.extend(key_dict.itervalues())
622
744
                    else:
623
745
                        # yield keys
629
751
                # the last thing looked up was a terminal element
630
752
                yield (self, ) + key_dict
631
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
 
632
771
    def key_count(self):
633
772
        """Return an estimate of the number of keys in this index.
634
 
        
 
773
 
635
774
        For GraphIndex the estimate is exact.
636
775
        """
637
776
        if self._key_count is None:
653
792
        # Possible improvements:
654
793
        #  - only bisect lookup each key once
655
794
        #  - sort the keys first, and use that to reduce the bisection window
656
 
        # ----- 
 
795
        # -----
657
796
        # this progresses in three parts:
658
797
        # read data
659
798
        # parse it
668
807
                # We have the key parsed.
669
808
                continue
670
809
            index = self._parsed_key_index(key)
671
 
            if (len(self._parsed_key_map) and 
 
810
            if (len(self._parsed_key_map) and
672
811
                self._parsed_key_map[index][0] <= key and
673
812
                (self._parsed_key_map[index][1] >= key or
674
813
                 # end of the file has been parsed
678
817
                continue
679
818
            # - if we have examined this part of the file already - yes
680
819
            index = self._parsed_byte_index(location)
681
 
            if (len(self._parsed_byte_map) and 
 
820
            if (len(self._parsed_byte_map) and
682
821
                self._parsed_byte_map[index][0] <= location and
683
822
                self._parsed_byte_map[index][1] > location):
684
823
                # the byte region has been parsed, so no read is needed.
939
1078
        # adjust offset and data to the parseable data.
940
1079
        trimmed_data = data[trim_start:trim_end]
941
1080
        if not (trimmed_data):
942
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
 
1081
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
943
1082
                % (trim_start, trim_end, offset, offset + len(data)))
944
1083
        if trim_start:
945
1084
            offset += trim_start
973
1112
                raise errors.BadIndexData(self)
974
1113
            # keys are tuples. Each element is a string that may occur many
975
1114
            # times, so we intern them to save space. AB, RC, 200807
976
 
            key = tuple(intern(element) for element in elements[:self._key_length])
 
1115
            key = tuple([intern(element) for element in elements[:self._key_length]])
977
1116
            if first_key is None:
978
1117
                first_key = key
979
1118
            absent, references, value = elements[-3:]
1046
1185
            self._parsed_key_map.insert(index + 1, new_key)
1047
1186
 
1048
1187
    def _read_and_parse(self, readv_ranges):
1049
 
        """Read the the ranges and parse the resulting data.
 
1188
        """Read the ranges and parse the resulting data.
1050
1189
 
1051
1190
        :param readv_ranges: A prepared readv range list.
1052
1191
        """
1058
1197
            self._buffer_all()
1059
1198
            return
1060
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]
1061
1205
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1062
 
            self._size)
 
1206
            self._size + self._base_offset)
1063
1207
        # parse
1064
1208
        for offset, data in readv_data:
 
1209
            offset -= base_offset
1065
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
1066
1216
            if offset == 0 and len(data) == self._size:
1067
1217
                # We read the whole range, most likely because the
1068
1218
                # Transport upcast our readv ranges into one long request
1090
1240
 
1091
1241
class CombinedGraphIndex(object):
1092
1242
    """A GraphIndex made up from smaller GraphIndices.
1093
 
    
 
1243
 
1094
1244
    The backing indices must implement GraphIndex, and are presumed to be
1095
1245
    static data.
1096
1246
 
1101
1251
    in the index list.
1102
1252
    """
1103
1253
 
1104
 
    def __init__(self, indices):
 
1254
    def __init__(self, indices, reload_func=None):
1105
1255
        """Create a CombinedGraphIndex backed by indices.
1106
1256
 
1107
1257
        :param indices: An ordered list of indices to query for data.
 
1258
        :param reload_func: A function to call if we find we are missing an
 
1259
            index. Should have the form reload_func() => True/False to indicate
 
1260
            if reloading actually changed anything.
1108
1261
        """
1109
1262
        self._indices = indices
 
1263
        self._reload_func = reload_func
1110
1264
 
1111
1265
    def __repr__(self):
1112
1266
        return "%s(%s)" % (
1113
1267
                self.__class__.__name__,
1114
1268
                ', '.join(map(repr, self._indices)))
1115
1269
 
1116
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
1117
 
    def get_parents(self, revision_ids):
1118
 
        """See graph._StackedParentsProvider.get_parents.
1119
 
        
1120
 
        This implementation thunks the graph.Graph.get_parents api across to
1121
 
        GraphIndex.
1122
 
 
1123
 
        :param revision_ids: An iterable of graph keys for this graph.
1124
 
        :return: A list of parent details for each key in revision_ids.
1125
 
            Each parent details will be one of:
1126
 
             * None when the key was missing
1127
 
             * (NULL_REVISION,) when the key has no parents.
1128
 
             * (parent_key, parent_key...) otherwise.
1129
 
        """
1130
 
        parent_map = self.get_parent_map(revision_ids)
1131
 
        return [parent_map.get(r, None) for r in revision_ids]
 
1270
    def clear_cache(self):
 
1271
        """See GraphIndex.clear_cache()"""
 
1272
        for index in self._indices:
 
1273
            index.clear_cache()
1132
1274
 
1133
1275
    def get_parent_map(self, keys):
1134
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
1276
        """See graph.StackedParentsProvider.get_parent_map"""
1135
1277
        search_keys = set(keys)
1136
1278
        if NULL_REVISION in search_keys:
1137
1279
            search_keys.discard(NULL_REVISION)
1145
1287
            found_parents[key] = parents
1146
1288
        return found_parents
1147
1289
 
 
1290
    has_key = _has_key_from_parent_map
 
1291
 
1148
1292
    def insert_index(self, pos, index):
1149
1293
        """Insert a new index in the list of indices to query.
1150
1294
 
1164
1308
            the most efficient order for the index.
1165
1309
        """
1166
1310
        seen_keys = set()
1167
 
        for index in self._indices:
1168
 
            for node in index.iter_all_entries():
1169
 
                if node[1] not in seen_keys:
1170
 
                    yield node
1171
 
                    seen_keys.add(node[1])
 
1311
        while True:
 
1312
            try:
 
1313
                for index in self._indices:
 
1314
                    for node in index.iter_all_entries():
 
1315
                        if node[1] not in seen_keys:
 
1316
                            yield node
 
1317
                            seen_keys.add(node[1])
 
1318
                return
 
1319
            except errors.NoSuchFile:
 
1320
                self._reload_or_raise()
1172
1321
 
1173
1322
    def iter_entries(self, keys):
1174
1323
        """Iterate over keys within the index.
1182
1331
            efficient order for the index.
1183
1332
        """
1184
1333
        keys = set(keys)
1185
 
        for index in self._indices:
1186
 
            if not keys:
 
1334
        while True:
 
1335
            try:
 
1336
                for index in self._indices:
 
1337
                    if not keys:
 
1338
                        return
 
1339
                    for node in index.iter_entries(keys):
 
1340
                        keys.remove(node[1])
 
1341
                        yield node
1187
1342
                return
1188
 
            for node in index.iter_entries(keys):
1189
 
                keys.remove(node[1])
1190
 
                yield node
 
1343
            except errors.NoSuchFile:
 
1344
                self._reload_or_raise()
1191
1345
 
1192
1346
    def iter_entries_prefix(self, keys):
1193
1347
        """Iterate over keys within the index using prefix matching.
1213
1367
        if not keys:
1214
1368
            return
1215
1369
        seen_keys = set()
1216
 
        for index in self._indices:
1217
 
            for node in index.iter_entries_prefix(keys):
1218
 
                if node[1] in seen_keys:
1219
 
                    continue
1220
 
                seen_keys.add(node[1])
1221
 
                yield node
 
1370
        while True:
 
1371
            try:
 
1372
                for index in self._indices:
 
1373
                    for node in index.iter_entries_prefix(keys):
 
1374
                        if node[1] in seen_keys:
 
1375
                            continue
 
1376
                        seen_keys.add(node[1])
 
1377
                        yield node
 
1378
                return
 
1379
            except errors.NoSuchFile:
 
1380
                self._reload_or_raise()
 
1381
 
 
1382
    def find_ancestry(self, keys, ref_list_num):
 
1383
        """Find the complete ancestry for the given set of keys.
 
1384
 
 
1385
        Note that this is a whole-ancestry request, so it should be used
 
1386
        sparingly.
 
1387
 
 
1388
        :param keys: An iterable of keys to look for
 
1389
        :param ref_list_num: The reference list which references the parents
 
1390
            we care about.
 
1391
        :return: (parent_map, missing_keys)
 
1392
        """
 
1393
        missing_keys = set()
 
1394
        parent_map = {}
 
1395
        keys_to_lookup = set(keys)
 
1396
        generation = 0
 
1397
        while keys_to_lookup:
 
1398
            # keys that *all* indexes claim are missing, stop searching them
 
1399
            generation += 1
 
1400
            all_index_missing = None
 
1401
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
 
1402
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
 
1403
            #                                   len(parent_map),
 
1404
            #                                   len(missing_keys))
 
1405
            for index_idx, index in enumerate(self._indices):
 
1406
                # TODO: we should probably be doing something with
 
1407
                #       'missing_keys' since we've already determined that
 
1408
                #       those revisions have not been found anywhere
 
1409
                index_missing_keys = set()
 
1410
                # Find all of the ancestry we can from this index
 
1411
                # keep looking until the search_keys set is empty, which means
 
1412
                # things we didn't find should be in index_missing_keys
 
1413
                search_keys = keys_to_lookup
 
1414
                sub_generation = 0
 
1415
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
 
1416
                #     index_idx, len(search_keys),
 
1417
                #     len(parent_map), len(index_missing_keys))
 
1418
                while search_keys:
 
1419
                    sub_generation += 1
 
1420
                    # TODO: ref_list_num should really be a parameter, since
 
1421
                    #       CombinedGraphIndex does not know what the ref lists
 
1422
                    #       mean.
 
1423
                    search_keys = index._find_ancestors(search_keys,
 
1424
                        ref_list_num, parent_map, index_missing_keys)
 
1425
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
 
1426
                    #     sub_generation, len(search_keys),
 
1427
                    #     len(parent_map), len(index_missing_keys))
 
1428
                # Now set whatever was missing to be searched in the next index
 
1429
                keys_to_lookup = index_missing_keys
 
1430
                if all_index_missing is None:
 
1431
                    all_index_missing = set(index_missing_keys)
 
1432
                else:
 
1433
                    all_index_missing.intersection_update(index_missing_keys)
 
1434
                if not keys_to_lookup:
 
1435
                    break
 
1436
            if all_index_missing is None:
 
1437
                # There were no indexes, so all search keys are 'missing'
 
1438
                missing_keys.update(keys_to_lookup)
 
1439
                keys_to_lookup = None
 
1440
            else:
 
1441
                missing_keys.update(all_index_missing)
 
1442
                keys_to_lookup.difference_update(all_index_missing)
 
1443
        return parent_map, missing_keys
1222
1444
 
1223
1445
    def key_count(self):
1224
1446
        """Return an estimate of the number of keys in this index.
1225
 
        
 
1447
 
1226
1448
        For CombinedGraphIndex this is approximated by the sum of the keys of
1227
1449
        the child indices. As child indices may have duplicate keys this can
1228
1450
        have a maximum error of the number of child indices * largest number of
1229
1451
        keys in any index.
1230
1452
        """
1231
 
        return sum((index.key_count() for index in self._indices), 0)
 
1453
        while True:
 
1454
            try:
 
1455
                return sum((index.key_count() for index in self._indices), 0)
 
1456
            except errors.NoSuchFile:
 
1457
                self._reload_or_raise()
 
1458
 
 
1459
    missing_keys = _missing_keys_from_parent_map
 
1460
 
 
1461
    def _reload_or_raise(self):
 
1462
        """We just got a NoSuchFile exception.
 
1463
 
 
1464
        Try to reload the indices, if it fails, just raise the current
 
1465
        exception.
 
1466
        """
 
1467
        if self._reload_func is None:
 
1468
            raise
 
1469
        exc_type, exc_value, exc_traceback = sys.exc_info()
 
1470
        trace.mutter('Trying to reload after getting exception: %s',
 
1471
                     exc_value)
 
1472
        if not self._reload_func():
 
1473
            # We tried to reload, but nothing changed, so we fail anyway
 
1474
            trace.mutter('_reload_func indicated nothing has changed.'
 
1475
                         ' Raising original exception.')
 
1476
            raise exc_type, exc_value, exc_traceback
1232
1477
 
1233
1478
    def validate(self):
1234
1479
        """Validate that everything in the index can be accessed."""
1235
 
        for index in self._indices:
1236
 
            index.validate()
 
1480
        while True:
 
1481
            try:
 
1482
                for index in self._indices:
 
1483
                    index.validate()
 
1484
                return
 
1485
            except errors.NoSuchFile:
 
1486
                self._reload_or_raise()
1237
1487
 
1238
1488
 
1239
1489
class InMemoryGraphIndex(GraphIndexBuilder):
1283
1533
            defined order for the result iteration - it will be in the most
1284
1534
            efficient order for the index (keys iteration order in this case).
1285
1535
        """
1286
 
        keys = set(keys)
 
1536
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
 
1537
        #       aren't using set().intersection() here
 
1538
        nodes = self._nodes
 
1539
        keys = [key for key in keys if key in nodes]
1287
1540
        if self.reference_lists:
1288
 
            for key in keys.intersection(self._keys):
1289
 
                node = self._nodes[key]
 
1541
            for key in keys:
 
1542
                node = nodes[key]
1290
1543
                if not node[0]:
1291
1544
                    yield self, key, node[2], node[1]
1292
1545
        else:
1293
 
            for key in keys.intersection(self._keys):
1294
 
                node = self._nodes[key]
 
1546
            for key in keys:
 
1547
                node = nodes[key]
1295
1548
                if not node[0]:
1296
1549
                    yield self, key, node[2]
1297
1550
 
1326
1579
                    raise errors.BadIndexKey(key)
1327
1580
                node = self._nodes[key]
1328
1581
                if node[0]:
1329
 
                    continue 
 
1582
                    continue
1330
1583
                if self.reference_lists:
1331
1584
                    yield self, key, node[2], node[1]
1332
1585
                else:
1357
1610
                    # can't be empty or would not exist
1358
1611
                    item, value = key_dict.iteritems().next()
1359
1612
                    if type(value) == dict:
1360
 
                        # push keys 
 
1613
                        # push keys
1361
1614
                        dicts.extend(key_dict.itervalues())
1362
1615
                    else:
1363
1616
                        # yield keys
1368
1621
 
1369
1622
    def key_count(self):
1370
1623
        """Return an estimate of the number of keys in this index.
1371
 
        
 
1624
 
1372
1625
        For InMemoryGraphIndex the estimate is exact.
1373
1626
        """
1374
 
        return len(self._keys)
 
1627
        return len(self._nodes) - len(self._absent_keys)
1375
1628
 
1376
1629
    def validate(self):
1377
1630
        """In memory index's have no known corruption at the moment."""
1382
1635
 
1383
1636
    Queries against this will emit queries against the adapted Graph with the
1384
1637
    prefix added, queries for all items use iter_entries_prefix. The returned
1385
 
    nodes will have their keys and node references adjusted to remove the 
 
1638
    nodes will have their keys and node references adjusted to remove the
1386
1639
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1387
1640
    nodes and references being added will have prefix prepended.
1388
1641
    """
1415
1668
                    adjusted_references))
1416
1669
        except ValueError:
1417
1670
            # XXX: TODO add an explicit interface for getting the reference list
1418
 
            # status, to handle this bit of user-friendliness in the API more 
 
1671
            # status, to handle this bit of user-friendliness in the API more
1419
1672
            # explicitly.
1420
1673
            for (key, value) in nodes:
1421
1674
                translated_nodes.append((self.prefix + key, value))
1493
1746
 
1494
1747
    def key_count(self):
1495
1748
        """Return an estimate of the number of keys in this index.
1496
 
        
 
1749
 
1497
1750
        For GraphIndexPrefixAdapter this is relatively expensive - key
1498
1751
        iteration with the prefix is done.
1499
1752
        """