← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-27 19:05:43 UTC
  • mto: This revision was merged to the branch mainline in revision 6450.
  • Revision ID: jelmer@samba.org-20120127190543-vk350mv4a0c7aug2
Fix weave test.

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-2011 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
 
 
19
from __future__ import absolute_import
 
20
 
19
21
__all__ = [
20
22
    'CombinedGraphIndex',
21
23
    'GraphIndex',
27
29
from bisect import bisect_right
28
30
from cStringIO import StringIO
29
31
import re
 
32
import sys
30
33
 
31
34
from bzrlib.lazy_import import lazy_import
32
35
lazy_import(globals(), """
33
 
from bzrlib import trace
34
 
from bzrlib.bisect_multi import bisect_multi_bytes
35
 
from bzrlib.revision import NULL_REVISION
36
 
from bzrlib.trace import mutter
 
36
from bzrlib import (
 
37
    bisect_multi,
 
38
    revision as _mod_revision,
 
39
    trace,
 
40
    )
37
41
""")
38
42
from bzrlib import (
39
43
    debug,
40
44
    errors,
41
 
    symbol_versioning,
42
45
    )
 
46
from bzrlib.static_tuple import StaticTuple
43
47
 
44
48
_HEADER_READV = (0, 200)
45
49
_OPTION_KEY_ELEMENTS = "key_elements="
52
56
_newline_null_re = re.compile('[\n\0]')
53
57
 
54
58
 
 
59
def _has_key_from_parent_map(self, key):
 
60
    """Check if this index has one key.
 
61
 
 
62
    If it's possible to check for multiple keys at once through
 
63
    calling get_parent_map that should be faster.
 
64
    """
 
65
    return (key in self.get_parent_map([key]))
 
66
 
 
67
 
 
68
def _missing_keys_from_parent_map(self, keys):
 
69
    return set(keys) - set(self.get_parent_map(keys))
 
70
 
 
71
 
55
72
class GraphIndexBuilder(object):
56
73
    """A builder that can build a GraphIndex.
57
 
    
58
 
    The resulting graph has the structure:
59
 
    
60
 
    _SIGNATURE OPTIONS NODES NEWLINE
61
 
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
62
 
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
63
 
    NODES          := NODE*
64
 
    NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
65
 
    KEY            := Not-whitespace-utf8
66
 
    ABSENT         := 'a'
67
 
    REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
68
 
    REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
69
 
    REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
70
 
                              ; referenced key.
71
 
    VALUE          := no-newline-no-null-bytes
 
74
 
 
75
    The resulting graph has the structure::
 
76
 
 
77
      _SIGNATURE OPTIONS NODES NEWLINE
 
78
      _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
 
79
      OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
 
80
      NODES          := NODE*
 
81
      NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
 
82
      KEY            := Not-whitespace-utf8
 
83
      ABSENT         := 'a'
 
84
      REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
 
85
      REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
 
86
      REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
 
87
                                ; referenced key.
 
88
      VALUE          := no-newline-no-null-bytes
72
89
    """
73
90
 
74
91
    def __init__(self, reference_lists=0, key_elements=1):
79
96
        :param key_elements: The number of bytestrings in each key.
80
97
        """
81
98
        self.reference_lists = reference_lists
82
 
        self._keys = set()
 
99
        # A dict of {key: (absent, ref_lists, value)}
83
100
        self._nodes = {}
84
 
        self._nodes_by_key = {}
 
101
        # Keys that are referenced but not actually present in this index
 
102
        self._absent_keys = set()
 
103
        self._nodes_by_key = None
85
104
        self._key_length = key_elements
 
105
        self._optimize_for_size = False
 
106
        self._combine_backing_indices = True
86
107
 
87
108
    def _check_key(self, key):
88
109
        """Raise BadIndexKey if key is not a valid key for this index."""
89
 
        if type(key) != tuple:
 
110
        if type(key) not in (tuple, StaticTuple):
90
111
            raise errors.BadIndexKey(key)
91
112
        if self._key_length != len(key):
92
113
            raise errors.BadIndexKey(key)
94
115
            if not element or _whitespace_re.search(element) is not None:
95
116
                raise errors.BadIndexKey(element)
96
117
 
97
 
    def add_node(self, key, value, references=()):
98
 
        """Add a node to the index.
99
 
 
100
 
        :param key: The key. keys are non-empty tuples containing
101
 
            as many whitespace-free utf8 bytestrings as the key length
102
 
            defined for this index.
103
 
        :param references: An iterable of iterables of keys. Each is a
104
 
            reference to another key.
105
 
        :param value: The value to associate with the key. It may be any
106
 
            bytes as long as it does not contain \0 or \n.
107
 
        """
 
118
    def _external_references(self):
 
119
        """Return references that are not present in this index.
 
120
        """
 
121
        keys = set()
 
122
        refs = set()
 
123
        # TODO: JAM 2008-11-21 This makes an assumption about how the reference
 
124
        #       lists are used. It is currently correct for pack-0.92 through
 
125
        #       1.9, which use the node references (3rd column) second
 
126
        #       reference list as the compression parent. Perhaps this should
 
127
        #       be moved into something higher up the stack, since it
 
128
        #       makes assumptions about how the index is used.
 
129
        if self.reference_lists > 1:
 
130
            for node in self.iter_all_entries():
 
131
                keys.add(node[1])
 
132
                refs.update(node[3][1])
 
133
            return refs - keys
 
134
        else:
 
135
            # If reference_lists == 0 there can be no external references, and
 
136
            # if reference_lists == 1, then there isn't a place to store the
 
137
            # compression parent
 
138
            return set()
 
139
 
 
140
    def _get_nodes_by_key(self):
 
141
        if self._nodes_by_key is None:
 
142
            nodes_by_key = {}
 
143
            if self.reference_lists:
 
144
                for key, (absent, references, value) in self._nodes.iteritems():
 
145
                    if absent:
 
146
                        continue
 
147
                    key_dict = nodes_by_key
 
148
                    for subkey in key[:-1]:
 
149
                        key_dict = key_dict.setdefault(subkey, {})
 
150
                    key_dict[key[-1]] = key, value, references
 
151
            else:
 
152
                for key, (absent, references, value) in self._nodes.iteritems():
 
153
                    if absent:
 
154
                        continue
 
155
                    key_dict = nodes_by_key
 
156
                    for subkey in key[:-1]:
 
157
                        key_dict = key_dict.setdefault(subkey, {})
 
158
                    key_dict[key[-1]] = key, value
 
159
            self._nodes_by_key = nodes_by_key
 
160
        return self._nodes_by_key
 
161
 
 
162
    def _update_nodes_by_key(self, key, value, node_refs):
 
163
        """Update the _nodes_by_key dict with a new key.
 
164
 
 
165
        For a key of (foo, bar, baz) create
 
166
        _nodes_by_key[foo][bar][baz] = key_value
 
167
        """
 
168
        if self._nodes_by_key is None:
 
169
            return
 
170
        key_dict = self._nodes_by_key
 
171
        if self.reference_lists:
 
172
            key_value = StaticTuple(key, value, node_refs)
 
173
        else:
 
174
            key_value = StaticTuple(key, value)
 
175
        for subkey in key[:-1]:
 
176
            key_dict = key_dict.setdefault(subkey, {})
 
177
        key_dict[key[-1]] = key_value
 
178
 
 
179
    def _check_key_ref_value(self, key, references, value):
 
180
        """Check that 'key' and 'references' are all valid.
 
181
 
 
182
        :param key: A key tuple. Must conform to the key interface (be a tuple,
 
183
            be of the right length, not have any whitespace or nulls in any key
 
184
            element.)
 
185
        :param references: An iterable of reference lists. Something like
 
186
            [[(ref, key)], [(ref, key), (other, key)]]
 
187
        :param value: The value associate with this key. Must not contain
 
188
            newlines or null characters.
 
189
        :return: (node_refs, absent_references)
 
190
        
 
191
            * node_refs: basically a packed form of 'references' where all
 
192
              iterables are tuples
 
193
            * absent_references: reference keys that are not in self._nodes.
 
194
              This may contain duplicates if the same key is referenced in
 
195
              multiple lists.
 
196
        """
 
197
        as_st = StaticTuple.from_sequence
108
198
        self._check_key(key)
109
199
        if _newline_null_re.search(value) is not None:
110
200
            raise errors.BadIndexValue(value)
111
201
        if len(references) != self.reference_lists:
112
202
            raise errors.BadIndexValue(references)
113
203
        node_refs = []
 
204
        absent_references = []
114
205
        for reference_list in references:
115
206
            for reference in reference_list:
116
 
                self._check_key(reference)
 
207
                # If reference *is* in self._nodes, then we know it has already
 
208
                # been checked.
117
209
                if reference not in self._nodes:
118
 
                    self._nodes[reference] = ('a', (), '')
119
 
            node_refs.append(tuple(reference_list))
120
 
        if key in self._nodes and self._nodes[key][0] == '':
 
210
                    self._check_key(reference)
 
211
                    absent_references.append(reference)
 
212
            reference_list = as_st([as_st(ref).intern()
 
213
                                    for ref in reference_list])
 
214
            node_refs.append(reference_list)
 
215
        return as_st(node_refs), absent_references
 
216
 
 
217
    def add_node(self, key, value, references=()):
 
218
        """Add a node to the index.
 
219
 
 
220
        :param key: The key. keys are non-empty tuples containing
 
221
            as many whitespace-free utf8 bytestrings as the key length
 
222
            defined for this index.
 
223
        :param references: An iterable of iterables of keys. Each is a
 
224
            reference to another key.
 
225
        :param value: The value to associate with the key. It may be any
 
226
            bytes as long as it does not contain \\0 or \\n.
 
227
        """
 
228
        (node_refs,
 
229
         absent_references) = self._check_key_ref_value(key, references, value)
 
230
        if key in self._nodes and self._nodes[key][0] != 'a':
121
231
            raise errors.BadIndexDuplicateKey(key, self)
122
 
        self._nodes[key] = ('', tuple(node_refs), value)
123
 
        self._keys.add(key)
124
 
        if self._key_length > 1:
125
 
            key_dict = self._nodes_by_key
126
 
            if self.reference_lists:
127
 
                key_value = key, value, tuple(node_refs)
128
 
            else:
129
 
                key_value = key, value
130
 
            # possibly should do this on-demand, but it seems likely it is 
131
 
            # always wanted
132
 
            # For a key of (foo, bar, baz) create
133
 
            # _nodes_by_key[foo][bar][baz] = key_value
134
 
            for subkey in key[:-1]:
135
 
                key_dict = key_dict.setdefault(subkey, {})
136
 
            key_dict[key[-1]] = key_value
137
 
 
 
232
        for reference in absent_references:
 
233
            # There may be duplicates, but I don't think it is worth worrying
 
234
            # about
 
235
            self._nodes[reference] = ('a', (), '')
 
236
        self._absent_keys.update(absent_references)
 
237
        self._absent_keys.discard(key)
 
238
        self._nodes[key] = ('', node_refs, value)
 
239
        if self._nodes_by_key is not None and self._key_length > 1:
 
240
            self._update_nodes_by_key(key, value, node_refs)
 
241
 
 
242
    def clear_cache(self):
 
243
        """See GraphIndex.clear_cache()
 
244
 
 
245
        This is a no-op, but we need the api to conform to a generic 'Index'
 
246
        abstraction.
 
247
        """
 
248
        
138
249
    def finish(self):
 
250
        """Finish the index.
 
251
 
 
252
        :returns: cStringIO holding the full context of the index as it 
 
253
        should be written to disk.
 
254
        """
139
255
        lines = [_SIGNATURE]
140
256
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
141
257
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
142
 
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
 
258
        key_count = len(self._nodes) - len(self._absent_keys)
 
259
        lines.append(_OPTION_LEN + str(key_count) + '\n')
143
260
        prefix_length = sum(len(x) for x in lines)
144
261
        # references are byte offsets. To avoid having to do nasty
145
 
        # polynomial work to resolve offsets (references to later in the 
 
262
        # polynomial work to resolve offsets (references to later in the
146
263
        # file cannot be determined until all the inbetween references have
147
264
        # been calculated too) we pad the offsets with 0's to make them be
148
265
        # of consistent length. Using binary offsets would break the trivial
152
269
        # one to pad all the data with reference-length and determine entry
153
270
        # addresses.
154
271
        # One to serialise.
155
 
        
 
272
 
156
273
        # forward sorted by key. In future we may consider topological sorting,
157
274
        # at the cost of table scans for direct lookup, or a second index for
158
275
        # direct lookup
219
336
            raise errors.BzrError('Failed index creation. Internal error:'
220
337
                ' mismatched output length and expected length: %d %d' %
221
338
                (len(result.getvalue()), expected_bytes))
222
 
        return StringIO(''.join(lines))
 
339
        return result
 
340
 
 
341
    def set_optimize(self, for_size=None, combine_backing_indices=None):
 
342
        """Change how the builder tries to optimize the result.
 
343
 
 
344
        :param for_size: Tell the builder to try and make the index as small as
 
345
            possible.
 
346
        :param combine_backing_indices: If the builder spills to disk to save
 
347
            memory, should the on-disk indices be combined. Set to True if you
 
348
            are going to be probing the index, but to False if you are not. (If
 
349
            you are not querying, then the time spent combining is wasted.)
 
350
        :return: None
 
351
        """
 
352
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
 
353
        # other builders do.
 
354
        if for_size is not None:
 
355
            self._optimize_for_size = for_size
 
356
        if combine_backing_indices is not None:
 
357
            self._combine_backing_indices = combine_backing_indices
 
358
 
 
359
    def find_ancestry(self, keys, ref_list_num):
 
360
        """See CombinedGraphIndex.find_ancestry()"""
 
361
        pending = set(keys)
 
362
        parent_map = {}
 
363
        missing_keys = set()
 
364
        while pending:
 
365
            next_pending = set()
 
366
            for _, key, value, ref_lists in self.iter_entries(pending):
 
367
                parent_keys = ref_lists[ref_list_num]
 
368
                parent_map[key] = parent_keys
 
369
                next_pending.update([p for p in parent_keys if p not in
 
370
                                     parent_map])
 
371
                missing_keys.update(pending.difference(parent_map))
 
372
            pending = next_pending
 
373
        return parent_map, missing_keys
223
374
 
224
375
 
225
376
class GraphIndex(object):
226
377
    """An index for data with embedded graphs.
227
 
 
 
378
 
228
379
    The index maps keys to a list of key reference lists, and a value.
229
380
    Each node has the same number of key reference lists. Each key reference
230
381
    list can be empty or an arbitrary length. The value is an opaque NULL
231
 
    terminated string without any newlines. The storage of the index is 
 
382
    terminated string without any newlines. The storage of the index is
232
383
    hidden in the interface: keys and key references are always tuples of
233
384
    bytestrings, never the internal representation (e.g. dictionary offsets).
234
385
 
240
391
    suitable for production use. :XXX
241
392
    """
242
393
 
243
 
    def __init__(self, transport, name, size):
 
394
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
244
395
        """Open an index called name on transport.
245
396
 
246
397
        :param transport: A bzrlib.transport.Transport.
252
403
            avoided by having it supplied. If size is None, then bisection
253
404
            support will be disabled and accessing the index will just stream
254
405
            all the data.
 
406
        :param offset: Instead of starting the index data at offset 0, start it
 
407
            at an arbitrary offset.
255
408
        """
256
409
        self._transport = transport
257
410
        self._name = name
272
425
        self._keys_by_offset = None
273
426
        self._nodes_by_key = None
274
427
        self._size = size
 
428
        # The number of bytes we've read so far in trying to process this file
 
429
        self._bytes_read = 0
 
430
        self._base_offset = offset
275
431
 
276
432
    def __eq__(self, other):
277
433
        """Equal when self and other were created with the same parameters."""
284
440
    def __ne__(self, other):
285
441
        return not self.__eq__(other)
286
442
 
287
 
    def _buffer_all(self):
 
443
    def __repr__(self):
 
444
        return "%s(%r)" % (self.__class__.__name__,
 
445
            self._transport.abspath(self._name))
 
446
 
 
447
    def _buffer_all(self, stream=None):
288
448
        """Buffer all the index data.
289
449
 
290
450
        Mutates self._nodes and self.keys_by_offset.
291
451
        """
 
452
        if self._nodes is not None:
 
453
            # We already did this
 
454
            return
292
455
        if 'index' in debug.debug_flags:
293
 
            mutter('Reading entire index %s', self._transport.abspath(self._name))
294
 
        stream = self._transport.get(self._name)
 
456
            trace.mutter('Reading entire index %s',
 
457
                          self._transport.abspath(self._name))
 
458
        if stream is None:
 
459
            stream = self._transport.get(self._name)
 
460
            if self._base_offset != 0:
 
461
                # This is wasteful, but it is better than dealing with
 
462
                # adjusting all the offsets, etc.
 
463
                stream = StringIO(stream.read()[self._base_offset:])
295
464
        self._read_prefix(stream)
296
465
        self._expected_elements = 3 + self._key_length
297
466
        line_count = 0
299
468
        self._keys_by_offset = {}
300
469
        # ready-to-return key:value or key:value, node_ref_lists
301
470
        self._nodes = {}
302
 
        self._nodes_by_key = {}
 
471
        self._nodes_by_key = None
303
472
        trailers = 0
304
473
        pos = stream.tell()
305
474
        lines = stream.read().split('\n')
 
475
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
 
476
        stream.close()
306
477
        del lines[-1]
307
478
        _, _, _, trailers = self._parse_lines(lines, pos)
308
479
        for key, absent, references, value in self._keys_by_offset.itervalues():
314
485
            else:
315
486
                node_value = value
316
487
            self._nodes[key] = node_value
317
 
            if self._key_length > 1:
318
 
                subkey = list(reversed(key[:-1]))
319
 
                key_dict = self._nodes_by_key
320
 
                if self.node_ref_lists:
321
 
                    key_value = key, node_value[0], node_value[1]
322
 
                else:
323
 
                    key_value = key, node_value
324
 
                # possibly should do this on-demand, but it seems likely it is 
325
 
                # always wanted
326
 
                # For a key of (foo, bar, baz) create
327
 
                # _nodes_by_key[foo][bar][baz] = key_value
328
 
                for subkey in key[:-1]:
329
 
                    key_dict = key_dict.setdefault(subkey, {})
330
 
                key_dict[key[-1]] = key_value
331
488
        # cache the keys for quick set intersections
332
 
        self._keys = set(self._nodes)
333
489
        if trailers != 1:
334
490
            # there must be one line - the empty trailer line.
335
491
            raise errors.BadIndexData(self)
336
492
 
 
493
    def clear_cache(self):
 
494
        """Clear out any cached/memoized values.
 
495
 
 
496
        This can be called at any time, but generally it is used when we have
 
497
        extracted some information, but don't expect to be requesting any more
 
498
        from this index.
 
499
        """
 
500
 
 
501
    def external_references(self, ref_list_num):
 
502
        """Return references that are not present in this index.
 
503
        """
 
504
        self._buffer_all()
 
505
        if ref_list_num + 1 > self.node_ref_lists:
 
506
            raise ValueError('No ref list %d, index has %d ref lists'
 
507
                % (ref_list_num, self.node_ref_lists))
 
508
        refs = set()
 
509
        nodes = self._nodes
 
510
        for key, (value, ref_lists) in nodes.iteritems():
 
511
            ref_list = ref_lists[ref_list_num]
 
512
            refs.update([ref for ref in ref_list if ref not in nodes])
 
513
        return refs
 
514
 
 
515
    def _get_nodes_by_key(self):
 
516
        if self._nodes_by_key is None:
 
517
            nodes_by_key = {}
 
518
            if self.node_ref_lists:
 
519
                for key, (value, references) in self._nodes.iteritems():
 
520
                    key_dict = nodes_by_key
 
521
                    for subkey in key[:-1]:
 
522
                        key_dict = key_dict.setdefault(subkey, {})
 
523
                    key_dict[key[-1]] = key, value, references
 
524
            else:
 
525
                for key, value in self._nodes.iteritems():
 
526
                    key_dict = nodes_by_key
 
527
                    for subkey in key[:-1]:
 
528
                        key_dict = key_dict.setdefault(subkey, {})
 
529
                    key_dict[key[-1]] = key, value
 
530
            self._nodes_by_key = nodes_by_key
 
531
        return self._nodes_by_key
 
532
 
337
533
    def iter_all_entries(self):
338
534
        """Iterate over all keys within the index.
339
535
 
383
579
 
384
580
    def _resolve_references(self, references):
385
581
        """Return the resolved key references for references.
386
 
        
 
582
 
387
583
        References are resolved by looking up the location of the key in the
388
584
        _keys_by_offset map and substituting the key name, preserving ordering.
389
585
 
390
 
        :param references: An iterable of iterables of key locations. e.g. 
 
586
        :param references: An iterable of iterables of key locations. e.g.
391
587
            [[123, 456], [123]]
392
588
        :return: A tuple of tuples of keys.
393
589
        """
447
643
 
448
644
    def _iter_entries_from_total_buffer(self, keys):
449
645
        """Iterate over keys when the entire index is parsed."""
450
 
        keys = keys.intersection(self._keys)
 
646
        # Note: See the note in BTreeBuilder.iter_entries for why we don't use
 
647
        #       .intersection() here
 
648
        nodes = self._nodes
 
649
        keys = [key for key in keys if key in nodes]
451
650
        if self.node_ref_lists:
452
651
            for key in keys:
453
 
                value, node_refs = self._nodes[key]
 
652
                value, node_refs = nodes[key]
454
653
                yield self, key, value, node_refs
455
654
        else:
456
655
            for key in keys:
457
 
                yield self, key, self._nodes[key]
 
656
                yield self, key, nodes[key]
458
657
 
459
658
    def iter_entries(self, keys):
460
659
        """Iterate over keys within the index.
464
663
            keys supplied. No additional keys will be returned, and every
465
664
            key supplied that is in the index will be returned.
466
665
        """
467
 
        # PERFORMANCE TODO: parse and bisect all remaining data at some
468
 
        # threshold of total-index processing/get calling layers that expect to
469
 
        # read the entire index to use the iter_all_entries  method instead.
470
666
        keys = set(keys)
471
667
        if not keys:
472
668
            return []
473
669
        if self._size is None and self._nodes is None:
474
670
            self._buffer_all()
 
671
 
 
672
        # We fit about 20 keys per minimum-read (4K), so if we are looking for
 
673
        # more than 1/20th of the index its likely (assuming homogenous key
 
674
        # spread) that we'll read the entire index. If we're going to do that,
 
675
        # buffer the whole thing. A better analysis might take key spread into
 
676
        # account - but B+Tree indices are better anyway.
 
677
        # We could look at all data read, and use a threshold there, which will
 
678
        # trigger on ancestry walks, but that is not yet fully mapped out.
 
679
        if self._nodes is None and len(keys) * 20 > self.key_count():
 
680
            self._buffer_all()
475
681
        if self._nodes is not None:
476
682
            return self._iter_entries_from_total_buffer(keys)
477
683
        else:
478
 
            return (result[1] for result in bisect_multi_bytes(
 
684
            return (result[1] for result in bisect_multi.bisect_multi_bytes(
479
685
                self._lookup_keys_via_location, self._size, keys))
480
686
 
481
687
    def iter_entries_prefix(self, keys):
519
725
                else:
520
726
                    yield self, key, self._nodes[key]
521
727
            return
 
728
        nodes_by_key = self._get_nodes_by_key()
522
729
        for key in keys:
523
730
            # sanity check
524
731
            if key[0] is None:
526
733
            if len(key) != self._key_length:
527
734
                raise errors.BadIndexKey(key)
528
735
            # find what it refers to:
529
 
            key_dict = self._nodes_by_key
 
736
            key_dict = nodes_by_key
530
737
            elements = list(key)
531
738
            # find the subdict whose contents should be returned.
532
739
            try:
543
750
                    # can't be empty or would not exist
544
751
                    item, value = key_dict.iteritems().next()
545
752
                    if type(value) == dict:
546
 
                        # push keys 
 
753
                        # push keys
547
754
                        dicts.extend(key_dict.itervalues())
548
755
                    else:
549
756
                        # yield keys
555
762
                # the last thing looked up was a terminal element
556
763
                yield (self, ) + key_dict
557
764
 
 
765
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
 
766
        """See BTreeIndex._find_ancestors."""
 
767
        # The api can be implemented as a trivial overlay on top of
 
768
        # iter_entries, it is not an efficient implementation, but it at least
 
769
        # gets the job done.
 
770
        found_keys = set()
 
771
        search_keys = set()
 
772
        for index, key, value, refs in self.iter_entries(keys):
 
773
            parent_keys = refs[ref_list_num]
 
774
            found_keys.add(key)
 
775
            parent_map[key] = parent_keys
 
776
            search_keys.update(parent_keys)
 
777
        # Figure out what, if anything, was missing
 
778
        missing_keys.update(set(keys).difference(found_keys))
 
779
        search_keys = search_keys.difference(parent_map)
 
780
        return search_keys
 
781
 
558
782
    def key_count(self):
559
783
        """Return an estimate of the number of keys in this index.
560
 
        
 
784
 
561
785
        For GraphIndex the estimate is exact.
562
786
        """
563
787
        if self._key_count is None:
579
803
        # Possible improvements:
580
804
        #  - only bisect lookup each key once
581
805
        #  - sort the keys first, and use that to reduce the bisection window
582
 
        # ----- 
 
806
        # -----
583
807
        # this progresses in three parts:
584
808
        # read data
585
809
        # parse it
594
818
                # We have the key parsed.
595
819
                continue
596
820
            index = self._parsed_key_index(key)
597
 
            if (len(self._parsed_key_map) and 
 
821
            if (len(self._parsed_key_map) and
598
822
                self._parsed_key_map[index][0] <= key and
599
823
                (self._parsed_key_map[index][1] >= key or
600
824
                 # end of the file has been parsed
604
828
                continue
605
829
            # - if we have examined this part of the file already - yes
606
830
            index = self._parsed_byte_index(location)
607
 
            if (len(self._parsed_byte_map) and 
 
831
            if (len(self._parsed_byte_map) and
608
832
                self._parsed_byte_map[index][0] <= location and
609
833
                self._parsed_byte_map[index][1] > location):
610
834
                # the byte region has been parsed, so no read is needed.
619
843
        if self._bisect_nodes is None:
620
844
            readv_ranges.append(_HEADER_READV)
621
845
        self._read_and_parse(readv_ranges)
 
846
        result = []
 
847
        if self._nodes is not None:
 
848
            # _read_and_parse triggered a _buffer_all because we requested the
 
849
            # whole data range
 
850
            for location, key in location_keys:
 
851
                if key not in self._nodes: # not present
 
852
                    result.append(((location, key), False))
 
853
                elif self.node_ref_lists:
 
854
                    value, refs = self._nodes[key]
 
855
                    result.append(((location, key),
 
856
                        (self, key, value, refs)))
 
857
                else:
 
858
                    result.append(((location, key),
 
859
                        (self, key, self._nodes[key])))
 
860
            return result
622
861
        # generate results:
623
862
        #  - figure out <, >, missing, present
624
863
        #  - result present references so we can return them.
625
 
        result = []
626
864
        # keys that we cannot answer until we resolve references
627
865
        pending_references = []
628
866
        pending_locations = set()
678
916
            if length > 0:
679
917
                readv_ranges.append((location, length))
680
918
        self._read_and_parse(readv_ranges)
 
919
        if self._nodes is not None:
 
920
            # The _read_and_parse triggered a _buffer_all, grab the data and
 
921
            # return it
 
922
            for location, key in pending_references:
 
923
                value, refs = self._nodes[key]
 
924
                result.append(((location, key), (self, key, value, refs)))
 
925
            return result
681
926
        for location, key in pending_references:
682
927
            # answer key references we had to look-up-late.
683
 
            index = self._parsed_key_index(key)
684
928
            value, refs = self._bisect_nodes[key]
685
929
            result.append(((location, key), (self, key,
686
930
                value, self._resolve_references(refs))))
845
1089
        # adjust offset and data to the parseable data.
846
1090
        trimmed_data = data[trim_start:trim_end]
847
1091
        if not (trimmed_data):
848
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
 
1092
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
849
1093
                % (trim_start, trim_end, offset, offset + len(data)))
850
1094
        if trim_start:
851
1095
            offset += trim_start
877
1121
            elements = line.split('\0')
878
1122
            if len(elements) != self._expected_elements:
879
1123
                raise errors.BadIndexData(self)
880
 
            # keys are tuples
881
 
            key = tuple(elements[:self._key_length])
 
1124
            # keys are tuples. Each element is a string that may occur many
 
1125
            # times, so we intern them to save space. AB, RC, 200807
 
1126
            key = tuple([intern(element) for element in elements[:self._key_length]])
882
1127
            if first_key is None:
883
1128
                first_key = key
884
1129
            absent, references, value = elements[-3:]
951
1196
            self._parsed_key_map.insert(index + 1, new_key)
952
1197
 
953
1198
    def _read_and_parse(self, readv_ranges):
954
 
        """Read the the ranges and parse the resulting data.
 
1199
        """Read the ranges and parse the resulting data.
955
1200
 
956
1201
        :param readv_ranges: A prepared readv range list.
957
1202
        """
958
 
        if readv_ranges:
959
 
            readv_data = self._transport.readv(self._name, readv_ranges, True,
960
 
                self._size)
961
 
            # parse
962
 
            for offset, data in readv_data:
963
 
                if self._bisect_nodes is None:
964
 
                    # this must be the start
965
 
                    if not (offset == 0):
966
 
                        raise AssertionError()
967
 
                    offset, data = self._parse_header_from_bytes(data)
968
 
                # print readv_ranges, "[%d:%d]" % (offset, offset + len(data))
969
 
                self._parse_region(offset, data)
 
1203
        if not readv_ranges:
 
1204
            return
 
1205
        if self._nodes is None and self._bytes_read * 2 >= self._size:
 
1206
            # We've already read more than 50% of the file and we are about to
 
1207
            # request more data, just _buffer_all() and be done
 
1208
            self._buffer_all()
 
1209
            return
 
1210
 
 
1211
        base_offset = self._base_offset
 
1212
        if base_offset != 0:
 
1213
            # Rewrite the ranges for the offset
 
1214
            readv_ranges = [(start+base_offset, size)
 
1215
                            for start, size in readv_ranges]
 
1216
        readv_data = self._transport.readv(self._name, readv_ranges, True,
 
1217
            self._size + self._base_offset)
 
1218
        # parse
 
1219
        for offset, data in readv_data:
 
1220
            offset -= base_offset
 
1221
            self._bytes_read += len(data)
 
1222
            if offset < 0:
 
1223
                # transport.readv() expanded to extra data which isn't part of
 
1224
                # this index
 
1225
                data = data[-offset:]
 
1226
                offset = 0
 
1227
            if offset == 0 and len(data) == self._size:
 
1228
                # We read the whole range, most likely because the
 
1229
                # Transport upcast our readv ranges into one long request
 
1230
                # for enough total data to grab the whole index.
 
1231
                self._buffer_all(StringIO(data))
 
1232
                return
 
1233
            if self._bisect_nodes is None:
 
1234
                # this must be the start
 
1235
                if not (offset == 0):
 
1236
                    raise AssertionError()
 
1237
                offset, data = self._parse_header_from_bytes(data)
 
1238
            # print readv_ranges, "[%d:%d]" % (offset, offset + len(data))
 
1239
            self._parse_region(offset, data)
970
1240
 
971
1241
    def _signature(self):
972
1242
        """The file signature for this index type."""
981
1251
 
982
1252
class CombinedGraphIndex(object):
983
1253
    """A GraphIndex made up from smaller GraphIndices.
984
 
    
 
1254
 
985
1255
    The backing indices must implement GraphIndex, and are presumed to be
986
1256
    static data.
987
1257
 
988
1258
    Queries against the combined index will be made against the first index,
989
 
    and then the second and so on. The order of index's can thus influence
 
1259
    and then the second and so on. The order of indices can thus influence
990
1260
    performance significantly. For example, if one index is on local disk and a
991
1261
    second on a remote server, the local disk index should be before the other
992
1262
    in the index list.
 
1263
    
 
1264
    Also, queries tend to need results from the same indices as previous
 
1265
    queries.  So the indices will be reordered after every query to put the
 
1266
    indices that had the result(s) of that query first (while otherwise
 
1267
    preserving the relative ordering).
993
1268
    """
994
1269
 
995
 
    def __init__(self, indices):
 
1270
    def __init__(self, indices, reload_func=None):
996
1271
        """Create a CombinedGraphIndex backed by indices.
997
1272
 
998
1273
        :param indices: An ordered list of indices to query for data.
 
1274
        :param reload_func: A function to call if we find we are missing an
 
1275
            index. Should have the form reload_func() => True/False to indicate
 
1276
            if reloading actually changed anything.
999
1277
        """
1000
1278
        self._indices = indices
 
1279
        self._reload_func = reload_func
 
1280
        # Sibling indices are other CombinedGraphIndex that we should call
 
1281
        # _move_to_front_by_name on when we auto-reorder ourself.
 
1282
        self._sibling_indices = []
 
1283
        # A list of names that corresponds to the instances in self._indices,
 
1284
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
 
1285
        # indices must all use the same set of names as each other.
 
1286
        self._index_names = [None] * len(self._indices)
1001
1287
 
1002
1288
    def __repr__(self):
1003
1289
        return "%s(%s)" % (
1004
1290
                self.__class__.__name__,
1005
1291
                ', '.join(map(repr, self._indices)))
1006
1292
 
1007
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
1008
 
    def get_parents(self, revision_ids):
1009
 
        """See graph._StackedParentsProvider.get_parents.
1010
 
        
1011
 
        This implementation thunks the graph.Graph.get_parents api across to
1012
 
        GraphIndex.
1013
 
 
1014
 
        :param revision_ids: An iterable of graph keys for this graph.
1015
 
        :return: A list of parent details for each key in revision_ids.
1016
 
            Each parent details will be one of:
1017
 
             * None when the key was missing
1018
 
             * (NULL_REVISION,) when the key has no parents.
1019
 
             * (parent_key, parent_key...) otherwise.
1020
 
        """
1021
 
        parent_map = self.get_parent_map(revision_ids)
1022
 
        return [parent_map.get(r, None) for r in revision_ids]
 
1293
    def clear_cache(self):
 
1294
        """See GraphIndex.clear_cache()"""
 
1295
        for index in self._indices:
 
1296
            index.clear_cache()
1023
1297
 
1024
1298
    def get_parent_map(self, keys):
1025
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
1299
        """See graph.StackedParentsProvider.get_parent_map"""
1026
1300
        search_keys = set(keys)
1027
 
        if NULL_REVISION in search_keys:
1028
 
            search_keys.discard(NULL_REVISION)
1029
 
            found_parents = {NULL_REVISION:[]}
 
1301
        if _mod_revision.NULL_REVISION in search_keys:
 
1302
            search_keys.discard(_mod_revision.NULL_REVISION)
 
1303
            found_parents = {_mod_revision.NULL_REVISION:[]}
1030
1304
        else:
1031
1305
            found_parents = {}
1032
1306
        for index, key, value, refs in self.iter_entries(search_keys):
1033
1307
            parents = refs[0]
1034
1308
            if not parents:
1035
 
                parents = (NULL_REVISION,)
 
1309
                parents = (_mod_revision.NULL_REVISION,)
1036
1310
            found_parents[key] = parents
1037
1311
        return found_parents
1038
1312
 
1039
 
    def insert_index(self, pos, index):
 
1313
    has_key = _has_key_from_parent_map
 
1314
 
 
1315
    def insert_index(self, pos, index, name=None):
1040
1316
        """Insert a new index in the list of indices to query.
1041
1317
 
1042
1318
        :param pos: The position to insert the index.
1043
1319
        :param index: The index to insert.
 
1320
        :param name: a name for this index, e.g. a pack name.  These names can
 
1321
            be used to reflect index reorderings to related CombinedGraphIndex
 
1322
            instances that use the same names.  (see set_sibling_indices)
1044
1323
        """
1045
1324
        self._indices.insert(pos, index)
 
1325
        self._index_names.insert(pos, name)
1046
1326
 
1047
1327
    def iter_all_entries(self):
1048
1328
        """Iterate over all keys within the index
1055
1335
            the most efficient order for the index.
1056
1336
        """
1057
1337
        seen_keys = set()
1058
 
        for index in self._indices:
1059
 
            for node in index.iter_all_entries():
1060
 
                if node[1] not in seen_keys:
1061
 
                    yield node
1062
 
                    seen_keys.add(node[1])
 
1338
        while True:
 
1339
            try:
 
1340
                for index in self._indices:
 
1341
                    for node in index.iter_all_entries():
 
1342
                        if node[1] not in seen_keys:
 
1343
                            yield node
 
1344
                            seen_keys.add(node[1])
 
1345
                return
 
1346
            except errors.NoSuchFile:
 
1347
                self._reload_or_raise()
1063
1348
 
1064
1349
    def iter_entries(self, keys):
1065
1350
        """Iterate over keys within the index.
1068
1353
        value and are only reported once.
1069
1354
 
1070
1355
        :param keys: An iterable providing the keys to be retrieved.
1071
 
        :return: An iterable of (index, key, reference_lists, value). There is no
1072
 
            defined order for the result iteration - it will be in the most
 
1356
        :return: An iterable of (index, key, reference_lists, value). There is
 
1357
            no defined order for the result iteration - it will be in the most
1073
1358
            efficient order for the index.
1074
1359
        """
1075
1360
        keys = set(keys)
1076
 
        for index in self._indices:
1077
 
            if not keys:
1078
 
                return
1079
 
            for node in index.iter_entries(keys):
1080
 
                keys.remove(node[1])
1081
 
                yield node
 
1361
        hit_indices = []
 
1362
        while True:
 
1363
            try:
 
1364
                for index in self._indices:
 
1365
                    if not keys:
 
1366
                        break
 
1367
                    index_hit = False
 
1368
                    for node in index.iter_entries(keys):
 
1369
                        keys.remove(node[1])
 
1370
                        yield node
 
1371
                        index_hit = True
 
1372
                    if index_hit:
 
1373
                        hit_indices.append(index)
 
1374
                break
 
1375
            except errors.NoSuchFile:
 
1376
                self._reload_or_raise()
 
1377
        self._move_to_front(hit_indices)
1082
1378
 
1083
1379
    def iter_entries_prefix(self, keys):
1084
1380
        """Iterate over keys within the index using prefix matching.
1104
1400
        if not keys:
1105
1401
            return
1106
1402
        seen_keys = set()
1107
 
        for index in self._indices:
1108
 
            for node in index.iter_entries_prefix(keys):
1109
 
                if node[1] in seen_keys:
1110
 
                    continue
1111
 
                seen_keys.add(node[1])
1112
 
                yield node
 
1403
        hit_indices = []
 
1404
        while True:
 
1405
            try:
 
1406
                for index in self._indices:
 
1407
                    index_hit = False
 
1408
                    for node in index.iter_entries_prefix(keys):
 
1409
                        if node[1] in seen_keys:
 
1410
                            continue
 
1411
                        seen_keys.add(node[1])
 
1412
                        yield node
 
1413
                        index_hit = True
 
1414
                    if index_hit:
 
1415
                        hit_indices.append(index)
 
1416
                break
 
1417
            except errors.NoSuchFile:
 
1418
                self._reload_or_raise()
 
1419
        self._move_to_front(hit_indices)
 
1420
 
 
1421
    def _move_to_front(self, hit_indices):
 
1422
        """Rearrange self._indices so that hit_indices are first.
 
1423
 
 
1424
        Order is maintained as much as possible, e.g. the first unhit index
 
1425
        will be the first index in _indices after the hit_indices, and the
 
1426
        hit_indices will be present in exactly the order they are passed to
 
1427
        _move_to_front.
 
1428
 
 
1429
        _move_to_front propagates to all objects in self._sibling_indices by
 
1430
        calling _move_to_front_by_name.
 
1431
        """
 
1432
        if self._indices[:len(hit_indices)] == hit_indices:
 
1433
            # The 'hit_indices' are already at the front (and in the same
 
1434
            # order), no need to re-order
 
1435
            return
 
1436
        hit_names = self._move_to_front_by_index(hit_indices)
 
1437
        for sibling_idx in self._sibling_indices:
 
1438
            sibling_idx._move_to_front_by_name(hit_names)
 
1439
 
 
1440
    def _move_to_front_by_index(self, hit_indices):
 
1441
        """Core logic for _move_to_front.
 
1442
        
 
1443
        Returns a list of names corresponding to the hit_indices param.
 
1444
        """
 
1445
        indices_info = zip(self._index_names, self._indices)
 
1446
        if 'index' in debug.debug_flags:
 
1447
            trace.mutter('CombinedGraphIndex reordering: currently %r, '
 
1448
                         'promoting %r', indices_info, hit_indices)
 
1449
        hit_names = []
 
1450
        unhit_names = []
 
1451
        new_hit_indices = []
 
1452
        unhit_indices = []
 
1453
 
 
1454
        for offset, (name, idx) in enumerate(indices_info):
 
1455
            if idx in hit_indices:
 
1456
                hit_names.append(name)
 
1457
                new_hit_indices.append(idx)
 
1458
                if len(new_hit_indices) == len(hit_indices):
 
1459
                    # We've found all of the hit entries, everything else is
 
1460
                    # unhit
 
1461
                    unhit_names.extend(self._index_names[offset+1:])
 
1462
                    unhit_indices.extend(self._indices[offset+1:])
 
1463
                    break
 
1464
            else:
 
1465
                unhit_names.append(name)
 
1466
                unhit_indices.append(idx)
 
1467
 
 
1468
        self._indices = new_hit_indices + unhit_indices
 
1469
        self._index_names = hit_names + unhit_names
 
1470
        if 'index' in debug.debug_flags:
 
1471
            trace.mutter('CombinedGraphIndex reordered: %r', self._indices)
 
1472
        return hit_names
 
1473
 
 
1474
    def _move_to_front_by_name(self, hit_names):
 
1475
        """Moves indices named by 'hit_names' to front of the search order, as
 
1476
        described in _move_to_front.
 
1477
        """
 
1478
        # Translate names to index instances, and then call
 
1479
        # _move_to_front_by_index.
 
1480
        indices_info = zip(self._index_names, self._indices)
 
1481
        hit_indices = []
 
1482
        for name, idx in indices_info:
 
1483
            if name in hit_names:
 
1484
                hit_indices.append(idx)
 
1485
        self._move_to_front_by_index(hit_indices)
 
1486
 
 
1487
    def find_ancestry(self, keys, ref_list_num):
 
1488
        """Find the complete ancestry for the given set of keys.
 
1489
 
 
1490
        Note that this is a whole-ancestry request, so it should be used
 
1491
        sparingly.
 
1492
 
 
1493
        :param keys: An iterable of keys to look for
 
1494
        :param ref_list_num: The reference list which references the parents
 
1495
            we care about.
 
1496
        :return: (parent_map, missing_keys)
 
1497
        """
 
1498
        # XXX: make this call _move_to_front?
 
1499
        missing_keys = set()
 
1500
        parent_map = {}
 
1501
        keys_to_lookup = set(keys)
 
1502
        generation = 0
 
1503
        while keys_to_lookup:
 
1504
            # keys that *all* indexes claim are missing, stop searching them
 
1505
            generation += 1
 
1506
            all_index_missing = None
 
1507
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
 
1508
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
 
1509
            #                                   len(parent_map),
 
1510
            #                                   len(missing_keys))
 
1511
            for index_idx, index in enumerate(self._indices):
 
1512
                # TODO: we should probably be doing something with
 
1513
                #       'missing_keys' since we've already determined that
 
1514
                #       those revisions have not been found anywhere
 
1515
                index_missing_keys = set()
 
1516
                # Find all of the ancestry we can from this index
 
1517
                # keep looking until the search_keys set is empty, which means
 
1518
                # things we didn't find should be in index_missing_keys
 
1519
                search_keys = keys_to_lookup
 
1520
                sub_generation = 0
 
1521
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
 
1522
                #     index_idx, len(search_keys),
 
1523
                #     len(parent_map), len(index_missing_keys))
 
1524
                while search_keys:
 
1525
                    sub_generation += 1
 
1526
                    # TODO: ref_list_num should really be a parameter, since
 
1527
                    #       CombinedGraphIndex does not know what the ref lists
 
1528
                    #       mean.
 
1529
                    search_keys = index._find_ancestors(search_keys,
 
1530
                        ref_list_num, parent_map, index_missing_keys)
 
1531
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
 
1532
                    #     sub_generation, len(search_keys),
 
1533
                    #     len(parent_map), len(index_missing_keys))
 
1534
                # Now set whatever was missing to be searched in the next index
 
1535
                keys_to_lookup = index_missing_keys
 
1536
                if all_index_missing is None:
 
1537
                    all_index_missing = set(index_missing_keys)
 
1538
                else:
 
1539
                    all_index_missing.intersection_update(index_missing_keys)
 
1540
                if not keys_to_lookup:
 
1541
                    break
 
1542
            if all_index_missing is None:
 
1543
                # There were no indexes, so all search keys are 'missing'
 
1544
                missing_keys.update(keys_to_lookup)
 
1545
                keys_to_lookup = None
 
1546
            else:
 
1547
                missing_keys.update(all_index_missing)
 
1548
                keys_to_lookup.difference_update(all_index_missing)
 
1549
        return parent_map, missing_keys
1113
1550
 
1114
1551
    def key_count(self):
1115
1552
        """Return an estimate of the number of keys in this index.
1116
 
        
 
1553
 
1117
1554
        For CombinedGraphIndex this is approximated by the sum of the keys of
1118
1555
        the child indices. As child indices may have duplicate keys this can
1119
1556
        have a maximum error of the number of child indices * largest number of
1120
1557
        keys in any index.
1121
1558
        """
1122
 
        return sum((index.key_count() for index in self._indices), 0)
 
1559
        while True:
 
1560
            try:
 
1561
                return sum((index.key_count() for index in self._indices), 0)
 
1562
            except errors.NoSuchFile:
 
1563
                self._reload_or_raise()
 
1564
 
 
1565
    missing_keys = _missing_keys_from_parent_map
 
1566
 
 
1567
    def _reload_or_raise(self):
 
1568
        """We just got a NoSuchFile exception.
 
1569
 
 
1570
        Try to reload the indices, if it fails, just raise the current
 
1571
        exception.
 
1572
        """
 
1573
        if self._reload_func is None:
 
1574
            raise
 
1575
        exc_type, exc_value, exc_traceback = sys.exc_info()
 
1576
        trace.mutter('Trying to reload after getting exception: %s',
 
1577
                     exc_value)
 
1578
        if not self._reload_func():
 
1579
            # We tried to reload, but nothing changed, so we fail anyway
 
1580
            trace.mutter('_reload_func indicated nothing has changed.'
 
1581
                         ' Raising original exception.')
 
1582
            raise exc_type, exc_value, exc_traceback
 
1583
 
 
1584
    def set_sibling_indices(self, sibling_combined_graph_indices):
 
1585
        """Set the CombinedGraphIndex objects to reorder after reordering self.
 
1586
        """
 
1587
        self._sibling_indices = sibling_combined_graph_indices
1123
1588
 
1124
1589
    def validate(self):
1125
1590
        """Validate that everything in the index can be accessed."""
1126
 
        for index in self._indices:
1127
 
            index.validate()
 
1591
        while True:
 
1592
            try:
 
1593
                for index in self._indices:
 
1594
                    index.validate()
 
1595
                return
 
1596
            except errors.NoSuchFile:
 
1597
                self._reload_or_raise()
1128
1598
 
1129
1599
 
1130
1600
class InMemoryGraphIndex(GraphIndexBuilder):
1174
1644
            defined order for the result iteration - it will be in the most
1175
1645
            efficient order for the index (keys iteration order in this case).
1176
1646
        """
1177
 
        keys = set(keys)
 
1647
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
 
1648
        #       aren't using set().intersection() here
 
1649
        nodes = self._nodes
 
1650
        keys = [key for key in keys if key in nodes]
1178
1651
        if self.reference_lists:
1179
 
            for key in keys.intersection(self._keys):
1180
 
                node = self._nodes[key]
 
1652
            for key in keys:
 
1653
                node = nodes[key]
1181
1654
                if not node[0]:
1182
1655
                    yield self, key, node[2], node[1]
1183
1656
        else:
1184
 
            for key in keys.intersection(self._keys):
1185
 
                node = self._nodes[key]
 
1657
            for key in keys:
 
1658
                node = nodes[key]
1186
1659
                if not node[0]:
1187
1660
                    yield self, key, node[2]
1188
1661
 
1217
1690
                    raise errors.BadIndexKey(key)
1218
1691
                node = self._nodes[key]
1219
1692
                if node[0]:
1220
 
                    continue 
 
1693
                    continue
1221
1694
                if self.reference_lists:
1222
1695
                    yield self, key, node[2], node[1]
1223
1696
                else:
1224
1697
                    yield self, key, node[2]
1225
1698
            return
 
1699
        nodes_by_key = self._get_nodes_by_key()
1226
1700
        for key in keys:
1227
1701
            # sanity check
1228
1702
            if key[0] is None:
1230
1704
            if len(key) != self._key_length:
1231
1705
                raise errors.BadIndexKey(key)
1232
1706
            # find what it refers to:
1233
 
            key_dict = self._nodes_by_key
 
1707
            key_dict = nodes_by_key
1234
1708
            elements = list(key)
1235
1709
            # find the subdict to return
1236
1710
            try:
1247
1721
                    # can't be empty or would not exist
1248
1722
                    item, value = key_dict.iteritems().next()
1249
1723
                    if type(value) == dict:
1250
 
                        # push keys 
 
1724
                        # push keys
1251
1725
                        dicts.extend(key_dict.itervalues())
1252
1726
                    else:
1253
1727
                        # yield keys
1258
1732
 
1259
1733
    def key_count(self):
1260
1734
        """Return an estimate of the number of keys in this index.
1261
 
        
 
1735
 
1262
1736
        For InMemoryGraphIndex the estimate is exact.
1263
1737
        """
1264
 
        return len(self._keys)
 
1738
        return len(self._nodes) - len(self._absent_keys)
1265
1739
 
1266
1740
    def validate(self):
1267
1741
        """In memory index's have no known corruption at the moment."""
1272
1746
 
1273
1747
    Queries against this will emit queries against the adapted Graph with the
1274
1748
    prefix added, queries for all items use iter_entries_prefix. The returned
1275
 
    nodes will have their keys and node references adjusted to remove the 
 
1749
    nodes will have their keys and node references adjusted to remove the
1276
1750
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1277
1751
    nodes and references being added will have prefix prepended.
1278
1752
    """
1305
1779
                    adjusted_references))
1306
1780
        except ValueError:
1307
1781
            # XXX: TODO add an explicit interface for getting the reference list
1308
 
            # status, to handle this bit of user-friendliness in the API more 
 
1782
            # status, to handle this bit of user-friendliness in the API more
1309
1783
            # explicitly.
1310
1784
            for (key, value) in nodes:
1311
1785
                translated_nodes.append((self.prefix + key, value))
1383
1857
 
1384
1858
    def key_count(self):
1385
1859
        """Return an estimate of the number of keys in this index.
1386
 
        
 
1860
 
1387
1861
        For GraphIndexPrefixAdapter this is relatively expensive - key
1388
1862
        iteration with the prefix is done.
1389
1863
        """