← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

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
 
31
31
 
32
32
from bzrlib.lazy_import import lazy_import
33
33
lazy_import(globals(), """
34
 
from bzrlib import trace
35
 
from bzrlib.bisect_multi import bisect_multi_bytes
36
 
from bzrlib.revision import NULL_REVISION
37
 
from bzrlib.trace import mutter
 
34
from bzrlib import (
 
35
    bisect_multi,
 
36
    revision as _mod_revision,
 
37
    trace,
 
38
    )
38
39
""")
39
40
from bzrlib import (
40
41
    debug,
41
42
    errors,
42
 
    symbol_versioning,
43
43
    )
 
44
from bzrlib.static_tuple import StaticTuple
44
45
 
45
46
_HEADER_READV = (0, 200)
46
47
_OPTION_KEY_ELEMENTS = "key_elements="
56
57
def _has_key_from_parent_map(self, key):
57
58
    """Check if this index has one key.
58
59
 
59
 
    If it's possible to check for multiple keys at once through 
 
60
    If it's possible to check for multiple keys at once through
60
61
    calling get_parent_map that should be faster.
61
62
    """
62
63
    return (key in self.get_parent_map([key]))
68
69
 
69
70
class GraphIndexBuilder(object):
70
71
    """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
 
72
 
 
73
    The resulting graph has the structure::
 
74
 
 
75
      _SIGNATURE OPTIONS NODES NEWLINE
 
76
      _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
 
77
      OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
 
78
      NODES          := NODE*
 
79
      NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
 
80
      KEY            := Not-whitespace-utf8
 
81
      ABSENT         := 'a'
 
82
      REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
 
83
      REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
 
84
      REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
 
85
                                ; referenced key.
 
86
      VALUE          := no-newline-no-null-bytes
86
87
    """
87
88
 
88
89
    def __init__(self, reference_lists=0, key_elements=1):
93
94
        :param key_elements: The number of bytestrings in each key.
94
95
        """
95
96
        self.reference_lists = reference_lists
96
 
        self._keys = set()
97
97
        # A dict of {key: (absent, ref_lists, value)}
98
98
        self._nodes = {}
 
99
        # Keys that are referenced but not actually present in this index
 
100
        self._absent_keys = set()
99
101
        self._nodes_by_key = None
100
102
        self._key_length = key_elements
101
103
        self._optimize_for_size = False
 
104
        self._combine_backing_indices = True
102
105
 
103
106
    def _check_key(self, key):
104
107
        """Raise BadIndexKey if key is not a valid key for this index."""
105
 
        if type(key) != tuple:
 
108
        if type(key) not in (tuple, StaticTuple):
106
109
            raise errors.BadIndexKey(key)
107
110
        if self._key_length != len(key):
108
111
            raise errors.BadIndexKey(key)
164
167
            return
165
168
        key_dict = self._nodes_by_key
166
169
        if self.reference_lists:
167
 
            key_value = key, value, node_refs
 
170
            key_value = StaticTuple(key, value, node_refs)
168
171
        else:
169
 
            key_value = key, value
 
172
            key_value = StaticTuple(key, value)
170
173
        for subkey in key[:-1]:
171
174
            key_dict = key_dict.setdefault(subkey, {})
172
175
        key_dict[key[-1]] = key_value
182
185
        :param value: The value associate with this key. Must not contain
183
186
            newlines or null characters.
184
187
        :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.
 
188
        
 
189
            * node_refs: basically a packed form of 'references' where all
 
190
              iterables are tuples
 
191
            * absent_references: reference keys that are not in self._nodes.
 
192
              This may contain duplicates if the same key is referenced in
 
193
              multiple lists.
190
194
        """
 
195
        as_st = StaticTuple.from_sequence
191
196
        self._check_key(key)
192
197
        if _newline_null_re.search(value) is not None:
193
198
            raise errors.BadIndexValue(value)
202
207
                if reference not in self._nodes:
203
208
                    self._check_key(reference)
204
209
                    absent_references.append(reference)
205
 
            node_refs.append(tuple(reference_list))
206
 
        return tuple(node_refs), absent_references
 
210
            reference_list = as_st([as_st(ref).intern()
 
211
                                    for ref in reference_list])
 
