~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/groupcompress.py

  • Committer: John Arbash Meinel
  • Date: 2009-03-27 22:29:55 UTC
  • mto: (3735.39.2 clean)
  • mto: This revision was merged to the branch mainline in revision 4280.
  • Revision ID: john@arbash-meinel.com-20090327222955-utifmfm888zerixt
Implement apply_delta_to_source which doesn't have to malloc another string.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2008, 2009 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 itertools import izip
 
20
from cStringIO import StringIO
19
21
import time
20
22
import zlib
21
23
try:
26
28
from bzrlib import (
27
29
    annotate,
28
30
    debug,
 
31
    diff,
29
32
    errors,
30
33
    graph as _mod_graph,
31
 
    knit,
32
34
    osutils,
33
35
    pack,
34
 
    static_tuple,
 
36
    patiencediff,
35
37
    trace,
36
38
    )
 
39
from bzrlib.graph import Graph
 
40
from bzrlib.knit import _DirectPackAccess
37
41
from bzrlib.btree_index import BTreeBuilder
38
42
from bzrlib.lru_cache import LRUSizeCache
39
43
from bzrlib.tsort import topo_sort
45
49
    VersionedFiles,
46
50
    )
47
51
 
48
 
# Minimum number of uncompressed bytes to try fetch at once when retrieving
49
 
# groupcompress blocks.
50
 
BATCH_SIZE = 2**16
51
 
 
52
52
_USE_LZMA = False and (pylzma is not None)
53
53
 
54
54
# osutils.sha_string('')
55
55
_null_sha1 = 'da39a3ee5e6b4b0d3255bfef95601890afd80709'
56
56
 
 
57
 
57
58
def sort_gc_optimal(parent_map):
58
59
    """Sort and group the keys in parent_map into groupcompress order.
59
60
 
65
66
    # groupcompress ordering is approximately reverse topological,
66
67
    # properly grouped by file-id.
67
68
    per_prefix_map = {}
68
 
    for key, value in parent_map.iteritems():
 
69
    for item in parent_map.iteritems():
 
70
        key = item[0]
69
71
        if isinstance(key, str) or len(key) == 1:
70
72
            prefix = ''
71
73
        else:
72
74
            prefix = key[0]
73
75
        try:
74
 
            per_prefix_map[prefix][key] = value
 
76
            per_prefix_map[prefix].append(item)
75
77
        except KeyError:
76
 
            per_prefix_map[prefix] = {key: value}
 
78
            per_prefix_map[prefix] = [item]
77
79
 
78
80
    present_keys = []
79
81
    for prefix in sorted(per_prefix_map):
94
96
 
95
97
    # Group Compress Block v1 Zlib
96
98
    GCB_HEADER = 'gcb1z\n'
97
 
    # Group Compress Block v1 Lzma
98
99
    GCB_LZ_HEADER = 'gcb1l\n'
99
 
    GCB_KNOWN_HEADERS = (GCB_HEADER, GCB_LZ_HEADER)
100
100
 
101
101
    def __init__(self):
102
102
        # map by key? or just order in file?
106
106
        self._z_content_length = None
107
107
        self._content_length = None
108
108
        self._content = None
109
 
        self._content_chunks = None
110
109
 
111
110
    def __len__(self):
112
111
        # This is the maximum number of bytes this object will reference if
120
119
        :param num_bytes: Ensure that we have extracted at least num_bytes of
121
120
            content. If None, consume everything
122
121
        """
123
 
        if self._content_length is None:
124
 
            raise AssertionError('self._content_length should never be None')
 
122
        # TODO: If we re-use the same content block at different times during
 
123
        #       get_record_stream(), it is possible that the first pass will
 
124
        #       get inserted, triggering an extract/_ensure_content() which
 
125
        #       will get rid of _z_content. And then the next use of the block
 
126
        #       will try to access _z_content (to send it over the wire), and
 
127
        #       fail because it is already extracted. Consider never releasing
 
128
        #       _z_content because of this.
125
129
        if num_bytes is None:
126
130
            num_bytes = self._content_length
127
 
        elif (self._content_length is not None
128
 
              and num_bytes > self._content_length):
129
 
            raise AssertionError(
130
 
                'requested num_bytes (%d) > content length (%d)'
131
 
                % (num_bytes, self._content_length))
132
 
        # Expand the content if required
133
 
        if self._content is None:
134
 
            if self._content_chunks is not None:
135
 
                self._content = ''.join(self._content_chunks)
136
 
                self._content_chunks = None
137
 
        if self._content is None:
138
 
            if self._z_content is None:
139
 
                raise AssertionError('No content to decompress')
 
131
        if self._content_length is not None:
 
132
            assert num_bytes <= self._content_length
 
133
        if self._content is None:
 
134
            assert self._z_content is not None
140
135
            if self._z_content == '':
141
136
                self._content = ''
142
137
            elif self._compressor_name == 'lzma':
143
138
                # We don't do partial lzma decomp yet
144
139
                self._content = pylzma.decompress(self._z_content)
145
 
            elif self._compressor_name == 'zlib':
 
140
            else:
146
141
                # Start a zlib decompressor
147
 
                if num_bytes * 4 > self._content_length * 3:
148
 
                    # If we are requesting more that 3/4ths of the content,
149
 
                    # just extract the whole thing in a single pass
150
 
                    num_bytes = self._content_length
 
142
                assert self._compressor_name == 'zlib'
 
143
                if num_bytes is None:
151
144
                    self._content = zlib.decompress(self._z_content)
152
145
                else:
153
146
                    self._z_content_decompressor = zlib.decompressobj()
155
148
                    # that the rest of the code is simplified
156
149
                    self._content = self._z_content_decompressor.decompress(
157
150
                        self._z_content, num_bytes + _ZLIB_DECOMP_WINDOW)
158
 
                    if not self._z_content_decompressor.unconsumed_tail:
159
 
                        self._z_content_decompressor = None
160
 
            else:
161
 
                raise AssertionError('Unknown compressor: %r'
162
 
                                     % self._compressor_name)
163
 
        # Any bytes remaining to be decompressed will be in the decompressors
164
 
        # 'unconsumed_tail'
165
 
 
 
151
                # Any bytes remaining to be decompressed will be in the
 
152
                # decompressors 'unconsumed_tail'
166
153
        # Do we have enough bytes already?
167
 
        if len(self._content) >= num_bytes:
 
154
        if num_bytes is not None and len(self._content) >= num_bytes:
 
155
            return
 
156
        if num_bytes is None and self._z_content_decompressor is None:
 
157
            # We must have already decompressed everything
168
158
            return
169
159
        # If we got this far, and don't have a decompressor, something is wrong
170
 
        if self._z_content_decompressor is None:
171
 
            raise AssertionError(
172
 
                'No decompressor to decompress %d bytes' % num_bytes)
 
160
        assert self._z_content_decompressor is not None
173
161
        remaining_decomp = self._z_content_decompressor.unconsumed_tail
174
 
        if not remaining_decomp:
175
 
            raise AssertionError('Nothing left to decompress')
176
 
        needed_bytes = num_bytes - len(self._content)
177
 
        # We always set max_size to 32kB over the minimum needed, so that
178
 
        # zlib will give us as much as we really want.
179
 
        # TODO: If this isn't good enough, we could make a loop here,
180
 
        #       that keeps expanding the request until we get enough
181
 
        self._content += self._z_content_decompressor.decompress(
182
 
            remaining_decomp, needed_bytes + _ZLIB_DECOMP_WINDOW)
183
 
        if len(self._content) < num_bytes:
184
 
            raise AssertionError('%d bytes wanted, only %d available'
185
 
                                 % (num_bytes, len(self._content)))
186
 
        if not self._z_content_decompressor.unconsumed_tail:
187
 
            # The stream is finished
188
 
            self._z_content_decompressor = None
 
162
        if num_bytes is None:
 
163
            if remaining_decomp:
 
164
                # We don't know how much is left, but we'll decompress it all
 
165
                self._content += self._z_content_decompressor.decompress(
 
166
                    remaining_decomp)
 
