/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/bzr/groupcompress.py

  • Committer: Jelmer Vernooij
  • Date: 2020-05-24 00:42:36 UTC
  • mto: This revision was merged to the branch mainline in revision 7505.
  • Revision ID: jelmer@jelmer.uk-20200524004236-jdj6obo4k5lznqw2
Cleanup Windows functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2008-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
18
18
 
19
19
import time
20
20
import zlib
21
 
try:
22
 
    import pylzma
23
 
except ImportError:
24
 
    pylzma = None
25
21
 
26
 
from bzrlib import (
 
22
from ..lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
from breezy import (
27
25
    annotate,
 
26
    config,
28
27
    debug,
29
 
    errors,
30
 
    graph as _mod_graph,
31
 
    knit,
32
28
    osutils,
33
 
    pack,
34
29
    static_tuple,
35
30
    trace,
36
 
    )
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 (
 
31
    tsort,
 
32
    )
 
33
from breezy.bzr import (
 
34
    knit,
 
35
    pack,
 
36
    pack_repo,
 
37
    )
 
38
 
 
39
from breezy.i18n import gettext
 
40
""")
 
41
 
 
42
from .. import (
 
43
    errors,
 
44
    )
 
45
from .btree_index import BTreeBuilder
 
46
from ..lru_cache import LRUSizeCache
 
47
from .versionedfile import (
 
48
    _KeyRefs,
41
49
    adapter_registry,
42
50
    AbsentContentFactory,
43
51
    ChunkedContentFactory,
44
52
    FulltextContentFactory,
45
 
    VersionedFiles,
 
53
    VersionedFilesWithFallbacks,
46
54
    )
47
55
 
48
56
# Minimum number of uncompressed bytes to try fetch at once when retrieving
49
57
# groupcompress blocks.
50
58
BATCH_SIZE = 2**16
51
59
 
52
 
_USE_LZMA = False and (pylzma is not None)
 
60
# osutils.sha_string(b'')
 
61
_null_sha1 = b'da39a3ee5e6b4b0d3255bfef95601890afd80709'
53
62
 
54
 
# osutils.sha_string('')
55
 
_null_sha1 = 'da39a3ee5e6b4b0d3255bfef95601890afd80709'
56
63
 
57
64
def sort_gc_optimal(parent_map):
58
65
    """Sort and group the keys in parent_map into groupcompress order.
65
72
    # groupcompress ordering is approximately reverse topological,
66
73
    # properly grouped by file-id.
67
74
    per_prefix_map = {}
68
 
    for key, value in parent_map.iteritems():
69
 
        if isinstance(key, str) or len(key) == 1:
70
 
            prefix = ''
 
75
    for key, value in parent_map.items():
 
76
        if isinstance(key, bytes) or len(key) == 1:
 
77
            prefix = b''
71
78
        else:
72
79
            prefix = key[0]
73
80
        try:
77
84
 
78
85
    present_keys = []
79
86
    for prefix in sorted(per_prefix_map):
80
 
        present_keys.extend(reversed(topo_sort(per_prefix_map[prefix])))
 
87
        present_keys.extend(reversed(tsort.topo_sort(per_prefix_map[prefix])))
81
88
    return present_keys
82
89
 
83
90
 
 
91
class DecompressCorruption(errors.BzrError):
 
92
 
 
93
    _fmt = "Corruption while decompressing repository file%(orig_error)s"
 
94
 
 
95
    def __init__(self, orig_error=None):
 
96
        if orig_error is not None:
 
97
            self.orig_error = ", %s" % (orig_error,)
 
98
        else:
 
99
            self.orig_error = ""
 
100
        errors.BzrError.__init__(self)
 
101
 
 
102
 
84
103
# The max zlib window size is 32kB, so if we set 'max_size' output of the
85
104
# decompressor to the requested bytes + 32kB, then we should guarantee
86
105
# num_bytes coming out.
87
 
_ZLIB_DECOMP_WINDOW = 32*1024
 
106
_ZLIB_DECOMP_WINDOW = 32 * 1024
 
107
 
88
108
 
89
109
class GroupCompressBlock(object):
90
110
    """An object which maintains the internal structure of the compressed data.
93
113
    """
94
114
 
95
115
    # Group Compress Block v1 Zlib
96
 
    GCB_HEADER = 'gcb1z\n'
 
116
    GCB_HEADER = b'gcb1z\n'
97
117
    # Group Compress Block v1 Lzma
98
 
    GCB_LZ_HEADER = 'gcb1l\n'
 
118
    GCB_LZ_HEADER = b'gcb1l\n'
99
119
    GCB_KNOWN_HEADERS = (GCB_HEADER, GCB_LZ_HEADER)
100
120
 
101
121
    def __init__(self):
102
122
        # map by key? or just order in file?
103
123
        self._compressor_name = None
104
 
        self._z_content = None
 
124
        self._z_content_chunks = None
105
125
        self._z_content_decompressor = None
106
126
        self._z_content_length = None
107
127
        self._content_length = None
132
152
        # Expand the content if required
133
153
        if self._content is None:
134
154
            if self._content_chunks is not None:
135
 
                self._content = ''.join(self._content_chunks)
 
155
                self._content = b''.join(self._content_chunks)
136
156
                self._content_chunks = None
137
157
        if self._content is None:
138
 
            if self._z_content is None:
 
158
            # We join self._z_content_chunks here, because if we are
 
159
            # decompressing, then it is *very* likely that we have a single
 
160
            # chunk
 
161
            if self._z_content_chunks is None:
139
162
                raise AssertionError('No content to decompress')
140
 
            if self._z_content == '':
141
 
                self._content = ''
 
163
            z_content = b''.join(self._z_content_chunks)
 
164
            if z_content == b'':
 
165
                self._content = b''
142
166
            elif self._compressor_name == 'lzma':
143
167
                # We don't do partial lzma decomp yet
144
 
                self._content = pylzma.decompress(self._z_content)
 
168
                import pylzma
 
169
                self._content = pylzma.decompress(z_content)
145
170
            elif self._compressor_name == 'zlib':
146
171
                # Start a zlib decompressor
147
172
                if num_bytes * 4 > self._content_length * 3:
148
173
                    # If we are requesting more that 3/4ths of the content,
149
174
                    # just extract the whole thing in a single pass
150
175
                    num_bytes = self._content_length
151
 
                    self._content = zlib.decompress(self._z_content)
 
176
                    self._content = zlib.decompress(z_content)
152
177
                else:
153
178
                    self._z_content_decompressor = zlib.decompressobj()
154
179
                    # Seed the decompressor with the uncompressed bytes, so
155
180
                    # that the rest of the code is simplified
156
181
                    self._content = self._z_content_decompressor.decompress(
157
 
                        self._z_content, num_bytes + _ZLIB_DECOMP_WINDOW)
 
182
                        z_content, num_bytes + _ZLIB_DECOMP_WINDOW)
158
183
                    if not self._z_content_decompressor.unconsumed_tail:
159
184
                        self._z_content_decompressor = None
160
185
            else:
187
212
            # The stream is finished
188
213
            self._z_content_decompressor = None
189
214
 
190
 
    def _parse_bytes(self, bytes, pos):
 
215
    def _parse_bytes(self, data, pos):
191
216
        """Read the various lengths from the header.
192
217
 
193
218
        This also populates the various 'compressed' buffers.
197
222
        # At present, we have 2 integers for the compressed and uncompressed
198
223
        # content. In base10 (ascii) 14 bytes can represent > 1TB, so to avoid
199
224
        # checking too far, cap the search to 14 bytes.
200
 
        pos2 = bytes.index('\n', pos, pos + 14)
201
 
        self._z_content_length = int(bytes[pos:pos2])
202
 
        pos = pos2 + 1
203
 
        pos2 = bytes.index('\n', pos, pos + 14)
204
 
        self._content_length = int(bytes[pos:pos2])
205
 
        pos = pos2 + 1
206
 
        if len(bytes) != (pos + self._z_content_length):
 
225
        pos2 = data.index(b'\n', pos, pos + 14)
 
226
        self._z_content_length = int(data[pos:pos2])
 
227
        pos = pos2 + 1
 
228
        pos2 = data.index(b'\n', pos, pos + 14)
 
229
        self._content_length = int(data[pos:pos2])
 
230
        pos = pos2 + 1
 
231
        if len(data) != (pos + self._z_content_length):
207
232
            # XXX: Define some GCCorrupt error ?
208
233
            raise AssertionError('Invalid bytes: (%d) != %d + %d' %
209
 
                                 (len(bytes), pos, self._z_content_length))
210
 
        self._z_content = bytes[pos:]
 
234
                                 (len(data), pos, self._z_content_length))
 
235
        self._z_content_chunks = (data[pos:],)
 
236
 
 
237
    @property
 
238
    def _z_content(self):
 
239
        """Return z_content_chunks as a simple string.
 
240
 
 
241
        Meant only to be used by the test suite.
 
242
        """
 
243
        if self._z_content_chunks is not None:
 
244
            return b''.join(self._z_content_chunks)
 
245
        return None
211
246
 
212
247
    @classmethod
213
248
    def from_bytes(cls, bytes):
214
249
        out = cls()
215
 
        if bytes[:6] not in cls.GCB_KNOWN_HEADERS:
 
250
        header = bytes[:6]
 
251
        if header not in cls.GCB_KNOWN_HEADERS:
216
252
            raise ValueError('bytes did not start with any of %r'
217
253
                             % (cls.GCB_KNOWN_HEADERS,))
218
 
        # XXX: why not testing the whole header ?
219
 
        if bytes[4] == 'z':
 
254
        if header == cls.GCB_HEADER:
220
255
            out._compressor_name = 'zlib'
221
 
        elif bytes[4] == 'l':
 
256
        elif header == cls.GCB_LZ_HEADER:
222
257
            out._compressor_name = 'lzma'
223
258
        else:
224
 
            raise ValueError('unknown compressor: %r' % (bytes,))
 
259
            raise ValueError('unknown compressor: %r' % (header,))
225
260
        out._parse_bytes(bytes, 6)
226
261
        return out
227
262
 
233
268
        :return: The bytes for the content
234
269
        """
235
270
        if start == end == 0:
