~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: John Arbash Meinel
  • Date: 2009-08-25 18:45:40 UTC
  • mto: (4634.6.15 2.0)
  • mto: This revision was merged to the branch mainline in revision 4667.
  • Revision ID: john@arbash-meinel.com-20090825184540-6dn3xjq62xhgj2gq
Add support for skipping ghost nodes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007, 2008 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
 
24
24
    'InMemoryGraphIndex',
25
25
    ]
26
26
 
 
27
from bisect import bisect_right
27
28
from cStringIO import StringIO
28
29
import re
 
30
import sys
29
31
 
30
32
from bzrlib.lazy_import import lazy_import
31
33
lazy_import(globals(), """
32
34
from bzrlib import trace
 
35
from bzrlib.bisect_multi import bisect_multi_bytes
 
36
from bzrlib.revision import NULL_REVISION
33
37
from bzrlib.trace import mutter
34
38
""")
35
 
from bzrlib import debug, errors
 
39
from bzrlib import (
 
40
    debug,
 
41
    errors,
 
42
    )
36
43
 
 
44
_HEADER_READV = (0, 200)
37
45
_OPTION_KEY_ELEMENTS = "key_elements="
38
46
_OPTION_LEN = "len="
39
47
_OPTION_NODE_REFS = "node_ref_lists="
44
52
_newline_null_re = re.compile('[\n\0]')
45
53
 
46
54
 
 
55
def _has_key_from_parent_map(self, key):
 
56
    """Check if this index has one key.
 
57
 
 
58
    If it's possible to check for multiple keys at once through
 
59
    calling get_parent_map that should be faster.
 
60
    """
 
61
    return (key in self.get_parent_map([key]))
 
62
 
 
63
 
 
64
def _missing_keys_from_parent_map(self, keys):
 
65
    return set(keys) - set(self.get_parent_map(keys))
 
66
 
 
67
 
47
68
class GraphIndexBuilder(object):
48
69
    """A builder that can build a GraphIndex.
49
 
    
 
70
 
50
71
    The resulting graph has the structure:
51
 
    
 
72
 
52
73
    _SIGNATURE OPTIONS NODES NEWLINE
53
74
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
54
75
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
72
93
        """
73
94
        self.reference_lists = reference_lists
74
95
        self._keys = set()
 
96
        # A dict of {key: (absent, ref_lists, value)}
75
97
        self._nodes = {}
76
 
        self._nodes_by_key = {}
 
98
        self._nodes_by_key = None
77
99
        self._key_length = key_elements
 
100
        self._optimize_for_size = False
 
101
        self._combine_backing_indices = True
78
102
 
79
103
    def _check_key(self, key):
80
104
        """Raise BadIndexKey if key is not a valid key for this index."""
86
110
            if not element or _whitespace_re.search(element) is not None:
87
111
                raise errors.BadIndexKey(element)
88
112
 
89
 
    def add_node(self, key, value, references=()):
90
 
        """Add a node to the index.
91
 
 
92
 
        :param key: The key. keys are non-empty tuples containing
93
 
            as many whitespace-free utf8 bytestrings as the key length
94
 
            defined for this index.
95
 
        :param references: An iterable of iterables of keys. Each is a
96
 
            reference to another key.
97
 
        :param value: The value to associate with the key. It may be any
98
 
            bytes as long as it does not contain \0 or \n.
 
113
    def _external_references(self):
 
114
        """Return references that are not present in this index.
 
115
        """
 
116
        keys = set()
 
117
        refs = set()
 
118
        # TODO: JAM 2008-11-21 This makes an assumption about how the reference
 
119
        #       lists are used. It is currently correct for pack-0.92 through
 
120
        #       1.9, which use the node references (3rd column) second
 
121
        #       reference list as the compression parent. Perhaps this should
 
122
        #       be moved into something higher up the stack, since it
 
123
        #       makes assumptions about how the index is used.
 
124
        if self.reference_lists > 1:
 
125
            for node in self.iter_all_entries():
 
126
                keys.add(node[1])
 
127
                refs.update(node[3][1])
 
128
            return refs - keys
 
129
        else:
 
130
            # If reference_lists == 0 there can be no external references, and
 
131
            # if reference_lists == 1, then there isn't a place to store the
 
132
            # compression parent
 
133
            return set()
 
134
 
 
135
    def _get_nodes_by_key(self):
 
136
        if self._nodes_by_key is None:
 
137
            nodes_by_key = {}
 
138
            if self.reference_lists:
 
139
                for key, (absent, references, value) in self._nodes.iteritems():
 
140
                    if absent:
 
141
                        continue
 
142
                    key_dict = nodes_by_key
 
143
                    for subkey in key[:-1]:
 
144
                        key_dict = key_dict.setdefault(subkey, {})
 
145
                    key_dict[key[-1]] = key, value, references
 
146
            else:
 
147
                for key, (absent, references, value) in self._nodes.iteritems():
 
148
                    if absent:
 
149
                        continue
 
150
                    key_dict = nodes_by_key
 
151
                    for subkey in key[:-1]:
 
152
                        key_dict = key_dict.setdefault(subkey, {})
 
153
                    key_dict[key[-1]] = key, value
 
154
            self._nodes_by_key = nodes_by_key
 
155
        return self._nodes_by_key
 
156
 
 
157
    def _update_nodes_by_key(self, key, value, node_refs):
 
158
        """Update the _nodes_by_key dict with a new key.
 
159
 
 
160
        For a key of (foo, bar, baz) create
 
161
        _nodes_by_key[foo][bar][baz] = key_value
 
162
        """
 
163
        if self._nodes_by_key is None:
 
164
            return
 
165
        key_dict = self._nodes_by_key
 
166
        if self.reference_lists:
 
167
            key_value = key, value, node_refs
 
168
        else:
 
169
            key_value = key, value
 
170
        for subkey in key[:-1]:
 
171
            key_dict = key_dict.setdefault(subkey, {})
 
172
        key_dict[key[-1]] = key_value
 
173
 
 
174
    def _check_key_ref_value(self, key, references, value):
 
175
        """Check that 'key' and 'references' are all valid.
 
176
 
 
177
        :param key: A key tuple. Must conform to the key interface (be a tuple,
 
178
            be of the right length, not have any whitespace or nulls in any key
 
179
            element.)
 
180
        :param references: An iterable of reference lists. Something like
 
181
            [[(ref, key)], [(ref, key), (other, key)]]
 
182
        :param value: The value associate with this key. Must not contain
 
183
            newlines or null characters.
 
184
        :return: (node_refs, absent_references)
 
185
            node_refs   basically a packed form of 'references' where all
 
186
                        iterables are tuples
 
187
            absent_references   reference keys that are not in self._nodes.
 
188
                                This may contain duplicates if the same key is
 
189
                                referenced in multiple lists.
99
190
        """
100
191
        self._check_key(key)
101
192
        if _newline_null_re.search(value) is not None:
103
194
        if len(references) != self.reference_lists:
104
195
            raise errors.BadIndexValue(references)
105
196
        node_refs = []
 
197
        absent_references = []
106
198
        for reference_list in references:
107
199
            for reference in reference_list:
108
 
                self._check_key(reference)
 
200
                # If reference *is* in self._nodes, then we know it has already
 
201
                # been checked.
109
202
                if reference not in self._nodes:
110
 
                    self._nodes[reference] = ('a', (), '')
 
203
                    self._check_key(reference)
 
204
                    absent_references.append(reference)
111
205
            node_refs.append(tuple(reference_list))
112
 
        if key in self._nodes and self._nodes[key][0] == '':
 
206
        return tuple(node_refs), absent_references
 
207
 
 
208
    def add_node(self, key, value, references=()):
 
209
        """Add a node to the index.
 
210
 
 
211
        :param key: The key. keys are non-empty tuples containing
 
212
            as many whitespace-free utf8 bytestrings as the key length
 
213
            defined for this index.
 
214
        :param references: An iterable of iterables of keys. Each is a
 
215
            reference to another key.
 