167
                # Note: There what I consider a bug in zlib.decompressobj
 
168
                #       If you pass back in the entire unconsumed_tail, only
 
169
                #       this time you don't pass a max-size, it doesn't
 
170
                #       change the unconsumed_tail back to None/''.
 
171
                #       However, we know we are done with the whole stream
 
172
                self._z_content_decompressor = None
 
173
            self._content_length = len(self._content)
 
174
        else:
 
175
            # If we have nothing left to decomp, we ran out of decomp bytes
 
176
            assert remaining_decomp
 
177
            needed_bytes = num_bytes - len(self._content)
 
178
            # We always set max_size to 32kB over the minimum needed, so that
 
179
            # zlib will give us as much as we really want.
 
180
            # TODO: If this isn't good enough, we could make a loop here,
 
181
            #       that keeps expanding the request until we get enough
 
182
            self._content += self._z_content_decompressor.decompress(
 
183
                remaining_decomp, needed_bytes + _ZLIB_DECOMP_WINDOW)
 
184
            assert len(self._content) >= num_bytes
 
185
            if not self._z_content_decompressor.unconsumed_tail:
 
186
                # The stream is finished
 
187
                self._z_content_decompressor = None
189
188
 
190
189
    def _parse_bytes(self, bytes, pos):
191
190
        """Read the various lengths from the header.
203
202
        pos2 = bytes.index('\n', pos, pos + 14)
204
203
        self._content_length = int(bytes[pos:pos2])
205
204
        pos = pos2 + 1
206
 
        if len(bytes) != (pos + self._z_content_length):
207
 
            # XXX: Define some GCCorrupt error ?
208
 
            raise AssertionError('Invalid bytes: (%d) != %d + %d' %
209
 
                                 (len(bytes), pos, self._z_content_length))
 
205
        assert len(bytes) == (pos + self._z_content_length)
210
206
        self._z_content = bytes[pos:]
 
207
        assert len(self._z_content) == self._z_content_length
211
208
 
212
209
    @classmethod
213
210
    def from_bytes(cls, bytes):
214
211
        out = cls()
215
 
        if bytes[:6] not in cls.GCB_KNOWN_HEADERS:
216
 
            raise ValueError('bytes did not start with any of %r'
217
 
                             % (cls.GCB_KNOWN_HEADERS,))
218
 
        # XXX: why not testing the whole header ?
 
212
        if bytes[:6] not in (cls.GCB_HEADER, cls.GCB_LZ_HEADER):
 
213
            raise ValueError('bytes did not start with %r' % (cls.GCB_HEADER,))
219
214
        if bytes[4] == 'z':
220
215
            out._compressor_name = 'zlib'
221
216
        elif bytes[4] == 'l':
259
254
            bytes = apply_delta_to_source(self._content, content_start, end)
260
255
        return bytes
261
256
 
262
 
    def set_chunked_content(self, content_chunks, length):
263
 
        """Set the content of this block to the given chunks."""
264
 
        # If we have lots of short lines, it is may be more efficient to join
265
 
        # the content ahead of time. If the content is <10MiB, we don't really
266
 
        # care about the extra memory consumption, so we can just pack it and
267
 
        # be done. However, timing showed 18s => 17.9s for repacking 1k revs of
268
 
        # mysql, which is below the noise margin
269
 
        self._content_length = length
270
 
        self._content_chunks = content_chunks
271
 
        self._content = None
272
 
        self._z_content = None
273
 
 
274
257
    def set_content(self, content):
275
258
        """Set the content of this block."""
276
259
        self._content_length = len(content)
277
260
        self._content = content
278
261
        self._z_content = None
279
262
 
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):
290
 
        compressor = zlib.compressobj(zlib.Z_DEFAULT_COMPRESSION)
291
 
        compressed_chunks = map(compressor.compress, self._content_chunks)
292
 
        compressed_chunks.append(compressor.flush())
293
 
        self._z_content = ''.join(compressed_chunks)
294
 
        self._z_content_length = len(self._z_content)
295
 
 
296
 
    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()
301
 
            return
302
 
        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)
307
 
 
308
263
    def to_bytes(self):
309
264
        """Encode the information into a byte stream."""
310
 
        self._create_z_content()
 
265
        compress = zlib.compress
 
266
        if _USE_LZMA:
 
267
            compress = pylzma.compress
 
268
        if self._z_content is None:
 
269
            assert self._content is not None
 
270
            self._z_content = compress(self._content)
 
271
            self._z_content_length = len(self._z_content)
311
272
        if _USE_LZMA:
312
273
            header = self.GCB_LZ_HEADER
313
274
        else:
318
279
                 ]
319
280
        return ''.join(chunks)
320
281
 
321
 
    def _dump(self, include_text=False):
322
 
        """Take this block, and spit out a human-readable structure.
323
 
 
324
 
        :param include_text: Inserts also include text bits, chose whether you
325
 
            want this displayed in the dump or not.
326
 
        :return: A dump of the given block. The layout is something like:
327
 
            [('f', length), ('d', delta_length, text_length, [delta_info])]
328
 
            delta_info := [('i', num_bytes, text), ('c', offset, num_bytes),
329
 
            ...]
