← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Indexing facilities."""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
__all__ = [
20
22
    'CombinedGraphIndex',
21
23
    'GraphIndex',
27
29
from bisect import bisect_right
28
30
from cStringIO import StringIO
29
31
import re
 
32
import sys
30
33
 
31
34
from bzrlib.lazy_import import lazy_import
32
35
lazy_import(globals(), """
33
 
from bzrlib import trace
34
 
from bzrlib.bisect_multi import bisect_multi_bytes
35
 
from bzrlib.revision import NULL_REVISION
36
 
from bzrlib.trace import mutter
 
36
from bzrlib import (
 
37
    bisect_multi,
 
38
    revision as _mod_revision,
 
39
    trace,
 
40
    )
37
41
""")
38
42
from bzrlib import (
39
43
    debug,
40
44
    errors,
41
 
    symbol_versioning,
42
45
    )
 
46
from bzrlib.static_tuple import StaticTuple
43
47
 
44
48
_HEADER_READV = (0, 200)
45
49
_OPTION_KEY_ELEMENTS = "key_elements="
52
56
_newline_null_re = re.compile('[\n\0]')
53
57
 
54
58
 
 
59
def _has_key_from_parent_map(self, key):
 
60
    """Check if this index has one key.
 
61
 
 
62
    If it's possible to check for multiple keys at once through
 
63
    calling get_parent_map that should be faster.
 
64
    """
 
65
    return (key in self.get_parent_map([key]))
 
66
 
 
67
 
 
68
def _missing_keys_from_parent_map(self, keys):
 
69
    return set(keys) - set(self.get_parent_map(keys))
 
70
 
 
71
 
55
72
class GraphIndexBuilder(object):
56
73
    """A builder that can build a GraphIndex.
57
 
    
58
 
    The resulting graph has the structure:
59
 
    
60
 
    _SIGNATURE OPTIONS NODES NEWLINE
61
 
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
62
 
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
63
 
    NODES          := NODE*
64
 
    NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
65
 
    KEY            := Not-whitespace-utf8
66
 
    ABSENT         := 'a'
67
 
    REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
68
 
    REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
69
 
    REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
70
 
                              ; referenced key.
71
 
    VALUE          := no-newline-no-null-bytes
 
74
 
 
75
    The resulting graph has the structure::
 
76
 
 
77
      _SIGNATURE OPTIONS NODES NEWLINE
 
78
      _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
 
79
      OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
 
80
      NODES          := NODE*
 
81
      NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
 
82
      KEY            := Not-whitespace-utf8
 
83
      ABSENT         := 'a'
 
84
      REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
 
85
      REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
 
86
      REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
 
87
                                ; referenced key.
 
88
      VALUE          := no-newline-no-null-bytes
72
89
    """
73
90
 
74
91
    def __init__(self, reference_lists=0, key_elements=1):
79
96
        :param key_elements: The number of bytestrings in each key.
80
97
        """
81
98
        self.reference_lists = reference_lists
82
 
        self._keys = set()
83
99
        # A dict of {key: (absent, ref_lists, value)}
84
100
        self._nodes = {}
 
101
        # Keys that are referenced but not actually present in this index
 
102
        self._absent_keys = set()
85
103
        self._nodes_by_key = None
86
104
        self._key_length = key_elements
 
105
        self._optimize_for_size = False
 
106
        self._combine_backing_indices = True
87
107
 
88
108
    def _check_key(self, key):
89
109
        """Raise BadIndexKey if key is not a valid key for this index."""
90
 
        if type(key) != tuple:
 
110
        if type(key) not in (tuple, StaticTuple):
91
111
            raise errors.BadIndexKey(key)
92
112
        if self._key_length != len(key):
93
113
            raise errors.BadIndexKey(key)
95
115
            if not element or _whitespace_re.search(element) is not None:
96
116
                raise errors.BadIndexKey(element)
97
117
 
 
118
    def _external_references(self):
 
119
        """Return references that are not present in this index.
 
120
        """
 
121
        keys = set()
 
122
        refs = set()
 
123
        # TODO: JAM 2008-11-21 This makes an assumption about how the reference
 
124
        #       lists are used. It is currently correct for pack-0.92 through
 
125
        #       1.9, which use the node references (3rd column) second
 
126
        #       reference list as the compression parent. Perhaps this should
 
127
        #       be moved into something higher up the stack, since it
 
128
        #       makes assumptions about how the index is used.
 
129
        if self.reference_lists > 1:
 
130
            for node in self.iter_all_entries():
 
131
                keys.add(node[1])
 
132
                refs.update(node[3][1])
 
133
            return refs - keys
 
134
        else:
 
135
            # If reference_lists == 0 there can be no external references, and
 
136
            # if reference_lists == 1, then there isn't a place to store the
 
137
            # compression parent
 
138
            return set()
 
139
 
98
140
    def _get_nodes_by_key(self):
99
141
        if self._nodes_by_key is None:
100
142
            nodes_by_key = {}
127
169
            return
128
170
        key_dict = self._nodes_by_key
129
171
        if self.reference_lists:
130
 
            key_value = key, value, node_refs
 
172
            key_value = StaticTuple(key, value, node_refs)
131
173
        else:
132
 
            key_value = key, value
 
174
            key_value = StaticTuple(key, value)
133
175
        for subkey in key[:-1]:
134
176
            key_dict = key_dict.setdefault(subkey, {})
135
177
        key_dict[key[-1]] = key_value