212
            node_refs.append(reference_list)
 
213
        return as_st(node_refs), absent_references
207
214
 
208
215
    def add_node(self, key, value, references=()):
209
216
        """Add a node to the index.
214
221
        :param references: An iterable of iterables of keys. Each is a
215
222
            reference to another key.
216
223
        :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.
 
224
            bytes as long as it does not contain \\0 or \\n.
218
225
        """
219
226
        (node_refs,
220
227
         absent_references) = self._check_key_ref_value(key, references, value)
224
231
            # There may be duplicates, but I don't think it is worth worrying
225
232
            # about
226
233
            self._nodes[reference] = ('a', (), '')
 
234
        self._absent_keys.update(absent_references)
 
235
        self._absent_keys.discard(key)
227
236
        self._nodes[key] = ('', node_refs, value)
228
 
        self._keys.add(key)
229
237
        if self._nodes_by_key is not None and self._key_length > 1:
230
238
            self._update_nodes_by_key(key, value, node_refs)
231
239
 
 
240
    def clear_cache(self):
 
241
        """See GraphIndex.clear_cache()
 
242
 
 
243
        This is a no-op, but we need the api to conform to a generic 'Index'
 
244
        abstraction.
 
245
        """
 
246
        
232
247
    def finish(self):
 
248
        """Finish the index.
 
249
 
 
250
        :returns: cStringIO holding the full context of the index as it 
 
251
        should be written to disk.
 
252
        """
233
253
        lines = [_SIGNATURE]
234
254
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
235
255
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
236
 
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
 
256
        key_count = len(self._nodes) - len(self._absent_keys)
 
257
        lines.append(_OPTION_LEN + str(key_count) + '\n')
237
258
        prefix_length = sum(len(x) for x in lines)
238
259
        # references are byte offsets. To avoid having to do nasty
239
260
        # polynomial work to resolve offsets (references to later in the
246
267
        # one to pad all the data with reference-length and determine entry
247
268
        # addresses.
248
269
        # One to serialise.
249
 
        
 
270
 
250
271
        # forward sorted by key. In future we may consider topological sorting,
251
272
        # at the cost of table scans for direct lookup, or a second index for
252
273
        # direct lookup
315
336
                (len(result.getvalue()), expected_bytes))
316
337
        return result
317
338
 
318
 
    def set_optimize(self, for_size=True):
 
339
    def set_optimize(self, for_size=None, combine_backing_indices=None):
319
340
        """Change how the builder tries to optimize the result.
320
341
 
321
342
        :param for_size: Tell the builder to try and make the index as small as
322
343
            possible.
 
344
        :param combine_backing_indices: If the builder spills to disk to save
 
345
            memory, should the on-disk indices be combined. Set to True if you
 
346
            are going to be probing the index, but to False if you are not. (If
 
347
            you are not querying, then the time spent combining is wasted.)
323
348
        :return: None
324
349
        """
325
350
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
326
351
        # other builders do.
327
 
        self._optimize_for_size = for_size
 
352
        if for_size is not None:
 
353
            self._optimize_for_size = for_size
 
354
        if combine_backing_indices is not None:
 
355
            self._combine_backing_indices = combine_backing_indices
 
356
 
 
357
    def find_ancestry(self, keys, ref_list_num):
 
358
        """See CombinedGraphIndex.find_ancestry()"""
 
359
        pending = set(keys)
 
360
        parent_map = {}
 
361
        missing_keys = set()
 
362
        while pending:
 
363
            next_pending = set()
 
364
            for _, key, value, ref_lists in self.iter_entries(pending):
 
365
                parent_keys = ref_lists[ref_list_num]
 
366
                parent_map[key] = parent_keys
 
367
                next_pending.update([p for p in parent_keys if p not in
 
368
                                     parent_map])
 
369
                missing_keys.update(pending.difference(parent_map))
 
370
            pending = next_pending
 
371
        return parent_map, missing_keys
328
372
 
329
373
 
330
374
class GraphIndex(object):
331
375
    """An index for data with embedded graphs.
332
 
 
 
376
 
333
377
    The index maps keys to a list of key reference lists, and a value.
334
378
    Each node has the same number of key reference lists. Each key reference
335
379
    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 
 
380
    terminated string without any newlines. The storage of the index is
337
381
    hidden in the interface: keys and key references are always tuples of
338
382
    bytestrings, never the internal representation (e.g. dictionary offsets).
339
383
 
345
389
    suitable for production use. :XXX
346
390
    """