216
        :param value: The value to associate with the key. It may be any
 
217
            bytes as long as it does not contain \0 or \n.
 
218
        """
 
219
        (node_refs,
 
220
         absent_references) = self._check_key_ref_value(key, references, value)
 
221
        if key in self._nodes and self._nodes[key][0] != 'a':
113
222
            raise errors.BadIndexDuplicateKey(key, self)
114
 
        self._nodes[key] = ('', tuple(node_refs), value)
 
223
        for reference in absent_references:
 
224
            # There may be duplicates, but I don't think it is worth worrying
 
225
            # about
 
226
            self._nodes[reference] = ('a', (), '')
 
227
        self._nodes[key] = ('', node_refs, value)
115
228
        self._keys.add(key)
116
 
        if self._key_length > 1:
117
 
            key_dict = self._nodes_by_key
118
 
            if self.reference_lists:
119
 
                key_value = key, value, tuple(node_refs)
120
 
            else:
121
 
                key_value = key, value
122
 
            # possibly should do this on-demand, but it seems likely it is 
123
 
            # always wanted
124
 
            # For a key of (foo, bar, baz) create
125
 
            # _nodes_by_key[foo][bar][baz] = key_value
126
 
            for subkey in key[:-1]:
127
 
                key_dict = key_dict.setdefault(subkey, {})
128
 
            key_dict[key[-1]] = key_value
 
229
        if self._nodes_by_key is not None and self._key_length > 1:
 
230
            self._update_nodes_by_key(key, value, node_refs)
129
231
 
130
232
    def finish(self):
131
233
        lines = [_SIGNATURE]
134
236
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
135
237
        prefix_length = sum(len(x) for x in lines)
136
238
        # references are byte offsets. To avoid having to do nasty
137
 
        # polynomial work to resolve offsets (references to later in the 
 
239
        # polynomial work to resolve offsets (references to later in the
138
240
        # file cannot be determined until all the inbetween references have
139
241
        # been calculated too) we pad the offsets with 0's to make them be
140
242
        # of consistent length. Using binary offsets would break the trivial
144
246
        # one to pad all the data with reference-length and determine entry
145
247
        # addresses.
146
248
        # One to serialise.
147
 
        
 
249
 
148
250
        # forward sorted by key. In future we may consider topological sorting,
149
251
        # at the cost of table scans for direct lookup, or a second index for
150
252
        # direct lookup
211
313
            raise errors.BzrError('Failed index creation. Internal error:'
212
314
                ' mismatched output length and expected length: %d %d' %
213
315
                (len(result.getvalue()), expected_bytes))
214
 
        return StringIO(''.join(lines))
 
316
        return result
 
317
 
 
318
    def set_optimize(self, for_size=None, combine_backing_indices=None):
 
319
        """Change how the builder tries to optimize the result.
 
320
 
 
321
        :param for_size: Tell the builder to try and make the index as small as
 
322
            possible.
 
323
        :param combine_backing_indices: If the builder spills to disk to save
 
324
            memory, should the on-disk indices be combined. Set to True if you
 
325
            are going to be probing the index, but to False if you are not. (If
 
326
            you are not querying, then the time spent combining is wasted.)
 
327
        :return: None
 
328
        """
 
329
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
 
330
        # other builders do.
 
331
        if for_size is not None:
 
332
            self._optimize_for_size = for_size
 
333
        if combine_backing_indices is not None:
 
334
            self._combine_backing_indices = combine_backing_indices
 
335
 
 
336
    def find_ancestry(self, keys, ref_list_num):
 
337
        """See CombinedGraphIndex.find_ancestry()"""
 
338
        pending = set(keys)
 
339
        parent_map = {}
 
340
        missing_keys = set()
 
341
        while pending:
 
342
            next_pending = set()
 
343
            for _, key, value, ref_lists in self.iter_entries(pending):
 
344
                parent_keys = ref_lists[ref_list_num]
 
345
                parent_map[key] = parent_keys
 
346
                next_pending.update([p for p in parent_keys if p not in
 
347
                                     parent_map])
 
348
                missing_keys.update(pending.difference(parent_map))
 
349
            pending = next_pending
 
350
        return parent_map, missing_keys
215
351
 
216
352
 
217
353
class GraphIndex(object):
218
354
    """An index for data with embedded graphs.
219
 
 
 
355
 
220
356
    The index maps keys to a list of key reference lists, and a value.
221
357
    Each node has the same number of key reference lists. Each key reference
222
358
    list can be empty or an arbitrary length. The value is an opaque NULL
223
 
    terminated string without any newlines. The storage of the index is 
 
359
    terminated string without any newlines. The storage of the index is
224
360
    hidden in the interface: keys and key references are always tuples of
225
361
    bytestrings, never the internal representation (e.g. dictionary offsets).
226
362
 
232
368
    suitable for production use. :XXX
233
369
    """
234
370
 
235
 
    def __init__(self, transport, name):
 
371
    def __init__(self, transport, name, size):
236
372
        """Open an index called name on transport.
237
373
 
238
374
        :param transport: A bzrlib.transport.Transport.
239
375
        :param name: A path to provide to transport API calls.
 
376
        :param size: The size of the index in bytes. This is used for bisection
 
377
            logic to perform partial index reads. While the size could be
 
378
            obtained by statting the file this introduced an additional round
 
379
            trip as well as requiring stat'able transports, both of which are
 
380
            avoided by having it supplied. If size is None, then bisection
 
381
            support will be disabled and accessing the index will just stream
 
382
            all the data.
240
383
        """
241
384
        self._transport = transport
242
385
        self._name = name
 
386
        # Becomes a dict of key:(value, reference-list-byte-locations) used by
 
387
        # the bisection interface to store parsed but not resolved keys.
 
388
        self._bisect_nodes = None
 
389
        # Becomes a dict of key:(value, reference-list-keys) which are ready to
 
390
        # be returned directly to callers.
243
391
        self._nodes = None
 
392
        # a sorted list of slice-addresses for the parsed bytes of the file.
 
393
        # e.g. (0,1) would mean that byte 0 is parsed.
 
394
        self._parsed_byte_map = []
 
395
        # a sorted list of keys matching each slice address for parsed bytes
 
396
        # e.g. (None, 'foo@bar') would mean that the first byte contained no
 
397
        # key, and the end byte of the slice is the of the data for 'foo@bar'
 
398
        self._parsed_key_map = []
244
399
        self._key_count = None
245
400
        self._keys_by_offset = None
246
401
        self._nodes_by_key = None
247
 
 
248
 
    def _buffer_all(self):
 
402
        self._size = size
 
403
        # The number of bytes we've read so far in trying to process this file
 
404
        self._bytes_read = 0
 
405
 
 
406
    def __eq__(self, other):
 
407
        """Equal when self and other were created with the same parameters."""
 
408
        return (
 
409
            type(self) == type(other) and
 
410
            self._transport == other._transport and
 
411
            self._name == other._name and
 
412
            self._size == other._size)
 
413
 
 
414
    def __ne__(self, other):
 
415
        return not self.__eq__(other)
 
416
 
 
417
    def __repr__(self):
 
418
        return "%s(%r)" % (self.__class__.__name__,
 
419
            self._transport.abspath(self._name))
 
420
 
 
421
    def _buffer_all(self, stream=None):
249
422
        """Buffer all the index data.
250
423
 
251
424
        Mutates self._nodes and self.keys_by_offset.