145
187
        :param value: The value associate with this key. Must not contain
146
188
            newlines or null characters.
147
189
        :return: (node_refs, absent_references)
148
 
            node_refs   basically a packed form of 'references' where all
149
 
                        iterables are tuples
150
 
            absent_references   reference keys that are not in self._nodes.
151
 
                                This may contain duplicates if the same key is
152
 
                                referenced in multiple lists.
 
190
        
 
191
            * node_refs: basically a packed form of 'references' where all
 
192
              iterables are tuples
 
193
            * absent_references: reference keys that are not in self._nodes.
 
194
              This may contain duplicates if the same key is referenced in
 
195
              multiple lists.
153
196
        """
 
197
        as_st = StaticTuple.from_sequence
154
198
        self._check_key(key)
155
199
        if _newline_null_re.search(value) is not None:
156
200
            raise errors.BadIndexValue(value)
165
209
                if reference not in self._nodes:
166
210
                    self._check_key(reference)
167
211
                    absent_references.append(reference)
168
 
            node_refs.append(tuple(reference_list))
169
 
        return tuple(node_refs), absent_references
 
212
            reference_list = as_st([as_st(ref).intern()
 
213
                                    for ref in reference_list])
 
214
            node_refs.append(reference_list)
 
215
        return as_st(node_refs), absent_references
170
216
 
171
217
    def add_node(self, key, value, references=()):
172
218
        """Add a node to the index.
177
223
        :param references: An iterable of iterables of keys. Each is a
178
224
            reference to another key.
179
225
        :param value: The value to associate with the key. It may be any
180
 
            bytes as long as it does not contain \0 or \n.
 
226
            bytes as long as it does not contain \\0 or \\n.
181
227
        """
182
228
        (node_refs,
183
229
         absent_references) = self._check_key_ref_value(key, references, value)
187
233
            # There may be duplicates, but I don't think it is worth worrying
188
234
            # about
189
235
            self._nodes[reference] = ('a', (), '')
 
236
        self._absent_keys.update(absent_references)
 
237
        self._absent_keys.discard(key)
190
238
        self._nodes[key] = ('', node_refs, value)
191
 
        self._keys.add(key)
192
239
        if self._nodes_by_key is not None and self._key_length > 1:
193
240
            self._update_nodes_by_key(key, value, node_refs)
194
241
 
 
242
    def clear_cache(self):
 
243
        """See GraphIndex.clear_cache()
 
244
 
 
245
        This is a no-op, but we need the api to conform to a generic 'Index'
 
246
        abstraction.
 
247
        """
 
248
        
195
249
    def finish(self):
 
250
        """Finish the index.
 
251
 
 
252
        :returns: cStringIO holding the full context of the index as it 
 
253
        should be written to disk.
 
254
        """
196
255
        lines = [_SIGNATURE]
197
256
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
198
257
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
199
 
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
 
258
        key_count = len(self._nodes) - len(self._absent_keys)
 
259
        lines.append(_OPTION_LEN + str(key_count) + '\n')
200
260
        prefix_length = sum(len(x) for x in lines)
201
261
        # references are byte offsets. To avoid having to do nasty
202
262
        # polynomial work to resolve offsets (references to later in the
209
269
        # one to pad all the data with reference-length and determine entry
210
270
        # addresses.
211
271
        # One to serialise.
212
 
        
 
272
 
213
273
        # forward sorted by key. In future we may consider topological sorting,
214
274
        # at the cost of table scans for direct lookup, or a second index for
215
275
        # direct lookup
278
338
                (len(result.getvalue()), expected_bytes))
279
339
        return result
280
340
 
 
341
    def set_optimize(self, for_size=None, combine_backing_indices=None):
 
342
        """Change how the builder tries to optimize the result.
 
343
 
 
344
        :param for_size: Tell the builder to try and make the index as small as
 
345
            possible.
 
346
        :param combine_backing_indices: If the builder spills to disk to save
 
347
            memory, should the on-disk indices be combined. Set to True if you
 
348
            are going to be probing the index, but to False if you are not. (If
 
349
            you are not querying, then the time spent combining is wasted.)
 
350
        :return: None
 
351
        """
 
352
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
 
353
        # other builders do.
 
354
        if for_size is not None:
 
355
            self._optimize_for_size = for_size
 
356
        if combine_backing_indices is not None:
 
357
            self._combine_backing_indices = combine_backing_indices
 
358
 
 
359
    def find_ancestry(self, keys, ref_list_num):
 
360
        """See CombinedGraphIndex.find_ancestry()"""
 
361
        pending = set(keys)
 
362
        parent_map = {}
 
363
        missing_keys = set()
 
364
        while pending:
 
365
            next_pending = set()
 
366
            for _, key, value, ref_lists in self.iter_entries(pending):
 
367
                parent_keys = ref_lists[ref_list_num]
 
368
                parent_map[key] = parent_keys
 
369
                next_pending.update([p for p in parent_keys if p not in
 
370
                                     parent_map])
 
371
                missing_keys.update(pending.difference(parent_map))
 
372
            pending = next_pending
 
373
        return parent_map, missing_keys
 
374
 
281
375
 
282
376
class GraphIndex(object):
283
377
    """An index for data with embedded graphs.
284
 
 
 
378
 
285
379
    The index maps keys to a list of key reference lists, and a value.
286
380
    Each node has the same number of key reference lists. Each key reference