330
 
        """
331
 
        self._ensure_content()
332
 
        result = []
333
 
        pos = 0
334
 
        while pos < self._content_length:
335
 
            kind = self._content[pos]
336
 
            pos += 1
337
 
            if kind not in ('f', 'd'):
338
 
                raise ValueError('invalid kind character: %r' % (kind,))
339
 
            content_len, len_len = decode_base128_int(
340
 
                                self._content[pos:pos + 5])
341
 
            pos += len_len
342
 
            if content_len + pos > self._content_length:
343
 
                raise ValueError('invalid content_len %d for record @ pos %d'
344
 
                                 % (content_len, pos - len_len - 1))
345
 
            if kind == 'f': # Fulltext
346
 
                if include_text:
347
 
                    text = self._content[pos:pos+content_len]
348
 
                    result.append(('f', content_len, text))
349
 
                else:
350
 
                    result.append(('f', content_len))
351
 
            elif kind == 'd': # Delta
352
 
                delta_content = self._content[pos:pos+content_len]
353
 
                delta_info = []
354
 
                # The first entry in a delta is the decompressed length
355
 
                decomp_len, delta_pos = decode_base128_int(delta_content)
356
 
                result.append(('d', content_len, decomp_len, delta_info))
357
 
                measured_len = 0
358
 
                while delta_pos < content_len:
359
 
                    c = ord(delta_content[delta_pos])
360
 
                    delta_pos += 1
361
 
                    if c & 0x80: # Copy
362
 
                        (offset, length,
363
 
                         delta_pos) = decode_copy_instruction(delta_content, c,
364
 
                                                              delta_pos)
365
 
                        if include_text:
366
 
                            text = self._content[offset:offset+length]
367
 
                            delta_info.append(('c', offset, length, text))
368
 
                        else:
369
 
                            delta_info.append(('c', offset, length))
370
 
                        measured_len += length
371
 
                    else: # Insert
372
 
                        if include_text:
373
 
                            txt = delta_content[delta_pos:delta_pos+c]
374
 
                        else:
375
 
                            txt = ''
376
 
                        delta_info.append(('i', c, txt))
377
 
                        measured_len += c
378
 
                        delta_pos += c
379
 
                if delta_pos != content_len:
380
 
                    raise ValueError('Delta consumed a bad number of bytes:'
381
 
                                     ' %d != %d' % (delta_pos, content_len))
382
 
                if measured_len != decomp_len:
383
 
                    raise ValueError('Delta claimed fulltext was %d bytes, but'
384
 
                                     ' extraction resulted in %d bytes'
385
 
                                     % (decomp_len, measured_len))
386
 
            pos += content_len
387
 
        return result
388
 
 
389
282
 
390
283
class _LazyGroupCompressFactory(object):
391
284
    """Yield content from a GroupCompressBlock on demand."""
438
331
                self._manager._prepare_for_extract()
439
332
                block = self._manager._block
440
333
                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()
 
334
                # XXX: It seems the smart fetch extracts inventories and chk
 
335
                #      pages as fulltexts to find the next chk pages, but then
 
336
                #      passes them down to be inserted as a
 
337
                #      groupcompress-block, so this is not safe to do. Perhaps
 
338
                #      we could just change the storage kind to "fulltext" at
 
339
                #      that point?
 
340
                # self._manager = None
444
341
            if storage_kind == 'fulltext':
445
342
                return self._bytes
446
343
            else:
452
349
class _LazyGroupContentManager(object):
453
350
    """This manages a group of _LazyGroupCompressFactory objects."""
454
351
 
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
462
 
 
463
352
    def __init__(self, block):
464
353
        self._block = block
465
354
        # We need to preserve the ordering
487
376
            yield factory
488
377
            # Break the ref-cycle
489
378
            factory._bytes = None
490
 
            factory._manager = None
 
379
            # XXX: this is not safe, the smart fetch code requests the content
 
380
            #      as both a 'fulltext', and then later on as a
 
381
            #      groupcompress-block. The iter_interesting_nodes code also is
 
382
            #      still buffering multiple records and returning them later.
 
383
            #      So that code would need to be updated to either re-fetch the
 
384
            #      original object, or buffer it somehow.
 
385
            # factory._manager = None
491
386
        # TODO: Consider setting self._factories = None after the above loop,
492
387
        #       as it will break the reference cycle
493
388
 
511
406
        end_point = 0
512
407
        for factory in self._factories:
513
408
            bytes = factory.get_bytes_as('fulltext')
514
 
            (found_sha1, start_point, end_point,
515
 
             type) = compressor.compress(factory.key, bytes, factory.sha1)
 
409
            (found_sha1, start_point, end_point, type,
 
410
             length) = compressor.compress(factory.key, bytes, factory.sha1)
516
411
            # Now update this factory with the new offsets, etc
517
412
            factory.sha1 = found_sha1
518
413
            factory._start = start_point
537
432
        # time (self._block._content) is a little expensive.
538
433
        self._block._ensure_content(self._last_byte)
539
434
 
540
 
    def _check_rebuild_action(self):
 
435
    def _check_rebuild_block(self):
541
436
        """Check to see if our block should be repacked."""
542
437
        total_bytes_used = 0
543
438
        last_byte_used = 0
544
439
        for factory in self._factories:
545
440
            total_bytes_used += factory._end - factory._start
546
 
            if last_byte_used < factory._end:
547
 
                last_byte_used = factory._end
548
 
        # If we are using more than half of the bytes from the block, we have
549
 
        # nothing else to check
 
441
            last_byte_used = max(last_byte_used, factory._end)
 
442
        # If we are using most of the bytes from the block, we have nothing
 
443
        # else to check (currently more that 1/2)
550
444
        if total_bytes_used * 2 >= self._block._content_length:
551
 
            return None, last_byte_used, total_bytes_used
552
 
        # We are using less than 50% of the content. Is the content we are
553
 
        # using at the beginning of the block? If so, we can just trim the
554
 
        # tail, rather than rebuilding from scratch.
 
445
            return
 
446
        # Can we just strip off the trailing bytes? If we are going to be
 
447
        # transmitting more than 50% of the front of the content, go ahead
555
448
        if total_bytes_used * 2 > last_byte_used:
556
 
            return 'trim', last_byte_used, total_bytes_used
 
449
            self._trim_block(last_byte_used)
 
450
            return
557
451
 
558
452
        # We are using a small amount of the data, and it isn't just packed
559
453
        # nicely at the front, so rebuild the content.
566
460
        #       expanding many deltas into fulltexts, as well.
567
461
        #       If we build a cheap enough 'strip', then we could try a strip,
568
462
        #       if that expands the content, we then rebuild.
569
 
        return 'rebuild', last_byte_used, total_bytes_used
570
 
 
571
 
    def check_is_well_utilized(self):
572
 
        """Is the current block considered 'well utilized'?
573
 
 
574
 
        This heuristic asks if the current block considers itself to be a fully
575
 
        developed group, rather than just a loose collection of data.
576
 
        """
577
 
        if len(self._factories) == 1:
578
 
            # A block of length 1 could be improved by combining with other
579
 
            # groups - don't look deeper. Even larger than max size groups
580
 
            # could compress well with adjacent versions of the same thing.
581
 
            return False
582
 
        action, last_byte_used, total_bytes_used = self._check_rebuild_action()
583
 
        block_size = self._block._content_length
584
 
        if total_bytes_used < block_size * self._max_cut_fraction:
585
 
            # This block wants to trim itself small enough that we want to
586
 
            # consider it under-utilized.
587
 
            return False
588
 
        # TODO: This code is meant to be the twin of _insert_record_stream's
589
 
        #       'start_new_block' logic. It would probably be better to factor
590
 
        #       out that logic into a shared location, so that it stays
591
 
        #       together better
592
 
        # We currently assume a block is properly utilized whenever it is >75%
593
 
        # of the size of a 'full' block. In normal operation, a block is
594
 
        # considered full when it hits 4MB of same-file content. So any block
595
 
        # >3MB is 'full enough'.
596
 
        # The only time this isn't true is when a given block has large-object
597
 
        # content. (a single file >4MB, etc.)
598
 
        # Under these circumstances, we allow a block to grow to
599
 
        # 2 x largest_content.  Which means that if a given block had a large
600
 
        # object, it may actually be under-utilized. However, given that this
601
 
        # is 'pack-on-the-fly' it is probably reasonable to not repack large
602
 
        # content blobs on-the-fly. Note that because we return False for all
603
 
        # 1-item blobs, we will repack them; we may wish to reevaluate our
604
 
        # treatment of large object blobs in the future.
605
 
        if block_size >= self._full_enough_block_size:
606
 
            return True
607
 
        # If a block is <3MB, it still may be considered 'full' if it contains
608
 
        # mixed content. The current rule is 2MB of mixed content is considered
609
 
        # full. So check to see if this block contains mixed content, and
610
 
        # set the threshold appropriately.
611
 
        common_prefix = None
612
 
        for factory in self._factories:
613
 
            prefix = factory.key[:-1]
614
 
            if common_prefix is None:
615
 
                common_prefix = prefix
616
 
            elif prefix != common_prefix:
617
 
                # Mixed content, check the size appropriately
618
 
                if block_size >= self._full_enough_mixed_block_size:
619
 
                    return True
620
 
                break
621
 
        # The content failed both the mixed check and the single-content check
622
 
        # so obviously it is not fully utilized
623
 
        # TODO: there is one other constraint that isn't being checked
624
 
        #       namely, that the entries in the block are in the appropriate
625
 
        #       order. For example, you could insert the entries in exactly
626
 
        #       reverse groupcompress order, and we would think that is ok.
627
 
        #       (all the right objects are in one group, and it is fully
628
 
        #       utilized, etc.) For now, we assume that case is rare,
629
 
        #       especially since we should always fetch in 'groupcompress'
630
 
        #       order.
631
 
        return False
632
 
 
633
 
    def _check_rebuild_block(self):
634
 
        action, last_byte_used, total_bytes_used = self._check_rebuild_action()
635
 
        if action is None:
636
 
            return
637
 
        if action == 'trim':
638
 
            self._trim_block(last_byte_used)
639
 
        elif action == 'rebuild':
640
 
            self._rebuild_block()
641
 
        else:
642
 
            raise ValueError('unknown rebuild action: %r' % (action,))
 
463
        self._rebuild_block()
643
464
 
644
465
    def _wire_bytes(self):
645
466
        """Return a byte stream suitable for transmitting over the wire."""
671
492
            record_header = '%s\n%s\n%d\n%d\n' % (
672
493
                key_bytes, parent_bytes, factory._start, factory._end)
673
494
            header_lines.append(record_header)
674
 
            # TODO: Can we break the refcycle at this point and set
675
 
            #       factory._manager = None?
676
495
        header_bytes = ''.join(header_lines)
677
496
        del header_lines
678
497
        header_bytes_len = len(header_bytes)
774
593
        :param soft: Do a 'soft' compression. This means that we require larger
775
594
            ranges to match to be considered for a copy command.
776
595
 
777
 
        :return: The sha1 of lines, the start and end offsets in the delta, and
778
 
            the type ('fulltext' or 'delta').
 
596
        :return: The sha1 of lines, the start and end offsets in the delta, the
 
597
            type ('fulltext' or 'delta') and the number of bytes accumulated in
 
598
            the group output so far.
779
599
 
780
600
        :seealso VersionedFiles.add_lines:
781
601
        """