252
425
        """
 
426
        if self._nodes is not None:
 
427
            # We already did this
 
428
            return
253
429
        if 'index' in debug.debug_flags:
254
430
            mutter('Reading entire index %s', self._transport.abspath(self._name))
255
 
        stream = self._transport.get(self._name)
 
431
        if stream is None:
 
432
            stream = self._transport.get(self._name)
256
433
        self._read_prefix(stream)
257
 
        expected_elements = 3 + self._key_length
 
434
        self._expected_elements = 3 + self._key_length
258
435
        line_count = 0
259
436
        # raw data keyed by offset
260
437
        self._keys_by_offset = {}
261
438
        # ready-to-return key:value or key:value, node_ref_lists
262
439
        self._nodes = {}
263
 
        self._nodes_by_key = {}
 
440
        self._nodes_by_key = None
264
441
        trailers = 0
265
442
        pos = stream.tell()
266
 
        for line in stream.readlines():
267
 
            if line == '\n':
268
 
                trailers += 1
269
 
                continue
270
 
            elements = line.split('\0')
271
 
            if len(elements) != expected_elements:
272
 
                raise errors.BadIndexData(self)
273
 
            # keys are tuples
274
 
            key = tuple(elements[:self._key_length])
275
 
            absent, references, value = elements[-3:]
276
 
            value = value[:-1] # remove the newline
277
 
            ref_lists = []
278
 
            for ref_string in references.split('\t'):
279
 
                ref_lists.append(tuple([
280
 
                    int(ref) for ref in ref_string.split('\r') if ref
281
 
                    ]))
282
 
            ref_lists = tuple(ref_lists)
283
 
            self._keys_by_offset[pos] = (key, absent, ref_lists, value)
284
 
            pos += len(line)
 
443
        lines = stream.read().split('\n')
 
444
        del lines[-1]
 
445
        _, _, _, trailers = self._parse_lines(lines, pos)
285
446
        for key, absent, references, value in self._keys_by_offset.itervalues():
286
447
            if absent:
287
448
                continue
288
449
            # resolve references:
289
450
            if self.node_ref_lists:
290
 
                node_refs = []
291
 
                for ref_list in references:
292
 
                    node_refs.append(tuple([self._keys_by_offset[ref][0] for ref in ref_list]))
293
 
                node_value = (value, tuple(node_refs))
 
451
                node_value = (value, self._resolve_references(references))
294
452
            else:
295
453
                node_value = value
296
454
            self._nodes[key] = node_value
297
 
            if self._key_length > 1:
298
 
                subkey = list(reversed(key[:-1]))
299
 
                key_dict = self._nodes_by_key
300
 
                if self.node_ref_lists:
301
 
                    key_value = key, node_value[0], node_value[1]
302
 
                else:
303
 
                    key_value = key, node_value
304
 
                # possibly should do this on-demand, but it seems likely it is 
305
 
                # always wanted
306
 
                # For a key of (foo, bar, baz) create
307
 
                # _nodes_by_key[foo][bar][baz] = key_value
308
 
                for subkey in key[:-1]:
309
 
                    key_dict = key_dict.setdefault(subkey, {})
310
 
                key_dict[key[-1]] = key_value
311
455
        # cache the keys for quick set intersections
312
456
        self._keys = set(self._nodes)
313
457
        if trailers != 1:
314
458
            # there must be one line - the empty trailer line.
315
459
            raise errors.BadIndexData(self)
316
460
 
 
461
    def external_references(self, ref_list_num):
 
462
        """Return references that are not present in this index.
 
463
        """
 
464
        self._buffer_all()
 
465
        if ref_list_num + 1 > self.node_ref_lists:
 
466
            raise ValueError('No ref list %d, index has %d ref lists'
 
467
                % (ref_list_num, self.node_ref_lists))
 
468
        refs = set()
 
469
        for key, (value, ref_lists) in self._nodes.iteritems():
 
470
            ref_list = ref_lists[ref_list_num]
 
471
            refs.update(ref_list)
 
472
        return refs - self._keys
 
473
 
 
474
    def _get_nodes_by_key(self):
 
475
        if self._nodes_by_key is None:
 
476
            nodes_by_key = {}
 
477
            if self.node_ref_lists:
 
478
                for key, (value, references) in self._nodes.iteritems():
 
479
                    key_dict = nodes_by_key
 
480
                    for subkey in key[:-1]:
 
481
                        key_dict = key_dict.setdefault(subkey, {})
 
482
                    key_dict[key[-1]] = key, value, references
 
483
            else:
 
484
                for key, value in self._nodes.iteritems():
 
485
                    key_dict = nodes_by_key
 
486
                    for subkey in key[:-1]:
 
487
                        key_dict = key_dict.setdefault(subkey, {})
 
488
                    key_dict[key[-1]] = key, value
 
489
            self._nodes_by_key = nodes_by_key
 
490
        return self._nodes_by_key
 
491
 
317
492
    def iter_all_entries(self):
318
493
        """Iterate over all keys within the index.
319
494
 
320
 
        :return: An iterable of (key, value) or (key, value, reference_lists).
 
495
        :return: An iterable of (index, key, value) or (index, key, value, reference_lists).
321
496
            The former tuple is used when there are no reference lists in the
322
497
            index, making the API compatible with simple key:value index types.
323
498
            There is no defined order for the result iteration - it will be in
324
499
            the most efficient order for the index.
325
500
        """
326
501
        if 'evil' in debug.debug_flags:
327
 
            trace.mutter_callsite(2,
 
502
            trace.mutter_callsite(3,
328
503
                "iter_all_entries scales with size of history.")
329
504
        if self._nodes is None:
330
505
            self._buffer_all()
361
536
        except ValueError:
362
537
            raise errors.BadIndexOptions(self)
363
538
 
364
 
    def iter_entries(self, keys):
365
 
        """Iterate over keys within the index.
366
 
 
367
 
        :param keys: An iterable providing the keys to be retrieved.
368
 
        :return: An iterable as per iter_all_entries, but restricted to the
369
 
            keys supplied. No additional keys will be returned, and every
370
 
            key supplied that is in the index will be returned.
371
 
        """
372
 
        keys = set(keys)
373
 
        if not keys:
374
 
            return
375
 
        if self._nodes is None:
376
 
            self._buffer_all()
 
539
    def _resolve_references(self, references):
 
540
        """Return the resolved key references for references.
 
541
 
 
542
        References are resolved by looking up the location of the key in the
 
543
        _keys_by_offset map and substituting the key name, preserving ordering.
 
544
 
 
545
        :param references: An iterable of iterables of key locations. e.g.
 
546
            [[123, 456], [123]]
 
547
        :return: A tuple of tuples of keys.
 
548
        """
 
549
        node_refs = []
 
550
        for ref_list in references:
 
551
            node_refs.append(tuple([self._keys_by_offset[ref][0] for ref in ref_list]))
 
552
        return tuple(node_refs)
 
553
 
 
554
    def _find_index(self, range_map, key):
 
555
        """Helper for the _parsed_*_index calls.
 
556
 
 
557
        Given a range map - [(start, end), ...], finds the index of the range
 
558
        in the map for key if it is in the map, and if it is not there, the
 
559
        immediately preceeding range in the map.
 
560
        """
 
561
        result = bisect_right(range_map, key) - 1
 
562
        if result + 1 < len(range_map):
 
563
            # check the border condition, it may be in result + 1
 
564
            if range_map[result + 1][0] == key[0]:
 
565
                return result + 1
 
566
        return result
 
567
 
 
568
    def _parsed_byte_index(self, offset):
 
569
        """Return the index of the entry immediately before offset.
 
570
 
 
571
        e.g. if the parsed map has regions 0,10 and 11,12 parsed, meaning that
 
572
        there is one unparsed byte (the 11th, addressed as[10]). then:
 
573
        asking for 0 will return 0
 
574
        asking for 10 will return 0
 
575
        asking for 11 will return 1
 
576
        asking for 12 will return 1
 
577
        """
 
578
        key = (offset, 0)
 
579
        return self._find_index(self._parsed_byte_map, key)
 
580
 
 
581
    def _parsed_key_index(self, key):
 
582
        """Return the index of the entry immediately before key.
 
583
 
 
584
        e.g. if the parsed map has regions (None, 'a') and ('b','c') parsed,
 
585
        meaning that keys from None to 'a' inclusive, and 'b' to 'c' inclusive
 
586
        have been parsed, then:
 
587
        asking for '' will return 0
 
588
        asking for 'a' will return 0
 
589
        asking for 'b' will return 1
 