287
381
    list can be empty or an arbitrary length. The value is an opaque NULL
288
 
    terminated string without any newlines. The storage of the index is 
 
382
    terminated string without any newlines. The storage of the index is
289
383
    hidden in the interface: keys and key references are always tuples of
290
384
    bytestrings, never the internal representation (e.g. dictionary offsets).
291
385
 
297
391
    suitable for production use. :XXX
298
392
    """
299
393
 
300
 
    def __init__(self, transport, name, size):
 
394
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
301
395
        """Open an index called name on transport.
302
396
 
303
397
        :param transport: A bzrlib.transport.Transport.
309
403
            avoided by having it supplied. If size is None, then bisection
310
404
            support will be disabled and accessing the index will just stream
311
405
            all the data.
 
406
        :param offset: Instead of starting the index data at offset 0, start it
 
407
            at an arbitrary offset.
312
408
        """
313
409
        self._transport = transport
314
410
        self._name = name
331
427
        self._size = size
332
428
        # The number of bytes we've read so far in trying to process this file
333
429
        self._bytes_read = 0
 
430
        self._base_offset = offset
334
431
 
335
432
    def __eq__(self, other):
336
433
        """Equal when self and other were created with the same parameters."""
356
453
            # We already did this
357
454
            return
358
455
        if 'index' in debug.debug_flags:
359
 
            mutter('Reading entire index %s', self._transport.abspath(self._name))
 
456
            trace.mutter('Reading entire index %s',
 
457
                          self._transport.abspath(self._name))
360
458
        if stream is None:
361
459
            stream = self._transport.get(self._name)
 
460
            if self._base_offset != 0:
 
461
                # This is wasteful, but it is better than dealing with
 
462
                # adjusting all the offsets, etc.
 
463
                stream = StringIO(stream.read()[self._base_offset:])
362
464
        self._read_prefix(stream)
363
465
        self._expected_elements = 3 + self._key_length
364
466
        line_count = 0
366
468
        self._keys_by_offset = {}
367
469
        # ready-to-return key:value or key:value, node_ref_lists
368
470
        self._nodes = {}
369
 
        self._nodes_by_key = {}
 
471
        self._nodes_by_key = None
370
472
        trailers = 0
371
473
        pos = stream.tell()
372
474
        lines = stream.read().split('\n')
 
475
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
 
476
        stream.close()
373
477
        del lines[-1]
374
478
        _, _, _, trailers = self._parse_lines(lines, pos)
375
479
        for key, absent, references, value in self._keys_by_offset.itervalues():
381
485
            else:
382
486
                node_value = value
383
487
            self._nodes[key] = node_value
384
 
            if self._key_length > 1:
385
 
                # TODO: We may want to do this lazily, but if we are calling
386
 
                #       _buffer_all, we are likely to be doing
387
 
                #       iter_entries_prefix
388
 
                key_dict = self._nodes_by_key
389
 
                if self.node_ref_lists:
390
 
                    key_value = key, node_value[0], node_value[1]
391
 
                else:
392
 
                    key_value = key, node_value
393
 
                # For a key of (foo, bar, baz) create
394
 
                # _nodes_by_key[foo][bar][baz] = key_value
395
 
                for subkey in key[:-1]:
396
 
                    key_dict = key_dict.setdefault(subkey, {})
397
 
                key_dict[key[-1]] = key_value
398
488
        # cache the keys for quick set intersections
399
 
        self._keys = set(self._nodes)
400
489
        if trailers != 1:
401
490
            # there must be one line - the empty trailer line.
402
491
            raise errors.BadIndexData(self)
403
492
 
 
493
    def clear_cache(self):
 
494
        """Clear out any cached/memoized values.
 
495
 
 
496
        This can be called at any time, but generally it is used when we have
 
497
        extracted some information, but don't expect to be requesting any more
 
498
        from this index.
 
499
        """
 
500
 
 
501
    def external_references(self, ref_list_num):
 
502
        """Return references that are not present in this index.
 
503
        """
 
504
        self._buffer_all()
 
505
        if ref_list_num + 1 > self.node_ref_lists:
 
506
            raise ValueError('No ref list %d, index has %d ref lists'
 
507
                % (ref_list_num, self.node_ref_lists))
 
508
        refs = set()
 
509
        nodes = self._nodes
 
510
        for key, (value, ref_lists) in nodes.iteritems():
 
511
            ref_list = ref_lists[ref_list_num]
 
512
            refs.update([ref for ref in ref_list if ref not in nodes])
 
513
        return refs
 
514
 
 
515
    def _get_nodes_by_key(self):
 
516
        if self._nodes_by_key is None:
 
517
            nodes_by_key = {}
 
518
            if self.node_ref_lists:
 
519
                for key, (value, references) in self._nodes.iteritems():
 
520
                    key_dict = nodes_by_key
 
521
                    for subkey in key[:-1]:
 
522
                        key_dict = key_dict.setdefault(subkey, {})
 
523
                    key_dict[key[-1]] = key, value, references
 
524
            else:
 
525
                for key, value in self._nodes.iteritems():
 
526
                    key_dict = nodes_by_key
 
527
                    for subkey in key[:-1]:
 
528
                        key_dict = key_dict.setdefault(subkey, {})
 
529
                    key_dict[key[-1]] = key, value
 
530
            self._nodes_by_key = nodes_by_key
 
531
        return self._nodes_by_key
 
532
 
404
533
    def iter_all_entries(self):
405
534
        """Iterate over all keys within the index.
