/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Robert Collins
  • Date: 2007-10-08 04:53:50 UTC
  • mfrom: (2890.1.2 readv)
  • mto: This revision was merged to the branch mainline in revision 2933.
  • Revision ID: robertc@robertcollins.net-20071008045350-qwh1gb3r9vy3c8kk
Readv fixes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 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
 
27
27
from bisect import bisect_right
28
28
from cStringIO import StringIO
29
29
import re
30
 
import sys
31
30
 
32
31
from bzrlib.lazy_import import lazy_import
33
32
lazy_import(globals(), """
34
33
from bzrlib import trace
35
34
from bzrlib.bisect_multi import bisect_multi_bytes
36
 
from bzrlib.revision import NULL_REVISION
37
35
from bzrlib.trace import mutter
38
36
""")
39
 
from bzrlib import (
40
 
    debug,
41
 
    errors,
42
 
    )
43
 
from bzrlib.static_tuple import StaticTuple
 
37
from bzrlib import debug, errors
44
38
 
45
 
_HEADER_READV = (0, 200)
46
39
_OPTION_KEY_ELEMENTS = "key_elements="
47
40
_OPTION_LEN = "len="
48
41
_OPTION_NODE_REFS = "node_ref_lists="
53
46
_newline_null_re = re.compile('[\n\0]')
54
47
 
55
48
 
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
49
class GraphIndexBuilder(object):
70
50
    """A builder that can build a GraphIndex.
71
 
 
 
51
    
72
52
    The resulting graph has the structure:
73
 
 
 
53
    
74
54
    _SIGNATURE OPTIONS NODES NEWLINE
75
55
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
76
56
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
93
73
        :param key_elements: The number of bytestrings in each key.
94
74
        """
95
75
        self.reference_lists = reference_lists
96
 
        # A dict of {key: (absent, ref_lists, value)}
 
76
        self._keys = set()
97
77
        self._nodes = {}
98
 
        # Keys that are referenced but not actually present in this index
99
 
        self._absent_keys = set()
100
 
        self._nodes_by_key = None
 
78
        self._nodes_by_key = {}
101
79
        self._key_length = key_elements
102
 
        self._optimize_for_size = False
103
 
        self._combine_backing_indices = True
104
80
 
105
81
    def _check_key(self, key):
106
82
        """Raise BadIndexKey if key is not a valid key for this index."""
107
 
        if type(key) not in (tuple, StaticTuple):
 
83
        if type(key) != tuple:
108
84
            raise errors.BadIndexKey(key)
109
85
        if self._key_length != len(key):
110
86
            raise errors.BadIndexKey(key)
112
88
            if not element or _whitespace_re.search(element) is not None:
113
89
                raise errors.BadIndexKey(element)
114
90
 
115
 
    def _external_references(self):
116
 
        """Return references that are not present in this index.
117
 
        """
118
 
        keys = set()
119
 
        refs = set()
120
 
        # TODO: JAM 2008-11-21 This makes an assumption about how the reference
121
 
        #       lists are used. It is currently correct for pack-0.92 through
122
 
        #       1.9, which use the node references (3rd column) second
123
 
        #       reference list as the compression parent. Perhaps this should
124
 
        #       be moved into something higher up the stack, since it
125
 
        #       makes assumptions about how the index is used.
126
 
        if self.reference_lists > 1:
127
 
            for node in self.iter_all_entries():
128
 
                keys.add(node[1])
129
 
                refs.update(node[3][1])
130
 
            return refs - keys
131
 
        else:
132
 
            # If reference_lists == 0 there can be no external references, and
133
 
            # if reference_lists == 1, then there isn't a place to store the
134
 
            # compression parent
135
 
            return set()
136
 
 
137
 
    def _get_nodes_by_key(self):
138
 
        if self._nodes_by_key is None:
139
 
            nodes_by_key = {}
140
 
            if self.reference_lists:
141
 
                for key, (absent, references, value) in self._nodes.iteritems():
142
 
                    if absent:
143
 
                        continue
144
 
                    key_dict = nodes_by_key
145
 
                    for subkey in key[:-1]:
146
 
                        key_dict = key_dict.setdefault(subkey, {})
147
 
                    key_dict[key[-1]] = key, value, references
148
 
            else:
149
 
                for key, (absent, references, value) in self._nodes.iteritems():
150
 
                    if absent:
151
 
                        continue
152
 
                    key_dict = nodes_by_key
153
 
                    for subkey in key[:-1]:
154
 
                        key_dict = key_dict.setdefault(subkey, {})
155
 
                    key_dict[key[-1]] = key, value
156
 
            self._nodes_by_key = nodes_by_key
157
 
        return self._nodes_by_key
158
 
 
159
 
    def _update_nodes_by_key(self, key, value, node_refs):
160
 
        """Update the _nodes_by_key dict with a new key.
161
 
 
162
 
        For a key of (foo, bar, baz) create
163
 
        _nodes_by_key[foo][bar][baz] = key_value
164
 
        """
165
 
        if self._nodes_by_key is None:
166
 
            return
167
 
        key_dict = self._nodes_by_key
168
 
        if self.reference_lists:
169
 
            key_value = StaticTuple(key, value, node_refs)
170
 
        else:
171
 
            key_value = StaticTuple(key, value)
172
 
        for subkey in key[:-1]:
173
 
            key_dict = key_dict.setdefault(subkey, {})
174
 
        key_dict[key[-1]] = key_value
175
 
 
176
 
    def _check_key_ref_value(self, key, references, value):
177
 
        """Check that 'key' and 'references' are all valid.
178
 
 
179
 
        :param key: A key tuple. Must conform to the key interface (be a tuple,
180
 
            be of the right length, not have any whitespace or nulls in any key
181
 
            element.)
182
 
        :param references: An iterable of reference lists. Something like
183
 
            [[(ref, key)], [(ref, key), (other, key)]]
184
 
        :param value: The value associate with this key. Must not contain
185
 
            newlines or null characters.
186
 
        :return: (node_refs, absent_references)
187
 
            node_refs   basically a packed form of 'references' where all
188
 
                        iterables are tuples
189
 
            absent_references   reference keys that are not in self._nodes.
190
 
                                This may contain duplicates if the same key is
191
 
                                referenced in multiple lists.
192
 
        """
193
 
        as_st = StaticTuple.from_sequence
 
91
    def add_node(self, key, value, references=()):
 
92
        """Add a node to the index.
 
93
 
 
94
        :param key: The key. keys are non-empty tuples containing
 
95
            as many whitespace-free utf8 bytestrings as the key length
 
96
            defined for this index.
 
97
        :param references: An iterable of iterables of keys. Each is a
 
98
            reference to another key.
 
99
        :param value: The value to associate with the key. It may be any
 
100
            bytes as long as it does not contain \0 or \n.
 
101
        """
194
102
        self._check_key(key)
195
103
        if _newline_null_re.search(value) is not None:
196
104
            raise errors.BadIndexValue(value)
197
105
        if len(references) != self.reference_lists:
198
106
            raise errors.BadIndexValue(references)
199
107
        node_refs = []
200
 
        absent_references = []
201
108
        for reference_list in references:
202
109
            for reference in reference_list:
203
 
                # If reference *is* in self._nodes, then we know it has already
204
 
                # been checked.
 
110
                self._check_key(reference)
205
111
                if reference not in self._nodes:
206
 
                    self._check_key(reference)
207
 
                    absent_references.append(reference)
208
 
            reference_list = as_st([as_st(ref).intern()
209
 
                                    for ref in reference_list])
210
 
            node_refs.append(reference_list)
211
 
        return as_st(node_refs), absent_references
212
 
 
213
 
    def add_node(self, key, value, references=()):
214
 
        """Add a node to the index.
215
 
 
216
 
        :param key: The key. keys are non-empty tuples containing
217
 
            as many whitespace-free utf8 bytestrings as the key length
218
 
            defined for this index.
219
 
        :param references: An iterable of iterables of keys. Each is a
220
 
            reference to another key.
221
 
        :param value: The value to associate with the key. It may be any
222
 
            bytes as long as it does not contain \0 or \n.
223
 
        """
