← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-10-31 04:39:04 UTC
  • mfrom: (3565.6.16 switch_nick)
  • Revision ID: pqm@pqm.ubuntu.com-20081031043904-52fnbfrloojemvcc
(mbp) branch nickname documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
1
 
# Copyright (C) 2007-2011 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Indexing facilities."""
18
18
 
19
 
from __future__ import absolute_import
20
 
 
21
19
__all__ = [
22
20
    'CombinedGraphIndex',
23
21
    'GraphIndex',
33
31
 
34
32
from bzrlib.lazy_import import lazy_import
35
33
lazy_import(globals(), """
36
 
from bzrlib import (
37
 
    bisect_multi,
38
 
    revision as _mod_revision,
39
 
    trace,
40
 
    )
 
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
41
38
""")
42
39
from bzrlib import (
43
40
    debug,
44
41
    errors,
 
42
    symbol_versioning,
45
43
    )
46
 
from bzrlib.static_tuple import StaticTuple
47
44
 
48
45
_HEADER_READV = (0, 200)
49
46
_OPTION_KEY_ELEMENTS = "key_elements="
56
53
_newline_null_re = re.compile('[\n\0]')
57
54
 
58
55
 
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
 
 
72
56
class GraphIndexBuilder(object):
73
57
    """A builder that can build a GraphIndex.
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
 
58
    
 
59
    The resulting graph has the structure:
 
60
    
 
61
    _SIGNATURE OPTIONS NODES NEWLINE
 
62
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
 
63
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
 
64
    NODES          := NODE*
 
65
    NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
 
66
    KEY            := Not-whitespace-utf8
 
67
    ABSENT         := 'a'
 
68
    REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
 
69
    REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
 
70
    REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
 
71
                              ; referenced key.
 
72
    VALUE          := no-newline-no-null-bytes
89
73
    """
90
74
 
91
75
    def __init__(self, reference_lists=0, key_elements=1):
96
80
        :param key_elements: The number of bytestrings in each key.
97
81
        """
98
82
        self.reference_lists = reference_lists
 
83
        self._keys = set()
99
84
        # A dict of {key: (absent, ref_lists, value)}
100
85
        self._nodes = {}
101
 
        # Keys that are referenced but not actually present in this index
102
 
        self._absent_keys = set()
103
86
        self._nodes_by_key = None
104
87
        self._key_length = key_elements
105
88
        self._optimize_for_size = False
106
 
        self._combine_backing_indices = True
107
89
 
108
90
    def _check_key(self, key):
109
91
        """Raise BadIndexKey if key is not a valid key for this index."""
110
 
        if type(key) not in (tuple, StaticTuple):
 
92
        if type(key) != tuple:
111
93
            raise errors.BadIndexKey(key)
112
94
        if self._key_length != len(key):
113
95
            raise errors.BadIndexKey(key)
115
97
            if not element or _whitespace_re.search(element) is not None:
116
98
                raise errors.BadIndexKey(element)
117
99
 
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
 
 
140
100
    def _get_nodes_by_key(self):
141
101
        if self._nodes_by_key is None:
142
102
            nodes_by_key = {}
169
129
            return
170
130
        key_dict = self._nodes_by_key
171
131
        if self.reference_lists:
172
 
            key_value = StaticTuple(key, value, node_refs)
 
132
            key_value = key, value, node_refs
173
133
        else:
174
 
            key_value = StaticTuple(key, value)
 
134
            key_value = key, value
175
135
        for subkey in key[:-1]:
176
136
            key_dict = key_dict.setdefault(subkey, {})
177
137
        key_dict[key[-1]] = key_value
187
147
        :param value: The value associate with this key. Must not contain
188
148
            newlines or null characters.
189
149
        :return: (node_refs, absent_references)
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.
 
150
            node_refs   basically a packed form of 'references' where all
 
151
                        iterables are tuples
 
152
            absent_references   reference keys that are not in self._nodes.
 
153
                                This may contain duplicates if the same key is
 
154
                                referenced in multiple lists.
196
155
        """
197
 
        as_st = StaticTuple.from_sequence
198
156
        self._check_key(key)
199
157
        if _newline_null_re.search(value) is not None:
200
158
            raise errors.BadIndexValue(value)
209
167
                if reference not in self._nodes:
210
168
                    self._check_key(reference)
211
169
                    absent_references.append(reference)
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
            node_refs.append(tuple(reference_list))
 
171
        return tuple(node_refs), absent_references
216
172
 
217
173
    def add_node(self, key, value, references=()):
218
174
        """Add a node to the index.
223
179
        :param references: An iterable of iterables of keys. Each is a
224
180
            reference to another key.
225
181
        :param value: The value to associate with the key. It may be any
226
 
            bytes as long as it does not contain \\0 or \\n.
 
182
            bytes as long as it does not contain \0 or \n.
227
183
        """
228
184
        (node_refs,
229
185
         absent_references) = self._check_key_ref_value(key, references, value)
233
189
            # There may be duplicates, but I don't think it is worth worrying
234
190
            # about
235
191
            self._nodes[reference] = ('a', (), '')
236
 
        self._absent_keys.update(absent_references)
237
 
        self._absent_keys.discard(key)
238
192
        self._nodes[key] = ('', node_refs, value)
 
193
        self._keys.add(key)
239
194
        if self._nodes_by_key is not None and self._key_length > 1:
240
195
            self._update_nodes_by_key(key, value, node_refs)
241
196
 
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
 
        
249
197
    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
 
        """
255
198
        lines = [_SIGNATURE]
256
199
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
257
200
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
258
 
        key_count = len(self._nodes) - len(self._absent_keys)
259
 
        lines.append(_OPTION_LEN + str(key_count) + '\n')
 
201
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
260
202
        prefix_length = sum(len(x) for x in lines)
261
203
        # references are byte offsets. To avoid having to do nasty
262
204
        # polynomial work to resolve offsets (references to later in the
269
211
        # one to pad all the data with reference-length and determine entry
270
212
        # addresses.
271
213
        # One to serialise.
272
 
 
 
214
        
273
215
        # forward sorted by key. In future we may consider topological sorting,
274
216
        # at the cost of table scans for direct lookup, or a second index for
275
217
        # direct lookup
338
280
                (len(result.getvalue()), expected_bytes))
339
281
        return result
340
282
 
341
 
    def set_optimize(self, for_size=None, combine_backing_indices=None):
 
283
    def set_optimize(self, for_size=True):
342
284
        """Change how the builder tries to optimize the result.
343
285
 
344
286
        :param for_size: Tell the builder to try and make the index as small as
345
287
            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
288
        :return: None
351
289
        """
352
290
        # GraphIndexBuilder itself doesn't pay attention to the flag yet, but
353
291
        # 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
 
292
        self._optimize_for_size = for_size
374
293
 
375
294
 
376
295
class GraphIndex(object):
377
296
    """An index for data with embedded graphs.
378
 
 
 
297
 
379
298
    The index maps keys to a list of key reference lists, and a value.
380
299
    Each node has the same number of key reference lists. Each key reference
381
300
    list can be empty or an arbitrary length. The value is an opaque NULL
382
 
    terminated string without any newlines. The storage of the index is
 
301
    terminated string without any newlines. The storage of the index is 
383
302
    hidden in the interface: keys and key references are always tuples of
384
303
    bytestrings, never the internal representation (e.g. dictionary offsets).
385
304
 
391
310
    suitable for production use. :XXX
392
311
    """
393
312
 
394
 
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
 
313
    def __init__(self, transport, name, size):
395
314
        """Open an index called name on transport.
396
315
 
397
316
        :param transport: A bzrlib.transport.Transport.
403
322
            avoided by having it supplied. If size is None, then bisection
404
323
            support will be disabled and accessing the index will just stream
405
324
            all the data.
406
 
        :param offset: Instead of starting the index data at offset 0, start it
407
 
            at an arbitrary offset.
408
325
        """
409
326
        self._transport = transport
410
327
        self._name = name
427
344
        self._size = size
428
345
        # The number of bytes we've read so far in trying to process this file
429
346
        self._bytes_read = 0
430
 
        self._base_offset = offset
431
347
 
432
348
    def __eq__(self, other):
433
349
        """Equal when self and other were created with the same parameters."""
453
369
            # We already did this
454
370
            return
455
371
        if 'index' in debug.debug_flags:
456
 
            trace.mutter('Reading entire index %s',
457
 
                          self._transport.abspath(self._name))
 
372
            mutter('Reading entire index %s', self._transport.abspath(self._name))
458
373
        if stream is None:
459
374
            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:])
464
375
        self._read_prefix(stream)
465
376
        self._expected_elements = 3 + self._key_length
466
377
        line_count = 0
472
383
        trailers = 0
473
384
        pos = stream.tell()
474
385
        lines = stream.read().split('\n')
475
 
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
476
 
        stream.close()
477
386
        del lines[-1]
478
387
        _, _, _, trailers = self._parse_lines(lines, pos)
479
388
        for key, absent, references, value in self._keys_by_offset.itervalues():
486
395
                node_value = value
487
396
            self._nodes[key] = node_value
488
397
        # cache the keys for quick set intersections
 
398
        self._keys = set(self._nodes)
489
399
        if trailers != 1:
490
400
            # there must be one line - the empty trailer line.
491
401
            raise errors.BadIndexData(self)
492
402
 
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
403
    def _get_nodes_by_key(self):
516
404
        if self._nodes_by_key is None:
517
405
            nodes_by_key = {}
579
467
 
580
468
    def _resolve_references(self, references):
581
469
        """Return the resolved key references for references.
582
 
 
 
470
        
583
471
        References are resolved by looking up the location of the key in the
584
472
        _keys_by_offset map and substituting the key name, preserving ordering.
585
473
 
586
 
        :param references: An iterable of iterables of key locations. e.g.
 
474
        :param references: An iterable of iterables of key locations. e.g. 
587
475
            [[123, 456], [123]]
588
476
        :return: A tuple of tuples of keys.
589
477
        """
643
531
 
644
532
    def _iter_entries_from_total_buffer(self, keys):
645
533
        """Iterate over keys when the entire index is parsed."""
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]
 
534
        keys = keys.intersection(self._keys)
650
535
        if self.node_ref_lists:
651
536
            for key in keys:
652
 
                value, node_refs = nodes[key]
 
537
                value, node_refs = self._nodes[key]
653
538
                yield self, key, value, node_refs
654
539
        else:
655
540
            for key in keys:
656
 
                yield self, key, nodes[key]
 
541
                yield self, key, self._nodes[key]
657
542
 
658
543
    def iter_entries(self, keys):
659
544
        """Iterate over keys within the index.
681
566
        if self._nodes is not None:
682
567
            return self._iter_entries_from_total_buffer(keys)
683
568
        else:
684
 
            return (result[1] for result in bisect_multi.bisect_multi_bytes(
 
569
            return (result[1] for result in bisect_multi_bytes(
685
570
                self._lookup_keys_via_location, self._size, keys))
686
571
 
687
572
    def iter_entries_prefix(self, keys):
750
635
                    # can't be empty or would not exist
751
636
                    item, value = key_dict.iteritems().next()
752
637
                    if type(value) == dict:
753
 
                        # push keys
 
638
                        # push keys 
754
639
                        dicts.extend(key_dict.itervalues())
755
640
                    else:
756
641
                        # yield keys
762
647
                # the last thing looked up was a terminal element
763
648
                yield (self, ) + key_dict
764
649
 
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
 
 
782
650
    def key_count(self):
783
651
        """Return an estimate of the number of keys in this index.
784
 
 
 
652
        
785
653
        For GraphIndex the estimate is exact.
786
654
        """
787
655
        if self._key_count is None:
803
671
        # Possible improvements:
804
672
        #  - only bisect lookup each key once
805
673
        #  - sort the keys first, and use that to reduce the bisection window
806
 
        # -----
 
674
        # ----- 
807
675
        # this progresses in three parts:
808
676
        # read data
809
677
        # parse it
818
686
                # We have the key parsed.
819
687
                continue
820
688
            index = self._parsed_key_index(key)
821
 
            if (len(self._parsed_key_map) and
 
689
            if (len(self._parsed_key_map) and 
822
690
                self._parsed_key_map[index][0] <= key and
823
691
                (self._parsed_key_map[index][1] >= key or
824
692
                 # end of the file has been parsed
828
696
                continue
829
697
            # - if we have examined this part of the file already - yes
830
698
            index = self._parsed_byte_index(location)
831
 
            if (len(self._parsed_byte_map) and
 
699
            if (len(self._parsed_byte_map) and 
832
700
                self._parsed_byte_map[index][0] <= location and
833
701
                self._parsed_byte_map[index][1] > location):
834
702
                # the byte region has been parsed, so no read is needed.
1089
957
        # adjust offset and data to the parseable data.
1090
958
        trimmed_data = data[trim_start:trim_end]
1091
959
        if not (trimmed_data):
1092
 
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
 
960
            raise AssertionError('read unneeded data [%d:%d] from [%d:%d]' 
1093
961
                % (trim_start, trim_end, offset, offset + len(data)))
1094
962
        if trim_start:
1095
963
            offset += trim_start
1196
1064
            self._parsed_key_map.insert(index + 1, new_key)
1197
1065
 
1198
1066
    def _read_and_parse(self, readv_ranges):
1199
 
        """Read the ranges and parse the resulting data.
 
1067
        """Read the the ranges and parse the resulting data.
1200
1068
 
1201
1069
        :param readv_ranges: A prepared readv range list.
1202
1070
        """
1208
1076
            self._buffer_all()
1209
1077
            return
1210
1078
 
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]
1216
1079
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1217
 
            self._size + self._base_offset)
 
1080
            self._size)
1218
1081
        # parse
1219
1082
        for offset, data in readv_data:
1220
 
            offset -= base_offset
1221
1083
            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
1227
1084
            if offset == 0 and len(data) == self._size:
1228
1085
                # We read the whole range, most likely because the
1229
1086
                # Transport upcast our readv ranges into one long request
1251
1108
 
1252
1109
class CombinedGraphIndex(object):
1253
1110
    """A GraphIndex made up from smaller GraphIndices.
1254
 
 
 
1111
    
1255
1112
    The backing indices must implement GraphIndex, and are presumed to be
1256
1113
    static data.
1257
1114
 
1258
1115
    Queries against the combined index will be made against the first index,
1259
 
    and then the second and so on. The order of indices can thus influence
 
1116
    and then the second and so on. The order of index's can thus influence
1260
1117
    performance significantly. For example, if one index is on local disk and a
1261
1118
    second on a remote server, the local disk index should be before the other
1262
1119
    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).
1268
1120
    """
1269
1121
 
1270
1122
    def __init__(self, indices, reload_func=None):
1277
1129
        """
1278
1130
        self._indices = indices
1279
1131
        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)
1287
1132
 
1288
1133
    def __repr__(self):
1289
1134
        return "%s(%s)" % (
1290
1135
                self.__class__.__name__,
1291
1136
                ', '.join(map(repr, self._indices)))
1292
1137
 
1293
 
    def clear_cache(self):
1294
 
        """See GraphIndex.clear_cache()"""
1295
 
        for index in self._indices:
1296
 
            index.clear_cache()
 
1138
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
1139
    def get_parents(self, revision_ids):
 
1140
        """See graph._StackedParentsProvider.get_parents.
 
1141
        
 
1142
        This implementation thunks the graph.Graph.get_parents api across to
 
1143
        GraphIndex.
 
1144
 
 
1145
        :param revision_ids: An iterable of graph keys for this graph.
 
1146
        :return: A list of parent details for each key in revision_ids.
 
1147
            Each parent details will be one of:
 
1148
             * None when the key was missing
 
1149
             * (NULL_REVISION,) when the key has no parents.
 
1150
             * (parent_key, parent_key...) otherwise.
 
1151
        """
 
1152
        parent_map = self.get_parent_map(revision_ids)
 
1153
        return [parent_map.get(r, None) for r in revision_ids]
1297
1154
 
1298
1155
    def get_parent_map(self, keys):
1299
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
1156
        """See graph._StackedParentsProvider.get_parent_map"""
1300
1157
        search_keys = set(keys)
1301
 
        if _mod_revision.NULL_REVISION in search_keys:
1302
 
            search_keys.discard(_mod_revision.NULL_REVISION)
1303
 
            found_parents = {_mod_revision.NULL_REVISION:[]}
 
1158
        if NULL_REVISION in search_keys:
 
1159
            search_keys.discard(NULL_REVISION)
 
1160
            found_parents = {NULL_REVISION:[]}
1304
1161
        else:
1305
1162
            found_parents = {}
1306
1163
        for index, key, value, refs in self.iter_entries(search_keys):
1307
1164
            parents = refs[0]
1308
1165
            if not parents:
1309
 
                parents = (_mod_revision.NULL_REVISION,)
 
1166
                parents = (NULL_REVISION,)
1310
1167
            found_parents[key] = parents
1311
1168
        return found_parents
1312
1169
 
1313
 
    has_key = _has_key_from_parent_map
1314
 
 
1315
 
    def insert_index(self, pos, index, name=None):
 
1170
    def insert_index(self, pos, index):
1316
1171
        """Insert a new index in the list of indices to query.
1317
1172
 
1318
1173
        :param pos: The position to insert the index.
1319
1174
        :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)
1323
1175
        """
1324
1176
        self._indices.insert(pos, index)
1325
 
        self._index_names.insert(pos, name)
1326
1177
 
1327
1178
    def iter_all_entries(self):
1328
1179
        """Iterate over all keys within the index
1353
1204
        value and are only reported once.
1354
1205
 
1355
1206
        :param keys: An iterable providing the keys to be retrieved.
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
 
1207
        :return: An iterable of (index, key, reference_lists, value). There is no
 
1208
            defined order for the result iteration - it will be in the most
1358
1209
            efficient order for the index.
1359
1210
        """
1360
1211
        keys = set(keys)
1361
 
        hit_indices = []
1362
1212
        while True:
1363
1213
            try:
1364
1214
                for index in self._indices:
1365
1215
                    if not keys:
1366
 
                        break
1367
 
                    index_hit = False
 
1216
                        return
1368
1217
                    for node in index.iter_entries(keys):
1369
1218
                        keys.remove(node[1])
1370
1219
                        yield node
1371
 
                        index_hit = True
1372
 
                    if index_hit:
1373
 
                        hit_indices.append(index)
1374
 
                break
 
1220
                return
1375
1221
            except errors.NoSuchFile:
1376
1222
                self._reload_or_raise()
1377
 
        self._move_to_front(hit_indices)
1378
1223
 
1379
1224
    def iter_entries_prefix(self, keys):
1380
1225
        """Iterate over keys within the index using prefix matching.
1400
1245
        if not keys:
1401
1246
            return
1402
1247
        seen_keys = set()
1403
 
        hit_indices = []
1404
1248
        while True:
1405
1249
            try:
1406
1250
                for index in self._indices:
1407
 
                    index_hit = False
1408
1251
                    for node in index.iter_entries_prefix(keys):
1409
1252
                        if node[1] in seen_keys:
1410
1253
                            continue
1411
1254
                        seen_keys.add(node[1])
1412
1255
                        yield node
1413
 
                        index_hit = True
1414
 
                    if index_hit:
1415
 
                        hit_indices.append(index)
1416
 
                break
 
1256
                return
1417
1257
            except errors.NoSuchFile:
1418
1258
                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
1550
1259
 
1551
1260
    def key_count(self):
1552
1261
        """Return an estimate of the number of keys in this index.
1562
1271
            except errors.NoSuchFile:
1563
1272
                self._reload_or_raise()
1564
1273
 
1565
 
    missing_keys = _missing_keys_from_parent_map
1566
 
 
1567
1274
    def _reload_or_raise(self):
1568
1275
        """We just got a NoSuchFile exception.
1569
1276
 
1581
1288
                         ' Raising original exception.')
1582
1289
            raise exc_type, exc_value, exc_traceback
1583
1290
 
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
 
 
1589
1291
    def validate(self):
1590
1292
        """Validate that everything in the index can be accessed."""
1591
1293
        while True:
1644
1346
            defined order for the result iteration - it will be in the most
1645
1347
            efficient order for the index (keys iteration order in this case).
1646
1348
        """
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]
 
1349
        keys = set(keys)
1651
1350
        if self.reference_lists:
1652
 
            for key in keys:
1653
 
                node = nodes[key]
 
1351
            for key in keys.intersection(self._keys):
 
1352
                node = self._nodes[key]
1654
1353
                if not node[0]:
1655
1354
                    yield self, key, node[2], node[1]
1656
1355
        else:
1657
 
            for key in keys:
1658
 
                node = nodes[key]
 
1356
            for key in keys.intersection(self._keys):
 
1357
                node = self._nodes[key]
1659
1358
                if not node[0]:
1660
1359
                    yield self, key, node[2]
1661
1360
 
1690
1389
                    raise errors.BadIndexKey(key)
1691
1390
                node = self._nodes[key]
1692
1391
                if node[0]:
1693
 
                    continue
 
1392
                    continue 
1694
1393
                if self.reference_lists:
1695
1394
                    yield self, key, node[2], node[1]
1696
1395
                else:
1721
1420
                    # can't be empty or would not exist
1722
1421
                    item, value = key_dict.iteritems().next()
1723
1422
                    if type(value) == dict:
1724
 
                        # push keys
 
1423
                        # push keys 
1725
1424
                        dicts.extend(key_dict.itervalues())
1726
1425
                    else:
1727
1426
                        # yield keys
1732
1431
 
1733
1432
    def key_count(self):
1734
1433
        """Return an estimate of the number of keys in this index.
1735
 
 
 
1434
        
1736
1435
        For InMemoryGraphIndex the estimate is exact.
1737
1436
        """
1738
 
        return len(self._nodes) - len(self._absent_keys)
 
1437
        return len(self._keys)
1739
1438
 
1740
1439
    def validate(self):
1741
1440
        """In memory index's have no known corruption at the moment."""
1746
1445
 
1747
1446
    Queries against this will emit queries against the adapted Graph with the
1748
1447
    prefix added, queries for all items use iter_entries_prefix. The returned
1749
 
    nodes will have their keys and node references adjusted to remove the
 
1448
    nodes will have their keys and node references adjusted to remove the 
1750
1449
    prefix. Finally, an add_nodes_callback can be supplied - when called the
1751
1450
    nodes and references being added will have prefix prepended.
1752
1451
    """
1779
1478
                    adjusted_references))
1780
1479
        except ValueError:
1781
1480
            # XXX: TODO add an explicit interface for getting the reference list
1782
 
            # status, to handle this bit of user-friendliness in the API more
 
1481
            # status, to handle this bit of user-friendliness in the API more 
1783
1482
            # explicitly.
1784
1483
            for (key, value) in nodes:
1785
1484
                translated_nodes.append((self.prefix + key, value))
1857
1556
 
1858
1557
    def key_count(self):
1859
1558
        """Return an estimate of the number of keys in this index.
1860
 
 
 
1559
        
1861
1560
        For GraphIndexPrefixAdapter this is relatively expensive - key
1862
1561
        iteration with the prefix is done.
1863
1562
        """