406
535
 
450
579
 
451
580
    def _resolve_references(self, references):
452
581
        """Return the resolved key references for references.
453
 
        
 
582
 
454
583
        References are resolved by looking up the location of the key in the
455
584
        _keys_by_offset map and substituting the key name, preserving ordering.
456
585
 
457
 
        :param references: An iterable of iterables of key locations. e.g. 
 
586
        :param references: An iterable of iterables of key locations. e.g.
458
587
            [[123, 456], [123]]
459
588
        :return: A tuple of tuples of keys.
460
589
        """
514
643
 
515
644
    def _iter_entries_from_total_buffer(self, keys):
516
645
        """Iterate over keys when the entire index is parsed."""
517
 
        keys = keys.intersection(self._keys)
 
646
        # Note: See the note in BTreeBuilder.iter_entries for why we don't use
 
647
        #       .intersection() here
 
648
        nodes = self._nodes
 
649
        keys = [key for key in keys if key in nodes]
518
650
        if self.node_ref_lists:
519
651
            for key in keys:
520
 
                value, node_refs = self._nodes[key]
 
652
                value, node_refs = nodes[key]
521
653
                yield self, key, value, node_refs
522
654
        else:
523
655
            for key in keys:
524
 
                yield self, key, self._nodes[key]
 
656
                yield self, key, nodes[key]
525
657
 
526
658
    def iter_entries(self, keys):
527
659
        """Iterate over keys within the index.
549
681
        if self._nodes is not None:
550
682
            return self._iter_entries_from_total_buffer(keys)
551
683
        else:
552
 
            return (result[1] for result in bisect_multi_bytes(
 
684
            return (result[1] for result in bisect_multi.bisect_multi_bytes(
553
685
                self._lookup_keys_via_location, self._size, keys))
554
686
 
555
687
    def iter_entries_prefix(self, keys):
593
725
                else:
594
726
                    yield self, key, self._nodes[key]
595
727
            return
 
728
        nodes_by_key = self._get_nodes_by_key()
596
729
        for key in keys:
597
730
            # sanity check
598
731
            if key[0] is None:
600
733
            if len(key) != self._key_length:
601
734
                raise errors.BadIndexKey(key)
602
735
            # find what it refers to:
603
 
            key_dict = self._nodes_by_key
 
736
            key_dict = nodes_by_key
604
737
            elements = list(key)
605
738
            # find the subdict whose contents should be returned.
606
739
            try:
617
750
                    # can't be empty or would not exist
618
751
                    item, value = key_dict.iteritems().next()
619
752
                    if type(value) == dict:
620
 
                        # push keys 
 
753
                        # push keys
621
754
                        dicts.extend(key_dict.itervalues())
622
755
                    else:
623
756
                        # yield keys
629
762
                # the last thing looked up was a terminal element
630
763
                yield (self, ) + key_dict
631
764
 
 
765
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
 
766
        """See BTreeIndex._find_ancestors."""
 
767
        # The api can be implemented as a trivial overlay on top of
 
768
        # iter_entries, it is not an efficient implementation, but it at least
 
769
        # gets the job done.
 
770
        found_keys = set()
 
771
        search_keys = set()
 
772
        for index, key, value, refs in self.iter_entries(keys):
 
773
            parent_keys = refs[ref_list_num]
 
774
            found_keys.add(key)
 
775
            parent_map[key] = parent_keys
 
776
            search_keys.update(parent_keys)
 
777
        # Figure out what, if anything, was missing
 
778
        missing_keys.update(set(keys).difference(found_keys))
 
779
        search_keys = search_keys.difference(parent_map)
 
780
        return search_keys
 
781
 
632
782
    def key_count(self):
633
783
        """Return an estimate of the number of keys in this index.
634
 
        
 
784
 
635
785
        For GraphIndex the estimate is exact.
636
786
        """
637
787
        if self._key_count is None:
653
803
        # Possible improvements:
654
804
        #  - only bisect lookup each key once
655
805
        #  - sort the keys first, and use that to reduce the bisection window
656
 
        # ----- 
 
806
        # -----
657
807
        # this progresses in three parts:
658
808
        # read data
659
809
        # parse it
668
818
                # We have the key parsed.
669
819
                continue
670
820
            index = self._parsed_key_index(key)
671
 
            if (len(self._parsed_key_map) and 
 
821
            if (len(self._parsed_key_map) and
672
822
                self._parsed_key_map[index][0] <= key and
673
823
                (self._parsed_key_map[index][1] >= key or
674
824
                 # end of the file has been parsed
678
828
                continue
679
829
            # - if we have examined this part of the file already - yes
680
830
            index = self._parsed_byte_index(location)
681
 
            if (len(self._parsed_byte_map) and 
 
831
            if (len(self._parsed_byte_map) and
682
832
                self._parsed_byte_map[index][0] <= location and
683
833
                self._parsed_byte_map[index][1] > location):
684
834
                # the byte region has been parsed, so no read is needed.
939
1089
        # adjust offset and data to the parseable data.
940
1090
        trimmed_data = data[trim_start:trim_end]
941
1091
        if not (trimmed_data):
942
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
 
1092
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
943
1093
                % (trim_start, trim_end, offset, offset + len(data)))
944
1094
        if trim_start:
945
1095
            offset += trim_start
973
1123
                raise errors.BadIndexData(self)
974
1124
            # keys are tuples. Each element is a string that may occur many
975
1125
            # times, so we intern them to save space. AB, RC, 200807
976
 
            key = tuple(intern(element) for element in elements[:self._key_length])
 
1126
            key = tuple([intern(element) for element in elements[:self._key_length]])
977
1127
            if first_key is None:
978
1128
                first_key = key
979
1129
            absent, references, value = elements[-3:]
1046
1196
            self._parsed_key_map.insert(index + 1, new_key)
1047
1197
 
1048
1198
    def _read_and_parse(self, readv_ranges):
1049
 
        """Read the the ranges and parse the resulting data.
 