224
 
        (node_refs,
225
 
         absent_references) = self._check_key_ref_value(key, references, value)
226
 
        if key in self._nodes and self._nodes[key][0] != 'a':
 
112
                    self._nodes[reference] = ('a', (), '')
 
113
            node_refs.append(tuple(reference_list))
 
114
        if key in self._nodes and self._nodes[key][0] == '':
227
115
            raise errors.BadIndexDuplicateKey(key, self)
228
 
        for reference in absent_references:
229
 
            # There may be duplicates, but I don't think it is worth worrying
230
 
            # about
231
 
            self._nodes[reference] = ('a', (), '')
232
 
        self._absent_keys.update(absent_references)
233
 
        self._absent_keys.discard(key)
234
 
        self._nodes[key] = ('', node_refs, value)
235
 
        if self._nodes_by_key is not None and self._key_length > 1:
236
 
            self._update_nodes_by_key(key, value, node_refs)
237
 
 
238
 
    def clear_cache(self):
239
 
        """See GraphIndex.clear_cache()
240
 
 
241
 
        This is a no-op, but we need the api to conform to a generic 'Index'
242
 
        abstraction.
243
 
        """
244
 
        
 
116
        self._nodes[key] = ('', tuple(node_refs), value)
 
117
        self._keys.add(key)
 
118
        if self._key_length > 1:
 
119
            key_dict = self._nodes_by_key
 
120
            if self.reference_lists:
 
121
                key_value = key, value, tuple(node_refs)
 
122
            else:
 
123
                key_value = key, value
 
124
            # possibly should do this on-demand, but it seems likely it is 
 
125
            # always wanted
 
126
            # For a key of (foo, bar, baz) create
 
127
            # _nodes_by_key[foo][bar][baz] = key_value
 
128
            for subkey in key[:-1]:
 
129
                key_dict = key_dict.setdefault(subkey, {})
 
130
            key_dict[key[-1]] = key_value
 
131
 
245
132
    def finish(self):
246
133
        lines = [_SIGNATURE]
247
134
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
248
135
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
249
 
        key_count = len(self._nodes) - len(self._absent_keys)
250
 
        lines.append(_OPTION_LEN + str(key_count) + '\n')
 
136
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
251
137
        prefix_length = sum(len(x) for x in lines)
252
138
        # references are byte offsets. To avoid having to do nasty
253
 
        # polynomial work to resolve offsets (references to later in the
 
139
        # polynomial work to resolve offsets (references to later in the 
254
140
        # file cannot be determined until all the inbetween references have
255
141
        # been calculated too) we pad the offsets with 0's to make them be
256
142
        # of consistent length. Using binary offsets would break the trivial
260
146
        # one to pad all the data with reference-length and determine entry
261
147
        # addresses.
262
148
        # One to serialise.
263
 
 
 
149
        
264
150
        # forward sorted by key. In future we may consider topological sorting,
265
151
        # at the cost of table scans for direct lookup, or a second index for
266
152
        # direct lookup
327
213
            raise errors.BzrError('Failed index creation. Internal error:'
328
214
                ' mismatched output length and expected length: %d %d' %
329
215
                (len(result.getvalue()), expected_bytes))
330
 
        return result
331
 
 
332
 
    def set_optimize(self, for_size=None, combine_backing_indices=None):
333
 
        """Change how the builder tries to optimize the result.
334
 
 
335
 
        :param for_size: Tell the builder to try and make the index as small as
336
 
            possible.
337
 
        :param combine_backing_indices: If the builder spills to disk to save
338
 
            memory, should the on-disk indices be combined. Set to True if you
339
 
            are going to be probing the index, but to False if you are not. (If
340
 
            you are not querying, then the time spent combining is wasted.)
341
 
        :return: None
342
 
        """
343
 
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
344
 
        # other builders do.
345
 
        if for_size is not None:
346
 
            self._optimize_for_size = for_size
347
 
        if combine_backing_indices is not None:
348
 
            self._combine_backing_indices = combine_backing_indices
349
 
 
350
 
    def find_ancestry(self, keys, ref_list_num):
351
 
        """See CombinedGraphIndex.find_ancestry()"""
352
 
        pending = set(keys)
353
 
        parent_map = {}
354
 
        missing_keys = set()
355
 
        while pending:
356
 
            next_pending = set()
357
 
            for _, key, value, ref_lists in self.iter_entries(pending):
358
 
                parent_keys = ref_lists[ref_list_num]
359
 
                parent_map[key] = parent_keys
360
 
                next_pending.update([p for p in parent_keys if p not in
361
 
                                     parent_map])
362
 
                missing_keys.update(pending.difference(parent_map))
363
 
            pending = next_pending
364
 
        return parent_map, missing_keys
 
216
        return StringIO(''.join(lines))
365
217
 
366
218
 
367
219
class GraphIndex(object):
368
220
    """An index for data with embedded graphs.
369
 
 
 
221
 
370
222
    The index maps keys to a list of key reference lists, and a value.
371
223
    Each node has the same number of key reference lists. Each key reference
372
224
    list can be empty or an arbitrary length. The value is an opaque NULL
373
 
    terminated string without any newlines. The storage of the index is
 
225
    terminated string without any newlines. The storage of the index is 
374
226
    hidden in the interface: keys and key references are always tuples of
375
227
    bytestrings, never the internal representation (e.g. dictionary offsets).
376
228
 
382
234
    suitable for production use. :XXX
383
235
    """
384
236
 
385
 
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
 
237
    def __init__(self, transport, name, size):
386
238
        """Open an index called name on transport.
387
239
 
388
240
        :param transport: A bzrlib.transport.Transport.
394
246
            avoided by having it supplied. If size is None, then bisection
395
247
            support will be disabled and accessing the index will just stream
396
248
            all the data.
397
 
        :param offset: Instead of starting the index data at offset 0, start it
398
 
            at an arbitrary offset.
399
249
        """
400
250
        self._transport = transport
401
251
        self._name = name
402
 
        # Becomes a dict of key:(value, reference-list-byte-locations) used by
403
 
        # the bisection interface to store parsed but not resolved keys.
 
252
        # becomes a dict of key:(value, reference-list-byte-locations) 
 
253
        # used by the bisection interface to store parsed but not resolved
 
254
        # keys.
404
255
        self._bisect_nodes = None
405
 
        # Becomes a dict of key:(value, reference-list-keys) which are ready to
406
 
        # be returned directly to callers.
407
256
        self._nodes = None
408
257
        # a sorted list of slice-addresses for the parsed bytes of the file.
409
258
        # e.g. (0,1) would mean that byte 0 is parsed.
416
265
        self._keys_by_offset = None
417
266
        self._nodes_by_key = None
418
267
        self._size = size
419
 
        # The number of bytes we've read so far in trying to process this file
420
 
        self._bytes_read = 0
421
 
        self._base_offset = offset
422
 
 
423
 
    def __eq__(self, other):
424
 
        """Equal when self and other were created with the same parameters."""
425
 
        return (
426
 
            type(self) == type(other) and
427
 
            self._transport == other._transport and
428
 
            self._name == other._name and
429
 
            self._size == other._size)
430
 
 
431
 
    def __ne__(self, other):
432
 
        return not self.__eq__(other)
433
 
 
434
 
    def __repr__(self):
435
 
        return "%s(%r)" % (self.__class__.__name__,
436
 
            self._transport.abspath(self._name))
437
 
 
438
 
    def _buffer_all(self, stream=None):
 
268
 
 
269
    def _buffer_all(self):
439
270
        """Buffer all the index data.
440
271
 
441
272
        Mutates self._nodes and self.keys_by_offset.
442
273
        """
443
 
        if self._nodes is not None:
444
 
            # We already did this
445
 
            return