347
391
 
348
 
    def __init__(self, transport, name, size):
 
392
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
349
393
        """Open an index called name on transport.
350
394
 
351
395
        :param transport: A bzrlib.transport.Transport.
357
401
            avoided by having it supplied. If size is None, then bisection
358
402
            support will be disabled and accessing the index will just stream
359
403
            all the data.
 
404
        :param offset: Instead of starting the index data at offset 0, start it
 
405
            at an arbitrary offset.
360
406
        """
361
407
        self._transport = transport
362
408
        self._name = name
379
425
        self._size = size
380
426
        # The number of bytes we've read so far in trying to process this file
381
427
        self._bytes_read = 0
 
428
        self._base_offset = offset
382
429
 
383
430
    def __eq__(self, other):
384
431
        """Equal when self and other were created with the same parameters."""
404
451
            # We already did this
405
452
            return
406
453
        if 'index' in debug.debug_flags:
407
 
            mutter('Reading entire index %s', self._transport.abspath(self._name))
 
454
            trace.mutter('Reading entire index %s',
 
455
                          self._transport.abspath(self._name))
408
456
        if stream is None:
409
457
            stream = self._transport.get(self._name)
 
458
            if self._base_offset != 0:
 
459
                # This is wasteful, but it is better than dealing with
 
460
                # adjusting all the offsets, etc.
 
461
                stream = StringIO(stream.read()[self._base_offset:])
410
462
        self._read_prefix(stream)
411
463
        self._expected_elements = 3 + self._key_length
412
464
        line_count = 0
418
470
        trailers = 0
419
471
        pos = stream.tell()
420
472
        lines = stream.read().split('\n')
 
473
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
 
474
        stream.close()
421
475
        del lines[-1]
422
476
        _, _, _, trailers = self._parse_lines(lines, pos)
423
477
        for key, absent, references, value in self._keys_by_offset.itervalues():
430
484
                node_value = value
431
485
            self._nodes[key] = node_value
432
486
        # cache the keys for quick set intersections
433
 
        self._keys = set(self._nodes)
434
487
        if trailers != 1:
435
488
            # there must be one line - the empty trailer line.
436
489
            raise errors.BadIndexData(self)
437
490
 
 
491
    def clear_cache(self):
 
492
        """Clear out any cached/memoized values.
 
493
 
 
494
        This can be called at any time, but generally it is used when we have
 
495
        extracted some information, but don't expect to be requesting any more
 
496
        from this index.
 
497
        """
 
498
 
 
499
    def external_references(self, ref_list_num):
 
500
        """Return references that are not present in this index.
 
501
        """
 
502
        self._buffer_all()
 
503
        if ref_list_num + 1 > self.node_ref_lists:
 
504
            raise ValueError('No ref list %d, index has %d ref lists'
 
505
                % (ref_list_num, self.node_ref_lists))
 
506
        refs = set()
 
507
        nodes = self._nodes
 
508
        for key, (value, ref_lists) in nodes.iteritems():
 
509
            ref_list = ref_lists[ref_list_num]
 
510
            refs.update([ref for ref in ref_list if ref not in nodes])
 
511
        return refs
 
512
 
438
513
    def _get_nodes_by_key(self):
439
514
        if self._nodes_by_key is None:
440
515
            nodes_by_key = {}
502
577
 
503
578
    def _resolve_references(self, references):
504
579
        """Return the resolved key references for references.
505
 
        
 
580
 
506
581
        References are resolved by looking up the location of the key in the
507
582
        _keys_by_offset map and substituting the key name, preserving ordering.
508
583
 
509
 
        :param references: An iterable of iterables of key locations. e.g. 
 
584
        :param references: An iterable of iterables of key locations. e.g.
510
585
            [[123, 456], [123]]
511
586
        :return: A tuple of tuples of keys.
512
587
        """
566
641
 
567
642
    def _iter_entries_from_total_buffer(self, keys):
568
643
        """Iterate over keys when the entire index is parsed."""