782
602
        if not bytes: # empty, like a dir entry, etc
783
603
            if nostore_sha == _null_sha1:
784
604
                raise errors.ExistingContent()
785
 
            return _null_sha1, 0, 0, 'fulltext'
 
605
            return _null_sha1, 0, 0, 'fulltext', 0
786
606
        # we assume someone knew what they were doing when they passed it in
787
607
        if expected_sha is not None:
788
608
            sha1 = expected_sha
794
614
        if key[-1] is None:
795
615
            key = key[:-1] + ('sha1:' + sha1,)
796
616
 
797
 
        start, end, type = self._compress(key, bytes, len(bytes) / 2, soft)
798
 
        return sha1, start, end, type
 
617
        return self._compress(key, bytes, sha1, len(bytes) / 2, soft)
799
618
 
800
 
    def _compress(self, key, bytes, max_delta_size, soft=False):
 
619
    def _compress(self, key, bytes, sha1, max_delta_size, soft=False):
801
620
        """Compress lines with label key.
802
621
 
803
622
        :param key: A key tuple. It is stored in the output for identification
805
624
 
806
625
        :param bytes: The bytes to be compressed
807
626
 
 
627
        :param sha1: The sha1 for 'bytes'.
 
628
 
808
629
        :param max_delta_size: The size above which we issue a fulltext instead
809
630
            of a delta.
810
631
 
811
632
        :param soft: Do a 'soft' compression. This means that we require larger
812
633
            ranges to match to be considered for a copy command.
813
634
 
814
 
        :return: The sha1 of lines, the start and end offsets in the delta, and
815
 
            the type ('fulltext' or 'delta').
 
635
        :return: The sha1 of lines, the start and end offsets in the delta, the
 
636
            type ('fulltext' or 'delta') and the number of bytes accumulated in
 
637
            the group output so far.
816
638
        """
817
639
        raise NotImplementedError(self._compress)
818
640
 
854
676
 
855
677
        After calling this, the compressor should no longer be used
856
678
        """
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
 
        self._block.set_chunked_content(self.chunks, self.endpoint)
 
679
        content = ''.join(self.chunks)
866
680
        self.chunks = None
867
681
        self._delta_index = None
 
682
        self._block.set_content(content)
868
683
        return self._block
869
684
 
870
685
    def pop_last(self):
888
703
    def __init__(self):
889
704
        """Create a GroupCompressor.
890
705
 
891
 
        Used only if the pyrex version is not available.
 
706
        :param delta: If False, do not compress records.
892
707
        """
893
708
        super(PythonGroupCompressor, self).__init__()
894
709
        self._delta_index = LinesDeltaIndex([])
895
710
        # The actual content is managed by LinesDeltaIndex
896
711
        self.chunks = self._delta_index.lines
897
712
 
898
 
    def _compress(self, key, bytes, max_delta_size, soft=False):
 
713
    def _compress(self, key, bytes, sha1, max_delta_size, soft=False):
899
714
        """see _CommonGroupCompressor._compress"""
900
 
        input_len = len(bytes)
 
715
        bytes_length = len(bytes)
901
716
        new_lines = osutils.split_lines(bytes)
902
 
        out_lines, index_lines = self._delta_index.make_delta(
903
 
            new_lines, bytes_length=input_len, soft=soft)
 
717
        out_lines, index_lines = self._delta_index.make_delta(new_lines,
 
718
            bytes_length=bytes_length, soft=soft)
904
719
        delta_length = sum(map(len, out_lines))
905
720
        if delta_length > max_delta_size:
906
721
            # The delta is longer than the fulltext, insert a fulltext
907
722
            type = 'fulltext'
908
 
            out_lines = ['f', encode_base128_int(input_len)]
 
723
            out_lines = ['f', encode_base128_int(bytes_length)]
909
724
            out_lines.extend(new_lines)
910
725
            index_lines = [False, False]
911
726
            index_lines.extend([True] * len(new_lines))
 
727
            out_length = len(out_lines[1]) + bytes_length + 1
912
728
        else:
913
729
            # this is a worthy delta, output it
914
730
            type = 'delta'
915
731
            out_lines[0] = 'd'
916
732
            # Update the delta_length to include those two encoded integers
917
733
            out_lines[1] = encode_base128_int(delta_length)
918
 
        # Before insertion
919
 
        start = self.endpoint
920
 
        chunk_start = len(self.chunks)
921
 
        self._last = (chunk_start, self.endpoint)
 
734
            out_length = len(out_lines[3]) + 1 + delta_length
 
735
        start = self.endpoint # Before insertion
 
736
        chunk_start = len(self._delta_index.lines)
922
737
        self._delta_index.extend_lines(out_lines, index_lines)
923
738
        self.endpoint = self._delta_index.endpoint
924
 
        self.input_bytes += input_len
925
 
        chunk_end = len(self.chunks)
 
739
        self.input_bytes += bytes_length
 
740
        chunk_end = len(self._delta_index.lines)
926
741
        self.labels_deltas[key] = (start, chunk_start,
927
742
                                   self.endpoint, chunk_end)
928
 
        return start, self.endpoint, type
 
743
        return sha1, start, self.endpoint, type, out_length
929
744
 
930
745
 
931
746
class PyrexGroupCompressor(_CommonGroupCompressor):
948
763
        super(PyrexGroupCompressor, self).__init__()
949
764
        self._delta_index = DeltaIndex()
950
765
 
951
 
    def _compress(self, key, bytes, max_delta_size, soft=False):
 
766
    def _compress(self, key, bytes, sha1, max_delta_size, soft=False):
952
767
        """see _CommonGroupCompressor._compress"""
953
768
        input_len = len(bytes)
954
769
        # By having action/label/sha1/len, we can parse the group if the index
969
784
            type = 'fulltext'
970
785
            enc_length = encode_base128_int(len(bytes))
971
786
            len_mini_header = 1 + len(enc_length)
 
787
            length = len(bytes) + len_mini_header
972
788
            self._delta_index.add_source(bytes, len_mini_header)
973
789
            new_chunks = ['f', enc_length, bytes]
974
790
        else:
975
791
            type = 'delta'
976
792
            enc_length = encode_base128_int(len(delta))
977
793
            len_mini_header = 1 + len(enc_length)
 
794
            length = len(delta) + len_mini_header
978
795
            new_chunks = ['d', enc_length, delta]
979
796
            self._delta_index.add_delta_source(delta, len_mini_header)
980
797
        # Before insertion
990
807
            raise AssertionError('the delta index is out of sync'
991
808
                'with the output lines %s != %s'
992
809
                % (self._delta_index._source_offset, self.endpoint))
993
 
        return start, self.endpoint, type
 
810
        return sha1, start, self.endpoint, type, length
994
811
 
995
812
    def _output_chunks(self, new_chunks):
996
813
        """Output some chunks.
1004
821
        self.endpoint = endpoint
1005
822
 
1006
823
 
1007
 
def make_pack_factory(graph, delta, keylength, inconsistency_fatal=True):
 