590
        asking for 'e' will return 1
 
591
        """
 
592
        search_key = (key, None)
 
593
        return self._find_index(self._parsed_key_map, search_key)
 
594
 
 
595
    def _is_parsed(self, offset):
 
596
        """Returns True if offset has been parsed."""
 
597
        index = self._parsed_byte_index(offset)
 
598
        if index == len(self._parsed_byte_map):
 
599
            return offset < self._parsed_byte_map[index - 1][1]
 
600
        start, end = self._parsed_byte_map[index]
 
601
        return offset >= start and offset < end
 
602
 
 
603
    def _iter_entries_from_total_buffer(self, keys):
 
604
        """Iterate over keys when the entire index is parsed."""
377
605
        keys = keys.intersection(self._keys)
378
606
        if self.node_ref_lists:
379
607
            for key in keys:
383
611
            for key in keys:
384
612
                yield self, key, self._nodes[key]
385
613
 
 
614
    def iter_entries(self, keys):
 
615
        """Iterate over keys within the index.
 
616
 
 
617
        :param keys: An iterable providing the keys to be retrieved.
 
618
        :return: An iterable as per iter_all_entries, but restricted to the
 
619
            keys supplied. No additional keys will be returned, and every
 
620
            key supplied that is in the index will be returned.
 
621
        """
 
622
        keys = set(keys)
 
623
        if not keys:
 
624
            return []
 
625
        if self._size is None and self._nodes is None:
 
626
            self._buffer_all()
 
627
 
 
628
        # We fit about 20 keys per minimum-read (4K), so if we are looking for
 
629
        # more than 1/20th of the index its likely (assuming homogenous key
 
630
        # spread) that we'll read the entire index. If we're going to do that,
 
631
        # buffer the whole thing. A better analysis might take key spread into
 
632
        # account - but B+Tree indices are better anyway.
 
633
        # We could look at all data read, and use a threshold there, which will
 
634
        # trigger on ancestry walks, but that is not yet fully mapped out.
 
635
        if self._nodes is None and len(keys) * 20 > self.key_count():
 
636
            self._buffer_all()
 
637
        if self._nodes is not None:
 
638
            return self._iter_entries_from_total_buffer(keys)
 
639
        else:
 
640
            return (result[1] for result in bisect_multi_bytes(
 
641
                self._lookup_keys_via_location, self._size, keys))
 
642
 
386
643
    def iter_entries_prefix(self, keys):
387
644
        """Iterate over keys within the index using prefix matching.
388
645
 
391
648
        'bar'), ('foobar', 'gam') and do a prefix search for ('foo', None) then
392
649
        only the former key is returned.
393
650
 
 
651
        WARNING: Note that this method currently causes a full index parse
 
652
        unconditionally (which is reasonably appropriate as it is a means for
 
653
        thunking many small indices into one larger one and still supplies
 
654
        iter_all_entries at the thunk layer).
 
655
 
394
656
        :param keys: An iterable providing the key prefixes to be retrieved.
395
657
            Each key prefix takes the form of a tuple the length of a key, but
396
658
            with the last N elements 'None' rather than a regular bytestring.
419
681
                else:
420
682
                    yield self, key, self._nodes[key]
421
683
            return
 
684
        nodes_by_key = self._get_nodes_by_key()
422
685
        for key in keys:
423
686
            # sanity check
424
687
            if key[0] is None:
426
689
            if len(key) != self._key_length:
427
690
                raise errors.BadIndexKey(key)
428
691
            # find what it refers to:
429
 
            key_dict = self._nodes_by_key
 
692
            key_dict = nodes_by_key
430
693
            elements = list(key)
431
694
            # find the subdict whose contents should be returned.
432
695
            try:
443
706
                    # can't be empty or would not exist
444
707
                    item, value = key_dict.iteritems().next()
445
708
                    if type(value) == dict:
446
 
                        # push keys 
 
709
                        # push keys
447
710
                        dicts.extend(key_dict.itervalues())
448
711
                    else:
449
712
                        # yield keys
455
718
                # the last thing looked up was a terminal element
456
719
                yield (self, ) + key_dict
457
720
 
 
721
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
 
722
        """See BTreeIndex._find_ancestors."""
 
723
        # The api can be implemented as a trivial overlay on top of
 
724
        # iter_entries, it is not an efficient implementation, but it at least
 
725
        # gets the job done.
 
726
        found_keys = set()
 
727
        search_keys = set()
 
728
        for index, key, value, refs in self.iter_entries(keys):
 
729
            parent_keys = refs[ref_list_num]
 
730
            found_keys.add(key)
 
731
            parent_map[key] = parent_keys
 
732
            search_keys.update(parent_keys)
 
733
        # Figure out what, if anything, was missing
 
734
        missing_keys.update(set(keys).difference(found_keys))
 
735
        search_keys = search_keys.difference(parent_map)
 
736
        return search_keys
 
737
 
458
738
    def key_count(self):
459
739
        """Return an estimate of the number of keys in this index.
460
 
        
 
740
 
461
741
        For GraphIndex the estimate is exact.
462
742
        """
463
743
        if self._key_count is None:
464
 
            # really this should just read the prefix
465
 
            self._buffer_all()
 
744
            self._read_and_parse([_HEADER_READV])
466
745
        return self._key_count
467
746
 
 
747
    def _lookup_keys_via_location(self, location_keys):
 
748
        """Public interface for implementing bisection.
 
749
 
 
750
        If _buffer_all has been called, then all the data for the index is in
 
751
        memory, and this method should not be called, as it uses a separate
 
752
        cache because it cannot pre-resolve all indices, which buffer_all does
 
753
        for performance.
 
754
 
 
755
        :param location_keys: A list of location(byte offset), key tuples.
 
756
        :return: A list of (location_key, result) tuples as expected by
 
757
            bzrlib.bisect_multi.bisect_multi_bytes.
 
758
        """
 
759
        # Possible improvements:
 
760
        #  - only bisect lookup each key once
 
761
        #  - sort the keys first, and use that to reduce the bisection window
 
762
        # -----
 
763
        # this progresses in three parts:
 
764
        # read data
 
765
        # parse it
 
766
        # attempt to answer the question from the now in memory data.
 
767
        # build the readv request
 
768
        # for each location, ask for 800 bytes - much more than rows we've seen
 
769
        # anywhere.
 
770
        readv_ranges = []
 
771
        for location, key in location_keys:
 
772
            # can we answer from cache?
 
773
            if self._bisect_nodes and key in self._bisect_nodes:
 
774
                # We have the key parsed.
 
775
                continue
 
776
            index = self._parsed_key_index(key)
 
777
            if (len(self._parsed_key_map) and
 
778
                self._parsed_key_map[index][0] <= key and
 
779
                (self._parsed_key_map[index][1] >= key or
 
780
                 # end of the file has been parsed
 
781
                 self._parsed_byte_map[index][1] == self._size)):
 
782
                # the key has been parsed, so no lookup is needed even if its
 
783
                # not present.
 
784
                continue
 
785
            # - if we have examined this part of the file already - yes
 
786
            index = self._parsed_byte_index(location)
 
787
            if (len(self._parsed_byte_map) and
 
788
                self._parsed_byte_map[index][0] <= location and
 
789
                self._parsed_byte_map[index][1] > location):
 
790
                # the byte region has been parsed, so no read is needed.
 
791
                continue
 
792
            length = 800
 
793
            if location + length > self._size:
 
794
                length = self._size - location
 
795
            # todo, trim out parsed locations.
 
796
            if length > 0:
 
797
                readv_ranges.append((location, length))
 
798
        # read the header if needed
 
799
        if self._bisect_nodes is None:
 
800
            readv_ranges.append(_HEADER_READV)
 
801
        self._read_and_parse(readv_ranges)
 
802
        result = []
 
803
        if self._nodes is not None:
 
804
            # _read_and_parse triggered a _buffer_all because we requested the
 
805
            # whole data range
 
806
            for location, key in location_keys:
 