569
 
        keys = keys.intersection(self._keys)
 
644
        # Note: See the note in BTreeBuilder.iter_entries for why we don't use
 
645
        #       .intersection() here
 
646
        nodes = self._nodes
 
647
        keys = [key for key in keys if key in nodes]
570
648
        if self.node_ref_lists:
571
649
            for key in keys:
572
 
                value, node_refs = self._nodes[key]
 
650
                value, node_refs = nodes[key]
573
651
                yield self, key, value, node_refs
574
652
        else:
575
653
            for key in keys:
576
 
                yield self, key, self._nodes[key]
 
654
                yield self, key, nodes[key]
577
655
 
578
656
    def iter_entries(self, keys):
579
657
        """Iterate over keys within the index.
601
679
        if self._nodes is not None:
602
680
            return self._iter_entries_from_total_buffer(keys)
603
681
        else:
604
 
            return (result[1] for result in bisect_multi_bytes(
 
682
            return (result[1] for result in bisect_multi.bisect_multi_bytes(
605
683
                self._lookup_keys_via_location, self._size, keys))
606
684
 
607
685
    def iter_entries_prefix(self, keys):
670
748
                    # can't be empty or would not exist
671
749
                    item, value = key_dict.iteritems().next()
672
750
                    if type(value) == dict:
673
 
                        # push keys 
 
751
                        # push keys
674
752
                        dicts.extend(key_dict.itervalues())
675
753
                    else:
676
754
                        # yield keys
682
760
                # the last thing looked up was a terminal element
683
761
                yield (self, ) + key_dict
684
762
 
 
763
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
 
764
        """See BTreeIndex._find_ancestors."""
 
765
        # The api can be implemented as a trivial overlay on top of
 
766
        # iter_entries, it is not an efficient implementation, but it at least
 
767
        # gets the job done.
 
768
        found_keys = set()
 
769
        search_keys = set()
 
770
        for index, key, value, refs in self.iter_entries(keys):
 
771
            parent_keys = refs[ref_list_num]
 
772
            found_keys.add(key)
 
773
            parent_map[key] = parent_keys
 
774
            search_keys.update(parent_keys)
 
775
        # Figure out what, if anything, was missing
 
776
        missing_keys.update(set(keys).difference(found_keys))
 
777
        search_keys = search_keys.difference(parent_map)
 
778
        return search_keys
 
779
 
685
780
    def key_count(self):
686
781
        """Return an estimate of the number of keys in this index.
687
 
        
 
782
 
688
783
        For GraphIndex the estimate is exact.
689
784
        """
690
785
        if self._key_count is None:
706
801
        # Possible improvements:
707
802
        #  - only bisect lookup each key once
708
803
        #  - sort the keys first, and use that to reduce the bisection window
709
 
        # ----- 
 
804
        # -----
710
805
        # this progresses in three parts:
711
806
        # read data
712
807
        # parse it
721
816
                # We have the key parsed.
722
817
                continue
723
818
            index = self._parsed_key_index(key)
724
 
            if (len(self._parsed_key_map) and 
 
819
            if (len(self._parsed_key_map) and
725
820
                self._parsed_key_map[index][0] <= key and
726
821
                (self._parsed_key_map[index][1] >= key or
727
822
                 # end of the file has been parsed
731
826
                continue
732
827
            # - if we have examined this part of the file already - yes
733
828
            index = self._parsed_byte_index(location)
734
 
            if (len(self._parsed_byte_map) and 
 
829
            if (len(self._parsed_byte_map) and
735
830
                self._parsed_byte_map[index][0] <= location and
736
831
                self._parsed_byte_map[index][1] > location):
737
832
                # the byte region has been parsed, so no read is needed.
992
1087
        # adjust offset and data to the parseable data.
993
1088
        trimmed_data = data[trim_start:trim_end]
994
1089
        if not (trimmed_data):
995
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
 
1090
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
996
1091
                % (trim_start, trim_end, offset, offset + len(data)))
997
1092
        if trim_start:
998
1093
            offset += trim_start
1099
1194
            self._parsed_key_map.insert(index + 1, new_key)
1100
1195
 
1101
1196
    def _read_and_parse(self, readv_ranges):
1102
 
        """Read the the ranges and parse the resulting data.
 