824
def make_pack_factory(graph, delta, keylength):
1008
825
    """Create a factory for creating a pack based groupcompress.
1009
826
 
1010
827
    This is only functional enough to run interface tests, it doesn't try to
1025
842
        writer = pack.ContainerWriter(stream.write)
1026
843
        writer.begin()
1027
844
        index = _GCGraphIndex(graph_index, lambda:True, parents=parents,
1028
 
            add_callback=graph_index.add_nodes,
1029
 
            inconsistency_fatal=inconsistency_fatal)
1030
 
        access = knit._DirectPackAccess({})
 
845
            add_callback=graph_index.add_nodes)
 
846
        access = _DirectPackAccess({})
1031
847
        access.set_writer(writer, graph_index, (transport, 'newpack'))
1032
848
        result = GroupCompressVersionedFiles(index, access, delta)
1033
849
        result.stream = stream
1041
857
    versioned_files.stream.close()
1042
858
 
1043
859
 
1044
 
class _BatchingBlockFetcher(object):
1045
 
    """Fetch group compress blocks in batches.
1046
 
    
1047
 
    :ivar total_bytes: int of expected number of bytes needed to fetch the
1048
 
        currently pending batch.
1049
 
    """
1050
 
 
1051
 
    def __init__(self, gcvf, locations):
1052
 
        self.gcvf = gcvf
1053
 
        self.locations = locations
1054
 
        self.keys = []
1055
 
        self.batch_memos = {}
1056
 
        self.memos_to_get = []
1057
 
        self.total_bytes = 0
1058
 
        self.last_read_memo = None
1059
 
        self.manager = None
1060
 
 
1061
 
    def add_key(self, key):
1062
 
        """Add another to key to fetch.
1063
 
        
1064
 
        :return: The estimated number of bytes needed to fetch the batch so
1065
 
            far.
1066
 
        """
1067
 
        self.keys.append(key)
1068
 
        index_memo, _, _, _ = self.locations[key]
1069
 
        read_memo = index_memo[0:3]
1070
 
        # Three possibilities for this read_memo:
1071
 
        #  - it's already part of this batch; or
1072
 
        #  - it's not yet part of this batch, but is already cached; or
1073
 
        #  - it's not yet part of this batch and will need to be fetched.
1074
 
        if read_memo in self.batch_memos:
1075
 
            # This read memo is already in this batch.
1076
 
            return self.total_bytes
1077
 
        try:
1078
 
            cached_block = self.gcvf._group_cache[read_memo]
1079
 
        except KeyError:
1080
 
            # This read memo is new to this batch, and the data isn't cached
1081
 
            # either.
1082
 
            self.batch_memos[read_memo] = None
1083
 
            self.memos_to_get.append(read_memo)
1084
 
            byte_length = read_memo[2]
1085
 
            self.total_bytes += byte_length
1086
 
        else:
1087
 
            # This read memo is new to this batch, but cached.
1088
 
            # Keep a reference to the cached block in batch_memos because it's
1089
 
            # certain that we'll use it when this batch is processed, but
1090
 
            # there's a risk that it would fall out of _group_cache between now
1091
 
            # and then.
1092
 
            self.batch_memos[read_memo] = cached_block
1093
 
        return self.total_bytes
1094
 
        
1095
 
    def _flush_manager(self):
1096
 
        if self.manager is not None:
1097
 
            for factory in self.manager.get_record_stream():
1098
 
                yield factory
1099
 
            self.manager = None
1100
 
            self.last_read_memo = None
1101
 
 
1102
 
    def yield_factories(self, full_flush=False):
1103
 
        """Yield factories for keys added since the last yield.  They will be
1104
 
        returned in the order they were added via add_key.
1105
 
        
1106
 
        :param full_flush: by default, some results may not be returned in case
1107
 
            they can be part of the next batch.  If full_flush is True, then
1108
 
            all results are returned.
1109
 
        """
1110
 
        if self.manager is None and not self.keys:
1111
 
            return
1112
 
        # Fetch all memos in this batch.
1113
 
        blocks = self.gcvf._get_blocks(self.memos_to_get)
1114
 
        # Turn blocks into factories and yield them.
1115
 
        memos_to_get_stack = list(self.memos_to_get)
1116
 
        memos_to_get_stack.reverse()
1117
 
        for key in self.keys:
1118
 
            index_memo, _, parents, _ = self.locations[key]
1119
 
            read_memo = index_memo[:3]
1120
 
            if self.last_read_memo != read_memo:
1121
 
                # We are starting a new block. If we have a
1122
 
                # manager, we have found everything that fits for
1123
 
                # now, so yield records
1124
 
                for factory in self._flush_manager():
1125
 
                    yield factory
1126
 
                # Now start a new manager.
1127
 
                if memos_to_get_stack and memos_to_get_stack[-1] == read_memo:
1128
 
                    # The next block from _get_blocks will be the block we
1129
 
                    # need.
1130
 
                    block_read_memo, block = blocks.next()
1131
 
                    if block_read_memo != read_memo:
1132
 
                        raise AssertionError(
1133
 
                            "block_read_memo out of sync with read_memo"
1134
 
                            "(%r != %r)" % (block_read_memo, read_memo))
1135
 
                    self.batch_memos[read_memo] = block
1136
 
                    memos_to_get_stack.pop()
1137
 
                else:
1138
 
                    block = self.batch_memos[read_memo]
1139
 
                self.manager = _LazyGroupContentManager(block)
1140
 
                self.last_read_memo = read_memo
1141
 
            start, end = index_memo[3:5]
1142
 
            self.manager.add_factory(key, parents, start, end)
1143
 
        if full_flush:
1144
 
            for factory in self._flush_manager():
1145
 
                yield factory
1146
 
        del self.keys[:]
1147
 
        self.batch_memos.clear()
1148
 
        del self.memos_to_get[:]
1149
 
        self.total_bytes = 0
1150
 
 
1151
 
 
1152
860
class GroupCompressVersionedFiles(VersionedFiles):
1153
861
    """A group-compress based VersionedFiles implementation."""
1154
862
 
1155
 
    def __init__(self, index, access, delta=True, _unadded_refs=None):
 
863
    def __init__(self, index, access, delta=True):
1156
864
        """Create a GroupCompressVersionedFiles object.
1157
865
 
1158
866
        :param index: The index object storing access and graph data.
1159
867
        :param access: The access object storing raw data.
1160
868
        :param delta: Whether to delta compress or just entropy compress.
1161
 
        :param _unadded_refs: private parameter, don't use.
1162
869
        """
1163
870
        self._index = index
1164
871
        self._access = access
1165
872
        self._delta = delta
1166
 
        if _unadded_refs is None:
1167
 
            _unadded_refs = {}
1168
 
        self._unadded_refs = _unadded_refs
 
873
        self._unadded_refs = {}
1169
874
        self._group_cache = LRUSizeCache(max_size=50*1024*1024)
1170
875
        self._fallback_vfs = []
1171
876
 
1172
 
    def without_fallbacks(self):
1173
 
        """Return a clone of this object without any fallbacks configured."""
1174
 
        return GroupCompressVersionedFiles(self._index, self._access,
1175
 
            self._delta, _unadded_refs=dict(self._unadded_refs))
1176
 
 
1177
877
    def add_lines(self, key, parents, lines, parent_texts=None,
1178
878
        left_matching_blocks=None, nostore_sha=None, random_id=False,
1179
879
        check_content=True):
1224
924
                                               nostore_sha=nostore_sha))[0]
1225
925
        return sha1, length, None
1226
926
 
1227
 
    def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
1228
 
        """See VersionedFiles._add_text()."""
1229
 
        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")
1233
 
        if parents is None:
1234
 
            # The caller might pass None if there is no graph data, but kndx
1235
 
            # indexes can't directly store that, so we give them
1236
 
            # an empty tuple instead.
1237
 
            parents = ()
1238
 
        # 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]
1243
 
        return sha1, length, None
1244
 
 
1245
927
    def add_fallback_versioned_files(self, a_versioned_files):
1246
928
        """Add a source of texts for texts not present in this knit.
1247
929
 
1251
933
 
1252
934
    def annotate(self, key):
1253
935
        """See VersionedFiles.annotate."""
1254
 
        ann = annotate.Annotator(self)
1255
 
        return ann.annotate_flat(key)
1256
 
 
1257
 
    def get_annotator(self):
1258
 
        return annotate.Annotator(self)
