112
86
if not element or _whitespace_re.search(element) is not None:
113
87
raise errors.BadIndexKey(element)
115
def _external_references(self):
116
"""Return references that are not present in this index.
120
# TODO: JAM 2008-11-21 This makes an assumption about how the reference
121
# lists are used. It is currently correct for pack-0.92 through
122
# 1.9, which use the node references (3rd column) second
123
# reference list as the compression parent. Perhaps this should
124
# be moved into something higher up the stack, since it
125
# makes assumptions about how the index is used.
126
if self.reference_lists > 1:
127
for node in self.iter_all_entries():
129
refs.update(node[3][1])
132
# If reference_lists == 0 there can be no external references, and
133
# if reference_lists == 1, then there isn't a place to store the
137
def _get_nodes_by_key(self):
138
if self._nodes_by_key is None:
140
if self.reference_lists:
141
for key, (absent, references, value) in self._nodes.iteritems():
144
key_dict = nodes_by_key
145
for subkey in key[:-1]:
146
key_dict = key_dict.setdefault(subkey, {})
147
key_dict[key[-1]] = key, value, references
149
for key, (absent, references, value) in self._nodes.iteritems():
152
key_dict = nodes_by_key
153
for subkey in key[:-1]:
154
key_dict = key_dict.setdefault(subkey, {})
155
key_dict[key[-1]] = key, value
156
self._nodes_by_key = nodes_by_key
157
return self._nodes_by_key
159
def _update_nodes_by_key(self, key, value, node_refs):
160
"""Update the _nodes_by_key dict with a new key.
162
For a key of (foo, bar, baz) create
163
_nodes_by_key[foo][bar][baz] = key_value
165
if self._nodes_by_key is None:
167
key_dict = self._nodes_by_key
168
if self.reference_lists:
169
key_value = StaticTuple(key, value, node_refs)
171
key_value = StaticTuple(key, value)
172
for subkey in key[:-1]:
173
key_dict = key_dict.setdefault(subkey, {})
174
key_dict[key[-1]] = key_value
176
def _check_key_ref_value(self, key, references, value):
177
"""Check that 'key' and 'references' are all valid.
179
:param key: A key tuple. Must conform to the key interface (be a tuple,
180
be of the right length, not have any whitespace or nulls in any key
182
:param references: An iterable of reference lists. Something like
183
[[(ref, key)], [(ref, key), (other, key)]]
184
:param value: The value associate with this key. Must not contain
185
newlines or null characters.
186
:return: (node_refs, absent_references)
187
node_refs basically a packed form of 'references' where all
189
absent_references reference keys that are not in self._nodes.
190
This may contain duplicates if the same key is
191
referenced in multiple lists.
193
as_st = StaticTuple.from_sequence
89
def add_node(self, key, value, references=()):
90
"""Add a node to the index.
92
:param key: The key. keys are non-empty tuples containing
93
as many whitespace-free utf8 bytestrings as the key length
94
defined for this index.
95
:param references: An iterable of iterables of keys. Each is a
96
reference to another key.
97
:param value: The value to associate with the key. It may be any
98
bytes as long as it does not contain \0 or \n.
194
100
self._check_key(key)
195
101
if _newline_null_re.search(value) is not None:
196
102
raise errors.BadIndexValue(value)
197
103
if len(references) != self.reference_lists:
198
104
raise errors.BadIndexValue(references)
200
absent_references = []
201
106
for reference_list in references:
202
107
for reference in reference_list:
203
# If reference *is* in self._nodes, then we know it has already
108
self._check_key(reference)
205
109
if reference not in self._nodes:
206
self._check_key(reference)
207
absent_references.append(reference)
208
reference_list = as_st([as_st(ref).intern()
209
for ref in reference_list])
210
node_refs.append(reference_list)
211
return as_st(node_refs), absent_references
213
def add_node(self, key, value, references=()):
214
"""Add a node to the index.
216
:param key: The key. keys are non-empty tuples containing
217
as many whitespace-free utf8 bytestrings as the key length
218
defined for this index.
219
:param references: An iterable of iterables of keys. Each is a
220
reference to another key.
221
:param value: The value to associate with the key. It may be any
222
bytes as long as it does not contain \0 or \n.
225
absent_references) = self._check_key_ref_value(key, references, value)
226
if key in self._nodes and self._nodes[key][0] != 'a':
110
self._nodes[reference] = ('a', (), '')
111
node_refs.append(tuple(reference_list))
112
if key in self._nodes and self._nodes[key][0] == '':
227
113
raise errors.BadIndexDuplicateKey(key, self)
228
for reference in absent_references:
229
# There may be duplicates, but I don't think it is worth worrying
231
self._nodes[reference] = ('a', (), '')
232
self._absent_keys.update(absent_references)
233
self._absent_keys.discard(key)
234
self._nodes[key] = ('', node_refs, value)
235
if self._nodes_by_key is not None and self._key_length > 1:
236
self._update_nodes_by_key(key, value, node_refs)
238
def clear_cache(self):
239
"""See GraphIndex.clear_cache()
241
This is a no-op, but we need the api to conform to a generic 'Index'
114
self._nodes[key] = ('', tuple(node_refs), value)
116
if self._key_length > 1:
117
key_dict = self._nodes_by_key
118
if self.reference_lists:
119
key_value = key, value, tuple(node_refs)
121
key_value = key, value
122
# possibly should do this on-demand, but it seems likely it is
124
# For a key of (foo, bar, baz) create
125
# _nodes_by_key[foo][bar][baz] = key_value
126
for subkey in key[:-1]:
127
key_dict = key_dict.setdefault(subkey, {})
128
key_dict[key[-1]] = key_value
245
130
def finish(self):
246
131
lines = [_SIGNATURE]
247
132
lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
248
133
lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
249
key_count = len(self._nodes) - len(self._absent_keys)
250
lines.append(_OPTION_LEN + str(key_count) + '\n')
134
lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
251
135
prefix_length = sum(len(x) for x in lines)
252
136
# references are byte offsets. To avoid having to do nasty
253
# polynomial work to resolve offsets (references to later in the
137
# polynomial work to resolve offsets (references to later in the
254
138
# file cannot be determined until all the inbetween references have
255
139
# been calculated too) we pad the offsets with 0's to make them be
256
140
# of consistent length. Using binary offsets would break the trivial
382
232
suitable for production use. :XXX
385
def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
235
def __init__(self, transport, name):
386
236
"""Open an index called name on transport.
388
238
:param transport: A bzrlib.transport.Transport.
389
239
:param name: A path to provide to transport API calls.
390
:param size: The size of the index in bytes. This is used for bisection
391
logic to perform partial index reads. While the size could be
392
obtained by statting the file this introduced an additional round
393
trip as well as requiring stat'able transports, both of which are
394
avoided by having it supplied. If size is None, then bisection
395
support will be disabled and accessing the index will just stream
397
:param offset: Instead of starting the index data at offset 0, start it
398
at an arbitrary offset.
400
241
self._transport = transport
401
242
self._name = name
402
# Becomes a dict of key:(value, reference-list-byte-locations) used by
403
# the bisection interface to store parsed but not resolved keys.
404
self._bisect_nodes = None
405
# Becomes a dict of key:(value, reference-list-keys) which are ready to
406
# be returned directly to callers.
407
243
self._nodes = None
408
# a sorted list of slice-addresses for the parsed bytes of the file.
409
# e.g. (0,1) would mean that byte 0 is parsed.
410
self._parsed_byte_map = []
411
# a sorted list of keys matching each slice address for parsed bytes
412
# e.g. (None, 'foo@bar') would mean that the first byte contained no
413
# key, and the end byte of the slice is the of the data for 'foo@bar'
414
self._parsed_key_map = []
415
244
self._key_count = None
416
245
self._keys_by_offset = None
417
246
self._nodes_by_key = None
419
# The number of bytes we've read so far in trying to process this file
421
self._base_offset = offset
423
def __eq__(self, other):
424
"""Equal when self and other were created with the same parameters."""
426
type(self) == type(other) and
427
self._transport == other._transport and
428
self._name == other._name and
429
self._size == other._size)
431
def __ne__(self, other):
432
return not self.__eq__(other)
435
return "%s(%r)" % (self.__class__.__name__,
436
self._transport.abspath(self._name))
438
def _buffer_all(self, stream=None):
248
def _buffer_all(self):
439
249
"""Buffer all the index data.
441
251
Mutates self._nodes and self.keys_by_offset.
443
if self._nodes is not None:
444
# We already did this
446
253
if 'index' in debug.debug_flags:
447
254
mutter('Reading entire index %s', self._transport.abspath(self._name))
449
stream = self._transport.get(self._name)
450
if self._base_offset != 0:
451
# This is wasteful, but it is better than dealing with
452
# adjusting all the offsets, etc.
453
stream = StringIO(stream.read()[self._base_offset:])
255
stream = self._transport.get(self._name)
454
256
self._read_prefix(stream)
455
self._expected_elements = 3 + self._key_length
257
expected_elements = 3 + self._key_length
457
259
# raw data keyed by offset
458
260
self._keys_by_offset = {}
459
261
# ready-to-return key:value or key:value, node_ref_lists
461
self._nodes_by_key = None
263
self._nodes_by_key = {}
463
265
pos = stream.tell()
464
lines = stream.read().split('\n')
465
# GZ 2009-09-20: Should really use a try/finally block to ensure close
468
_, _, _, trailers = self._parse_lines(lines, pos)
266
for line in stream.readlines():
270
elements = line.split('\0')
271
if len(elements) != expected_elements:
272
raise errors.BadIndexData(self)
274
key = tuple(elements[:self._key_length])
275
absent, references, value = elements[-3:]
276
value = value[:-1] # remove the newline
278
for ref_string in references.split('\t'):
279
ref_lists.append(tuple([
280
int(ref) for ref in ref_string.split('\r') if ref
282
ref_lists = tuple(ref_lists)
283
self._keys_by_offset[pos] = (key, absent, ref_lists, value)
469
285
for key, absent, references, value in self._keys_by_offset.itervalues():
472
288
# resolve references:
473
289
if self.node_ref_lists:
474
node_value = (value, self._resolve_references(references))
291
for ref_list in references:
292
node_refs.append(tuple([self._keys_by_offset[ref][0] for ref in ref_list]))
293
node_value = (value, tuple(node_refs))
476
295
node_value = value
477
296
self._nodes[key] = node_value
297
if self._key_length > 1:
298
subkey = list(reversed(key[:-1]))
299
key_dict = self._nodes_by_key
300
if self.node_ref_lists:
301
key_value = key, node_value[0], node_value[1]
303
key_value = key, node_value
304
# possibly should do this on-demand, but it seems likely it is
306
# For a key of (foo, bar, baz) create
307
# _nodes_by_key[foo][bar][baz] = key_value
308
for subkey in key[:-1]:
309
key_dict = key_dict.setdefault(subkey, {})
310
key_dict[key[-1]] = key_value
478
311
# cache the keys for quick set intersections
312
self._keys = set(self._nodes)
479
313
if trailers != 1:
480
314
# there must be one line - the empty trailer line.
481
315
raise errors.BadIndexData(self)
483
def clear_cache(self):
484
"""Clear out any cached/memoized values.
486
This can be called at any time, but generally it is used when we have
487
extracted some information, but don't expect to be requesting any more
491
def external_references(self, ref_list_num):
492
"""Return references that are not present in this index.
495
if ref_list_num + 1 > self.node_ref_lists:
496
raise ValueError('No ref list %d, index has %d ref lists'
497
% (ref_list_num, self.node_ref_lists))
500
for key, (value, ref_lists) in nodes.iteritems():
501
ref_list = ref_lists[ref_list_num]
502
refs.update([ref for ref in ref_list if ref not in nodes])
505
def _get_nodes_by_key(self):
506
if self._nodes_by_key is None:
508
if self.node_ref_lists:
509
for key, (value, references) in self._nodes.iteritems():
510
key_dict = nodes_by_key
511
for subkey in key[:-1]:
512
key_dict = key_dict.setdefault(subkey, {})
513
key_dict[key[-1]] = key, value, references
515
for key, value in self._nodes.iteritems():
516
key_dict = nodes_by_key
517
for subkey in key[:-1]:
518
key_dict = key_dict.setdefault(subkey, {})
519
key_dict[key[-1]] = key, value
520
self._nodes_by_key = nodes_by_key
521
return self._nodes_by_key
523
317
def iter_all_entries(self):
524
318
"""Iterate over all keys within the index.
526
:return: An iterable of (index, key, value) or (index, key, value, reference_lists).
320
:return: An iterable of (key, value) or (key, value, reference_lists).
527
321
The former tuple is used when there are no reference lists in the
528
322
index, making the API compatible with simple key:value index types.
529
323
There is no defined order for the result iteration - it will be in
530
324
the most efficient order for the index.
532
326
if 'evil' in debug.debug_flags:
533
trace.mutter_callsite(3,
327
trace.mutter_callsite(2,
534
328
"iter_all_entries scales with size of history.")
535
329
if self._nodes is None:
536
330
self._buffer_all()
752
455
# the last thing looked up was a terminal element
753
456
yield (self, ) + key_dict
755
def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
756
"""See BTreeIndex._find_ancestors."""
757
# The api can be implemented as a trivial overlay on top of
758
# iter_entries, it is not an efficient implementation, but it at least
762
for index, key, value, refs in self.iter_entries(keys):
763
parent_keys = refs[ref_list_num]
765
parent_map[key] = parent_keys
766
search_keys.update(parent_keys)
767
# Figure out what, if anything, was missing
768
missing_keys.update(set(keys).difference(found_keys))
769
search_keys = search_keys.difference(parent_map)
772
458
def key_count(self):
773
459
"""Return an estimate of the number of keys in this index.
775
461
For GraphIndex the estimate is exact.
777
463
if self._key_count is None:
778
self._read_and_parse([_HEADER_READV])
464
# really this should just read the prefix
779
466
return self._key_count
781
def _lookup_keys_via_location(self, location_keys):
782
"""Public interface for implementing bisection.
784
If _buffer_all has been called, then all the data for the index is in
785
memory, and this method should not be called, as it uses a separate
786
cache because it cannot pre-resolve all indices, which buffer_all does
789
:param location_keys: A list of location(byte offset), key tuples.
790
:return: A list of (location_key, result) tuples as expected by
791
bzrlib.bisect_multi.bisect_multi_bytes.
793
# Possible improvements:
794
# - only bisect lookup each key once
795
# - sort the keys first, and use that to reduce the bisection window
797
# this progresses in three parts:
800
# attempt to answer the question from the now in memory data.
801
# build the readv request
802
# for each location, ask for 800 bytes - much more than rows we've seen
805
for location, key in location_keys:
806
# can we answer from cache?
807
if self._bisect_nodes and key in self._bisect_nodes:
808
# We have the key parsed.
810
index = self._parsed_key_index(key)
811
if (len(self._parsed_key_map) and
812
self._parsed_key_map[index][0] <= key and
813
(self._parsed_key_map[index][1] >= key or
814
# end of the file has been parsed
815
self._parsed_byte_map[index][1] == self._size)):
816
# the key has been parsed, so no lookup is needed even if its
819
# - if we have examined this part of the file already - yes
820
index = self._parsed_byte_index(location)
821
if (len(self._parsed_byte_map) and
822
self._parsed_byte_map[index][0] <= location and
823
self._parsed_byte_map[index][1] > location):
824
# the byte region has been parsed, so no read is needed.
827
if location + length > self._size:
828
length = self._size - location
829
# todo, trim out parsed locations.
831
readv_ranges.append((location, length))
832
# read the header if needed
833
if self._bisect_nodes is None:
834
readv_ranges.append(_HEADER_READV)
835
self._read_and_parse(readv_ranges)
837
if self._nodes is not None:
838
# _read_and_parse triggered a _buffer_all because we requested the
840
for location, key in location_keys:
841
if key not in self._nodes: # not present
842
result.append(((location, key), False))
843
elif self.node_ref_lists:
844
value, refs = self._nodes[key]
845
result.append(((location, key),
846
(self, key, value, refs)))
848
result.append(((location, key),
849
(self, key, self._nodes[key])))
852
# - figure out <, >, missing, present
853
# - result present references so we can return them.
854
# keys that we cannot answer until we resolve references
855
pending_references = []
856
pending_locations = set()
857
for location, key in location_keys:
858
# can we answer from cache?
859
if key in self._bisect_nodes:
860
# the key has been parsed, so no lookup is needed
861
if self.node_ref_lists:
862
# the references may not have been all parsed.
863
value, refs = self._bisect_nodes[key]
864
wanted_locations = []
865
for ref_list in refs:
867
if ref not in self._keys_by_offset:
868
wanted_locations.append(ref)
870
pending_locations.update(wanted_locations)
871
pending_references.append((location, key))
873
result.append(((location, key), (self, key,
874
value, self._resolve_references(refs))))
876
result.append(((location, key),
877
(self, key, self._bisect_nodes[key])))
880
# has the region the key should be in, been parsed?
881
index = self._parsed_key_index(key)
882
if (self._parsed_key_map[index][0] <= key and
883
(self._parsed_key_map[index][1] >= key or
884
# end of the file has been parsed
885
self._parsed_byte_map[index][1] == self._size)):
886
result.append(((location, key), False))
888
# no, is the key above or below the probed location:
889
# get the range of the probed & parsed location
890
index = self._parsed_byte_index(location)
891
# if the key is below the start of the range, its below
892
if key < self._parsed_key_map[index][0]:
896
result.append(((location, key), direction))
898
# lookup data to resolve references
899
for location in pending_locations:
901
if location + length > self._size:
902
length = self._size - location
903
# TODO: trim out parsed locations (e.g. if the 800 is into the
904
# parsed region trim it, and dont use the adjust_for_latency
907
readv_ranges.append((location, length))
908
self._read_and_parse(readv_ranges)
909
if self._nodes is not None:
910
# The _read_and_parse triggered a _buffer_all, grab the data and
912
for location, key in pending_references:
913
value, refs = self._nodes[key]
914
result.append(((location, key), (self, key, value, refs)))
916
for location, key in pending_references:
917
# answer key references we had to look-up-late.
918
value, refs = self._bisect_nodes[key]
919
result.append(((location, key), (self, key,
920
value, self._resolve_references(refs))))
923
def _parse_header_from_bytes(self, bytes):
924
"""Parse the header from a region of bytes.
926
:param bytes: The data to parse.
927
:return: An offset, data tuple such as readv yields, for the unparsed
928
data. (which may length 0).
930
signature = bytes[0:len(self._signature())]
931
if not signature == self._signature():
932
raise errors.BadIndexFormatSignature(self._name, GraphIndex)
933
lines = bytes[len(self._signature()):].splitlines()
934
options_line = lines[0]
935
if not options_line.startswith(_OPTION_NODE_REFS):
936
raise errors.BadIndexOptions(self)
938
self.node_ref_lists = int(options_line[len(_OPTION_NODE_REFS):])
940
raise errors.BadIndexOptions(self)
941
options_line = lines[1]
942
if not options_line.startswith(_OPTION_KEY_ELEMENTS):
943
raise errors.BadIndexOptions(self)
945
self._key_length = int(options_line[len(_OPTION_KEY_ELEMENTS):])
947
raise errors.BadIndexOptions(self)
948
options_line = lines[2]
949
if not options_line.startswith(_OPTION_LEN):
950
raise errors.BadIndexOptions(self)
952
self._key_count = int(options_line[len(_OPTION_LEN):])
954
raise errors.BadIndexOptions(self)
955
# calculate the bytes we have processed
956
header_end = (len(signature) + len(lines[0]) + len(lines[1]) +
958
self._parsed_bytes(0, None, header_end, None)
959
# setup parsing state
960
self._expected_elements = 3 + self._key_length
961
# raw data keyed by offset
962
self._keys_by_offset = {}
963
# keys with the value and node references
964
self._bisect_nodes = {}
965
return header_end, bytes[header_end:]
967
def _parse_region(self, offset, data):
968
"""Parse node data returned from a readv operation.
970
:param offset: The byte offset the data starts at.
971
:param data: The data to parse.
975
end = offset + len(data)
978
# Trivial test - if the current index's end is within the
979
# low-matching parsed range, we're done.
980
index = self._parsed_byte_index(high_parsed)
981
if end < self._parsed_byte_map[index][1]:
983
# print "[%d:%d]" % (offset, end), \
984
# self._parsed_byte_map[index:index + 2]
985
high_parsed, last_segment = self._parse_segment(
986
offset, data, end, index)
990
def _parse_segment(self, offset, data, end, index):
991
"""Parse one segment of data.
993
:param offset: Where 'data' begins in the file.
994
:param data: Some data to parse a segment of.
995
:param end: Where data ends
996
:param index: The current index into the parsed bytes map.
997
:return: True if the parsed segment is the last possible one in the
999
:return: high_parsed_byte, last_segment.
1000
high_parsed_byte is the location of the highest parsed byte in this
1001
segment, last_segment is True if the parsed segment is the last
1002
possible one in the data block.
1004
# default is to use all data
1006
# accomodate overlap with data before this.
1007
if offset < self._parsed_byte_map[index][1]:
1008
# overlaps the lower parsed region
1009
# skip the parsed data
1010
trim_start = self._parsed_byte_map[index][1] - offset
1011
# don't trim the start for \n
1012
start_adjacent = True
1013
elif offset == self._parsed_byte_map[index][1]:
1014
# abuts the lower parsed region
1017
# do not trim anything
1018
start_adjacent = True
1020
# does not overlap the lower parsed region
1023
# but trim the leading \n
1024
start_adjacent = False
1025
if end == self._size:
1026
# lines up to the end of all data:
1029
# do not strip to the last \n
1032
elif index + 1 == len(self._parsed_byte_map):
1033
# at the end of the parsed data
1036
# but strip to the last \n
1037
end_adjacent = False
1039
elif end == self._parsed_byte_map[index + 1][0]:
1040
# buts up against the next parsed region
1043
# do not strip to the last \n
1046
elif end > self._parsed_byte_map[index + 1][0]:
1047
# overlaps into the next parsed region
1048
# only consider the unparsed data
1049
trim_end = self._parsed_byte_map[index + 1][0] - offset
1050
# do not strip to the last \n as we know its an entire record
1052
last_segment = end < self._parsed_byte_map[index + 1][1]
1054
# does not overlap into the next region
1057
# but strip to the last \n
1058
end_adjacent = False
1060
# now find bytes to discard if needed
1061
if not start_adjacent:
1062
# work around python bug in rfind
1063
if trim_start is None:
1064
trim_start = data.find('\n') + 1
1066
trim_start = data.find('\n', trim_start) + 1
1067
if not (trim_start != 0):
1068
raise AssertionError('no \n was present')
1069
# print 'removing start', offset, trim_start, repr(data[:trim_start])
1070
if not end_adjacent:
1071
# work around python bug in rfind
1072
if trim_end is None:
1073
trim_end = data.rfind('\n') + 1
1075
trim_end = data.rfind('\n', None, trim_end) + 1
1076
if not (trim_end != 0):
1077
raise AssertionError('no \n was present')
1078
# print 'removing end', offset, trim_end, repr(data[trim_end:])
1079
# adjust offset and data to the parseable data.
1080
trimmed_data = data[trim_start:trim_end]
1081
if not (trimmed_data):
1082
raise AssertionError('read unneeded data [%d:%d] from [%d:%d]'
1083
% (trim_start, trim_end, offset, offset + len(data)))
1085
offset += trim_start
1086
# print "parsing", repr(trimmed_data)
1087
# splitlines mangles the \r delimiters.. don't use it.
1088
lines = trimmed_data.split('\n')
1091
first_key, last_key, nodes, _ = self._parse_lines(lines, pos)
1092
for key, value in nodes:
1093
self._bisect_nodes[key] = value
1094
self._parsed_bytes(offset, first_key,
1095
offset + len(trimmed_data), last_key)
1096
return offset + len(trimmed_data), last_segment
1098
def _parse_lines(self, lines, pos):
1105
# must be at the end
1107
if not (self._size == pos + 1):
1108
raise AssertionError("%s %s" % (self._size, pos))
1111
elements = line.split('\0')
1112
if len(elements) != self._expected_elements:
1113
raise errors.BadIndexData(self)
1114
# keys are tuples. Each element is a string that may occur many
1115
# times, so we intern them to save space. AB, RC, 200807
1116
key = tuple([intern(element) for element in elements[:self._key_length]])
1117
if first_key is None:
1119
absent, references, value = elements[-3:]
1121
for ref_string in references.split('\t'):
1122
ref_lists.append(tuple([
1123
int(ref) for ref in ref_string.split('\r') if ref
1125
ref_lists = tuple(ref_lists)
1126
self._keys_by_offset[pos] = (key, absent, ref_lists, value)
1127
pos += len(line) + 1 # +1 for the \n
1130
if self.node_ref_lists:
1131
node_value = (value, ref_lists)
1134
nodes.append((key, node_value))
1135
# print "parsed ", key
1136
return first_key, key, nodes, trailers
1138
def _parsed_bytes(self, start, start_key, end, end_key):
1139
"""Mark the bytes from start to end as parsed.
1141
Calling self._parsed_bytes(1,2) will mark one byte (the one at offset
1144
:param start: The start of the parsed region.
1145
:param end: The end of the parsed region.
1147
index = self._parsed_byte_index(start)
1148
new_value = (start, end)
1149
new_key = (start_key, end_key)
1151
# first range parsed is always the beginning.
1152
self._parsed_byte_map.insert(index, new_value)
1153
self._parsed_key_map.insert(index, new_key)
1157
# extend lower region
1158
# extend higher region
1159
# combine two regions
1160
if (index + 1 < len(self._parsed_byte_map) and
1161
self._parsed_byte_map[index][1] == start and
1162
self._parsed_byte_map[index + 1][0] == end):
1163
# combine two regions
1164
self._parsed_byte_map[index] = (self._parsed_byte_map[index][0],
1165
self._parsed_byte_map[index + 1][1])
1166
self._parsed_key_map[index] = (self._parsed_key_map[index][0],
1167
self._parsed_key_map[index + 1][1])
1168
del self._parsed_byte_map[index + 1]
1169
del self._parsed_key_map[index + 1]
1170
elif self._parsed_byte_map[index][1] == start:
1171
# extend the lower entry
1172
self._parsed_byte_map[index] = (
1173
self._parsed_byte_map[index][0], end)
1174
self._parsed_key_map[index] = (
1175
self._parsed_key_map[index][0], end_key)
1176
elif (index + 1 < len(self._parsed_byte_map) and
1177
self._parsed_byte_map[index + 1][0] == end):
1178
# extend the higher entry
1179
self._parsed_byte_map[index + 1] = (
1180
start, self._parsed_byte_map[index + 1][1])
1181
self._parsed_key_map[index + 1] = (
1182
start_key, self._parsed_key_map[index + 1][1])
1185
self._parsed_byte_map.insert(index + 1, new_value)
1186
self._parsed_key_map.insert(index + 1, new_key)
1188
def _read_and_parse(self, readv_ranges):
1189
"""Read the ranges and parse the resulting data.
1191
:param readv_ranges: A prepared readv range list.
1193
if not readv_ranges:
1195
if self._nodes is None and self._bytes_read * 2 >= self._size:
1196
# We've already read more than 50% of the file and we are about to
1197
# request more data, just _buffer_all() and be done
1201
base_offset = self._base_offset
1202
if base_offset != 0:
1203
# Rewrite the ranges for the offset
1204
readv_ranges = [(start+base_offset, size)
1205
for start, size in readv_ranges]
1206
readv_data = self._transport.readv(self._name, readv_ranges, True,
1207
self._size + self._base_offset)
1209
for offset, data in readv_data:
1210
offset -= base_offset
1211
self._bytes_read += len(data)
1213
# transport.readv() expanded to extra data which isn't part of
1215
data = data[-offset:]
1217
if offset == 0 and len(data) == self._size:
1218
# We read the whole range, most likely because the
1219
# Transport upcast our readv ranges into one long request
1220
# for enough total data to grab the whole index.
1221
self._buffer_all(StringIO(data))
1223
if self._bisect_nodes is None:
1224
# this must be the start
1225
if not (offset == 0):
1226
raise AssertionError()
1227
offset, data = self._parse_header_from_bytes(data)
1228
# print readv_ranges, "[%d:%d]" % (offset, offset + len(data))
1229
self._parse_region(offset, data)
1231
468
def _signature(self):
1232
469
"""The file signature for this index type."""
1233
470
return _SIGNATURE
1392
566
seen_keys = set()
1396
for index in self._indices:
1398
for node in index.iter_entries_prefix(keys):
1399
if node[1] in seen_keys:
1401
seen_keys.add(node[1])
1405
hit_indices.append(index)
1407
except errors.NoSuchFile:
1408
self._reload_or_raise()
1409
self._move_to_front(hit_indices)
1411
def _move_to_front(self, hit_indices):
1412
"""Rearrange self._indices so that hit_indices are first.
1414
Order is maintained as much as possible, e.g. the first unhit index
1415
will be the first index in _indices after the hit_indices, and the
1416
hit_indices will be present in exactly the order they are passed to
1419
_move_to_front propagates to all objects in self._sibling_indices by
1420
calling _move_to_front_by_name.
1422
if self._indices[:len(hit_indices)] == hit_indices:
1423
# The 'hit_indices' are already at the front (and in the same
1424
# order), no need to re-order
1426
hit_names = self._move_to_front_by_index(hit_indices)
1427
for sibling_idx in self._sibling_indices:
1428
sibling_idx._move_to_front_by_name(hit_names)
1430
def _move_to_front_by_index(self, hit_indices):
1431
"""Core logic for _move_to_front.
1433
Returns a list of names corresponding to the hit_indices param.
1435
indices_info = zip(self._index_names, self._indices)
1436
if 'index' in debug.debug_flags:
1437
mutter('CombinedGraphIndex reordering: currently %r, promoting %r',
1438
indices_info, hit_indices)
1441
new_hit_indices = []
1444
for offset, (name, idx) in enumerate(indices_info):
1445
if idx in hit_indices:
1446
hit_names.append(name)
1447
new_hit_indices.append(idx)
1448
if len(new_hit_indices) == len(hit_indices):
1449
# We've found all of the hit entries, everything else is
1451
unhit_names.extend(self._index_names[offset+1:])
1452
unhit_indices.extend(self._indices[offset+1:])
1455
unhit_names.append(name)
1456
unhit_indices.append(idx)
1458
self._indices = new_hit_indices + unhit_indices
1459
self._index_names = hit_names + unhit_names
1460
if 'index' in debug.debug_flags:
1461
mutter('CombinedGraphIndex reordered: %r', self._indices)
1464
def _move_to_front_by_name(self, hit_names):
1465
"""Moves indices named by 'hit_names' to front of the search order, as
1466
described in _move_to_front.
1468
# Translate names to index instances, and then call
1469
# _move_to_front_by_index.
1470
indices_info = zip(self._index_names, self._indices)
1472
for name, idx in indices_info:
1473
if name in hit_names:
1474
hit_indices.append(idx)
1475
self._move_to_front_by_index(hit_indices)
1477
def find_ancestry(self, keys, ref_list_num):
1478
"""Find the complete ancestry for the given set of keys.
1480
Note that this is a whole-ancestry request, so it should be used
1483
:param keys: An iterable of keys to look for
1484
:param ref_list_num: The reference list which references the parents
1486
:return: (parent_map, missing_keys)
1488
# XXX: make this call _move_to_front?
1489
missing_keys = set()
1491
keys_to_lookup = set(keys)
1493
while keys_to_lookup:
1494
# keys that *all* indexes claim are missing, stop searching them
1496
all_index_missing = None
1497
# print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
1498
# print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
1500
# len(missing_keys))
1501
for index_idx, index in enumerate(self._indices):
1502
# TODO: we should probably be doing something with
1503
# 'missing_keys' since we've already determined that
1504
# those revisions have not been found anywhere
1505
index_missing_keys = set()
1506
# Find all of the ancestry we can from this index
1507
# keep looking until the search_keys set is empty, which means
1508
# things we didn't find should be in index_missing_keys
1509
search_keys = keys_to_lookup
1511
# print ' \t%2d\t\t%4d\t%5d\t%5d' % (
1512
# index_idx, len(search_keys),
1513
# len(parent_map), len(index_missing_keys))
1516
# TODO: ref_list_num should really be a parameter, since
1517
# CombinedGraphIndex does not know what the ref lists
1519
search_keys = index._find_ancestors(search_keys,
1520
ref_list_num, parent_map, index_missing_keys)
1521
# print ' \t \t%2d\t%4d\t%5d\t%5d' % (
1522
# sub_generation, len(search_keys),
1523
# len(parent_map), len(index_missing_keys))
1524
# Now set whatever was missing to be searched in the next index
1525
keys_to_lookup = index_missing_keys
1526
if all_index_missing is None:
1527
all_index_missing = set(index_missing_keys)
1529
all_index_missing.intersection_update(index_missing_keys)
1530
if not keys_to_lookup:
1532
if all_index_missing is None:
1533
# There were no indexes, so all search keys are 'missing'
1534
missing_keys.update(keys_to_lookup)
1535
keys_to_lookup = None
1537
missing_keys.update(all_index_missing)
1538
keys_to_lookup.difference_update(all_index_missing)
1539
return parent_map, missing_keys
567
for index in self._indices:
568
for node in index.iter_entries_prefix(keys):
569
if node[1] in seen_keys:
571
seen_keys.add(node[1])
1541
574
def key_count(self):
1542
575
"""Return an estimate of the number of keys in this index.
1544
577
For CombinedGraphIndex this is approximated by the sum of the keys of
1545
578
the child indices. As child indices may have duplicate keys this can
1546
579
have a maximum error of the number of child indices * largest number of
1547
580
keys in any index.
1551
return sum((index.key_count() for index in self._indices), 0)
1552
except errors.NoSuchFile:
1553
self._reload_or_raise()
1555
missing_keys = _missing_keys_from_parent_map
1557
def _reload_or_raise(self):
1558
"""We just got a NoSuchFile exception.
1560
Try to reload the indices, if it fails, just raise the current
1563
if self._reload_func is None:
1565
exc_type, exc_value, exc_traceback = sys.exc_info()
1566
trace.mutter('Trying to reload after getting exception: %s',
1568
if not self._reload_func():
1569
# We tried to reload, but nothing changed, so we fail anyway
1570
trace.mutter('_reload_func indicated nothing has changed.'
1571
' Raising original exception.')
1572
raise exc_type, exc_value, exc_traceback
1574
def set_sibling_indices(self, sibling_combined_graph_indices):
1575
"""Set the CombinedGraphIndex objects to reorder after reordering self.
1577
self._sibling_indices = sibling_combined_graph_indices
582
return sum((index.key_count() for index in self._indices), 0)
1579
584
def validate(self):
1580
585
"""Validate that everything in the index can be accessed."""
1583
for index in self._indices:
1586
except errors.NoSuchFile:
1587
self._reload_or_raise()
586
for index in self._indices:
1590
590
class InMemoryGraphIndex(GraphIndexBuilder):
added
removed
bzrlib/index.py