807
                if key not in self._nodes: # not present
 
808
                    result.append(((location, key), False))
 
809
                elif self.node_ref_lists:
 
810
                    value, refs = self._nodes[key]
 
811
                    result.append(((location, key),
 
812
                        (self, key, value, refs)))
 
813
                else:
 
814
                    result.append(((location, key),
 
815
                        (self, key, self._nodes[key])))
 
816
            return result
 
817
        # generate results:
 
818
        #  - figure out <, >, missing, present
 
819
        #  - result present references so we can return them.
 
820
        # keys that we cannot answer until we resolve references
 
821
        pending_references = []
 
822
        pending_locations = set()
 
823
        for location, key in location_keys:
 
824
            # can we answer from cache?
 
825
            if key in self._bisect_nodes:
 
826
                # the key has been parsed, so no lookup is needed
 
827
                if self.node_ref_lists:
 
828
                    # the references may not have been all parsed.
 
829
                    value, refs = self._bisect_nodes[key]
 
830
                    wanted_locations = []
 
831
                    for ref_list in refs:
 
832
                        for ref in ref_list:
 
833
                            if ref not in self._keys_by_offset:
 
834
                                wanted_locations.append(ref)
 
835
                    if wanted_locations:
 
836
                        pending_locations.update(wanted_locations)
 
837
                        pending_references.append((location, key))
 
838
                        continue
 
839
                    result.append(((location, key), (self, key,
 
840
                        value, self._resolve_references(refs))))
 
841
                else:
 
842
                    result.append(((location, key),
 
843
                        (self, key, self._bisect_nodes[key])))
 
844
                continue
 
845
            else:
 
846
                # has the region the key should be in, been parsed?
 
847
                index = self._parsed_key_index(key)
 
848
                if (self._parsed_key_map[index][0] <= key and
 
849
                    (self._parsed_key_map[index][1] >= key or
 
850
                     # end of the file has been parsed
 
851
                     self._parsed_byte_map[index][1] == self._size)):
 
852
                    result.append(((location, key), False))
 
853
                    continue
 
854
            # no, is the key above or below the probed location:
 
855
            # get the range of the probed & parsed location
 
856
            index = self._parsed_byte_index(location)
 
857
            # if the key is below the start of the range, its below
 
858
            if key < self._parsed_key_map[index][0]:
 
859
                direction = -1
 
860
            else:
 
861
                direction = +1
 
862
            result.append(((location, key), direction))
 
863
        readv_ranges = []
 
864
        # lookup data to resolve references
 
865
        for location in pending_locations:
 
866
            length = 800
 
867
            if location + length > self._size:
 
868
                length = self._size - location
 
869
            # TODO: trim out parsed locations (e.g. if the 800 is into the
 
870
            # parsed region trim it, and dont use the adjust_for_latency
 
871
            # facility)
 
872
            if length > 0:
 
873
                readv_ranges.append((location, length))
 
874
        self._read_and_parse(readv_ranges)
 
875
        if self._nodes is not None:
 
876
            # The _read_and_parse triggered a _buffer_all, grab the data and
 
877
            # return it
 
878
            for location, key in pending_references:
 
879
                value, refs = self._nodes[key]
 
880
                result.append(((location, key), (self, key, value, refs)))
 
881
            return result
 
882
        for location, key in pending_references:
 
883
            # answer key references we had to look-up-late.
 
884
            value, refs = self._bisect_nodes[key]
 
885
            result.append(((location, key), (self, key,
 
886
                value, self._resolve_references(refs))))
 
887
        return result
 
888
 
 
889
    def _parse_header_from_bytes(self, bytes):
 
890
        """Parse the header from a region of bytes.
 
891
 
 
892
        :param bytes: The data to parse.
 
893
        :return: An offset, data tuple such as readv yields, for the unparsed
 
894
            data. (which may length 0).
 
895
        """
 
896
        signature = bytes[0:len(self._signature())]
 
897
        if not signature == self._signature():
 
898
            raise errors.BadIndexFormatSignature(self._name, GraphIndex)
 
899
        lines = bytes[len(self._signature()):].splitlines()
 
900
        options_line = lines[0]
 
901
        if not options_line.startswith(_OPTION_NODE_REFS):
 
902
            raise errors.BadIndexOptions(self)
 
903
        try:
 
904
            self.node_ref_lists = int(options_line[len(_OPTION_NODE_REFS):])
 
905
        except ValueError:
 
906
            raise errors.BadIndexOptions(self)
 
907
        options_line = lines[1]
 
908
        if not options_line.startswith(_OPTION_KEY_ELEMENTS):
 
909
            raise errors.BadIndexOptions(self)
 
910
        try:
 
911
            self._key_length = int(options_line[len(_OPTION_KEY_ELEMENTS):])
 
912
        except ValueError:
 
913
            raise errors.BadIndexOptions(self)
 
914
        options_line = lines[2]
 
915
        if not options_line.startswith(_OPTION_LEN):
 
916
            raise errors.BadIndexOptions(self)
 
917
        try:
 
918
            self._key_count = int(options_line[len(_OPTION_LEN):])
 
919
        except ValueError:
 
920
            raise errors.BadIndexOptions(self)
 
921
        # calculate the bytes we have processed
 
922
        header_end = (len(signature) + len(lines[0]) + len(lines[1]) +
 
923
            len(lines[2]) + 3)
 
924
        self._parsed_bytes(0, None, header_end, None)
 
925
        # setup parsing state
 
926
        self._expected_elements = 3 + self._key_length
 
927
        # raw data keyed by offset
 
928
        self._keys_by_offset = {}
 
929
        # keys with the value and node references
 
930
        self._bisect_nodes = {}
 
931
        return header_end, bytes[header_end:]
 
932
 
 
933
    def _parse_region(self, offset, data):
 
934
        """Parse node data returned from a readv operation.
 
935
 
 
936
        :param offset: The byte offset the data starts at.
 
937
        :param data: The data to parse.
 
938
        """
 
939
        # trim the data.
 
940
        # end first:
 
941
        end = offset + len(data)
 
942
        high_parsed = offset
 
943
        while True:
 
944
            # Trivial test - if the current index's end is within the
 
945
            # low-matching parsed range, we're done.
 
946
            index = self._parsed_byte_index(high_parsed)
 
947
            if end < self._parsed_byte_map[index][1]:
 
948
                return
 
949
            # print "[%d:%d]" % (offset, end), \
 
950
            #     self._parsed_byte_map[index:index + 2]
 
951
            high_parsed, last_segment = self._parse_segment(
 
952
                offset, data, end, index)
 
953
            if last_segment:
 
954
                return
 
955
 
 
956
    def _parse_segment(self, offset, data, end, index):
 
957
        """Parse one segment of data.
 
958
 
 
959
        :param offset: Where 'data' begins in the file.
 
960
        :param data: Some data to parse a segment of.
 
961
        :param end: Where data ends
 
962
        :param index: The current index into the parsed bytes map.
 
963
        :return: True if the parsed segment is the last possible one in the
 
964
            range of data.
 
965
        :return: high_parsed_byte, last_segment.
 
966
            high_parsed_byte is the location of the highest parsed byte in this
 
967
            segment, last_segment is True if the parsed segment is the last
 
968
            possible one in the data block.
 
969
        """
 
970
        # default is to use all data
 
971
        trim_end = None
 
972
        # accomodate overlap with data before this.
 
973
        if offset < self._parsed_byte_map[index][1]:
 
974
            # overlaps the lower parsed region
 
975
            # skip the parsed data
 
976
            trim_start = self._parsed_byte_map[index][1] - offset
 
977
            # don't trim the start for \n
 
978
            start_adjacent = True
 
979
        elif offset == self._parsed_byte_map[index][1]:
 
980
            # abuts the lower parsed region
 
981
            # use all data
 
982
            trim_start = None
 
983
            # do not trim anything
 
984
            start_adjacent = True
 
985
        else:
 
986
            # does not overlap the lower parsed region
 
987
            # use all data
 