1259
 
 
1260
 
    def check(self, progress_bar=None, keys=None):
 
936
        graph = Graph(self)
 
937
        parent_map = self.get_parent_map([key])
 
938
        if not parent_map:
 
939
            raise errors.RevisionNotPresent(key, self)
 
940
        if parent_map[key] is not None:
 
941
            search = graph._make_breadth_first_searcher([key])
 
942
            keys = set()
 
943
            while True:
 
944
                try:
 
945
                    present, ghosts = search.next_with_ghosts()
 
946
                except StopIteration:
 
947
                    break
 
948
                keys.update(present)
 
949
            parent_map = self.get_parent_map(keys)
 
950
        else:
 
951
            keys = [key]
 
952
            parent_map = {key:()}
 
953
        head_cache = _mod_graph.FrozenHeadsCache(graph)
 
954
        parent_cache = {}
 
955
        reannotate = annotate.reannotate
 
956
        for record in self.get_record_stream(keys, 'topological', True):
 
957
            key = record.key
 
958
            chunks = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
 
959
            parent_lines = [parent_cache[parent] for parent in parent_map[key]]
 
960
            parent_cache[key] = list(
 
961
                reannotate(parent_lines, chunks, key, None, head_cache))
 
962
        return parent_cache[key]
 
963
 
 
964
    def check(self, progress_bar=None):
1261
965
        """See VersionedFiles.check()."""
1262
 
        if keys is None:
1263
 
            keys = self.keys()
1264
 
            for record in self.get_record_stream(keys, 'unordered', True):
1265
 
                record.get_bytes_as('fulltext')
1266
 
        else:
1267
 
            return self.get_record_stream(keys, 'unordered', True)
1268
 
 
1269
 
    def clear_cache(self):
1270
 
        """See VersionedFiles.clear_cache()"""
1271
 
        self._group_cache.clear()
1272
 
        self._index._graph_index.clear_cache()
1273
 
        self._index._int_cache.clear()
 
966
        keys = self.keys()
 
967
        for record in self.get_record_stream(keys, 'unordered', True):
 
968
            record.get_bytes_as('fulltext')
1274
969
 
1275
970
    def _check_add(self, key, lines, random_id, check_content):
1276
971
        """check that version_id and lines are safe to add."""
1287
982
            self._check_lines_not_unicode(lines)
1288
983
            self._check_lines_are_lines(lines)
1289
984
 
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
 
 
1306
985
    def get_parent_map(self, keys):
1307
986
        """Get a map of the graph parents of keys.
1308
987
 
1335
1014
            missing.difference_update(set(new_result))
1336
1015
        return result, source_results
1337
1016
 
1338
 
    def _get_blocks(self, read_memos):
1339
 
        """Get GroupCompressBlocks for the given read_memos.
1340
 
 
1341
 
        :returns: a series of (read_memo, block) pairs, in the order they were
1342
 
            originally passed.
1343
 
        """
1344
 
        cached = {}
1345
 
        for read_memo in read_memos:
1346
 
            try:
1347
 
                block = self._group_cache[read_memo]
1348
 
            except KeyError:
1349
 
                pass
1350
 
            else:
1351
 
                cached[read_memo] = block
1352
 
        not_cached = []
1353
 
        not_cached_seen = set()
1354
 
        for read_memo in read_memos:
1355
 
            if read_memo in cached:
1356
 
                # Don't fetch what we already have
1357
 
                continue
1358
 
            if read_memo in not_cached_seen:
1359
 
                # Don't try to fetch the same data twice
1360
 
                continue
1361
 
            not_cached.append(read_memo)
1362
 
            not_cached_seen.add(read_memo)
1363
 
        raw_records = self._access.get_raw_records(not_cached)
1364
 
        for read_memo in read_memos:
1365
 
            try:
1366
 
                yield read_memo, cached[read_memo]
1367
 
            except KeyError:
1368
 
                # Read the block, and cache it.
1369
 
                zdata = raw_records.next()
1370
 
                block = GroupCompressBlock.from_bytes(zdata)
1371
 
                self._group_cache[read_memo] = block
1372
 
                cached[read_memo] = block
1373
 
                yield read_memo, block
 
1017
    def _get_block(self, index_memo):
 
1018
        read_memo = index_memo[0:3]
 
1019
        # get the group:
 
1020
        try:
 
1021
            block = self._group_cache[read_memo]
 
1022
        except KeyError:
 
1023
            # read the group
 
1024
            zdata = self._access.get_raw_records([read_memo]).next()
 
1025
            # decompress - whole thing - this is not a bug, as it
 
1026
            # permits caching. We might want to store the partially
 
1027
            # decompresed group and decompress object, so that recent
 
1028
            # texts are not penalised by big groups.
 
1029
            block = GroupCompressBlock.from_bytes(zdata)
 
1030
            self._group_cache[read_memo] = block
 
1031
        # cheapo debugging:
 
1032
        # print len(zdata), len(plain)
 
1033
        # parse - requires split_lines, better to have byte offsets
 
1034
        # here (but not by much - we only split the region for the
 
1035
        # recipe, and we often want to end up with lines anyway.
 
1036
        return block
1374
1037
 
1375
1038
    def get_missing_compression_parent_keys(self):
1376
1039
        """Return the keys of missing compression parents.
1542
1205
                unadded_keys, source_result)
1543
1206
        for key in missing:
1544
1207
            yield AbsentContentFactory(key)
1545
 
        # Batch up as many keys as we can until either:
1546
 
        #  - we encounter an unadded ref, or
1547
 
        #  - we run out of keys, or
1548
 
        #  - the total bytes to retrieve for this batch > BATCH_SIZE
1549
 
        batcher = _BatchingBlockFetcher(self, locations)
 
1208
        manager = None
 
1209
        last_read_memo = None
 
1210
        # TODO: This works fairly well at batching up existing groups into a
 
1211
        #       streamable format, and possibly allowing for taking one big
 
1212
        #       group and splitting it when it isn't fully utilized.
 
1213
        #       However, it doesn't allow us to find under-utilized groups and
 
1214
        #       combine them into a bigger group on the fly.
 
1215
        #       (Consider the issue with how chk_map inserts texts
 
1216
        #       one-at-a-time.) This could be done at insert_record_stream()
 
1217
        #       time, but it probably would decrease the number of
 
1218
        #       bytes-on-the-wire for fetch.
1550
1219
        for source, keys in source_keys:
1551
1220
            if source is self:
1552
1221
                for key in keys:
1553
1222
                    if key in self._unadded_refs:
1554
 
                        # Flush batch, then yield unadded ref from
1555
 
                        # self._compressor.
1556
 
                        for factory in batcher.yield_factories(full_flush=True):
1557
 
                            yield factory
 
1223
                        if manager is not None:
 
1224
                            for factory in manager.get_record_stream():
 
1225
                                yield factory
 
1226
                            last_read_memo = manager = None
1558
1227
                        bytes, sha1 = self._compressor.extract(key)
1559
1228
                        parents = self._unadded_refs[key]
1560
1229
                        yield FulltextContentFactory(key, parents, sha1, bytes)
1561
 
                        continue
1562
 
                    if batcher.add_key(key) > BATCH_SIZE:
1563
 
                        # Ok, this batch is big enough.  Yield some results.
1564
 
                        for factory in batcher.yield_factories():
1565
 
                            yield factory
 
1230
                    else:
 
1231
                        index_memo, _, parents, (method, _) = locations[key]
 
1232
                        read_memo = index_memo[0:3]
 
1233
                        if last_read_memo != read_memo:
 
1234
                            # We are starting a new block. If we have a
 
1235
                            # manager, we have found everything that fits for
 
1236
                            # now, so yield records
 
1237
                            if manager is not None:
 
1238
                                for factory in manager.get_record_stream():
 
1239
                                    yield factory
 
1240
                            # Now start a new manager
 
1241
                            block = self._get_block(index_memo)
 
1242
                            manager = _LazyGroupContentManager(block)
 
1243
                            last_read_memo = read_memo
 
1244
                        start, end = index_memo[3:5]
 
