17
17
"""Core compression logic for compressing streams of related files."""
19
from __future__ import absolute_import
24
from ..lazy_import import lazy_import
25
lazy_import(globals(), """
35
from breezy.bzr import (
41
from breezy.i18n import gettext
47
from .btree_index import BTreeBuilder
48
from ..lru_cache import LRUSizeCache
49
from ..sixish import (
55
from .versionedfile import (
37
from bzrlib.btree_index import BTreeBuilder
38
from bzrlib.lru_cache import LRUSizeCache
39
from bzrlib.tsort import topo_sort
40
from bzrlib.versionedfile import (
58
42
AbsentContentFactory,
59
43
ChunkedContentFactory,
60
44
FulltextContentFactory,
61
VersionedFilesWithFallbacks,
64
48
# Minimum number of uncompressed bytes to try fetch at once when retrieving
65
49
# groupcompress blocks.
68
# osutils.sha_string(b'')
69
_null_sha1 = b'da39a3ee5e6b4b0d3255bfef95601890afd80709'
52
_USE_LZMA = False and (pylzma is not None)
54
# osutils.sha_string('')
55
_null_sha1 = 'da39a3ee5e6b4b0d3255bfef95601890afd80709'
72
57
def sort_gc_optimal(parent_map):
73
58
"""Sort and group the keys in parent_map into groupcompress order.
94
79
for prefix in sorted(per_prefix_map):
95
present_keys.extend(reversed(tsort.topo_sort(per_prefix_map[prefix])))
80
present_keys.extend(reversed(topo_sort(per_prefix_map[prefix])))
96
81
return present_keys
99
class DecompressCorruption(errors.BzrError):
101
_fmt = "Corruption while decompressing repository file%(orig_error)s"
103
def __init__(self, orig_error=None):
104
if orig_error is not None:
105
self.orig_error = ", %s" % (orig_error,)
108
errors.BzrError.__init__(self)
111
84
# The max zlib window size is 32kB, so if we set 'max_size' output of the
112
85
# decompressor to the requested bytes + 32kB, then we should guarantee
113
86
# num_bytes coming out.
114
_ZLIB_DECOMP_WINDOW = 32 * 1024
87
_ZLIB_DECOMP_WINDOW = 32*1024
117
89
class GroupCompressBlock(object):
118
90
"""An object which maintains the internal structure of the compressed data.
160
132
# Expand the content if required
161
133
if self._content is None:
162
134
if self._content_chunks is not None:
163
self._content = b''.join(self._content_chunks)
135
self._content = ''.join(self._content_chunks)
164
136
self._content_chunks = None
165
137
if self._content is None:
166
# We join self._z_content_chunks here, because if we are
167
# decompressing, then it is *very* likely that we have a single
169
if self._z_content_chunks is None:
138
if self._z_content is None:
170
139
raise AssertionError('No content to decompress')
171
z_content = b''.join(self._z_content_chunks)
140
if self._z_content == '':
174
142
elif self._compressor_name == 'lzma':
175
143
# We don't do partial lzma decomp yet
177
self._content = pylzma.decompress(z_content)
144
self._content = pylzma.decompress(self._z_content)
178
145
elif self._compressor_name == 'zlib':
179
146
# Start a zlib decompressor
180
147
if num_bytes * 4 > self._content_length * 3:
181
148
# If we are requesting more that 3/4ths of the content,
182
149
# just extract the whole thing in a single pass
183
150
num_bytes = self._content_length
184
self._content = zlib.decompress(z_content)
151
self._content = zlib.decompress(self._z_content)
186
153
self._z_content_decompressor = zlib.decompressobj()
187
154
# Seed the decompressor with the uncompressed bytes, so
188
155
# that the rest of the code is simplified
189
156
self._content = self._z_content_decompressor.decompress(
190
z_content, num_bytes + _ZLIB_DECOMP_WINDOW)
157
self._z_content, num_bytes + _ZLIB_DECOMP_WINDOW)
191
158
if not self._z_content_decompressor.unconsumed_tail:
192
159
self._z_content_decompressor = None
230
197
# At present, we have 2 integers for the compressed and uncompressed
231
198
# content. In base10 (ascii) 14 bytes can represent > 1TB, so to avoid
232
199
# checking too far, cap the search to 14 bytes.
233
pos2 = data.index(b'\n', pos, pos + 14)
234
self._z_content_length = int(data[pos:pos2])
236
pos2 = data.index(b'\n', pos, pos + 14)
237
self._content_length = int(data[pos:pos2])
239
if len(data) != (pos + self._z_content_length):
200
pos2 = bytes.index('\n', pos, pos + 14)
201
self._z_content_length = int(bytes[pos:pos2])
203
pos2 = bytes.index('\n', pos, pos + 14)
204
self._content_length = int(bytes[pos:pos2])
206
if len(bytes) != (pos + self._z_content_length):
240
207
# XXX: Define some GCCorrupt error ?
241
208
raise AssertionError('Invalid bytes: (%d) != %d + %d' %
242
(len(data), pos, self._z_content_length))
243
self._z_content_chunks = (data[pos:],)
246
def _z_content(self):
247
"""Return z_content_chunks as a simple string.
249
Meant only to be used by the test suite.
251
if self._z_content_chunks is not None:
252
return b''.join(self._z_content_chunks)
209
(len(bytes), pos, self._z_content_length))
210
self._z_content = bytes[pos:]
256
213
def from_bytes(cls, bytes):
259
if header not in cls.GCB_KNOWN_HEADERS:
215
if bytes[:6] not in cls.GCB_KNOWN_HEADERS:
260
216
raise ValueError('bytes did not start with any of %r'
261
217
% (cls.GCB_KNOWN_HEADERS,))
262
if header == cls.GCB_HEADER:
218
# XXX: why not testing the whole header ?
263
220
out._compressor_name = 'zlib'
264
elif header == cls.GCB_LZ_HEADER:
221
elif bytes[4] == 'l':
265
222
out._compressor_name = 'lzma'
267
raise ValueError('unknown compressor: %r' % (header,))
224
raise ValueError('unknown compressor: %r' % (bytes,))
268
225
out._parse_bytes(bytes, 6)
276
233
:return: The bytes for the content
278
235
if start == end == 0:
280
237
self._ensure_content(end)
281
238
# The bytes are 'f' or 'd' for the type, then a variable-length
282
239
# base128 integer for the content size, then the actual content
283
240
# We know that the variable-length integer won't be longer than 5
284
241
# bytes (it takes 5 bytes to encode 2^32)
285
c = self._content[start:start + 1]
242
c = self._content[start]
287
244
type = 'fulltext'
290
247
raise ValueError('Unknown content control code: %s'
293
250
content_len, len_len = decode_base128_int(
294
self._content[start + 1:start + 6])
251
self._content[start + 1:start + 6])
295
252
content_start = start + 1 + len_len
296
253
if end != content_start + content_len:
297
254
raise ValueError('end != len according to field header'
298
' %s != %s' % (end, content_start + content_len))
300
return [self._content[content_start:end]]
301
# Must be type delta as checked above
302
return [apply_delta_to_source(self._content, content_start, end)]
255
' %s != %s' % (end, content_start + content_len))
257
bytes = self._content[content_start:end]
259
bytes = apply_delta_to_source(self._content, content_start, end)
304
262
def set_chunked_content(self, content_chunks, length):
305
263
"""Set the content of this block to the given chunks."""
311
269
self._content_length = length
312
270
self._content_chunks = content_chunks
313
271
self._content = None
314
self._z_content_chunks = None
272
self._z_content = None
316
274
def set_content(self, content):
317
275
"""Set the content of this block."""
318
276
self._content_length = len(content)
319
277
self._content = content
320
self._z_content_chunks = None
322
def _create_z_content_from_chunks(self, chunks):
278
self._z_content = None
280
def _create_z_content_using_lzma(self):
281
if self._content_chunks is not None:
282
self._content = ''.join(self._content_chunks)
283
self._content_chunks = None
284
if self._content is None:
285
raise AssertionError('Nothing to compress')
286
self._z_content = pylzma.compress(self._content)
287
self._z_content_length = len(self._z_content)
289
def _create_z_content_from_chunks(self):
323
290
compressor = zlib.compressobj(zlib.Z_DEFAULT_COMPRESSION)
324
# Peak in this point is 1 fulltext, 1 compressed text, + zlib overhead
325
# (measured peak is maybe 30MB over the above...)
326
compressed_chunks = list(map(compressor.compress, chunks))
291
compressed_chunks = map(compressor.compress, self._content_chunks)
327
292
compressed_chunks.append(compressor.flush())
328
# Ignore empty chunks
329
self._z_content_chunks = [c for c in compressed_chunks if c]
330
self._z_content_length = sum(map(len, self._z_content_chunks))
293
self._z_content = ''.join(compressed_chunks)
294
self._z_content_length = len(self._z_content)
332
296
def _create_z_content(self):
333
if self._z_content_chunks is not None:
297
if self._z_content is not None:
300
self._create_z_content_using_lzma()
335
302
if self._content_chunks is not None:
336
chunks = self._content_chunks
338
chunks = (self._content,)
339
self._create_z_content_from_chunks(chunks)
342
"""Create the byte stream as a series of 'chunks'"""
343
self._create_z_content()
344
header = self.GCB_HEADER
345
chunks = [b'%s%d\n%d\n'
346
% (header, self._z_content_length, self._content_length),
348
chunks.extend(self._z_content_chunks)
349
total_len = sum(map(len, chunks))
350
return total_len, chunks
303
self._create_z_content_from_chunks()
305
self._z_content = zlib.compress(self._content)
306
self._z_content_length = len(self._z_content)
352
308
def to_bytes(self):
353
309
"""Encode the information into a byte stream."""
354
total_len, chunks = self.to_chunks()
355
return b''.join(chunks)
310
self._create_z_content()
312
header = self.GCB_LZ_HEADER
314
header = self.GCB_HEADER
316
'%d\n%d\n' % (self._z_content_length, self._content_length),
319
return ''.join(chunks)
357
321
def _dump(self, include_text=False):
358
322
"""Take this block, and spit out a human-readable structure.
370
334
while pos < self._content_length:
371
kind = self._content[pos:pos + 1]
335
kind = self._content[pos]
373
if kind not in (b'f', b'd'):
337
if kind not in ('f', 'd'):
374
338
raise ValueError('invalid kind character: %r' % (kind,))
375
339
content_len, len_len = decode_base128_int(
376
self._content[pos:pos + 5])
340
self._content[pos:pos + 5])
378
342
if content_len + pos > self._content_length:
379
343
raise ValueError('invalid content_len %d for record @ pos %d'
380
344
% (content_len, pos - len_len - 1))
381
if kind == b'f': # Fulltext
345
if kind == 'f': # Fulltext
383
text = self._content[pos:pos + content_len]
384
result.append((b'f', content_len, text))
347
text = self._content[pos:pos+content_len]
348
result.append(('f', content_len, text))
386
result.append((b'f', content_len))
387
elif kind == b'd': # Delta
388
delta_content = self._content[pos:pos + content_len]
350
result.append(('f', content_len))
351
elif kind == 'd': # Delta
352
delta_content = self._content[pos:pos+content_len]
390
354
# The first entry in a delta is the decompressed length
391
355
decomp_len, delta_pos = decode_base128_int(delta_content)
392
result.append((b'd', content_len, decomp_len, delta_info))
356
result.append(('d', content_len, decomp_len, delta_info))
394
358
while delta_pos < content_len:
395
c = indexbytes(delta_content, delta_pos)
359
c = ord(delta_content[delta_pos])
399
363
delta_pos) = decode_copy_instruction(delta_content, c,
402
text = self._content[offset:offset + length]
403
delta_info.append((b'c', offset, length, text))
366
text = self._content[offset:offset+length]
367
delta_info.append(('c', offset, length, text))
405
delta_info.append((b'c', offset, length))
369
delta_info.append(('c', offset, length))
406
370
measured_len += length
409
txt = delta_content[delta_pos:delta_pos + c]
373
txt = delta_content[delta_pos:delta_pos+c]
412
delta_info.append((b'i', c, txt))
376
delta_info.append(('i', c, txt))
413
377
measured_len += c
415
379
if delta_pos != content_len:
459
422
def __repr__(self):
460
423
return '%s(%s, first=%s)' % (self.__class__.__name__,
461
self.key, self._first)
463
def _extract_bytes(self):
464
# Grab and cache the raw bytes for this entry
465
# and break the ref-cycle with _manager since we don't need it
468
self._manager._prepare_for_extract()
469
except zlib.error as value:
470
raise DecompressCorruption("zlib: " + str(value))
471
block = self._manager._block
472
self._chunks = block.extract(self.key, self._start, self._end)
473
# There are code paths that first extract as fulltext, and then
474
# extract as storage_kind (smart fetch). So we don't break the
475
# refcycle here, but instead in manager.get_record_stream()
424
self.key, self._first)
477
426
def get_bytes_as(self, storage_kind):
478
427
if storage_kind == self.storage_kind:
480
429
# wire bytes, something...
481
430
return self._manager._wire_bytes()
484
if storage_kind in ('fulltext', 'chunked', 'lines'):
485
if self._chunks is None:
486
self._extract_bytes()
433
if storage_kind in ('fulltext', 'chunked'):
434
if self._bytes is None:
435
# Grab and cache the raw bytes for this entry
436
# and break the ref-cycle with _manager since we don't need it
438
self._manager._prepare_for_extract()
439
block = self._manager._block
440
self._bytes = block.extract(self.key, self._start, self._end)
441
# There are code paths that first extract as fulltext, and then
442
# extract as storage_kind (smart fetch). So we don't break the
443
# refcycle here, but instead in manager.get_record_stream()
487
444
if storage_kind == 'fulltext':
488
return b''.join(self._chunks)
489
elif storage_kind == 'chunked':
492
return osutils.chunks_to_lines(self._chunks)
493
raise errors.UnavailableRepresentation(self.key, storage_kind,
496
def iter_bytes_as(self, storage_kind):
497
if self._chunks is None:
498
self._extract_bytes()
499
if storage_kind == 'chunked':
500
return iter(self._chunks)
501
elif storage_kind == 'lines':
502
return iter(osutils.chunks_to_lines(self._chunks))
503
448
raise errors.UnavailableRepresentation(self.key, storage_kind,
504
449
self.storage_kind)
507
452
class _LazyGroupContentManager(object):
508
453
"""This manages a group of _LazyGroupCompressFactory objects."""
510
_max_cut_fraction = 0.75 # We allow a block to be trimmed to 75% of
511
# current size, and still be considered
513
_full_block_size = 4 * 1024 * 1024
514
_full_mixed_block_size = 2 * 1024 * 1024
515
_full_enough_block_size = 3 * 1024 * 1024 # size at which we won't repack
516
_full_enough_mixed_block_size = 2 * 768 * 1024 # 1.5MB
455
_max_cut_fraction = 0.75 # We allow a block to be trimmed to 75% of
456
# current size, and still be considered
458
_full_block_size = 4*1024*1024
459
_full_mixed_block_size = 2*1024*1024
460
_full_enough_block_size = 3*1024*1024 # size at which we won't repack
461
_full_enough_mixed_block_size = 2*768*1024 # 1.5MB
518
def __init__(self, block, get_compressor_settings=None):
463
def __init__(self, block):
519
464
self._block = block
520
465
# We need to preserve the ordering
521
466
self._factories = []
522
467
self._last_byte = 0
523
self._get_settings = get_compressor_settings
524
self._compressor_settings = None
526
def _get_compressor_settings(self):
527
if self._compressor_settings is not None:
528
return self._compressor_settings
530
if self._get_settings is not None:
531
settings = self._get_settings()
533
vf = GroupCompressVersionedFiles
534
settings = vf._DEFAULT_COMPRESSOR_SETTINGS
535
self._compressor_settings = settings
536
return self._compressor_settings
538
469
def add_factory(self, key, parents, start, end):
539
470
if not self._factories:
572
503
new_block.set_content(self._block._content[:last_byte])
573
504
self._block = new_block
575
def _make_group_compressor(self):
576
return GroupCompressor(self._get_compressor_settings())
578
506
def _rebuild_block(self):
579
507
"""Create a new GroupCompressBlock with only the referenced texts."""
580
compressor = self._make_group_compressor()
508
compressor = GroupCompressor()
581
509
tstart = time.time()
582
510
old_length = self._block._content_length
584
512
for factory in self._factories:
585
chunks = factory.get_bytes_as('chunked')
586
chunks_len = factory.size
587
if chunks_len is None:
588
chunks_len = sum(map(len, chunks))
513
bytes = factory.get_bytes_as('fulltext')
589
514
(found_sha1, start_point, end_point,
590
type) = compressor.compress(
591
factory.key, chunks, chunks_len, factory.sha1)
515
type) = compressor.compress(factory.key, bytes, factory.sha1)
592
516
# Now update this factory with the new offsets, etc
593
517
factory.sha1 = found_sha1
594
518
factory._start = start_point
743
662
# 1 line for end byte
744
663
header_lines = []
745
664
for factory in self._factories:
746
key_bytes = b'\x00'.join(factory.key)
665
key_bytes = '\x00'.join(factory.key)
747
666
parents = factory.parents
748
667
if parents is None:
749
parent_bytes = b'None:'
668
parent_bytes = 'None:'
751
parent_bytes = b'\t'.join(b'\x00'.join(key) for key in parents)
752
record_header = b'%s\n%s\n%d\n%d\n' % (
670
parent_bytes = '\t'.join('\x00'.join(key) for key in parents)
671
record_header = '%s\n%s\n%d\n%d\n' % (
753
672
key_bytes, parent_bytes, factory._start, factory._end)
754
673
header_lines.append(record_header)
755
674
# TODO: Can we break the refcycle at this point and set
756
675
# factory._manager = None?
757
header_bytes = b''.join(header_lines)
676
header_bytes = ''.join(header_lines)
759
678
header_bytes_len = len(header_bytes)
760
679
z_header_bytes = zlib.compress(header_bytes)
762
681
z_header_bytes_len = len(z_header_bytes)
763
block_bytes_len, block_chunks = self._block.to_chunks()
764
lines.append(b'%d\n%d\n%d\n' % (
765
z_header_bytes_len, header_bytes_len, block_bytes_len))
682
block_bytes = self._block.to_bytes()
683
lines.append('%d\n%d\n%d\n' % (z_header_bytes_len, header_bytes_len,
766
685
lines.append(z_header_bytes)
767
lines.extend(block_chunks)
768
del z_header_bytes, block_chunks
769
# TODO: This is a point where we will double the memory consumption. To
770
# avoid this, we probably have to switch to a 'chunked' api
771
return b''.join(lines)
686
lines.append(block_bytes)
687
del z_header_bytes, block_bytes
688
return ''.join(lines)
774
691
def from_bytes(cls, bytes):
775
692
# TODO: This does extra string copying, probably better to do it a
776
# different way. At a minimum this creates 2 copies of the
778
694
(storage_kind, z_header_len, header_len,
779
block_len, rest) = bytes.split(b'\n', 4)
695
block_len, rest) = bytes.split('\n', 4)
781
if storage_kind != b'groupcompress-block':
697
if storage_kind != 'groupcompress-block':
782
698
raise ValueError('Unknown storage kind: %s' % (storage_kind,))
783
699
z_header_len = int(z_header_len)
784
700
if len(rest) < z_header_len:
807
723
block = GroupCompressBlock.from_bytes(block_bytes)
809
725
result = cls(block)
810
for start in range(0, len(header_lines), 4):
726
for start in xrange(0, len(header_lines), 4):
812
key = tuple(header_lines[start].split(b'\x00'))
813
parents_line = header_lines[start + 1]
814
if parents_line == b'None:':
728
key = tuple(header_lines[start].split('\x00'))
729
parents_line = header_lines[start+1]
730
if parents_line == 'None:':
817
parents = tuple([tuple(segment.split(b'\x00'))
818
for segment in parents_line.split(b'\t')
820
start_offset = int(header_lines[start + 2])
821
end_offset = int(header_lines[start + 3])
733
parents = tuple([tuple(segment.split('\x00'))
734
for segment in parents_line.split('\t')
736
start_offset = int(header_lines[start+2])
737
end_offset = int(header_lines[start+3])
822
738
result.add_factory(key, parents, start_offset, end_offset)
833
749
class _CommonGroupCompressor(object):
835
def __init__(self, settings=None):
836
752
"""Create a GroupCompressor."""
838
754
self._last = None
839
755
self.endpoint = 0
840
756
self.input_bytes = 0
841
757
self.labels_deltas = {}
842
self._delta_index = None # Set by the children
758
self._delta_index = None # Set by the children
843
759
self._block = GroupCompressBlock()
847
self._settings = settings
849
def compress(self, key, chunks, length, expected_sha, nostore_sha=None,
761
def compress(self, key, bytes, expected_sha, nostore_sha=None, soft=False):
851
762
"""Compress lines with label key.
853
764
:param key: A key tuple. It is stored in the output
854
765
for identification of the text during decompression. If the last
855
element is b'None' it is replaced with the sha1 of the text -
766
element is 'None' it is replaced with the sha1 of the text -
856
767
e.g. sha1:xxxxxxx.
857
:param chunks: Chunks of bytes to be compressed
858
:param length: Length of chunks
768
:param bytes: The bytes to be compressed
859
769
:param expected_sha: If non-None, the sha the lines are believed to
860
770
have. During compression the sha is calculated; a mismatch will
877
787
if expected_sha is not None:
878
788
sha1 = expected_sha
880
sha1 = osutils.sha_strings(chunks)
790
sha1 = osutils.sha_string(bytes)
881
791
if nostore_sha is not None:
882
792
if sha1 == nostore_sha:
883
793
raise errors.ExistingContent()
884
794
if key[-1] is None:
885
key = key[:-1] + (b'sha1:' + sha1,)
795
key = key[:-1] + ('sha1:' + sha1,)
887
start, end, type = self._compress(key, chunks, length, length / 2, soft)
797
start, end, type = self._compress(key, bytes, len(bytes) / 2, soft)
888
798
return sha1, start, end, type
890
def _compress(self, key, chunks, input_len, max_delta_size, soft=False):
800
def _compress(self, key, bytes, max_delta_size, soft=False):
891
801
"""Compress lines with label key.
893
803
:param key: A key tuple. It is stored in the output for identification
894
804
of the text during decompression.
896
:param chunks: The chunks of bytes to be compressed
898
:param input_len: The length of the chunks
806
:param bytes: The bytes to be compressed
900
808
:param max_delta_size: The size above which we issue a fulltext instead
912
820
"""Extract a key previously added to the compressor.
914
822
:param key: The key to extract.
915
:return: An iterable over chunks and the sha1.
823
:return: An iterable over bytes and the sha1.
917
(start_byte, start_chunk, end_byte,
918
end_chunk) = self.labels_deltas[key]
825
(start_byte, start_chunk, end_byte, end_chunk) = self.labels_deltas[key]
919
826
delta_chunks = self.chunks[start_chunk:end_chunk]
920
stored_bytes = b''.join(delta_chunks)
921
kind = stored_bytes[:1]
827
stored_bytes = ''.join(delta_chunks)
828
if stored_bytes[0] == 'f':
923
829
fulltext_len, offset = decode_base128_int(stored_bytes[1:10])
924
830
data_len = fulltext_len + 1 + offset
925
if data_len != len(stored_bytes):
831
if data_len != len(stored_bytes):
926
832
raise ValueError('Index claimed fulltext len, but stored bytes'
927
833
' claim %s != %s'
928
834
% (len(stored_bytes), data_len))
929
data = [stored_bytes[offset + 1:]]
835
bytes = stored_bytes[offset + 1:]
932
raise ValueError('Unknown content kind, bytes claim %s' % kind)
933
837
# XXX: This is inefficient at best
934
source = b''.join(self.chunks[:start_chunk])
838
source = ''.join(self.chunks[:start_chunk])
839
if stored_bytes[0] != 'd':
840
raise ValueError('Unknown content kind, bytes claim %s'
841
% (stored_bytes[0],))
935
842
delta_len, offset = decode_base128_int(stored_bytes[1:10])
936
843
data_len = delta_len + 1 + offset
937
844
if data_len != len(stored_bytes):
938
845
raise ValueError('Index claimed delta len, but stored bytes'
939
846
' claim %s != %s'
940
847
% (len(stored_bytes), data_len))
941
data = [apply_delta(source, stored_bytes[offset + 1:])]
942
data_sha1 = osutils.sha_strings(data)
943
return data, data_sha1
848
bytes = apply_delta(source, stored_bytes[offset + 1:])
849
bytes_sha1 = osutils.sha_string(bytes)
850
return bytes, bytes_sha1
946
853
"""Finish this group, creating a formatted stream.
948
855
After calling this, the compressor should no longer be used
857
# TODO: this causes us to 'bloat' to 2x the size of content in the
858
# group. This has an impact for 'commit' of large objects.
859
# One possibility is to use self._content_chunks, and be lazy and
860
# only fill out self._content as a full string when we actually
861
# need it. That would at least drop the peak memory consumption
862
# for 'commit' down to ~1x the size of the largest file, at a
863
# cost of increased complexity within this code. 2x is still <<
864
# 3x the size of the largest file, so we are doing ok.
950
865
self._block.set_chunked_content(self.chunks, self.endpoint)
951
866
self.chunks = None
952
867
self._delta_index = None
971
886
class PythonGroupCompressor(_CommonGroupCompressor):
973
def __init__(self, settings=None):
974
889
"""Create a GroupCompressor.
976
891
Used only if the pyrex version is not available.
978
super(PythonGroupCompressor, self).__init__(settings)
893
super(PythonGroupCompressor, self).__init__()
979
894
self._delta_index = LinesDeltaIndex([])
980
895
# The actual content is managed by LinesDeltaIndex
981
896
self.chunks = self._delta_index.lines
983
def _compress(self, key, chunks, input_len, max_delta_size, soft=False):
898
def _compress(self, key, bytes, max_delta_size, soft=False):
984
899
"""see _CommonGroupCompressor._compress"""
985
new_lines = osutils.chunks_to_lines(chunks)
900
input_len = len(bytes)
901
new_lines = osutils.split_lines(bytes)
986
902
out_lines, index_lines = self._delta_index.make_delta(
987
903
new_lines, bytes_length=input_len, soft=soft)
988
904
delta_length = sum(map(len, out_lines))
989
905
if delta_length > max_delta_size:
990
906
# The delta is longer than the fulltext, insert a fulltext
991
907
type = 'fulltext'
992
out_lines = [b'f', encode_base128_int(input_len)]
908
out_lines = ['f', encode_base128_int(input_len)]
993
909
out_lines.extend(new_lines)
994
910
index_lines = [False, False]
995
911
index_lines.extend([True] * len(new_lines))
997
913
# this is a worthy delta, output it
1000
916
# Update the delta_length to include those two encoded integers
1001
917
out_lines[1] = encode_base128_int(delta_length)
1002
918
# Before insertion
1018
934
It contains code very similar to SequenceMatcher because of having a similar
1019
935
task. However some key differences apply:
1021
* there is no junk, we want a minimal edit not a human readable diff.
1022
* we don't filter very common lines (because we don't know where a good
1023
range will start, and after the first text we want to be emitting minmal
1025
* we chain the left side, not the right side
1026
* we incrementally update the adjacency matrix as new lines are provided.
1027
* we look for matches in all of the left side, so the routine which does
1028
the analagous task of find_longest_match does not need to filter on the
936
- there is no junk, we want a minimal edit not a human readable diff.
937
- we don't filter very common lines (because we don't know where a good
938
range will start, and after the first text we want to be emitting minmal
940
- we chain the left side, not the right side
941
- we incrementally update the adjacency matrix as new lines are provided.
942
- we look for matches in all of the left side, so the routine which does
943
the analagous task of find_longest_match does not need to filter on the
1032
def __init__(self, settings=None):
1033
super(PyrexGroupCompressor, self).__init__(settings)
1034
max_bytes_to_index = self._settings.get('max_bytes_to_index', 0)
1035
self._delta_index = DeltaIndex(max_bytes_to_index=max_bytes_to_index)
948
super(PyrexGroupCompressor, self).__init__()
949
self._delta_index = DeltaIndex()
1037
def _compress(self, key, chunks, input_len, max_delta_size, soft=False):
951
def _compress(self, key, bytes, max_delta_size, soft=False):
1038
952
"""see _CommonGroupCompressor._compress"""
953
input_len = len(bytes)
1039
954
# By having action/label/sha1/len, we can parse the group if the index
1040
955
# was ever destroyed, we have the key in 'label', we know the final
1041
956
# bytes are valid from sha1, and we know where to find the end of this
1047
962
# new_chunks = ['label:%s\nsha1:%s\n' % (label, sha1)]
1048
963
if self._delta_index._source_offset != self.endpoint:
1049
964
raise AssertionError('_source_offset != endpoint'
1050
' somehow the DeltaIndex got out of sync with'
1051
' the output lines')
1052
bytes = b''.join(chunks)
965
' somehow the DeltaIndex got out of sync with'
1053
967
delta = self._delta_index.make_delta(bytes, max_delta_size)
1055
969
type = 'fulltext'
1056
enc_length = encode_base128_int(input_len)
970
enc_length = encode_base128_int(len(bytes))
1057
971
len_mini_header = 1 + len(enc_length)
1058
972
self._delta_index.add_source(bytes, len_mini_header)
1059
new_chunks = [b'f', enc_length] + chunks
973
new_chunks = ['f', enc_length, bytes]
1062
976
enc_length = encode_base128_int(len(delta))
1063
977
len_mini_header = 1 + len(enc_length)
1064
new_chunks = [b'd', enc_length, delta]
978
new_chunks = ['d', enc_length, delta]
1065
979
self._delta_index.add_delta_source(delta, len_mini_header)
1066
980
# Before insertion
1067
981
start = self.endpoint
1108
1022
graph_index = BTreeBuilder(reference_lists=ref_length,
1109
key_elements=keylength)
1023
key_elements=keylength)
1110
1024
stream = transport.open_write_stream('newpack')
1111
1025
writer = pack.ContainerWriter(stream.write)
1113
index = _GCGraphIndex(graph_index, lambda: True, parents=parents,
1114
add_callback=graph_index.add_nodes,
1115
inconsistency_fatal=inconsistency_fatal)
1116
access = pack_repo._DirectPackAccess({})
1027
index = _GCGraphIndex(graph_index, lambda:True, parents=parents,
1028
add_callback=graph_index.add_nodes,
1029
inconsistency_fatal=inconsistency_fatal)
1030
access = knit._DirectPackAccess({})
1117
1031
access.set_writer(writer, graph_index, (transport, 'newpack'))
1118
1032
result = GroupCompressVersionedFiles(index, access, delta)
1119
1033
result.stream = stream
1237
1149
self.total_bytes = 0
1240
class GroupCompressVersionedFiles(VersionedFilesWithFallbacks):
1152
class GroupCompressVersionedFiles(VersionedFiles):
1241
1153
"""A group-compress based VersionedFiles implementation."""
1243
# This controls how the GroupCompress DeltaIndex works. Basically, we
1244
# compute hash pointers into the source blocks (so hash(text) => text).
1245
# However each of these references costs some memory in trade against a
1246
# more accurate match result. For very large files, they either are
1247
# pre-compressed and change in bulk whenever they change, or change in just
1248
# local blocks. Either way, 'improved resolution' is not very helpful,
1249
# versus running out of memory trying to track everything. The default max
1250
# gives 100% sampling of a 1MB file.
1251
_DEFAULT_MAX_BYTES_TO_INDEX = 1024 * 1024
1252
_DEFAULT_COMPRESSOR_SETTINGS = {'max_bytes_to_index':
1253
_DEFAULT_MAX_BYTES_TO_INDEX}
1255
def __init__(self, index, access, delta=True, _unadded_refs=None,
1155
def __init__(self, index, access, delta=True, _unadded_refs=None):
1257
1156
"""Create a GroupCompressVersionedFiles object.
1259
1158
:param index: The index object storing access and graph data.
1260
1159
:param access: The access object storing raw data.
1261
1160
:param delta: Whether to delta compress or just entropy compress.
1262
1161
:param _unadded_refs: private parameter, don't use.
1263
:param _group_cache: private parameter, don't use.
1265
1163
self._index = index
1266
1164
self._access = access
1268
1166
if _unadded_refs is None:
1269
1167
_unadded_refs = {}
1270
1168
self._unadded_refs = _unadded_refs
1271
if _group_cache is None:
1272
_group_cache = LRUSizeCache(max_size=50 * 1024 * 1024)
1273
self._group_cache = _group_cache
1274
self._immediate_fallback_vfs = []
1275
self._max_bytes_to_index = None
1169
self._group_cache = LRUSizeCache(max_size=50*1024*1024)
1170
self._fallback_vfs = []
1277
1172
def without_fallbacks(self):
1278
1173
"""Return a clone of this object without any fallbacks configured."""
1279
1174
return GroupCompressVersionedFiles(self._index, self._access,
1280
self._delta, _unadded_refs=dict(
1281
self._unadded_refs),
1282
_group_cache=self._group_cache)
1175
self._delta, _unadded_refs=dict(self._unadded_refs))
1284
1177
def add_lines(self, key, parents, lines, parent_texts=None,
1285
left_matching_blocks=None, nostore_sha=None, random_id=False,
1286
check_content=True):
1178
left_matching_blocks=None, nostore_sha=None, random_id=False,
1179
check_content=True):
1287
1180
"""Add a text to the store.
1289
1182
:param key: The key tuple of the text to add.
1290
1183
:param parents: The parents key tuples of the text to add.
1291
1184
:param lines: A list of lines. Each line must be a bytestring. And all
1292
of them except the last must be terminated with \\n and contain no
1293
other \\n's. The last line may either contain no \\n's or a single
1294
terminating \\n. If the lines list does meet this constraint the
1295
add routine may error or may succeed - but you will be unable to
1296
read the data back accurately. (Checking the lines have been split
1185
of them except the last must be terminated with \n and contain no
1186
other \n's. The last line may either contain no \n's or a single
1187
terminating \n. If the lines list does meet this constraint the add
1188
routine may error or may succeed - but you will be unable to read
1189
the data back accurately. (Checking the lines have been split
1297
1190
correctly is expensive and extremely unlikely to catch bugs so it
1298
1191
is not done at runtime unless check_content is True.)
1299
1192
:param parent_texts: An optional dictionary containing the opaque
1318
1211
back to future add_lines calls in the parent_texts dictionary.
1320
1213
self._index._check_write_ok()
1322
self._check_lines_not_unicode(lines)
1323
self._check_lines_are_lines(lines)
1324
return self.add_content(
1325
ChunkedContentFactory(
1326
key, parents, osutils.sha_strings(lines), lines, chunks_are_lines=True),
1327
parent_texts, left_matching_blocks, nostore_sha, random_id)
1329
def add_content(self, factory, parent_texts=None,
1330
left_matching_blocks=None, nostore_sha=None,
1332
"""Add a text to the store.
1334
:param factory: A ContentFactory that can be used to retrieve the key,
1335
parents and contents.
1336
:param parent_texts: An optional dictionary containing the opaque
1337
representations of some or all of the parents of version_id to
1338
allow delta optimisations. VERY IMPORTANT: the texts must be those
1339
returned by add_lines or data corruption can be caused.
1340
:param left_matching_blocks: a hint about which areas are common
1341
between the text and its left-hand-parent. The format is
1342
the SequenceMatcher.get_matching_blocks format.
1343
:param nostore_sha: Raise ExistingContent and do not add the lines to
1344
the versioned file if the digest of the lines matches this.
1345
:param random_id: If True a random id has been selected rather than
1346
an id determined by some deterministic process such as a converter
1347
from a foreign VCS. When True the backend may choose not to check
1348
for uniqueness of the resulting key within the versioned file, so
1349
this should only be done when the result is expected to be unique
1351
:return: The text sha1, the number of bytes in the text, and an opaque
1352
representation of the inserted version which can be provided
1353
back to future add_lines calls in the parent_texts dictionary.
1214
self._check_add(key, lines, random_id, check_content)
1216
# The caller might pass None if there is no graph data, but kndx
1217
# indexes can't directly store that, so we give them
1218
# an empty tuple instead.
1220
# double handling for now. Make it work until then.
1221
length = sum(map(len, lines))
1222
record = ChunkedContentFactory(key, parents, None, lines)
1223
sha1 = list(self._insert_record_stream([record], random_id=random_id,
1224
nostore_sha=nostore_sha))[0]
1225
return sha1, length, None
1227
def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
1228
"""See VersionedFiles._add_text()."""
1355
1229
self._index._check_write_ok()
1356
parents = factory.parents
1357
self._check_add(factory.key, random_id)
1230
self._check_add(key, None, random_id, check_content=False)
1231
if text.__class__ is not str:
1232
raise errors.BzrBadParameterUnicode("text")
1358
1233
if parents is None:
1359
1234
# The caller might pass None if there is no graph data, but kndx
1360
1235
# indexes can't directly store that, so we give them
1361
1236
# an empty tuple instead.
1363
1238
# double handling for now. Make it work until then.
1364
sha1, length = list(self._insert_record_stream(
1365
[factory], random_id=random_id, nostore_sha=nostore_sha))[0]
1240
record = FulltextContentFactory(key, parents, None, text)
1241
sha1 = list(self._insert_record_stream([record], random_id=random_id,
1242
nostore_sha=nostore_sha))[0]
1366
1243
return sha1, length, None
1368
1245
def add_fallback_versioned_files(self, a_versioned_files):
1407
1283
# probably check that the existing content is identical to what is
1408
1284
# being inserted, and otherwise raise an exception. This would make
1409
1285
# the bundle code simpler.
1287
self._check_lines_not_unicode(lines)
1288
self._check_lines_are_lines(lines)
1290
def get_known_graph_ancestry(self, keys):
1291
"""Get a KnownGraph instance with the ancestry of keys."""
1292
# Note that this is identical to
1293
# KnitVersionedFiles.get_known_graph_ancestry, but they don't share
1295
parent_map, missing_keys = self._index.find_ancestry(keys)
1296
for fallback in self._fallback_vfs:
1297
if not missing_keys:
1299
(f_parent_map, f_missing_keys) = fallback._index.find_ancestry(
1301
parent_map.update(f_parent_map)
1302
missing_keys = f_missing_keys
1303
kg = _mod_graph.KnownGraph(parent_map)
1411
1306
def get_parent_map(self, keys):
1412
1307
"""Get a map of the graph parents of keys.
1640
1534
key_to_source_map)
1641
1535
elif ordering == 'as-requested':
1642
1536
source_keys = self._get_as_requested_source_keys(orig_keys,
1643
locations, unadded_keys, key_to_source_map)
1537
locations, unadded_keys, key_to_source_map)
1645
1539
# We want to yield the keys in a semi-optimal (read-wise) ordering.
1646
1540
# Otherwise we thrash the _group_cache and destroy performance
1647
1541
source_keys = self._get_io_ordered_source_keys(locations,
1648
unadded_keys, source_result)
1542
unadded_keys, source_result)
1649
1543
for key in missing:
1650
1544
yield AbsentContentFactory(key)
1651
1545
# Batch up as many keys as we can until either:
1652
1546
# - we encounter an unadded ref, or
1653
1547
# - we run out of keys, or
1654
1548
# - the total bytes to retrieve for this batch > BATCH_SIZE
1655
batcher = _BatchingBlockFetcher(self, locations,
1656
get_compressor_settings=self._get_compressor_settings)
1549
batcher = _BatchingBlockFetcher(self, locations)
1657
1550
for source, keys in source_keys:
1658
1551
if source is self:
1659
1552
for key in keys:
1702
1595
# test_insert_record_stream_existing_keys fail for groupcompress and
1703
1596
# groupcompress-nograph, this needs to be revisited while addressing
1704
1597
# 'bzr branch' performance issues.
1705
for _, _ in self._insert_record_stream(stream, random_id=False):
1598
for _ in self._insert_record_stream(stream, random_id=False):
1708
def _get_compressor_settings(self):
1709
if self._max_bytes_to_index is None:
1710
# TODO: VersionedFiles don't know about their containing
1711
# repository, so they don't have much of an idea about their
1712
# location. So for now, this is only a global option.
1713
c = config.GlobalConfig()
1714
val = c.get_user_option('bzr.groupcompress.max_bytes_to_index')
1718
except ValueError as e:
1719
trace.warning('Value for '
1720
'"bzr.groupcompress.max_bytes_to_index"'
1721
' %r is not an integer'
1725
val = self._DEFAULT_MAX_BYTES_TO_INDEX
1726
self._max_bytes_to_index = val
1727
return {'max_bytes_to_index': self._max_bytes_to_index}
1729
def _make_group_compressor(self):
1730
return GroupCompressor(self._get_compressor_settings())
1732
1601
def _insert_record_stream(self, stream, random_id=False, nostore_sha=None,
1733
1602
reuse_blocks=True):
1734
1603
"""Internal core to insert a record stream into this container.
1759
1627
# This will go up to fulltexts for gc to gc fetching, which isn't
1761
self._compressor = self._make_group_compressor()
1629
self._compressor = GroupCompressor()
1762
1630
self._unadded_refs = {}
1763
1631
keys_to_add = []
1766
bytes_len, chunks = self._compressor.flush().to_chunks()
1767
self._compressor = self._make_group_compressor()
1768
# Note: At this point we still have 1 copy of the fulltext (in
1769
# record and the var 'bytes'), and this generates 2 copies of
1770
# the compressed text (one for bytes, one in chunks)
1771
# TODO: Figure out how to indicate that we would be happy to free
1772
# the fulltext content at this point. Note that sometimes we
1773
# will want it later (streaming CHK pages), but most of the
1774
# time we won't (everything else)
1775
index, start, length = self._access.add_raw_record(
1776
None, bytes_len, chunks)
1633
bytes = self._compressor.flush().to_bytes()
1634
self._compressor = GroupCompressor()
1635
index, start, length = self._access.add_raw_records(
1636
[(None, len(bytes))], bytes)[0]
1778
1638
for key, reads, refs in keys_to_add:
1779
nodes.append((key, b"%d %d %s" % (start, length, reads), refs))
1639
nodes.append((key, "%d %d %s" % (start, length, reads), refs))
1780
1640
self._index.add_records(nodes, random_id=random_id)
1781
1641
self._unadded_refs = {}
1782
1642
del keys_to_add[:]
1828
1689
raise AssertionError('No insert_manager set')
1829
1690
if insert_manager is not record._manager:
1830
1691
raise AssertionError('insert_manager does not match'
1831
' the current record, we cannot be positive'
1832
' that the appropriate content was inserted.'
1834
value = b"%d %d %d %d" % (block_start, block_length,
1835
record._start, record._end)
1692
' the current record, we cannot be positive'
1693
' that the appropriate content was inserted.'
1695
value = "%d %d %d %d" % (block_start, block_length,
1696
record._start, record._end)
1836
1697
nodes = [(record.key, value, (record.parents,))]
1837
1698
# TODO: Consider buffering up many nodes to be added, not
1838
1699
# sure how much overhead this has, but we're seeing
1840
1701
self._index.add_records(nodes, random_id=random_id)
1843
chunks = record.get_bytes_as('chunked')
1704
bytes = record.get_bytes_as('fulltext')
1844
1705
except errors.UnavailableRepresentation:
1845
adapter_key = record.storage_kind, 'chunked'
1706
adapter_key = record.storage_kind, 'fulltext'
1846
1707
adapter = get_adapter(adapter_key)
1847
chunks = adapter.get_bytes(record, 'chunked')
1848
chunks_len = record.size
1849
if chunks_len is None:
1850
chunks_len = sum(map(len, chunks))
1708
bytes = adapter.get_bytes(record)
1851
1709
if len(record.key) > 1:
1852
1710
prefix = record.key[0]
1853
1711
soft = (prefix == last_prefix)
1857
if max_fulltext_len < chunks_len:
1858
max_fulltext_len = chunks_len
1715
if max_fulltext_len < len(bytes):
1716
max_fulltext_len = len(bytes)
1859
1717
max_fulltext_prefix = prefix
1860
1718
(found_sha1, start_point, end_point,
1861
type) = self._compressor.compress(
1862
record.key, chunks, chunks_len, record.sha1, soft=soft,
1863
nostore_sha=nostore_sha)
1864
# delta_ratio = float(chunks_len) / (end_point - start_point)
1719
type) = self._compressor.compress(record.key,
1720
bytes, record.sha1, soft=soft,
1721
nostore_sha=nostore_sha)
1722
# delta_ratio = float(len(bytes)) / (end_point - start_point)
1865
1723
# Check if we want to continue to include that text
1866
1724
if (prefix == max_fulltext_prefix
1867
and end_point < 2 * max_fulltext_len):
1725
and end_point < 2 * max_fulltext_len):
1868
1726
# As long as we are on the same file_id, we will fill at least
1869
1727
# 2 * max_fulltext_len
1870
1728
start_new_block = False
1871
elif end_point > 4 * 1024 * 1024:
1729
elif end_point > 4*1024*1024:
1872
1730
start_new_block = True
1873
1731
elif (prefix is not None and prefix != last_prefix
1874
and end_point > 2 * 1024 * 1024):
1732
and end_point > 2*1024*1024):
1875
1733
start_new_block = True
1877
1735
start_new_block = False
1879
1737
if start_new_block:
1880
1738
self._compressor.pop_last()
1882
max_fulltext_len = chunks_len
1740
max_fulltext_len = len(bytes)
1883
1741
(found_sha1, start_point, end_point,
1884
type) = self._compressor.compress(
1885
record.key, chunks, chunks_len, record.sha1)
1742
type) = self._compressor.compress(record.key, bytes,
1886
1744
if record.key[-1] is None:
1887
key = record.key[:-1] + (b'sha1:' + found_sha1,)
1745
key = record.key[:-1] + ('sha1:' + found_sha1,)
1889
1747
key = record.key
1890
1748
self._unadded_refs[key] = record.parents
1891
yield found_sha1, chunks_len
1892
1750
as_st = static_tuple.StaticTuple.from_sequence
1893
1751
if record.parents is not None:
1894
1752
parents = as_st([as_st(p) for p in record.parents])
1897
1755
refs = static_tuple.StaticTuple(parents)
1899
(key, b'%d %d' % (start_point, end_point), refs))
1756
keys_to_add.append((key, '%d %d' % (start_point, end_point), refs))
1900
1757
if len(keys_to_add):
1902
1759
self._compressor = None
1928
1785
# but we need to setup a list of records to visit.
1929
1786
# we need key, position, length
1930
1787
for key_idx, record in enumerate(self.get_record_stream(keys,
1931
'unordered', True)):
1788
'unordered', True)):
1932
1789
# XXX: todo - optimise to use less than full texts.
1933
1790
key = record.key
1934
1791
if pb is not None:
1935
1792
pb.update('Walking content', key_idx, total)
1936
1793
if record.storage_kind == 'absent':
1937
1794
raise errors.RevisionNotPresent(key, self)
1938
for line in record.iter_bytes_as('lines'):
1795
lines = osutils.split_lines(record.get_bytes_as('fulltext'))
1939
1797
yield line, key
1940
1798
if pb is not None:
1941
1799
pb.update('Walking content', total, total)
1944
1802
"""See VersionedFiles.keys."""
1945
1803
if 'evil' in debug.debug_flags:
1946
1804
trace.mutter_callsite(2, "keys scales with size of history")
1947
sources = [self._index] + self._immediate_fallback_vfs
1805
sources = [self._index] + self._fallback_vfs
1949
1807
for source in sources:
1950
1808
result.update(source.keys())
1954
class _GCBuildDetails(object):
1955
"""A blob of data about the build details.
1957
This stores the minimal data, which then allows compatibility with the old
1958
api, without taking as much memory.
1961
__slots__ = ('_index', '_group_start', '_group_end', '_basis_end',
1962
'_delta_end', '_parents')
1965
compression_parent = None
1967
def __init__(self, parents, position_info):
1968
self._parents = parents
1969
(self._index, self._group_start, self._group_end, self._basis_end,
1970
self._delta_end) = position_info
1973
return '%s(%s, %s)' % (self.__class__.__name__,
1974
self.index_memo, self._parents)
1977
def index_memo(self):
1978
return (self._index, self._group_start, self._group_end,
1979
self._basis_end, self._delta_end)
1982
def record_details(self):
1983
return static_tuple.StaticTuple(self.method, None)
1985
def __getitem__(self, offset):
1986
"""Compatibility thunk to act like a tuple."""
1988
return self.index_memo
1990
return self.compression_parent # Always None
1992
return self._parents
1994
return self.record_details
1996
raise IndexError('offset out of range')
2002
1812
class _GCGraphIndex(object):
2003
1813
"""Mapper from GroupCompressVersionedFiles needs into GraphIndex storage."""
2005
1815
def __init__(self, graph_index, is_locked, parents=True,
2006
add_callback=None, track_external_parent_refs=False,
2007
inconsistency_fatal=True, track_new_keys=False):
1816
add_callback=None, track_external_parent_refs=False,
1817
inconsistency_fatal=True, track_new_keys=False):
2008
1818
"""Construct a _GCGraphIndex on a graph_index.
2010
:param graph_index: An implementation of breezy.index.GraphIndex.
1820
:param graph_index: An implementation of bzrlib.index.GraphIndex.
2011
1821
:param is_locked: A callback, returns True if the index is locked and
2013
1823
:param parents: If True, record knits parents, if not do not record
2179
1989
:param keys: An iterable of keys.
2180
1990
:return: A dict of key:
2181
1991
(index_memo, compression_parent, parents, record_details).
2183
* index_memo: opaque structure to pass to read_records to extract
2185
* compression_parent: Content that this record is built upon, may
2187
* parents: Logical parents of this node
2188
* record_details: extra information about the content which needs
2189
to be passed to Factory.parse_record
1993
opaque structure to pass to read_records to extract the raw
1996
Content that this record is built upon, may be None
1998
Logical parents of this node
2000
extra information about the content which needs to be passed to
2001
Factory.parse_record
2191
2003
self._check_read()