126
137
DATA_SUFFIX = '.knit'
127
138
INDEX_SUFFIX = '.kndx'
128
_STREAM_MIN_BUFFER_SIZE = 5*1024*1024
131
class KnitAdapter(object):
132
"""Base class for knit record adaption."""
134
def __init__(self, basis_vf):
135
"""Create an adapter which accesses full texts from basis_vf.
137
:param basis_vf: A versioned file to access basis texts of deltas from.
138
May be None for adapters that do not need to access basis texts.
140
self._data = KnitVersionedFiles(None, None)
141
self._annotate_factory = KnitAnnotateFactory()
142
self._plain_factory = KnitPlainFactory()
143
self._basis_vf = basis_vf
146
class FTAnnotatedToUnannotated(KnitAdapter):
147
"""An adapter from FT annotated knits to unannotated ones."""
149
def get_bytes(self, factory):
150
annotated_compressed_bytes = factory._raw_record
152
self._data._parse_record_unchecked(annotated_compressed_bytes)
153
content = self._annotate_factory.parse_fulltext(contents, rec[1])
154
size, bytes = self._data._record_to_data((rec[1],), rec[3], content.text())
158
class DeltaAnnotatedToUnannotated(KnitAdapter):
159
"""An adapter for deltas from annotated to unannotated."""
161
def get_bytes(self, factory):
162
annotated_compressed_bytes = factory._raw_record
164
self._data._parse_record_unchecked(annotated_compressed_bytes)
165
delta = self._annotate_factory.parse_line_delta(contents, rec[1],
167
contents = self._plain_factory.lower_line_delta(delta)
168
size, bytes = self._data._record_to_data((rec[1],), rec[3], contents)
172
class FTAnnotatedToFullText(KnitAdapter):
173
"""An adapter from FT annotated knits to unannotated ones."""
175
def get_bytes(self, factory):
176
annotated_compressed_bytes = factory._raw_record
178
self._data._parse_record_unchecked(annotated_compressed_bytes)
179
content, delta = self._annotate_factory.parse_record(factory.key[-1],
180
contents, factory._build_details, None)
181
return ''.join(content.text())
184
class DeltaAnnotatedToFullText(KnitAdapter):
185
"""An adapter for deltas from annotated to unannotated."""
187
def get_bytes(self, factory):
188
annotated_compressed_bytes = factory._raw_record
190
self._data._parse_record_unchecked(annotated_compressed_bytes)
191
delta = self._annotate_factory.parse_line_delta(contents, rec[1],
193
compression_parent = factory.parents[0]
194
basis_entry = self._basis_vf.get_record_stream(
195
[compression_parent], 'unordered', True).next()
196
if basis_entry.storage_kind == 'absent':
197
raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
198
basis_chunks = basis_entry.get_bytes_as('chunked')
199
basis_lines = osutils.chunks_to_lines(basis_chunks)
200
# Manually apply the delta because we have one annotated content and
202
basis_content = PlainKnitContent(basis_lines, compression_parent)
203
basis_content.apply_delta(delta, rec[1])
204
basis_content._should_strip_eol = factory._build_details[1]
205
return ''.join(basis_content.text())
208
class FTPlainToFullText(KnitAdapter):
209
"""An adapter from FT plain knits to unannotated ones."""
211
def get_bytes(self, factory):
212
compressed_bytes = factory._raw_record
214
self._data._parse_record_unchecked(compressed_bytes)
215
content, delta = self._plain_factory.parse_record(factory.key[-1],
216
contents, factory._build_details, None)
217
return ''.join(content.text())
220
class DeltaPlainToFullText(KnitAdapter):
221
"""An adapter for deltas from annotated to unannotated."""
223
def get_bytes(self, factory):
224
compressed_bytes = factory._raw_record
226
self._data._parse_record_unchecked(compressed_bytes)
227
delta = self._plain_factory.parse_line_delta(contents, rec[1])
228
compression_parent = factory.parents[0]
229
# XXX: string splitting overhead.
230
basis_entry = self._basis_vf.get_record_stream(
231
[compression_parent], 'unordered', True).next()
232
if basis_entry.storage_kind == 'absent':
233
raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
234
basis_chunks = basis_entry.get_bytes_as('chunked')
235
basis_lines = osutils.chunks_to_lines(basis_chunks)
236
basis_content = PlainKnitContent(basis_lines, compression_parent)
237
# Manually apply the delta because we have one annotated content and
239
content, _ = self._plain_factory.parse_record(rec[1], contents,
240
factory._build_details, basis_content)
241
return ''.join(content.text())
244
class KnitContentFactory(ContentFactory):
245
"""Content factory for streaming from knits.
247
:seealso ContentFactory:
250
def __init__(self, key, parents, build_details, sha1, raw_record,
251
annotated, knit=None, network_bytes=None):
252
"""Create a KnitContentFactory for key.
255
:param parents: The parents.
256
:param build_details: The build details as returned from
258
:param sha1: The sha1 expected from the full text of this object.
259
:param raw_record: The bytes of the knit data from disk.
260
:param annotated: True if the raw data is annotated.
261
:param network_bytes: None to calculate the network bytes on demand,
262
not-none if they are already known.
264
ContentFactory.__init__(self)
267
self.parents = parents
268
if build_details[0] == 'line-delta':
273
annotated_kind = 'annotated-'
276
self.storage_kind = 'knit-%s%s-gz' % (annotated_kind, kind)
277
self._raw_record = raw_record
278
self._network_bytes = network_bytes
279
self._build_details = build_details
282
def _create_network_bytes(self):
283
"""Create a fully serialised network version for transmission."""
284
# storage_kind, key, parents, Noeol, raw_record
285
key_bytes = '\x00'.join(self.key)
286
if self.parents is None:
287
parent_bytes = 'None:'
289
parent_bytes = '\t'.join('\x00'.join(key) for key in self.parents)
290
if self._build_details[1]:
294
network_bytes = "%s\n%s\n%s\n%s%s" % (self.storage_kind, key_bytes,
295
parent_bytes, noeol, self._raw_record)
296
self._network_bytes = network_bytes
298
def get_bytes_as(self, storage_kind):
299
if storage_kind == self.storage_kind:
300
if self._network_bytes is None:
301
self._create_network_bytes()
302
return self._network_bytes
303
if ('-ft-' in self.storage_kind and
304
storage_kind in ('chunked', 'fulltext')):
305
adapter_key = (self.storage_kind, 'fulltext')
306
adapter_factory = adapter_registry.get(adapter_key)
307
adapter = adapter_factory(None)
308
bytes = adapter.get_bytes(self)
309
if storage_kind == 'chunked':
313
if self._knit is not None:
314
# Not redundant with direct conversion above - that only handles
316
if storage_kind == 'chunked':
317
return self._knit.get_lines(self.key[0])
318
elif storage_kind == 'fulltext':
319
return self._knit.get_text(self.key[0])
320
raise errors.UnavailableRepresentation(self.key, storage_kind,
324
class LazyKnitContentFactory(ContentFactory):
325
"""A ContentFactory which can either generate full text or a wire form.
327
:seealso ContentFactory:
330
def __init__(self, key, parents, generator, first):
331
"""Create a LazyKnitContentFactory.
333
:param key: The key of the record.
334
:param parents: The parents of the record.
335
:param generator: A _ContentMapGenerator containing the record for this
337
:param first: Is this the first content object returned from generator?
338
if it is, its storage kind is knit-delta-closure, otherwise it is
339
knit-delta-closure-ref
342
self.parents = parents
344
self._generator = generator
345
self.storage_kind = "knit-delta-closure"
347
self.storage_kind = self.storage_kind + "-ref"
350
def get_bytes_as(self, storage_kind):
351
if storage_kind == self.storage_kind:
353
return self._generator._wire_bytes()
355
# all the keys etc are contained in the bytes returned in the
358
if storage_kind in ('chunked', 'fulltext'):
359
chunks = self._generator._get_one_work(self.key).text()
360
if storage_kind == 'chunked':
363
return ''.join(chunks)
364
raise errors.UnavailableRepresentation(self.key, storage_kind,
368
def knit_delta_closure_to_records(storage_kind, bytes, line_end):
369
"""Convert a network record to a iterator over stream records.
371
:param storage_kind: The storage kind of the record.
372
Must be 'knit-delta-closure'.
373
:param bytes: The bytes of the record on the network.
375
generator = _NetworkContentMapGenerator(bytes, line_end)
376
return generator.get_record_stream()
379
def knit_network_to_record(storage_kind, bytes, line_end):
380
"""Convert a network record to a record object.
382
:param storage_kind: The storage kind of the record.
383
:param bytes: The bytes of the record on the network.
386
line_end = bytes.find('\n', start)
387
key = tuple(bytes[start:line_end].split('\x00'))
389
line_end = bytes.find('\n', start)
390
parent_line = bytes[start:line_end]
391
if parent_line == 'None:':
395
[tuple(segment.split('\x00')) for segment in parent_line.split('\t')
398
noeol = bytes[start] == 'N'
399
if 'ft' in storage_kind:
402
method = 'line-delta'
403
build_details = (method, noeol)
405
raw_record = bytes[start:]
406
annotated = 'annotated' in storage_kind
407
return [KnitContentFactory(key, parents, build_details, None, raw_record,
408
annotated, network_bytes=bytes)]
411
141
class KnitContent(object):
412
"""Content of a knit version to which deltas can be applied.
414
This is always stored in memory as a list of lines with \\n at the end,
415
plus a flag saying if the final ending is really there or not, because that
416
corresponds to the on-disk knit representation.
142
"""Content of a knit version to which deltas can be applied."""
419
144
def __init__(self):
420
145
self._should_strip_eol = False
755
484
out.extend(lines)
758
def annotate(self, knit, key):
487
def annotate(self, knit, version_id):
759
488
annotator = _KnitAnnotator(knit)
760
return annotator.annotate_flat(key)
764
def make_file_factory(annotated, mapper):
765
"""Create a factory for creating a file based KnitVersionedFiles.
767
This is only functional enough to run interface tests, it doesn't try to
768
provide a full pack environment.
770
:param annotated: knit annotations are wanted.
771
:param mapper: The mapper from keys to paths.
773
def factory(transport):
774
index = _KndxIndex(transport, mapper, lambda:None, lambda:True, lambda:True)
775
access = _KnitKeyAccess(transport, mapper)
776
return KnitVersionedFiles(index, access, annotated=annotated)
780
def make_pack_factory(graph, delta, keylength):
781
"""Create a factory for creating a pack based VersionedFiles.
783
This is only functional enough to run interface tests, it doesn't try to
784
provide a full pack environment.
786
:param graph: Store a graph.
787
:param delta: Delta compress contents.
788
:param keylength: How long should keys be.
790
def factory(transport):
791
parents = graph or delta
797
max_delta_chain = 200
800
graph_index = _mod_index.InMemoryGraphIndex(reference_lists=ref_length,
801
key_elements=keylength)
802
stream = transport.open_write_stream('newpack')
803
writer = pack.ContainerWriter(stream.write)
805
index = _KnitGraphIndex(graph_index, lambda:True, parents=parents,
806
deltas=delta, add_callback=graph_index.add_nodes)
807
access = pack_repo._DirectPackAccess({})
808
access.set_writer(writer, graph_index, (transport, 'newpack'))
809
result = KnitVersionedFiles(index, access,
810
max_delta_chain=max_delta_chain)
811
result.stream = stream
812
result.writer = writer
817
def cleanup_pack_knit(versioned_files):
818
versioned_files.stream.close()
819
versioned_files.writer.end()
822
def _get_total_build_size(self, keys, positions):
823
"""Determine the total bytes to build these keys.
825
(helper function because _KnitGraphIndex and _KndxIndex work the same, but
826
don't inherit from a common base.)
828
:param keys: Keys that we want to build
829
:param positions: dict of {key, (info, index_memo, comp_parent)} (such
830
as returned by _get_components_positions)
831
:return: Number of bytes to build those keys
833
all_build_index_memos = {}
837
for key in build_keys:
838
# This is mostly for the 'stacked' case
839
# Where we will be getting the data from a fallback
840
if key not in positions:
842
_, index_memo, compression_parent = positions[key]
843
all_build_index_memos[key] = index_memo
844
if compression_parent not in all_build_index_memos:
845
next_keys.add(compression_parent)
846
build_keys = next_keys
847
return sum([index_memo[2] for index_memo
848
in all_build_index_memos.itervalues()])
851
class KnitVersionedFiles(VersionedFilesWithFallbacks):
852
"""Storage for many versioned files using knit compression.
854
Backend storage is managed by indices and data objects.
856
:ivar _index: A _KnitGraphIndex or similar that can describe the
857
parents, graph, compression and data location of entries in this
858
KnitVersionedFiles. Note that this is only the index for
859
*this* vfs; if there are fallbacks they must be queried separately.
862
def __init__(self, index, data_access, max_delta_chain=200,
863
annotated=False, reload_func=None):
864
"""Create a KnitVersionedFiles with index and data_access.
866
:param index: The index for the knit data.
867
:param data_access: The access object to store and retrieve knit
869
:param max_delta_chain: The maximum number of deltas to permit during
870
insertion. Set to 0 to prohibit the use of deltas.
871
:param annotated: Set to True to cause annotations to be calculated and
872
stored during insertion.
873
:param reload_func: An function that can be called if we think we need
874
to reload the pack listing and try again. See
875
'bzrlib.repofmt.pack_repo.AggregateIndex' for the signature.
489
return annotator.annotate(version_id)
492
def make_empty_knit(transport, relpath):
493
"""Construct a empty knit at the specified location."""
494
k = make_file_knit(transport, relpath, 'w', KnitPlainFactory)
497
def make_file_knit(name, transport, file_mode=None, access_mode='w',
498
factory=None, delta=True, create=False, create_parent_dir=False,
499
delay_create=False, dir_mode=None, get_scope=None):
500
"""Factory to create a KnitVersionedFile for a .knit/.kndx file pair."""
502
factory = KnitAnnotateFactory()
504
factory = KnitPlainFactory()
505
if get_scope is None:
506
get_scope = lambda:None
507
index = _KnitIndex(transport, name + INDEX_SUFFIX,
508
access_mode, create=create, file_mode=file_mode,
509
create_parent_dir=create_parent_dir, delay_create=delay_create,
510
dir_mode=dir_mode, get_scope=get_scope)
511
access = _KnitAccess(transport, name + DATA_SUFFIX, file_mode,
512
dir_mode, ((create and not len(index)) and delay_create),
514
return KnitVersionedFile(name, transport, factory=factory,
515
create=create, delay_create=delay_create, index=index,
516
access_method=access)
520
"""Return the suffixes used by file based knits."""
521
return [DATA_SUFFIX, INDEX_SUFFIX]
522
make_file_knit.get_suffixes = get_suffixes
525
class KnitVersionedFile(VersionedFile):
526
"""Weave-like structure with faster random access.
528
A knit stores a number of texts and a summary of the relationships
529
between them. Texts are identified by a string version-id. Texts
530
are normally stored and retrieved as a series of lines, but can
531
also be passed as single strings.
533
Lines are stored with the trailing newline (if any) included, to
534
avoid special cases for files with no final newline. Lines are
535
composed of 8-bit characters, not unicode. The combination of
536
these approaches should mean any 'binary' file can be safely
537
stored and retrieved.
540
def __init__(self, relpath, transport, file_mode=None,
541
factory=None, delta=True, create=False, create_parent_dir=False,
542
delay_create=False, dir_mode=None, index=None, access_method=None):
543
"""Construct a knit at location specified by relpath.
545
:param create: If not True, only open an existing knit.
546
:param create_parent_dir: If True, create the parent directory if
547
creating the file fails. (This is used for stores with
548
hash-prefixes that may not exist yet)
549
:param delay_create: The calling code is aware that the knit won't
550
actually be created until the first data is stored.
551
:param index: An index to use for the knit.
553
super(KnitVersionedFile, self).__init__()
554
self.transport = transport
555
self.filename = relpath
556
self.factory = factory or KnitAnnotateFactory()
559
self._max_delta_chain = 200
561
if None in (access_method, index):
562
raise ValueError("No default access_method or index any more")
877
563
self._index = index
878
self._access = data_access
879
self._max_delta_chain = max_delta_chain
881
self._factory = KnitAnnotateFactory()
883
self._factory = KnitPlainFactory()
884
self._immediate_fallback_vfs = []
885
self._reload_func = reload_func
564
_access = access_method
565
if create and not len(self) and not delay_create:
567
self._data = _KnitData(_access)
887
569
def __repr__(self):
888
return "%s(%r, %r)" % (
889
self.__class__.__name__,
893
def without_fallbacks(self):
894
"""Return a clone of this object without any fallbacks configured."""
895
return KnitVersionedFiles(self._index, self._access,
896
self._max_delta_chain, self._factory.annotated,
899
def add_fallback_versioned_files(self, a_versioned_files):
900
"""Add a source of texts for texts not present in this knit.
902
:param a_versioned_files: A VersionedFiles object.
904
self._immediate_fallback_vfs.append(a_versioned_files)
906
def add_lines(self, key, parents, lines, parent_texts=None,
907
left_matching_blocks=None, nostore_sha=None, random_id=False,
909
"""See VersionedFiles.add_lines()."""
910
self._index._check_write_ok()
911
self._check_add(key, lines, random_id, check_content)
913
# The caller might pass None if there is no graph data, but kndx
914
# indexes can't directly store that, so we give them
915
# an empty tuple instead.
917
line_bytes = ''.join(lines)
918
return self._add(key, lines, parents,
919
parent_texts, left_matching_blocks, nostore_sha, random_id,
920
line_bytes=line_bytes)
922
def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
923
"""See VersionedFiles._add_text()."""
924
self._index._check_write_ok()
925
self._check_add(key, None, random_id, check_content=False)
926
if text.__class__ is not str:
927
raise errors.BzrBadParameterUnicode("text")
929
# The caller might pass None if there is no graph data, but kndx
930
# indexes can't directly store that, so we give them
931
# an empty tuple instead.
933
return self._add(key, None, parents,
934
None, None, nostore_sha, random_id,
937
def _add(self, key, lines, parents, parent_texts,
938
left_matching_blocks, nostore_sha, random_id,
940
"""Add a set of lines on top of version specified by parents.
942
Any versions not present will be converted into ghosts.
944
:param lines: A list of strings where each one is a single line (has a
945
single newline at the end of the string) This is now optional
946
(callers can pass None). It is left in its location for backwards
947
compatibility. It should ''.join(lines) must == line_bytes
948
:param line_bytes: A single string containing the content
950
We pass both lines and line_bytes because different routes bring the
951
values to this function. And for memory efficiency, we don't want to
952
have to split/join on-demand.
954
# first thing, if the content is something we don't need to store, find
956
digest = sha_string(line_bytes)
957
if nostore_sha == digest:
958
raise errors.ExistingContent
961
if parent_texts is None:
963
# Do a single query to ascertain parent presence; we only compress
964
# against parents in the same kvf.
965
present_parent_map = self._index.get_parent_map(parents)
966
for parent in parents:
967
if parent in present_parent_map:
968
present_parents.append(parent)
970
# Currently we can only compress against the left most present parent.
971
if (len(present_parents) == 0 or
972
present_parents[0] != parents[0]):
975
# To speed the extract of texts the delta chain is limited
976
# to a fixed number of deltas. This should minimize both
977
# I/O and the time spend applying deltas.
978
delta = self._check_should_delta(present_parents[0])
980
text_length = len(line_bytes)
983
# Note: line_bytes is not modified to add a newline, that is tracked
984
# via the no_eol flag. 'lines' *is* modified, because that is the
985
# general values needed by the Content code.
986
if line_bytes and line_bytes[-1] != '\n':
987
options.append('no-eol')
989
# Copy the existing list, or create a new one
991
lines = osutils.split_lines(line_bytes)
994
# Replace the last line with one that ends in a final newline
995
lines[-1] = lines[-1] + '\n'
997
lines = osutils.split_lines(line_bytes)
999
for element in key[:-1]:
1000
if type(element) is not str:
1001
raise TypeError("key contains non-strings: %r" % (key,))
1003
key = key[:-1] + ('sha1:' + digest,)
1004
elif type(key[-1]) is not str:
1005
raise TypeError("key contains non-strings: %r" % (key,))
1006
# Knit hunks are still last-element only
1007
version_id = key[-1]
1008
content = self._factory.make(lines, version_id)
1010
# Hint to the content object that its text() call should strip the
1012
content._should_strip_eol = True
1013
if delta or (self._factory.annotated and len(present_parents) > 0):
1014
# Merge annotations from parent texts if needed.
1015
delta_hunks = self._merge_annotations(content, present_parents,
1016
parent_texts, delta, self._factory.annotated,
1017
left_matching_blocks)
1020
options.append('line-delta')
1021
store_lines = self._factory.lower_line_delta(delta_hunks)
1022
size, bytes = self._record_to_data(key, digest,
1025
options.append('fulltext')
1026
# isinstance is slower and we have no hierarchy.
1027
if self._factory.__class__ is KnitPlainFactory:
1028
# Use the already joined bytes saving iteration time in
1030
dense_lines = [line_bytes]
1032
dense_lines.append('\n')
1033
size, bytes = self._record_to_data(key, digest,
1036
# get mixed annotation + content and feed it into the
1038
store_lines = self._factory.lower_fulltext(content)
1039
size, bytes = self._record_to_data(key, digest,
1042
access_memo = self._access.add_raw_records([(key, size)], bytes)[0]
1043
self._index.add_records(
1044
((key, options, access_memo, parents),),
1045
random_id=random_id)
1046
return digest, text_length, content
1048
def annotate(self, key):
1049
"""See VersionedFiles.annotate."""
1050
return self._factory.annotate(self, key)
1052
def get_annotator(self):
1053
return _KnitAnnotator(self)
1055
def check(self, progress_bar=None, keys=None):
1056
"""See VersionedFiles.check()."""
1058
return self._logical_check()
1060
# At the moment, check does not extra work over get_record_stream
1061
return self.get_record_stream(keys, 'unordered', True)
1063
def _logical_check(self):
1064
# This doesn't actually test extraction of everything, but that will
1065
# impact 'bzr check' substantially, and needs to be integrated with
1066
# care. However, it does check for the obvious problem of a delta with
1068
keys = self._index.keys()
1069
parent_map = self.get_parent_map(keys)
1071
if self._index.get_method(key) != 'fulltext':
1072
compression_parent = parent_map[key][0]
1073
if compression_parent not in parent_map:
1074
raise errors.KnitCorrupt(self,
1075
"Missing basis parent %s for %s" % (
1076
compression_parent, key))
1077
for fallback_vfs in self._immediate_fallback_vfs:
1078
fallback_vfs.check()
1080
def _check_add(self, key, lines, random_id, check_content):
1081
"""check that version_id and lines are safe to add."""
1082
version_id = key[-1]
1083
if version_id is not None:
1084
if contains_whitespace(version_id):
1085
raise InvalidRevisionId(version_id, self)
1086
self.check_not_reserved_id(version_id)
1087
# TODO: If random_id==False and the key is already present, we should
1088
# probably check that the existing content is identical to what is
1089
# being inserted, and otherwise raise an exception. This would make
1090
# the bundle code simpler.
1092
self._check_lines_not_unicode(lines)
1093
self._check_lines_are_lines(lines)
1095
def _check_header(self, key, line):
1096
rec = self._split_header(line)
1097
self._check_header_version(rec, key[-1])
1100
def _check_header_version(self, rec, version_id):
1101
"""Checks the header version on original format knit records.
1103
These have the last component of the key embedded in the record.
1105
if rec[1] != version_id:
1106
raise KnitCorrupt(self,
1107
'unexpected version, wanted %r, got %r' % (version_id, rec[1]))
1109
def _check_should_delta(self, parent):
570
return '%s(%s)' % (self.__class__.__name__,
571
self.transport.abspath(self.filename))
573
def _check_should_delta(self, first_parents):
1110
574
"""Iterate back through the parent listing, looking for a fulltext.
1112
576
This is used when we want to decide whether to add a delta or a new
1121
585
fulltext_size = None
586
delta_parents = first_parents
1122
587
for count in xrange(self._max_delta_chain):
1124
# Note that this only looks in the index of this particular
1125
# KnitVersionedFiles, not in the fallbacks. This ensures that
1126
# we won't store a delta spanning physical repository
1128
build_details = self._index.get_build_details([parent])
1129
parent_details = build_details[parent]
1130
except (RevisionNotPresent, KeyError), e:
1131
# Some basis is not locally present: always fulltext
1133
index_memo, compression_parent, _, _ = parent_details
1134
_, _, size = index_memo
1135
if compression_parent is None:
588
parent = delta_parents[0]
589
method = self._index.get_method(parent)
590
index, pos, size = self._index.get_position(parent)
591
if method == 'fulltext':
1136
592
fulltext_size = size
1138
594
delta_size += size
1139
# We don't explicitly check for presence because this is in an
1140
# inner loop, and if it's missing it'll fail anyhow.
1141
parent = compression_parent
595
delta_parents = self._index.get_parent_map([parent])[parent]
1143
597
# We couldn't find a fulltext, so we must create a new one
1145
# Simple heuristic - if the total I/O wold be greater as a delta than
1146
# the originally installed fulltext, we create a new fulltext.
1147
600
return fulltext_size > delta_size
1149
def _build_details_to_components(self, build_details):
1150
"""Convert a build_details tuple to a position tuple."""
1151
# record_details, access_memo, compression_parent
1152
return build_details[3], build_details[0], build_details[1]
1154
def _get_components_positions(self, keys, allow_missing=False):
1155
"""Produce a map of position data for the components of keys.
1157
This data is intended to be used for retrieving the knit records.
1159
A dict of key to (record_details, index_memo, next, parents) is
1162
* method is the way referenced data should be applied.
1163
* index_memo is the handle to pass to the data access to actually get
1165
* next is the build-parent of the version, or None for fulltexts.
1166
* parents is the version_ids of the parents of this version
1168
:param allow_missing: If True do not raise an error on a missing
1169
component, just ignore it.
1172
pending_components = keys
1173
while pending_components:
1174
build_details = self._index.get_build_details(pending_components)
1175
current_components = set(pending_components)
1176
pending_components = set()
1177
for key, details in build_details.iteritems():
1178
(index_memo, compression_parent, parents,
1179
record_details) = details
1180
method = record_details[0]
1181
if compression_parent is not None:
1182
pending_components.add(compression_parent)
1183
component_data[key] = self._build_details_to_components(details)
1184
missing = current_components.difference(build_details)
1185
if missing and not allow_missing:
1186
raise errors.RevisionNotPresent(missing.pop(), self)
1187
return component_data
1189
def _get_content(self, key, parent_texts={}):
1190
"""Returns a content object that makes up the specified
1192
cached_version = parent_texts.get(key, None)
1193
if cached_version is not None:
1194
# Ensure the cache dict is valid.
1195
if not self.get_parent_map([key]):
1196
raise RevisionNotPresent(key, self)
1197
return cached_version
1198
generator = _VFContentMapGenerator(self, [key])
1199
return generator._get_content(key)
1201
def get_parent_map(self, keys):
1202
"""Get a map of the graph parents of keys.
1204
:param keys: The keys to look up parents for.
1205
:return: A mapping from keys to parents. Absent keys are absent from
1208
return self._get_parent_map_with_sources(keys)[0]
1210
def _get_parent_map_with_sources(self, keys):
1211
"""Get a map of the parents of keys.
1213
:param keys: The keys to look up parents for.
1214
:return: A tuple. The first element is a mapping from keys to parents.
1215
Absent keys are absent from the mapping. The second element is a
1216
list with the locations each key was found in. The first element
1217
is the in-this-knit parents, the second the first fallback source,
1221
sources = [self._index] + self._immediate_fallback_vfs
1224
for source in sources:
1227
new_result = source.get_parent_map(missing)
1228
source_results.append(new_result)
1229
result.update(new_result)
1230
missing.difference_update(set(new_result))
1231
return result, source_results
1233
def _get_record_map(self, keys, allow_missing=False):
1234
"""Produce a dictionary of knit records.
1236
:return: {key:(record, record_details, digest, next)}
1238
* record: data returned from read_records (a KnitContentobject)
1239
* record_details: opaque information to pass to parse_record
1240
* digest: SHA1 digest of the full text after all steps are done
1241
* next: build-parent of the version, i.e. the leftmost ancestor.
1242
Will be None if the record is not a delta.
1244
:param keys: The keys to build a map for
1245
:param allow_missing: If some records are missing, rather than
1246
error, just return the data that could be generated.
1248
raw_map = self._get_record_map_unparsed(keys,
1249
allow_missing=allow_missing)
1250
return self._raw_map_to_record_map(raw_map)
1252
def _raw_map_to_record_map(self, raw_map):
1253
"""Parse the contents of _get_record_map_unparsed.
1255
:return: see _get_record_map.
1259
data, record_details, next = raw_map[key]
1260
content, digest = self._parse_record(key[-1], data)
1261
result[key] = content, record_details, digest, next
1264
def _get_record_map_unparsed(self, keys, allow_missing=False):
1265
"""Get the raw data for reconstructing keys without parsing it.
1267
:return: A dict suitable for parsing via _raw_map_to_record_map.
1268
key-> raw_bytes, (method, noeol), compression_parent
1270
# This retries the whole request if anything fails. Potentially we
1271
# could be a bit more selective. We could track the keys whose records
1272
# we have successfully found, and then only request the new records
1273
# from there. However, _get_components_positions grabs the whole build
1274
# chain, which means we'll likely try to grab the same records again
1275
# anyway. Also, can the build chains change as part of a pack
1276
# operation? We wouldn't want to end up with a broken chain.
1279
position_map = self._get_components_positions(keys,
1280
allow_missing=allow_missing)
1281
# key = component_id, r = record_details, i_m = index_memo,
1283
records = [(key, i_m) for key, (r, i_m, n)
1284
in position_map.iteritems()]
1285
# Sort by the index memo, so that we request records from the
1286
# same pack file together, and in forward-sorted order
1287
records.sort(key=operator.itemgetter(1))
1289
for key, data in self._read_records_iter_unchecked(records):
1290
(record_details, index_memo, next) = position_map[key]
1291
raw_record_map[key] = data, record_details, next
1292
return raw_record_map
1293
except errors.RetryWithNewPacks, e:
1294
self._access.reload_or_raise(e)
1297
def _split_by_prefix(cls, keys):
1298
"""For the given keys, split them up based on their prefix.
1300
To keep memory pressure somewhat under control, split the
1301
requests back into per-file-id requests, otherwise "bzr co"
1302
extracts the full tree into memory before writing it to disk.
1303
This should be revisited if _get_content_maps() can ever cross
1306
The keys for a given file_id are kept in the same relative order.
1307
Ordering between file_ids is not, though prefix_order will return the
1308
order that the key was first seen.
1310
:param keys: An iterable of key tuples
1311
:return: (split_map, prefix_order)
1312
split_map A dictionary mapping prefix => keys
1313
prefix_order The order that we saw the various prefixes
1315
split_by_prefix = {}
1323
if prefix in split_by_prefix:
1324
split_by_prefix[prefix].append(key)
1326
split_by_prefix[prefix] = [key]
1327
prefix_order.append(prefix)
1328
return split_by_prefix, prefix_order
1330
def _group_keys_for_io(self, keys, non_local_keys, positions,
1331
_min_buffer_size=_STREAM_MIN_BUFFER_SIZE):
1332
"""For the given keys, group them into 'best-sized' requests.
1334
The idea is to avoid making 1 request per file, but to never try to
1335
unpack an entire 1.5GB source tree in a single pass. Also when
1336
possible, we should try to group requests to the same pack file
1339
:return: list of (keys, non_local) tuples that indicate what keys
1340
should be fetched next.
1342
# TODO: Ideally we would group on 2 factors. We want to extract texts
1343
# from the same pack file together, and we want to extract all
1344
# the texts for a given build-chain together. Ultimately it
1345
# probably needs a better global view.
1346
total_keys = len(keys)
1347
prefix_split_keys, prefix_order = self._split_by_prefix(keys)
1348
prefix_split_non_local_keys, _ = self._split_by_prefix(non_local_keys)
1350
cur_non_local = set()
1354
for prefix in prefix_order:
1355
keys = prefix_split_keys[prefix]
1356
non_local = prefix_split_non_local_keys.get(prefix, [])
1358
this_size = self._index._get_total_build_size(keys, positions)
1359
cur_size += this_size
1360
cur_keys.extend(keys)
1361
cur_non_local.update(non_local)
1362
if cur_size > _min_buffer_size:
1363
result.append((cur_keys, cur_non_local))
1364
sizes.append(cur_size)
1366
cur_non_local = set()
1369
result.append((cur_keys, cur_non_local))
1370
sizes.append(cur_size)
1373
def get_record_stream(self, keys, ordering, include_delta_closure):
1374
"""Get a stream of records for keys.
1376
:param keys: The keys to include.
1377
:param ordering: Either 'unordered' or 'topological'. A topologically
1378
sorted stream has compression parents strictly before their
1380
:param include_delta_closure: If True then the closure across any
1381
compression parents will be included (in the opaque data).
1382
:return: An iterator of ContentFactory objects, each of which is only
1383
valid until the iterator is advanced.
1385
# keys might be a generator
602
def _check_write_ok(self):
603
return self._index._check_write_ok()
605
def _add_raw_records(self, records, data):
606
"""Add all the records 'records' with data pre-joined in 'data'.
608
:param records: A list of tuples(version_id, options, parents, size).
609
:param data: The data for the records. When it is written, the records
610
are adjusted to have pos pointing into data by the sum of
611
the preceding records sizes.
614
raw_record_sizes = [record[3] for record in records]
615
positions = self._data.add_raw_records(raw_record_sizes, data)
618
for (version_id, options, parents, size), access_memo in zip(
620
index_entries.append((version_id, options, access_memo, parents))
622
self._index.add_versions(index_entries)
624
def copy_to(self, name, transport):
625
"""See VersionedFile.copy_to()."""
626
# copy the current index to a temp index to avoid racing with local
628
transport.put_file_non_atomic(name + INDEX_SUFFIX + '.tmp',
629
self.transport.get(self._index._filename))
631
f = self._data._open_file()
633
transport.put_file(name + DATA_SUFFIX, f)
636
# move the copied index into place
637
transport.move(name + INDEX_SUFFIX + '.tmp', name + INDEX_SUFFIX)
639
def get_data_stream(self, required_versions):
640
"""Get a data stream for the specified versions.
642
Versions may be returned in any order, not necessarily the order
643
specified. They are returned in a partial order by compression
644
parent, so that the deltas can be applied as the data stream is
645
inserted; however note that compression parents will not be sent
646
unless they were specifically requested, as the client may already
649
:param required_versions: The exact set of versions to be extracted.
650
Unlike some other knit methods, this is not used to generate a
651
transitive closure, rather it is used precisely as given.
653
:returns: format_signature, list of (version, options, length, parents),
656
required_version_set = frozenset(required_versions)
658
# list of revisions that can just be sent without waiting for their
661
# map from revision to the children based on it
663
# first, read all relevant index data, enough to sort into the right
665
for version_id in required_versions:
666
options = self._index.get_options(version_id)
667
parents = self._index.get_parents_with_ghosts(version_id)
668
index_memo = self._index.get_position(version_id)
669
version_index[version_id] = (index_memo, options, parents)
670
if ('line-delta' in options
671
and parents[0] in required_version_set):
672
# must wait until the parent has been sent
673
deferred.setdefault(parents[0], []). \
676
# either a fulltext, or a delta whose parent the client did
677
# not ask for and presumably already has
678
ready_to_send.append(version_id)
679
# build a list of results to return, plus instructions for data to
681
copy_queue_records = []
682
temp_version_list = []
684
# XXX: pushing and popping lists may be a bit inefficient
685
version_id = ready_to_send.pop(0)
686
(index_memo, options, parents) = version_index[version_id]
687
copy_queue_records.append((version_id, index_memo))
688
none, data_pos, data_size = index_memo
689
temp_version_list.append((version_id, options, data_size,
691
if version_id in deferred:
692
# now we can send all the children of this revision - we could
693
# put them in anywhere, but we hope that sending them soon
694
# after the fulltext will give good locality in the receiver
695
ready_to_send[:0] = deferred.pop(version_id)
696
assert len(deferred) == 0, \
697
"Still have compressed child versions waiting to be sent"
698
# XXX: The stream format is such that we cannot stream it - we have to
699
# know the length of all the data a-priori.
701
result_version_list = []
702
for (version_id, raw_data), \
703
(version_id2, options, _, parents) in \
704
izip(self._data.read_records_iter_raw(copy_queue_records),
706
assert version_id == version_id2, \
707
'logic error, inconsistent results'
708
raw_datum.append(raw_data)
709
result_version_list.append(
710
(version_id, options, len(raw_data), parents))
711
# provide a callback to get data incrementally.
712
pseudo_file = StringIO(''.join(raw_datum))
715
return pseudo_file.read()
717
return pseudo_file.read(length)
718
return (self.get_format_signature(), result_version_list, read)
720
def _extract_blocks(self, version_id, source, target):
721
if self._index.get_method(version_id) != 'line-delta':
723
parent, sha1, noeol, delta = self.get_delta(version_id)
724
return KnitContent.get_line_delta_blocks(delta, source, target)
726
def get_delta(self, version_id):
727
"""Get a delta for constructing version from some other version."""
728
self.check_not_reserved_id(version_id)
729
parents = self.get_parent_map([version_id])[version_id]
734
index_memo = self._index.get_position(version_id)
735
data, sha1 = self._data.read_records(((version_id, index_memo),))[version_id]
736
noeol = 'no-eol' in self._index.get_options(version_id)
737
if 'fulltext' == self._index.get_method(version_id):
738
new_content = self.factory.parse_fulltext(data, version_id)
739
if parent is not None:
740
reference_content = self._get_content(parent)
741
old_texts = reference_content.text()
744
new_texts = new_content.text()
745
delta_seq = patiencediff.PatienceSequenceMatcher(None, old_texts,
747
return parent, sha1, noeol, self._make_line_delta(delta_seq, new_content)
749
delta = self.factory.parse_line_delta(data, version_id)
750
return parent, sha1, noeol, delta
752
def get_format_signature(self):
753
"""See VersionedFile.get_format_signature()."""
754
if self.factory.annotated:
755
annotated_part = "annotated"
757
annotated_part = "plain"
758
return "knit-%s" % (annotated_part,)
760
@deprecated_method(one_four)
761
def get_graph_with_ghosts(self):
762
"""See VersionedFile.get_graph_with_ghosts()."""
763
return self.get_parent_map(self.versions())
765
def get_sha1s(self, version_ids):
766
"""See VersionedFile.get_sha1s()."""
767
record_map = self._get_record_map(version_ids)
768
# record entry 2 is the 'digest'.
769
return [record_map[v][2] for v in version_ids]
771
@deprecated_method(one_four)
772
def has_ghost(self, version_id):
773
"""True if there is a ghost reference in the file to version_id."""
775
if self.has_version(version_id):
777
# optimisable if needed by memoising the _ghosts set.
778
items = self.get_parent_map(self.versions())
779
for parents in items.itervalues():
780
for parent in parents:
781
if parent == version_id and parent not in items:
785
def insert_data_stream(self, (format, data_list, reader_callable)):
786
"""Insert knit records from a data stream into this knit.
788
If a version in the stream is already present in this knit, it will not
789
be inserted a second time. It will be checked for consistency with the
790
stored version however, and may cause a KnitCorrupt error to be raised
791
if the data in the stream disagrees with the already stored data.
793
:seealso: get_data_stream
795
if format != self.get_format_signature():
796
if 'knit' in debug.debug_flags:
798
'incompatible format signature inserting to %r', self)
799
source = self._knit_from_datastream(
800
(format, data_list, reader_callable))
1389
if not self._index.has_graph:
1390
# Cannot sort when no graph has been stored.
1391
ordering = 'unordered'
1393
remaining_keys = keys
1396
keys = set(remaining_keys)
1397
for content_factory in self._get_remaining_record_stream(keys,
1398
ordering, include_delta_closure):
1399
remaining_keys.discard(content_factory.key)
1400
yield content_factory
1402
except errors.RetryWithNewPacks, e:
1403
self._access.reload_or_raise(e)
1405
def _get_remaining_record_stream(self, keys, ordering,
1406
include_delta_closure):
1407
"""This function is the 'retry' portion for get_record_stream."""
1408
if include_delta_closure:
1409
positions = self._get_components_positions(keys, allow_missing=True)
1411
build_details = self._index.get_build_details(keys)
1413
# (record_details, access_memo, compression_parent_key)
1414
positions = dict((key, self._build_details_to_components(details))
1415
for key, details in build_details.iteritems())
1416
absent_keys = keys.difference(set(positions))
1417
# There may be more absent keys : if we're missing the basis component
1418
# and are trying to include the delta closure.
1419
# XXX: We should not ever need to examine remote sources because we do
1420
# not permit deltas across versioned files boundaries.
1421
if include_delta_closure:
1422
needed_from_fallback = set()
1423
# Build up reconstructable_keys dict. key:True in this dict means
1424
# the key can be reconstructed.
1425
reconstructable_keys = {}
1429
chain = [key, positions[key][2]]
1431
needed_from_fallback.add(key)
1434
while chain[-1] is not None:
1435
if chain[-1] in reconstructable_keys:
1436
result = reconstructable_keys[chain[-1]]
1440
chain.append(positions[chain[-1]][2])
1442
# missing basis component
1443
needed_from_fallback.add(chain[-1])
1446
for chain_key in chain[:-1]:
1447
reconstructable_keys[chain_key] = result
1449
needed_from_fallback.add(key)
1450
# Double index lookups here : need a unified api ?
1451
global_map, parent_maps = self._get_parent_map_with_sources(keys)
1452
if ordering in ('topological', 'groupcompress'):
1453
if ordering == 'topological':
1454
# Global topological sort
1455
present_keys = tsort.topo_sort(global_map)
1457
present_keys = sort_groupcompress(global_map)
1458
# Now group by source:
1460
current_source = None
1461
for key in present_keys:
1462
for parent_map in parent_maps:
1463
if key in parent_map:
1464
key_source = parent_map
1466
if current_source is not key_source:
1467
source_keys.append((key_source, []))
1468
current_source = key_source
1469
source_keys[-1][1].append(key)
1471
if ordering != 'unordered':
1472
raise AssertionError('valid values for ordering are:'
1473
' "unordered", "groupcompress" or "topological" not: %r'
1475
# Just group by source; remote sources first.
1478
for parent_map in reversed(parent_maps):
1479
source_keys.append((parent_map, []))
1480
for key in parent_map:
1481
present_keys.append(key)
1482
source_keys[-1][1].append(key)
1483
# We have been requested to return these records in an order that
1484
# suits us. So we ask the index to give us an optimally sorted
1486
for source, sub_keys in source_keys:
1487
if source is parent_maps[0]:
1488
# Only sort the keys for this VF
1489
self._index._sort_keys_by_io(sub_keys, positions)
1490
absent_keys = keys - set(global_map)
1491
for key in absent_keys:
1492
yield AbsentContentFactory(key)
1493
# restrict our view to the keys we can answer.
1494
# XXX: Memory: TODO: batch data here to cap buffered data at (say) 1MB.
1495
# XXX: At that point we need to consider the impact of double reads by
1496
# utilising components multiple times.
1497
if include_delta_closure:
1498
# XXX: get_content_maps performs its own index queries; allow state
1500
non_local_keys = needed_from_fallback - absent_keys
1501
for keys, non_local_keys in self._group_keys_for_io(present_keys,
1504
generator = _VFContentMapGenerator(self, keys, non_local_keys,
1507
for record in generator.get_record_stream():
1510
for source, keys in source_keys:
1511
if source is parent_maps[0]:
1512
# this KnitVersionedFiles
1513
records = [(key, positions[key][1]) for key in keys]
1514
for key, raw_data in self._read_records_iter_unchecked(records):
1515
(record_details, index_memo, _) = positions[key]
1516
yield KnitContentFactory(key, global_map[key],
1517
record_details, None, raw_data, self._factory.annotated, None)
1519
vf = self._immediate_fallback_vfs[parent_maps.index(source) - 1]
1520
for record in vf.get_record_stream(keys, ordering,
1521
include_delta_closure):
1524
def get_sha1s(self, keys):
1525
"""See VersionedFiles.get_sha1s()."""
1527
record_map = self._get_record_map(missing, allow_missing=True)
1529
for key, details in record_map.iteritems():
1530
if key not in missing:
1532
# record entry 2 is the 'digest'.
1533
result[key] = details[2]
1534
missing.difference_update(set(result))
1535
for source in self._immediate_fallback_vfs:
1538
new_result = source.get_sha1s(missing)
1539
result.update(new_result)
1540
missing.difference_update(set(new_result))
1543
def insert_record_stream(self, stream):
1544
"""Insert a record stream into this container.
1546
:param stream: A stream of records to insert.
1548
:seealso VersionedFiles.get_record_stream:
1550
def get_adapter(adapter_key):
1552
return adapters[adapter_key]
1554
adapter_factory = adapter_registry.get(adapter_key)
1555
adapter = adapter_factory(self)
1556
adapters[adapter_key] = adapter
1559
if self._factory.annotated:
1560
# self is annotated, we need annotated knits to use directly.
1561
annotated = "annotated-"
1564
# self is not annotated, but we can strip annotations cheaply.
1566
convertibles = set(["knit-annotated-ft-gz"])
1567
if self._max_delta_chain:
1568
delta_types.add("knit-annotated-delta-gz")
1569
convertibles.add("knit-annotated-delta-gz")
1570
# The set of types we can cheaply adapt without needing basis texts.
1571
native_types = set()
1572
if self._max_delta_chain:
1573
native_types.add("knit-%sdelta-gz" % annotated)
1574
delta_types.add("knit-%sdelta-gz" % annotated)
1575
native_types.add("knit-%sft-gz" % annotated)
1576
knit_types = native_types.union(convertibles)
1578
# Buffer all index entries that we can't add immediately because their
1579
# basis parent is missing. We don't buffer all because generating
1580
# annotations may require access to some of the new records. However we
1581
# can't generate annotations from new deltas until their basis parent
1582
# is present anyway, so we get away with not needing an index that
1583
# includes the new keys.
1585
# See <http://launchpad.net/bugs/300177> about ordering of compression
1586
# parents in the records - to be conservative, we insist that all
1587
# parents must be present to avoid expanding to a fulltext.
1589
# key = basis_parent, value = index entry to add
1590
buffered_index_entries = {}
1591
for record in stream:
1592
kind = record.storage_kind
1593
if kind.startswith('knit-') and kind.endswith('-gz'):
1594
# Check that the ID in the header of the raw knit bytes matches
1595
# the record metadata.
1596
raw_data = record._raw_record
1597
df, rec = self._parse_record_header(record.key, raw_data)
1600
parents = record.parents
1601
if record.storage_kind in delta_types:
1602
# TODO: eventually the record itself should track
1603
# compression_parent
1604
compression_parent = parents[0]
1606
compression_parent = None
1607
# Raise an error when a record is missing.
1608
if record.storage_kind == 'absent':
1609
raise RevisionNotPresent([record.key], self)
1610
elif ((record.storage_kind in knit_types)
1611
and (compression_parent is None
1612
or not self._immediate_fallback_vfs
1613
or self._index.has_key(compression_parent)
1614
or not self.has_key(compression_parent))):
1615
# we can insert the knit record literally if either it has no
1616
# compression parent OR we already have its basis in this kvf
1617
# OR the basis is not present even in the fallbacks. In the
1618
# last case it will either turn up later in the stream and all
1619
# will be well, or it won't turn up at all and we'll raise an
1622
# TODO: self.has_key is somewhat redundant with
1623
# self._index.has_key; we really want something that directly
1624
# asks if it's only present in the fallbacks. -- mbp 20081119
1625
if record.storage_kind not in native_types:
1627
adapter_key = (record.storage_kind, "knit-delta-gz")
1628
adapter = get_adapter(adapter_key)
1630
adapter_key = (record.storage_kind, "knit-ft-gz")
1631
adapter = get_adapter(adapter_key)
1632
bytes = adapter.get_bytes(record)
1634
# It's a knit record, it has a _raw_record field (even if
1635
# it was reconstituted from a network stream).
1636
bytes = record._raw_record
1637
options = [record._build_details[0]]
1638
if record._build_details[1]:
1639
options.append('no-eol')
1640
# Just blat it across.
1641
# Note: This does end up adding data on duplicate keys. As
1642
# modern repositories use atomic insertions this should not
1643
# lead to excessive growth in the event of interrupted fetches.
1644
# 'knit' repositories may suffer excessive growth, but as a
1645
# deprecated format this is tolerable. It can be fixed if
1646
# needed by in the kndx index support raising on a duplicate
1647
# add with identical parents and options.
1648
access_memo = self._access.add_raw_records(
1649
[(record.key, len(bytes))], bytes)[0]
1650
index_entry = (record.key, options, access_memo, parents)
1651
if 'fulltext' not in options:
1652
# Not a fulltext, so we need to make sure the compression
1653
# parent will also be present.
1654
# Note that pack backed knits don't need to buffer here
1655
# because they buffer all writes to the transaction level,
1656
# but we don't expose that difference at the index level. If
1657
# the query here has sufficient cost to show up in
1658
# profiling we should do that.
804
for version_id, options, length, parents in data_list:
805
if self.has_version(version_id):
806
# First check: the list of parents.
807
my_parents = self.get_parents_with_ghosts(version_id)
808
if tuple(my_parents) != tuple(parents):
809
# XXX: KnitCorrupt is not quite the right exception here.
812
'parents list %r from data stream does not match '
813
'already recorded parents %r for %s'
814
% (parents, my_parents, version_id))
816
# Also check the SHA-1 of the fulltext this content will
818
raw_data = reader_callable(length)
819
my_fulltext_sha1 = self.get_sha1s([version_id])[0]
820
df, rec = self._data._parse_record_header(version_id, raw_data)
821
stream_fulltext_sha1 = rec[3]
822
if my_fulltext_sha1 != stream_fulltext_sha1:
823
# Actually, we don't know if it's this knit that's corrupt,
824
# or the data stream we're trying to insert.
826
self.filename, 'sha-1 does not match %s' % version_id)
828
if 'line-delta' in options:
829
# Make sure that this knit record is actually useful: a
830
# line-delta is no use unless we have its parent.
831
# Fetching from a broken repository with this problem
832
# shouldn't break the target repository.
1660
# They're required to be physically in this
1661
# KnitVersionedFiles, not in a fallback.
1662
if not self._index.has_key(compression_parent):
1663
pending = buffered_index_entries.setdefault(
1664
compression_parent, [])
1665
pending.append(index_entry)
1668
self._index.add_records([index_entry])
1669
elif record.storage_kind == 'chunked':
1670
self.add_lines(record.key, parents,
1671
osutils.chunks_to_lines(record.get_bytes_as('chunked')))
1673
# Not suitable for direct insertion as a
1674
# delta, either because it's not the right format, or this
1675
# KnitVersionedFiles doesn't permit deltas (_max_delta_chain ==
1676
# 0) or because it depends on a base only present in the
1678
self._access.flush()
1680
# Try getting a fulltext directly from the record.
1681
bytes = record.get_bytes_as('fulltext')
1682
except errors.UnavailableRepresentation:
1683
adapter_key = record.storage_kind, 'fulltext'
1684
adapter = get_adapter(adapter_key)
1685
bytes = adapter.get_bytes(record)
1686
lines = split_lines(bytes)
1688
self.add_lines(record.key, parents, lines)
1689
except errors.RevisionAlreadyPresent:
1691
# Add any records whose basis parent is now available.
1693
added_keys = [record.key]
1695
key = added_keys.pop(0)
1696
if key in buffered_index_entries:
1697
index_entries = buffered_index_entries[key]
1698
self._index.add_records(index_entries)
1700
[index_entry[0] for index_entry in index_entries])
1701
del buffered_index_entries[key]
1702
if buffered_index_entries:
1703
# There were index entries buffered at the end of the stream,
1704
# So these need to be added (if the index supports holding such
1705
# entries for later insertion)
1707
for key in buffered_index_entries:
1708
index_entries = buffered_index_entries[key]
1709
all_entries.extend(index_entries)
1710
self._index.add_records(
1711
all_entries, missing_compression_parents=True)
1713
def get_missing_compression_parent_keys(self):
1714
"""Return an iterable of keys of missing compression parents.
1716
Check this after calling insert_record_stream to find out if there are
1717
any missing compression parents. If there are, the records that
1718
depend on them are not able to be inserted safely. For atomic
1719
KnitVersionedFiles built on packs, the transaction should be aborted or
1720
suspended - commit will fail at this point. Nonatomic knits will error
1721
earlier because they have no staging area to put pending entries into.
1723
return self._index.get_missing_compression_parents()
1725
def iter_lines_added_or_present_in_keys(self, keys, pb=None):
1726
"""Iterate over the lines in the versioned files from keys.
1728
This may return lines from other keys. Each item the returned
1729
iterator yields is a tuple of a line and a text version that that line
1730
is present in (not introduced in).
1732
Ordering of results is in whatever order is most suitable for the
1733
underlying storage format.
1735
If a progress bar is supplied, it may be used to indicate progress.
1736
The caller is responsible for cleaning up progress bars (because this
1740
* Lines are normalised by the underlying store: they will all have \\n
1742
* Lines are returned in arbitrary order.
1743
* If a requested key did not change any lines (or didn't have any
1744
lines), it may not be mentioned at all in the result.
1746
:param pb: Progress bar supplied by caller.
1747
:return: An iterator over (line, key).
1750
pb = ui.ui_factory.nested_progress_bar()
1756
# we don't care about inclusions, the caller cares.
1757
# but we need to setup a list of records to visit.
1758
# we need key, position, length
1760
build_details = self._index.get_build_details(keys)
1761
for key, details in build_details.iteritems():
1763
key_records.append((key, details[0]))
1764
records_iter = enumerate(self._read_records_iter(key_records))
1765
for (key_idx, (key, data, sha_value)) in records_iter:
1766
pb.update(gettext('Walking content'), key_idx, total)
1767
compression_parent = build_details[key][1]
1768
if compression_parent is None:
1770
line_iterator = self._factory.get_fulltext_content(data)
1773
line_iterator = self._factory.get_linedelta_content(data)
1774
# Now that we are yielding the data for this key, remove it
1777
# XXX: It might be more efficient to yield (key,
1778
# line_iterator) in the future. However for now, this is a
1779
# simpler change to integrate into the rest of the
1780
# codebase. RBC 20071110
1781
for line in line_iterator:
1784
except errors.RetryWithNewPacks, e:
1785
self._access.reload_or_raise(e)
1786
# If there are still keys we've not yet found, we look in the fallback
1787
# vfs, and hope to find them there. Note that if the keys are found
1788
# but had no changes or no content, the fallback may not return
1790
if keys and not self._immediate_fallback_vfs:
1791
# XXX: strictly the second parameter is meant to be the file id
1792
# but it's not easily accessible here.
1793
raise RevisionNotPresent(keys, repr(self))
1794
for source in self._immediate_fallback_vfs:
1798
for line, key in source.iter_lines_added_or_present_in_keys(keys):
1799
source_keys.add(key)
1801
keys.difference_update(source_keys)
1802
pb.update(gettext('Walking content'), total, total)
1804
def _make_line_delta(self, delta_seq, new_content):
1805
"""Generate a line delta from delta_seq and new_content."""
1807
for op in delta_seq.get_opcodes():
1808
if op[0] == 'equal':
1810
diff_hunks.append((op[1], op[2], op[4]-op[3], new_content._lines[op[3]:op[4]]))
834
# See https://bugs.launchpad.net/bzr/+bug/164443
835
if not self._index.has_version(parents[0]):
838
'line-delta from stream '
841
'missing parent %s\n'
842
'Try running "bzr check" '
843
'on the source repository, and "bzr reconcile" '
845
(version_id, parents[0]))
847
# We received a line-delta record for a non-delta knit.
848
# Convert it to a fulltext.
849
gzip_bytes = reader_callable(length)
850
self._convert_line_delta_to_fulltext(
851
gzip_bytes, version_id, parents)
854
self._add_raw_records(
855
[(version_id, options, parents, length)],
856
reader_callable(length))
858
def _convert_line_delta_to_fulltext(self, gzip_bytes, version_id, parents):
859
lines, sha1 = self._data._parse_record(version_id, gzip_bytes)
860
delta = self.factory.parse_line_delta(lines, version_id)
861
content = self.factory.make(self.get_lines(parents[0]), parents[0])
862
content.apply_delta(delta, version_id)
863
digest, len, content = self.add_lines(
864
version_id, parents, content.text())
866
raise errors.VersionedFileInvalidChecksum(version_id)
868
def _knit_from_datastream(self, (format, data_list, reader_callable)):
869
"""Create a knit object from a data stream.
871
This method exists to allow conversion of data streams that do not
872
match the signature of this knit. Generally it will be slower and use
873
more memory to use this method to insert data, but it will work.
875
:seealso: get_data_stream for details on datastreams.
876
:return: A knit versioned file which can be used to join the datastream
879
if format == "knit-plain":
880
factory = KnitPlainFactory()
881
elif format == "knit-annotated":
882
factory = KnitAnnotateFactory()
884
raise errors.KnitDataStreamUnknown(format)
885
index = _StreamIndex(data_list, self._index)
886
access = _StreamAccess(reader_callable, index, self, factory)
887
return KnitVersionedFile(self.filename, self.transport,
888
factory=factory, index=index, access_method=access)
891
"""See VersionedFile.versions."""
892
if 'evil' in debug.debug_flags:
893
trace.mutter_callsite(2, "versions scales with size of history")
894
return self._index.get_versions()
896
def has_version(self, version_id):
897
"""See VersionedFile.has_version."""
898
if 'evil' in debug.debug_flags:
899
trace.mutter_callsite(2, "has_version is a LBYL scenario")
900
return self._index.has_version(version_id)
902
__contains__ = has_version
1813
904
def _merge_annotations(self, content, parents, parent_texts={},
1814
905
delta=None, annotated=None,
1815
906
left_matching_blocks=None):
1816
"""Merge annotations for content and generate deltas.
1818
This is done by comparing the annotations based on changes to the text
1819
and generating a delta on the resulting full texts. If annotations are
1820
not being created then a simple delta is created.
907
"""Merge annotations for content. This is done by comparing
908
the annotations based on changed to the text.
1822
910
if left_matching_blocks is not None:
1823
911
delta_seq = diff._PrematchedMatcher(left_matching_blocks)
1825
913
delta_seq = None
1827
for parent_key in parents:
1828
merge_content = self._get_content(parent_key, parent_texts)
1829
if (parent_key == parents[0] and delta_seq is not None):
915
for parent_id in parents:
916
merge_content = self._get_content(parent_id, parent_texts)
917
if (parent_id == parents[0] and delta_seq is not None):
1832
920
seq = patiencediff.PatienceSequenceMatcher(
1855
935
None, old_texts, new_texts)
1856
936
return self._make_line_delta(delta_seq, content)
1858
def _parse_record(self, version_id, data):
1859
"""Parse an original format knit record.
1861
These have the last element of the key only present in the stored data.
1863
rec, record_contents = self._parse_record_unchecked(data)
1864
self._check_header_version(rec, version_id)
1865
return record_contents, rec[3]
1867
def _parse_record_header(self, key, raw_data):
1868
"""Parse a record header for consistency.
1870
:return: the header and the decompressor stream.
1871
as (stream, header_record)
1873
df = gzip.GzipFile(mode='rb', fileobj=StringIO(raw_data))
1876
rec = self._check_header(key, df.readline())
1877
except Exception, e:
1878
raise KnitCorrupt(self,
1879
"While reading {%s} got %s(%s)"
1880
% (key, e.__class__.__name__, str(e)))
1883
def _parse_record_unchecked(self, data):
1885
# 4168 calls in 2880 217 internal
1886
# 4168 calls to _parse_record_header in 2121
1887
# 4168 calls to readlines in 330
1888
df = gzip.GzipFile(mode='rb', fileobj=StringIO(data))
1890
record_contents = df.readlines()
1891
except Exception, e:
1892
raise KnitCorrupt(self, "Corrupt compressed record %r, got %s(%s)" %
1893
(data, e.__class__.__name__, str(e)))
1894
header = record_contents.pop(0)
1895
rec = self._split_header(header)
1896
last_line = record_contents.pop()
1897
if len(record_contents) != int(rec[2]):
1898
raise KnitCorrupt(self,
1899
'incorrect number of lines %s != %s'
1900
' for version {%s} %s'
1901
% (len(record_contents), int(rec[2]),
1902
rec[1], record_contents))
1903
if last_line != 'end %s\n' % rec[1]:
1904
raise KnitCorrupt(self,
1905
'unexpected version end line %r, wanted %r'
1906
% (last_line, rec[1]))
1908
return rec, record_contents
1910
def _read_records_iter(self, records):
1911
"""Read text records from data file and yield result.
1913
The result will be returned in whatever is the fastest to read.
1914
Not by the order requested. Also, multiple requests for the same
1915
record will only yield 1 response.
1917
:param records: A list of (key, access_memo) entries
1918
:return: Yields (key, contents, digest) in the order
1919
read, not the order requested
1924
# XXX: This smells wrong, IO may not be getting ordered right.
1925
needed_records = sorted(set(records), key=operator.itemgetter(1))
1926
if not needed_records:
1929
# The transport optimizes the fetching as well
1930
# (ie, reads continuous ranges.)
1931
raw_data = self._access.get_raw_records(
1932
[index_memo for key, index_memo in needed_records])
1934
for (key, index_memo), data in \
1935
izip(iter(needed_records), raw_data):
1936
content, digest = self._parse_record(key[-1], data)
1937
yield key, content, digest
1939
def _read_records_iter_raw(self, records):
1940
"""Read text records from data file and yield raw data.
1942
This unpacks enough of the text record to validate the id is
1943
as expected but thats all.
1945
Each item the iterator yields is (key, bytes,
1946
expected_sha1_of_full_text).
1948
for key, data in self._read_records_iter_unchecked(records):
1949
# validate the header (note that we can only use the suffix in
1950
# current knit records).
1951
df, rec = self._parse_record_header(key, data)
1953
yield key, data, rec[3]
1955
def _read_records_iter_unchecked(self, records):
1956
"""Read text records from data file and yield raw data.
1958
No validation is done.
1960
Yields tuples of (key, data).
1962
# setup an iterator of the external records:
1963
# uses readv so nice and fast we hope.
1965
# grab the disk data needed.
1966
needed_offsets = [index_memo for key, index_memo
1968
raw_records = self._access.get_raw_records(needed_offsets)
1970
for key, index_memo in records:
1971
data = raw_records.next()
1974
def _record_to_data(self, key, digest, lines, dense_lines=None):
1975
"""Convert key, digest, lines into a raw data block.
1977
:param key: The key of the record. Currently keys are always serialised
1978
using just the trailing component.
1979
:param dense_lines: The bytes of lines but in a denser form. For
1980
instance, if lines is a list of 1000 bytestrings each ending in
1981
\\n, dense_lines may be a list with one line in it, containing all
1982
the 1000's lines and their \\n's. Using dense_lines if it is
1983
already known is a win because the string join to create bytes in
1984
this function spends less time resizing the final string.
1985
:return: (len, a StringIO instance with the raw data ready to read.)
1987
chunks = ["version %s %d %s\n" % (key[-1], len(lines), digest)]
1988
chunks.extend(dense_lines or lines)
1989
chunks.append("end %s\n" % key[-1])
1990
for chunk in chunks:
1991
if type(chunk) is not str:
1992
raise AssertionError(
1993
'data must be plain bytes was %s' % type(chunk))
1994
if lines and lines[-1][-1] != '\n':
1995
raise ValueError('corrupt lines value %r' % lines)
1996
compressed_bytes = tuned_gzip.chunks_to_gzip(chunks)
1997
return len(compressed_bytes), compressed_bytes
1999
def _split_header(self, line):
2002
raise KnitCorrupt(self,
2003
'unexpected number of elements in record header')
2007
"""See VersionedFiles.keys."""
2008
if 'evil' in debug.debug_flags:
2009
trace.mutter_callsite(2, "keys scales with size of history")
2010
sources = [self._index] + self._immediate_fallback_vfs
2012
for source in sources:
2013
result.update(source.keys())
2017
class _ContentMapGenerator(object):
2018
"""Generate texts or expose raw deltas for a set of texts."""
2020
def __init__(self, ordering='unordered'):
2021
self._ordering = ordering
2023
def _get_content(self, key):
2024
"""Get the content object for key."""
2025
# Note that _get_content is only called when the _ContentMapGenerator
2026
# has been constructed with just one key requested for reconstruction.
2027
if key in self.nonlocal_keys:
2028
record = self.get_record_stream().next()
2029
# Create a content object on the fly
2030
lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
2031
return PlainKnitContent(lines, record.key)
938
def _make_line_delta(self, delta_seq, new_content):
939
"""Generate a line delta from delta_seq and new_content."""
941
for op in delta_seq.get_opcodes():
944
diff_hunks.append((op[1], op[2], op[4]-op[3], new_content._lines[op[3]:op[4]]))
947
def _get_components_positions(self, version_ids):
948
"""Produce a map of position data for the components of versions.
950
This data is intended to be used for retrieving the knit records.
952
A dict of version_id to (record_details, index_memo, next, parents) is
954
method is the way referenced data should be applied.
955
index_memo is the handle to pass to the data access to actually get the
957
next is the build-parent of the version, or None for fulltexts.
958
parents is the version_ids of the parents of this version
961
pending_components = version_ids
962
while pending_components:
963
build_details = self._index.get_build_details(pending_components)
964
current_components = set(pending_components)
965
pending_components = set()
966
for version_id, details in build_details.iteritems():
967
(index_memo, compression_parent, parents,
968
record_details) = details
969
method = record_details[0]
970
if compression_parent is not None:
971
pending_components.add(compression_parent)
972
component_data[version_id] = (record_details, index_memo,
974
missing = current_components.difference(build_details)
976
raise errors.RevisionNotPresent(missing.pop(), self.filename)
977
return component_data
979
def _get_content(self, version_id, parent_texts={}):
980
"""Returns a content object that makes up the specified
982
cached_version = parent_texts.get(version_id, None)
983
if cached_version is not None:
984
if not self.has_version(version_id):
985
raise RevisionNotPresent(version_id, self.filename)
986
return cached_version
988
text_map, contents_map = self._get_content_maps([version_id])
989
return contents_map[version_id]
991
def _check_versions_present(self, version_ids):
992
"""Check that all specified versions are present."""
993
self._index.check_versions_present(version_ids)
995
def _add_lines_with_ghosts(self, version_id, parents, lines, parent_texts,
996
nostore_sha, random_id, check_content, left_matching_blocks):
997
"""See VersionedFile.add_lines_with_ghosts()."""
998
self._check_add(version_id, lines, random_id, check_content)
999
return self._add(version_id, lines, parents, self.delta,
1000
parent_texts, left_matching_blocks, nostore_sha, random_id)
1002
def _add_lines(self, version_id, parents, lines, parent_texts,
1003
left_matching_blocks, nostore_sha, random_id, check_content):
1004
"""See VersionedFile.add_lines."""
1005
self._check_add(version_id, lines, random_id, check_content)
1006
self._check_versions_present(parents)
1007
return self._add(version_id, lines[:], parents, self.delta,
1008
parent_texts, left_matching_blocks, nostore_sha, random_id)
1010
def _check_add(self, version_id, lines, random_id, check_content):
1011
"""check that version_id and lines are safe to add."""
1012
if contains_whitespace(version_id):
1013
raise InvalidRevisionId(version_id, self.filename)
1014
self.check_not_reserved_id(version_id)
1015
# Technically this could be avoided if we are happy to allow duplicate
1016
# id insertion when other things than bzr core insert texts, but it
1017
# seems useful for folk using the knit api directly to have some safety
1018
# blanket that we can disable.
1019
if not random_id and self.has_version(version_id):
1020
raise RevisionAlreadyPresent(version_id, self.filename)
1022
self._check_lines_not_unicode(lines)
1023
self._check_lines_are_lines(lines)
1025
def _add(self, version_id, lines, parents, delta, parent_texts,
1026
left_matching_blocks, nostore_sha, random_id):
1027
"""Add a set of lines on top of version specified by parents.
1029
If delta is true, compress the text as a line-delta against
1032
Any versions not present will be converted into ghosts.
1034
# first thing, if the content is something we don't need to store, find
1036
line_bytes = ''.join(lines)
1037
digest = sha_string(line_bytes)
1038
if nostore_sha == digest:
1039
raise errors.ExistingContent
1041
present_parents = []
1042
if parent_texts is None:
1044
for parent in parents:
1045
if self.has_version(parent):
1046
present_parents.append(parent)
1048
# can only compress against the left most present parent.
1050
(len(present_parents) == 0 or
1051
present_parents[0] != parents[0])):
1054
text_length = len(line_bytes)
1057
if lines[-1][-1] != '\n':
1058
# copy the contents of lines.
1060
options.append('no-eol')
1061
lines[-1] = lines[-1] + '\n'
1065
# To speed the extract of texts the delta chain is limited
1066
# to a fixed number of deltas. This should minimize both
1067
# I/O and the time spend applying deltas.
1068
delta = self._check_should_delta(present_parents)
1070
assert isinstance(version_id, str)
1071
content = self.factory.make(lines, version_id)
1072
if delta or (self.factory.annotated and len(present_parents) > 0):
1073
# Merge annotations from parent texts if needed.
1074
delta_hunks = self._merge_annotations(content, present_parents,
1075
parent_texts, delta, self.factory.annotated,
1076
left_matching_blocks)
1079
options.append('line-delta')
1080
store_lines = self.factory.lower_line_delta(delta_hunks)
1081
size, bytes = self._data._record_to_data(version_id, digest,
2033
# local keys we can ask for directly
2034
return self._get_one_work(key)
2036
def get_record_stream(self):
2037
"""Get a record stream for the keys requested during __init__."""
2038
for record in self._work():
2042
"""Produce maps of text and KnitContents as dicts.
1084
options.append('fulltext')
1085
# isinstance is slower and we have no hierarchy.
1086
if self.factory.__class__ == KnitPlainFactory:
1087
# Use the already joined bytes saving iteration time in
1089
size, bytes = self._data._record_to_data(version_id, digest,
1090
lines, [line_bytes])
1092
# get mixed annotation + content and feed it into the
1094
store_lines = self.factory.lower_fulltext(content)
1095
size, bytes = self._data._record_to_data(version_id, digest,
1098
access_memo = self._data.add_raw_records([size], bytes)[0]
1099
self._index.add_versions(
1100
((version_id, options, access_memo, parents),),
1101
random_id=random_id)
1102
return digest, text_length, content
1104
def check(self, progress_bar=None):
1105
"""See VersionedFile.check()."""
1107
def get_lines(self, version_id):
1108
"""See VersionedFile.get_lines()."""
1109
return self.get_line_list([version_id])[0]
1111
def _get_record_map(self, version_ids):
1112
"""Produce a dictionary of knit records.
1114
:return: {version_id:(record, record_details, digest, next)}
1116
data returned from read_records
1118
opaque information to pass to parse_record
1120
SHA1 digest of the full text after all steps are done
1122
build-parent of the version, i.e. the leftmost ancestor.
1123
Will be None if the record is not a delta.
1125
position_map = self._get_components_positions(version_ids)
1126
# c = component_id, r = record_details, i_m = index_memo, n = next
1127
records = [(c, i_m) for c, (r, i_m, n)
1128
in position_map.iteritems()]
1130
for component_id, record, digest in \
1131
self._data.read_records_iter(records):
1132
(record_details, index_memo, next) = position_map[component_id]
1133
record_map[component_id] = record, record_details, digest, next
1137
def get_text(self, version_id):
1138
"""See VersionedFile.get_text"""
1139
return self.get_texts([version_id])[0]
1141
def get_texts(self, version_ids):
1142
return [''.join(l) for l in self.get_line_list(version_ids)]
1144
def get_line_list(self, version_ids):
1145
"""Return the texts of listed versions as a list of strings."""
1146
for version_id in version_ids:
1147
self.check_not_reserved_id(version_id)
1148
text_map, content_map = self._get_content_maps(version_ids)
1149
return [text_map[v] for v in version_ids]
1151
_get_lf_split_line_list = get_line_list
1153
def _get_content_maps(self, version_ids):
1154
"""Produce maps of text and KnitContents
2044
1156
:return: (text_map, content_map) where text_map contains the texts for
2045
the requested versions and content_map contains the KnitContents.
1157
the requested versions and content_map contains the KnitContents.
1158
Both dicts take version_ids as their keys.
2047
# NB: By definition we never need to read remote sources unless texts
2048
# are requested from them: we don't delta across stores - and we
2049
# explicitly do not want to to prevent data loss situations.
2050
if self.global_map is None:
2051
self.global_map = self.vf.get_parent_map(self.keys)
2052
nonlocal_keys = self.nonlocal_keys
2054
missing_keys = set(nonlocal_keys)
2055
# Read from remote versioned file instances and provide to our caller.
2056
for source in self.vf._immediate_fallback_vfs:
2057
if not missing_keys:
2059
# Loop over fallback repositories asking them for texts - ignore
2060
# any missing from a particular fallback.
2061
for record in source.get_record_stream(missing_keys,
2062
self._ordering, True):
2063
if record.storage_kind == 'absent':
2064
# Not in thie particular stream, may be in one of the
2065
# other fallback vfs objects.
2067
missing_keys.remove(record.key)
2070
if self._raw_record_map is None:
2071
raise AssertionError('_raw_record_map should have been filled')
2073
for key in self.keys:
2074
if key in self.nonlocal_keys:
2076
yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2079
def _get_one_work(self, requested_key):
2080
# Now, if we have calculated everything already, just return the
2082
if requested_key in self._contents_map:
2083
return self._contents_map[requested_key]
2084
# To simplify things, parse everything at once - code that wants one text
2085
# probably wants them all.
2086
1160
# FUTURE: This function could be improved for the 'extract many' case
2087
1161
# by tracking each component and only doing the copy when the number of
2088
1162
# children than need to apply delta's to it is > 1 or it is part of the
2089
1163
# final output.
2090
multiple_versions = len(self.keys) != 1
2091
if self._record_map is None:
2092
self._record_map = self.vf._raw_map_to_record_map(
2093
self._raw_record_map)
2094
record_map = self._record_map
2095
# raw_record_map is key:
2096
# Have read and parsed records at this point.
2097
for key in self.keys:
2098
if key in self.nonlocal_keys:
1164
version_ids = list(version_ids)
1165
multiple_versions = len(version_ids) != 1
1166
record_map = self._get_record_map(version_ids)
1171
for version_id in version_ids:
2101
1172
components = []
2103
1174
while cursor is not None:
2105
record, record_details, digest, next = record_map[cursor]
2107
raise RevisionNotPresent(cursor, self)
1175
record, record_details, digest, next = record_map[cursor]
2108
1176
components.append((cursor, record, record_details, digest))
1177
if cursor in content_map:
2110
if cursor in self._contents_map:
2111
# no need to plan further back
2112
components.append((cursor, None, None, None))
2116
1182
for (component_id, record, record_details,
2117
1183
digest) in reversed(components):
2118
if component_id in self._contents_map:
2119
content = self._contents_map[component_id]
1184
if component_id in content_map:
1185
content = content_map[component_id]
2121
content, delta = self._factory.parse_record(key[-1],
1187
content, delta = self.factory.parse_record(version_id,
2122
1188
record, record_details, content,
2123
1189
copy_base_content=multiple_versions)
2124
1190
if multiple_versions:
2125
self._contents_map[component_id] = content
1191
content_map[component_id] = content
1193
content.cleanup_eol(copy_on_mutate=multiple_versions)
1194
final_content[version_id] = content
2127
1196
# digest here is the digest from the last applied component.
2128
1197
text = content.text()
2129
1198
actual_sha = sha_strings(text)
2130
1199
if actual_sha != digest:
2131
raise SHA1KnitCorrupt(self, actual_sha, digest, key, text)
2132
if multiple_versions:
2133
return self._contents_map[requested_key]
2137
def _wire_bytes(self):
2138
"""Get the bytes to put on the wire for 'key'.
2140
The first collection of bytes asked for returns the serialised
2141
raw_record_map and the additional details (key, parent) for key.
2142
Subsequent calls return just the additional details (key, parent).
2143
The wire storage_kind given for the first key is 'knit-delta-closure',
2144
For subsequent keys it is 'knit-delta-closure-ref'.
2146
:param key: A key from the content generator.
2147
:return: Bytes to put on the wire.
2150
# kind marker for dispatch on the far side,
2151
lines.append('knit-delta-closure')
2153
if self.vf._factory.annotated:
2154
lines.append('annotated')
2157
# then the list of keys
2158
lines.append('\t'.join(['\x00'.join(key) for key in self.keys
2159
if key not in self.nonlocal_keys]))
2160
# then the _raw_record_map in serialised form:
2162
# for each item in the map:
2164
# 1 line with parents if the key is to be yielded (None: for None, '' for ())
2165
# one line with method
2166
# one line with noeol
2167
# one line with next ('' for None)
2168
# one line with byte count of the record bytes
2170
for key, (record_bytes, (method, noeol), next) in \
2171
self._raw_record_map.iteritems():
2172
key_bytes = '\x00'.join(key)
2173
parents = self.global_map.get(key, None)
2175
parent_bytes = 'None:'
2177
parent_bytes = '\t'.join('\x00'.join(key) for key in parents)
2178
method_bytes = method
2184
next_bytes = '\x00'.join(next)
2187
map_byte_list.append('%s\n%s\n%s\n%s\n%s\n%d\n%s' % (
2188
key_bytes, parent_bytes, method_bytes, noeol_bytes, next_bytes,
2189
len(record_bytes), record_bytes))
2190
map_bytes = ''.join(map_byte_list)
2191
lines.append(map_bytes)
2192
bytes = '\n'.join(lines)
2196
class _VFContentMapGenerator(_ContentMapGenerator):
2197
"""Content map generator reading from a VersionedFiles object."""
2199
def __init__(self, versioned_files, keys, nonlocal_keys=None,
2200
global_map=None, raw_record_map=None, ordering='unordered'):
2201
"""Create a _ContentMapGenerator.
2203
:param versioned_files: The versioned files that the texts are being
2205
:param keys: The keys to produce content maps for.
2206
:param nonlocal_keys: An iterable of keys(possibly intersecting keys)
2207
which are known to not be in this knit, but rather in one of the
2209
:param global_map: The result of get_parent_map(keys) (or a supermap).
2210
This is required if get_record_stream() is to be used.
2211
:param raw_record_map: A unparsed raw record map to use for answering
2214
_ContentMapGenerator.__init__(self, ordering=ordering)
2215
# The vf to source data from
2216
self.vf = versioned_files
2218
self.keys = list(keys)
2219
# Keys known to be in fallback vfs objects
2220
if nonlocal_keys is None:
2221
self.nonlocal_keys = set()
2223
self.nonlocal_keys = frozenset(nonlocal_keys)
2224
# Parents data for keys to be returned in get_record_stream
2225
self.global_map = global_map
2226
# The chunked lists for self.keys in text form
2228
# A cache of KnitContent objects used in extracting texts.
2229
self._contents_map = {}
2230
# All the knit records needed to assemble the requested keys as full
2232
self._record_map = None
2233
if raw_record_map is None:
2234
self._raw_record_map = self.vf._get_record_map_unparsed(keys,
2237
self._raw_record_map = raw_record_map
2238
# the factory for parsing records
2239
self._factory = self.vf._factory
2242
class _NetworkContentMapGenerator(_ContentMapGenerator):
2243
"""Content map generator sourced from a network stream."""
2245
def __init__(self, bytes, line_end):
2246
"""Construct a _NetworkContentMapGenerator from a bytes block."""
2248
self.global_map = {}
2249
self._raw_record_map = {}
2250
self._contents_map = {}
2251
self._record_map = None
2252
self.nonlocal_keys = []
2253
# Get access to record parsing facilities
2254
self.vf = KnitVersionedFiles(None, None)
2257
line_end = bytes.find('\n', start)
2258
line = bytes[start:line_end]
2259
start = line_end + 1
2260
if line == 'annotated':
2261
self._factory = KnitAnnotateFactory()
2263
self._factory = KnitPlainFactory()
2264
# list of keys to emit in get_record_stream
2265
line_end = bytes.find('\n', start)
2266
line = bytes[start:line_end]
2267
start = line_end + 1
2269
tuple(segment.split('\x00')) for segment in line.split('\t')
2271
# now a loop until the end. XXX: It would be nice if this was just a
2272
# bunch of the same records as get_record_stream(..., False) gives, but
2273
# there is a decent sized gap stopping that at the moment.
2277
line_end = bytes.find('\n', start)
2278
key = tuple(bytes[start:line_end].split('\x00'))
2279
start = line_end + 1
2280
# 1 line with parents (None: for None, '' for ())
2281
line_end = bytes.find('\n', start)
2282
line = bytes[start:line_end]
2287
[tuple(segment.split('\x00')) for segment in line.split('\t')
2289
self.global_map[key] = parents
2290
start = line_end + 1
2291
# one line with method
2292
line_end = bytes.find('\n', start)
2293
line = bytes[start:line_end]
2295
start = line_end + 1
2296
# one line with noeol
2297
line_end = bytes.find('\n', start)
2298
line = bytes[start:line_end]
2300
start = line_end + 1
2301
# one line with next ('' for None)
2302
line_end = bytes.find('\n', start)
2303
line = bytes[start:line_end]
2307
next = tuple(bytes[start:line_end].split('\x00'))
2308
start = line_end + 1
2309
# one line with byte count of the record bytes
2310
line_end = bytes.find('\n', start)
2311
line = bytes[start:line_end]
2313
start = line_end + 1
2315
record_bytes = bytes[start:start+count]
2316
start = start + count
2318
self._raw_record_map[key] = (record_bytes, (method, noeol), next)
2320
def get_record_stream(self):
2321
"""Get a record stream for for keys requested by the bytestream."""
2323
for key in self.keys:
2324
yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2327
def _wire_bytes(self):
2331
class _KndxIndex(object):
2332
"""Manages knit index files
2334
The index is kept in memory and read on startup, to enable
1200
raise KnitCorrupt(self.filename,
1202
'\n of reconstructed text does not match'
1204
'\n for version %s' %
1205
(actual_sha, digest, version_id))
1206
text_map[version_id] = text
1207
return text_map, final_content
1209
def iter_lines_added_or_present_in_versions(self, version_ids=None,
1211
"""See VersionedFile.iter_lines_added_or_present_in_versions()."""
1212
if version_ids is None:
1213
version_ids = self.versions()
1215
pb = progress.DummyProgress()
1216
# we don't care about inclusions, the caller cares.
1217
# but we need to setup a list of records to visit.
1218
# we need version_id, position, length
1219
version_id_records = []
1220
requested_versions = set(version_ids)
1221
# filter for available versions
1222
for version_id in requested_versions:
1223
if not self.has_version(version_id):
1224
raise RevisionNotPresent(version_id, self.filename)
1225
# get a in-component-order queue:
1226
for version_id in self.versions():
1227
if version_id in requested_versions:
1228
index_memo = self._index.get_position(version_id)
1229
version_id_records.append((version_id, index_memo))
1231
total = len(version_id_records)
1232
for version_idx, (version_id, data, sha_value) in \
1233
enumerate(self._data.read_records_iter(version_id_records)):
1234
pb.update('Walking content.', version_idx, total)
1235
method = self._index.get_method(version_id)
1237
assert method in ('fulltext', 'line-delta')
1238
if method == 'fulltext':
1239
line_iterator = self.factory.get_fulltext_content(data)
1241
line_iterator = self.factory.get_linedelta_content(data)
1242
# XXX: It might be more efficient to yield (version_id,
1243
# line_iterator) in the future. However for now, this is a simpler
1244
# change to integrate into the rest of the codebase. RBC 20071110
1245
for line in line_iterator:
1246
yield line, version_id
1248
pb.update('Walking content.', total, total)
1250
def num_versions(self):
1251
"""See VersionedFile.num_versions()."""
1252
return self._index.num_versions()
1254
__len__ = num_versions
1256
def annotate(self, version_id):
1257
"""See VersionedFile.annotate."""
1258
return self.factory.annotate(self, version_id)
1260
def get_parent_map(self, version_ids):
1261
"""See VersionedFile.get_parent_map."""
1262
return self._index.get_parent_map(version_ids)
1264
def get_ancestry(self, versions, topo_sorted=True):
1265
"""See VersionedFile.get_ancestry."""
1266
if isinstance(versions, basestring):
1267
versions = [versions]
1270
return self._index.get_ancestry(versions, topo_sorted)
1272
def get_ancestry_with_ghosts(self, versions):
1273
"""See VersionedFile.get_ancestry_with_ghosts."""
1274
if isinstance(versions, basestring):
1275
versions = [versions]
1278
return self._index.get_ancestry_with_ghosts(versions)
1280
def plan_merge(self, ver_a, ver_b):
1281
"""See VersionedFile.plan_merge."""
1282
ancestors_b = set(self.get_ancestry(ver_b, topo_sorted=False))
1283
ancestors_a = set(self.get_ancestry(ver_a, topo_sorted=False))
1284
annotated_a = self.annotate(ver_a)
1285
annotated_b = self.annotate(ver_b)
1286
return merge._plan_annotate_merge(annotated_a, annotated_b,
1287
ancestors_a, ancestors_b)
1290
class _KnitComponentFile(object):
1291
"""One of the files used to implement a knit database"""
1293
def __init__(self, transport, filename, mode, file_mode=None,
1294
create_parent_dir=False, dir_mode=None):
1295
self._transport = transport
1296
self._filename = filename
1298
self._file_mode = file_mode
1299
self._dir_mode = dir_mode
1300
self._create_parent_dir = create_parent_dir
1301
self._need_to_create = False
1303
def _full_path(self):
1304
"""Return the full path to this file."""
1305
return self._transport.base + self._filename
1307
def check_header(self, fp):
1308
line = fp.readline()
1310
# An empty file can actually be treated as though the file doesn't
1312
raise errors.NoSuchFile(self._full_path())
1313
if line != self.HEADER:
1314
raise KnitHeaderError(badline=line,
1315
filename=self._transport.abspath(self._filename))
1318
return '%s(%s)' % (self.__class__.__name__, self._filename)
1321
class _KnitIndex(_KnitComponentFile):
1322
"""Manages knit index file.
1324
The index is already kept in memory and read on startup, to enable
2335
1325
fast lookups of revision information. The cursor of the index
2336
1326
file is always pointing to the end, making it easy to append
2379
1369
to ensure that records always start on new lines even if the last write was
2380
1370
interrupted. As a result its normal for the last line in the index to be
2381
1371
missing a trailing newline. One can be added with no harmful effects.
2383
:ivar _kndx_cache: dict from prefix to the old state of KnitIndex objects,
2384
where prefix is e.g. the (fileid,) for .texts instances or () for
2385
constant-mapped things like .revisions, and the old state is
2386
tuple(history_vector, cache_dict). This is used to prevent having an
2387
ABI change with the C extension that reads .kndx files.
2390
1374
HEADER = "# bzr knit index 8\n"
2392
def __init__(self, transport, mapper, get_scope, allow_writes, is_locked):
2393
"""Create a _KndxIndex on transport using mapper."""
2394
self._transport = transport
2395
self._mapper = mapper
2396
self._get_scope = get_scope
2397
self._allow_writes = allow_writes
2398
self._is_locked = is_locked
2400
self.has_graph = True
2402
def add_records(self, records, random_id=False, missing_compression_parents=False):
2403
"""Add multiple records to the index.
2405
:param records: a list of tuples:
2406
(key, options, access_memo, parents).
2407
:param random_id: If True the ids being added were randomly generated
2408
and no check for existence will be performed.
2409
:param missing_compression_parents: If True the records being added are
2410
only compressed against texts already in the index (or inside
2411
records). If False the records all refer to unavailable texts (or
2412
texts inside records) as compression parents.
2414
if missing_compression_parents:
2415
# It might be nice to get the edge of the records. But keys isn't
2417
keys = sorted(record[0] for record in records)
2418
raise errors.RevisionNotPresent(keys, self)
2420
for record in records:
2423
path = self._mapper.map(key) + '.kndx'
2424
path_keys = paths.setdefault(path, (prefix, []))
2425
path_keys[1].append(record)
2426
for path in sorted(paths):
2427
prefix, path_keys = paths[path]
2428
self._load_prefixes([prefix])
2430
orig_history = self._kndx_cache[prefix][1][:]
2431
orig_cache = self._kndx_cache[prefix][0].copy()
2434
for key, options, (_, pos, size), parents in path_keys:
2436
# kndx indices cannot be parentless.
2438
line = "\n%s %s %s %s %s :" % (
2439
key[-1], ','.join(options), pos, size,
2440
self._dictionary_compress(parents))
2441
if type(line) is not str:
2442
raise AssertionError(
2443
'data must be utf8 was %s' % type(line))
2445
self._cache_key(key, options, pos, size, parents)
2446
if len(orig_history):
2447
self._transport.append_bytes(path, ''.join(lines))
2449
self._init_index(path, lines)
2451
# If any problems happen, restore the original values and re-raise
2452
self._kndx_cache[prefix] = (orig_cache, orig_history)
2455
def scan_unvalidated_index(self, graph_index):
2456
"""See _KnitGraphIndex.scan_unvalidated_index."""
2457
# Because kndx files do not support atomic insertion via separate index
2458
# files, they do not support this method.
2459
raise NotImplementedError(self.scan_unvalidated_index)
2461
def get_missing_compression_parents(self):
2462
"""See _KnitGraphIndex.get_missing_compression_parents."""
2463
# Because kndx files do not support atomic insertion via separate index
2464
# files, they do not support this method.
2465
raise NotImplementedError(self.get_missing_compression_parents)
2467
def _cache_key(self, key, options, pos, size, parent_keys):
1376
# speed of knit parsing went from 280 ms to 280 ms with slots addition.
1377
# __slots__ = ['_cache', '_history', '_transport', '_filename']
1379
def _cache_version(self, version_id, options, pos, size, parents):
2468
1380
"""Cache a version record in the history array and index cache.
2470
1382
This is inlined into _load_data for performance. KEEP IN SYNC.
2471
1383
(It saves 60ms, 25% of the __init__ overhead on local 4000 record
2475
version_id = key[-1]
2476
# last-element only for compatibilty with the C load_data.
2477
parents = tuple(parent[-1] for parent in parent_keys)
2478
for parent in parent_keys:
2479
if parent[:-1] != prefix:
2480
raise ValueError("mismatched prefixes for %r, %r" % (
2482
cache, history = self._kndx_cache[prefix]
2483
1386
# only want the _history index to reference the 1st index entry
2484
1387
# for version_id
2485
if version_id not in cache:
2486
index = len(history)
2487
history.append(version_id)
1388
if version_id not in self._cache:
1389
index = len(self._history)
1390
self._history.append(version_id)
2489
index = cache[version_id][5]
2490
cache[version_id] = (version_id,
1392
index = self._cache[version_id][5]
1393
self._cache[version_id] = (version_id,
2497
def check_header(self, fp):
2498
line = fp.readline()
2500
# An empty file can actually be treated as though the file doesn't
2502
raise errors.NoSuchFile(self)
2503
if line != self.HEADER:
2504
raise KnitHeaderError(badline=line, filename=self)
2506
def _check_read(self):
2507
if not self._is_locked():
2508
raise errors.ObjectNotLocked(self)
2509
if self._get_scope() != self._scope:
2512
1400
def _check_write_ok(self):
2513
"""Assert if not writes are permitted."""
2514
if not self._is_locked():
2515
raise errors.ObjectNotLocked(self)
2516
1401
if self._get_scope() != self._scope:
1402
raise errors.OutSideTransaction()
2518
1403
if self._mode != 'w':
2519
1404
raise errors.ReadOnlyObjectDirtiedError(self)
2521
def get_build_details(self, keys):
2522
"""Get the method, index_memo and compression parent for keys.
1406
def __init__(self, transport, filename, mode, create=False, file_mode=None,
1407
create_parent_dir=False, delay_create=False, dir_mode=None,
1409
_KnitComponentFile.__init__(self, transport, filename, mode,
1410
file_mode=file_mode,
1411
create_parent_dir=create_parent_dir,
1414
# position in _history is the 'official' index for a revision
1415
# but the values may have come from a newer entry.
1416
# so - wc -l of a knit index is != the number of unique names
1420
fp = self._transport.get(self._filename)
1422
# _load_data may raise NoSuchFile if the target knit is
1424
_load_data(self, fp)
1428
if mode != 'w' or not create:
1431
self._need_to_create = True
1433
self._transport.put_bytes_non_atomic(
1434
self._filename, self.HEADER, mode=self._file_mode)
1435
self._scope = get_scope()
1436
self._get_scope = get_scope
1438
def get_ancestry(self, versions, topo_sorted=True):
1439
"""See VersionedFile.get_ancestry."""
1440
# get a graph of all the mentioned versions:
1442
pending = set(versions)
1445
version = pending.pop()
1448
parents = [p for p in cache[version][4] if p in cache]
1450
raise RevisionNotPresent(version, self._filename)
1451
# if not completed and not a ghost
1452
pending.update([p for p in parents if p not in graph])
1453
graph[version] = parents
1456
return topo_sort(graph.items())
1458
def get_ancestry_with_ghosts(self, versions):
1459
"""See VersionedFile.get_ancestry_with_ghosts."""
1460
# get a graph of all the mentioned versions:
1461
self.check_versions_present(versions)
1464
pending = set(versions)
1466
version = pending.pop()
1468
parents = cache[version][4]
1474
pending.update([p for p in parents if p not in graph])
1475
graph[version] = parents
1476
return topo_sort(graph.items())
1478
def get_build_details(self, version_ids):
1479
"""Get the method, index_memo and compression parent for version_ids.
2524
1481
Ghosts are omitted from the result.
2526
:param keys: An iterable of keys.
2527
:return: A dict of key:(index_memo, compression_parent, parents,
1483
:param version_ids: An iterable of version_ids.
1484
:return: A dict of version_id:(index_memo, compression_parent,
1485
parents, record_details).
2530
1487
opaque structure to pass to read_records to extract the raw
2537
1494
extra information about the content which needs to be passed to
2538
1495
Factory.parse_record
2540
parent_map = self.get_parent_map(keys)
2543
if key not in parent_map:
2545
method = self.get_method(key)
2546
parents = parent_map[key]
1498
for version_id in version_ids:
1499
if version_id not in self._cache:
1500
# ghosts are omitted
1502
method = self.get_method(version_id)
1503
parents = self.get_parents_with_ghosts(version_id)
2547
1504
if method == 'fulltext':
2548
1505
compression_parent = None
2550
1507
compression_parent = parents[0]
2551
noeol = 'no-eol' in self.get_options(key)
2552
index_memo = self.get_position(key)
2553
result[key] = (index_memo, compression_parent,
1508
noeol = 'no-eol' in self.get_options(version_id)
1509
index_memo = self.get_position(version_id)
1510
result[version_id] = (index_memo, compression_parent,
2554
1511
parents, (method, noeol))
2557
def get_method(self, key):
2558
"""Return compression method of specified key."""
2559
options = self.get_options(key)
2560
if 'fulltext' in options:
2562
elif 'line-delta' in options:
2565
raise errors.KnitIndexUnknownMethod(self, options)
2567
def get_options(self, key):
2568
"""Return a list representing options.
2572
prefix, suffix = self._split_key(key)
2573
self._load_prefixes([prefix])
2575
return self._kndx_cache[prefix][0][suffix][1]
2577
raise RevisionNotPresent(key, self)
2579
def find_ancestry(self, keys):
2580
"""See CombinedGraphIndex.find_ancestry()"""
2581
prefixes = set(key[:-1] for key in keys)
2582
self._load_prefixes(prefixes)
2585
missing_keys = set()
2586
pending_keys = list(keys)
2587
# This assumes that keys will not reference parents in a different
2588
# prefix, which is accurate so far.
2590
key = pending_keys.pop()
2591
if key in parent_map:
2595
suffix_parents = self._kndx_cache[prefix][0][key[-1]][4]
2597
missing_keys.add(key)
2599
parent_keys = tuple([prefix + (suffix,)
2600
for suffix in suffix_parents])
2601
parent_map[key] = parent_keys
2602
pending_keys.extend([p for p in parent_keys
2603
if p not in parent_map])
2604
return parent_map, missing_keys
2606
def get_parent_map(self, keys):
2607
"""Get a map of the parents of keys.
2609
:param keys: The keys to look up parents for.
2610
:return: A mapping from keys to parents. Absent keys are absent from
2613
# Parse what we need to up front, this potentially trades off I/O
2614
# locality (.kndx and .knit in the same block group for the same file
2615
# id) for less checking in inner loops.
2616
prefixes = set(key[:-1] for key in keys)
2617
self._load_prefixes(prefixes)
2622
suffix_parents = self._kndx_cache[prefix][0][key[-1]][4]
2626
result[key] = tuple(prefix + (suffix,) for
2627
suffix in suffix_parents)
2630
def get_position(self, key):
2631
"""Return details needed to access the version.
2633
:return: a tuple (key, data position, size) to hand to the access
2634
logic to get the record.
2636
prefix, suffix = self._split_key(key)
2637
self._load_prefixes([prefix])
2638
entry = self._kndx_cache[prefix][0][suffix]
2639
return key, entry[2], entry[3]
2641
has_key = _mod_index._has_key_from_parent_map
2643
def _init_index(self, path, extra_lines=[]):
2644
"""Initialize an index."""
2646
sio.write(self.HEADER)
2647
sio.writelines(extra_lines)
2649
self._transport.put_file_non_atomic(path, sio,
2650
create_parent_dir=True)
2651
# self._create_parent_dir)
2652
# mode=self._file_mode,
2653
# dir_mode=self._dir_mode)
2656
"""Get all the keys in the collection.
2658
The keys are not ordered.
2661
# Identify all key prefixes.
2662
# XXX: A bit hacky, needs polish.
2663
if type(self._mapper) is ConstantMapper:
2667
for quoted_relpath in self._transport.iter_files_recursive():
2668
path, ext = os.path.splitext(quoted_relpath)
2670
prefixes = [self._mapper.unmap(path) for path in relpaths]
2671
self._load_prefixes(prefixes)
2672
for prefix in prefixes:
2673
for suffix in self._kndx_cache[prefix][1]:
2674
result.add(prefix + (suffix,))
2677
def _load_prefixes(self, prefixes):
2678
"""Load the indices for prefixes."""
2680
for prefix in prefixes:
2681
if prefix not in self._kndx_cache:
2682
# the load_data interface writes to these variables.
2685
self._filename = prefix
2687
path = self._mapper.map(prefix) + '.kndx'
2688
fp = self._transport.get(path)
2690
# _load_data may raise NoSuchFile if the target knit is
2692
_load_data(self, fp)
2695
self._kndx_cache[prefix] = (self._cache, self._history)
2700
self._kndx_cache[prefix] = ({}, [])
2701
if type(self._mapper) is ConstantMapper:
2702
# preserve behaviour for revisions.kndx etc.
2703
self._init_index(path)
2708
missing_keys = _mod_index._missing_keys_from_parent_map
2710
def _partition_keys(self, keys):
2711
"""Turn keys into a dict of prefix:suffix_list."""
2714
prefix_keys = result.setdefault(key[:-1], [])
2715
prefix_keys.append(key[-1])
2718
def _dictionary_compress(self, keys):
2719
"""Dictionary compress keys.
2721
:param keys: The keys to generate references to.
2722
:return: A string representation of keys. keys which are present are
2723
dictionary compressed, and others are emitted as fulltext with a
1514
def num_versions(self):
1515
return len(self._history)
1517
__len__ = num_versions
1519
def get_versions(self):
1520
"""Get all the versions in the file. not topologically sorted."""
1521
return self._history
1523
def _version_list_to_index(self, versions):
2728
1524
result_list = []
2729
prefix = keys[0][:-1]
2730
cache = self._kndx_cache[prefix][0]
2732
if key[:-1] != prefix:
2733
# kndx indices cannot refer across partitioned storage.
2734
raise ValueError("mismatched prefixes for %r" % keys)
2735
if key[-1] in cache:
1526
for version in versions:
1527
if version in cache:
2736
1528
# -- inlined lookup() --
2737
result_list.append(str(cache[key[-1]][5]))
1529
result_list.append(str(cache[version][5]))
2738
1530
# -- end lookup () --
2740
result_list.append('.' + key[-1])
1532
result_list.append('.' + version)
2741
1533
return ' '.join(result_list)
2743
def _reset_cache(self):
2744
# Possibly this should be a LRU cache. A dictionary from key_prefix to
2745
# (cache_dict, history_vector) for parsed kndx files.
2746
self._kndx_cache = {}
2747
self._scope = self._get_scope()
2748
allow_writes = self._allow_writes()
1535
def add_version(self, version_id, options, index_memo, parents):
1536
"""Add a version record to the index."""
1537
self.add_versions(((version_id, options, index_memo, parents),))
1539
def add_versions(self, versions, random_id=False):
1540
"""Add multiple versions to the index.
1542
:param versions: a list of tuples:
1543
(version_id, options, pos, size, parents).
1544
:param random_id: If True the ids being added were randomly generated
1545
and no check for existence will be performed.
1548
orig_history = self._history[:]
1549
orig_cache = self._cache.copy()
1552
for version_id, options, (index, pos, size), parents in versions:
1553
line = "\n%s %s %s %s %s :" % (version_id,
1557
self._version_list_to_index(parents))
1558
assert isinstance(line, str), \
1559
'content must be utf-8 encoded: %r' % (line,)
1561
self._cache_version(version_id, options, pos, size, tuple(parents))
1562
if not self._need_to_create:
1563
self._transport.append_bytes(self._filename, ''.join(lines))
1566
sio.write(self.HEADER)
1567
sio.writelines(lines)
1569
self._transport.put_file_non_atomic(self._filename, sio,
1570
create_parent_dir=self._create_parent_dir,
1571
mode=self._file_mode,
1572
dir_mode=self._dir_mode)
1573
self._need_to_create = False
1575
# If any problems happen, restore the original values and re-raise
1576
self._history = orig_history
1577
self._cache = orig_cache
1580
def has_version(self, version_id):
1581
"""True if the version is in the index."""
1582
return version_id in self._cache
1584
def get_position(self, version_id):
1585
"""Return details needed to access the version.
1587
.kndx indices do not support split-out data, so return None for the
1590
:return: a tuple (None, data position, size) to hand to the access
1591
logic to get the record.
1593
entry = self._cache[version_id]
1594
return None, entry[2], entry[3]
1596
def get_method(self, version_id):
1597
"""Return compression method of specified version."""
1599
options = self._cache[version_id][1]
1601
raise RevisionNotPresent(version_id, self._filename)
1602
if 'fulltext' in options:
2754
def _sort_keys_by_io(self, keys, positions):
2755
"""Figure out an optimal order to read the records for the given keys.
2757
Sort keys, grouped by index and sorted by position.
2759
:param keys: A list of keys whose records we want to read. This will be
2761
:param positions: A dict, such as the one returned by
2762
_get_components_positions()
1605
if 'line-delta' not in options:
1606
raise errors.KnitIndexUnknownMethod(self._full_path(), options)
1609
def get_options(self, version_id):
1610
"""Return a list representing options.
2765
def get_sort_key(key):
2766
index_memo = positions[key][1]
2767
# Group by prefix and position. index_memo[0] is the key, so it is
2768
# (file_id, revision_id) and we don't want to sort on revision_id,
2769
# index_memo[1] is the position, and index_memo[2] is the size,
2770
# which doesn't matter for the sort
2771
return index_memo[0][:-1], index_memo[1]
2772
return keys.sort(key=get_sort_key)
2774
_get_total_build_size = _get_total_build_size
2776
def _split_key(self, key):
2777
"""Split key into a prefix and suffix."""
2778
return key[:-1], key[-1]
2781
class _KnitGraphIndex(object):
2782
"""A KnitVersionedFiles index layered on GraphIndex."""
2784
def __init__(self, graph_index, is_locked, deltas=False, parents=True,
2785
add_callback=None, track_external_parent_refs=False):
1614
return self._cache[version_id][1]
1616
def get_parent_map(self, version_ids):
1617
"""Passed through to by KnitVersionedFile.get_parent_map."""
1619
for version_id in version_ids:
1621
result[version_id] = tuple(self._cache[version_id][4])
1626
def get_parents_with_ghosts(self, version_id):
1627
"""Return parents of specified version with ghosts."""
1629
return self.get_parent_map([version_id])[version_id]
1631
raise RevisionNotPresent(version_id, self)
1633
def check_versions_present(self, version_ids):
1634
"""Check that all specified versions are present."""
1636
for version_id in version_ids:
1637
if version_id not in cache:
1638
raise RevisionNotPresent(version_id, self._filename)
1641
class KnitGraphIndex(object):
1642
"""A knit index that builds on GraphIndex."""
1644
def __init__(self, graph_index, deltas=False, parents=True, add_callback=None):
2786
1645
"""Construct a KnitGraphIndex on a graph_index.
2788
1647
:param graph_index: An implementation of bzrlib.index.GraphIndex.
2789
:param is_locked: A callback to check whether the object should answer
2791
1648
:param deltas: Allow delta-compressed records.
2792
:param parents: If True, record knits parents, if not do not record
2794
1649
:param add_callback: If not None, allow additions to the index and call
2795
1650
this callback with a list of added GraphIndex nodes:
2796
1651
[(node, value, node_refs), ...]
2797
:param is_locked: A callback, returns True if the index is locked and
2799
:param track_external_parent_refs: If True, record all external parent
2800
references parents from added records. These can be retrieved
2801
later by calling get_missing_parents().
1652
:param parents: If True, record knits parents, if not do not record
2803
self._add_callback = add_callback
2804
1655
self._graph_index = graph_index
2805
1656
self._deltas = deltas
1657
self._add_callback = add_callback
2806
1658
self._parents = parents
2807
1659
if deltas and not parents:
2808
# XXX: TODO: Delta tree and parent graph should be conceptually
2810
1660
raise KnitCorrupt(self, "Cannot do delta compression without "
2811
1661
"parent tracking.")
2812
self.has_graph = parents
2813
self._is_locked = is_locked
2814
self._missing_compression_parents = set()
2815
if track_external_parent_refs:
2816
self._key_dependencies = _KeyRefs()
2818
self._key_dependencies = None
2821
return "%s(%r)" % (self.__class__.__name__, self._graph_index)
2823
def add_records(self, records, random_id=False,
2824
missing_compression_parents=False):
2825
"""Add multiple records to the index.
1663
def _check_write_ok(self):
1666
def _get_entries(self, keys, check_present=False):
1667
"""Get the entries for keys.
1669
:param keys: An iterable of index keys, - 1-tuples.
1674
for node in self._graph_index.iter_entries(keys):
1676
found_keys.add(node[1])
1678
# adapt parentless index to the rest of the code.
1679
for node in self._graph_index.iter_entries(keys):
1680
yield node[0], node[1], node[2], ()
1681
found_keys.add(node[1])
1683
missing_keys = keys.difference(found_keys)
1685
raise RevisionNotPresent(missing_keys.pop(), self)
1687
def _present_keys(self, version_ids):
1689
node[1] for node in self._get_entries(version_ids)])
1691
def _parentless_ancestry(self, versions):
1692
"""Honour the get_ancestry API for parentless knit indices."""
1693
wanted_keys = self._version_ids_to_keys(versions)
1694
present_keys = self._present_keys(wanted_keys)
1695
missing = set(wanted_keys).difference(present_keys)
1697
raise RevisionNotPresent(missing.pop(), self)
1698
return list(self._keys_to_version_ids(present_keys))
1700
def get_ancestry(self, versions, topo_sorted=True):
1701
"""See VersionedFile.get_ancestry."""
1702
if not self._parents:
1703
return self._parentless_ancestry(versions)
1704
# XXX: This will do len(history) index calls - perhaps
1705
# it should be altered to be a index core feature?
1706
# get a graph of all the mentioned versions:
1709
versions = self._version_ids_to_keys(versions)
1710
pending = set(versions)
1712
# get all pending nodes
1713
this_iteration = pending
1714
new_nodes = self._get_entries(this_iteration)
1717
for (index, key, value, node_refs) in new_nodes:
1718
# dont ask for ghosties - otherwise
1719
# we we can end up looping with pending
1720
# being entirely ghosted.
1721
graph[key] = [parent for parent in node_refs[0]
1722
if parent not in ghosts]
1724
for parent in graph[key]:
1725
# dont examine known nodes again
1730
ghosts.update(this_iteration.difference(found))
1731
if versions.difference(graph):
1732
raise RevisionNotPresent(versions.difference(graph).pop(), self)
1734
result_keys = topo_sort(graph.items())
1736
result_keys = graph.iterkeys()
1737
return [key[0] for key in result_keys]
1739
def get_ancestry_with_ghosts(self, versions):
1740
"""See VersionedFile.get_ancestry."""
1741
if not self._parents:
1742
return self._parentless_ancestry(versions)
1743
# XXX: This will do len(history) index calls - perhaps
1744
# it should be altered to be a index core feature?
1745
# get a graph of all the mentioned versions:
1747
versions = self._version_ids_to_keys(versions)
1748
pending = set(versions)
1750
# get all pending nodes
1751
this_iteration = pending
1752
new_nodes = self._get_entries(this_iteration)
1754
for (index, key, value, node_refs) in new_nodes:
1755
graph[key] = node_refs[0]
1757
for parent in graph[key]:
1758
# dont examine known nodes again
1762
missing_versions = this_iteration.difference(graph)
1763
missing_needed = versions.intersection(missing_versions)
1765
raise RevisionNotPresent(missing_needed.pop(), self)
1766
for missing_version in missing_versions:
1767
# add a key, no parents
1768
graph[missing_version] = []
1769
pending.discard(missing_version) # don't look for it
1770
result_keys = topo_sort(graph.items())
1771
return [key[0] for key in result_keys]
1773
def get_build_details(self, version_ids):
1774
"""Get the method, index_memo and compression parent for version_ids.
1776
Ghosts are omitted from the result.
1778
:param version_ids: An iterable of version_ids.
1779
:return: A dict of version_id:(index_memo, compression_parent,
1780
parents, record_details).
1782
opaque structure to pass to read_records to extract the raw
1785
Content that this record is built upon, may be None
1787
Logical parents of this node
1789
extra information about the content which needs to be passed to
1790
Factory.parse_record
1793
entries = self._get_entries(self._version_ids_to_keys(version_ids), True)
1794
for entry in entries:
1795
version_id = self._keys_to_version_ids((entry[1],))[0]
1796
if not self._parents:
1799
parents = self._keys_to_version_ids(entry[3][0])
1800
if not self._deltas:
1801
compression_parent = None
1803
compression_parent_key = self._compression_parent(entry)
1804
if compression_parent_key:
1805
compression_parent = self._keys_to_version_ids(
1806
(compression_parent_key,))[0]
1808
compression_parent = None
1809
noeol = (entry[2][0] == 'N')
1810
if compression_parent:
1811
method = 'line-delta'
1814
result[version_id] = (self._node_to_position(entry),
1815
compression_parent, parents,
1819
def _compression_parent(self, an_entry):
1820
# return the key that an_entry is compressed against, or None
1821
# Grab the second parent list (as deltas implies parents currently)
1822
compression_parents = an_entry[3][1]
1823
if not compression_parents:
1825
assert len(compression_parents) == 1
1826
return compression_parents[0]
1828
def _get_method(self, node):
1829
if not self._deltas:
1831
if self._compression_parent(node):
1836
def num_versions(self):
1837
return len(list(self._graph_index.iter_all_entries()))
1839
__len__ = num_versions
1841
def get_versions(self):
1842
"""Get all the versions in the file. not topologically sorted."""
1843
return [node[1][0] for node in self._graph_index.iter_all_entries()]
1845
def has_version(self, version_id):
1846
"""True if the version is in the index."""
1847
return len(self._present_keys(self._version_ids_to_keys([version_id]))) == 1
1849
def _keys_to_version_ids(self, keys):
1850
return tuple(key[0] for key in keys)
1852
def get_position(self, version_id):
1853
"""Return details needed to access the version.
1855
:return: a tuple (index, data position, size) to hand to the access
1856
logic to get the record.
1858
node = self._get_node(version_id)
1859
return self._node_to_position(node)
1861
def _node_to_position(self, node):
1862
"""Convert an index value to position details."""
1863
bits = node[2][1:].split(' ')
1864
return node[0], int(bits[0]), int(bits[1])
1866
def get_method(self, version_id):
1867
"""Return compression method of specified version."""
1868
return self._get_method(self._get_node(version_id))
1870
def _get_node(self, version_id):
1872
return list(self._get_entries(self._version_ids_to_keys([version_id])))[0]
1874
raise RevisionNotPresent(version_id, self)
1876
def get_options(self, version_id):
1877
"""Return a list representing options.
1881
node = self._get_node(version_id)
1882
options = [self._get_method(node)]
1883
if node[2][0] == 'N':
1884
options.append('no-eol')
1887
def get_parent_map(self, version_ids):
1888
"""Passed through to by KnitVersionedFile.get_parent_map."""
1889
nodes = self._get_entries(self._version_ids_to_keys(version_ids))
1893
result[node[1][0]] = self._keys_to_version_ids(node[3][0])
1896
result[node[1][0]] = ()
1899
def get_parents_with_ghosts(self, version_id):
1900
"""Return parents of specified version with ghosts."""
1902
return self.get_parent_map([version_id])[version_id]
1904
raise RevisionNotPresent(version_id, self)
1906
def check_versions_present(self, version_ids):
1907
"""Check that all specified versions are present."""
1908
keys = self._version_ids_to_keys(version_ids)
1909
present = self._present_keys(keys)
1910
missing = keys.difference(present)
1912
raise RevisionNotPresent(missing.pop(), self)
1914
def add_version(self, version_id, options, access_memo, parents):
1915
"""Add a version record to the index."""
1916
return self.add_versions(((version_id, options, access_memo, parents),))
1918
def add_versions(self, versions, random_id=False):
1919
"""Add multiple versions to the index.
2827
1921
This function does not insert data into the Immutable GraphIndex
2828
1922
backing the KnitGraphIndex, instead it prepares data for insertion by
2829
1923
the caller and checks that it is safe to insert then calls
2830
1924
self._add_callback with the prepared GraphIndex nodes.
2832
:param records: a list of tuples:
2833
(key, options, access_memo, parents).
1926
:param versions: a list of tuples:
1927
(version_id, options, pos, size, parents).
2834
1928
:param random_id: If True the ids being added were randomly generated
2835
1929
and no check for existence will be performed.
2836
:param missing_compression_parents: If True the records being added are
2837
only compressed against texts already in the index (or inside
2838
records). If False the records all refer to unavailable texts (or
2839
texts inside records) as compression parents.
2841
1931
if not self._add_callback:
2842
1932
raise errors.ReadOnlyError(self)
2843
1933
# we hope there are no repositories with inconsistent parentage
2847
compression_parents = set()
2848
key_dependencies = self._key_dependencies
2849
for (key, options, access_memo, parents) in records:
2851
parents = tuple(parents)
2852
if key_dependencies is not None:
2853
key_dependencies.add_references(key, parents)
1938
for (version_id, options, access_memo, parents) in versions:
2854
1939
index, pos, size = access_memo
1940
key = (version_id, )
1941
parents = tuple((parent, ) for parent in parents)
2855
1942
if 'no-eol' in options:
2898
1976
for key, (value, node_refs) in keys.iteritems():
2899
1977
result.append((key, value))
2900
1978
self._add_callback(result)
2901
if missing_compression_parents:
2902
# This may appear to be incorrect (it does not check for
2903
# compression parents that are in the existing graph index),
2904
# but such records won't have been buffered, so this is
2905
# actually correct: every entry when
2906
# missing_compression_parents==True either has a missing parent, or
2907
# a parent that is one of the keys in records.
2908
compression_parents.difference_update(keys)
2909
self._missing_compression_parents.update(compression_parents)
2910
# Adding records may have satisfied missing compression parents.
2911
self._missing_compression_parents.difference_update(keys)
2913
def scan_unvalidated_index(self, graph_index):
2914
"""Inform this _KnitGraphIndex that there is an unvalidated index.
2916
This allows this _KnitGraphIndex to keep track of any missing
2917
compression parents we may want to have filled in to make those
2920
:param graph_index: A GraphIndex
2923
new_missing = graph_index.external_references(ref_list_num=1)
2924
new_missing.difference_update(self.get_parent_map(new_missing))
2925
self._missing_compression_parents.update(new_missing)
2926
if self._key_dependencies is not None:
2927
# Add parent refs from graph_index (and discard parent refs that
2928
# the graph_index has).
2929
for node in graph_index.iter_all_entries():
2930
self._key_dependencies.add_references(node[1], node[3][0])
2932
def get_missing_compression_parents(self):
2933
"""Return the keys of missing compression parents.
2935
Missing compression parents occur when a record stream was missing
2936
basis texts, or a index was scanned that had missing basis texts.
2938
return frozenset(self._missing_compression_parents)
2940
def get_missing_parents(self):
2941
"""Return the keys of missing parents."""
2942
# If updating this, you should also update
2943
# groupcompress._GCGraphIndex.get_missing_parents
2944
# We may have false positives, so filter those out.
2945
self._key_dependencies.satisfy_refs_for_keys(
2946
self.get_parent_map(self._key_dependencies.get_unsatisfied_refs()))
2947
return frozenset(self._key_dependencies.get_unsatisfied_refs())
2949
def _check_read(self):
2950
"""raise if reads are not permitted."""
2951
if not self._is_locked():
2952
raise errors.ObjectNotLocked(self)
2954
def _check_write_ok(self):
2955
"""Assert if writes are not permitted."""
2956
if not self._is_locked():
2957
raise errors.ObjectNotLocked(self)
2959
def _compression_parent(self, an_entry):
2960
# return the key that an_entry is compressed against, or None
2961
# Grab the second parent list (as deltas implies parents currently)
2962
compression_parents = an_entry[3][1]
2963
if not compression_parents:
2965
if len(compression_parents) != 1:
2966
raise AssertionError(
2967
"Too many compression parents: %r" % compression_parents)
2968
return compression_parents[0]
2970
def get_build_details(self, keys):
2971
"""Get the method, index_memo and compression parent for version_ids.
2973
Ghosts are omitted from the result.
2975
:param keys: An iterable of keys.
2976
:return: A dict of key:
2977
(index_memo, compression_parent, parents, record_details).
2979
opaque structure to pass to read_records to extract the raw
2982
Content that this record is built upon, may be None
2984
Logical parents of this node
2986
extra information about the content which needs to be passed to
2987
Factory.parse_record
2991
entries = self._get_entries(keys, False)
2992
for entry in entries:
2994
if not self._parents:
2997
parents = entry[3][0]
2998
if not self._deltas:
2999
compression_parent_key = None
3001
compression_parent_key = self._compression_parent(entry)
3002
noeol = (entry[2][0] == 'N')
3003
if compression_parent_key:
3004
method = 'line-delta'
3007
result[key] = (self._node_to_position(entry),
3008
compression_parent_key, parents,
1980
def _version_ids_to_keys(self, version_ids):
1981
return set((version_id, ) for version_id in version_ids)
1984
class _KnitAccess(object):
1985
"""Access to knit records in a .knit file."""
1987
def __init__(self, transport, filename, _file_mode, _dir_mode,
1988
_need_to_create, _create_parent_dir):
1989
"""Create a _KnitAccess for accessing and inserting data.
1991
:param transport: The transport the .knit is located on.
1992
:param filename: The filename of the .knit.
1994
self._transport = transport
1995
self._filename = filename
1996
self._file_mode = _file_mode
1997
self._dir_mode = _dir_mode
1998
self._need_to_create = _need_to_create
1999
self._create_parent_dir = _create_parent_dir
2001
def add_raw_records(self, sizes, raw_data):
2002
"""Add raw knit bytes to a storage area.
2004
The data is spooled to whereever the access method is storing data.
2006
:param sizes: An iterable containing the size of each raw data segment.
2007
:param raw_data: A bytestring containing the data.
2008
:return: A list of memos to retrieve the record later. Each memo is a
2009
tuple - (index, pos, length), where the index field is always None
2010
for the .knit access method.
2012
assert type(raw_data) == str, \
2013
'data must be plain bytes was %s' % type(raw_data)
2014
if not self._need_to_create:
2015
base = self._transport.append_bytes(self._filename, raw_data)
2017
self._transport.put_bytes_non_atomic(self._filename, raw_data,
2018
create_parent_dir=self._create_parent_dir,
2019
mode=self._file_mode,
2020
dir_mode=self._dir_mode)
2021
self._need_to_create = False
2025
result.append((None, base, size))
3012
def _get_entries(self, keys, check_present=False):
3013
"""Get the entries for keys.
3015
:param keys: An iterable of index key tuples.
3020
for node in self._graph_index.iter_entries(keys):
3022
found_keys.add(node[1])
3024
# adapt parentless index to the rest of the code.
3025
for node in self._graph_index.iter_entries(keys):
3026
yield node[0], node[1], node[2], ()
3027
found_keys.add(node[1])
3029
missing_keys = keys.difference(found_keys)
3031
raise RevisionNotPresent(missing_keys.pop(), self)
3033
def get_method(self, key):
3034
"""Return compression method of specified key."""
3035
return self._get_method(self._get_node(key))
3037
def _get_method(self, node):
3038
if not self._deltas:
3040
if self._compression_parent(node):
3045
def _get_node(self, key):
2030
"""IFF this data access has its own storage area, initialise it.
2034
self._transport.put_bytes_non_atomic(self._filename, '',
2035
mode=self._file_mode)
2037
def open_file(self):
2038
"""IFF this data access can be represented as a single file, open it.
2040
For knits that are not mapped to a single file on disk this will
2043
:return: None or a file handle.
3047
return list(self._get_entries([key]))[0]
3049
raise RevisionNotPresent(key, self)
3051
def get_options(self, key):
3052
"""Return a list representing options.
3056
node = self._get_node(key)
3057
options = [self._get_method(node)]
3058
if node[2][0] == 'N':
3059
options.append('no-eol')
3062
def find_ancestry(self, keys):
3063
"""See CombinedGraphIndex.find_ancestry()"""
3064
return self._graph_index.find_ancestry(keys, 0)
3066
def get_parent_map(self, keys):
3067
"""Get a map of the parents of keys.
3069
:param keys: The keys to look up parents for.
3070
:return: A mapping from keys to parents. Absent keys are absent from
3074
nodes = self._get_entries(keys)
3078
result[node[1]] = node[3][0]
2046
return self._transport.get(self._filename)
2051
def get_raw_records(self, memos_for_retrieval):
2052
"""Get the raw bytes for a records.
2054
:param memos_for_retrieval: An iterable containing the (index, pos,
2055
length) memo for retrieving the bytes. The .knit method ignores
2056
the index as there is always only a single file.
2057
:return: An iterator over the bytes of the records.
2059
read_vector = [(pos, size) for (index, pos, size) in memos_for_retrieval]
2060
for pos, data in self._transport.readv(self._filename, read_vector):
2064
class _PackAccess(object):
2065
"""Access to knit records via a collection of packs."""
2067
def __init__(self, index_to_packs, writer=None):
2068
"""Create a _PackAccess object.
2070
:param index_to_packs: A dict mapping index objects to the transport
2071
and file names for obtaining data.
2072
:param writer: A tuple (pack.ContainerWriter, write_index) which
2073
contains the pack to write, and the index that reads from it will
2077
self.container_writer = writer[0]
2078
self.write_index = writer[1]
3081
result[node[1]] = None
3084
def get_position(self, key):
3085
"""Return details needed to access the version.
3087
:return: a tuple (index, data position, size) to hand to the access
3088
logic to get the record.
3090
node = self._get_node(key)
3091
return self._node_to_position(node)
3093
has_key = _mod_index._has_key_from_parent_map
3096
"""Get all the keys in the collection.
3098
The keys are not ordered.
3101
return [node[1] for node in self._graph_index.iter_all_entries()]
3103
missing_keys = _mod_index._missing_keys_from_parent_map
3105
def _node_to_position(self, node):
3106
"""Convert an index value to position details."""
3107
bits = node[2][1:].split(' ')
3108
return node[0], int(bits[0]), int(bits[1])
3110
def _sort_keys_by_io(self, keys, positions):
3111
"""Figure out an optimal order to read the records for the given keys.
3113
Sort keys, grouped by index and sorted by position.
3115
:param keys: A list of keys whose records we want to read. This will be
3117
:param positions: A dict, such as the one returned by
3118
_get_components_positions()
3121
def get_index_memo(key):
3122
# index_memo is at offset [1]. It is made up of (GraphIndex,
3123
# position, size). GI is an object, which will be unique for each
3124
# pack file. This causes us to group by pack file, then sort by
3125
# position. Size doesn't matter, but it isn't worth breaking up the
3127
return positions[key][1]
3128
return keys.sort(key=get_index_memo)
3130
_get_total_build_size = _get_total_build_size
3133
class _KnitKeyAccess(object):
3134
"""Access to records in .knit files."""
3136
def __init__(self, transport, mapper):
3137
"""Create a _KnitKeyAccess with transport and mapper.
3139
:param transport: The transport the access object is rooted at.
3140
:param mapper: The mapper used to map keys to .knit files.
3142
self._transport = transport
3143
self._mapper = mapper
3145
def add_raw_records(self, key_sizes, raw_data):
2080
self.container_writer = None
2081
self.write_index = None
2082
self.indices = index_to_packs
2084
def add_raw_records(self, sizes, raw_data):
3146
2085
"""Add raw knit bytes to a storage area.
3148
2087
The data is spooled to the container writer in one bytes-record per
3151
:param sizes: An iterable of tuples containing the key and size of each
2090
:param sizes: An iterable containing the size of each raw data segment.
3153
2091
:param raw_data: A bytestring containing the data.
3154
:return: A list of memos to retrieve the record later. Each memo is an
3155
opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3156
length), where the key is the record key.
2092
:return: A list of memos to retrieve the record later. Each memo is a
2093
tuple - (index, pos, length), where the index field is the
2094
write_index object supplied to the PackAccess object.
3158
if type(raw_data) is not str:
3159
raise AssertionError(
3160
'data must be plain bytes was %s' % type(raw_data))
2096
assert type(raw_data) == str, \
2097
'data must be plain bytes was %s' % type(raw_data)
3163
# TODO: This can be tuned for writing to sftp and other servers where
3164
# append() is relatively expensive by grouping the writes to each key
3166
for key, size in key_sizes:
3167
path = self._mapper.map(key)
3169
base = self._transport.append_bytes(path + '.knit',
3170
raw_data[offset:offset+size])
3171
except errors.NoSuchFile:
3172
self._transport.mkdir(osutils.dirname(path))
3173
base = self._transport.append_bytes(path + '.knit',
3174
raw_data[offset:offset+size])
2101
p_offset, p_length = self.container_writer.add_bytes_record(
2102
raw_data[offset:offset+size], [])
3178
result.append((key, base, size))
2104
result.append((self.write_index, p_offset, p_length))
3182
"""Flush pending writes on this access object.
3184
For .knit files this is a no-op.
2108
"""Pack based knits do not get individually created."""
3188
2110
def get_raw_records(self, memos_for_retrieval):
3189
2111
"""Get the raw bytes for a records.
3191
:param memos_for_retrieval: An iterable containing the access memo for
3192
retrieving the bytes.
2113
:param memos_for_retrieval: An iterable containing the (index, pos,
2114
length) memo for retrieving the bytes. The Pack access method
2115
looks up the pack to use for a given record in its index_to_pack
3193
2117
:return: An iterator over the bytes of the records.
3195
# first pass, group into same-index request to minimise readv's issued.
2119
# first pass, group into same-index requests
3196
2120
request_lists = []
3197
current_prefix = None
3198
for (key, offset, length) in memos_for_retrieval:
3199
if current_prefix == key[:-1]:
2121
current_index = None
2122
for (index, offset, length) in memos_for_retrieval:
2123
if current_index == index:
3200
2124
current_list.append((offset, length))
3202
if current_prefix is not None:
3203
request_lists.append((current_prefix, current_list))
3204
current_prefix = key[:-1]
2126
if current_index is not None:
2127
request_lists.append((current_index, current_list))
2128
current_index = index
3205
2129
current_list = [(offset, length)]
3206
2130
# handle the last entry
3207
if current_prefix is not None:
3208
request_lists.append((current_prefix, current_list))
3209
for prefix, read_vector in request_lists:
3210
path = self._mapper.map(prefix) + '.knit'
3211
for pos, data in self._transport.readv(path, read_vector):
2131
if current_index is not None:
2132
request_lists.append((current_index, current_list))
2133
for index, offsets in request_lists:
2134
transport, path = self.indices[index]
2135
reader = pack.make_readv_reader(transport, path, offsets)
2136
for names, read_func in reader.iter_records():
2137
yield read_func(None)
2139
def open_file(self):
2140
"""Pack based knits have no single file."""
2143
def set_writer(self, writer, index, (transport, packname)):
2144
"""Set a writer to use for adding data."""
2145
if index is not None:
2146
self.indices[index] = (transport, packname)
2147
self.container_writer = writer
2148
self.write_index = index
2151
class _StreamAccess(object):
2152
"""A Knit Access object that provides data from a datastream.
2154
It also provides a fallback to present as unannotated data, annotated data
2155
from a *backing* access object.
2157
This is triggered by a index_memo which is pointing to a different index
2158
than this was constructed with, and is used to allow extracting full
2159
unannotated texts for insertion into annotated knits.
2162
def __init__(self, reader_callable, stream_index, backing_knit,
2164
"""Create a _StreamAccess object.
2166
:param reader_callable: The reader_callable from the datastream.
2167
This is called to buffer all the data immediately, for
2169
:param stream_index: The index the data stream this provides access to
2170
which will be present in native index_memo's.
2171
:param backing_knit: The knit object that will provide access to
2172
annotated texts which are not available in the stream, so as to
2173
create unannotated texts.
2174
:param orig_factory: The original content factory used to generate the
2175
stream. This is used for checking whether the thunk code for
2176
supporting _copy_texts will generate the correct form of data.
2178
self.data = reader_callable(None)
2179
self.stream_index = stream_index
2180
self.backing_knit = backing_knit
2181
self.orig_factory = orig_factory
2183
def get_raw_records(self, memos_for_retrieval):
2184
"""Get the raw bytes for a records.
2186
:param memos_for_retrieval: An iterable of memos from the
2187
_StreamIndex object identifying bytes to read; for these classes
2188
they are (from_backing_knit, index, start, end) and can point to
2189
either the backing knit or streamed data.
2190
:return: An iterator yielding a byte string for each record in
2191
memos_for_retrieval.
2193
# use a generator for memory friendliness
2194
for from_backing_knit, version_id, start, end in memos_for_retrieval:
2195
if not from_backing_knit:
2196
assert version_id is self.stream_index
2197
yield self.data[start:end]
2199
# we have been asked to thunk. This thunking only occurs when
2200
# we are obtaining plain texts from an annotated backing knit
2201
# so that _copy_texts will work.
2202
# We could improve performance here by scanning for where we need
2203
# to do this and using get_line_list, then interleaving the output
2204
# as desired. However, for now, this is sufficient.
2205
if self.orig_factory.__class__ != KnitPlainFactory:
2206
raise errors.KnitCorrupt(
2207
self, 'Bad thunk request %r cannot be backed by %r' %
2208
(version_id, self.orig_factory))
2209
lines = self.backing_knit.get_lines(version_id)
2210
line_bytes = ''.join(lines)
2211
digest = sha_string(line_bytes)
2212
# the packed form of the fulltext always has a trailing newline,
2213
# even if the actual text does not, unless the file is empty. the
2214
# record options including the noeol flag are passed through by
2215
# _StreamIndex, so this is safe.
2217
if lines[-1][-1] != '\n':
2218
lines[-1] = lines[-1] + '\n'
2220
# We want plain data, because we expect to thunk only to allow text
2222
size, bytes = self.backing_knit._data._record_to_data(version_id,
2223
digest, lines, line_bytes)
2227
class _StreamIndex(object):
2228
"""A Knit Index object that uses the data map from a datastream."""
2230
def __init__(self, data_list, backing_index):
2231
"""Create a _StreamIndex object.
2233
:param data_list: The data_list from the datastream.
2234
:param backing_index: The index which will supply values for nodes
2235
referenced outside of this stream.
2237
self.data_list = data_list
2238
self.backing_index = backing_index
2239
self._by_version = {}
2241
for key, options, length, parents in data_list:
2242
self._by_version[key] = options, (pos, pos + length), parents
2245
def get_ancestry(self, versions, topo_sorted):
2246
"""Get an ancestry list for versions."""
2248
# Not needed for basic joins
2249
raise NotImplementedError(self.get_ancestry)
2250
# get a graph of all the mentioned versions:
2251
# Little ugly - basically copied from KnitIndex, but don't want to
2252
# accidentally incorporate too much of that index's code.
2254
pending = set(versions)
2255
cache = self._by_version
2257
version = pending.pop()
2260
parents = [p for p in cache[version][2] if p in cache]
2262
raise RevisionNotPresent(version, self)
2263
# if not completed and not a ghost
2264
pending.update([p for p in parents if p not in ancestry])
2265
ancestry.add(version)
2266
return list(ancestry)
2268
def get_build_details(self, version_ids):
2269
"""Get the method, index_memo and compression parent for version_ids.
2271
Ghosts are omitted from the result.
2273
:param version_ids: An iterable of version_ids.
2274
:return: A dict of version_id:(index_memo, compression_parent,
2275
parents, record_details).
2277
opaque memo that can be passed to _StreamAccess.read_records
2278
to extract the raw data; for these classes it is
2279
(from_backing_knit, index, start, end)
2281
Content that this record is built upon, may be None
2283
Logical parents of this node
2285
extra information about the content which needs to be passed to
2286
Factory.parse_record
2289
for version_id in version_ids:
2291
method = self.get_method(version_id)
2292
except errors.RevisionNotPresent:
2293
# ghosts are omitted
2295
parent_ids = self.get_parents_with_ghosts(version_id)
2296
noeol = ('no-eol' in self.get_options(version_id))
2297
index_memo = self.get_position(version_id)
2298
from_backing_knit = index_memo[0]
2299
if from_backing_knit:
2300
# texts retrieved from the backing knit are always full texts
2302
if method == 'fulltext':
2303
compression_parent = None
2305
compression_parent = parent_ids[0]
2306
result[version_id] = (index_memo, compression_parent,
2307
parent_ids, (method, noeol))
2310
def get_method(self, version_id):
2311
"""Return compression method of specified version."""
2312
options = self.get_options(version_id)
2313
if 'fulltext' in options:
2315
elif 'line-delta' in options:
2318
raise errors.KnitIndexUnknownMethod(self, options)
2320
def get_options(self, version_id):
2321
"""Return a list representing options.
2326
return self._by_version[version_id][0]
2328
options = list(self.backing_index.get_options(version_id))
2329
if 'fulltext' in options:
2331
elif 'line-delta' in options:
2332
# Texts from the backing knit are always returned from the stream
2334
options.remove('line-delta')
2335
options.append('fulltext')
2337
raise errors.KnitIndexUnknownMethod(self, options)
2338
return tuple(options)
2340
def get_parent_map(self, version_ids):
2341
"""Passed through to by KnitVersionedFile.get_parent_map."""
2344
for version_id in version_ids:
2346
result[version_id] = self._by_version[version_id][2]
2348
pending_ids.add(version_id)
2349
result.update(self.backing_index.get_parent_map(pending_ids))
2352
def get_parents_with_ghosts(self, version_id):
2353
"""Return parents of specified version with ghosts."""
2355
return self.get_parent_map([version_id])[version_id]
2357
raise RevisionNotPresent(version_id, self)
2359
def get_position(self, version_id):
2360
"""Return details needed to access the version.
2362
_StreamAccess has the data as a big array, so we return slice
2363
coordinates into that (as index_memo's are opaque outside the
2364
index and matching access class).
2366
:return: a tuple (from_backing_knit, index, start, end) that can
2367
be passed e.g. to get_raw_records.
2368
If from_backing_knit is False, index will be self, otherwise it
2369
will be a version id.
2372
start, end = self._by_version[version_id][1]
2373
return False, self, start, end
2375
# Signal to the access object to handle this from the backing knit.
2376
return (True, version_id, None, None)
2378
def get_versions(self):
2379
"""Get all the versions in the stream."""
2380
return self._by_version.keys()
2383
class _KnitData(object):
2384
"""Manage extraction of data from a KnitAccess, caching and decompressing.
2386
The KnitData class provides the logic for parsing and using knit records,
2387
making use of an access method for the low level read and write operations.
2390
def __init__(self, access):
2391
"""Create a KnitData object.
2393
:param access: The access method to use. Access methods such as
2394
_KnitAccess manage the insertion of raw records and the subsequent
2395
retrieval of the same.
2397
self._access = access
2398
self._checked = False
2400
def _open_file(self):
2401
return self._access.open_file()
2403
def _record_to_data(self, version_id, digest, lines, dense_lines=None):
2404
"""Convert version_id, digest, lines into a raw data block.
2406
:param dense_lines: The bytes of lines but in a denser form. For
2407
instance, if lines is a list of 1000 bytestrings each ending in \n,
2408
dense_lines may be a list with one line in it, containing all the
2409
1000's lines and their \n's. Using dense_lines if it is already
2410
known is a win because the string join to create bytes in this
2411
function spends less time resizing the final string.
2412
:return: (len, a StringIO instance with the raw data ready to read.)
2414
# Note: using a string copy here increases memory pressure with e.g.
2415
# ISO's, but it is about 3 seconds faster on a 1.2Ghz intel machine
2416
# when doing the initial commit of a mozilla tree. RBC 20070921
2417
bytes = ''.join(chain(
2418
["version %s %d %s\n" % (version_id,
2421
dense_lines or lines,
2422
["end %s\n" % version_id]))
2423
assert bytes.__class__ == str
2424
compressed_bytes = bytes_to_gzip(bytes)
2425
return len(compressed_bytes), compressed_bytes
2427
def add_raw_records(self, sizes, raw_data):
2428
"""Append a prepared record to the data file.
2430
:param sizes: An iterable containing the size of each raw data segment.
2431
:param raw_data: A bytestring containing the data.
2432
:return: a list of index data for the way the data was stored.
2433
See the access method add_raw_records documentation for more
2436
return self._access.add_raw_records(sizes, raw_data)
2438
def _parse_record_header(self, version_id, raw_data):
2439
"""Parse a record header for consistency.
2441
:return: the header and the decompressor stream.
2442
as (stream, header_record)
2444
df = GzipFile(mode='rb', fileobj=StringIO(raw_data))
2446
rec = self._check_header(version_id, df.readline())
2447
except Exception, e:
2448
raise KnitCorrupt(self._access,
2449
"While reading {%s} got %s(%s)"
2450
% (version_id, e.__class__.__name__, str(e)))
2453
def _check_header(self, version_id, line):
2456
raise KnitCorrupt(self._access,
2457
'unexpected number of elements in record header')
2458
if rec[1] != version_id:
2459
raise KnitCorrupt(self._access,
2460
'unexpected version, wanted %r, got %r'
2461
% (version_id, rec[1]))
2464
def _parse_record(self, version_id, data):
2466
# 4168 calls in 2880 217 internal
2467
# 4168 calls to _parse_record_header in 2121
2468
# 4168 calls to readlines in 330
2469
df = GzipFile(mode='rb', fileobj=StringIO(data))
2472
record_contents = df.readlines()
2473
except Exception, e:
2474
raise KnitCorrupt(self._access,
2475
"While reading {%s} got %s(%s)"
2476
% (version_id, e.__class__.__name__, str(e)))
2477
header = record_contents.pop(0)
2478
rec = self._check_header(version_id, header)
2480
last_line = record_contents.pop()
2481
if len(record_contents) != int(rec[2]):
2482
raise KnitCorrupt(self._access,
2483
'incorrect number of lines %s != %s'
2485
% (len(record_contents), int(rec[2]),
2487
if last_line != 'end %s\n' % rec[1]:
2488
raise KnitCorrupt(self._access,
2489
'unexpected version end line %r, wanted %r'
2490
% (last_line, version_id))
2492
return record_contents, rec[3]
2494
def read_records_iter_raw(self, records):
2495
"""Read text records from data file and yield raw data.
2497
This unpacks enough of the text record to validate the id is
2498
as expected but thats all.
2500
# setup an iterator of the external records:
2501
# uses readv so nice and fast we hope.
2503
# grab the disk data needed.
2504
needed_offsets = [index_memo for version_id, index_memo
2506
raw_records = self._access.get_raw_records(needed_offsets)
2508
for version_id, index_memo in records:
2509
data = raw_records.next()
2510
# validate the header
2511
df, rec = self._parse_record_header(version_id, data)
2513
yield version_id, data
2515
def read_records_iter(self, records):
2516
"""Read text records from data file and yield result.
2518
The result will be returned in whatever is the fastest to read.
2519
Not by the order requested. Also, multiple requests for the same
2520
record will only yield 1 response.
2521
:param records: A list of (version_id, pos, len) entries
2522
:return: Yields (version_id, contents, digest) in the order
2523
read, not the order requested
2528
needed_records = sorted(set(records), key=operator.itemgetter(1))
2529
if not needed_records:
2532
# The transport optimizes the fetching as well
2533
# (ie, reads continuous ranges.)
2534
raw_data = self._access.get_raw_records(
2535
[index_memo for version_id, index_memo in needed_records])
2537
for (version_id, index_memo), data in \
2538
izip(iter(needed_records), raw_data):
2539
content, digest = self._parse_record(version_id, data)
2540
yield version_id, content, digest
2542
def read_records(self, records):
2543
"""Read records into a dictionary."""
2545
for record_id, content, digest in \
2546
self.read_records_iter(records):
2547
components[record_id] = (content, digest)
2551
class InterKnit(InterVersionedFile):
2552
"""Optimised code paths for knit to knit operations."""
2554
_matching_file_from_factory = staticmethod(make_file_knit)
2555
_matching_file_to_factory = staticmethod(make_file_knit)
2558
def is_compatible(source, target):
2559
"""Be compatible with knits. """
2561
return (isinstance(source, KnitVersionedFile) and
2562
isinstance(target, KnitVersionedFile))
2563
except AttributeError:
2566
def _copy_texts(self, pb, msg, version_ids, ignore_missing=False):
2567
"""Copy texts to the target by extracting and adding them one by one.
2569
see join() for the parameter definitions.
2571
version_ids = self._get_source_version_ids(version_ids, ignore_missing)
2572
# --- the below is factorable out with VersionedFile.join, but wait for
2573
# VersionedFiles, it may all be simpler then.
2574
graph = Graph(self.source)
2575
search = graph._make_breadth_first_searcher(version_ids)
2576
transitive_ids = set()
2577
map(transitive_ids.update, list(search))
2578
parent_map = self.source.get_parent_map(transitive_ids)
2579
order = topo_sort(parent_map.items())
2581
def size_of_content(content):
2582
return sum(len(line) for line in content.text())
2583
# Cache at most 10MB of parent texts
2584
parent_cache = lru_cache.LRUSizeCache(max_size=10*1024*1024,
2585
compute_size=size_of_content)
2586
# TODO: jam 20071116 It would be nice to have a streaming interface to
2587
# get multiple texts from a source. The source could be smarter
2588
# about how it handled intermediate stages.
2589
# get_line_list() or make_mpdiffs() seem like a possibility, but
2590
# at the moment they extract all full texts into memory, which
2591
# causes us to store more than our 3x fulltext goal.
2592
# Repository.iter_files_bytes() may be another possibility
2593
to_process = [version for version in order
2594
if version not in self.target]
2595
total = len(to_process)
2596
pb = ui.ui_factory.nested_progress_bar()
2598
for index, version in enumerate(to_process):
2599
pb.update('Converting versioned data', index, total)
2600
sha1, num_bytes, parent_text = self.target.add_lines(version,
2601
self.source.get_parents_with_ghosts(version),
2602
self.source.get_lines(version),
2603
parent_texts=parent_cache)
2604
parent_cache[version] = parent_text
2609
def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
2610
"""See InterVersionedFile.join."""
2611
assert isinstance(self.source, KnitVersionedFile)
2612
assert isinstance(self.target, KnitVersionedFile)
2614
# If the source and target are mismatched w.r.t. annotations vs
2615
# plain, the data needs to be converted accordingly
2616
if self.source.factory.annotated == self.target.factory.annotated:
2618
elif self.source.factory.annotated:
2619
converter = self._anno_to_plain_converter
2621
# We're converting from a plain to an annotated knit. Copy them
2622
# across by full texts.
2623
return self._copy_texts(pb, msg, version_ids, ignore_missing)
2625
version_ids = self._get_source_version_ids(version_ids, ignore_missing)
2629
pb = ui.ui_factory.nested_progress_bar()
2631
version_ids = list(version_ids)
2632
if None in version_ids:
2633
version_ids.remove(None)
2635
self.source_ancestry = set(self.source.get_ancestry(version_ids,
2637
this_versions = set(self.target._index.get_versions())
2638
# XXX: For efficiency we should not look at the whole index,
2639
# we only need to consider the referenced revisions - they
2640
# must all be present, or the method must be full-text.
2641
# TODO, RBC 20070919
2642
needed_versions = self.source_ancestry - this_versions
2644
if not needed_versions:
2646
full_list = topo_sort(
2647
self.source.get_parent_map(self.source.versions()))
2649
version_list = [i for i in full_list if (not self.target.has_version(i)
2650
and i in needed_versions)]
2654
copy_queue_records = []
2656
for version_id in version_list:
2657
options = self.source._index.get_options(version_id)
2658
parents = self.source._index.get_parents_with_ghosts(version_id)
2659
# check that its will be a consistent copy:
2660
for parent in parents:
2661
# if source has the parent, we must :
2662
# * already have it or
2663
# * have it scheduled already
2664
# otherwise we don't care
2665
assert (self.target.has_version(parent) or
2666
parent in copy_set or
2667
not self.source.has_version(parent))
2668
index_memo = self.source._index.get_position(version_id)
2669
copy_queue_records.append((version_id, index_memo))
2670
copy_queue.append((version_id, options, parents))
2671
copy_set.add(version_id)
2673
# data suck the join:
2675
total = len(version_list)
2678
for (version_id, raw_data), \
2679
(version_id2, options, parents) in \
2680
izip(self.source._data.read_records_iter_raw(copy_queue_records),
2682
assert version_id == version_id2, 'logic error, inconsistent results'
2684
pb.update("Joining knit", count, total)
2686
size, raw_data = converter(raw_data, version_id, options,
2689
size = len(raw_data)
2690
raw_records.append((version_id, options, parents, size))
2691
raw_datum.append(raw_data)
2692
self.target._add_raw_records(raw_records, ''.join(raw_datum))
2697
def _anno_to_plain_converter(self, raw_data, version_id, options,
2699
"""Convert annotated content to plain content."""
2700
data, digest = self.source._data._parse_record(version_id, raw_data)
2701
if 'fulltext' in options:
2702
content = self.source.factory.parse_fulltext(data, version_id)
2703
lines = self.target.factory.lower_fulltext(content)
2705
delta = self.source.factory.parse_line_delta(data, version_id,
2707
lines = self.target.factory.lower_line_delta(delta)
2708
return self.target._data._record_to_data(version_id, digest, lines)
2711
InterVersionedFile.register_optimiser(InterKnit)
2714
class WeaveToKnit(InterVersionedFile):
2715
"""Optimised code paths for weave to knit operations."""
2717
_matching_file_from_factory = bzrlib.weave.WeaveFile
2718
_matching_file_to_factory = staticmethod(make_file_knit)
2721
def is_compatible(source, target):
2722
"""Be compatible with weaves to knits."""
2724
return (isinstance(source, bzrlib.weave.Weave) and
2725
isinstance(target, KnitVersionedFile))
2726
except AttributeError:
2729
def join(self, pb=None, msg=None, version_ids=None, ignore_missing=False):
2730
"""See InterVersionedFile.join."""
2731
assert isinstance(self.source, bzrlib.weave.Weave)
2732
assert isinstance(self.target, KnitVersionedFile)
2734
version_ids = self._get_source_version_ids(version_ids, ignore_missing)
2739
pb = ui.ui_factory.nested_progress_bar()
2741
version_ids = list(version_ids)
2743
self.source_ancestry = set(self.source.get_ancestry(version_ids))
2744
this_versions = set(self.target._index.get_versions())
2745
needed_versions = self.source_ancestry - this_versions
2747
if not needed_versions:
2749
full_list = topo_sort(
2750
self.source.get_parent_map(self.source.versions()))
2752
version_list = [i for i in full_list if (not self.target.has_version(i)
2753
and i in needed_versions)]
2757
total = len(version_list)
2758
parent_map = self.source.get_parent_map(version_list)
2759
for version_id in version_list:
2760
pb.update("Converting to knit", count, total)
2761
parents = parent_map[version_id]
2762
# check that its will be a consistent copy:
2763
for parent in parents:
2764
# if source has the parent, we must already have it
2765
assert (self.target.has_version(parent))
2766
self.target.add_lines(
2767
version_id, parents, self.source.get_lines(version_id))
2774
InterVersionedFile.register_optimiser(WeaveToKnit)
2777
# Deprecated, use PatienceSequenceMatcher instead
2778
KnitSequenceMatcher = patiencediff.PatienceSequenceMatcher
3215
2781
def annotate_knit(knit, revision_id):
3256
2892
parents to create an annotation, but only need 1 parent to generate the
3259
:return: A list of (key, index_memo) records, suitable for
3260
passing to read_records_iter to start reading in the raw data from
2895
:return: A list of (revision_id, index_memo) records, suitable for
2896
passing to read_records_iter to start reading in the raw data fro/
3263
pending = set([key])
2899
if revision_id in self._annotated_lines:
2902
pending = set([revision_id])
3266
self._num_needed_children[key] = 1
3268
2907
# get all pending nodes
3269
2909
this_iteration = pending
3270
build_details = self._vf._index.get_build_details(this_iteration)
2910
build_details = self._knit._index.get_build_details(this_iteration)
3271
2911
self._all_build_details.update(build_details)
3272
# new_nodes = self._vf._index._get_entries(this_iteration)
2912
# new_nodes = self._knit._index._get_entries(this_iteration)
3273
2913
pending = set()
3274
for key, details in build_details.iteritems():
3275
(index_memo, compression_parent, parent_keys,
2914
for rev_id, details in build_details.iteritems():
2915
(index_memo, compression_parent, parents,
3276
2916
record_details) = details
3277
self._parent_map[key] = parent_keys
3278
self._heads_provider = None
3279
records.append((key, index_memo))
2917
self._revision_id_graph[rev_id] = parents
2918
records.append((rev_id, index_memo))
3280
2919
# Do we actually need to check _annotated_lines?
3281
pending.update([p for p in parent_keys
3282
if p not in self._all_build_details])
3284
for parent_key in parent_keys:
3285
if parent_key in self._num_needed_children:
3286
self._num_needed_children[parent_key] += 1
3288
self._num_needed_children[parent_key] = 1
2920
pending.update(p for p in parents
2921
if p not in self._all_build_details)
3289
2922
if compression_parent:
3290
if compression_parent in self._num_compression_children:
3291
self._num_compression_children[compression_parent] += 1
3293
self._num_compression_children[compression_parent] = 1
2923
self._compression_children.setdefault(compression_parent,
2926
for parent in parents:
2927
self._annotate_children.setdefault(parent,
2929
num_gens = generation - kept_generation
2930
if ((num_gens >= self._generations_until_keep)
2931
and len(parents) > 1):
2932
kept_generation = generation
2933
self._nodes_to_keep_annotations.add(rev_id)
3295
2935
missing_versions = this_iteration.difference(build_details.keys())
3296
if missing_versions:
3297
for key in missing_versions:
3298
if key in self._parent_map and key in self._text_cache:
3299
# We already have this text ready, we just need to
3300
# yield it later so we get it annotated
3302
parent_keys = self._parent_map[key]
3303
for parent_key in parent_keys:
3304
if parent_key in self._num_needed_children:
3305
self._num_needed_children[parent_key] += 1
3307
self._num_needed_children[parent_key] = 1
3308
pending.update([p for p in parent_keys
3309
if p not in self._all_build_details])
3311
raise errors.RevisionNotPresent(key, self._vf)
2936
self._ghosts.update(missing_versions)
2937
for missing_version in missing_versions:
2938
# add a key, no parents
2939
self._revision_id_graph[missing_version] = ()
2940
pending.discard(missing_version) # don't look for it
2941
# XXX: This should probably be a real exception, as it is a data
2943
assert not self._ghosts.intersection(self._compression_children), \
2944
"We cannot have nodes which have a compression parent of a ghost."
2945
# Cleanout anything that depends on a ghost so that we don't wait for
2946
# the ghost to show up
2947
for node in self._ghosts:
2948
if node in self._annotate_children:
2949
# We won't be building this node
2950
del self._annotate_children[node]
3312
2951
# Generally we will want to read the records in reverse order, because
3313
2952
# we find the parent nodes after the children
3314
2953
records.reverse()
3315
return records, ann_keys
3317
def _get_needed_texts(self, key, pb=None):
3318
# if True or len(self._vf._immediate_fallback_vfs) > 0:
3319
if len(self._vf._immediate_fallback_vfs) > 0:
3320
# If we have fallbacks, go to the generic path
3321
for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3326
records, ann_keys = self._get_build_graph(key)
3327
for idx, (sub_key, text, num_lines) in enumerate(
3328
self._extract_texts(records)):
3330
pb.update(gettext('annotating'), idx, len(records))
3331
yield sub_key, text, num_lines
3332
for sub_key in ann_keys:
3333
text = self._text_cache[sub_key]
3334
num_lines = len(text) # bad assumption
3335
yield sub_key, text, num_lines
3337
except errors.RetryWithNewPacks, e:
3338
self._vf._access.reload_or_raise(e)
3339
# The cached build_details are no longer valid
3340
self._all_build_details.clear()
3342
def _cache_delta_blocks(self, key, compression_parent, delta, lines):
3343
parent_lines = self._text_cache[compression_parent]
3344
blocks = list(KnitContent.get_line_delta_blocks(delta, parent_lines, lines))
3345
self._matching_blocks[(key, compression_parent)] = blocks
3347
def _expand_record(self, key, parent_keys, compression_parent, record,
3350
if compression_parent:
3351
if compression_parent not in self._content_objects:
3352
# Waiting for the parent
3353
self._pending_deltas.setdefault(compression_parent, []).append(
3354
(key, parent_keys, record, record_details))
3356
# We have the basis parent, so expand the delta
3357
num = self._num_compression_children[compression_parent]
3360
base_content = self._content_objects.pop(compression_parent)
3361
self._num_compression_children.pop(compression_parent)
3363
self._num_compression_children[compression_parent] = num
3364
base_content = self._content_objects[compression_parent]
3365
# It is tempting to want to copy_base_content=False for the last
3366
# child object. However, whenever noeol=False,
3367
# self._text_cache[parent_key] is content._lines. So mutating it
3368
# gives very bad results.
3369
# The alternative is to copy the lines into text cache, but then we
3370
# are copying anyway, so just do it here.
3371
content, delta = self._vf._factory.parse_record(
3372
key, record, record_details, base_content,
3373
copy_base_content=True)
3376
content, _ = self._vf._factory.parse_record(
3377
key, record, record_details, None)
3378
if self._num_compression_children.get(key, 0) > 0:
3379
self._content_objects[key] = content
3380
lines = content.text()
3381
self._text_cache[key] = lines
3382
if delta is not None:
3383
self._cache_delta_blocks(key, compression_parent, delta, lines)
3386
def _get_parent_annotations_and_matches(self, key, text, parent_key):
3387
"""Get the list of annotations for the parent, and the matching lines.
3389
:param text: The opaque value given by _get_needed_texts
3390
:param parent_key: The key for the parent text
3391
:return: (parent_annotations, matching_blocks)
3392
parent_annotations is a list as long as the number of lines in
3394
matching_blocks is a list of (parent_idx, text_idx, len) tuples
3395
indicating which lines match between the two texts
3397
block_key = (key, parent_key)
3398
if block_key in self._matching_blocks:
3399
blocks = self._matching_blocks.pop(block_key)
3400
parent_annotations = self._annotations_cache[parent_key]
3401
return parent_annotations, blocks
3402
return annotate.Annotator._get_parent_annotations_and_matches(self,
3403
key, text, parent_key)
3405
def _process_pending(self, key):
3406
"""The content for 'key' was just processed.
3408
Determine if there is any more pending work to be processed.
3411
if key in self._pending_deltas:
3412
compression_parent = key
3413
children = self._pending_deltas.pop(key)
3414
for child_key, parent_keys, record, record_details in children:
3415
lines = self._expand_record(child_key, parent_keys,
3417
record, record_details)
3418
if self._check_ready_for_annotations(child_key, parent_keys):
3419
to_return.append(child_key)
3420
# Also check any children that are waiting for this parent to be
3422
if key in self._pending_annotation:
3423
children = self._pending_annotation.pop(key)
3424
to_return.extend([c for c, p_keys in children
3425
if self._check_ready_for_annotations(c, p_keys)])
3428
def _check_ready_for_annotations(self, key, parent_keys):
3429
"""return true if this text is ready to be yielded.
3431
Otherwise, this will return False, and queue the text into
3432
self._pending_annotation
3434
for parent_key in parent_keys:
3435
if parent_key not in self._annotations_cache:
3436
# still waiting on at least one parent text, so queue it up
3437
# Note that if there are multiple parents, we need to wait
3439
self._pending_annotation.setdefault(parent_key,
3440
[]).append((key, parent_keys))
3444
def _extract_texts(self, records):
3445
"""Extract the various texts needed based on records"""
2956
def _annotate_records(self, records):
2957
"""Build the annotations for the listed records."""
3446
2958
# We iterate in the order read, rather than a strict order requested
3447
2959
# However, process what we can, and put off to the side things that
3448
2960
# still need parents, cleaning them up when those parents are
3451
# 1) As 'records' are read, see if we can expand these records into
3452
# Content objects (and thus lines)
3453
# 2) If a given line-delta is waiting on its compression parent, it
3454
# gets queued up into self._pending_deltas, otherwise we expand
3455
# it, and put it into self._text_cache and self._content_objects
3456
# 3) If we expanded the text, we will then check to see if all
3457
# parents have also been processed. If so, this text gets yielded,
3458
# else this record gets set aside into pending_annotation
3459
# 4) Further, if we expanded the text in (2), we will then check to
3460
# see if there are any children in self._pending_deltas waiting to
3461
# also be processed. If so, we go back to (2) for those
3462
# 5) Further again, if we yielded the text, we can then check if that
3463
# 'unlocks' any of the texts in pending_annotations, which should
3464
# then get yielded as well
3465
# Note that both steps 4 and 5 are 'recursive' in that unlocking one
3466
# compression child could unlock yet another, and yielding a fulltext
3467
# will also 'unlock' the children that are waiting on that annotation.
3468
# (Though also, unlocking 1 parent's fulltext, does not unlock a child
3469
# if other parents are also waiting.)
3470
# We want to yield content before expanding child content objects, so
3471
# that we know when we can re-use the content lines, and the annotation
3472
# code can know when it can stop caching fulltexts, as well.
3474
# Children that are missing their compression parent
3476
for (key, record, digest) in self._vf._read_records_iter(records):
3478
details = self._all_build_details[key]
3479
(_, compression_parent, parent_keys, record_details) = details
3480
lines = self._expand_record(key, parent_keys, compression_parent,
3481
record, record_details)
3483
# Pending delta should be queued up
2962
for (rev_id, record,
2963
digest) in self._knit._data.read_records_iter(records):
2964
if rev_id in self._annotated_lines:
3485
# At this point, we may be able to yield this content, if all
3486
# parents are also finished
3487
yield_this_text = self._check_ready_for_annotations(key,
3490
# All parents present
3491
yield key, lines, len(lines)
3492
to_process = self._process_pending(key)
3494
this_process = to_process
3496
for key in this_process:
3497
lines = self._text_cache[key]
3498
yield key, lines, len(lines)
3499
to_process.extend(self._process_pending(key))
2966
parent_ids = self._revision_id_graph[rev_id]
2967
parent_ids = [p for p in parent_ids if p not in self._ghosts]
2968
details = self._all_build_details[rev_id]
2969
(index_memo, compression_parent, parents,
2970
record_details) = details
2971
nodes_to_annotate = []
2972
# TODO: Remove the punning between compression parents, and
2973
# parent_ids, we should be able to do this without assuming
2975
if len(parent_ids) == 0:
2976
# There are no parents for this node, so just add it
2977
# TODO: This probably needs to be decoupled
2978
assert compression_parent is None
2979
fulltext_content, delta = self._knit.factory.parse_record(
2980
rev_id, record, record_details, None)
2981
fulltext = self._add_fulltext_content(rev_id, fulltext_content)
2982
nodes_to_annotate.extend(self._add_annotation(rev_id, fulltext,
2983
parent_ids, left_matching_blocks=None))
2985
child = (rev_id, parent_ids, record)
2986
# Check if all the parents are present
2987
self._check_parents(child, nodes_to_annotate)
2988
while nodes_to_annotate:
2989
# Should we use a queue here instead of a stack?
2990
(rev_id, parent_ids, record) = nodes_to_annotate.pop()
2991
(index_memo, compression_parent, parents,
2992
record_details) = self._all_build_details[rev_id]
2993
if compression_parent is not None:
2994
comp_children = self._compression_children[compression_parent]
2995
assert rev_id in comp_children
2996
# If there is only 1 child, it is safe to reuse this
2998
reuse_content = (len(comp_children) == 1
2999
and compression_parent not in
3000
self._nodes_to_keep_annotations)
3002
# Remove it from the cache since it will be changing
3003
parent_fulltext_content = self._fulltext_contents.pop(compression_parent)
3004
# Make sure to copy the fulltext since it might be
3006
parent_fulltext = list(parent_fulltext_content.text())
3008
parent_fulltext_content = self._fulltext_contents[compression_parent]
3009
parent_fulltext = parent_fulltext_content.text()
3010
comp_children.remove(rev_id)
3011
fulltext_content, delta = self._knit.factory.parse_record(
3012
rev_id, record, record_details,
3013
parent_fulltext_content,
3014
copy_base_content=(not reuse_content))
3015
fulltext = self._add_fulltext_content(rev_id,
3017
blocks = KnitContent.get_line_delta_blocks(delta,
3018
parent_fulltext, fulltext)
3020
fulltext_content = self._knit.factory.parse_fulltext(
3022
fulltext = self._add_fulltext_content(rev_id,
3025
nodes_to_annotate.extend(
3026
self._add_annotation(rev_id, fulltext, parent_ids,
3027
left_matching_blocks=blocks))
3029
def _get_heads_provider(self):
3030
"""Create a heads provider for resolving ancestry issues."""
3031
if self._heads_provider is not None:
3032
return self._heads_provider
3033
parent_provider = _mod_graph.DictParentsProvider(
3034
self._revision_id_graph)
3035
graph_obj = _mod_graph.Graph(parent_provider)
3036
head_cache = _mod_graph.FrozenHeadsCache(graph_obj)
3037
self._heads_provider = head_cache
3040
def annotate(self, revision_id):
3041
"""Return the annotated fulltext at the given revision.
3043
:param revision_id: The revision id for this file
3045
records = self._get_build_graph(revision_id)
3046
if revision_id in self._ghosts:
3047
raise errors.RevisionNotPresent(revision_id, self._knit)
3048
self._annotate_records(records)
3049
return self._annotated_lines[revision_id]
3502
from bzrlib._knit_load_data_pyx import _load_data_c as _load_data
3503
except ImportError, e:
3504
osutils.failed_to_load_extension(e)
3053
from bzrlib._knit_load_data_c import _load_data_c as _load_data
3505
3055
from bzrlib._knit_load_data_py import _load_data_py as _load_data
added
removed
bzrlib/knit.py