446
274
        if 'index' in debug.debug_flags:
447
275
            mutter('Reading entire index %s', self._transport.abspath(self._name))
448
 
        if stream is None:
449
 
            stream = self._transport.get(self._name)
450
 
            if self._base_offset != 0:
451
 
                # This is wasteful, but it is better than dealing with
452
 
                # adjusting all the offsets, etc.
453
 
                stream = StringIO(stream.read()[self._base_offset:])
 
276
        stream = self._transport.get(self._name)
454
277
        self._read_prefix(stream)
455
 
        self._expected_elements = 3 + self._key_length
 
278
        expected_elements = 3 + self._key_length
456
279
        line_count = 0
457
280
        # raw data keyed by offset
458
281
        self._keys_by_offset = {}
459
282
        # ready-to-return key:value or key:value, node_ref_lists
460
283
        self._nodes = {}
461
 
        self._nodes_by_key = None
 
284
        self._nodes_by_key = {}
462
285
        trailers = 0
463
286
        pos = stream.tell()
464
 
        lines = stream.read().split('\n')
465
 
        stream.close()
466
 
        del lines[-1]
467
 
        _, _, _, trailers = self._parse_lines(lines, pos)
 
287
        for line in stream.readlines():
 
288
            if line == '\n':
 
289
                trailers += 1
 
290
                continue
 
291
            elements = line.split('\0')
 
292
            if len(elements) != expected_elements:
 
293
                raise errors.BadIndexData(self)
 
294
            # keys are tuples
 
295
            key = tuple(elements[:self._key_length])
 
296
            absent, references, value = elements[-3:]
 
297
            value = value[:-1] # remove the newline
 
298
            ref_lists = []
 
299
            for ref_string in references.split('\t'):
 
300
                ref_lists.append(tuple([
 
301
                    int(ref) for ref in ref_string.split('\r') if ref
 
302
                    ]))
 
303
            ref_lists = tuple(ref_lists)
 
304
            self._keys_by_offset[pos] = (key, absent, ref_lists, value)
 
305
            pos += len(line)
468
306
        for key, absent, references, value in self._keys_by_offset.itervalues():
469
307
            if absent:
470
308
                continue
471
309
            # resolve references:
472
310
            if self.node_ref_lists:
473
 
                node_value = (value, self._resolve_references(references))
 
311
                node_refs = []
 
312
                for ref_list in references:
 
313
                    node_refs.append(tuple([self._keys_by_offset[ref][0] for ref in ref_list]))
 
314
                node_value = (value, tuple(node_refs))
474
315
            else:
475
316
                node_value = value
476
317
            self._nodes[key] = node_value
 
318
            if self._key_length > 1:
 
319
                subkey = list(reversed(key[:-1]))
 
320
                key_dict = self._nodes_by_key
 
321
                if self.node_ref_lists:
 
322
                    key_value = key, node_value[0], node_value[1]
 
323
                else:
 
324
                    key_value = key, node_value
 
325
                # possibly should do this on-demand, but it seems likely it is 
 
326
                # always wanted
 
327
                # For a key of (foo, bar, baz) create
 
328
                # _nodes_by_key[foo][bar][baz] = key_value
 
329
                for subkey in key[:-1]:
 
330
                    key_dict = key_dict.setdefault(subkey, {})
 
331
                key_dict[key[-1]] = key_value
477
332
        # cache the keys for quick set intersections
 
333
        self._keys = set(self._nodes)
478
334
        if trailers != 1:
479
335
            # there must be one line - the empty trailer line.
480
336
            raise errors.BadIndexData(self)
481
337
 
482
 
    def clear_cache(self):
483
 
        """Clear out any cached/memoized values.
484
 
 
485
 
        This can be called at any time, but generally it is used when we have
486
 
        extracted some information, but don't expect to be requesting any more
487
 
        from this index.
488
 
        """
489
 
 
490
 
    def external_references(self, ref_list_num):
491
 
        """Return references that are not present in this index.
492
 
        """
493
 
        self._buffer_all()
494
 
        if ref_list_num + 1 > self.node_ref_lists:
495
 
            raise ValueError('No ref list %d, index has %d ref lists'
496
 
                % (ref_list_num, self.node_ref_lists))
497
 
        refs = set()
498
 
        nodes = self._nodes
499
 
        for key, (value, ref_lists) in nodes.iteritems():
500
 
            ref_list = ref_lists[ref_list_num]
501
 
            refs.update([ref for ref in ref_list if ref not in nodes])
502
 
        return refs
503
 
 
504
 
    def _get_nodes_by_key(self):
505
 
        if self._nodes_by_key is None:
506
 
            nodes_by_key = {}
507
 
            if self.node_ref_lists:
508
 
                for key, (value, references) in self._nodes.iteritems():
509
 
                    key_dict = nodes_by_key
510
 
                    for subkey in key[:-1]:
511
 
                        key_dict = key_dict.setdefault(subkey, {})
512
 
                    key_dict[key[-1]] = key, value, references
513
 
            else:
514
 
                for key, value in self._nodes.iteritems():
515
 
                    key_dict = nodes_by_key
516
 
                    for subkey in key[:-1]:
517
 
                        key_dict = key_dict.setdefault(subkey, {})
518
 
                    key_dict[key[-1]] = key, value
519
 
            self._nodes_by_key = nodes_by_key
520
 
        return self._nodes_by_key
521
 
 
522
338
    def iter_all_entries(self):
523
339
        """Iterate over all keys within the index.
524
340
 
567
383
            raise errors.BadIndexOptions(self)
568
384
 
569
385
    def _resolve_references(self, references):
570
 
        """Return the resolved key references for references.
571
 
 
572
 
        References are resolved by looking up the location of the key in the
573
 
        _keys_by_offset map and substituting the key name, preserving ordering.
574
 
 
575
 
        :param references: An iterable of iterables of key locations. e.g.
576
 
            [[123, 456], [123]]
577
 
        :return: A tuple of tuples of keys.
578
 
        """
 
386
        """Return the resolved key references for references."""
579
387
        node_refs = []
580
388
        for ref_list in references:
581
389
            node_refs.append(tuple([self._keys_by_offset[ref][0] for ref in ref_list]))
632
440
 
633
441
    def _iter_entries_from_total_buffer(self, keys):
634
442
        """Iterate over keys when the entire index is parsed."""
635
 
        # Note: See the note in BTreeBuilder.iter_entries for why we don't use
636
 
        #       .intersection() here
637
 
        nodes = self._nodes
638
 
        keys = [key for key in keys if key in nodes]
 
443
        keys = keys.intersection(self._keys)
639
444
        if self.node_ref_lists:
640
445
            for key in keys:
641
 
                value, node_refs = nodes[key]
 
446
                value, node_refs = self._nodes[key]
642
447
                yield self, key, value, node_refs
643
448
        else:
644
449
            for key in keys:
645
 
                yield self, key, nodes[key]
 
450
                yield self, key, self._nodes[key]
646
451
 
647
452
    def iter_entries(self, keys):
648
453
        """Iterate over keys within the index.
657
462
            return []
658
463
        if self._size is None and self._nodes is None:
659
464
            self._buffer_all()
660
 
 
661
 
        # We fit about 20 keys per minimum-read (4K), so if we are looking for
662
 
        # more than 1/20th of the index its likely (assuming homogenous key
663
 
        # spread) that we'll read the entire index. If we're going to do that,
664
 
        # buffer the whole thing. A better analysis might take key spread into
665
 
        # account - but B+Tree indices are better anyway.
666
 
        # We could look at all data read, and use a threshold there, which will
667
 
        # trigger on ancestry walks, but that is not yet fully mapped out.
668
 
        if self._nodes is None and len(keys) * 20 > self.key_count():
669
 
            self._buffer_all()
670
465
        if self._nodes is not None:
671
466
            return self._iter_entries_from_total_buffer(keys)
672
467
        else:
673
468
            return (result[1] for result in bisect_multi_bytes(
674
 
                self._lookup_keys_via_location, self._size, keys))
 
469
                self.lookup_keys_via_location, self._size, keys))
675
470
 
676
471
    def iter_entries_prefix(self, keys):
677
472
        """Iterate over keys within the index using prefix matching.
714
509
                else:
715
510
                    yield self, key, self._nodes[key]
716
511
            return
717
 
        nodes_by_key = self._get_nodes_by_key()
718
512
        for key in keys:
719
513
            # sanity check
720
514
            if key[0] is None:
722
516
            if len(key) != self._key_length:
723
517
                raise errors.BadIndexKey(key)
724
518
            # find what it refers to:
725
 
            key_dict = nodes_by_key
 
519
            key_dict = self._nodes_by_key
726
520
            elements = list(key)
727
521
            # find the subdict whose contents should be returned.
728
522
            try:
739
533
                    # can't be empty or would not exist
740
534
                    item, value = key_dict.iteritems().next()
741
535
                    if type(value) == dict:
742
 
                        # push keys
 
536
                        # push keys 
743
537
                        dicts.extend(key_dict.itervalues())
744
538
                    else:
745
539
                        # yield keys
751
545
                # the last thing looked up was a terminal element
752
546
                yield (self, ) + key_dict
753
547
 
754
 
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
755
 
        """See BTreeIndex._find_ancestors."""
756
 
        # The api can be implemented as a trivial overlay on top of
757
 
        # iter_entries, it is not an efficient implementation, but it at least
758
 
        # gets the job done.
759
 
        found_keys = set()
760
 
        search_keys = set()
761
 
        for index, key, value, refs in self.iter_entries(keys):
762
 
            parent_keys = refs[ref_list_num]
763
 
            found_keys.add(key)
764
 
            parent_map[key] = parent_keys
765
 
            search_keys.update(parent_keys)
766
 
        # Figure out what, if anything, was missing
767
 
        missing_keys.update(set(keys).difference(found_keys))
768
 
        search_keys = search_keys.difference(parent_map)
769
 
        return search_keys
770
 
 
771
548
    def key_count(self):
772
549
        """Return an estimate of the number of keys in this index.
773
 
 
 
550
        
774
551
        For GraphIndex the estimate is exact.
775
552
        """
776
553
        if self._key_count is None:
777
 
            self._read_and_parse([_HEADER_READV])
 
554
            # really this should just read the prefix
 
555
            self._buffer_all()
778
556
        return self._key_count
779
557
 
780
 
    def _lookup_keys_via_location(self, location_keys):
 
558
    def lookup_keys_via_location(self, location_keys):
781
559
        """Public interface for implementing bisection.
782
560
 
783
561
        If _buffer_all has been called, then all the data for the index is in
785
563
        cache because it cannot pre-resolve all indices, which buffer_all does
786
564
        for performance.
787
565
 
788
 
        :param location_keys: A list of location(byte offset), key tuples.
 
566
        :param location_keys: A list of location, key tuples.
789
567
        :return: A list of (location_key, result) tuples as expected by
790
568
            bzrlib.bisect_multi.bisect_multi_bytes.
791
569
        """
792
570
        # Possible improvements:
793
571
        #  - only bisect lookup each key once
794
572
        #  - sort the keys first, and use that to reduce the bisection window
795
 
        # -----
 
573
        # ----- 
796
574
        # this progresses in three parts:
797
575
        # read data
798
576
        # parse it
803
581
        readv_ranges = []
804
582
        for location, key in location_keys:
805
583
            # can we answer from cache?
806
 
            if self._bisect_nodes and key in self._bisect_nodes:
807
 
                # We have the key parsed.
808
 
                continue
 
584
            # - if we know the answer - yes
809
585
            index = self._parsed_key_index(key)
810
 
            if (len(self._parsed_key_map) and
 
586
            if (len(self._parsed_key_map) and 
811
587
                self._parsed_key_map[index][0] <= key and
812
 
                (self._parsed_key_map[index][1] >= key or
 
588
                (self._parsed_key_map[index][1] > key or
813
589
                 # end of the file has been parsed
814
590
                 self._parsed_byte_map[index][1] == self._size)):
815
 
                # the key has been parsed, so no lookup is needed even if its
816
 
                # not present.
 
591
                # the key has been parsed, so no lookup is needed
817
592
                continue
818
593
            # - if we have examined this part of the file already - yes
819
594
            index = self._parsed_byte_index(location)
820
 
            if (len(self._parsed_byte_map) and
 
595
            if (len(self._parsed_byte_map) and 
821
596
                self._parsed_byte_map[index][0] <= location and
822
597
                self._parsed_byte_map[index][1] > location):
823
598
                # the byte region has been parsed, so no read is needed.
830
605
                readv_ranges.append((location, length))
831
606
        # read the header if needed
832
607
        if self._bisect_nodes is None:
833
 
            readv_ranges.append(_HEADER_READV)
 
608
            readv_ranges.append((0, 200))
834
609
        self._read_and_parse(readv_ranges)
835
 
        result = []
836
 
        if self._nodes is not None:
837
 
            # _read_and_parse triggered a _buffer_all because we requested the
838
 
            # whole data range
839
 
            for location, key in location_keys:
840
 
                if key not in self._nodes: # not present
841
 
                    result.append(((location, key), False))
842
 
                elif self.node_ref_lists:
843
 
                    value, refs = self._nodes[key]
844
 
                    result.append(((location, key),
845
 
                        (self, key, value, refs)))
846
 
                else:
847
 
                    result.append(((location, key),
848
 
                        (self, key, self._nodes[key])))
849
 
            return result
850
610
        # generate results:
851
611
        #  - figure out <, >, missing, present
852
612
        #  - result present references so we can return them.
 
613
        result = []
853
614
        # keys that we cannot answer until we resolve references
854
615
        pending_references = []
855
616
        pending_locations = set()
856
617
        for location, key in location_keys:
857
618
            # can we answer from cache?
858
 
            if key in self._bisect_nodes:
 
619
            index = self._parsed_key_index(key)
 
620
            if (self._parsed_key_map[index][0] <= key and
 
621
                (self._parsed_key_map[index][1] > key or
 
622
                 # end of the file has been parsed
 
623
                 self._parsed_byte_map[index][1] == self._size)):
859
624
                # the key has been parsed, so no lookup is needed
860
 
                if self.node_ref_lists:
861
 
                    # the references may not have been all parsed.
862
 
                    value, refs = self._bisect_nodes[key]
863
 
                    wanted_locations = []
864
 
                    for ref_list in refs:
865
 
                        for ref in ref_list:
866
 
                            if ref not in self._keys_by_offset:
867
 
                                wanted_locations.append(ref)
868
 
                    if wanted_locations:
869
 
                        pending_locations.update(wanted_locations)
870
 
                        pending_references.append((location, key))
871
 
                        continue
872
 
                    result.append(((location, key), (self, key,
873
 
                        value, self._resolve_references(refs))))
 
625
                if key in self._bisect_nodes:
 
626
                    if self.node_ref_lists:
 
627
                        # the references may not have been all parsed.
 
628
                        value, refs = self._bisect_nodes[key]
 
629
                        wanted_locations = []
 
630
                        for ref_list in refs:
 
631
                            for ref in ref_list:
 
632
                                if ref not in self._keys_by_offset:
 
633
                                    wanted_locations.append(ref)
 
634
                        if wanted_locations:
 
635
                            pending_locations.update(wanted_locations)
 
636
                            pending_references.append((location, key))
 
637
                            continue
 
638
                        result.append(((location, key), (self, key,
 
639
                            value, self._resolve_references(refs))))
 
640
                    else:
 
641
                        result.append(((location, key),
 
642
                            (self, key, self._bisect_nodes[key])))
874
643
                else:
875
 
                    result.append(((location, key),
876
 
                        (self, key, self._bisect_nodes[key])))
 
644
                    result.append(((location, key), False))
877
645
                continue
878
 
            else:
879
 
                # has the region the key should be in, been parsed?
880
 
                index = self._parsed_key_index(key)
881
 
                if (self._parsed_key_map[index][0] <= key and
882
 
                    (self._parsed_key_map[index][1] >= key or
883
 
                     # end of the file has been parsed
884
 
                     self._parsed_byte_map[index][1] == self._size)):
885
 
                    result.append(((location, key), False))
886
 
                    continue
887
646
            # no, is the key above or below the probed location:
888
647
            # get the range of the probed & parsed location
889
648
            index = self._parsed_byte_index(location)
900
659
            if location + length > self._size:
901
660
                length = self._size - location
902
661
            # TODO: trim out parsed locations (e.g. if the 800 is into the
903
 
            # parsed region trim it, and dont use the adjust_for_latency
 
662
            # parsed region trim it, and dont use the ajust_for_latency
904
663
            # facility)
905
664
            if length > 0:
906
665
                readv_ranges.append((location, length))
907
666
        self._read_and_parse(readv_ranges)
908
 
        if self._nodes is not None:
909
 
            # The _read_and_parse triggered a _buffer_all, grab the data and
910
 
            # return it
911
 
            for location, key in pending_references:
912
 
                value, refs = self._nodes[key]
913
 
                result.append(((location, key), (self, key, value, refs)))
914
 
            return result
915
667
        for location, key in pending_references:
916
668
            # answer key references we had to look-up-late.
 
669
            index = self._parsed_key_index(key)
917
670
            value, refs = self._bisect_nodes[key]
918
671
            result.append(((location, key), (self, key,
919
672
                value, self._resolve_references(refs))))
972
725
        # trim the data.
973
726
        # end first:
974
727
        end = offset + len(data)
975
 
        high_parsed = offset
976
 
        while True:
977
 
            # Trivial test - if the current index's end is within the
978
 
            # low-matching parsed range, we're done.
979
 
            index = self._parsed_byte_index(high_parsed)
980
 
            if end < self._parsed_byte_map[index][1]:
981
 
                return
982
 
            # print "[%d:%d]" % (offset, end), \
983
 
            #     self._parsed_byte_map[index:index + 2]
984
 
            high_parsed, last_segment = self._parse_segment(
985
 
                offset, data, end, index)
986
 
            if last_segment:
987
 
                return
988
 
 
989
 
    def _parse_segment(self, offset, data, end, index):
990
 
        """Parse one segment of data.