1199
        """Read the ranges and parse the resulting data.
1050
1200
 
1051
1201
        :param readv_ranges: A prepared readv range list.
1052
1202
        """
1058
1208
            self._buffer_all()
1059
1209
            return
1060
1210
 
 
1211
        base_offset = self._base_offset
 
1212
        if base_offset != 0:
 
1213
            # Rewrite the ranges for the offset
 
1214
            readv_ranges = [(start+base_offset, size)
 
1215
                            for start, size in readv_ranges]
1061
1216
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1062
 
            self._size)
 
1217
            self._size + self._base_offset)
1063
1218
        # parse
1064
1219
        for offset, data in readv_data:
 
1220
            offset -= base_offset
1065
1221
            self._bytes_read += len(data)
 
1222
            if offset < 0:
 
1223
                # transport.readv() expanded to extra data which isn't part of
 
1224
                # this index
 
1225
                data = data[-offset:]
 
1226
                offset = 0
1066
1227
            if offset == 0 and len(data) == self._size:
1067
1228
                # We read the whole range, most likely because the
1068
1229
                # Transport upcast our readv ranges into one long request
1090
1251
 
1091
1252
class CombinedGraphIndex(object):
1092
1253
    """A GraphIndex made up from smaller GraphIndices.
1093
 
    
 
1254
 
1094
1255
    The backing indices must implement GraphIndex, and are presumed to be
1095
1256
    static data.
1096
1257
 
1097
1258
    Queries against the combined index will be made against the first index,
1098
 
    and then the second and so on. The order of index's can thus influence
 
1259
    and then the second and so on. The order of indices can thus influence
1099
1260
    performance significantly. For example, if one index is on local disk and a
1100
1261
    second on a remote server, the local disk index should be before the other
1101
1262
    in the index list.
 
1263
    
 
1264
    Also, queries tend to need results from the same indices as previous
 
1265
    queries.  So the indices will be reordered after every query to put the
 
1266
    indices that had the result(s) of that query first (while otherwise
 
1267
    preserving the relative ordering).
1102
1268
    """
1103
1269
 
1104
 
    def __init__(self, indices):
 
1270
    def __init__(self, indices, reload_func=None):
1105
1271
        """Create a CombinedGraphIndex backed by indices.
1106
1272
 
1107
1273
        :param indices: An ordered list of indices to query for data.
 
1274
        :param reload_func: A function to call if we find we are missing an
 
1275
            index. Should have the form reload_func() => True/False to indicate
 
1276
            if reloading actually changed anything.
1108
1277
        """
1109
1278
        self._indices = indices
 
1279
        self._reload_func = reload_func
 
1280
        # Sibling indices are other CombinedGraphIndex that we should call
 
1281
        # _move_to_front_by_name on when we auto-reorder ourself.
 
1282
        self._sibling_indices = []
 
1283
        # A list of names that corresponds to the instances in self._indices,
 
1284
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
 
1285
        # indices must all use the same set of names as each other.
 
1286
        self._index_names = [None] * len(self._indices)
1110
1287
 
1111
1288
    def __repr__(self):
1112
1289
        return "%s(%s)" % (
1113
1290
                self.__class__.__name__,
1114
1291
                ', '.join(map(repr, self._indices)))
1115
1292
 
1116
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
1117
 
    def get_parents(self, revision_ids):
1118
 
        """See graph._StackedParentsProvider.get_parents.
1119
 
        
1120
 
        This implementation thunks the graph.Graph.get_parents api across to
1121
 
        GraphIndex.
1122
 
 
1123
 
        :param revision_ids: An iterable of graph keys for this graph.
1124
 
        :return: A list of parent details for each key in revision_ids.
1125
 
            Each parent details will be one of:
1126
 
             * None when the key was missing
1127
 
             * (NULL_REVISION,) when the key has no parents.
1128
 
             * (parent_key, parent_key...) otherwise.
1129
 
        """
1130
 
        parent_map = self.get_parent_map(revision_ids)
1131
 
        return [parent_map.get(r, None) for r in revision_ids]
 
1293
    def clear_cache(self):
 
1294
        """See GraphIndex.clear_cache()"""
 
1295
        for index in self._indices:
 
1296
            index.clear_cache()
1132
1297
 
1133
1298
    def get_parent_map(self, keys):
1134
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
1299
        """See graph.StackedParentsProvider.get_parent_map"""
1135
1300
        search_keys = set(keys)
1136
 
        if NULL_REVISION in search_keys:
1137
 
            search_keys.discard(NULL_REVISION)
1138
 
            found_parents = {NULL_REVISION:[]}
 
1301
        if _mod_revision.NULL_REVISION in search_keys:
 
1302
            search_keys.discard(_mod_revision.NULL_REVISION)
 
1303
            found_parents = {_mod_revision.NULL_REVISION:[]}
1139
1304
        else:
1140
1305
            found_parents = {}