988
            trim_start = None
 
989
            # but trim the leading \n
 
990
            start_adjacent = False
 
991
        if end == self._size:
 
992
            # lines up to the end of all data:
 
993
            # use it all
 
994
            trim_end = None
 
995
            # do not strip to the last \n
 
996
            end_adjacent = True
 
997
            last_segment = True
 
998
        elif index + 1 == len(self._parsed_byte_map):
 
999
            # at the end of the parsed data
 
1000
            # use it all
 
1001
            trim_end = None
 
1002
            # but strip to the last \n
 
1003
            end_adjacent = False
 
1004
            last_segment = True
 
1005
        elif end == self._parsed_byte_map[index + 1][0]:
 
1006
            # buts up against the next parsed region
 
1007
            # use it all
 
1008
            trim_end = None
 
1009
            # do not strip to the last \n
 
1010
            end_adjacent = True
 
1011
            last_segment = True
 
1012
        elif end > self._parsed_byte_map[index + 1][0]:
 
1013
            # overlaps into the next parsed region
 
1014
            # only consider the unparsed data
 
1015
            trim_end = self._parsed_byte_map[index + 1][0] - offset
 
1016
            # do not strip to the last \n as we know its an entire record
 
1017
            end_adjacent = True
 
1018
            last_segment = end < self._parsed_byte_map[index + 1][1]
 
1019
        else:
 
1020
            # does not overlap into the next region
 
1021
            # use it all
 
1022
            trim_end = None
 
1023
            # but strip to the last \n
 
1024
            end_adjacent = False
 
1025
            last_segment = True
 
1026
        # now find bytes to discard if needed
 
1027
        if not start_adjacent:
 
1028
            # work around python bug in rfind
 
1029
            if trim_start is None:
 
1030
                trim_start = data.find('\n') + 1
 
1031
            else:
 
1032
                trim_start = data.find('\n', trim_start) + 1
 
1033
            if not (trim_start != 0):
 
1034
                raise AssertionError('no \n was present')
 
1035
            # print 'removing start', offset, trim_start, repr(data[:trim_start])
 
1036
        if not end_adjacent:
 
1037
            # work around python bug in rfind
 
1038
            if trim_end is None:
 
1039
                trim_end = data.rfind('\n') + 1
 
1040
            else:
 
1041
                trim_end = data.rfind('\n', None, trim_end) + 1
 
1042
            if not (trim_end != 0):
 
1043
                raise AssertionError('no \n was present')
 
1044
            # print 'removing end', offset, trim_end, repr(data[trim_end:])
 
1045
        # adjust offset and data to the parseable data.
 
1046
        trimmed_data = data[trim_start:trim_end]
 
1047
        if not (trimmed_data):
 
1048
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
 
1049
                % (trim_start, trim_end, offset, offset + len(data)))
 
1050
        if trim_start:
 
1051
            offset += trim_start
 
1052
        # print "parsing", repr(trimmed_data)
 
1053
        # splitlines mangles the \r delimiters.. don't use it.
 
1054
        lines = trimmed_data.split('\n')
 
1055
        del lines[-1]
 
1056
        pos = offset
 
1057
        first_key, last_key, nodes, _ = self._parse_lines(lines, pos)
 
1058
        for key, value in nodes:
 
1059
            self._bisect_nodes[key] = value
 
1060
        self._parsed_bytes(offset, first_key,
 
1061
            offset + len(trimmed_data), last_key)
 
1062
        return offset + len(trimmed_data), last_segment
 
1063
 
 
1064
    def _parse_lines(self, lines, pos):
 
1065
        key = None
 
1066
        first_key = None
 
1067
        trailers = 0
 
1068
        nodes = []
 
1069
        for line in lines:
 
1070
            if line == '':
 
1071
                # must be at the end
 
1072
                if self._size:
 
1073
                    if not (self._size == pos + 1):
 
1074
                        raise AssertionError("%s %s" % (self._size, pos))
 
1075
                trailers += 1
 
1076
                continue
 
1077
            elements = line.split('\0')
 
1078
            if len(elements) != self._expected_elements:
 
1079
                raise errors.BadIndexData(self)
 
1080
            # keys are tuples. Each element is a string that may occur many
 
1081
            # times, so we intern them to save space. AB, RC, 200807
 
1082
            key = tuple([intern(element) for element in elements[:self._key_length]])
 
1083
            if first_key is None:
 
1084
                first_key = key
 
1085
            absent, references, value = elements[-3:]
 
1086
            ref_lists = []
 
1087
            for ref_string in references.split('\t'):
 
1088
                ref_lists.append(tuple([
 
1089
                    int(ref) for ref in ref_string.split('\r') if ref
 
1090
                    ]))
 
1091
            ref_lists = tuple(ref_lists)
 
1092
            self._keys_by_offset[pos] = (key, absent, ref_lists, value)
 
1093
            pos += len(line) + 1 # +1 for the \n
 
1094
            if absent:
 
1095
                continue
 
1096
            if self.node_ref_lists:
 
1097
                node_value = (value, ref_lists)
 
1098
            else:
 
1099
                node_value = value
 
1100
            nodes.append((key, node_value))
 
1101
            # print "parsed ", key
 
1102
        return first_key, key, nodes, trailers
 
1103
 
 
1104
    def _parsed_bytes(self, start, start_key, end, end_key):
 
1105
        """Mark the bytes from start to end as parsed.
 
1106
 
 
1107
        Calling self._parsed_bytes(1,2) will mark one byte (the one at offset
 
1108
        1) as parsed.
 
1109
 
 
1110
        :param start: The start of the parsed region.
 
1111
        :param end: The end of the parsed region.
 
1112
        """
 
1113
        index = self._parsed_byte_index(start)
 
1114
        new_value = (start, end)
 
1115
        new_key = (start_key, end_key)
 
1116
        if index == -1:
 
1117
            # first range parsed is always the beginning.
 
1118
            self._parsed_byte_map.insert(index, new_value)
 
1119
            self._parsed_key_map.insert(index, new_key)
 
1120
            return
 
1121
        # four cases:
 
1122
        # new region
 
1123
        # extend lower region
 
1124
        # extend higher region
 
1125
        # combine two regions
 
1126
        if (index + 1 < len(self._parsed_byte_map) and
 
1127
            self._parsed_byte_map[index][1] == start and
 
1128
            self._parsed_byte_map[index + 1][0] == end):
 
1129
            # combine two regions
 
1130
            self._parsed_byte_map[index] = (self._parsed_byte_map[index][0],
 
1131
                self._parsed_byte_map[index + 1][1])
 
1132
            self._parsed_key_map[index] = (self._parsed_key_map[index][0],
 
1133
                self._parsed_key_map[index + 1][1])
 
1134
            del self._parsed_byte_map[index + 1]
 
1135
            del self._parsed_key_map[index + 1]
 
1136
        elif self._parsed_byte_map[index][1] == start:
 
1137
            # extend the lower entry
 
1138
            self._parsed_byte_map[index] = (
 
1139
                self._parsed_byte_map[index][0], end)
 
1140
            self._parsed_key_map[index] = (
 
1141
                self._parsed_key_map[index][0], end_key)
 
1142
        elif (index + 1 < len(self._parsed_byte_map) and
 
1143
            self._parsed_byte_map[index + 1][0] == end):
 
1144
            # extend the higher entry
 
1145
            self._parsed_byte_map[index + 1] = (
 
1146
                start, self._parsed_byte_map[index + 1][1])
 
1147
            self._parsed_key_map[index + 1] = (
 
1148
                start_key, self._parsed_key_map[index + 1][1])
 
1149
        else:
 
1150
            # new entry
 
1151
            self._parsed_byte_map.insert(index + 1, new_value)
 
1152
            self._parsed_key_map.insert(index + 1, new_key)
 
1153
 
 
1154
    def _read_and_parse(self, readv_ranges):
 
1155
        """Read the the ranges and parse the resulting data.
 
1156
 
 
1157
        :param readv_ranges: A prepared readv range list.
 
1158
        """
 