236
 
            return ''
 
271
            return []
237
272
        self._ensure_content(end)
238
273
        # The bytes are 'f' or 'd' for the type, then a variable-length
239
274
        # base128 integer for the content size, then the actual content
240
275
        # We know that the variable-length integer won't be longer than 5
241
276
        # bytes (it takes 5 bytes to encode 2^32)
242
 
        c = self._content[start]
243
 
        if c == 'f':
 
277
        c = self._content[start:start + 1]
 
278
        if c == b'f':
244
279
            type = 'fulltext'
245
280
        else:
246
 
            if c != 'd':
 
281
            if c != b'd':
247
282
                raise ValueError('Unknown content control code: %s'
248
283
                                 % (c,))
249
284
            type = 'delta'
250
285
        content_len, len_len = decode_base128_int(
251
 
                            self._content[start + 1:start + 6])
 
286
            self._content[start + 1:start + 6])
252
287
        content_start = start + 1 + len_len
253
288
        if end != content_start + content_len:
254
289
            raise ValueError('end != len according to field header'
255
 
                ' %s != %s' % (end, content_start + content_len))
256
 
        if c == 'f':
257
 
            bytes = self._content[content_start:end]
258
 
        elif c == 'd':
259
 
            bytes = apply_delta_to_source(self._content, content_start, end)
260
 
        return bytes
 
290
                             ' %s != %s' % (end, content_start + content_len))
 
291
        if c == b'f':
 
292
            return [self._content[content_start:end]]
 
293
        # Must be type delta as checked above
 
294
        return [apply_delta_to_source(self._content, content_start, end)]
261
295
 
262
296
    def set_chunked_content(self, content_chunks, length):
263
297
        """Set the content of this block to the given chunks."""
269
303
        self._content_length = length
270
304
        self._content_chunks = content_chunks
271
305
        self._content = None
272
 
        self._z_content = None
 
306
        self._z_content_chunks = None
273
307
 
274
308
    def set_content(self, content):
275
309
        """Set the content of this block."""
276
310
        self._content_length = len(content)
277
311
        self._content = content
278
 
        self._z_content = None
279
 
 
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)
288
 
 
289
 
    def _create_z_content_from_chunks(self):
 
312
        self._z_content_chunks = None
 
313
 
 
314
    def _create_z_content_from_chunks(self, chunks):
290
315
        compressor = zlib.compressobj(zlib.Z_DEFAULT_COMPRESSION)
291
 
        compressed_chunks = map(compressor.compress, self._content_chunks)
 
316
        # Peak in this point is 1 fulltext, 1 compressed text, + zlib overhead
 
317
        # (measured peak is maybe 30MB over the above...)
 
318
        compressed_chunks = list(map(compressor.compress, chunks))
292
319
        compressed_chunks.append(compressor.flush())
293
 
        self._z_content = ''.join(compressed_chunks)
294
 
        self._z_content_length = len(self._z_content)
 
320
        # Ignore empty chunks
 
321
        self._z_content_chunks = [c for c in compressed_chunks if c]
 
322
        self._z_content_length = sum(map(len, self._z_content_chunks))
295
323
 
296
324
    def _create_z_content(self):
297
 
        if self._z_content is not None:
298
 
            return
299
 
        if _USE_LZMA:
300
 
            self._create_z_content_using_lzma()
 
325
        if self._z_content_chunks is not None:
301
326
            return
302
327
        if self._content_chunks is not None:
303
 
            self._create_z_content_from_chunks()
304
 
            return
305
 
        self._z_content = zlib.compress(self._content)
306
 
        self._z_content_length = len(self._z_content)
 
328
            chunks = self._content_chunks
 
329
        else:
 
330
            chunks = (self._content,)
 
331
        self._create_z_content_from_chunks(chunks)
 
332
 
 
333
    def to_chunks(self):
 
334
        """Create the byte stream as a series of 'chunks'"""
 
335
        self._create_z_content()
 
336
        header = self.GCB_HEADER
 
337
        chunks = [b'%s%d\n%d\n'
 
338
                  % (header, self._z_content_length, self._content_length),
 
339
                  ]
 
340
        chunks.extend(self._z_content_chunks)
 
341
        total_len = sum(map(len, chunks))
 
342
        return total_len, chunks
307
343
 
308
344
    def to_bytes(self):
309
345
        """Encode the information into a byte stream."""
310
 
        self._create_z_content()
311
 
        if _USE_LZMA:
312
 
            header = self.GCB_LZ_HEADER
313
 
        else:
314
 
            header = self.GCB_HEADER
315
 
        chunks = [header,
316
 
                  '%d\n%d\n' % (self._z_content_length, self._content_length),
317
 
                  self._z_content,
318
 
                 ]
319
 
        return ''.join(chunks)
 
346
        total_len, chunks = self.to_chunks()
 
347
        return b''.join(chunks)
320
348
 
321
349
    def _dump(self, include_text=False):