1197
        """Read the ranges and parse the resulting data.
1103
1198
 
1104
1199
        :param readv_ranges: A prepared readv range list.
1105
1200
        """
1111
1206
            self._buffer_all()
1112
1207
            return
1113
1208
 
 
1209
        base_offset = self._base_offset
 
1210
        if base_offset != 0:
 
1211
            # Rewrite the ranges for the offset
 
1212
            readv_ranges = [(start+base_offset, size)
 
1213
                            for start, size in readv_ranges]
1114
1214
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1115
 
            self._size)
 
1215
            self._size + self._base_offset)
1116
1216
        # parse
1117
1217
        for offset, data in readv_data:
 
1218
            offset -= base_offset
1118
1219
            self._bytes_read += len(data)
 
1220
            if offset < 0:
 
1221
                # transport.readv() expanded to extra data which isn't part of
 
1222
                # this index
 
1223
                data = data[-offset:]
 
1224
                offset = 0
1119
1225
            if offset == 0 and len(data) == self._size:
1120
1226
                # We read the whole range, most likely because the
1121
1227
                # Transport upcast our readv ranges into one long request
1143
1249
 
1144
1250
class CombinedGraphIndex(object):
1145
1251
    """A GraphIndex made up from smaller GraphIndices.
1146
 
    
 
1252
 
1147
1253
    The backing indices must implement GraphIndex, and are presumed to be
1148
1254
    static data.
1149
1255
 
1150
1256
    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
 
1257
    and then the second and so on. The order of indices can thus influence
1152
1258
    performance significantly. For example, if one index is on local disk and a
1153
1259
    second on a remote server, the local disk index should be before the other
1154
1260
    in the index list.
 
1261
    
 
1262
    Also, queries tend to need results from the same indices as previous
 
1263
    queries.  So the indices will be reordered after every query to put the
 
1264
    indices that had the result(s) of that query first (while otherwise
 
1265
    preserving the relative ordering).
1155
1266
    """
1156
1267
 
1157
1268
    def __init__(self, indices, reload_func=None):
1164
1275
        """
1165
1276
        self._indices = indices
1166
1277
        self._reload_func = reload_func
 
1278
        # Sibling indices are other CombinedGraphIndex that we should call
 
1279
        # _move_to_front_by_name on when we auto-reorder ourself.
 
1280
        self._sibling_indices = []
 
1281
        # A list of names that corresponds to the instances in self._indices,
 
1282
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
 
1283
        # indices must all use the same set of names as each other.
 
1284
        self._index_names = [None] * len(self._indices)
1167
1285
 
1168
1286
    def __repr__(self):
1169
1287
        return "%s(%s)" % (
1170
1288
                self.__class__.__name__,
1171
1289
                ', '.join(map(repr, self._indices)))
1172
1290
 
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]
 
1291
    def clear_cache(self):
 
1292
        """See GraphIndex.clear_cache()"""
 
1293
        for index in self._indices:
 
1294
            index.clear_cache()
1189
1295
 
1190
1296
    def get_parent_map(self, keys):
1191
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
1297
        """See graph.StackedParentsProvider.get_parent_map"""
1192
1298
        search_keys = set(keys)
1193
 
        if NULL_REVISION in search_keys:
1194
 
            search_keys.discard(NULL_REVISION)
1195
 
            found_parents = {NULL_REVISION:[]}
 
1299
        if _mod_revision.NULL_REVISION in search_keys:
 
1300
            search_keys.discard(_mod_revision.NULL_REVISION)
 
1301
            found_parents = {_mod_revision.NULL_REVISION:[]}
1196
1302
        else:
1197
1303
            found_parents = {}
1198
1304
        for index, key, value, refs in self.iter_entries(search_keys):
1199
1305
            parents = refs[0]
1200
1306
            if not parents:
1201
 
                parents = (NULL_REVISION,)
 
1307
                parents = (_mod_revision.NULL_REVISION,)
1202
1308
            found_parents[key] = parents
1203
1309
        return found_parents
1204
1310
 
1205
1311
    has_key = _has_key_from_parent_map
1206
1312
 
1207
 
    def insert_index(self, pos, index):
 
1313
    def insert_index(self, pos, index, name=None):
1208
1314
        """Insert a new index in the list of indices to query.