991
 
 
992
 
        :param offset: Where 'data' begins in the file.
993
 
        :param data: Some data to parse a segment of.
994
 
        :param end: Where data ends
995
 
        :param index: The current index into the parsed bytes map.
996
 
        :return: True if the parsed segment is the last possible one in the
997
 
            range of data.
998
 
        :return: high_parsed_byte, last_segment.
999
 
            high_parsed_byte is the location of the highest parsed byte in this
1000
 
            segment, last_segment is True if the parsed segment is the last
1001
 
            possible one in the data block.
1002
 
        """
 
728
        index = self._parsed_byte_index(offset)
1003
729
        # default is to use all data
1004
730
        trim_end = None
 
731
        # trivial check for entirely parsed data:
 
732
        if end < self._parsed_byte_map[index][1]:
 
733
            return
1005
734
        # accomodate overlap with data before this.
1006
735
        if offset < self._parsed_byte_map[index][1]:
1007
736
            # overlaps the lower parsed region
1027
756
            trim_end = None
1028
757
            # do not strip to the last \n
1029
758
            end_adjacent = True
1030
 
            last_segment = True
1031
759
        elif index + 1 == len(self._parsed_byte_map):
1032
760
            # at the end of the parsed data
1033
761
            # use it all
1034
762
            trim_end = None
1035
763
            # but strip to the last \n
1036
764
            end_adjacent = False
1037
 
            last_segment = True
1038
765
        elif end == self._parsed_byte_map[index + 1][0]:
1039
766
            # buts up against the next parsed region
1040
767
            # use it all
1041
768
            trim_end = None
1042
769
            # do not strip to the last \n
1043
770
            end_adjacent = True
1044
 
            last_segment = True
1045
771
        elif end > self._parsed_byte_map[index + 1][0]:
1046
772
            # overlaps into the next parsed region
1047
773
            # only consider the unparsed data
1048
774
            trim_end = self._parsed_byte_map[index + 1][0] - offset
1049
775
            # do not strip to the last \n as we know its an entire record
1050
776
            end_adjacent = True
1051
 
            last_segment = end < self._parsed_byte_map[index + 1][1]
1052
777
        else:
1053
778
            # does not overlap into the next region
1054
779
            # use it all
1055
780
            trim_end = None
1056
781
            # but strip to the last \n
1057
782
            end_adjacent = False
1058
 
            last_segment = True
1059
783
        # now find bytes to discard if needed
1060
784
        if not start_adjacent:
1061
785
            # work around python bug in rfind
1063
787
                trim_start = data.find('\n') + 1
1064
788
            else:
1065
789
                trim_start = data.find('\n', trim_start) + 1
1066
 
            if not (trim_start != 0):
1067
 
                raise AssertionError('no \n was present')
 
790
            assert trim_start != 0, 'no \n was present'
1068
791
            # print 'removing start', offset, trim_start, repr(data[:trim_start])
1069
792
        if not end_adjacent:
1070
793
            # work around python bug in rfind
1072
795
                trim_end = data.rfind('\n') + 1
1073
796
            else:
1074
797
                trim_end = data.rfind('\n', None, trim_end) + 1
1075
 
            if not (trim_end != 0):
1076
 
                raise AssertionError('no \n was present')
 
798
            assert trim_end != 0, 'no \n was present'
1077
799
            # print 'removing end', offset, trim_end, repr(data[trim_end:])
1078
800
        # adjust offset and data to the parseable data.
1079
801
        trimmed_data = data[trim_start:trim_end]
1080
 
        if not (trimmed_data):
1081
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
1082
 
                % (trim_start, trim_end, offset, offset + len(data)))
 
802
        assert trimmed_data, 'read unneeded data'
1083
803
        if trim_start:
1084
804
            offset += trim_start
1085
805
        # print "parsing", repr(trimmed_data)
1087
807
        lines = trimmed_data.split('\n')
1088
808
        del lines[-1]
1089
809
        pos = offset
1090
 
        first_key, last_key, nodes, _ = self._parse_lines(lines, pos)
1091
 
        for key, value in nodes:
1092
 
            self._bisect_nodes[key] = value
1093
 
        self._parsed_bytes(offset, first_key,
1094
 
            offset + len(trimmed_data), last_key)
1095
 
        return offset + len(trimmed_data), last_segment
1096
 
 
1097
 
    def _parse_lines(self, lines, pos):
 
810
        first_key = None
1098
811
        key = None
1099
 
        first_key = None
1100
 
        trailers = 0
1101
 
        nodes = []
1102
812
        for line in lines:
1103
813
            if line == '':
1104
814
                # must be at the end
1105
 
                if self._size:
1106
 
                    if not (self._size == pos + 1):
1107
 
                        raise AssertionError("%s %s" % (self._size, pos))
1108
 
                trailers += 1
 
815
                assert self._size == pos + 1, "%s %s" % (self._size, pos)
1109
816
                continue
1110
817
            elements = line.split('\0')
1111
818
            if len(elements) != self._expected_elements:
1112
819
                raise errors.BadIndexData(self)
1113
 
            # keys are tuples. Each element is a string that may occur many
1114
 
            # times, so we intern them to save space. AB, RC, 200807
1115
 
            key = tuple([intern(element) for element in elements[:self._key_length]])
 
820
            # keys are tuples
 
821
            key = tuple(elements[:self._key_length])
1116
822
            if first_key is None:
1117
823
                first_key = key
1118
824
            absent, references, value = elements[-3:]
1130
836
                node_value = (value, ref_lists)
1131
837
            else:
1132
838
                node_value = value
1133
 
            nodes.append((key, node_value))
 
839
            self._bisect_nodes[key] = node_value
1134
840
            # print "parsed ", key
1135
 
        return first_key, key, nodes, trailers
 
841
        self._parsed_bytes(offset, first_key, offset + len(trimmed_data), key)
1136
842
 
1137
843
    def _parsed_bytes(self, start, start_key, end, end_key):
1138
844
        """Mark the bytes from start to end as parsed.