322
350
        """Take this block, and spit out a human-readable structure.
332
360
        result = []
333
361
        pos = 0
334
362
        while pos < self._content_length:
335
 
            kind = self._content[pos]
 
363
            kind = self._content[pos:pos + 1]
336
364
            pos += 1
337
 
            if kind not in ('f', 'd'):
 
365
            if kind not in (b'f', b'd'):
338
366
                raise ValueError('invalid kind character: %r' % (kind,))
339
367
            content_len, len_len = decode_base128_int(
340
 
                                self._content[pos:pos + 5])
 
368
                self._content[pos:pos + 5])
341
369
            pos += len_len
342
370
            if content_len + pos > self._content_length:
343
371
                raise ValueError('invalid content_len %d for record @ pos %d'
344
372
                                 % (content_len, pos - len_len - 1))
345
 
            if kind == 'f': # Fulltext
 
373
            if kind == b'f':  # Fulltext
346
374
                if include_text:
347
 
                    text = self._content[pos:pos+content_len]
348
 
                    result.append(('f', content_len, text))
 
375
                    text = self._content[pos:pos + content_len]
 
376
                    result.append((b'f', content_len, text))
349
377
                else:
350
 
                    result.append(('f', content_len))
351
 
            elif kind == 'd': # Delta
352
 
                delta_content = self._content[pos:pos+content_len]
 
378
                    result.append((b'f', content_len))
 
379
            elif kind == b'd':  # Delta
 
380
                delta_content = self._content[pos:pos + content_len]
353
381
                delta_info = []
354
382
                # The first entry in a delta is the decompressed length
355
383
                decomp_len, delta_pos = decode_base128_int(delta_content)
356
 
                result.append(('d', content_len, decomp_len, delta_info))
 
384
                result.append((b'd', content_len, decomp_len, delta_info))
357
385
                measured_len = 0
358
386
                while delta_pos < content_len:
359
 
                    c = ord(delta_content[delta_pos])
 
387
                    c = delta_content[delta_pos]
360
388
                    delta_pos += 1
361
 
                    if c & 0x80: # Copy
 
389
                    if c & 0x80:  # Copy
362
390
                        (offset, length,
363
391
                         delta_pos) = decode_copy_instruction(delta_content, c,
364
392
                                                              delta_pos)
365
393
                        if include_text:
366
 
                            text = self._content[offset:offset+length]
367
 
                            delta_info.append(('c', offset, length, text))
 
394
                            text = self._content[offset:offset + length]
 
395
                            delta_info.append((b'c', offset, length, text))
368
396
                        else:
369
 
                            delta_info.append(('c', offset, length))
 
397
                            delta_info.append((b'c', offset, length))
370
398
                        measured_len += length
371
 
                    else: # Insert
 
399
                    else:  # Insert
372
400
                        if include_text:
373
 
                            txt = delta_content[delta_pos:delta_pos+c]
 
401
                            txt = delta_content[delta_pos:delta_pos + c]
374
402
                        else:
375
 
                            txt = ''
376
 
                        delta_info.append(('i', c, txt))
 
403
                            txt = b''
 
404
                        delta_info.append((b'i', c, txt))
377
405
                        measured_len += c
378
406
                        delta_pos += c
379
407
                if delta_pos != content_len:
405
433
        self.key = key
406
434
        self.parents = parents
407
435
        self.sha1 = None
 
436
        self.size = None
408
437
        # Note: This attribute coupled with Manager._factories creates a
409
438
        #       reference cycle. Perhaps we would rather use a weakref(), or
410
439
        #       find an appropriate time to release the ref. After the first
411
440
        #       get_bytes_as call? After Manager.get_record_stream() returns
412
441
        #       the object?
413
442
        self._manager = manager
414
 
        self._bytes = None
 
443
        self._chunks = None
415
444
        self.storage_kind = 'groupcompress-block'
416
445
        if not first:
417
446
            self.storage_kind = 'groupcompress-block-ref'
421
450
 
422
451
    def __repr__(self):
423
452
        return '%s(%s, first=%s)' % (self.__class__.__name__,
424
 
            self.key, self._first)
 
453
                                     self.key, self._first)
 
454
 
 
455
    def _extract_bytes(self):
 
456
        # Grab and cache the raw bytes for this entry
 
457
        # and break the ref-cycle with _manager since we don't need it
 
458
        # anymore
 
459
        try:
 
460
            self._manager._prepare_for_extract()
 
461
        except zlib.error as value:
 
462
            raise DecompressCorruption("zlib: " + str(value))
 
463
        block = self._manager._block
 
464
        self._chunks = block.extract(self.key, self._start, self._end)
 
465
        # There are code paths that first extract as fulltext, and then
 
466
        # extract as storage_kind (smart fetch). So we don't break the
 
467
        # refcycle here, but instead in manager.get_record_stream()
425
468
 
426
469
    def get_bytes_as(self, storage_kind):
427
470
        if storage_kind == self.storage_kind:
429
472
                # wire bytes, something...
430
473
                return self._manager._wire_bytes()
431
474
            else:
432
 
                return ''
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
437
 
                # anymore
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()
 
475
                return b''
 
476
        if storage_kind in ('fulltext', 'chunked', 'lines'):
 
477
            if self._chunks is None:
 
478
                self._extract_bytes()
444
479
            if storage_kind == 'fulltext':
445
 
                return self._bytes
 
480
                return b''.join(self._chunks)
 
481
            elif storage_kind == 'chunked':
 
482
                return self._chunks
446
483
            else:
447
 
                return [self._bytes]
 
484
                return osutils.chunks_to_lines(self._chunks)
 
485
        raise errors.UnavailableRepresentation(self.key, storage_kind,
 
486
                                               self.storage_kind)
 
487
 
 
488
    def iter_bytes_as(self, storage_kind):
 
489
        if self._chunks is None:
 
490
            self._extract_bytes()
 
491
        if storage_kind == 'chunked':
 
492
            return iter(self._chunks)
 
493
        elif storage_kind == 'lines':
 
494
            return iter(osutils.chunks_to_lines(self._chunks))
448
495
        raise errors.UnavailableRepresentation(self.key, storage_kind,
449
496
                                               self.storage_kind)
450
497
 
452
499
class _LazyGroupContentManager(object):
453
500
    """This manages a group of _LazyGroupCompressFactory objects."""
454
501
 
455
 
    _max_cut_fraction = 0.75 # We allow a block to be trimmed to 75% of
456
 
                             # current size, and still be considered
457
 
                             # resuable
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
 
502
    _max_cut_fraction = 0.75  # We allow a block to be trimmed to 75% of
 
503
    # current size, and still be considered
 
504
    # resuable
 
505
    _full_block_size = 4 * 1024 * 1024
 
506
    _full_mixed_block_size = 2 * 1024 * 1024
 
507
    _full_enough_block_size = 3 * 1024 * 1024  # size at which we won't repack
 
508
    _full_enough_mixed_block_size = 2 * 768 * 1024  # 1.5MB
462
509
 
463
 
    def __init__(self, block):
 
510
    def __init__(self, block, get_compressor_settings=None):
464
511
        self._block = block
465
512
        # We need to preserve the ordering
466
513
        self._factories = []
467
514
        self._last_byte = 0
 
515
        self._get_settings = get_compressor_settings
 
516
        self._compressor_settings = None
 
517
 
 
518
    def _get_compressor_settings(self):
 
519
        if self._compressor_settings is not None:
 
520
            return self._compressor_settings
 
521
        settings = None
 
522
        if self._get_settings is not None:
 
523
            settings = self._get_settings()
 
524
        if settings is None:
 
525
            vf = GroupCompressVersionedFiles
 
526
            settings = vf._DEFAULT_COMPRESSOR_SETTINGS
 
527
        self._compressor_settings = settings
 
528
        return self._compressor_settings
468
529
 
469
530
    def add_factory(self, key, parents, start, end):
470
531
        if not self._factories:
473
534
            first = False
474
535
        # Note that this creates a reference cycle....
475
536
        factory = _LazyGroupCompressFactory(key, parents, self,
476
 
            start, end, first=first)
 
537
                                            start, end, first=first)
477
538
        # max() works here, but as a function call, doing a compare seems to be
478
539
        # significantly faster, timeit says 250ms for max() and 100ms for the
479
540
        # comparison
503
564
        new_block.set_content(self._block._content[:last_byte])
504
565
        self._block = new_block
505
566
 
 
567
    def _make_group_compressor(self):
 
568
        return GroupCompressor(self._get_compressor_settings())
 
569
 
506
570
    def _rebuild_block(self):
507
571
        """Create a new GroupCompressBlock with only the referenced texts."""
508
 
        compressor = GroupCompressor()
 
572
        compressor = self._make_group_compressor()
509
573
        tstart = time.time()
510
574
        old_length = self._block._content_length
511
575
        end_point = 0
512
576
        for factory in self._factories:
513
 
            bytes = factory.get_bytes_as('fulltext')
 
577
            chunks = factory.get_bytes_as('chunked')
 
578
            chunks_len = factory.size
 
579
            if chunks_len is None:
 
580
                chunks_len = sum(map(len, chunks))
514
581
            (found_sha1, start_point, end_point,
515
 
             type) = compressor.compress(factory.key, bytes, factory.sha1)
 
582
             type) = compressor.compress(
 
583
                 factory.key, chunks, chunks_len, factory.sha1)
516
584
            # Now update this factory with the new offsets, etc
517
585
            factory.sha1 = found_sha1
518
586
            factory._start = start_point
523
591
        #       block? It seems hard to come up with a method that it would
524
592
        #       expand, since we do full compression again. Perhaps based on a
525
593
        #       request that ends up poorly ordered?
 
594
        # TODO: If the content would have expanded, then we would want to
 
595
        #       handle a case where we need to split the block.
 
596
        #       Now that we have a user-tweakable option
 
597
        #       (max_bytes_to_index), it is possible that one person set it
 
598
        #       to a very low value, causing poor compression.
526
599
        delta = time.time() - tstart
527
600
        self._block = new_block
528
601
        trace.mutter('creating new compressed block on-the-fly in %.3fs'
651
724
        #   <length of gc block>\n
652
725
        #   <header bytes>
653
726
        #   <gc-block>
654
 
        lines = ['groupcompress-block\n']
 
727
        lines = [b'groupcompress-block\n']
655
728
        # The minimal info we need is the key, the start offset, and the
656
729
        # parents. The length and type are encoded in the record itself.
657
730
        # However, passing in the other bits makes it easier.  The list of
662
735
        # 1 line for end byte
663
736
        header_lines = []
664
737
        for factory in self._factories:
665
 
            key_bytes = '\x00'.join(factory.key)
 
738
            key_bytes = b'\x00'.join(factory.key)
666
739
            parents = factory.parents
667
740
            if parents is None:
668
 
                parent_bytes = 'None:'
 
741
                parent_bytes = b'None:'
669
742
            else:
670
 
                parent_bytes = '\t'.join('\x00'.join(key) for key in parents)
671
 
            record_header = '%s\n%s\n%d\n%d\n' % (
 
743
                parent_bytes = b'\t'.join(b'\x00'.join(key) for key in parents)
 
744
            record_header = b'%s\n%s\n%d\n%d\n' % (
672
745
                key_bytes, parent_bytes, factory._start, factory._end)
673
746
            header_lines.append(record_header)
674
747
            # TODO: Can we break the refcycle at this point and set
675
748
            #       factory._manager = None?
676
 
        header_bytes = ''.join(header_lines)
 
749
        header_bytes = b''.join(header_lines)
677
750
        del header_lines
678
751
        header_bytes_len = len(header_bytes)
679
752
        z_header_bytes = zlib.compress(header_bytes)
680
753
        del header_bytes
681
754
        z_header_bytes_len = len(z_header_bytes)
682
 
        block_bytes = self._block.to_bytes()
683
 
        lines.append('%d\n%d\n%d\n' % (z_header_bytes_len, header_bytes_len,
684
 
                                       len(block_bytes)))
 
755
        block_bytes_len, block_chunks = self._block.to_chunks()
 
756
        lines.append(b'%d\n%d\n%d\n' % (
 
757
            z_header_bytes_len, header_bytes_len, block_bytes_len))
685
758
        lines.append(z_header_bytes)
686
 
        lines.append(block_bytes)
687
 
        del z_header_bytes, block_bytes
688
 
        return ''.join(lines)
 
759
        lines.extend(block_chunks)
 
760
        del z_header_bytes, block_chunks
 
761
        # TODO: This is a point where we will double the memory consumption. To
 
762
        #       avoid this, we probably have to switch to a 'chunked' api
 
763
        return b''.join(lines)
689
764
 
690
765
    @classmethod
691
766
    def from_bytes(cls, bytes):
692
767
        # TODO: This does extra string copying, probably better to do it a
693
 
        #       different way
 
768
        #       different way. At a minimum this creates 2 copies of the
 
769
        #       compressed content
694
770
        (storage_kind, z_header_len, header_len,
695
 
         block_len, rest) = bytes.split('\n', 4)
 
771
         block_len, rest) = bytes.split(b'\n', 4)
696
772
        del bytes
697
 
        if storage_kind != 'groupcompress-block':
 
773
        if storage_kind != b'groupcompress-block':
698
774
            raise ValueError('Unknown storage kind: %s' % (storage_kind,))
699
775
        z_header_len = int(z_header_len)
700
776
        if len(rest) < z_header_len:
712
788
        del rest
713
789
        # So now we have a valid GCB, we just need to parse the factories that
714
790
        # were sent to us
715
 
        header_lines = header.split('\n')
 
791
        header_lines = header.split(b'\n')
716
792
        del header
717
793
        last = header_lines.pop()
718
 
        if last != '':
 
794
        if last != b'':
719
795
            raise ValueError('header lines did not end with a trailing'
720
796
                             ' newline')
721
797
        if len(header_lines) % 4 != 0:
723
799
        block = GroupCompressBlock.from_bytes(block_bytes)
724
800
        del block_bytes
725
801
        result = cls(block)
726
 
        for start in xrange(0, len(header_lines), 4):
 
802
        for start in range(0, len(header_lines), 4):
727
803
            # intern()?
728
 
            key = tuple(header_lines[start].split('\x00'))
729
 
            parents_line = header_lines[start+1]
730
 
            if parents_line == 'None:':
 
804
            key = tuple(header_lines[start].split(b'\x00'))
 
805
            parents_line = header_lines[start + 1]
 
806
            if parents_line == b'None:':
731
807
                parents = None
732
808
            else:
733
 
                parents = tuple([tuple(segment.split('\x00'))
734
 
                                 for segment in parents_line.split('\t')
735
 
                                  if segment])
736
 
            start_offset = int(header_lines[start+2])
737
 
            end_offset = int(header_lines[start+3])
 
809
                parents = tuple([tuple(segment.split(b'\x00'))
 
810
                                 for segment in parents_line.split(b'\t')
 
811
                                 if segment])
 
812
            start_offset = int(header_lines[start + 2])
 
813
            end_offset = int(header_lines[start + 3])
738
814
            result.add_factory(key, parents, start_offset, end_offset)
739
815
        return result
740
816
 
748
824
 
749
825
class _CommonGroupCompressor(object):
750
826
 
751
 
    def __init__(self):
 
827
    def __init__(self, settings=None):
752
828
        """Create a GroupCompressor."""
753
829
        self.chunks = []
754
830
        self._last = None
755
831
        self.endpoint = 0
756
832
        self.input_bytes = 0
757
833
        self.labels_deltas = {}
758
 
        self._delta_index = None # Set by the children
 
834
        self._delta_index = None  # Set by the children
759
835
        self._block = GroupCompressBlock()
 
836
        if settings is None:
 
837
            self._settings = {}
 
838
        else:
 
839
            self._settings = settings
760
840
 
761
 
    def compress(self, key, bytes, expected_sha, nostore_sha=None, soft=False):
 
841
    def compress(self, key, chunks, length, expected_sha, nostore_sha=None,
 
842
                 soft=False):
762
843
        """Compress lines with label key.