1141
1306
        for index, key, value, refs in self.iter_entries(search_keys):
1142
1307
            parents = refs[0]
1143
1308
            if not parents:
1144
 
                parents = (NULL_REVISION,)
 
1309
                parents = (_mod_revision.NULL_REVISION,)
1145
1310
            found_parents[key] = parents
1146
1311
        return found_parents
1147
1312
 
1148
 
    def insert_index(self, pos, index):
 
1313
    has_key = _has_key_from_parent_map
 
1314
 
 
1315
    def insert_index(self, pos, index, name=None):
1149
1316
        """Insert a new index in the list of indices to query.
1150
1317
 
1151
1318
        :param pos: The position to insert the index.
1152
1319
        :param index: The index to insert.
 
1320
        :param name: a name for this index, e.g. a pack name.  These names can
 
1321
            be used to reflect index reorderings to related CombinedGraphIndex
 
1322
            instances that use the same names.  (see set_sibling_indices)
1153
1323
        """
1154
1324
        self._indices.insert(pos, index)
 
1325
        self._index_names.insert(pos, name)
1155
1326
 
1156
1327
    def iter_all_entries(self):
1157
1328
        """Iterate over all keys within the index
1164
1335
            the most efficient order for the index.
1165
1336
        """
1166
1337
        seen_keys = set()
1167
 
        for index in self._indices:
1168
 
            for node in index.iter_all_entries():
1169
 
                if node[1] not in seen_keys:
1170
 
                    yield node
1171
 
                    seen_keys.add(node[1])
 
1338
        while True:
 
1339
            try:
 
1340
                for index in self._indices:
 
1341
                    for node in index.iter_all_entries():
 
1342
                        if node[1] not in seen_keys:
 
1343
                            yield node
 
1344
                            seen_keys.add(node[1])
 
1345
                return
 
1346
            except errors.NoSuchFile:
 
1347
                self._reload_or_raise()
1172
1348
 
1173
1349
    def iter_entries(self, keys):
1174
1350
        """Iterate over keys within the index.
1177
1353
        value and are only reported once.
1178
1354
 
1179
1355
        :param keys: An iterable providing the keys to be retrieved.
1180
 
        :return: An iterable of (index, key, reference_lists, value). There is no
1181
 
            defined order for the result iteration - it will be in the most
 
1356
        :return: An iterable of (index, key, reference_lists, value). There is
 
1357
            no defined order for the result iteration - it will be in the most
1182
1358
            efficient order for the index.
1183
1359
        """
1184
1360
        keys = set(keys)
1185
 
        for index in self._indices:
1186
 
            if not keys:
1187
 
                return
1188
 
            for node in index.iter_entries(keys):
1189
 
                keys.remove(node[1])
1190
 
                yield node
 
1361
        hit_indices = []
 
1362
        while True:
 
1363
            try:
 
1364
                for index in self._indices:
 
1365
                    if not keys:
 
1366
                        break
 
1367
                    index_hit = False
 
1368
                    for node in index.iter_entries(keys):
 
1369
                        keys.remove(node[1])
 
1370
                        yield node
 
1371
                        index_hit = True
 
1372
                    if index_hit:
 
1373
                        hit_indices.append(index)
 
1374
                break
 
1375
            except errors.NoSuchFile:
 
1376
                self._reload_or_raise()
 
1377
        self._move_to_front(hit_indices)
1191
1378
 
1192
1379
    def iter_entries_prefix(self, keys):
1193
1380
        """Iterate over keys within the index using prefix matching.
1213
1400
        if not keys:
1214
1401
            return
1215
1402
        seen_keys = set()
1216
 
        for index in self._indices:
1217
 
            for node in index.iter_entries_prefix(keys):
1218
 
                if node[1] in seen_keys:
1219
 
                    continue
1220
 
                seen_keys.add(node[1])
1221
 
                yield node
 
1403
        hit_indices = []
 
1404
        while True:
 
1405
            try:
 
1406
                for index in self._indices:
 
1407
                    index_hit = False
 
1408
                    for node in index.iter_entries_prefix(keys):
 
1409
                        if node[1] in seen_keys:
 
1410
                            continue
 
1411
                        seen_keys.add(node[1])
 
1412
                        yield node
 
1413
                        index_hit = True
 
1414
                    if index_hit:
 
1415
                        hit_indices.append(index)
 
1416
                break
 
1417
            except errors.NoSuchFile:
 
1418
                self._reload_or_raise()
 
1419
        self._move_to_front(hit_indices)
 
1420
 
 
1421
    def _move_to_front(self, hit_indices):
 
1422
        """Rearrange self._indices so that hit_indices are first.
 
1423
 
 
1424
        Order is maintained as much as possible, e.g. the first unhit index
 
1425
        will be the first index in _indices after the hit_indices, and the
 
1426
        hit_indices will be present in exactly the order they are passed to
 
1427
        _move_to_front.
 
1428
 
 
1429
        _move_to_front propagates to all objects in self._sibling_indices by
 
1430
        calling _move_to_front_by_name.
 
1431
        """
 
1432
        if self._indices[:len(hit_indices)] == hit_indices:
 
1433
            # The 'hit_indices' are already at the front (and in the same
 
1434
            # order), no need to re-order
 
1435
            return
 
1436
        hit_names = self._move_to_front_by_index(hit_indices)
 
1437
        for sibling_idx in self._sibling_indices:
 
1438
            sibling_idx._move_to_front_by_name(hit_names)
 
1439
 
 
1440
    def _move_to_front_by_index(self, hit_indices):
 
1441
        """Core logic for _move_to_front.
 