1245
                        manager.add_factory(key, parents, start, end)
1566
1246
            else:
1567
 
                for factory in batcher.yield_factories(full_flush=True):
1568
 
                    yield factory
 
1247
                if manager is not None:
 
1248
                    for factory in manager.get_record_stream():
 
1249
                        yield factory
 
1250
                    last_read_memo = manager = None
1569
1251
                for record in source.get_record_stream(keys, ordering,
1570
1252
                                                       include_delta_closure):
1571
1253
                    yield record
1572
 
        for factory in batcher.yield_factories(full_flush=True):
1573
 
            yield factory
 
1254
        if manager is not None:
 
1255
            for factory in manager.get_record_stream():
 
1256
                yield factory
1574
1257
 
1575
1258
    def get_sha1s(self, keys):
1576
1259
        """See VersionedFiles.get_sha1s()."""
1591
1274
        :return: None
1592
1275
        :seealso VersionedFiles.get_record_stream:
1593
1276
        """
1594
 
        # XXX: Setting random_id=True makes
1595
 
        # test_insert_record_stream_existing_keys fail for groupcompress and
1596
 
        # groupcompress-nograph, this needs to be revisited while addressing
1597
 
        # 'bzr branch' performance issues.
1598
 
        for _ in self._insert_record_stream(stream, random_id=False):
 
1277
        for _ in self._insert_record_stream(stream):
1599
1278
            pass
1600
1279
 
1601
1280
    def _insert_record_stream(self, stream, random_id=False, nostore_sha=None,
1631
1310
        keys_to_add = []
1632
1311
        def flush():
1633
1312
            bytes = self._compressor.flush().to_bytes()
1634
 
            self._compressor = GroupCompressor()
1635
1313
            index, start, length = self._access.add_raw_records(
1636
1314
                [(None, len(bytes))], bytes)[0]
1637
1315
            nodes = []
1640
1318
            self._index.add_records(nodes, random_id=random_id)
1641
1319
            self._unadded_refs = {}
1642
1320
            del keys_to_add[:]
 
1321
            self._compressor = GroupCompressor()
1643
1322
 
1644
1323
        last_prefix = None
 
1324
        last_fulltext_len = None
1645
1325
        max_fulltext_len = 0
1646
1326
        max_fulltext_prefix = None
1647
1327
        insert_manager = None
1648
1328
        block_start = None
1649
1329
        block_length = None
1650
 
        # XXX: TODO: remove this, it is just for safety checking for now
1651
 
        inserted_keys = set()
1652
 
        reuse_this_block = reuse_blocks
1653
1330
        for record in stream:
1654
1331
            # Raise an error when a record is missing.
1655
1332
            if record.storage_kind == 'absent':
1656
1333
                raise errors.RevisionNotPresent(record.key, self)
1657
 
            if random_id:
1658
 
                if record.key in inserted_keys:
1659
 
                    trace.note('Insert claimed random_id=True,'
1660
 
                               ' but then inserted %r two times', record.key)
1661
 
                    continue
1662
 
                inserted_keys.add(record.key)
1663
1334
            if reuse_blocks:
1664
1335
                # If the reuse_blocks flag is set, check to see if we can just
1665
1336
                # copy a groupcompress block as-is.
1666
 
                # We only check on the first record (groupcompress-block) not
1667
 
                # on all of the (groupcompress-block-ref) entries.
1668
 
                # The reuse_this_block flag is then kept for as long as
1669
 
                if record.storage_kind == 'groupcompress-block':
1670
 
                    # Check to see if we really want to re-use this block
1671
 
                    insert_manager = record._manager
1672
 
                    reuse_this_block = insert_manager.check_is_well_utilized()
1673
 
            else:
1674
 
                reuse_this_block = False
1675
 
            if reuse_this_block:
1676
 
                # We still want to reuse this block
1677
1337
                if record.storage_kind == 'groupcompress-block':
1678
1338
                    # Insert the raw block into the target repo
1679
1339
                    insert_manager = record._manager
 
1340
                    insert_manager._check_rebuild_block()
1680
1341
                    bytes = record._manager._block.to_bytes()
1681
1342
                    _, start, length = self._access.add_raw_records(
1682
1343
                        [(None, len(bytes))], bytes)[0]
1685
1346
                    block_length = length
1686
1347
                if record.storage_kind in ('groupcompress-block',
1687
1348
                                           'groupcompress-block-ref'):
1688
 
                    if insert_manager is None:
1689
 
                        raise AssertionError('No insert_manager set')
1690
 
                    if insert_manager is not record._manager:
1691
 
                        raise AssertionError('insert_manager does not match'
1692
 
                            ' the current record, we cannot be positive'
1693
 
                            ' that the appropriate content was inserted.'
1694
 
                            )
 
1349
                    assert insert_manager is not None
 
1350
                    assert record._manager is insert_manager
1695
1351
                    value = "%d %d %d %d" % (block_start, block_length,
1696
1352
                                             record._start, record._end)
1697
1353
                    nodes = [(record.key, value, (record.parents,))]
1715
1371
            if max_fulltext_len < len(bytes):
1716
1372
                max_fulltext_len = len(bytes)
1717
1373
                max_fulltext_prefix = prefix
1718
 
            (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)
 
1374
            (found_sha1, start_point, end_point, type,
 
1375
             length) = self._compressor.compress(record.key,
 
1376
                bytes, record.sha1, soft=soft,
 
1377
                nostore_sha=nostore_sha)
 
1378
            # delta_ratio = float(len(bytes)) / length
1723
1379
            # Check if we want to continue to include that text
1724
1380
            if (prefix == max_fulltext_prefix
1725
1381
                and end_point < 2 * max_fulltext_len):
1738
1394
                self._compressor.pop_last()
1739
1395
                flush()
1740
1396
                max_fulltext_len = len(bytes)
1741
 
                (found_sha1, start_point, end_point,
1742
 
                 type) = self._compressor.compress(record.key, bytes,
1743
 
                                                   record.sha1)
 
1397
                (found_sha1, start_point, end_point, type,
 
1398
                 length) = self._compressor.compress(record.key,
 
1399
                    bytes, record.sha1)
 
1400
                last_fulltext_len = length
1744
1401
            if record.key[-1] is None:
1745
1402
                key = record.key[:-1] + ('sha1:' + found_sha1,)
1746
1403
            else:
1747
1404
                key = record.key
1748
1405
            self._unadded_refs[key] = record.parents
1749
1406
            yield found_sha1
1750
 
            as_st = static_tuple.StaticTuple.from_sequence
1751
 
            if record.parents is not None:
1752
 
                parents = as_st([as_st(p) for p in record.parents])
1753
 
            else:
1754
 
                parents = None
1755
 
            refs = static_tuple.StaticTuple(parents)
1756
 
            keys_to_add.append((key, '%d %d' % (start_point, end_point), refs))
 
1407
            keys_to_add.append((key, '%d %d' % (start_point, end_point),
 
1408
                (record.parents,)))
1757
1409
        if len(keys_to_add):
1758
1410
            flush()
1759
1411
        self._compressor = None
1779
1431
 
1780
1432
        :return: An iterator over (line, key).
1781
1433
        """
 
1434
        if pb is None:
 
1435
            pb = progress.DummyProgress()
1782
1436
        keys = set(keys)
1783
1437
        total = len(keys)
1784
1438
        # we don't care about inclusions, the caller cares.
1788
1442
            'unordered', True)):
1789
1443
            # XXX: todo - optimise to use less than full texts.
1790
1444
            key = record.key
1791
 
            if pb is not None:
1792
 
                pb.update('Walking content', key_idx, total)
 
1445
            pb.update('Walking content', key_idx, total)
1793
1446
            if record.storage_kind == 'absent':
1794
1447
                raise errors.RevisionNotPresent(key, self)
1795
1448
            lines = osutils.split_lines(record.get_bytes_as('fulltext'))
1796
1449
            for line in lines:
1797
1450
                yield line, key
1798
 
        if pb is not None:
1799
 
            pb.update('Walking content', total, total)
 