763
844
 
764
845
        :param key: A key tuple. It is stored in the output
765
846
            for identification of the text during decompression. If the last
766
 
            element is 'None' it is replaced with the sha1 of the text -
 
847
            element is b'None' it is replaced with the sha1 of the text -
767
848
            e.g. sha1:xxxxxxx.
768
 
        :param bytes: The bytes to be compressed
 
849
        :param chunks: Chunks of bytes to be compressed
 
850
        :param length: Length of chunks
769
851
        :param expected_sha: If non-None, the sha the lines are believed to
770
852
            have. During compression the sha is calculated; a mismatch will
771
853
            cause an error.
779
861
 
780
862
        :seealso VersionedFiles.add_lines:
781
863
        """
782
 
        if not bytes: # empty, like a dir entry, etc
 
864
        if length == 0:  # empty, like a dir entry, etc
783
865
            if nostore_sha == _null_sha1:
784
866
                raise errors.ExistingContent()
785
867
            return _null_sha1, 0, 0, 'fulltext'
787
869
        if expected_sha is not None:
788
870
            sha1 = expected_sha
789
871
        else:
790
 
            sha1 = osutils.sha_string(bytes)
 
872
            sha1 = osutils.sha_strings(chunks)
791
873
        if nostore_sha is not None:
792
874
            if sha1 == nostore_sha:
793
875
                raise errors.ExistingContent()
794
876
        if key[-1] is None:
795
 
            key = key[:-1] + ('sha1:' + sha1,)
 
877
            key = key[:-1] + (b'sha1:' + sha1,)
796
878
 
797
 
        start, end, type = self._compress(key, bytes, len(bytes) / 2, soft)
 
879
        start, end, type = self._compress(key, chunks, length, length / 2, soft)
798
880
        return sha1, start, end, type
799
881
 
800
 
    def _compress(self, key, bytes, max_delta_size, soft=False):
 
882
    def _compress(self, key, chunks, input_len, max_delta_size, soft=False):
801
883
        """Compress lines with label key.
802
884
 
803
885
        :param key: A key tuple. It is stored in the output for identification
804
886
            of the text during decompression.
805
887
 
806
 
        :param bytes: The bytes to be compressed
 
888
        :param chunks: The chunks of bytes to be compressed
 
889
 
 
890
        :param input_len: The length of the chunks
807
891
 
808
892
        :param max_delta_size: The size above which we issue a fulltext instead
809
893
            of a delta.
820
904
        """Extract a key previously added to the compressor.
821
905
 
822
906
        :param key: The key to extract.
823
 
        :return: An iterable over bytes and the sha1.
 
907
        :return: An iterable over chunks and the sha1.
824
908
        """
825
 
        (start_byte, start_chunk, end_byte, end_chunk) = self.labels_deltas[key]
 
909
        (start_byte, start_chunk, end_byte,
 
910
         end_chunk) = self.labels_deltas[key]
826
911
        delta_chunks = self.chunks[start_chunk:end_chunk]
827
 
        stored_bytes = ''.join(delta_chunks)
828
 
        if stored_bytes[0] == 'f':
 
912
        stored_bytes = b''.join(delta_chunks)
 
913
        kind = stored_bytes[:1]
 
914
        if kind == b'f':
829
915
            fulltext_len, offset = decode_base128_int(stored_bytes[1:10])
830
916
            data_len = fulltext_len + 1 + offset
831
 
            if  data_len != len(stored_bytes):
 
917
            if data_len != len(stored_bytes):
832
918
                raise ValueError('Index claimed fulltext len, but stored bytes'
833
919
                                 ' claim %s != %s'
834
920
                                 % (len(stored_bytes), data_len))
835
 
            bytes = stored_bytes[offset + 1:]
 
921
            data = [stored_bytes[offset + 1:]]
836
922
        else:
 
923
            if kind != b'd':
 
924
                raise ValueError('Unknown content kind, bytes claim %s' % kind)
837
925
            # XXX: This is inefficient at best
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],))
 
926
            source = b''.join(self.chunks[:start_chunk])
842
927
            delta_len, offset = decode_base128_int(stored_bytes[1:10])
843
928
            data_len = delta_len + 1 + offset
844
929
            if data_len != len(stored_bytes):
845
930
                raise ValueError('Index claimed delta len, but stored bytes'
846
931
                                 ' claim %s != %s'
847
932
                                 % (len(stored_bytes), data_len))
848
 
            bytes = apply_delta(source, stored_bytes[offset + 1:])
849
 
        bytes_sha1 = osutils.sha_string(bytes)
850
 
        return bytes, bytes_sha1
 
933
            data = [apply_delta(source, stored_bytes[offset + 1:])]
 
934
        data_sha1 = osutils.sha_strings(data)
 
935
        return data, data_sha1
851
936
 
852
937
    def flush(self):
853
938
        """Finish this group, creating a formatted stream.
854
939
 
855
940
        After calling this, the compressor should no longer be used
856
941
        """
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.
865
942
        self._block.set_chunked_content(self.chunks, self.endpoint)
866
943
        self.chunks = None
867
944
        self._delta_index = None
885
962
 
886
963
class PythonGroupCompressor(_CommonGroupCompressor):
887
964
 
888
 
    def __init__(self):
 
965
    def __init__(self, settings=None):
889
966
        """Create a GroupCompressor.
890
967
 
891
968
        Used only if the pyrex version is not available.
892
969
        """
893
 
        super(PythonGroupCompressor, self).__init__()
 
970
        super(PythonGroupCompressor, self).__init__(settings)
894
971
        self._delta_index = LinesDeltaIndex([])
895
972
        # The actual content is managed by LinesDeltaIndex
896
973
        self.chunks = self._delta_index.lines
897
974
 
898
 
    def _compress(self, key, bytes, max_delta_size, soft=False):
 
975
    def _compress(self, key, chunks, input_len, max_delta_size, soft=False):
899
976
        """see _CommonGroupCompressor._compress"""
900
 
        input_len = len(bytes)
901
 
        new_lines = osutils.split_lines(bytes)
 
977
        new_lines = osutils.chunks_to_lines(chunks)
902
978
        out_lines, index_lines = self._delta_index.make_delta(
903
979
            new_lines, bytes_length=input_len, soft=soft)
904
980
        delta_length = sum(map(len, out_lines))
905
981
        if delta_length > max_delta_size:
906
982
            # The delta is longer than the fulltext, insert a fulltext
907
983
            type = 'fulltext'
908
 
            out_lines = ['f', encode_base128_int(input_len)]
 
984
            out_lines = [b'f', encode_base128_int(input_len)]
909
985
            out_lines.extend(new_lines)
910
986
            index_lines = [False, False]
911
987
            index_lines.extend([True] * len(new_lines))
912
988
        else:
913
989
            # this is a worthy delta, output it
914
990
            type = 'delta'
915
 
            out_lines[0] = 'd'
 
991
            out_lines[0] = b'd'
916
992
            # Update the delta_length to include those two encoded integers
917
993
            out_lines[1] = encode_base128_int(delta_length)
918
994
        # Before insertion
933
1009
 
934
1010
    It contains code very similar to SequenceMatcher because of having a similar
935
1011
    task. However some key differences apply:
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
939
 
       edits only.
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
944
 
       left side.
 
1012
 
 
1013
    * there is no junk, we want a minimal edit not a human readable diff.
 
1014
    * we don't filter very common lines (because we don't know where a good
 
1015
      range will start, and after the first text we want to be emitting minmal
 
1016
      edits only.
 
1017
    * we chain the left side, not the right side
 
1018
    * we incrementally update the adjacency matrix as new lines are provided.
 
1019
    * we look for matches in all of the left side, so the routine which does
 
1020
      the analagous task of find_longest_match does not need to filter on the
 
1021
      left side.
