/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-03-22 20:02:36 UTC
  • mto: (7490.7.7 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200322200236-fsbl91ktcn6fcbdd
Fix tests.

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