1442
        
 
1443
        Returns a list of names corresponding to the hit_indices param.
 
1444
        """
 
1445
        indices_info = zip(self._index_names, self._indices)
 
1446
        if 'index' in debug.debug_flags:
 
1447
            trace.mutter('CombinedGraphIndex reordering: currently %r, '
 
1448
                         'promoting %r', indices_info, hit_indices)
 
1449
        hit_names = []
 
1450
        unhit_names = []
 
1451
        new_hit_indices = []
 
1452
        unhit_indices = []
 
1453
 
 
1454
        for offset, (name, idx) in enumerate(indices_info):
 
1455
            if idx in hit_indices:
 
1456
                hit_names.append(name)
 
1457
                new_hit_indices.append(idx)
 
1458
                if len(new_hit_indices) == len(hit_indices):
 
1459
                    # We've found all of the hit entries, everything else is
 
1460
                    # unhit
 
1461
                    unhit_names.extend(self._index_names[offset+1:])
 
1462
                    unhit_indices.extend(self._indices[offset+1:])
 
1463
                    break
 
1464
            else:
 
1465
                unhit_names.append(name)
 
1466
                unhit_indices.append(idx)
 
1467
 
 
1468
        self._indices = new_hit_indices + unhit_indices
 
1469
        self._index_names = hit_names + unhit_names
 
1470
        if 'index' in debug.debug_flags:
 
1471
            trace.mutter('CombinedGraphIndex reordered: %r', self._indices)
 
1472
        return hit_names
 
1473
 
 
1474
    def _move_to_front_by_name(self, hit_names):
 
1475
        """Moves indices named by 'hit_names' to front of the search order, as
 
1476
        described in _move_to_front.
 
1477
        """
 
1478
        # Translate names to index instances, and then call
 
1479
        # _move_to_front_by_index.
 
1480
        indices_info = zip(self._index_names, self._indices)
 
1481
        hit_indices = []
 
1482
        for name, idx in indices_info:
 
1483
            if name in hit_names:
 
1484
                hit_indices.append(idx)
 
1485
        self._move_to_front_by_index(hit_indices)
 
1486
 
 
1487
    def find_ancestry(self, keys, ref_list_num):
 
1488
        """Find the complete ancestry for the given set of keys.
 
1489
 
 
1490
        Note that this is a whole-ancestry request, so it should be used
 
1491
        sparingly.
 
1492
 
 
1493
        :param keys: An iterable of keys to look for
 
1494
        :param ref_list_num: The reference list which references the parents
 
1495
            we care about.
 
1496
        :return: (parent_map, missing_keys)
 
1497
        """
 
1498
        # XXX: make this call _move_to_front?
 
1499
        missing_keys = set()
 
1500
        parent_map = {}
 
1501
        keys_to_lookup = set(keys)
 
1502
        generation = 0
 
1503
        while keys_to_lookup:
 
1504
            # keys that *all* indexes claim are missing, stop searching them
 
1505
            generation += 1
 
1506
            all_index_missing = None
 
1507
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
 
1508
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
 
1509
            #                                   len(parent_map),
 
1510
            #                                   len(missing_keys))
 
1511
            for index_idx, index in enumerate(self._indices):
 
1512
                # TODO: we should probably be doing something with
 
1513
                #       'missing_keys' since we've already determined that
 
1514
                #       those revisions have not been found anywhere
 
1515
                index_missing_keys = set()
 
1516
                # Find all of the ancestry we can from this index
 
1517
                # keep looking until the search_keys set is empty, which means
 
1518
                # things we didn't find should be in index_missing_keys
 
1519
                search_keys = keys_to_lookup
 
1520
                sub_generation = 0
 
1521
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
 
1522
                #     index_idx, len(search_keys),
 
1523
                #     len(parent_map), len(index_missing_keys))
 
1524
                while search_keys:
 
1525
                    sub_generation += 1
 
1526
                    # TODO: ref_list_num should really be a parameter, since
 
1527
                    #       CombinedGraphIndex does not know what the ref lists
 
1528
                    #       mean.
 
1529
                    search_keys = index._find_ancestors(search_keys,
 
1530
                        ref_list_num, parent_map, index_missing_keys)
 
1531
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
 
1532
                    #     sub_generation, len(search_keys),
 
1533
                    #     len(parent_map), len(index_missing_keys))
 
1534
                # Now set whatever was missing to be searched in the next index
 
1535
                keys_to_lookup = index_missing_keys
 
1536
                if all_index_missing is None:
 
1537
                    all_index_missing = set(index_missing_keys)
 
1538
                else:
 
1539
                    all_index_missing.intersection_update(index_missing_keys)
 
1540
                if not keys_to_lookup:
 
1541
                    break
 
1542
            if all_index_missing is None:
 
1543
                # There were no indexes, so all search keys are 'missing'
 
1544
                missing_keys.update(keys_to_lookup)
 
1545
                keys_to_lookup = None
 
1546
            else:
 
1547
                missing_keys.update(all_index_missing)
 
1548
                keys_to_lookup.difference_update(all_index_missing)
 
1549
        return parent_map, missing_keys
1222
1550
 
1223
1551
    def key_count(self):
1224
1552
        """Return an estimate of the number of keys in this index.
1225
 
        
 
1553
 