945
1022
    """
946
1023
 
947
 
    def __init__(self):
948
 
        super(PyrexGroupCompressor, self).__init__()
949
 
        self._delta_index = DeltaIndex()
 
1024
    def __init__(self, settings=None):
 
1025
        super(PyrexGroupCompressor, self).__init__(settings)
 
1026
        max_bytes_to_index = self._settings.get('max_bytes_to_index', 0)
 
1027
        self._delta_index = DeltaIndex(max_bytes_to_index=max_bytes_to_index)
950
1028
 
951
 
    def _compress(self, key, bytes, max_delta_size, soft=False):
 
1029
    def _compress(self, key, chunks, input_len, max_delta_size, soft=False):
952
1030
        """see _CommonGroupCompressor._compress"""
953
 
        input_len = len(bytes)
954
1031
        # By having action/label/sha1/len, we can parse the group if the index
955
1032
        # was ever destroyed, we have the key in 'label', we know the final
956
1033
        # bytes are valid from sha1, and we know where to find the end of this
962
1039
        # new_chunks = ['label:%s\nsha1:%s\n' % (label, sha1)]
963
1040
        if self._delta_index._source_offset != self.endpoint:
964
1041
            raise AssertionError('_source_offset != endpoint'
965
 
                ' somehow the DeltaIndex got out of sync with'
966
 
                ' the output lines')
 
1042
                                 ' somehow the DeltaIndex got out of sync with'
 
1043
                                 ' the output lines')
 
1044
        bytes = b''.join(chunks)
967
1045
        delta = self._delta_index.make_delta(bytes, max_delta_size)
968
 
        if (delta is None):
 
1046
        if delta is None:
969
1047
            type = 'fulltext'
970
 
            enc_length = encode_base128_int(len(bytes))
 
1048
            enc_length = encode_base128_int(input_len)
971
1049
            len_mini_header = 1 + len(enc_length)
972
1050
            self._delta_index.add_source(bytes, len_mini_header)
973
 
            new_chunks = ['f', enc_length, bytes]
 
1051
            new_chunks = [b'f', enc_length] + chunks
974
1052
        else:
975
1053
            type = 'delta'
976
1054
            enc_length = encode_base128_int(len(delta))
977
1055
            len_mini_header = 1 + len(enc_length)
978
 
            new_chunks = ['d', enc_length, delta]
 
1056
            new_chunks = [b'd', enc_length, delta]
979
1057
            self._delta_index.add_delta_source(delta, len_mini_header)
980
1058
        # Before insertion
981
1059
        start = self.endpoint
988
1066
                                   self.endpoint, chunk_end)
989
1067
        if not self._delta_index._source_offset == self.endpoint:
990
1068
            raise AssertionError('the delta index is out of sync'
991
 
                'with the output lines %s != %s'
992
 
                % (self._delta_index._source_offset, self.endpoint))
 
1069
                                 'with the output lines %s != %s'
 
1070
                                 % (self._delta_index._source_offset, self.endpoint))
993
1071
        return start, self.endpoint, type
994
1072
 
995
1073
    def _output_chunks(self, new_chunks):
1020
1098
        if graph:
1021
1099
            ref_length = 1
1022
1100
        graph_index = BTreeBuilder(reference_lists=ref_length,
1023
 
            key_elements=keylength)
 
1101
                                   key_elements=keylength)
1024
1102
        stream = transport.open_write_stream('newpack')
1025
1103
        writer = pack.ContainerWriter(stream.write)
1026
1104
        writer.begin()
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({})
 
1105
        index = _GCGraphIndex(graph_index, lambda: True, parents=parents,
 
1106
                              add_callback=graph_index.add_nodes,
 
1107
                              inconsistency_fatal=inconsistency_fatal)
 
1108
        access = pack_repo._DirectPackAccess({})
1031
1109
        access.set_writer(writer, graph_index, (transport, 'newpack'))
1032
1110
        result = GroupCompressVersionedFiles(index, access, delta)
1033
1111
        result.stream = stream
1043
1121
 
1044
1122
class _BatchingBlockFetcher(object):
1045
1123
    """Fetch group compress blocks in batches.
1046
 
    
 
1124
 
1047
1125
    :ivar total_bytes: int of expected number of bytes needed to fetch the
1048
1126
        currently pending batch.
1049
1127
    """
1050
1128
 
1051
 
    def __init__(self, gcvf, locations):
 
1129
    def __init__(self, gcvf, locations, get_compressor_settings=None):
1052
1130
        self.gcvf = gcvf
1053
1131
        self.locations = locations
1054
1132
        self.keys = []
1057
1135
        self.total_bytes = 0
1058
1136
        self.last_read_memo = None
1059
1137
        self.manager = None
 
1138
        self._get_compressor_settings = get_compressor_settings
1060
1139
 
1061
1140
    def add_key(self, key):
1062
1141
        """Add another to key to fetch.
1063
 
        
 
1142
 
1064
1143
        :return: The estimated number of bytes needed to fetch the batch so
1065
1144
            far.
1066
1145
        """
1091
1170
            # and then.
1092
1171
            self.batch_memos[read_memo] = cached_block
1093
1172
        return self.total_bytes
1094
 
        
 
1173
 
1095
1174
    def _flush_manager(self):
1096
1175
        if self.manager is not None:
1097
1176
            for factory in self.manager.get_record_stream():
1102
1181
    def yield_factories(self, full_flush=False):
1103
1182
        """Yield factories for keys added since the last yield.  They will be
1104
1183
        returned in the order they were added via add_key.
1105
 
        
 
1184
 
1106
1185
        :param full_flush: by default, some results may not be returned in case
1107
1186
            they can be part of the next batch.  If full_flush is True, then
1108
1187
            all results are returned.
1127
1206
                if memos_to_get_stack and memos_to_get_stack[-1] == read_memo:
1128
1207
                    # The next block from _get_blocks will be the block we
1129
1208
                    # need.
1130
 
                    block_read_memo, block = blocks.next()
 
1209
                    block_read_memo, block = next(blocks)
1131
1210
                    if block_read_memo != read_memo:
1132
1211
                        raise AssertionError(
1133
1212
                            "block_read_memo out of sync with read_memo"
1136
1215
                    memos_to_get_stack.pop()
1137
1216
                else:
1138
1217
                    block = self.batch_memos[read_memo]
1139
 
                self.manager = _LazyGroupContentManager(block)
 
1218
                self.manager = _LazyGroupContentManager(block,
 
1219
                                                        get_compressor_settings=self._get_compressor_settings)
1140
1220
                self.last_read_memo = read_memo
1141
1221
            start, end = index_memo[3:5]
1142
1222
            self.manager.add_factory(key, parents, start, end)
1149
1229
        self.total_bytes = 0
1150
1230
 
1151
1231
 
1152
 
class GroupCompressVersionedFiles(VersionedFiles):
 
1232
class GroupCompressVersionedFiles(VersionedFilesWithFallbacks):
1153
1233
    """A group-compress based VersionedFiles implementation."""
1154
1234
 
1155
 
    def __init__(self, index, access, delta=True, _unadded_refs=None):
 
1235
    # This controls how the GroupCompress DeltaIndex works. Basically, we
 
1236
    # compute hash pointers into the source blocks (so hash(text) => text).
 
1237
    # However each of these references costs some memory in trade against a
 
1238
    # more accurate match result. For very large files, they either are
 
1239
    # pre-compressed and change in bulk whenever they change, or change in just
 
1240
    # local blocks. Either way, 'improved resolution' is not very helpful,
 
1241
    # versus running out of memory trying to track everything. The default max
 
1242
    # gives 100% sampling of a 1MB file.
 
1243
    _DEFAULT_MAX_BYTES_TO_INDEX = 1024 * 1024
 
1244
    _DEFAULT_COMPRESSOR_SETTINGS = {'max_bytes_to_index':
 
1245
                                    _DEFAULT_MAX_BYTES_TO_INDEX}
 
1246
 
 
1247
    def __init__(self, index, access, delta=True, _unadded_refs=None,
 
1248
                 _group_cache=None):
1156
1249
        """Create a GroupCompressVersionedFiles object.
1157
1250
 
1158
1251
        :param index: The index object storing access and graph data.
1159
1252
        :param access: The access object storing raw data.
1160
1253
        :param delta: Whether to delta compress or just entropy compress.
1161
1254
        :param _unadded_refs: private parameter, don't use.
 
1255
        :param _group_cache: private parameter, don't use.
1162
1256
        """
1163
1257
        self._index = index
1164
1258
        self._access = access
1166
1260
        if _unadded_refs is None:
1167
1261
            _unadded_refs = {}
1168
1262
        self._unadded_refs = _unadded_refs
1169
 
        self._group_cache = LRUSizeCache(max_size=50*1024*1024)
1170
 
        self._fallback_vfs = []
 
1263
        if _group_cache is None:
 
1264
            _group_cache = LRUSizeCache(max_size=50 * 1024 * 1024)
 
1265
        self._group_cache = _group_cache
 
1266
        self._immediate_fallback_vfs = []
 
1267
        self._max_bytes_to_index = None
1171
1268
 
1172
1269
    def without_fallbacks(self):
1173
1270
        """Return a clone of this object without any fallbacks configured."""
1174
1271
        return GroupCompressVersionedFiles(self._index, self._access,
1175
 
            self._delta, _unadded_refs=dict(self._unadded_refs))
 
1272
                                           self._delta, _unadded_refs=dict(
 
1273
                                               self._unadded_refs),
 
1274
                                           _group_cache=self._group_cache)
1176
1275
 
1177
1276
    def add_lines(self, key, parents, lines, parent_texts=None,
1178
 
        left_matching_blocks=None, nostore_sha=None, random_id=False,
1179
 
        check_content=True):
 
1277
                  left_matching_blocks=None, nostore_sha=None, random_id=False,
 
1278
                  check_content=True):
1180
1279
        """Add a text to the store.
1181
1280
 
1182
1281
        :param key: The key tuple of the text to add.
1183
1282
        :param parents: The parents key tuples of the text to add.
1184
1283
        :param lines: A list of lines. Each line must be a bytestring. And all
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
 
1284
            of them except the last must be terminated with \\n and contain no
 
1285
            other \\n's. The last line may either contain no \\n's or a single
 
1286
            terminating \\n. If the lines list does meet this constraint the
 
1287
            add routine may error or may succeed - but you will be unable to
 
1288
            read the data back accurately. (Checking the lines have been split
1190
1289
            correctly is expensive and extremely unlikely to catch bugs so it
1191
1290
            is not done at runtime unless check_content is True.)
1192
1291
        :param parent_texts: An optional dictionary containing the opaque
1211
1310
                 back to future add_lines calls in the parent_texts dictionary.
1212
1311
        """
1213
1312
        self._index._check_write_ok()
1214
 
        self._check_add(key, lines, random_id, check_content)
1215
 
        if parents is None:
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.
1219
 
            parents = ()
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
1226
 
 
1227
 
    def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
1228
 
        """See VersionedFiles._add_text()."""
 
1313
        if check_content:
 
1314
            self._check_lines_not_unicode(lines)
 
1315
            self._check_lines_are_lines(lines)
 
1316
        return self.add_content(
 
1317
            ChunkedContentFactory(
 
1318
                key, parents, osutils.sha_strings(lines), lines, chunks_are_lines=True),
 
1319
            parent_texts, left_matching_blocks, nostore_sha, random_id)
 
1320
 
 
1321
    def add_content(self, factory, parent_texts=None,
 
1322
                    left_matching_blocks=None, nostore_sha=None,
 
1323
                    random_id=False):
 