1164
870
                self._parsed_byte_map[index + 1][1])
1165
871
            self._parsed_key_map[index] = (self._parsed_key_map[index][0],
1166
872
                self._parsed_key_map[index + 1][1])
1167
 
            del self._parsed_byte_map[index + 1]
1168
 
            del self._parsed_key_map[index + 1]
1169
873
        elif self._parsed_byte_map[index][1] == start:
1170
874
            # extend the lower entry
1171
875
            self._parsed_byte_map[index] = (
1183
887
            # new entry
1184
888
            self._parsed_byte_map.insert(index + 1, new_value)
1185
889
            self._parsed_key_map.insert(index + 1, new_key)
 
890
        assert sorted(self._parsed_byte_map) == self._parsed_byte_map
 
891
        assert sorted(self._parsed_key_map) == self._parsed_key_map
1186
892
 
1187
893
    def _read_and_parse(self, readv_ranges):
1188
 
        """Read the ranges and parse the resulting data.
 
894
        """Read the the ranges and parse the resulting data.
1189
895
 
1190
896
        :param readv_ranges: A prepared readv range list.
1191
897
        """
1192
 
        if not readv_ranges:
1193
 
            return
1194
 
        if self._nodes is None and self._bytes_read * 2 >= self._size:
1195
 
            # We've already read more than 50% of the file and we are about to
1196
 
            # request more data, just _buffer_all() and be done
1197
 
            self._buffer_all()
1198
 
            return
1199
 
 
1200
 
        base_offset = self._base_offset
1201
 
        if base_offset != 0:
1202
 
            # Rewrite the ranges for the offset
1203
 
            readv_ranges = [(start+base_offset, size)
1204
 
                            for start, size in readv_ranges]
1205
 
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1206
 
            self._size + self._base_offset)
1207
 
        # parse
1208
 
        for offset, data in readv_data:
1209
 
            offset -= base_offset
1210
 
            self._bytes_read += len(data)
1211
 
            if offset < 0:
1212
 
                # transport.readv() expanded to extra data which isn't part of
1213
 
                # this index
1214
 
                data = data[-offset:]
1215
 
                offset = 0
1216
 
            if offset == 0 and len(data) == self._size:
1217
 
                # We read the whole range, most likely because the
1218
 
                # Transport upcast our readv ranges into one long request
1219
 
                # for enough total data to grab the whole index.
1220
 
                self._buffer_all(StringIO(data))
1221
 
                return
1222
 
            if self._bisect_nodes is None:
1223
 
                # this must be the start
1224
 
                if not (offset == 0):
1225
 
                    raise AssertionError()
1226
 
                offset, data = self._parse_header_from_bytes(data)
1227
 
            # print readv_ranges, "[%d:%d]" % (offset, offset + len(data))
1228
 
            self._parse_region(offset, data)
 
898
        if readv_ranges:
 
899
            readv_data = self._transport.readv(self._name, readv_ranges, True,
 
900
                self._size)
 
901
            # parse
 
902
            for offset, data in readv_data:
 
903
                if self._bisect_nodes is None:
 
904
                    # this must be the start
 
905
                    assert offset == 0
 
906
                    offset, data = self._parse_header_from_bytes(data)
 
907
                self._parse_region(offset, data)
 
908
                # print offset, len(data), data
1229
909
 
1230
910
    def _signature(self):
1231
911
        """The file signature for this index type."""
1240
920
 
1241
921
class CombinedGraphIndex(object):
1242
922
    """A GraphIndex made up from smaller GraphIndices.
1243
 
 
 
923
    
1244
924
    The backing indices must implement GraphIndex, and are presumed to be
1245
925
    static data.
1246
926
 
1247
927
    Queries against the combined index will be made against the first index,
1248
 
    and then the second and so on. The order of indices can thus influence
 
928
    and then the second and so on. The order of index's can thus influence
1249
929
    performance significantly. For example, if one index is on local disk and a
1250
930
    second on a remote server, the local disk index should be before the other
1251
931
    in the index list.
1252
 
    
1253
 
    Also, queries tend to need results from the same indices as previous
1254
 
    queries.  So the indices will be reordered after every query to put the
1255
 
    indices that had the result(s) of that query first (while otherwise
1256
 
    preserving the relative ordering).
1257
932
    """
1258
933
 
1259
 
    def __init__(self, indices, reload_func=None):
 
934
    def __init__(self, indices):
1260
935
        """Create a CombinedGraphIndex backed by indices.
1261
936
 
1262
937
        :param indices: An ordered list of indices to query for data.
1263
 
        :param reload_func: A function to call if we find we are missing an
1264
 
            index. Should have the form reload_func() => True/False to indicate
1265
 
            if reloading actually changed anything.
1266
938
        """
1267
939
        self._indices = indices
1268
 
        self._reload_func = reload_func
1269
 
        # Sibling indices are other CombinedGraphIndex that we should call
1270
 
        # _move_to_front_by_name on when we auto-reorder ourself.
1271
 
        self._sibling_indices = []
1272
 
        # A list of names that corresponds to the instances in self._indices,
1273
 
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
1274
 
        # indices must all use the same set of names as each other.
1275
 
        self._index_names = [None] * len(self._indices)
1276
940
 
1277
941
    def __repr__(self):
1278
942
        return "%s(%s)" % (
1279
943
                self.__class__.__name__,
1280
944
                ', '.join(map(repr, self._indices)))
1281
945
 
1282
 
    def clear_cache(self):
1283
 
        """See GraphIndex.clear_cache()"""
1284
 
        for index in self._indices:
1285
 
            index.clear_cache()
1286
 
 
1287
 
    def get_parent_map(self, keys):
1288
 
        """See graph.StackedParentsProvider.get_parent_map"""
1289
 
        search_keys = set(keys)
1290
 
        if NULL_REVISION in search_keys:
1291
 
            search_keys.discard(NULL_REVISION)
1292
 
            found_parents = {NULL_REVISION:[]}
1293
 
        else:
1294
 
            found_parents = {}
1295
 
        for index, key, value, refs in self.iter_entries(search_keys):
1296
 
            parents = refs[0]
1297
 
            if not parents:
1298
 
                parents = (NULL_REVISION,)
1299
 
            found_parents[key] = parents
1300
 
        return found_parents
1301
 
 
1302
 
    has_key = _has_key_from_parent_map
1303
 
 
1304
 
    def insert_index(self, pos, index, name=None):
 
946
    def insert_index(self, pos, index):
1305
947
        """Insert a new index in the list of indices to query.
1306
948
 
1307
949
        :param pos: The position to insert the index.
1308
950
        :param index: The index to insert.
1309
 
        :param name: a name for this index, e.g. a pack name.  These names can
1310
 
            be used to reflect index reorderings to related CombinedGraphIndex
1311
 
            instances that use the same names.  (see set_sibling_indices)
1312
951
        """
1313
952
        self._indices.insert(pos, index)
1314
 
        self._index_names.insert(pos, name)
1315
953
 
1316
954
    def iter_all_entries(self):
1317
955
        """Iterate over all keys within the index
1324
962
            the most efficient order for the index.
1325
963
        """
1326
964
        seen_keys = set()
1327
 
        while True:
1328
 
            try:
1329
 
                for index in self._indices:
1330
 
                    for node in index.iter_all_entries():
1331
 
                        if node[1] not in seen_keys:
1332
 
                            yield node
1333
 
                            seen_keys.add(node[1])
1334
 
                return
1335
 
            except errors.NoSuchFile:
1336
 
                self._reload_or_raise()
 
965
        for index in self._indices:
 
966
            for node in index.iter_all_entries():
 
967
                if node[1] not in seen_keys:
 
968
                    yield node
 
969
                    seen_keys.add(node[1])
1337
970
 
1338
971
    def iter_entries(self, keys):
1339
972
        """Iterate over keys within the index.
1342
975
        value and are only reported once.
1343
976
 
1344
977
        :param keys: An iterable providing the keys to be retrieved.
1345
 
        :return: An iterable of (index, key, reference_lists, value). There is
1346
 
            no defined order for the result iteration - it will be in the most
 
978
        :return: An iterable of (index, key, reference_lists, value). There is no
 
979
            defined order for the result iteration - it will be in the most
1347
980
            efficient order for the index.
1348
981
        """
1349
982
        keys = set(keys)
1350
 
        hit_indices = []
1351
 
        while True:
1352
 
            try:
1353
 
                for index in self._indices:
1354
 
                    if not keys:
1355
 
                        break
1356
 
                    index_hit = False
1357
 
                    for node in index.iter_entries(keys):
1358
 
                        keys.remove(node[1])
1359
 
                        yield node
1360
 
                        index_hit = True
1361
 
                    if index_hit:
1362
 
                        hit_indices.append(index)
1363
 
                break
1364
 
            except errors.NoSuchFile:
1365
 
                self._reload_or_raise()
1366
 
        self._move_to_front(hit_indices)
 
983
        for index in self._indices:
 
984
            if not keys:
 
985
                return
 
986
            for node in index.iter_entries(keys):
 
987
                keys.remove(node[1])
 
988
                yield node
1367
989
 
1368
990
    def iter_entries_prefix(self, keys):
1369
991
        """Iterate over keys within the index using prefix matching.
1389
1011
        if not keys:
1390
1012
            return
1391
1013
        seen_keys = set()
1392
 
        hit_indices = []
1393
 
        while True:
1394
 
            try:
1395
 
                for index in self._indices:
1396
 
                    index_hit = False
1397
 
                    for node in index.iter_entries_prefix(keys):
1398
 
                        if node[1] in seen_keys:
1399
 
                            continue
1400
 
                        seen_keys.add(node[1])
1401
 
                        yield node
1402
 
                        index_hit = True
1403
 
                    if index_hit:
1404
 
                        hit_indices.append(index)
1405
 
                break
1406
 
            except errors.NoSuchFile:
1407
 
                self._reload_or_raise()
1408
 
        self._move_to_front(hit_indices)
1409
 
 
1410
 
    def _move_to_front(self, hit_indices):
1411
 
        """Rearrange self._indices so that hit_indices are first.
1412
 
 
1413
 
        Order is maintained as much as possible, e.g. the first unhit index
1414
 
        will be the first index in _indices after the hit_indices, and the
1415
 
        hit_indices will be present in exactly the order they are passed to
1416
 
        _move_to_front.
1417
 
 
1418
 
        _move_to_front propagates to all objects in self._sibling_indices by
1419
 
        calling _move_to_front_by_name.
1420
 
        """
1421
 
        if self._indices[:len(hit_indices)] == hit_indices:
1422
 
            # The 'hit_indices' are already at the front (and in the same
1423
 
            # order), no need to re-order
1424
 
            return
1425
 
        hit_names = self._move_to_front_by_index(hit_indices)
1426
 
        for sibling_idx in self._sibling_indices:
1427
 
            sibling_idx._move_to_front_by_name(hit_names)
1428
 
 
1429
 
    def _move_to_front_by_index(self, hit_indices):
1430
 
        """Core logic for _move_to_front.
1431
 
        
1432
 
        Returns a list of names corresponding to the hit_indices param.
1433
 
        """
1434
 
        indices_info = zip(self._index_names, self._indices)
1435
 
        if 'index' in debug.debug_flags:
1436
 
            mutter('CombinedGraphIndex reordering: currently %r, promoting %r',
1437
 
                   indices_info, hit_indices)
1438
 
        hit_names = []
1439
 
        unhit_names = []
1440
 
        new_hit_indices = []
1441
 
        unhit_indices = []
1442
 
 
1443
 
        for offset, (name, idx) in enumerate(indices_info):
1444
 
            if idx in hit_indices:
1445
 
                hit_names.append(name)
1446
 
                new_hit_indices.append(idx)
1447
 
                if len(new_hit_indices) == len(hit_indices):
1448
 
                    # We've found all of the hit entries, everything else is
1449
 
                    # unhit
1450
 
                    unhit_names.extend(self._index_names[offset+1:])
1451
 
                    unhit_indices.extend(self._indices[offset+1:])
1452
 
                    break
1453
 
            else:
1454
 
                unhit_names.append(name)
1455
 
                unhit_indices.append(idx)
1456
 
 
1457
 
        self._indices = new_hit_indices + unhit_indices
1458
 
        self._index_names = hit_names + unhit_names
1459
 
        if 'index' in debug.debug_flags:
1460
 
            mutter('CombinedGraphIndex reordered: %r', self._indices)
1461
 
        return hit_names
1462
 
 
1463
 
    def _move_to_front_by_name(self, hit_names):
1464
 
        """Moves indices named by 'hit_names' to front of the search order, as
1465
 
        described in _move_to_front.
1466
 
        """
1467
 
        # Translate names to index instances, and then call
1468
 
        # _move_to_front_by_index.
1469
 
        indices_info = zip(self._index_names, self._indices)
1470
 
        hit_indices = []
1471
 
        for name, idx in indices_info:
1472
 
            if name in hit_names:
1473
 
                hit_indices.append(idx)
1474
 
        self._move_to_front_by_index(hit_indices)
1475
 
 
1476
 
    def find_ancestry(self, keys, ref_list_num):
1477
 
        """Find the complete ancestry for the given set of keys.
1478
 
 
1479
 
        Note that this is a whole-ancestry request, so it should be used
1480
 
        sparingly.
1481
 
 
1482
 
        :param keys: An iterable of keys to look for
1483
 
        :param ref_list_num: The reference list which references the parents
1484
 
            we care about.
1485
 
        :return: (parent_map, missing_keys)
1486
 
        """
1487
 
        # XXX: make this call _move_to_front?
1488
 
        missing_keys = set()
1489
 
        parent_map = {}
1490
 
        keys_to_lookup = set(keys)
1491
 
        generation = 0
1492
 
        while keys_to_lookup:
1493
 
            # keys that *all* indexes claim are missing, stop searching them
1494
 
            generation += 1
1495
 
            all_index_missing = None
1496
 
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
1497
 
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
1498
 
            #                                   len(parent_map),
1499
 
            #                                   len(missing_keys))
1500
 
            for index_idx, index in enumerate(self._indices):
1501
 
                # TODO: we should probably be doing something with
1502
 
                #       'missing_keys' since we've already determined that
1503
 
                #       those revisions have not been found anywhere
1504
 
                index_missing_keys = set()
1505
 
                # Find all of the ancestry we can from this index
1506
 
                # keep looking until the search_keys set is empty, which means
1507
 
                # things we didn't find should be in index_missing_keys
1508
 
                search_keys = keys_to_lookup
1509
 
                sub_generation = 0
1510
 
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
1511
 
                #     index_idx, len(search_keys),
1512
 
                #     len(parent_map), len(index_missing_keys))
1513
 
                while search_keys:
1514
 
                    sub_generation += 1
1515
 
                    # TODO: ref_list_num should really be a parameter, since
1516
 
                    #       CombinedGraphIndex does not know what the ref lists
1517
 
                    #       mean.
1518
 
                    search_keys = index._find_ancestors(search_keys,
1519
 
                        ref_list_num, parent_map, index_missing_keys)
1520
 
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
1521
 
                    #     sub_generation, len(search_keys),
1522
 
                    #     len(parent_map), len(index_missing_keys))
1523
 
                # Now set whatever was missing to be searched in the next index
1524
 
                keys_to_lookup = index_missing_keys
1525
 
                if all_index_missing is None:
1526
 
                    all_index_missing = set(index_missing_keys)
1527
 
                else:
1528
 
                    all_index_missing.intersection_update(index_missing_keys)
1529
 
                if not keys_to_lookup:
1530
 
                    break
1531
 
            if all_index_missing is None:
1532
 
                # There were no indexes, so all search keys are 'missing'
1533
 
                missing_keys.update(keys_to_lookup)
1534
 
                keys_to_lookup = None
1535
 
            else:
1536
 
                missing_keys.update(all_index_missing)
1537
 
                keys_to_lookup.difference_update(all_index_missing)
1538
 
        return parent_map, missing_keys
 
1014
        for index in self._indices:
 
1015
            for node in index.iter_entries_prefix(keys):
 
1016
                if node[1] in seen_keys:
 
1017
                    continue
 
1018
                seen_keys.add(node[1])
 
1019
                yield node
1539
1020
 
1540
1021
    def key_count(self):
1541
1022
        """Return an estimate of the number of keys in this index.
1542
 
 
 
1023
        
1543
1024
        For CombinedGraphIndex this is approximated by the sum of the keys of
1544
1025
        the child indices. As child indices may have duplicate keys this can
1545
1026
        have a maximum error of the number of child indices * largest number of
1546
1027
        keys in any index.
1547
1028
        """
1548
 
        while True:
1549
 
            try:
1550
 
                return sum((index.key_count() for index in self._indices), 0)
1551
 
            except errors.NoSuchFile:
1552
 
                self._reload_or_raise()
1553
 
 
1554
 
    missing_keys = _missing_keys_from_parent_map
1555
 
 
1556
 
    def _reload_or_raise(self):
1557
 
        """We just got a NoSuchFile exception.
1558
 
 
1559
 
        Try to reload the indices, if it fails, just raise the current
1560
 
        exception.
1561
 
        """
1562
 
        if self._reload_func is None:
1563
 
            raise
1564
 
        exc_type, exc_value, exc_traceback = sys.exc_info()
1565
 
        trace.mutter('Trying to reload after getting exception: %s',
1566
 
                     exc_value)
1567
 
        if not self._reload_func():
1568
 
            # We tried to reload, but nothing changed, so we fail anyway
1569
 
            trace.mutter('_reload_func indicated nothing has changed.'
1570
 
                         ' Raising original exception.')
1571
 
            raise exc_type, exc_value, exc_traceback
1572
 
 
1573
 
    def set_sibling_indices(self, sibling_combined_graph_indices):
1574
 
        """Set the CombinedGraphIndex objects to reorder after reordering self.
1575
 
        """
1576
 
        self._sibling_indices = sibling_combined_graph_indices
 
1029
        return sum((index.key_count() for index in self._indices), 0)
1577
1030
 
1578
1031
    def validate(self):
1579
1032
        """Validate that everything in the index can be accessed."""
1580
 
        while True:
1581
 
            try:
1582
 
                for index in self._indices:
1583
 
                    index.validate()
1584
 
                return
1585
 
            except errors.NoSuchFile:
1586
 
                self._reload_or_raise()
 
1033
        for index in self._indices:
 
1034
            index.validate()
1587
1035
 
1588
1036
 
1589
1037
class InMemoryGraphIndex(GraphIndexBuilder):
1629
1077
        """Iterate over keys within the index.
1630
1078
 
1631
1079
        :param keys: An iterable providing the keys to be retrieved.
1632
 
        :return: An iterable of (index, key, value, reference_lists). There is no
 
1080
        :return: An iterable of (index, key, reference_lists, value). There is no
1633
1081
            defined order for the result iteration - it will be in the most
1634
1082
            efficient order for the index (keys iteration order in this case).
1635
1083
        """
1636
 
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
1637
 
        #       aren't using set().intersection() here
1638
 
        nodes = self._nodes
1639
 
        keys = [key for key in keys if key in nodes]
 
1084
        keys = set(keys)
1640
1085
        if self.reference_lists:
1641
 
            for key in keys:
1642
 
                node = nodes[key]
 
1086
            for key in keys.intersection(self._keys):
 
1087
                node = self._nodes[key]
1643
1088
                if not node[0]:
1644
1089
                    yield self, key, node[2], node[1]
1645
1090
        else:
1646
 
            for key in keys:
1647
 
                node = nodes[key]
 
1091
            for key in keys.intersection(self._keys):
 
1092
                node = self._nodes[key]
1648
1093
                if not node[0]:
1649
1094
                    yield self, key, node[2]
1650
1095
 
1679
1124
                    raise errors.BadIndexKey(key)
1680
1125
                node = self._nodes[key]
1681
1126
                if node[0]:
1682
 
                    continue
 
1127
                    continue 
1683
1128
                if self.reference_lists:
1684
1129
                    yield self, key, node[2], node[1]
1685
1130
                else:
1686
1131
                    yield self, key, node[2]
1687
1132
            return
1688
 
        nodes_by_key = self._get_nodes_by_key()
1689
1133
        for key in keys:
1690
1134
            # sanity check
1691
1135
            if key[0] is None:
1693
1137
            if len(key) != self._key_length:
1694
1138
                raise errors.BadIndexKey(key)
1695
1139
            # find what it refers to:
1696
 
            key_dict = nodes_by_key
 
1140
            key_dict = self._nodes_by_key
1697
1141
            elements = list(key)
1698
1142
            # find the subdict to return
1699
1143
            try:
1710
1154
                    # can't be empty or would not exist
1711
1155
                    item, value = key_dict.iteritems().next()
1712
1156
                    if type(value) == dict:
1713
 
                        # push keys
 
1157
                        # push keys 
1714
1158
                        dicts.extend(key_dict.itervalues())
1715
1159
                    else:
1716
1160
                        # yield keys
1721
1165
 
1722
1166
    def key_count(self):
1723
1167
        """Return an estimate of the number of keys in this index.
1724
 
 
 
1168
        
1725
1169
        For InMemoryGraphIndex the estimate is exact.
1726
1170
        """
1727
 
        return len(self._nodes) - len(self._absent_keys)
 
1171
        return len(self._keys)
1728
1172
 
1729
1173
    def validate(self):
1730
1174
        """In memory index's have no known corruption at the moment."""
1735
1179
 
1736
1180
    Queries against this will emit queries against the adapted Graph with the
1737
1181
    prefix added, queries for all items use iter_entries_prefix. The returned
1738
 
    nodes will have their keys and node references adjusted to remove the
 
1182
    nodes will have their keys and node references adjusted to remove the 
1739
1183
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1740
1184
    nodes and references being added will have prefix prepended.
1741
1185
    """
1768
1212
                    adjusted_references))
1769
1213
        except ValueError:
1770
1214
            # XXX: TODO add an explicit interface for getting the reference list
1771
 
            # status, to handle this bit of user-friendliness in the API more
 
1215
            # status, to handle this bit of user-friendliness in the API more 
1772
1216
            # explicitly.
1773
1217
            for (key, value) in nodes:
1774
1218
                translated_nodes.append((self.prefix + key, value))
1817
1261
        """Iterate over keys within the index.
1818
1262
 
1819
1263
        :param keys: An iterable providing the keys to be retrieved.
1820
 
        :return: An iterable of (index, key, value, reference_lists). There is no
 
1264
        :return: An iterable of (key, reference_lists, value). There is no
1821
1265
            defined order for the result iteration - it will be in the most
1822
1266
            efficient order for the index (keys iteration order in this case).
1823
1267
        """
1846
1290
 
1847
1291
    def key_count(self):
1848
1292
        """Return an estimate of the number of keys in this index.
1849
 
 
 
1293
        
1850
1294
        For GraphIndexPrefixAdapter this is relatively expensive - key
1851
1295
        iteration with the prefix is done.
1852
1296
        """