← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: John Arbash Meinel
  • Date: 2013-06-24 12:03:12 UTC
  • mfrom: (6437.77.2 2.5)
  • mto: This revision was merged to the branch mainline in revision 6579.
  • Revision ID: john@arbash-meinel.com-20130624120312-pmvck24x052csigx
Merge lp:bzr/2.5 r6515 to get the fix for bug #855155 (Dirstate.update_basis_by_delta)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
1
 
# Copyright (C) 2007, 2008 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',
31
33
 
32
34
from bzrlib.lazy_import import lazy_import
33
35
lazy_import(globals(), """
34
 
from bzrlib import trace
35
 
from bzrlib.bisect_multi import bisect_multi_bytes
36
 
from bzrlib.revision import NULL_REVISION
37
 
from bzrlib.trace import mutter
 
36
from bzrlib import (
 
37
    bisect_multi,
 
38
    revision as _mod_revision,
 
39
    trace,
 
40
    )
38
41
""")
39
42
from bzrlib import (
40
43
    debug,
41
44
    errors,
42
 
    symbol_versioning,
43
45
    )
 
46
from bzrlib.static_tuple import StaticTuple
44
47
 
45
48
_HEADER_READV = (0, 200)
46
49
_OPTION_KEY_ELEMENTS = "key_elements="
56
59
def _has_key_from_parent_map(self, key):
57
60
    """Check if this index has one key.
58
61
 
59
 
    If it's possible to check for multiple keys at once through 
 
62
    If it's possible to check for multiple keys at once through
60
63
    calling get_parent_map that should be faster.
61
64
    """
62
65
    return (key in self.get_parent_map([key]))
68
71
 
69
72
class GraphIndexBuilder(object):
70
73
    """A builder that can build a GraphIndex.
71
 
    
72
 
    The resulting graph has the structure:
73
 
    
74
 
    _SIGNATURE OPTIONS NODES NEWLINE
75
 
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
76
 
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
77
 
    NODES          := NODE*
78
 
    NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
79
 
    KEY            := Not-whitespace-utf8
80
 
    ABSENT         := 'a'
81
 
    REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
82
 
    REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
83
 
    REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
84
 
                              ; referenced key.
85
 
    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
86
89
    """
87
90
 
88
91
    def __init__(self, reference_lists=0, key_elements=1):
93
96
        :param key_elements: The number of bytestrings in each key.
94
97
        """
95
98
        self.reference_lists = reference_lists
96
 
        self._keys = set()
97
99
        # A dict of {key: (absent, ref_lists, value)}
98
100
        self._nodes = {}
 
101
        # Keys that are referenced but not actually present in this index
 
102
        self._absent_keys = set()
99
103
        self._nodes_by_key = None
100
104
        self._key_length = key_elements
101
105
        self._optimize_for_size = False
 
106
        self._combine_backing_indices = True
102
107
 
103
108
    def _check_key(self, key):
104
109
        """Raise BadIndexKey if key is not a valid key for this index."""
105
 
        if type(key) != tuple:
 
110
        if type(key) not in (tuple, StaticTuple):
106
111
            raise errors.BadIndexKey(key)
107
112
        if self._key_length != len(key):
108
113
            raise errors.BadIndexKey(key)
164
169
            return
165
170
        key_dict = self._nodes_by_key
166
171
        if self.reference_lists:
167
 
            key_value = key, value, node_refs
 
172
            key_value = StaticTuple(key, value, node_refs)
168
173
        else:
169
 
            key_value = key, value
 
174
            key_value = StaticTuple(key, value)
170
175
        for subkey in key[:-1]:
171
176
            key_dict = key_dict.setdefault(subkey, {})
172
177
        key_dict[key[-1]] = key_value
182
187
        :param value: The value associate with this key. Must not contain
183
188
            newlines or null characters.
184
189
        :return: (node_refs, absent_references)
185
 
            node_refs   basically a packed form of 'references' where all
186
 
                        iterables are tuples
187
 
            absent_references   reference keys that are not in self._nodes.
188
 
                                This may contain duplicates if the same key is
189
 
                                referenced in multiple lists.
 
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.
190
196
        """
 
197
        as_st = StaticTuple.from_sequence
191
198
        self._check_key(key)
192
199
        if _newline_null_re.search(value) is not None:
193
200
            raise errors.BadIndexValue(value)
202
209
                if reference not in self._nodes:
203
210
                    self._check_key(reference)