1324
        """Add a text to the store.
 
1325
 
 
1326
        :param factory: A ContentFactory that can be used to retrieve the key,
 
1327
            parents and contents.
 
1328
        :param parent_texts: An optional dictionary containing the opaque
 
1329
            representations of some or all of the parents of version_id to
 
1330
            allow delta optimisations.  VERY IMPORTANT: the texts must be those
 
1331
            returned by add_lines or data corruption can be caused.
 
1332
        :param left_matching_blocks: a hint about which areas are common
 
1333
            between the text and its left-hand-parent.  The format is
 
1334
            the SequenceMatcher.get_matching_blocks format.
 
1335
        :param nostore_sha: Raise ExistingContent and do not add the lines to
 
1336
            the versioned file if the digest of the lines matches this.
 
1337
        :param random_id: If True a random id has been selected rather than
 
1338
            an id determined by some deterministic process such as a converter
 
1339
            from a foreign VCS. When True the backend may choose not to check
 
1340
            for uniqueness of the resulting key within the versioned file, so
 
1341
            this should only be done when the result is expected to be unique
 
1342
            anyway.
 
1343
        :return: The text sha1, the number of bytes in the text, and an opaque
 
1344
                 representation of the inserted version which can be provided
 
1345
                 back to future add_lines calls in the parent_texts dictionary.
 
1346
        """
1229
1347
        self._index._check_write_ok()
1230
 
        self._check_add(key, None, random_id, check_content=False)
1231
 
        if text.__class__ is not str:
1232
 
            raise errors.BzrBadParameterUnicode("text")
 
1348
        parents = factory.parents
 
1349
        self._check_add(factory.key, random_id)
1233
1350
        if parents is None:
1234
1351
            # The caller might pass None if there is no graph data, but kndx
1235
1352
            # indexes can't directly store that, so we give them
1236
1353
            # an empty tuple instead.
1237
1354
            parents = ()
1238
1355
        # double handling for now. Make it work until then.
1239
 
        length = len(text)
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]
 
1356
        sha1, length = list(self._insert_record_stream(
 
1357
            [factory], random_id=random_id, nostore_sha=nostore_sha))[0]
1243
1358
        return sha1, length, None
1244
1359
 
1245
1360
    def add_fallback_versioned_files(self, a_versioned_files):
1247
1362
 
1248
1363
        :param a_versioned_files: A VersionedFiles object.
1249
1364
        """
1250
 
        self._fallback_vfs.append(a_versioned_files)
 
1365
        self._immediate_fallback_vfs.append(a_versioned_files)
1251
1366
 
1252
1367
    def annotate(self, key):
1253
1368
        """See VersionedFiles.annotate."""
1262
1377
        if keys is None:
1263
1378
            keys = self.keys()
1264
1379
            for record in self.get_record_stream(keys, 'unordered', True):
1265
 
                record.get_bytes_as('fulltext')
 
1380
                for chunk in record.iter_bytes_as('chunked'):
 
1381
                    pass
1266
1382
        else:
1267
1383
            return self.get_record_stream(keys, 'unordered', True)
1268
1384
 
1272
1388
        self._index._graph_index.clear_cache()
1273
1389
        self._index._int_cache.clear()
1274
1390
 
1275
 
    def _check_add(self, key, lines, random_id, check_content):
 
1391
    def _check_add(self, key, random_id):
1276
1392
        """check that version_id and lines are safe to add."""
1277
1393
        version_id = key[-1]
1278
1394
        if version_id is not None:
1283
1399
        # probably check that the existing content is identical to what is
1284
1400
        # being inserted, and otherwise raise an exception.  This would make
1285
1401
        # the bundle code simpler.
1286
 
        if check_content:
1287
 
            self._check_lines_not_unicode(lines)
1288
 
            self._check_lines_are_lines(lines)
1289
 
 
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
1294
 
        # ancestry.
1295
 
        parent_map, missing_keys = self._index.find_ancestry(keys)
1296
 
        for fallback in self._fallback_vfs:
1297
 
            if not missing_keys:
1298
 
                break
1299
 
            (f_parent_map, f_missing_keys) = fallback._index.find_ancestry(
1300
 
                                                missing_keys)
1301
 
            parent_map.update(f_parent_map)
1302
 
            missing_keys = f_missing_keys
1303
 
        kg = _mod_graph.KnownGraph(parent_map)
1304
 
        return kg
1305
1402
 
1306
1403
    def get_parent_map(self, keys):
1307
1404
        """Get a map of the graph parents of keys.
1323
1420
            and so on.
1324
1421
        """
1325
1422
        result = {}
1326
 
        sources = [self._index] + self._fallback_vfs
 
1423
        sources = [self._index] + self._immediate_fallback_vfs
1327
1424
        source_results = []
1328
1425
        missing = set(keys)
1329
1426
        for source in sources:
1366
1463
                yield read_memo, cached[read_memo]
1367
1464
            except KeyError:
1368
1465
                # Read the block, and cache it.
1369
 
                zdata = raw_records.next()
 
1466
                zdata = next(raw_records)
1370
1467
                block = GroupCompressBlock.from_bytes(zdata)
1371
1468
                self._group_cache[read_memo] = block
1372
1469
                cached[read_memo] = block
1400
1497
        if not keys:
1401
1498
            return
1402
1499
        if (not self._index.has_graph
1403
 
            and ordering in ('topological', 'groupcompress')):
 
1500
                and ordering in ('topological', 'groupcompress')):
1404
1501
            # Cannot topological order when no graph has been stored.
1405
1502
            # but we allow 'as-requested' or 'unordered'
1406
1503
            ordering = 'unordered'
1410
1507
            try:
1411
1508
                keys = set(remaining_keys)
1412
1509
                for content_factory in self._get_remaining_record_stream(keys,
1413
 
                        orig_keys, ordering, include_delta_closure):
 
1510
                                                                         orig_keys, ordering, include_delta_closure):
1414
1511
                    remaining_keys.discard(content_factory.key)
1415
1512
                    yield content_factory
1416
1513
                return
1417
 
            except errors.RetryWithNewPacks, e:
 
1514
            except errors.RetryWithNewPacks as e:
1418
1515
                self._access.reload_or_raise(e)
1419
1516
 
1420
1517
    def _find_from_fallback(self, missing):
1430
1527
        parent_map = {}
1431
1528
        key_to_source_map = {}
1432
1529
        source_results = []
1433
 
        for source in self._fallback_vfs:
 
1530
        for source in self._immediate_fallback_vfs:
1434
1531
            if not missing:
1435
1532
                break
1436
1533
            source_parents = source.get_parent_map(missing)
1446
1543
 
1447
1544
        The returned objects should be in the order defined by 'ordering',
1448
1545
        which can weave between different sources.
 
1546
 
1449
1547
        :param ordering: Must be one of 'topological' or 'groupcompress'
1450
1548
        :return: List of [(source, [keys])] tuples, such that all keys are in
1451
1549
            the defined order, regardless of source.
1452
1550
        """
1453
1551
        if ordering == 'topological':
1454
 
            present_keys = topo_sort(parent_map)
 
1552
            present_keys = tsort.topo_sort(parent_map)
1455
1553
        else:
1456
1554
            # ordering == 'groupcompress'
1457
1555
            # XXX: This only optimizes for the target ordering. We may need
1479
1577
                source = self
1480
1578
            elif key in key_to_source_map:
1481
1579
                source = key_to_source_map[key]
1482
 
            else: # absent
 
1580
            else:  # absent
1483
1581
                continue
1484
1582
            if source is not current_source:
1485
1583
                source_keys.append((source, []))
1493
1591
            # This is the group the bytes are stored in, followed by the
1494
1592
            # location in the group
1495
1593
            return locations[key][0]
1496
 
        present_keys = sorted(locations.iterkeys(), key=get_group)
1497
1594
        # We don't have an ordering for keys in the in-memory object, but
1498
1595
        # lets process the in-memory ones first.
1499
 
        present_keys = list(unadded_keys) + present_keys
 
1596
        present_keys = list(unadded_keys)
 
1597
        present_keys.extend(sorted(locations, key=get_group))
1500
1598
        # Now grab all of the ones from other sources
1501
1599
        source_keys = [(self, present_keys)]
1502
1600
        source_keys.extend(source_result)
1526
1624
            # start with one key, recurse to its oldest parent, then grab
1527
1625
            # everything in the same group, etc.
1528
1626
            parent_map = dict((key, details[2]) for key, details in
1529
 
                locations.iteritems())
 
1627
                              locations.items())
1530
1628
            for key in unadded_keys:
1531
1629
                parent_map[key] = self._unadded_refs[key]
1532
1630
            parent_map.update(fallback_parent_map)
1534
1632
                                                        key_to_source_map)
1535
1633
        elif ordering == 'as-requested':
1536
1634
            source_keys = self._get_as_requested_source_keys(orig_keys,
1537
 
                locations, unadded_keys, key_to_source_map)
 
1635
                                                             locations, unadded_keys, key_to_source_map)
1538
1636
        else:
1539
1637
            # We want to yield the keys in a semi-optimal (read-wise) ordering.
1540
1638
            # Otherwise we thrash the _group_cache and destroy performance
1541
1639
            source_keys = self._get_io_ordered_source_keys(locations,
1542
 
                unadded_keys, source_result)
 
1640
                                                           unadded_keys, source_result)
1543
1641
        for key in missing:
1544
1642
            yield AbsentContentFactory(key)
1545
1643
        # Batch up as many keys as we can until either:
1546
1644
        #  - we encounter an unadded ref, or
1547
1645
        #  - we run out of keys, or
1548
1646
        #  - the total bytes to retrieve for this batch > BATCH_SIZE
1549
 
        batcher = _BatchingBlockFetcher(self, locations)
 
1647
        batcher = _BatchingBlockFetcher(self, locations,
 
1648
                                        get_compressor_settings=self._get_compressor_settings)
1550
1649
        for source, keys in source_keys:
1551
1650
            if source is self:
1552
1651
                for key in keys:
1555
1654
                        # self._compressor.
1556
1655
                        for factory in batcher.yield_factories(full_flush=True):
1557
1656
                            yield factory
1558
 
                        bytes, sha1 = self._compressor.extract(key)
 
1657
                        chunks, sha1 = self._compressor.extract(key)
1559
1658
                        parents = self._unadded_refs[key]
1560
 
                        yield FulltextContentFactory(key, parents, sha1, bytes)
 
1659
                        yield ChunkedContentFactory(key, parents, sha1, chunks)
1561
1660
                        continue