1451
        pb.update('Walking content', total, total)
1800
1452
 
1801
1453
    def keys(self):
1802
1454
        """See VersionedFiles.keys."""
1813
1465
    """Mapper from GroupCompressVersionedFiles needs into GraphIndex storage."""
1814
1466
 
1815
1467
    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):
 
1468
        add_callback=None):
1818
1469
        """Construct a _GCGraphIndex on a graph_index.
1819
1470
 
1820
1471
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
1825
1476
        :param add_callback: If not None, allow additions to the index and call
1826
1477
            this callback with a list of added GraphIndex nodes:
1827
1478
            [(node, value, node_refs), ...]
1828
 
        :param track_external_parent_refs: As keys are added, keep track of the
1829
 
            keys they reference, so that we can query get_missing_parents(),
1830
 
            etc.
1831
 
        :param inconsistency_fatal: When asked to add records that are already
1832
 
            present, and the details are inconsistent with the existing
1833
 
            record, raise an exception instead of warning (and skipping the
1834
 
            record).
1835
1479
        """
1836
1480
        self._add_callback = add_callback
1837
1481
        self._graph_index = graph_index
1838
1482
        self._parents = parents
1839
1483
        self.has_graph = parents
1840
1484
        self._is_locked = is_locked
1841
 
        self._inconsistency_fatal = inconsistency_fatal
1842
 
        # GroupCompress records tend to have the same 'group' start + offset
1843
 
        # repeated over and over, this creates a surplus of ints
1844
 
        self._int_cache = {}
1845
 
        if track_external_parent_refs:
1846
 
            self._key_dependencies = knit._KeyRefs(
1847
 
                track_new_keys=track_new_keys)
1848
 
        else:
1849
 
            self._key_dependencies = None
1850
1485
 
1851
1486
    def add_records(self, records, random_id=False):
1852
1487
        """Add multiple records to the index.
1873
1508
                if refs:
1874
1509
                    for ref in refs:
1875
1510
                        if ref:
1876
 
                            raise errors.KnitCorrupt(self,
 
1511
                            raise KnitCorrupt(self,
1877
1512
                                "attempt to add node with parents "
1878
1513
                                "in parentless index.")
1879
1514
                    refs = ()
1883
1518
        if not random_id:
1884
1519
            present_nodes = self._get_entries(keys)
1885
1520
            for (index, key, value, node_refs) in present_nodes:
1886
 
                # Sometimes these are passed as a list rather than a tuple
1887
 
                node_refs = static_tuple.as_tuples(node_refs)
1888
 
                passed = static_tuple.as_tuples(keys[key])
1889
 
                if node_refs != passed[1]:
1890
 
                    details = '%s %s %s' % (key, (value, node_refs), passed)
1891
 
                    if self._inconsistency_fatal:
1892
 
                        raise errors.KnitCorrupt(self, "inconsistent details"
1893
 
                                                 " in add_records: %s" %
1894
 
                                                 details)
1895
 
                    else:
1896
 
                        trace.warning("inconsistent details in skipped"
1897
 
                                      " record: %s", details)
 
1521
                if node_refs != keys[key][1]:
 
1522
                    raise errors.KnitCorrupt(self, "inconsistent details in add_records"
 
1523
                        ": %s %s" % ((value, node_refs), keys[key]))
1898
1524
                del keys[key]
1899
1525
                changed = True
1900
1526
        if changed:
1906
1532
                for key, (value, node_refs) in keys.iteritems():
1907
1533
                    result.append((key, value))
1908
1534
            records = result
1909
 
        key_dependencies = self._key_dependencies
1910
 
        if key_dependencies is not None:
1911
 
            if self._parents:
1912
 
                for key, value, refs in records:
1913
 
                    parents = refs[0]
1914
 
                    key_dependencies.add_references(key, parents)
1915
 
            else:
1916
 
                for key, value, refs in records:
1917
 
                    new_keys.add_key(key)
1918
1535
        self._add_callback(records)
1919
1536
 
1920
1537
    def _check_read(self):
1949
1566
        if check_present:
1950
1567
            missing_keys = keys.difference(found_keys)
1951
1568
            if missing_keys:
1952
 
                raise errors.RevisionNotPresent(missing_keys.pop(), self)
1953
 
 
1954
 
    def find_ancestry(self, keys):
1955
 
        """See CombinedGraphIndex.find_ancestry"""
1956
 
        return self._graph_index.find_ancestry(keys, 0)
 
1569
                raise RevisionNotPresent(missing_keys.pop(), self)
1957
1570
 
1958
1571
    def get_parent_map(self, keys):
1959
1572
        """Get a map of the parents of keys.
1973
1586
                result[node[1]] = None
1974
1587
        return result
1975
1588
 
1976
 
    def get_missing_parents(self):
1977
 
        """Return the keys of missing parents."""
1978
 
        # Copied from _KnitGraphIndex.get_missing_parents
1979
 
        # We may have false positives, so filter those out.
1980
 
        self._key_dependencies.satisfy_refs_for_keys(
1981
 
            self.get_parent_map(self._key_dependencies.get_unsatisfied_refs()))
1982
 
        return frozenset(self._key_dependencies.get_unsatisfied_refs())
1983
 
 
1984
1589
    def get_build_details(self, keys):
1985
1590
        """Get the various build details for keys.
1986
1591
 
2026
1631
        """Convert an index value to position details."""
2027
1632
        bits = node[2].split(' ')
2028
1633
        # It would be nice not to read the entire gzip.
2029
 
        # start and stop are put into _int_cache because they are very common.
2030
 
        # They define the 'group' that an entry is in, and many groups can have
2031
 
        # thousands of objects.
2032
 
        # Branching Launchpad, for example, saves ~600k integers, at 12 bytes
2033
 
        # each, or about 7MB. Note that it might be even more when you consider
2034
 
        # how PyInt is allocated in separate slabs. And you can't return a slab
2035
 
        # 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
2037
 
        # fragmentation.
2038
1634
        start = int(bits[0])
2039
 
        start = self._int_cache.setdefault(start, start)
2040
1635
        stop = int(bits[1])
2041
 
        stop = self._int_cache.setdefault(stop, stop)
2042
1636
        basis_end = int(bits[2])
2043
1637
        delta_end = int(bits[3])
2044
 
        # We can't use StaticTuple here, because node[0] is a BTreeGraphIndex
2045
 
        # instance...
2046
 
        return (node[0], start, stop, basis_end, delta_end)
2047
 
 
2048
 
    def scan_unvalidated_index(self, graph_index):
2049
 
        """Inform this _GCGraphIndex that there is an unvalidated index.
2050
 
 
2051
 
        This allows this _GCGraphIndex to keep track of any missing
2052
 
        compression parents we may want to have filled in to make those
2053
 
        indices valid.  It also allows _GCGraphIndex to track any new keys.
2054
 
 
2055
 
        :param graph_index: A GraphIndex
2056
 
        """
2057
 
        key_dependencies = self._key_dependencies
2058
 
        if key_dependencies is None:
2059
 
            return
2060
 
        for node in graph_index.iter_all_entries():
2061
 
            # Add parent refs from graph_index (and discard parent refs
2062
 
            # that the graph_index has).
2063
 
            key_dependencies.add_references(node[1], node[3][0])
 
1638
        return node[0], start, stop, basis_end, delta_end
2064
1639
 
2065
1640
 
2066
1641
from bzrlib._groupcompress_py import (
2068
1643
    apply_delta_to_source,
2069
1644
    encode_base128_int,
2070
1645
    decode_base128_int,
2071
 
    decode_copy_instruction,
2072
1646
    LinesDeltaIndex,
2073
1647
    )
2074
1648
try:
2080
1654
        decode_base128_int,
2081
1655
        )
2082
1656
    GroupCompressor = PyrexGroupCompressor
2083
 
except ImportError, e:
2084
 
    osutils.failed_to_load_extension(e)
 
1657
except ImportError:
2085
1658
    GroupCompressor = PythonGroupCompressor
2086
1659