204
211
                    absent_references.append(reference)
205
 
            node_refs.append(tuple(reference_list))
206
 
        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
207
216
 
208
217
    def add_node(self, key, value, references=()):
209
218
        """Add a node to the index.
214
223
        :param references: An iterable of iterables of keys. Each is a
215
224
            reference to another key.
216
225
        :param value: The value to associate with the key. It may be any
217
 
            bytes as long as it does not contain \0 or \n.
 
226
            bytes as long as it does not contain \\0 or \\n.
218
227
        """
219
228
        (node_refs,
220
229
         absent_references) = self._check_key_ref_value(key, references, value)
224
233
            # There may be duplicates, but I don't think it is worth worrying
225
234
            # about
226
235
            self._nodes[reference] = ('a', (), '')
 
236
        self._absent_keys.update(absent_references)
 
237
        self._absent_keys.discard(key)
227
238
        self._nodes[key] = ('', node_refs, value)
228
 
        self._keys.add(key)
229
239
        if self._nodes_by_key is not None and self._key_length > 1:
230
240
            self._update_nodes_by_key(key, value, node_refs)
231
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
        
232
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
        """
233
255
        lines = [_SIGNATURE]
234
256
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
235
257
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
236
 
        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')
237
260
        prefix_length = sum(len(x) for x in lines)
238
261
        # references are byte offsets. To avoid having to do nasty
239
262
        # polynomial work to resolve offsets (references to later in the
246
269
        # one to pad all the data with reference-length and determine entry
247
270
        # addresses.
248
271
        # One to serialise.
249
 
        
 
272
 
250
273
        # forward sorted by key. In future we may consider topological sorting,
251
274
        # at the cost of table scans for direct lookup, or a second index for
252
275
        # direct lookup
315
338
                (len(result.getvalue()), expected_bytes))
316
339
        return result
317
340
 
318
 
    def set_optimize(self, for_size=True):
 
341
    def set_optimize(self, for_size=None, combine_backing_indices=None):
319
342
        """Change how the builder tries to optimize the result.
320
343
 
321
344
        :param for_size: Tell the builder to try and make the index as small as
322
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.)
323
350
        :return: None
324
351
        """
325
352
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
326
353
        # other builders do.
327
 
        self._optimize_for_size = for_size
 
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
328
374
 
329
375
 
330
376
class GraphIndex(object):
331
377
    """An index for data with embedded graphs.
332
 
 
 
378
 
333
379
    The index maps keys to a list of key reference lists, and a value.
334
380
    Each node has the same number of key reference lists. Each key reference
335
381
    list can be empty or an arbitrary length. The value is an opaque NULL
336
 
    terminated string without any newlines. The storage of the index is 
 
382
    terminated string without any newlines. The storage of the index is
337
383
    hidden in the interface: keys and key references are always tuples of
338
384
    bytestrings, never the internal representation (e.g. dictionary offsets).
339
385
 
345
391
    suitable for production use. :XXX
346
392
    """
347
393
 
348
 
    def __init__(self, transport, name, size):
 
394
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
349
395
        """Open an index called name on transport.
350
396
 
351
397
        :param transport: A bzrlib.transport.Transport.
357
403
            avoided by having it supplied. If size is None, then bisection
358
404
            support will be disabled and accessing the index will just stream
359
405
            all the data.
 
406
        :param offset: Instead of starting the index data at offset 0, start it
 
407
            at an arbitrary offset.
360
408
        """
361
409
        self._transport = transport
362
410
        self._name = name
379
427
        self._size = size
380
428
        # The number of bytes we've read so far in trying to process this file
381
429
        self._bytes_read = 0
 
430
        self._base_offset = offset
382
431
 
383
432
    def __eq__(self, other):
384
433
        """Equal when self and other were created with the same parameters."""
404
453
            # We already did this
405
454
            return
406
455
        if 'index' in debug.debug_flags:
407
 
            mutter('Reading entire index %s', self._transport.abspath(self._name))
 
456
            trace.mutter('Reading entire index %s',
 
457
                          self._transport.abspath(self._name))
408
458
        if stream is None:
409
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:])
410
464
        self._read_prefix(stream)
411
465
        self._expected_elements = 3 + self._key_length
412
466
        line_count = 0
418
472
        trailers = 0
419
473
        pos = stream.tell()
420
474
        lines = stream.read().split('\n')
 
475
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
 
476
        stream.close()
421
477
        del lines[-1]
422
478
        _, _, _, trailers = self._parse_lines(lines, pos)
423
479
        for key, absent, references, value in self._keys_by_offset.itervalues():
430
486
                node_value = value
431
487
            self._nodes[key] = node_value
432
488
        # cache the keys for quick set intersections
433
 
        self._keys = set(self._nodes)
434
489
        if trailers != 1:
435
490
            # there must be one line - the empty trailer line.
436
491
            raise errors.BadIndexData(self)
437
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
 
438
515
    def _get_nodes_by_key(self):
439
516
        if self._nodes_by_key is None:
440
517
            nodes_by_key = {}
502
579
 
503
580
    def _resolve_references(self, references):
504
581
        """Return the resolved key references for references.