1562
1661
                    if batcher.add_key(key) > BATCH_SIZE:
1563
1662
                        # Ok, this batch is big enough.  Yield some results.
1576
1675
        """See VersionedFiles.get_sha1s()."""
1577
1676
        result = {}
1578
1677
        for record in self.get_record_stream(keys, 'unordered', True):
1579
 
            if record.sha1 != None:
 
1678
            if record.sha1 is not None:
1580
1679
                result[record.key] = record.sha1
1581
1680
            else:
1582
1681
                if record.storage_kind != 'absent':
1583
 
                    result[record.key] = osutils.sha_string(
1584
 
                        record.get_bytes_as('fulltext'))
 
1682
                    result[record.key] = osutils.sha_strings(
 
1683
                        record.iter_bytes_as('chunked'))
1585
1684
        return result
1586
1685
 
1587
1686
    def insert_record_stream(self, stream):
1595
1694
        # test_insert_record_stream_existing_keys fail for groupcompress and
1596
1695
        # groupcompress-nograph, this needs to be revisited while addressing
1597
1696
        # 'bzr branch' performance issues.
1598
 
        for _ in self._insert_record_stream(stream, random_id=False):
 
1697
        for _, _ in self._insert_record_stream(stream, random_id=False):
1599
1698
            pass
1600
1699
 
 
1700
    def _get_compressor_settings(self):
 
1701
        if self._max_bytes_to_index is None:
 
1702
            # TODO: VersionedFiles don't know about their containing
 
1703
            #       repository, so they don't have much of an idea about their
 
1704
            #       location. So for now, this is only a global option.
 
1705
            c = config.GlobalConfig()
 
1706
            val = c.get_user_option('bzr.groupcompress.max_bytes_to_index')
 
1707
            if val is not None:
 
1708
                try:
 
1709
                    val = int(val)
 
1710
                except ValueError as e:
 
1711
                    trace.warning('Value for '
 
1712
                                  '"bzr.groupcompress.max_bytes_to_index"'
 
1713
                                  ' %r is not an integer'
 
1714
                                  % (val,))
 
1715
                    val = None
 
1716
            if val is None:
 
1717
                val = self._DEFAULT_MAX_BYTES_TO_INDEX
 
1718
            self._max_bytes_to_index = val
 
1719
        return {'max_bytes_to_index': self._max_bytes_to_index}
 
1720
 
 
1721
    def _make_group_compressor(self):
 
1722
        return GroupCompressor(self._get_compressor_settings())
 
1723
 
1601
1724
    def _insert_record_stream(self, stream, random_id=False, nostore_sha=None,
1602
1725
                              reuse_blocks=True):
1603
1726
        """Internal core to insert a record stream into this container.
1611
1734
        :param reuse_blocks: If the source is streaming from
1612
1735
            groupcompress-blocks, just insert the blocks as-is, rather than
1613
1736
            expanding the texts and inserting again.
1614
 
        :return: An iterator over the sha1 of the inserted records.
 
1737
        :return: An iterator over (sha1, length) of the inserted records.
1615
1738
        :seealso insert_record_stream:
1616
1739
        :seealso add_lines:
1617
1740
        """
1618
1741
        adapters = {}
 
1742
 
1619
1743
        def get_adapter(adapter_key):
1620
1744
            try:
1621
1745
                return adapters[adapter_key]
1626
1750
                return adapter
1627
1751
        # This will go up to fulltexts for gc to gc fetching, which isn't
1628
1752
        # ideal.
1629
 
        self._compressor = GroupCompressor()
 
1753
        self._compressor = self._make_group_compressor()
1630
1754
        self._unadded_refs = {}
1631
1755
        keys_to_add = []
 
1756
 
1632
1757
        def flush():
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]
 
1758
            bytes_len, chunks = self._compressor.flush().to_chunks()
 
1759
            self._compressor = self._make_group_compressor()
 
1760
            # Note: At this point we still have 1 copy of the fulltext (in
 
1761
            #       record and the var 'bytes'), and this generates 2 copies of
 
1762
            #       the compressed text (one for bytes, one in chunks)
 
1763
            # TODO: Figure out how to indicate that we would be happy to free
 
1764
            #       the fulltext content at this point. Note that sometimes we
 
1765
            #       will want it later (streaming CHK pages), but most of the
 
1766
            #       time we won't (everything else)
 
1767
            index, start, length = self._access.add_raw_record(
 
1768
                None, bytes_len, chunks)
1637
1769
            nodes = []
1638
1770
            for key, reads, refs in keys_to_add:
1639
 
                nodes.append((key, "%d %d %s" % (start, length, reads), refs))
 
1771
                nodes.append((key, b"%d %d %s" % (start, length, reads), refs))
1640
1772
            self._index.add_records(nodes, random_id=random_id)
1641
1773
            self._unadded_refs = {}
1642
1774
            del keys_to_add[:]
1656
1788
                raise errors.RevisionNotPresent(record.key, self)
1657
1789
            if random_id:
1658
1790
                if record.key in inserted_keys:
1659
 
                    trace.note('Insert claimed random_id=True,'
1660
 
                               ' but then inserted %r two times', record.key)
 
1791
                    trace.note(gettext('Insert claimed random_id=True,'
 
1792
                                       ' but then inserted %r two times'), record.key)
1661
1793
                    continue
1662
1794
                inserted_keys.add(record.key)
1663
1795
            if reuse_blocks:
1677
1809
                if record.storage_kind == 'groupcompress-block':
1678
1810
                    # Insert the raw block into the target repo
1679
1811
                    insert_manager = record._manager
1680
 
                    bytes = record._manager._block.to_bytes()
1681
 
                    _, start, length = self._access.add_raw_records(
1682
 
                        [(None, len(bytes))], bytes)[0]
1683
 
                    del bytes
 
1812
                    bytes_len, chunks = record._manager._block.to_chunks()
 
1813
                    _, start, length = self._access.add_raw_record(
 
1814
                        None, bytes_len, chunks)
1684
1815
                    block_start = start
1685
1816
                    block_length = length
1686
1817
                if record.storage_kind in ('groupcompress-block',
1689
1820
                        raise AssertionError('No insert_manager set')
1690
1821
                    if insert_manager is not record._manager:
1691
1822
                        raise AssertionError('insert_manager does not match'
1692
 
                            ' the current record, we cannot be positive'
1693
 
                            ' that the appropriate content was inserted.'
1694
 
                            )
1695
 
                    value = "%d %d %d %d" % (block_start, block_length,
1696
 
                                             record._start, record._end)
 
1823
                                             ' the current record, we cannot be positive'
 
1824
                                             ' that the appropriate content was inserted.'
 
1825
                                             )
 
1826
                    value = b"%d %d %d %d" % (block_start, block_length,
 
1827
                                              record._start, record._end)
1697
1828
                    nodes = [(record.key, value, (record.parents,))]
1698
1829
                    # TODO: Consider buffering up many nodes to be added, not
1699
1830
                    #       sure how much overhead this has, but we're seeing
1701
1832
                    self._index.add_records(nodes, random_id=random_id)
1702
1833
                    continue
1703
1834
            try:
1704
 
                bytes = record.get_bytes_as('fulltext')
 
1835
                chunks = record.get_bytes_as('chunked')
1705
1836
            except errors.UnavailableRepresentation:
1706
 
                adapter_key = record.storage_kind, 'fulltext'
 
1837
                adapter_key = record.storage_kind, 'chunked'
1707
1838
                adapter = get_adapter(adapter_key)
1708
 
                bytes = adapter.get_bytes(record)
 
1839
                chunks = adapter.get_bytes(record, 'chunked')
 
1840
            chunks_len = record.size
 
1841
            if chunks_len is None:
 
1842
                chunks_len = sum(map(len, chunks))
1709
1843
            if len(record.key) > 1:
1710
1844
                prefix = record.key[0]
1711
1845
                soft = (prefix == last_prefix)
1712
1846
            else:
1713
1847
                prefix = None
1714
1848
                soft = False
1715
 
            if max_fulltext_len < len(bytes):
1716
 
                max_fulltext_len = len(bytes)
 
1849
            if max_fulltext_len < chunks_len:
 
1850
                max_fulltext_len = chunks_len
1717
1851
                max_fulltext_prefix = prefix
1718
1852
            (found_sha1, start_point, end_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)
 
1853
             type) = self._compressor.compress(
 
1854
                 record.key, chunks, chunks_len, record.sha1, soft=soft,
 
1855
                 nostore_sha=nostore_sha)
 
1856
            # delta_ratio = float(chunks_len) / (end_point - start_point)
1723
1857
            # Check if we want to continue to include that text
1724
1858
            if (prefix == max_fulltext_prefix
1725
 
                and end_point < 2 * max_fulltext_len):
 
1859
                    and end_point < 2 * max_fulltext_len):
1726
1860
                # As long as we are on the same file_id, we will fill at least
1727
1861
                # 2 * max_fulltext_len
1728
1862
                start_new_block = False
1729
 
            elif end_point > 4*1024*1024:
 
1863
            elif end_point > 4 * 1024 * 1024:
1730
1864
                start_new_block = True
1731
1865
            elif (prefix is not None and prefix != last_prefix
1732
 
                  and end_point > 2*1024*1024):
 
1866
                  and end_point > 2 * 1024 * 1024):
1733
1867
                start_new_block = True
1734
1868
            else:
1735
1869
                start_new_block = False
1737
1871
            if start_new_block:
1738
1872
                self._compressor.pop_last()
1739
1873
                flush()
1740
 
                max_fulltext_len = len(bytes)
 
1874
                max_fulltext_len = chunks_len
1741
1875
                (found_sha1, start_point, end_point,
1742
 
                 type) = self._compressor.compress(record.key, bytes,
1743
 
                                                   record.sha1)
 
1876
                 type) = self._compressor.compress(
 
1877
                     record.key, chunks, chunks_len, record.sha1)
1744
1878
            if record.key[-1] is None:
1745
 
                key = record.key[:-1] + ('sha1:' + found_sha1,)
 
1879
                key = record.key[:-1] + (b'sha1:' + found_sha1,)
1746
1880
            else:
1747
1881
                key = record.key
1748
1882
            self._unadded_refs[key] = record.parents