1159
        if not readv_ranges:
 
1160
            return
 
1161
        if self._nodes is None and self._bytes_read * 2 >= self._size:
 
1162
            # We've already read more than 50% of the file and we are about to
 
1163
            # request more data, just _buffer_all() and be done
 
1164
            self._buffer_all()
 
1165
            return
 
1166
 
 
1167
        readv_data = self._transport.readv(self._name, readv_ranges, True,
 
1168
            self._size)
 
1169
        # parse
 
1170
        for offset, data in readv_data:
 
1171
            self._bytes_read += len(data)
 
1172
            if offset == 0 and len(data) == self._size:
 
1173
                # We read the whole range, most likely because the
 
1174
                # Transport upcast our readv ranges into one long request
 
1175
                # for enough total data to grab the whole index.
 
1176
                self._buffer_all(StringIO(data))
 
1177
                return
 
1178
            if self._bisect_nodes is None:
 
1179
                # this must be the start
 
1180
                if not (offset == 0):
 
1181
                    raise AssertionError()
 
1182
                offset, data = self._parse_header_from_bytes(data)
 
1183
            # print readv_ranges, "[%d:%d]" % (offset, offset + len(data))
 
1184
            self._parse_region(offset, data)
 
1185
 
468
1186
    def _signature(self):
469
1187
        """The file signature for this index type."""
470
1188
        return _SIGNATURE
478
1196
 
479
1197
class CombinedGraphIndex(object):
480
1198
    """A GraphIndex made up from smaller GraphIndices.
481
 
    
 
1199
 
482
1200
    The backing indices must implement GraphIndex, and are presumed to be
483
1201
    static data.
484
1202
 
489
1207
    in the index list.
490
1208
    """
491
1209
 
492
 
    def __init__(self, indices):
 
1210
    def __init__(self, indices, reload_func=None):
493
1211
        """Create a CombinedGraphIndex backed by indices.
494
1212
 
495
1213
        :param indices: An ordered list of indices to query for data.
 
1214
        :param reload_func: A function to call if we find we are missing an
 
1215
            index. Should have the form reload_func() => True/False to indicate
 
1216
            if reloading actually changed anything.
496
1217
        """
497
1218
        self._indices = indices
 
1219
        self._reload_func = reload_func
 
1220
 
 
1221
    def __repr__(self):
 
1222
        return "%s(%s)" % (
 
1223
                self.__class__.__name__,
 
1224
                ', '.join(map(repr, self._indices)))
 
1225
 
 
1226
    def get_parent_map(self, keys):
 
1227
        """See graph.StackedParentsProvider.get_parent_map"""
 
1228
        search_keys = set(keys)
 
1229
        if NULL_REVISION in search_keys:
 
1230
            search_keys.discard(NULL_REVISION)
 
1231
            found_parents = {NULL_REVISION:[]}
 
1232
        else:
 
1233
            found_parents = {}
 
1234
        for index, key, value, refs in self.iter_entries(search_keys):
 
1235
            parents = refs[0]
 
1236
            if not parents:
 
1237
                parents = (NULL_REVISION,)
 
1238
            found_parents[key] = parents
 
1239
        return found_parents
 
1240
 
 
1241
    has_key = _has_key_from_parent_map
498
1242
 
499
1243
    def insert_index(self, pos, index):
500
1244
        """Insert a new index in the list of indices to query.
510
1254
        Duplicate keys across child indices are presumed to have the same
511
1255
        value and are only reported once.
512
1256
 
513
 
        :return: An iterable of (key, reference_lists, value). There is no
514
 
            defined order for the result iteration - it will be in the most
515
 
            efficient order for the index.
 
1257
        :return: An iterable of (index, key, reference_lists, value).
 
1258
            There is no defined order for the result iteration - it will be in
 
1259
            the most efficient order for the index.
516
1260
        """
517
1261
        seen_keys = set()
518
 
        for index in self._indices:
519
 
            for node in index.iter_all_entries():
520
 
                if node[1] not in seen_keys:
521
 
                    yield node
522
 
                    seen_keys.add(node[1])
 
1262
        while True:
 
1263
            try:
 
1264
                for index in self._indices:
 
1265
                    for node in index.iter_all_entries():
 
1266
                        if node[1] not in seen_keys:
 
1267
                            yield node
 
1268
                            seen_keys.add(node[1])
 
1269
                return
 
1270
            except errors.NoSuchFile:
 
1271
                self._reload_or_raise()
523
1272
 
524
1273
    def iter_entries(self, keys):
525
1274
        """Iterate over keys within the index.
528
1277
        value and are only reported once.
529
1278
 
530
1279
        :param keys: An iterable providing the keys to be retrieved.
531
 
        :return: An iterable of (key, reference_lists, value). There is no
 
1280
        :return: An iterable of (index, key, reference_lists, value). There is no
532
1281
            defined order for the result iteration - it will be in the most
533
1282
            efficient order for the index.
534
1283
        """
535
1284
        keys = set(keys)
536
 
        for index in self._indices:
537
 
            if not keys:
 
1285
        while True:
 
1286
            try:
 
1287
                for index in self._indices:
 
1288
                    if not keys:
 
1289
                        return
 
1290
                    for node in index.iter_entries(keys):
 
1291
                        keys.remove(node[1])
 
1292
                        yield node
538
1293
                return
539
 
            for node in index.iter_entries(keys):
540
 
                keys.remove(node[1])
541
 
                yield node
 
1294
            except errors.NoSuchFile:
 
1295
                self._reload_or_raise()
542
1296
 
543
1297
    def iter_entries_prefix(self, keys):
544
1298
        """Iterate over keys within the index using prefix matching.
564
1318
        if not keys:
565
1319
            return
566
1320
        seen_keys = set()
567
 
        for index in self._indices:
568
 
            for node in index.iter_entries_prefix(keys):
569
 
                if node[1] in seen_keys:
570
 
                    continue
571
 
                seen_keys.add(node[1])
572
 
                yield node
 
1321
        while True:
 
1322
            try:
 
1323
                for index in self._indices:
 
1324
                    for node in index.iter_entries_prefix(keys):
 
1325
                        if node[1] in seen_keys:
 
1326
                            continue
 
1327
                        seen_keys.add(node[1])
 
1328
                        yield node
 
1329
                return
 
1330
            except errors.NoSuchFile:
 
1331
                self._reload_or_raise()
 
1332
 
 
1333
    def find_ancestry(self, keys, ref_list_num):
 
1334
        """Find the complete ancestry for the given set of keys.
 
1335
 
 
1336
        Note that this is a whole-ancestry request, so it should be used
 
1337
        sparingly.
 
1338
 
 
1339
        :param keys: An iterable of keys to look for
 
1340
        :param ref_list_num: The reference list which references the parents
 
1341
            we care about.
 
1342
        :return: (parent_map, missing_keys)
 