505
 
        
 
582
 
506
583
        References are resolved by looking up the location of the key in the
507
584
        _keys_by_offset map and substituting the key name, preserving ordering.
508
585
 
509
 
        :param references: An iterable of iterables of key locations. e.g. 
 
586
        :param references: An iterable of iterables of key locations. e.g.
510
587
            [[123, 456], [123]]
511
588
        :return: A tuple of tuples of keys.
512
589
        """
566
643
 
567
644
    def _iter_entries_from_total_buffer(self, keys):
568
645
        """Iterate over keys when the entire index is parsed."""
569
 
        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]
570
650
        if self.node_ref_lists:
571
651
            for key in keys:
572
 
                value, node_refs = self._nodes[key]
 
652
                value, node_refs = nodes[key]
573
653
                yield self, key, value, node_refs
574
654
        else:
575
655
            for key in keys:
576
 
                yield self, key, self._nodes[key]
 
656
                yield self, key, nodes[key]
577
657
 
578
658
    def iter_entries(self, keys):
579
659
        """Iterate over keys within the index.
601
681
        if self._nodes is not None:
602
682
            return self._iter_entries_from_total_buffer(keys)
603
683
        else:
604
 
            return (result[1] for result in bisect_multi_bytes(
 
684
            return (result[1] for result in bisect_multi.bisect_multi_bytes(
605
685
                self._lookup_keys_via_location, self._size, keys))
606
686
 
607
687
    def iter_entries_prefix(self, keys):
670
750
                    # can't be empty or would not exist
671
751
                    item, value = key_dict.iteritems().next()
672
752
                    if type(value) == dict:
673
 
                        # push keys 
 
753
                        # push keys
674
754
                        dicts.extend(key_dict.itervalues())
675
755
                    else:
676
756
                        # yield keys
682
762
                # the last thing looked up was a terminal element
683
763
                yield (self, ) + key_dict
684
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
 
685
782
    def key_count(self):
686
783
        """Return an estimate of the number of keys in this index.
687
 
        
 
784
 
688
785
        For GraphIndex the estimate is exact.
689
786
        """
690
787
        if self._key_count is None:
706
803
        # Possible improvements:
707
804
        #  - only bisect lookup each key once
708
805
        #  - sort the keys first, and use that to reduce the bisection window
709
 
        # ----- 
 
806
        # -----
710
807
        # this progresses in three parts:
711
808
        # read data
712
809
        # parse it
721
818
                # We have the key parsed.
722
819
                continue
723
820
            index = self._parsed_key_index(key)
724
 
            if (len(self._parsed_key_map) and 
 
821
            if (len(self._parsed_key_map) and
725
822
                self._parsed_key_map[index][0] <= key and
726
823
                (self._parsed_key_map[index][1] >= key or
727
824
                 # end of the file has been parsed
731
828
                continue
732
829
            # - if we have examined this part of the file already - yes
733
830
            index = self._parsed_byte_index(location)
734
 
            if (len(self._parsed_byte_map) and 
 
831
            if (len(self._parsed_byte_map) and
735
832
                self._parsed_byte_map[index][0] <= location and
736
833
                self._parsed_byte_map[index][1] > location):
737
834
                # the byte region has been parsed, so no read is needed.
992
1089
        # adjust offset and data to the parseable data.
993
1090
        trimmed_data = data[trim_start:trim_end]
994
1091
        if not (trimmed_data):
995
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
 
1092
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
996
1093
                % (trim_start, trim_end, offset, offset + len(data)))
997
1094
        if trim_start:
998
1095
            offset += trim_start
1099
1196
            self._parsed_key_map.insert(index + 1, new_key)
1100
1197
 
1101
1198
    def _read_and_parse(self, readv_ranges):
1102
 
        """Read the the ranges and parse the resulting data.
 
1199
        """Read the ranges and parse the resulting data.
1103
1200
 
1104
1201
        :param readv_ranges: A prepared readv range list.
1105
1202
        """
1111
1208
            self._buffer_all()
1112
1209
            return
1113
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]
1114
1216
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1115
 
            self._size)
 
1217
            self._size + self._base_offset)
1116
1218
        # parse
1117
1219
        for offset, data in readv_data:
 
1220
            offset -= base_offset
1118
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
1119
1227
            if offset == 0 and len(data) == self._size:
1120
1228
                # We read the whole range, most likely because the
1121
1229
                # Transport upcast our readv ranges into one long request
1143
1251
 
1144
1252
class CombinedGraphIndex(object):
1145
1253
    """A GraphIndex made up from smaller GraphIndices.
1146
 
    
 
1254
 
1147
1255
    The backing indices must implement GraphIndex, and are presumed to be
1148
1256
    static data.
1149
1257
 
1150
1258
    Queries against the combined index will be made against the first index,
1151
 
    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
1152
1260
    performance significantly. For example, if one index is on local disk and a
1153
1261
    second on a remote server, the local disk index should be before the other
1154
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).
1155
1268
    """
1156
1269
 
1157
1270
    def __init__(self, indices, reload_func=None):
1164
1277
        """
1165
1278
        self._indices = indices
1166
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)
1167
1287
 
1168
1288
    def __repr__(self):
1169
1289
        return "%s(%s)" % (
1170
1290
                self.__class__.__name__,
1171
1291
                ', '.join(map(repr, self._indices)))
1172
1292
 
1173
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
1174
 
    def get_parents(self, revision_ids):
1175
 
        """See graph._StackedParentsProvider.get_parents.
1176
 
        
1177
 
        This implementation thunks the graph.Graph.get_parents api across to
1178
 
        GraphIndex.
1179
 
 
1180
 
        :param revision_ids: An iterable of graph keys for this graph.
1181
 
        :return: A list of parent details for each key in revision_ids.
1182
 
            Each parent details will be one of:
1183
 
             * None when the key was missing
1184
 
             * (NULL_REVISION,) when the key has no parents.
1185
 
             * (parent_key, parent_key...) otherwise.
1186
 
        """
1187
 
        parent_map = self.get_parent_map(revision_ids)
1188
 
        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()
1189
1297
 
1190
1298
    def get_parent_map(self, keys):
1191
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
1299
        """See graph.StackedParentsProvider.get_parent_map"""
1192
1300
        search_keys = set(keys)
1193
 
        if NULL_REVISION in search_keys:
1194
 
            search_keys.discard(NULL_REVISION)
1195
 
            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:[]}
1196
1304
        else:
1197
1305
            found_parents = {}
1198
1306
        for index, key, value, refs in self.iter_entries(search_keys):
1199
1307
            parents = refs[0]
1200
1308
            if not parents:
1201
 
                parents = (NULL_REVISION,)
 
1309
                parents = (_mod_revision.NULL_REVISION,)
1202
1310
            found_parents[key] = parents
1203
1311
        return found_parents
1204
1312
 
1205
1313
    has_key = _has_key_from_parent_map
1206
1314
 
1207
 
    def insert_index(self, pos, index):
 
1315
    def insert_index(self, pos, index, name=None):
1208
1316
        """Insert a new index in the list of indices to query.
1209
1317
 
1210
1318
        :param pos: The position to insert the index.
1211
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)
1212
1323
        """
1213
1324
        self._indices.insert(pos, index)
 
1325
        self._index_names.insert(pos, name)
1214
1326
 
1215
1327
    def iter_all_entries(self):
1216
1328
        """Iterate over all keys within the index
1241
1353
        value and are only reported once.
1242
1354
 
1243
1355
        :param keys: An iterable providing the keys to be retrieved.
1244
 
        :return: An iterable of (index, key, reference_lists, value). There is no
1245
 
            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
1246
1358
            efficient order for the index.
1247
1359
        """
1248
1360
        keys = set(keys)
 
1361
        hit_indices = []
1249
1362
        while True:
1250
1363
            try:
1251
1364
                for index in self._indices:
1252
1365
                    if not keys:
1253
 
                        return
 
1366
                        break
 
1367
                    index_hit = False
1254
1368
                    for node in index.iter_entries(keys):
1255
1369
                        keys.remove(node[1])
1256
1370
                        yield node
1257
 
                return
 
1371
                        index_hit = True
 
1372
                    if index_hit:
 
1373
                        hit_indices.append(index)
 
1374
                break
1258
1375
            except errors.NoSuchFile:
1259
1376
                self._reload_or_raise()
 
1377
        self._move_to_front(hit_indices)
1260
1378
 
1261
1379
    def iter_entries_prefix(self, keys):
1262
1380
        """Iterate over keys within the index using prefix matching.
1282
1400
        if not keys:
1283
1401
            return
1284
1402
        seen_keys = set()
 
1403
        hit_indices = []
1285
1404
        while True:
1286
1405
            try:
1287
1406
                for index in self._indices:
 
1407
                    index_hit = False
1288
1408
                    for node in index.iter_entries_prefix(keys):
1289
1409
                        if node[1] in seen_keys:
1290
1410
                            continue
1291
1411
                        seen_keys.add(node[1])
1292
1412
                        yield node
1293
 
                return
 
1413
                        index_hit = True
 
1414
                    if index_hit:
 
1415
                        hit_indices.append(index)
 
1416
                break
1294
1417
            except errors.NoSuchFile:
1295
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
1296
1550
 
1297
1551
    def key_count(self):
1298
1552
        """Return an estimate of the number of keys in this index.
1327
1581
                         ' Raising original exception.')
1328
1582
            raise exc_type, exc_value, exc_traceback
1329
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
 
1588
 
1330
1589
    def validate(self):
1331
1590
        """Validate that everything in the index can be accessed."""
1332
1591
        while True:
1385
1644
            defined order for the result iteration - it will be in the most
1386
1645
            efficient order for the index (keys iteration order in this case).
1387
1646
        """
1388
 
        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]
1389
1651
        if self.reference_lists:
1390
 
            for key in keys.intersection(self._keys):
1391
 
                node = self._nodes[key]
 
1652
            for key in keys:
 
1653
                node = nodes[key]
1392
1654
                if not node[0]:
1393
1655
                    yield self, key, node[2], node[1]
1394
1656
        else:
1395
 
            for key in keys.intersection(self._keys):
1396
 
                node = self._nodes[key]
 
1657
            for key in keys:
 
1658
                node = nodes[key]
1397
1659
                if not node[0]:
1398
1660
                    yield self, key, node[2]
1399
1661
 
1428
1690
                    raise errors.BadIndexKey(key)
1429
1691
                node = self._nodes[key]
1430
1692
                if node[0]:
1431
 
                    continue 
 
1693
                    continue
1432
1694
                if self.reference_lists:
1433
1695
                    yield self, key, node[2], node[1]
1434
1696
                else:
1459
1721
                    # can't be empty or would not exist
1460
1722
                    item, value = key_dict.iteritems().next()
1461
1723
                    if type(value) == dict:
1462
 
                        # push keys 
 
1724
                        # push keys
1463
1725
                        dicts.extend(key_dict.itervalues())
1464
1726
                    else:
1465
1727
                        # yield keys
1470
1732
 
1471
1733
    def key_count(self):
1472
1734
        """Return an estimate of the number of keys in this index.
1473
 
        
 
1735
 
1474
1736
        For InMemoryGraphIndex the estimate is exact.
1475
1737
        """
1476
 
        return len(self._keys)
 
1738
        return len(self._nodes) - len(self._absent_keys)
1477
1739
 
1478
1740
    def validate(self):
1479
1741
        """In memory index's have no known corruption at the moment."""
1484
1746
 
1485
1747
    Queries against this will emit queries against the adapted Graph with the
1486
1748
    prefix added, queries for all items use iter_entries_prefix. The returned
1487
 
    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
1488
1750
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1489
1751
    nodes and references being added will have prefix prepended.
1490
1752
    """
1517
1779
                    adjusted_references))
1518
1780
        except ValueError:
1519
1781
            # XXX: TODO add an explicit interface for getting the reference list
1520
 
            # 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
1521
1783
            # explicitly.
1522
1784
            for (key, value) in nodes:
1523
1785
                translated_nodes.append((self.prefix + key, value))
1595
1857
 
1596
1858
    def key_count(self):
1597
1859
        """Return an estimate of the number of keys in this index.
1598
 
        
 
1860
 
1599
1861
        For GraphIndexPrefixAdapter this is relatively expensive - key
1600
1862
        iteration with the prefix is done.
1601
1863
        """