1749
 
            yield found_sha1
 
1883
            yield found_sha1, chunks_len
1750
1884
            as_st = static_tuple.StaticTuple.from_sequence
1751
1885
            if record.parents is not None:
1752
1886
                parents = as_st([as_st(p) for p in record.parents])
1753
1887
            else:
1754
1888
                parents = None
1755
1889
            refs = static_tuple.StaticTuple(parents)
1756
 
            keys_to_add.append((key, '%d %d' % (start_point, end_point), refs))
 
1890
            keys_to_add.append(
 
1891
                (key, b'%d %d' % (start_point, end_point), refs))
1757
1892
        if len(keys_to_add):
1758
1893
            flush()
1759
1894
        self._compressor = None
1785
1920
        # but we need to setup a list of records to visit.
1786
1921
        # we need key, position, length
1787
1922
        for key_idx, record in enumerate(self.get_record_stream(keys,
1788
 
            'unordered', True)):
 
1923
                                                                'unordered', True)):
1789
1924
            # XXX: todo - optimise to use less than full texts.
1790
1925
            key = record.key
1791
1926
            if pb is not None:
1792
1927
                pb.update('Walking content', key_idx, total)
1793
1928
            if record.storage_kind == 'absent':
1794
1929
                raise errors.RevisionNotPresent(key, self)
1795
 
            lines = osutils.split_lines(record.get_bytes_as('fulltext'))
1796
 
            for line in lines:
 
1930
            for line in record.iter_bytes_as('lines'):
1797
1931
                yield line, key
1798
1932
        if pb is not None:
1799
1933
            pb.update('Walking content', total, total)
1802
1936
        """See VersionedFiles.keys."""
1803
1937
        if 'evil' in debug.debug_flags:
1804
1938
            trace.mutter_callsite(2, "keys scales with size of history")
1805
 
        sources = [self._index] + self._fallback_vfs
 
1939
        sources = [self._index] + self._immediate_fallback_vfs
1806
1940
        result = set()
1807
1941
        for source in sources:
1808
1942
            result.update(source.keys())
1809
1943
        return result
1810
1944
 
1811
1945
 
 
1946
class _GCBuildDetails(object):
 
1947
    """A blob of data about the build details.
 
1948
 
 
1949
    This stores the minimal data, which then allows compatibility with the old
 
1950
    api, without taking as much memory.
 
1951
    """
 
1952
 
 
1953
    __slots__ = ('_index', '_group_start', '_group_end', '_basis_end',
 
1954
                 '_delta_end', '_parents')
 
1955
 
 
1956
    method = 'group'
 
1957
    compression_parent = None
 
1958
 
 
1959
    def __init__(self, parents, position_info):
 
1960
        self._parents = parents
 
1961
        (self._index, self._group_start, self._group_end, self._basis_end,
 
1962
         self._delta_end) = position_info
 
1963
 
 
1964
    def __repr__(self):
 
1965
        return '%s(%s, %s)' % (self.__class__.__name__,
 
1966
                               self.index_memo, self._parents)
 
1967
 
 
1968
    @property
 
1969
    def index_memo(self):
 
1970
        return (self._index, self._group_start, self._group_end,
 
1971
                self._basis_end, self._delta_end)
 
1972
 
 
1973
    @property
 
1974
    def record_details(self):
 
1975
        return static_tuple.StaticTuple(self.method, None)
 
1976
 
 
1977
    def __getitem__(self, offset):
 
1978
        """Compatibility thunk to act like a tuple."""
 
1979
        if offset == 0:
 
1980
            return self.index_memo
 
1981
        elif offset == 1:
 
1982
            return self.compression_parent  # Always None
 
1983
        elif offset == 2:
 
1984
            return self._parents
 
1985
        elif offset == 3:
 
1986
            return self.record_details
 
1987
        else:
 
1988
            raise IndexError('offset out of range')
 
1989
 
 
1990
    def __len__(self):
 
1991
        return 4
 
1992
 
 
1993
 
1812
1994
class _GCGraphIndex(object):
1813
1995
    """Mapper from GroupCompressVersionedFiles needs into GraphIndex storage."""
1814
1996
 
1815
1997
    def __init__(self, graph_index, is_locked, parents=True,
1816
 
        add_callback=None, track_external_parent_refs=False,
1817
 
        inconsistency_fatal=True, track_new_keys=False):
 
1998
                 add_callback=None, track_external_parent_refs=False,
 
1999
                 inconsistency_fatal=True, track_new_keys=False):
1818
2000
        """Construct a _GCGraphIndex on a graph_index.
1819
2001
 
1820
 
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
 
2002
        :param graph_index: An implementation of breezy.index.GraphIndex.
1821
2003
        :param is_locked: A callback, returns True if the index is locked and
1822
2004
            thus usable.
1823
2005
        :param parents: If True, record knits parents, if not do not record
1843
2025
        # repeated over and over, this creates a surplus of ints
1844
2026
        self._int_cache = {}
1845
2027
        if track_external_parent_refs:
1846
 
            self._key_dependencies = knit._KeyRefs(
 
2028
            self._key_dependencies = _KeyRefs(
1847
2029
                track_new_keys=track_new_keys)
1848
2030
        else:
1849
2031
            self._key_dependencies = None
1873
2055
                if refs:
1874
2056
                    for ref in refs:
1875
2057
                        if ref:
1876
 
                            raise errors.KnitCorrupt(self,
1877
 
                                "attempt to add node with parents "
1878
 
                                "in parentless index.")
 
2058
                            raise knit.KnitCorrupt(self,
 
2059
                                                   "attempt to add node with parents "
 
2060
                                                   "in parentless index.")
1879
2061
                    refs = ()
1880
2062
                    changed = True
1881
2063
            keys[key] = (value, refs)
1889
2071
                if node_refs != passed[1]:
1890
2072
                    details = '%s %s %s' % (key, (value, node_refs), passed)
1891
2073
                    if self._inconsistency_fatal:
1892
 
                        raise errors.KnitCorrupt(self, "inconsistent details"
1893
 
                                                 " in add_records: %s" %
1894
 
                                                 details)
 
2074
                        raise knit.KnitCorrupt(self, "inconsistent details"
 
2075
                                               " in add_records: %s" %
 
2076
                                               details)
1895
2077
                    else:
1896
2078
                        trace.warning("inconsistent details in skipped"
1897
2079
                                      " record: %s", details)
1900
2082
        if changed:
1901
2083
            result = []
1902
2084
            if self._parents:
1903
 
                for key, (value, node_refs) in keys.iteritems():
 
2085
                for key, (value, node_refs) in keys.items():
1904
2086
                    result.append((key, value, node_refs))
1905
2087
            else:
1906
 
                for key, (value, node_refs) in keys.iteritems():
 
2088
                for key, (value, node_refs) in keys.items():
1907
2089
                    result.append((key, value))
1908
2090
            records = result
1909
2091
        key_dependencies = self._key_dependencies
1989
2171
        :param keys: An iterable of keys.
1990
2172
        :return: A dict of key:
1991
2173
            (index_memo, compression_parent, parents, record_details).
1992
 
            index_memo
1993
 
                opaque structure to pass to read_records to extract the raw
1994
 
                data
1995
 
            compression_parent
1996
 
                Content that this record is built upon, may be None
1997
 
            parents
1998
 
                Logical parents of this node
1999
 
            record_details
2000
 
                extra information about the content which needs to be passed to
2001
 
                Factory.parse_record
 
2174
 
 
2175
            * index_memo: opaque structure to pass to read_records to extract
 
2176
              the raw data
 
2177
            * compression_parent: Content that this record is built upon, may
 
2178
              be None
 
2179
            * parents: Logical parents of this node
 
2180
            * record_details: extra information about the content which needs
 
2181
              to be passed to Factory.parse_record
2002
2182
        """
2003
2183
        self._check_read()
2004
2184
        result = {}
2009
2189
                parents = None
2010
2190
            else:
2011
2191
                parents = entry[3][0]
2012
 
            method = 'group'
2013
 
            result[key] = (self._node_to_position(entry),
2014
 
                                  None, parents, (method, None))
 
2192
            details = _GCBuildDetails(parents, self._node_to_position(entry))
 
2193
            result[key] = details
2015
2194
        return result
2016
2195
 
2017
2196
    def keys(self):
2024
2203
 
2025
2204
    def _node_to_position(self, node):
2026
2205
        """Convert an index value to position details."""
2027
 
        bits = node[2].split(' ')
 
2206
        bits = node[2].split(b' ')
2028
2207
        # It would be nice not to read the entire gzip.
2029
2208
        # start and stop are put into _int_cache because they are very common.
2030
2209
        # They define the 'group' that an entry is in, and many groups can have
2033
2212
        # each, or about 7MB. Note that it might be even more when you consider
2034
2213
        # how PyInt is allocated in separate slabs. And you can't return a slab
2035
2214
        # to the OS if even 1 int on it is in use. Note though that Python uses
2036
 
        # a LIFO when re-using PyInt slots, which probably causes more
 
2215
        # a LIFO when re-using PyInt slots, which might cause more
2037
2216
        # fragmentation.
2038
2217
        start = int(bits[0])
2039
2218
        start = self._int_cache.setdefault(start, start)
2063
2242
            key_dependencies.add_references(node[1], node[3][0])
2064
2243
 
2065
2244
 
2066
 
from bzrlib._groupcompress_py import (
 
2245
from ._groupcompress_py import (
2067
2246
    apply_delta,
2068
2247
    apply_delta_to_source,
2069
2248
    encode_base128_int,
2072
2251
    LinesDeltaIndex,
2073
2252
    )
2074
2253
try:
2075
 
    from bzrlib._groupcompress_pyx import (
 
2254
    from ._groupcompress_pyx import (
2076
2255
        apply_delta,
2077
2256
        apply_delta_to_source,
2078
2257
        DeltaIndex,
2080
2259
        decode_base128_int,
2081
2260
        )
2082
2261
    GroupCompressor = PyrexGroupCompressor
2083
 
except ImportError, e:
 
2262
except ImportError as e:
2084
2263
    osutils.failed_to_load_extension(e)
2085
2264
    GroupCompressor = PythonGroupCompressor
2086