1343
        """
 
1344
        missing_keys = set()
 
1345
        parent_map = {}
 
1346
        keys_to_lookup = set(keys)
 
1347
        generation = 0
 
1348
        while keys_to_lookup:
 
1349
            # keys that *all* indexes claim are missing, stop searching them
 
1350
            generation += 1
 
1351
            all_index_missing = None
 
1352
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
 
1353
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
 
1354
            #                                   len(parent_map),
 
1355
            #                                   len(missing_keys))
 
1356
            for index_idx, index in enumerate(self._indices):
 
1357
                # TODO: we should probably be doing something with
 
1358
                #       'missing_keys' since we've already determined that
 
1359
                #       those revisions have not been found anywhere
 
1360
                index_missing_keys = set()
 
1361
                # Find all of the ancestry we can from this index
 
1362
                # keep looking until the search_keys set is empty, which means
 
1363
                # things we didn't find should be in index_missing_keys
 
1364
                search_keys = keys_to_lookup
 
1365
                sub_generation = 0
 
1366
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
 
1367
                #     index_idx, len(search_keys),
 
1368
                #     len(parent_map), len(index_missing_keys))
 
1369
                while search_keys:
 
1370
                    sub_generation += 1
 
1371
                    # TODO: ref_list_num should really be a parameter, since
 
1372
                    #       CombinedGraphIndex does not know what the ref lists
 
1373
                    #       mean.
 
1374
                    search_keys = index._find_ancestors(search_keys,
 
1375
                        ref_list_num, parent_map, index_missing_keys)
 
1376
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
 
1377
                    #     sub_generation, len(search_keys),
 
1378
                    #     len(parent_map), len(index_missing_keys))
 
1379
                # Now set whatever was missing to be searched in the next index
 
1380
                keys_to_lookup = index_missing_keys
 
1381
                if all_index_missing is None:
 
1382
                    all_index_missing = set(index_missing_keys)
 
1383
                else:
 
1384
                    all_index_missing.intersection_update(index_missing_keys)
 
1385
                if not keys_to_lookup:
 
1386
                    break
 
1387
            if all_index_missing is None:
 
1388
                # There were no indexes, so all search keys are 'missing'
 
1389
                missing_keys.update(keys_to_lookup)
 
1390
                keys_to_lookup = None
 
1391
            else:
 
1392
                missing_keys.update(all_index_missing)
 
1393
                keys_to_lookup.difference_update(all_index_missing)
 
1394
        return parent_map, missing_keys
573
1395
 
574
1396
    def key_count(self):
575
1397
        """Return an estimate of the number of keys in this index.
576
 
        
 
1398
 
577
1399
        For CombinedGraphIndex this is approximated by the sum of the keys of
578
1400
        the child indices. As child indices may have duplicate keys this can
579
1401
        have a maximum error of the number of child indices * largest number of
580
1402
        keys in any index.
581
1403
        """
582
 
        return sum((index.key_count() for index in self._indices), 0)
 
1404
        while True:
 
1405
            try:
 
1406
                return sum((index.key_count() for index in self._indices), 0)
 
1407
            except errors.NoSuchFile:
 
1408
                self._reload_or_raise()
 
1409
 
 
1410
    missing_keys = _missing_keys_from_parent_map
 
1411
 
 
1412
    def _reload_or_raise(self):
 
1413
        """We just got a NoSuchFile exception.
 
1414
 
 
1415
        Try to reload the indices, if it fails, just raise the current
 
1416
        exception.
 
1417
        """
 
1418
        if self._reload_func is None:
 
1419
            raise
 
1420
        exc_type, exc_value, exc_traceback = sys.exc_info()
 
1421
        trace.mutter('Trying to reload after getting exception: %s',
 
1422
                     exc_value)
 
1423
        if not self._reload_func():
 
1424
            # We tried to reload, but nothing changed, so we fail anyway
 
1425
            trace.mutter('_reload_func indicated nothing has changed.'
 
1426
                         ' Raising original exception.')
 
1427
            raise exc_type, exc_value, exc_traceback
583
1428
 
584
1429
    def validate(self):
585
1430
        """Validate that everything in the index can be accessed."""
586
 
        for index in self._indices:
587
 
            index.validate()
 
1431
        while True:
 
1432
            try:
 
1433
                for index in self._indices:
 
1434
                    index.validate()
 
1435
                return
 
1436
            except errors.NoSuchFile:
 
1437
                self._reload_or_raise()
588
1438
 
589
1439
 
590
1440
class InMemoryGraphIndex(GraphIndexBuilder):
610
1460
    def iter_all_entries(self):
611
1461
        """Iterate over all keys within the index
612
1462
 
613
 
        :return: An iterable of (key, reference_lists, value). There is no
 
1463
        :return: An iterable of (index, key, reference_lists, value). There is no
614
1464
            defined order for the result iteration - it will be in the most
615
1465
            efficient order for the index (in this case dictionary hash order).
616
1466
        """
617
1467
        if 'evil' in debug.debug_flags:
618
 
            trace.mutter_callsite(2,
 
1468
            trace.mutter_callsite(3,
619
1469
                "iter_all_entries scales with size of history.")
620
1470
        if self.reference_lists:
621
1471
            for key, (absent, references, value) in self._nodes.iteritems():
630
1480
        """Iterate over keys within the index.
631
1481
 
632
1482
        :param keys: An iterable providing the keys to be retrieved.
633
 
        :return: An iterable of (key, reference_lists, value). There is no
 
1483
        :return: An iterable of (index, key, value, reference_lists). There is no
634
1484
            defined order for the result iteration - it will be in the most
635
1485
            efficient order for the index (keys iteration order in this case).
636
1486
        """
677
1527
                    raise errors.BadIndexKey(key)
678
1528
                node = self._nodes[key]
679
1529
                if node[0]:
680
 
                    continue 
 
1530
                    continue
681
1531
                if self.reference_lists:
682
1532
                    yield self, key, node[2], node[1]
683
1533
                else:
684
1534
                    yield self, key, node[2]
685
1535
            return
 
1536
        nodes_by_key = self._get_nodes_by_key()
686
1537
        for key in keys:
687
1538
            # sanity check
688
1539
            if key[0] is None:
690
1541
            if len(key) != self._key_length:
691
1542
                raise errors.BadIndexKey(key)
692
1543
            # find what it refers to:
693
 
            key_dict = self._nodes_by_key
 
1544
            key_dict = nodes_by_key
694
1545
            elements = list(key)
695
1546
            # find the subdict to return
696
1547
            try:
707
1558
                    # can't be empty or would not exist
708
1559
                    item, value = key_dict.iteritems().next()
709
1560
                    if type(value) == dict:
710
 
                        # push keys 
 
1561
                        # push keys
711
1562
                        dicts.extend(key_dict.itervalues())
712
1563
                    else:
713
1564
                        # yield keys
718
1569
 
719
1570
    def key_count(self):
720
1571
        """Return an estimate of the number of keys in this index.
721
 
        
 
1572
 
722
1573
        For InMemoryGraphIndex the estimate is exact.
723
1574
        """
724
1575
        return len(self._keys)
732
1583
 
733
1584
    Queries against this will emit queries against the adapted Graph with the
734
1585
    prefix added, queries for all items use iter_entries_prefix. The returned
735
 
    nodes will have their keys and node references adjusted to remove the 
 
1586
    nodes will have their keys and node references adjusted to remove the
736
1587
    prefix. Finally, an add_nodes_callback can be supplied - when called the
737
1588
    nodes and references being added will have prefix prepended.
738
1589
    """
765
1616
                    adjusted_references))
766
1617
        except ValueError:
767
1618
            # XXX: TODO add an explicit interface for getting the reference list
768
 
            # status, to handle this bit of user-friendliness in the API more 
 
1619
            # status, to handle this bit of user-friendliness in the API more
769
1620
            # explicitly.
770
1621
            for (key, value) in nodes:
771
1622
                translated_nodes.append((self.prefix + key, value))
804
1655
        iter_all_entries is implemented against the adapted index using
805
1656
        iter_entries_prefix.
806
1657
 
807
 
        :return: An iterable of (key, reference_lists, value). There is no
 
1658
        :return: An iterable of (index, key, reference_lists, value). There is no
808
1659
            defined order for the result iteration - it will be in the most
809
1660
            efficient order for the index (in this case dictionary hash order).
810
1661
        """
814
1665
        """Iterate over keys within the index.
815
1666
 
816
1667
        :param keys: An iterable providing the keys to be retrieved.
817
 
        :return: An iterable of (key, reference_lists, value). There is no
 
1668
        :return: An iterable of (index, key, value, reference_lists). There is no
818
1669
            defined order for the result iteration - it will be in the most
819
1670
            efficient order for the index (keys iteration order in this case).
820
1671
        """
843
1694
 
844
1695
    def key_count(self):
845
1696
        """Return an estimate of the number of keys in this index.
846
 
        
 
1697
 
847
1698
        For GraphIndexPrefixAdapter this is relatively expensive - key
848
1699
        iteration with the prefix is done.
849
1700
        """