~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Aaron Bentley
  • Date: 2007-08-16 00:54:00 UTC
  • mto: This revision was merged to the branch mainline in revision 2711.
  • Revision ID: aaron.bentley@utoronto.ca-20070816005400-oxxtqiy310wx10h9
Fix typo

Show diffs side-by-side

added added

removed removed

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