1209
1315
 
1210
1316
        :param pos: The position to insert the index.
1211
1317
        :param index: The index to insert.
 
1318
        :param name: a name for this index, e.g. a pack name.  These names can
 
1319
            be used to reflect index reorderings to related CombinedGraphIndex
 
1320
            instances that use the same names.  (see set_sibling_indices)
1212
1321
        """
1213
1322
        self._indices.insert(pos, index)
 
1323
        self._index_names.insert(pos, name)
1214
1324
 
1215
1325
    def iter_all_entries(self):
1216
1326
        """Iterate over all keys within the index
1241
1351
        value and are only reported once.
1242
1352
 
1243
1353
        :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
 
1354
        :return: An iterable of (index, key, reference_lists, value). There is
 
1355
            no defined order for the result iteration - it will be in the most
1246
1356
            efficient order for the index.
1247
1357
        """
1248
1358
        keys = set(keys)
 
1359
        hit_indices = []
1249
1360
        while True:
1250
1361
            try:
1251
1362
                for index in self._indices:
1252
1363
                    if not keys:
1253
 
                        return
 
1364
                        break
 
1365
                    index_hit = False
1254
1366
                    for node in index.iter_entries(keys):
1255
1367
                        keys.remove(node[1])
1256
1368
                        yield node
1257
 
                return
 
1369
                        index_hit = True
 
1370
                    if index_hit:
 
1371
                        hit_indices.append(index)
 
1372
                break
1258
1373
            except errors.NoSuchFile:
1259
1374
                self._reload_or_raise()
 
1375
        self._move_to_front(hit_indices)
1260
1376
 
1261
1377
    def iter_entries_prefix(self, keys):
1262
1378
        """Iterate over keys within the index using prefix matching.
1282
1398
        if not keys:
1283
1399
            return
1284
1400
        seen_keys = set()
 
1401
        hit_indices = []
1285
1402
        while True:
1286
1403
            try:
1287
1404
                for index in self._indices:
 
1405
                    index_hit = False
1288
1406
                    for node in index.iter_entries_prefix(keys):
1289
1407
                        if node[1] in seen_keys:
1290
1408
                            continue
1291
1409
                        seen_keys.add(node[1])
1292
1410
                        yield node
1293
 
                return
 
1411
                        index_hit = True
 
1412
                    if index_hit:
 
1413
                        hit_indices.append(index)
 
1414
                break
1294
1415
            except errors.NoSuchFile:
1295
1416
                self._reload_or_raise()
 
1417
        self._move_to_front(hit_indices)
 
1418
 
 
1419
    def _move_to_front(self, hit_indices):
 
1420
        """Rearrange self._indices so that hit_indices are first.
 
1421
 
 
1422
        Order is maintained as much as possible, e.g. the first unhit index
 
1423
        will be the first index in _indices after the hit_indices, and the
 
1424
        hit_indices will be present in exactly the order they are passed to
 
1425
        _move_to_front.
 
1426
 
 
1427
        _move_to_front propagates to all objects in self._sibling_indices by
 
1428
        calling _move_to_front_by_name.
 
1429
        """
 
1430
        if self._indices[:len(hit_indices)] == hit_indices:
 
1431
            # The 'hit_indices' are already at the front (and in the same
 
1432
            # order), no need to re-order
 
1433
            return
 
1434
        hit_names = self._move_to_front_by_index(hit_indices)
 
1435
        for sibling_idx in self._sibling_indices:
 
1436
            sibling_idx._move_to_front_by_name(hit_names)
 
1437
 
 
1438
    def _move_to_front_by_index(self, hit_indices):
 
1439
        """Core logic for _move_to_front.
 
1440
        
 
1441
        Returns a list of names corresponding to the hit_indices param.
 
1442
        """
 
1443
        indices_info = zip(self._index_names, self._indices)
 
1444
        if 'index' in debug.debug_flags:
 
1445
            trace.mutter('CombinedGraphIndex reordering: currently %r, '
 
1446
                         'promoting %r', indices_info, hit_indices)
 
1447
        hit_names = []
 
1448
        unhit_names = []
 
1449
        new_hit_indices = []
 