1226
1554
        For CombinedGraphIndex this is approximated by the sum of the keys of
1227
1555
        the child indices. As child indices may have duplicate keys this can
1228
1556
        have a maximum error of the number of child indices * largest number of
1229
1557
        keys in any index.
1230
1558
        """
1231
 
        return sum((index.key_count() for index in self._indices), 0)
 
1559
        while True:
 
1560
            try:
 
1561
                return sum((index.key_count() for index in self._indices), 0)
 
1562
            except errors.NoSuchFile:
 
1563
                self._reload_or_raise()
 
1564
 
 
1565
    missing_keys = _missing_keys_from_parent_map
 
1566
 
 
1567
    def _reload_or_raise(self):
 
1568
        """We just got a NoSuchFile exception.
 
1569
 
 
1570
        Try to reload the indices, if it fails, just raise the current
 
1571
        exception.
 
1572
        """
 
1573
        if self._reload_func is None:
 
1574
            raise
 
1575
        exc_type, exc_value, exc_traceback = sys.exc_info()
 
1576
        trace.mutter('Trying to reload after getting exception: %s',
 
1577
                     exc_value)
 
1578
        if not self._reload_func():
 
1579
            # We tried to reload, but nothing changed, so we fail anyway
 
1580
            trace.mutter('_reload_func indicated nothing has changed.'
 
1581
                         ' Raising original exception.')
 
1582
            raise exc_type, exc_value, exc_traceback
 
1583
 
 
1584
    def set_sibling_indices(self, sibling_combined_graph_indices):
 
1585
        """Set the CombinedGraphIndex objects to reorder after reordering self.
 
1586
        """
 
1587
        self._sibling_indices = sibling_combined_graph_indices
1232
1588
 
1233
1589
    def validate(self):
1234
1590
        """Validate that everything in the index can be accessed."""
1235
 
        for index in self._indices:
1236
 
            index.validate()
 
1591
        while True:
 
1592
            try:
 
1593
                for index in self._indices:
 
1594
                    index.validate()
 
1595
                return
 
1596
            except errors.NoSuchFile:
 
1597
                self._reload_or_raise()
1237
1598
 
1238
1599
 
1239
1600
class InMemoryGraphIndex(GraphIndexBuilder):
1283
1644
            defined order for the result iteration - it will be in the most
1284
1645
            efficient order for the index (keys iteration order in this case).
1285
1646
        """
1286
 
        keys = set(keys)
 
1647
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
 
1648
        #       aren't using set().intersection() here
 
1649
        nodes = self._nodes
 
1650
        keys = [key for key in keys if key in nodes]
1287
1651
        if self.reference_lists:
1288
 
            for key in keys.intersection(self._keys):
1289
 
                node = self._nodes[key]
 
1652
            for key in keys:
 
1653
                node = nodes[key]
1290
1654
                if not node[0]:
1291
1655
                    yield self, key, node[2], node[1]
1292
1656
        else:
1293
 
            for key in keys.intersection(self._keys):
1294
 
                node = self._nodes[key]
 
1657
            for key in keys:
 
1658
                node = nodes[key]
1295
1659
                if not node[0]:
1296
1660
                    yield self, key, node[2]
1297
1661
 
1326
1690
                    raise errors.BadIndexKey(key)
1327
1691
                node = self._nodes[key]
1328
1692
                if node[0]:
1329
 
                    continue 
 
1693
                    continue
1330
1694
                if self.reference_lists:
1331
1695
                    yield self, key, node[2], node[1]
1332
1696
                else:
1357
1721
                    # can't be empty or would not exist
1358
1722
                    item, value = key_dict.iteritems().next()
1359
1723
                    if type(value) == dict:
1360
 
                        # push keys 
 
1724
                        # push keys
1361
1725
                        dicts.extend(key_dict.itervalues())
1362
1726
                    else:
1363
1727
                        # yield keys
1368
1732
 
1369
1733
    def key_count(self):
1370
1734
        """Return an estimate of the number of keys in this index.
1371
 
        
 
1735
 
1372
1736
        For InMemoryGraphIndex the estimate is exact.
1373
1737
        """
1374
 
        return len(self._keys)
 
1738
        return len(self._nodes) - len(self._absent_keys)
1375
1739
 
1376
1740
    def validate(self):
1377
1741
        """In memory index's have no known corruption at the moment."""
1382
1746
 
1383
1747
    Queries against this will emit queries against the adapted Graph with the
1384
1748
    prefix added, queries for all items use iter_entries_prefix. The returned
1385
 
    nodes will have their keys and node references adjusted to remove the 
 
1749
    nodes will have their keys and node references adjusted to remove the
1386
1750
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1387
1751
    nodes and references being added will have prefix prepended.
1388
1752
    """
1415
1779
                    adjusted_references))
1416
1780
        except ValueError:
1417
1781
            # XXX: TODO add an explicit interface for getting the reference list
1418
 
            # status, to handle this bit of user-friendliness in the API more 
 
1782
            # status, to handle this bit of user-friendliness in the API more
1419
1783
            # explicitly.
1420
1784
            for (key, value) in nodes:
1421
1785
                translated_nodes.append((self.prefix + key, value))
1493
1857
 
1494
1858
    def key_count(self):
1495
1859
        """Return an estimate of the number of keys in this index.
1496
 
        
 
1860
 
1497
1861
        For GraphIndexPrefixAdapter this is relatively expensive - key
1498
1862
        iteration with the prefix is done.
1499
1863
        """