1450
        unhit_indices = []
 
1451
 
 
1452
        for offset, (name, idx) in enumerate(indices_info):
 
1453
            if idx in hit_indices:
 
1454
                hit_names.append(name)
 
1455
                new_hit_indices.append(idx)
 
1456
                if len(new_hit_indices) == len(hit_indices):
 
1457
                    # We've found all of the hit entries, everything else is
 
1458
                    # unhit
 
1459
                    unhit_names.extend(self._index_names[offset+1:])
 
1460
                    unhit_indices.extend(self._indices[offset+1:])
 
1461
                    break
 
1462
            else:
 
1463
                unhit_names.append(name)
 
1464
                unhit_indices.append(idx)
 
1465
 
 
1466
        self._indices = new_hit_indices + unhit_indices
 
1467
        self._index_names = hit_names + unhit_names
 
1468
        if 'index' in debug.debug_flags:
 
1469
            trace.mutter('CombinedGraphIndex reordered: %r', self._indices)
 
1470
        return hit_names
 
1471
 
 
1472
    def _move_to_front_by_name(self, hit_names):
 
1473
        """Moves indices named by 'hit_names' to front of the search order, as
 
1474
        described in _move_to_front.
 
1475
        """
 
1476
        # Translate names to index instances, and then call
 
1477
        # _move_to_front_by_index.
 
1478
        indices_info = zip(self._index_names, self._indices)
 
1479
        hit_indices = []
 
1480
        for name, idx in indices_info:
 
1481
            if name in hit_names:
 
1482
                hit_indices.append(idx)
 
1483
        self._move_to_front_by_index(hit_indices)
 
1484
 
 
1485
    def find_ancestry(self, keys, ref_list_num):
 
1486
        """Find the complete ancestry for the given set of keys.
 
1487
 
 
1488
        Note that this is a whole-ancestry request, so it should be used
 
1489
        sparingly.
 
1490
 
 
1491
        :param keys: An iterable of keys to look for
 
1492
        :param ref_list_num: The reference list which references the parents
 
1493
            we care about.
 
1494
        :return: (parent_map, missing_keys)
 
1495
        """
 
1496
        # XXX: make this call _move_to_front?
 
1497
        missing_keys = set()
 
1498
        parent_map = {}
 
1499
        keys_to_lookup = set(keys)
 
1500
        generation = 0
 
1501
        while keys_to_lookup:
 
1502
            # keys that *all* indexes claim are missing, stop searching them
 
1503
            generation += 1
 
1504
            all_index_missing = None
 
1505
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
 
1506
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
 
1507
            #                                   len(parent_map),
 
1508
            #                                   len(missing_keys))
 
1509
            for index_idx, index in enumerate(self._indices):
 
1510
                # TODO: we should probably be doing something with
 
1511
                #       'missing_keys' since we've already determined that
 
1512
                #       those revisions have not been found anywhere
 
1513
                index_missing_keys = set()
 
1514
                # Find all of the ancestry we can from this index
 
1515
                # keep looking until the search_keys set is empty, which means
 
1516
                # things we didn't find should be in index_missing_keys
 
1517
                search_keys = keys_to_lookup
 
1518
                sub_generation = 0
 
1519
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
 
1520
                #     index_idx, len(search_keys),
 
1521
                #     len(parent_map), len(index_missing_keys))
 
1522
                while search_keys:
 
1523
                    sub_generation += 1
 
1524
                    # TODO: ref_list_num should really be a parameter, since
 
1525
                    #       CombinedGraphIndex does not know what the ref lists
 
1526
                    #       mean.
 
1527
                    search_keys = index._find_ancestors(search_keys,
 
1528
                        ref_list_num, parent_map, index_missing_keys)
 
1529
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
 
1530
                    #     sub_generation, len(search_keys),
 
1531
                    #     len(parent_map), len(index_missing_keys))
 
1532
                # Now set whatever was missing to be searched in the next index
 
1533
                keys_to_lookup = index_missing_keys
 
1534
                if all_index_missing is None:
 
1535
                    all_index_missing = set(index_missing_keys)
 
1536
                else:
 
1537
                    all_index_missing.intersection_update(index_missing_keys)
 
1538
                if not keys_to_lookup:
 
1539
                    break
 
1540
            if all_index_missing is None:
 
1541
                # There were no indexes, so all search keys are 'missing'
 
1542
                missing_keys.update(keys_to_lookup)
 
1543
                keys_to_lookup = None
 
1544
            else:
 
1545
                missing_keys.update(all_index_missing)
 
1546
                keys_to_lookup.difference_update(all_index_missing)
 
1547
        return parent_map, missing_keys
1296
1548
 
1297
1549
    def key_count(self):
1298
1550
        """Return an estimate of the number of keys in this index.
1327
1579
                         ' Raising original exception.')
1328
1580
            raise exc_type, exc_value, exc_traceback
1329
1581
 
 
1582
    def set_sibling_indices(self, sibling_combined_graph_indices):
 
1583
        """Set the CombinedGraphIndex objects to reorder after reordering self.
 
1584
        """
 
1585
        self._sibling_indices = sibling_combined_graph_indices
 
1586
 
1330
1587
    def validate(self):
1331
1588
        """Validate that everything in the index can be accessed."""
1332
1589
        while True:
1385
1642
            defined order for the result iteration - it will be in the most
1386
1643
            efficient order for the index (keys iteration order in this case).
1387
1644
        """
1388
 
        keys = set(keys)
 
1645
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
 
1646
        #       aren't using set().intersection() here
 
1647
        nodes = self._nodes
 
1648
        keys = [key for key in keys if key in nodes]
1389
1649
        if self.reference_lists:
1390
 
            for key in keys.intersection(self._keys):
1391
 
                node = self._nodes[key]
 
1650
            for key in keys:
 
1651
                node = nodes[key]
1392
1652
                if not node[0]:
1393
1653
                    yield self, key, node[2], node[1]
1394
1654
        else:
1395
 
            for key in keys.intersection(self._keys):
1396
 
                node = self._nodes[key]
 
1655
            for key in keys:
 
1656
                node = nodes[key]
1397
1657
                if not node[0]:
1398
1658
                    yield self, key, node[2]
1399
1659
 
1428
1688
                    raise errors.BadIndexKey(key)
1429
1689
                node = self._nodes[key]
1430
1690
                if node[0]:
1431
 
                    continue 
 
1691
                    continue
1432
1692
                if self.reference_lists:
1433
1693
                    yield self, key, node[2], node[1]
1434
1694
                else:
1459
1719
                    # can't be empty or would not exist
1460
1720
                    item, value = key_dict.iteritems().next()
1461
1721
                    if type(value) == dict:
1462
 
                        # push keys 
 
1722
                        # push keys
1463
1723
                        dicts.extend(key_dict.itervalues())
1464
1724
                    else:
1465
1725
                        # yield keys
1470
1730
 
1471
1731
    def key_count(self):
1472
1732
        """Return an estimate of the number of keys in this index.
1473
 
        
 
1733
 
1474
1734
        For InMemoryGraphIndex the estimate is exact.
1475
1735
        """
1476
 
        return len(self._keys)
 
1736
        return len(self._nodes) - len(self._absent_keys)
1477
1737
 
1478
1738
    def validate(self):
1479
1739
        """In memory index's have no known corruption at the moment."""
1484
1744
 
1485
1745
    Queries against this will emit queries against the adapted Graph with the
1486
1746
    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 
 
1747
    nodes will have their keys and node references adjusted to remove the
1488
1748
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1489
1749
    nodes and references being added will have prefix prepended.
1490
1750
    """
1517
1777
                    adjusted_references))
1518
1778
        except ValueError:
1519
1779
            # XXX: TODO add an explicit interface for getting the reference list
1520
 
            # status, to handle this bit of user-friendliness in the API more 
 
1780
            # status, to handle this bit of user-friendliness in the API more
1521
1781
            # explicitly.
1522
1782
            for (key, value) in nodes:
1523
1783
                translated_nodes.append((self.prefix + key, value))
1595
1855
 
1596
1856
    def key_count(self):
1597
1857
        """Return an estimate of the number of keys in this index.
1598
 
        
 
1858
 
1599
1859
        For GraphIndexPrefixAdapter this is relatively expensive - key
1600
1860
        iteration with the prefix is done.
1601
1861
        """