~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/groupcompress.py

  • Committer: Martin Pool
  • Date: 2009-07-10 06:46:10 UTC
  • mto: (4525.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4526.
  • Revision ID: mbp@sourcefrog.net-20090710064610-sqviksbqp5i34sw2
Rename to per_interrepository

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
31
31
    knit,
32
32
    osutils,
33
33
    pack,
34
 
    static_tuple,
35
34
    trace,
36
35
    )
 
36
from bzrlib.graph import Graph
37
37
from bzrlib.btree_index import BTreeBuilder
38
38
from bzrlib.lru_cache import LRUSizeCache
39
39
from bzrlib.tsort import topo_sort
45
45
    VersionedFiles,
46
46
    )
47
47
 
48
 
# Minimum number of uncompressed bytes to try fetch at once when retrieving
49
 
# groupcompress blocks.
50
 
BATCH_SIZE = 2**16
51
 
 
52
48
_USE_LZMA = False and (pylzma is not None)
53
49
 
54
50
# osutils.sha_string('')
55
51
_null_sha1 = 'da39a3ee5e6b4b0d3255bfef95601890afd80709'
56
52
 
 
53
 
57
54
def sort_gc_optimal(parent_map):
58
55
    """Sort and group the keys in parent_map into groupcompress order.
59
56
 
65
62
    # groupcompress ordering is approximately reverse topological,
66
63
    # properly grouped by file-id.
67
64
    per_prefix_map = {}
68
 
    for key, value in parent_map.iteritems():
 
65
    for item in parent_map.iteritems():
 
66
        key = item[0]
69
67
        if isinstance(key, str) or len(key) == 1:
70
68
            prefix = ''
71
69
        else:
72
70
            prefix = key[0]
73
71
        try:
74
 
            per_prefix_map[prefix][key] = value
 
72
            per_prefix_map[prefix].append(item)
75
73
        except KeyError:
76
 
            per_prefix_map[prefix] = {key: value}
 
74
            per_prefix_map[prefix] = [item]
77
75
 
78
76
    present_keys = []
79
77
    for prefix in sorted(per_prefix_map):
101
99
    def __init__(self):
102
100
        # map by key? or just order in file?
103
101
        self._compressor_name = None
104
 
        self._z_content_chunks = None
 
102
        self._z_content = None
105
103
        self._z_content_decompressor = None
106
104
        self._z_content_length = None
107
105
        self._content_length = None
120
118
        :param num_bytes: Ensure that we have extracted at least num_bytes of
121
119
            content. If None, consume everything
122
120
        """
123
 
        if self._content_length is None:
124
 
            raise AssertionError('self._content_length should never be None')
 
121
        # TODO: If we re-use the same content block at different times during
 
122
        #       get_record_stream(), it is possible that the first pass will
 
123
        #       get inserted, triggering an extract/_ensure_content() which
 
124
        #       will get rid of _z_content. And then the next use of the block
 
125
        #       will try to access _z_content (to send it over the wire), and
 
126
        #       fail because it is already extracted. Consider never releasing
 
127
        #       _z_content because of this.
125
128
        if num_bytes is None:
126
129
            num_bytes = self._content_length
127
130
        elif (self._content_length is not None
135
138
                self._content = ''.join(self._content_chunks)
136
139
                self._content_chunks = None
137
140
        if self._content is None:
138
 
            # We join self._z_content_chunks here, because if we are
139
 
            # decompressing, then it is *very* likely that we have a single
140
 
            # chunk
141
 
            if self._z_content_chunks is None:
 
141
            if self._z_content is None:
142
142
                raise AssertionError('No content to decompress')
143
 
            z_content = ''.join(self._z_content_chunks)
144
 
            if z_content == '':
 
143
            if self._z_content == '':
145
144
                self._content = ''
146
145
            elif self._compressor_name == 'lzma':
147
146
                # We don't do partial lzma decomp yet
148
 
                self._content = pylzma.decompress(z_content)
 
147
                self._content = pylzma.decompress(self._z_content)
149
148
            elif self._compressor_name == 'zlib':
150
149
                # Start a zlib decompressor
151
 
                if num_bytes * 4 > self._content_length * 3:
152
 
                    # If we are requesting more that 3/4ths of the content,
153
 
                    # just extract the whole thing in a single pass
154
 
                    num_bytes = self._content_length
155
 
                    self._content = zlib.decompress(z_content)
 
150
                if num_bytes is None:
 
151
                    self._content = zlib.decompress(self._z_content)
156
152
                else:
157
153
                    self._z_content_decompressor = zlib.decompressobj()
158
154
                    # Seed the decompressor with the uncompressed bytes, so
159
155
                    # that the rest of the code is simplified
160
156
                    self._content = self._z_content_decompressor.decompress(
161
 
                        z_content, num_bytes + _ZLIB_DECOMP_WINDOW)
162
 
                    if not self._z_content_decompressor.unconsumed_tail:
163
 
                        self._z_content_decompressor = None
 
157
                        self._z_content, num_bytes + _ZLIB_DECOMP_WINDOW)
164
158
            else:
165
159
                raise AssertionError('Unknown compressor: %r'
166
160
                                     % self._compressor_name)
168
162
        # 'unconsumed_tail'
169
163
 
170
164
        # Do we have enough bytes already?
171
 
        if len(self._content) >= num_bytes:
 
165
        if num_bytes is not None and len(self._content) >= num_bytes:
 
166
            return
 
167
        if num_bytes is None and self._z_content_decompressor is None:
 
168
            # We must have already decompressed everything
172
169
            return
173
170
        # If we got this far, and don't have a decompressor, something is wrong
174
171
        if self._z_content_decompressor is None:
175
172
            raise AssertionError(
176
173
                'No decompressor to decompress %d bytes' % num_bytes)
177
174
        remaining_decomp = self._z_content_decompressor.unconsumed_tail
178
 
        if not remaining_decomp:
179
 
            raise AssertionError('Nothing left to decompress')
180
 
        needed_bytes = num_bytes - len(self._content)
181
 
        # We always set max_size to 32kB over the minimum needed, so that
182
 
        # zlib will give us as much as we really want.
183
 
        # TODO: If this isn't good enough, we could make a loop here,
184
 
        #       that keeps expanding the request until we get enough
185
 
        self._content += self._z_content_decompressor.decompress(
186
 
            remaining_decomp, needed_bytes + _ZLIB_DECOMP_WINDOW)
187
 
        if len(self._content) < num_bytes:
188
 
            raise AssertionError('%d bytes wanted, only %d available'
189
 
                                 % (num_bytes, len(self._content)))
190
 
        if not self._z_content_decompressor.unconsumed_tail:
191
 
            # The stream is finished
192
 
            self._z_content_decompressor = None
 
175
        if num_bytes is None:
 
176
            if remaining_decomp:
 
177
                # We don't know how much is left, but we'll decompress it all
 
178
                self._content += self._z_content_decompressor.decompress(
 
179
                    remaining_decomp)
 
180
                # Note: There's what I consider a bug in zlib.decompressobj
 
181
                #       If you pass back in the entire unconsumed_tail, only
 
182
                #       this time you don't pass a max-size, it doesn't
 
183
                #       change the unconsumed_tail back to None/''.
 
184
                #       However, we know we are done with the whole stream
 
185
                self._z_content_decompressor = None
 
186
            # XXX: Why is this the only place in this routine we set this?
 
187
            self._content_length = len(self._content)
 
188
        else:
 
189
            if not remaining_decomp:
 
190
                raise AssertionError('Nothing left to decompress')
 
191
            needed_bytes = num_bytes - len(self._content)
 
192
            # We always set max_size to 32kB over the minimum needed, so that
 
193
            # zlib will give us as much as we really want.
 
194
            # TODO: If this isn't good enough, we could make a loop here,
 
195
            #       that keeps expanding the request until we get enough
 
196
            self._content += self._z_content_decompressor.decompress(
 
197
                remaining_decomp, needed_bytes + _ZLIB_DECOMP_WINDOW)
 
198
            if len(self._content) < num_bytes:
 
199
                raise AssertionError('%d bytes wanted, only %d available'
 
200
                                     % (num_bytes, len(self._content)))
 
201
            if not self._z_content_decompressor.unconsumed_tail:
 
202
                # The stream is finished
 
203
                self._z_content_decompressor = None
193
204
 
194
205
    def _parse_bytes(self, bytes, pos):
195
206
        """Read the various lengths from the header.
211
222
            # XXX: Define some GCCorrupt error ?
212
223
            raise AssertionError('Invalid bytes: (%d) != %d + %d' %
213
224
                                 (len(bytes), pos, self._z_content_length))
214
 
        self._z_content_chunks = (bytes[pos:],)
215
 
 
216
 
    @property
217
 
    def _z_content(self):
218
 
        """Return z_content_chunks as a simple string.
219
 
 
220
 
        Meant only to be used by the test suite.
221
 
        """
222
 
        if self._z_content_chunks is not None:
223
 
            return ''.join(self._z_content_chunks)
224
 
        return None
 
225
        self._z_content = bytes[pos:]
225
226
 
226
227
    @classmethod
227
228
    def from_bytes(cls, bytes):
283
284
        self._content_length = length
284
285
        self._content_chunks = content_chunks
285
286
        self._content = None
286
 
        self._z_content_chunks = None
 
287
        self._z_content = None
287
288
 
288
289
    def set_content(self, content):
289
290
        """Set the content of this block."""
290
291
        self._content_length = len(content)
291
292
        self._content = content
292
 
        self._z_content_chunks = None
 
293
        self._z_content = None
293
294
 
294
295
    def _create_z_content_using_lzma(self):
295
296
        if self._content_chunks is not None:
297
298
            self._content_chunks = None
298
299
        if self._content is None:
299
300
            raise AssertionError('Nothing to compress')
300
 
        z_content = pylzma.compress(self._content)
301
 
        self._z_content_chunks = (z_content,)
302
 
        self._z_content_length = len(z_content)
 
301
        self._z_content = pylzma.compress(self._content)
 
302
        self._z_content_length = len(self._z_content)
303
303
 
304
 
    def _create_z_content_from_chunks(self, chunks):
 
304
    def _create_z_content_from_chunks(self):
305
305
        compressor = zlib.compressobj(zlib.Z_DEFAULT_COMPRESSION)
306
 
        # Peak in this point is 1 fulltext, 1 compressed text, + zlib overhead
307
 
        # (measured peak is maybe 30MB over the above...)
308
 
        compressed_chunks = map(compressor.compress, chunks)
 
306
        compressed_chunks = map(compressor.compress, self._content_chunks)
309
307
        compressed_chunks.append(compressor.flush())
310
 
        # Ignore empty chunks
311
 
        self._z_content_chunks = [c for c in compressed_chunks if c]
312
 
        self._z_content_length = sum(map(len, self._z_content_chunks))
 
308
        self._z_content = ''.join(compressed_chunks)
 
309
        self._z_content_length = len(self._z_content)
313
310
 
314
311
    def _create_z_content(self):
315
 
        if self._z_content_chunks is not None:
 
312
        if self._z_content is not None:
316
313
            return
317
314
        if _USE_LZMA:
318
315
            self._create_z_content_using_lzma()
319
316
            return
320
317
        if self._content_chunks is not None:
321
 
            chunks = self._content_chunks
322
 
        else:
323
 
            chunks = (self._content,)
324
 
        self._create_z_content_from_chunks(chunks)
 
318
            self._create_z_content_from_chunks()
 
319
            return
 
320
        self._z_content = zlib.compress(self._content)
 
321
        self._z_content_length = len(self._z_content)
325
322
 
326
 
    def to_chunks(self):
327
 
        """Create the byte stream as a series of 'chunks'"""
 
323
    def to_bytes(self):
 
324
        """Encode the information into a byte stream."""
328
325
        self._create_z_content()
329
326
        if _USE_LZMA:
330
327
            header = self.GCB_LZ_HEADER
331
328
        else:
332
329
            header = self.GCB_HEADER
333
 
        chunks = ['%s%d\n%d\n'
334
 
                  % (header, self._z_content_length, self._content_length),
 
330
        chunks = [header,
 
331
                  '%d\n%d\n' % (self._z_content_length, self._content_length),
 
332
                  self._z_content,
335
333
                 ]
336
 
        chunks.extend(self._z_content_chunks)
337
 
        total_len = sum(map(len, chunks))
338
 
        return total_len, chunks
339
 
 
340
 
    def to_bytes(self):
341
 
        """Encode the information into a byte stream."""
342
 
        total_len, chunks = self.to_chunks()
343
334
        return ''.join(chunks)
344
335
 
345
336
    def _dump(self, include_text=False):
465
456
                # There are code paths that first extract as fulltext, and then
466
457
                # extract as storage_kind (smart fetch). So we don't break the
467
458
                # refcycle here, but instead in manager.get_record_stream()
 
459
                # self._manager = None
468
460
            if storage_kind == 'fulltext':
469
461
                return self._bytes
470
462
            else:
476
468
class _LazyGroupContentManager(object):
477
469
    """This manages a group of _LazyGroupCompressFactory objects."""
478
470
 
479
 
    _max_cut_fraction = 0.75 # We allow a block to be trimmed to 75% of
480
 
                             # current size, and still be considered
481
 
                             # resuable
482
 
    _full_block_size = 4*1024*1024
483
 
    _full_mixed_block_size = 2*1024*1024
484
 
    _full_enough_block_size = 3*1024*1024 # size at which we won't repack
485
 
    _full_enough_mixed_block_size = 2*768*1024 # 1.5MB
486
 
 
487
471
    def __init__(self, block):
488
472
        self._block = block
489
473
        # We need to preserve the ordering
561
545
        # time (self._block._content) is a little expensive.
562
546
        self._block._ensure_content(self._last_byte)
563
547
 
564
 
    def _check_rebuild_action(self):
 
548
    def _check_rebuild_block(self):
565
549
        """Check to see if our block should be repacked."""
566
550
        total_bytes_used = 0
567
551
        last_byte_used = 0
568
552
        for factory in self._factories:
569
553
            total_bytes_used += factory._end - factory._start
570
 
            if last_byte_used < factory._end:
571
 
                last_byte_used = factory._end
572
 
        # If we are using more than half of the bytes from the block, we have
573
 
        # nothing else to check
 
554
            last_byte_used = max(last_byte_used, factory._end)
 
555
        # If we are using most of the bytes from the block, we have nothing
 
556
        # else to check (currently more that 1/2)
574
557
        if total_bytes_used * 2 >= self._block._content_length:
575
 
            return None, last_byte_used, total_bytes_used
576
 
        # We are using less than 50% of the content. Is the content we are
577
 
        # using at the beginning of the block? If so, we can just trim the
578
 
        # tail, rather than rebuilding from scratch.
 
558
            return
 
559
        # Can we just strip off the trailing bytes? If we are going to be
 
560
        # transmitting more than 50% of the front of the content, go ahead
579
561
        if total_bytes_used * 2 > last_byte_used:
580
 
            return 'trim', last_byte_used, total_bytes_used
 
562
            self._trim_block(last_byte_used)
 
563
            return
581
564
 
582
565
        # We are using a small amount of the data, and it isn't just packed
583
566
        # nicely at the front, so rebuild the content.
590
573
        #       expanding many deltas into fulltexts, as well.
591
574
        #       If we build a cheap enough 'strip', then we could try a strip,
592
575
        #       if that expands the content, we then rebuild.
593
 
        return 'rebuild', last_byte_used, total_bytes_used
594
 
 
595
 
    def check_is_well_utilized(self):
596
 
        """Is the current block considered 'well utilized'?
597
 
 
598
 
        This heuristic asks if the current block considers itself to be a fully
599
 
        developed group, rather than just a loose collection of data.
600
 
        """
601
 
        if len(self._factories) == 1:
602
 
            # A block of length 1 could be improved by combining with other
603
 
            # groups - don't look deeper. Even larger than max size groups
604
 
            # could compress well with adjacent versions of the same thing.
605
 
            return False
606
 
        action, last_byte_used, total_bytes_used = self._check_rebuild_action()
607
 
        block_size = self._block._content_length
608
 
        if total_bytes_used < block_size * self._max_cut_fraction:
609
 
            # This block wants to trim itself small enough that we want to
610
 
            # consider it under-utilized.
611
 
            return False
612
 
        # TODO: This code is meant to be the twin of _insert_record_stream's
613
 
        #       'start_new_block' logic. It would probably be better to factor
614
 
        #       out that logic into a shared location, so that it stays
615
 
        #       together better
616
 
        # We currently assume a block is properly utilized whenever it is >75%
617
 
        # of the size of a 'full' block. In normal operation, a block is
618
 
        # considered full when it hits 4MB of same-file content. So any block
619
 
        # >3MB is 'full enough'.
620
 
        # The only time this isn't true is when a given block has large-object
621
 
        # content. (a single file >4MB, etc.)
622
 
        # Under these circumstances, we allow a block to grow to
623
 
        # 2 x largest_content.  Which means that if a given block had a large
624
 
        # object, it may actually be under-utilized. However, given that this
625
 
        # is 'pack-on-the-fly' it is probably reasonable to not repack large
626
 
        # content blobs on-the-fly. Note that because we return False for all
627
 
        # 1-item blobs, we will repack them; we may wish to reevaluate our
628
 
        # treatment of large object blobs in the future.
629
 
        if block_size >= self._full_enough_block_size:
630
 
            return True
631
 
        # If a block is <3MB, it still may be considered 'full' if it contains
632
 
        # mixed content. The current rule is 2MB of mixed content is considered
633
 
        # full. So check to see if this block contains mixed content, and
634
 
        # set the threshold appropriately.
635
 
        common_prefix = None
636
 
        for factory in self._factories:
637
 
            prefix = factory.key[:-1]
638
 
            if common_prefix is None:
639
 
                common_prefix = prefix
640
 
            elif prefix != common_prefix:
641
 
                # Mixed content, check the size appropriately
642
 
                if block_size >= self._full_enough_mixed_block_size:
643
 
                    return True
644
 
                break
645
 
        # The content failed both the mixed check and the single-content check
646
 
        # so obviously it is not fully utilized
647
 
        # TODO: there is one other constraint that isn't being checked
648
 
        #       namely, that the entries in the block are in the appropriate
649
 
        #       order. For example, you could insert the entries in exactly
650
 
        #       reverse groupcompress order, and we would think that is ok.
651
 
        #       (all the right objects are in one group, and it is fully
652
 
        #       utilized, etc.) For now, we assume that case is rare,
653
 
        #       especially since we should always fetch in 'groupcompress'
654
 
        #       order.
655
 
        return False
656
 
 
657
 
    def _check_rebuild_block(self):
658
 
        action, last_byte_used, total_bytes_used = self._check_rebuild_action()
659
 
        if action is None:
660
 
            return
661
 
        if action == 'trim':
662
 
            self._trim_block(last_byte_used)
663
 
        elif action == 'rebuild':
664
 
            self._rebuild_block()
665
 
        else:
666
 
            raise ValueError('unknown rebuild action: %r' % (action,))
 
576
        self._rebuild_block()
667
577
 
668
578
    def _wire_bytes(self):
669
579
        """Return a byte stream suitable for transmitting over the wire."""
703
613
        z_header_bytes = zlib.compress(header_bytes)
704
614
        del header_bytes
705
615
        z_header_bytes_len = len(z_header_bytes)
706
 
        block_bytes_len, block_chunks = self._block.to_chunks()
 
616
        block_bytes = self._block.to_bytes()
707
617
        lines.append('%d\n%d\n%d\n' % (z_header_bytes_len, header_bytes_len,
708
 
                                       block_bytes_len))
 
618
                                       len(block_bytes)))
709
619
        lines.append(z_header_bytes)
710
 
        lines.extend(block_chunks)
711
 
        del z_header_bytes, block_chunks
712
 
        # TODO: This is a point where we will double the memory consumption. To
713
 
        #       avoid this, we probably have to switch to a 'chunked' api
 
620
        lines.append(block_bytes)
 
621
        del z_header_bytes, block_bytes
714
622
        return ''.join(lines)
715
623
 
716
624
    @classmethod
717
625
    def from_bytes(cls, bytes):
718
626
        # TODO: This does extra string copying, probably better to do it a
719
 
        #       different way. At a minimum this creates 2 copies of the
720
 
        #       compressed content
 
627
        #       different way
721
628
        (storage_kind, z_header_len, header_len,
722
629
         block_len, rest) = bytes.split('\n', 4)
723
630
        del bytes
881
788
 
882
789
        After calling this, the compressor should no longer be used
883
790
        """
 
791
        # TODO: this causes us to 'bloat' to 2x the size of content in the
 
792
        #       group. This has an impact for 'commit' of large objects.
 
793
        #       One possibility is to use self._content_chunks, and be lazy and
 
794
        #       only fill out self._content as a full string when we actually
 
795
        #       need it. That would at least drop the peak memory consumption
 
796
        #       for 'commit' down to ~1x the size of the largest file, at a
 
797
        #       cost of increased complexity within this code. 2x is still <<
 
798
        #       3x the size of the largest file, so we are doing ok.
884
799
        self._block.set_chunked_content(self.chunks, self.endpoint)
885
800
        self.chunks = None
886
801
        self._delta_index = None
1060
975
    versioned_files.stream.close()
1061
976
 
1062
977
 
1063
 
class _BatchingBlockFetcher(object):
1064
 
    """Fetch group compress blocks in batches.
1065
 
    
1066
 
    :ivar total_bytes: int of expected number of bytes needed to fetch the
1067
 
        currently pending batch.
1068
 
    """
1069
 
 
1070
 
    def __init__(self, gcvf, locations):
1071
 
        self.gcvf = gcvf
1072
 
        self.locations = locations
1073
 
        self.keys = []
1074
 
        self.batch_memos = {}
1075
 
        self.memos_to_get = []
1076
 
        self.total_bytes = 0
1077
 
        self.last_read_memo = None
1078
 
        self.manager = None
1079
 
 
1080
 
    def add_key(self, key):
1081
 
        """Add another to key to fetch.
1082
 
        
1083
 
        :return: The estimated number of bytes needed to fetch the batch so
1084
 
            far.
1085
 
        """
1086
 
        self.keys.append(key)
1087
 
        index_memo, _, _, _ = self.locations[key]
1088
 
        read_memo = index_memo[0:3]
1089
 
        # Three possibilities for this read_memo:
1090
 
        #  - it's already part of this batch; or
1091
 
        #  - it's not yet part of this batch, but is already cached; or
1092
 
        #  - it's not yet part of this batch and will need to be fetched.
1093
 
        if read_memo in self.batch_memos:
1094
 
            # This read memo is already in this batch.
1095
 
            return self.total_bytes
1096
 
        try:
1097
 
            cached_block = self.gcvf._group_cache[read_memo]
1098
 
        except KeyError:
1099
 
            # This read memo is new to this batch, and the data isn't cached
1100
 
            # either.
1101
 
            self.batch_memos[read_memo] = None
1102
 
            self.memos_to_get.append(read_memo)
1103
 
            byte_length = read_memo[2]
1104
 
            self.total_bytes += byte_length
1105
 
        else:
1106
 
            # This read memo is new to this batch, but cached.
1107
 
            # Keep a reference to the cached block in batch_memos because it's
1108
 
            # certain that we'll use it when this batch is processed, but
1109
 
            # there's a risk that it would fall out of _group_cache between now
1110
 
            # and then.
1111
 
            self.batch_memos[read_memo] = cached_block
1112
 
        return self.total_bytes
1113
 
        
1114
 
    def _flush_manager(self):
1115
 
        if self.manager is not None:
1116
 
            for factory in self.manager.get_record_stream():
1117
 
                yield factory
1118
 
            self.manager = None
1119
 
            self.last_read_memo = None
1120
 
 
1121
 
    def yield_factories(self, full_flush=False):
1122
 
        """Yield factories for keys added since the last yield.  They will be
1123
 
        returned in the order they were added via add_key.
1124
 
        
1125
 
        :param full_flush: by default, some results may not be returned in case
1126
 
            they can be part of the next batch.  If full_flush is True, then
1127
 
            all results are returned.
1128
 
        """
1129
 
        if self.manager is None and not self.keys:
1130
 
            return
1131
 
        # Fetch all memos in this batch.
1132
 
        blocks = self.gcvf._get_blocks(self.memos_to_get)
1133
 
        # Turn blocks into factories and yield them.
1134
 
        memos_to_get_stack = list(self.memos_to_get)
1135
 
        memos_to_get_stack.reverse()
1136
 
        for key in self.keys:
1137
 
            index_memo, _, parents, _ = self.locations[key]
1138
 
            read_memo = index_memo[:3]
1139
 
            if self.last_read_memo != read_memo:
1140
 
                # We are starting a new block. If we have a
1141
 
                # manager, we have found everything that fits for
1142
 
                # now, so yield records
1143
 
                for factory in self._flush_manager():
1144
 
                    yield factory
1145
 
                # Now start a new manager.
1146
 
                if memos_to_get_stack and memos_to_get_stack[-1] == read_memo:
1147
 
                    # The next block from _get_blocks will be the block we
1148
 
                    # need.
1149
 
                    block_read_memo, block = blocks.next()
1150
 
                    if block_read_memo != read_memo:
1151
 
                        raise AssertionError(
1152
 
                            "block_read_memo out of sync with read_memo"
1153
 
                            "(%r != %r)" % (block_read_memo, read_memo))
1154
 
                    self.batch_memos[read_memo] = block
1155
 
                    memos_to_get_stack.pop()
1156
 
                else:
1157
 
                    block = self.batch_memos[read_memo]
1158
 
                self.manager = _LazyGroupContentManager(block)
1159
 
                self.last_read_memo = read_memo
1160
 
            start, end = index_memo[3:5]
1161
 
            self.manager.add_factory(key, parents, start, end)
1162
 
        if full_flush:
1163
 
            for factory in self._flush_manager():
1164
 
                yield factory
1165
 
        del self.keys[:]
1166
 
        self.batch_memos.clear()
1167
 
        del self.memos_to_get[:]
1168
 
        self.total_bytes = 0
1169
 
 
1170
 
 
1171
978
class GroupCompressVersionedFiles(VersionedFiles):
1172
979
    """A group-compress based VersionedFiles implementation."""
1173
980
 
1174
 
    def __init__(self, index, access, delta=True, _unadded_refs=None):
 
981
    def __init__(self, index, access, delta=True):
1175
982
        """Create a GroupCompressVersionedFiles object.
1176
983
 
1177
984
        :param index: The index object storing access and graph data.
1178
985
        :param access: The access object storing raw data.
1179
986
        :param delta: Whether to delta compress or just entropy compress.
1180
 
        :param _unadded_refs: private parameter, don't use.
1181
987
        """
1182
988
        self._index = index
1183
989
        self._access = access
1184
990
        self._delta = delta
1185
 
        if _unadded_refs is None:
1186
 
            _unadded_refs = {}
1187
 
        self._unadded_refs = _unadded_refs
 
991
        self._unadded_refs = {}
1188
992
        self._group_cache = LRUSizeCache(max_size=50*1024*1024)
1189
993
        self._fallback_vfs = []
1190
994
 
1191
 
    def without_fallbacks(self):
1192
 
        """Return a clone of this object without any fallbacks configured."""
1193
 
        return GroupCompressVersionedFiles(self._index, self._access,
1194
 
            self._delta, _unadded_refs=dict(self._unadded_refs))
1195
 
 
1196
995
    def add_lines(self, key, parents, lines, parent_texts=None,
1197
996
        left_matching_blocks=None, nostore_sha=None, random_id=False,
1198
997
        check_content=True):
1276
1075
    def get_annotator(self):
1277
1076
        return annotate.Annotator(self)
1278
1077
 
1279
 
    def check(self, progress_bar=None, keys=None):
 
1078
    def check(self, progress_bar=None):
1280
1079
        """See VersionedFiles.check()."""
1281
 
        if keys is None:
1282
 
            keys = self.keys()
1283
 
            for record in self.get_record_stream(keys, 'unordered', True):
1284
 
                record.get_bytes_as('fulltext')
1285
 
        else:
1286
 
            return self.get_record_stream(keys, 'unordered', True)
1287
 
 
1288
 
    def clear_cache(self):
1289
 
        """See VersionedFiles.clear_cache()"""
1290
 
        self._group_cache.clear()
1291
 
        self._index._graph_index.clear_cache()
1292
 
        self._index._int_cache.clear()
 
1080
        keys = self.keys()
 
1081
        for record in self.get_record_stream(keys, 'unordered', True):
 
1082
            record.get_bytes_as('fulltext')
1293
1083
 
1294
1084
    def _check_add(self, key, lines, random_id, check_content):
1295
1085
        """check that version_id and lines are safe to add."""
1306
1096
            self._check_lines_not_unicode(lines)
1307
1097
            self._check_lines_are_lines(lines)
1308
1098
 
1309
 
    def get_known_graph_ancestry(self, keys):
1310
 
        """Get a KnownGraph instance with the ancestry of keys."""
1311
 
        # Note that this is identical to
1312
 
        # KnitVersionedFiles.get_known_graph_ancestry, but they don't share
1313
 
        # ancestry.
1314
 
        parent_map, missing_keys = self._index.find_ancestry(keys)
1315
 
        for fallback in self._fallback_vfs:
1316
 
            if not missing_keys:
1317
 
                break
1318
 
            (f_parent_map, f_missing_keys) = fallback._index.find_ancestry(
1319
 
                                                missing_keys)
1320
 
            parent_map.update(f_parent_map)
1321
 
            missing_keys = f_missing_keys
1322
 
        kg = _mod_graph.KnownGraph(parent_map)
1323
 
        return kg
1324
 
 
1325
1099
    def get_parent_map(self, keys):
1326
1100
        """Get a map of the graph parents of keys.
1327
1101
 
1354
1128
            missing.difference_update(set(new_result))
1355
1129
        return result, source_results
1356
1130
 
1357
 
    def _get_blocks(self, read_memos):
1358
 
        """Get GroupCompressBlocks for the given read_memos.
1359
 
 
1360
 
        :returns: a series of (read_memo, block) pairs, in the order they were
1361
 
            originally passed.
1362
 
        """
1363
 
        cached = {}
1364
 
        for read_memo in read_memos:
1365
 
            try:
1366
 
                block = self._group_cache[read_memo]
1367
 
            except KeyError:
1368
 
                pass
1369
 
            else:
1370
 
                cached[read_memo] = block
1371
 
        not_cached = []
1372
 
        not_cached_seen = set()
1373
 
        for read_memo in read_memos:
1374
 
            if read_memo in cached:
1375
 
                # Don't fetch what we already have
1376
 
                continue
1377
 
            if read_memo in not_cached_seen:
1378
 
                # Don't try to fetch the same data twice
1379
 
                continue
1380
 
            not_cached.append(read_memo)
1381
 
            not_cached_seen.add(read_memo)
1382
 
        raw_records = self._access.get_raw_records(not_cached)
1383
 
        for read_memo in read_memos:
1384
 
            try:
1385
 
                yield read_memo, cached[read_memo]
1386
 
            except KeyError:
1387
 
                # Read the block, and cache it.
1388
 
                zdata = raw_records.next()
1389
 
                block = GroupCompressBlock.from_bytes(zdata)
1390
 
                self._group_cache[read_memo] = block
1391
 
                cached[read_memo] = block
1392
 
                yield read_memo, block
 
1131
    def _get_block(self, index_memo):
 
1132
        read_memo = index_memo[0:3]
 
1133
        # get the group:
 
1134
        try:
 
1135
            block = self._group_cache[read_memo]
 
1136
        except KeyError:
 
1137
            # read the group
 
1138
            zdata = self._access.get_raw_records([read_memo]).next()
 
1139
            # decompress - whole thing - this is not a bug, as it
 
1140
            # permits caching. We might want to store the partially
 
1141
            # decompresed group and decompress object, so that recent
 
1142
            # texts are not penalised by big groups.
 
1143
            block = GroupCompressBlock.from_bytes(zdata)
 
1144
            self._group_cache[read_memo] = block
 
1145
        # cheapo debugging:
 
1146
        # print len(zdata), len(plain)
 
1147
        # parse - requires split_lines, better to have byte offsets
 
1148
        # here (but not by much - we only split the region for the
 
1149
        # recipe, and we often want to end up with lines anyway.
 
1150
        return block
1393
1151
 
1394
1152
    def get_missing_compression_parent_keys(self):
1395
1153
        """Return the keys of missing compression parents.
1561
1319
                unadded_keys, source_result)
1562
1320
        for key in missing:
1563
1321
            yield AbsentContentFactory(key)
1564
 
        # Batch up as many keys as we can until either:
1565
 
        #  - we encounter an unadded ref, or
1566
 
        #  - we run out of keys, or
1567
 
        #  - the total bytes to retrieve for this batch > BATCH_SIZE
1568
 
        batcher = _BatchingBlockFetcher(self, locations)
 
1322
        manager = None
 
1323
        last_read_memo = None
 
1324
        # TODO: This works fairly well at batching up existing groups into a
 
1325
        #       streamable format, and possibly allowing for taking one big
 
1326
        #       group and splitting it when it isn't fully utilized.
 
1327
        #       However, it doesn't allow us to find under-utilized groups and
 
1328
        #       combine them into a bigger group on the fly.
 
1329
        #       (Consider the issue with how chk_map inserts texts
 
1330
        #       one-at-a-time.) This could be done at insert_record_stream()
 
1331
        #       time, but it probably would decrease the number of
 
1332
        #       bytes-on-the-wire for fetch.
1569
1333
        for source, keys in source_keys:
1570
1334
            if source is self:
1571
1335
                for key in keys:
1572
1336
                    if key in self._unadded_refs:
1573
 
                        # Flush batch, then yield unadded ref from
1574
 
                        # self._compressor.
1575
 
                        for factory in batcher.yield_factories(full_flush=True):
1576
 
                            yield factory
 
1337
                        if manager is not None:
 
1338
                            for factory in manager.get_record_stream():
 
1339
                                yield factory
 
1340
                            last_read_memo = manager = None
1577
1341
                        bytes, sha1 = self._compressor.extract(key)
1578
1342
                        parents = self._unadded_refs[key]
1579
1343
                        yield FulltextContentFactory(key, parents, sha1, bytes)
1580
 
                        continue
1581
 
                    if batcher.add_key(key) > BATCH_SIZE:
1582
 
                        # Ok, this batch is big enough.  Yield some results.
1583
 
                        for factory in batcher.yield_factories():
1584
 
                            yield factory
 
1344
                    else:
 
1345
                        index_memo, _, parents, (method, _) = locations[key]
 
1346
                        read_memo = index_memo[0:3]
 
1347
                        if last_read_memo != read_memo:
 
1348
                            # We are starting a new block. If we have a
 
1349
                            # manager, we have found everything that fits for
 
1350
                            # now, so yield records
 
1351
                            if manager is not None:
 
1352
                                for factory in manager.get_record_stream():
 
1353
                                    yield factory
 
1354
                            # Now start a new manager
 
1355
                            block = self._get_block(index_memo)
 
1356
                            manager = _LazyGroupContentManager(block)
 
1357
                            last_read_memo = read_memo
 
1358
                        start, end = index_memo[3:5]
 
1359
                        manager.add_factory(key, parents, start, end)
1585
1360
            else:
1586
 
                for factory in batcher.yield_factories(full_flush=True):
1587
 
                    yield factory
 
1361
                if manager is not None:
 
1362
                    for factory in manager.get_record_stream():
 
1363
                        yield factory
 
1364
                    last_read_memo = manager = None
1588
1365
                for record in source.get_record_stream(keys, ordering,
1589
1366
                                                       include_delta_closure):
1590
1367
                    yield record
1591
 
        for factory in batcher.yield_factories(full_flush=True):
1592
 
            yield factory
 
1368
        if manager is not None:
 
1369
            for factory in manager.get_record_stream():
 
1370
                yield factory
1593
1371
 
1594
1372
    def get_sha1s(self, keys):
1595
1373
        """See VersionedFiles.get_sha1s()."""
1649
1427
        self._unadded_refs = {}
1650
1428
        keys_to_add = []
1651
1429
        def flush():
1652
 
            bytes_len, chunks = self._compressor.flush().to_chunks()
1653
 
            self._compressor = GroupCompressor()
1654
 
            # Note: At this point we still have 1 copy of the fulltext (in
1655
 
            #       record and the var 'bytes'), and this generates 2 copies of
1656
 
            #       the compressed text (one for bytes, one in chunks)
1657
 
            # TODO: Push 'chunks' down into the _access api, so that we don't
1658
 
            #       have to double compressed memory here
1659
 
            # TODO: Figure out how to indicate that we would be happy to free
1660
 
            #       the fulltext content at this point. Note that sometimes we
1661
 
            #       will want it later (streaming CHK pages), but most of the
1662
 
            #       time we won't (everything else)
1663
 
            bytes = ''.join(chunks)
1664
 
            del chunks
 
1430
            bytes = self._compressor.flush().to_bytes()
1665
1431
            index, start, length = self._access.add_raw_records(
1666
1432
                [(None, len(bytes))], bytes)[0]
1667
1433
            nodes = []
1670
1436
            self._index.add_records(nodes, random_id=random_id)
1671
1437
            self._unadded_refs = {}
1672
1438
            del keys_to_add[:]
 
1439
            self._compressor = GroupCompressor()
1673
1440
 
1674
1441
        last_prefix = None
1675
1442
        max_fulltext_len = 0
1679
1446
        block_length = None
1680
1447
        # XXX: TODO: remove this, it is just for safety checking for now
1681
1448
        inserted_keys = set()
1682
 
        reuse_this_block = reuse_blocks
1683
1449
        for record in stream:
1684
1450
            # Raise an error when a record is missing.
1685
1451
            if record.storage_kind == 'absent':
1693
1459
            if reuse_blocks:
1694
1460
                # If the reuse_blocks flag is set, check to see if we can just
1695
1461
                # copy a groupcompress block as-is.
1696
 
                # We only check on the first record (groupcompress-block) not
1697
 
                # on all of the (groupcompress-block-ref) entries.
1698
 
                # The reuse_this_block flag is then kept for as long as
1699
 
                if record.storage_kind == 'groupcompress-block':
1700
 
                    # Check to see if we really want to re-use this block
1701
 
                    insert_manager = record._manager
1702
 
                    reuse_this_block = insert_manager.check_is_well_utilized()
1703
 
            else:
1704
 
                reuse_this_block = False
1705
 
            if reuse_this_block:
1706
 
                # We still want to reuse this block
1707
1462
                if record.storage_kind == 'groupcompress-block':
1708
1463
                    # Insert the raw block into the target repo
1709
1464
                    insert_manager = record._manager
 
1465
                    insert_manager._check_rebuild_block()
1710
1466
                    bytes = record._manager._block.to_bytes()
1711
1467
                    _, start, length = self._access.add_raw_records(
1712
1468
                        [(None, len(bytes))], bytes)[0]
1717
1473
                                           'groupcompress-block-ref'):
1718
1474
                    if insert_manager is None:
1719
1475
                        raise AssertionError('No insert_manager set')
1720
 
                    if insert_manager is not record._manager:
1721
 
                        raise AssertionError('insert_manager does not match'
1722
 
                            ' the current record, we cannot be positive'
1723
 
                            ' that the appropriate content was inserted.'
1724
 
                            )
1725
1476
                    value = "%d %d %d %d" % (block_start, block_length,
1726
1477
                                             record._start, record._end)
1727
1478
                    nodes = [(record.key, value, (record.parents,))]
1777
1528
                key = record.key
1778
1529
            self._unadded_refs[key] = record.parents
1779
1530
            yield found_sha1
1780
 
            as_st = static_tuple.StaticTuple.from_sequence
1781
 
            if record.parents is not None:
1782
 
                parents = as_st([as_st(p) for p in record.parents])
1783
 
            else:
1784
 
                parents = None
1785
 
            refs = static_tuple.StaticTuple(parents)
1786
 
            keys_to_add.append((key, '%d %d' % (start_point, end_point), refs))
 
1531
            keys_to_add.append((key, '%d %d' % (start_point, end_point),
 
1532
                (record.parents,)))
1787
1533
        if len(keys_to_add):
1788
1534
            flush()
1789
1535
        self._compressor = None
1839
1585
        return result
1840
1586
 
1841
1587
 
1842
 
class _GCBuildDetails(object):
1843
 
    """A blob of data about the build details.
1844
 
 
1845
 
    This stores the minimal data, which then allows compatibility with the old
1846
 
    api, without taking as much memory.
1847
 
    """
1848
 
 
1849
 
    __slots__ = ('_index', '_group_start', '_group_end', '_basis_end',
1850
 
                 '_delta_end', '_parents')
1851
 
 
1852
 
    method = 'group'
1853
 
    compression_parent = None
1854
 
 
1855
 
    def __init__(self, parents, position_info):
1856
 
        self._parents = parents
1857
 
        (self._index, self._group_start, self._group_end, self._basis_end,
1858
 
         self._delta_end) = position_info
1859
 
 
1860
 
    def __repr__(self):
1861
 
        return '%s(%s, %s)' % (self.__class__.__name__,
1862
 
            self.index_memo, self._parents)
1863
 
 
1864
 
    @property
1865
 
    def index_memo(self):
1866
 
        return (self._index, self._group_start, self._group_end,
1867
 
                self._basis_end, self._delta_end)
1868
 
 
1869
 
    @property
1870
 
    def record_details(self):
1871
 
        return static_tuple.StaticTuple(self.method, None)
1872
 
 
1873
 
    def __getitem__(self, offset):
1874
 
        """Compatibility thunk to act like a tuple."""
1875
 
        if offset == 0:
1876
 
            return self.index_memo
1877
 
        elif offset == 1:
1878
 
            return self.compression_parent # Always None
1879
 
        elif offset == 2:
1880
 
            return self._parents
1881
 
        elif offset == 3:
1882
 
            return self.record_details
1883
 
        else:
1884
 
            raise IndexError('offset out of range')
1885
 
            
1886
 
    def __len__(self):
1887
 
        return 4
1888
 
 
1889
 
 
1890
1588
class _GCGraphIndex(object):
1891
1589
    """Mapper from GroupCompressVersionedFiles needs into GraphIndex storage."""
1892
1590
 
1893
1591
    def __init__(self, graph_index, is_locked, parents=True,
1894
1592
        add_callback=None, track_external_parent_refs=False,
1895
 
        inconsistency_fatal=True, track_new_keys=False):
 
1593
        inconsistency_fatal=True):
1896
1594
        """Construct a _GCGraphIndex on a graph_index.
1897
1595
 
1898
1596
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
1917
1615
        self.has_graph = parents
1918
1616
        self._is_locked = is_locked
1919
1617
        self._inconsistency_fatal = inconsistency_fatal
1920
 
        # GroupCompress records tend to have the same 'group' start + offset
1921
 
        # repeated over and over, this creates a surplus of ints
1922
 
        self._int_cache = {}
1923
1618
        if track_external_parent_refs:
1924
 
            self._key_dependencies = knit._KeyRefs(
1925
 
                track_new_keys=track_new_keys)
 
1619
            self._key_dependencies = knit._KeyRefs()
1926
1620
        else:
1927
1621
            self._key_dependencies = None
1928
1622
 
1961
1655
        if not random_id:
1962
1656
            present_nodes = self._get_entries(keys)
1963
1657
            for (index, key, value, node_refs) in present_nodes:
1964
 
                # Sometimes these are passed as a list rather than a tuple
1965
 
                node_refs = static_tuple.as_tuples(node_refs)
1966
 
                passed = static_tuple.as_tuples(keys[key])
1967
 
                if node_refs != passed[1]:
1968
 
                    details = '%s %s %s' % (key, (value, node_refs), passed)
 
1658
                if node_refs != keys[key][1]:
 
1659
                    details = '%s %s %s' % (key, (value, node_refs), keys[key])
1969
1660
                    if self._inconsistency_fatal:
1970
1661
                        raise errors.KnitCorrupt(self, "inconsistent details"
1971
1662
                                                 " in add_records: %s" %
1985
1676
                    result.append((key, value))
1986
1677
            records = result
1987
1678
        key_dependencies = self._key_dependencies
1988
 
        if key_dependencies is not None:
1989
 
            if self._parents:
1990
 
                for key, value, refs in records:
1991
 
                    parents = refs[0]
1992
 
                    key_dependencies.add_references(key, parents)
1993
 
            else:
1994
 
                for key, value, refs in records:
1995
 
                    new_keys.add_key(key)
 
1679
        if key_dependencies is not None and self._parents:
 
1680
            for key, value, refs in records:
 
1681
                parents = refs[0]
 
1682
                key_dependencies.add_references(key, parents)
1996
1683
        self._add_callback(records)
1997
1684
 
1998
1685
    def _check_read(self):
2029
1716
            if missing_keys:
2030
1717
                raise errors.RevisionNotPresent(missing_keys.pop(), self)
2031
1718
 
2032
 
    def find_ancestry(self, keys):
2033
 
        """See CombinedGraphIndex.find_ancestry"""
2034
 
        return self._graph_index.find_ancestry(keys, 0)
2035
 
 
2036
1719
    def get_parent_map(self, keys):
2037
1720
        """Get a map of the parents of keys.
2038
1721
 
2055
1738
        """Return the keys of missing parents."""
2056
1739
        # Copied from _KnitGraphIndex.get_missing_parents
2057
1740
        # We may have false positives, so filter those out.
2058
 
        self._key_dependencies.satisfy_refs_for_keys(
 
1741
        self._key_dependencies.add_keys(
2059
1742
            self.get_parent_map(self._key_dependencies.get_unsatisfied_refs()))
2060
1743
        return frozenset(self._key_dependencies.get_unsatisfied_refs())
2061
1744
 
2087
1770
                parents = None
2088
1771
            else:
2089
1772
                parents = entry[3][0]
2090
 
            details = _GCBuildDetails(parents, self._node_to_position(entry))
2091
 
            result[key] = details
 
1773
            method = 'group'
 
1774
            result[key] = (self._node_to_position(entry),
 
1775
                                  None, parents, (method, None))
2092
1776
        return result
2093
1777
 
2094
1778
    def keys(self):
2103
1787
        """Convert an index value to position details."""
2104
1788
        bits = node[2].split(' ')
2105
1789
        # It would be nice not to read the entire gzip.
2106
 
        # start and stop are put into _int_cache because they are very common.
2107
 
        # They define the 'group' that an entry is in, and many groups can have
2108
 
        # thousands of objects.
2109
 
        # Branching Launchpad, for example, saves ~600k integers, at 12 bytes
2110
 
        # each, or about 7MB. Note that it might be even more when you consider
2111
 
        # how PyInt is allocated in separate slabs. And you can't return a slab
2112
 
        # to the OS if even 1 int on it is in use. Note though that Python uses
2113
 
        # a LIFO when re-using PyInt slots, which might cause more
2114
 
        # fragmentation.
2115
1790
        start = int(bits[0])
2116
 
        start = self._int_cache.setdefault(start, start)
2117
1791
        stop = int(bits[1])
2118
 
        stop = self._int_cache.setdefault(stop, stop)
2119
1792
        basis_end = int(bits[2])
2120
1793
        delta_end = int(bits[3])
2121
 
        # We can't use StaticTuple here, because node[0] is a BTreeGraphIndex
2122
 
        # instance...
2123
 
        return (node[0], start, stop, basis_end, delta_end)
 
1794
        return node[0], start, stop, basis_end, delta_end
2124
1795
 
2125
1796
    def scan_unvalidated_index(self, graph_index):
2126
1797
        """Inform this _GCGraphIndex that there is an unvalidated index.
2127
1798
 
2128
1799
        This allows this _GCGraphIndex to keep track of any missing
2129
1800
        compression parents we may want to have filled in to make those
2130
 
        indices valid.  It also allows _GCGraphIndex to track any new keys.
 
1801
        indices valid.
2131
1802
 
2132
1803
        :param graph_index: A GraphIndex
2133
1804
        """
2134
 
        key_dependencies = self._key_dependencies
2135
 
        if key_dependencies is None:
2136
 
            return
2137
 
        for node in graph_index.iter_all_entries():
2138
 
            # Add parent refs from graph_index (and discard parent refs
2139
 
            # that the graph_index has).
2140
 
            key_dependencies.add_references(node[1], node[3][0])
 
1805
        if self._key_dependencies is not None:
 
1806
            # Add parent refs from graph_index (and discard parent refs that
 
1807
            # the graph_index has).
 
1808
            add_refs = self._key_dependencies.add_references
 
1809
            for node in graph_index.iter_all_entries():
 
1810
                add_refs(node[1], node[3][0])
 
1811
 
2141
1812
 
2142
1813
 
2143
1814
from bzrlib._groupcompress_py import (
2157
1828
        decode_base128_int,
2158
1829
        )
2159
1830
    GroupCompressor = PyrexGroupCompressor
2160
 
except ImportError, e:
2161
 
    osutils.failed_to_load_extension(e)
 
1831
except ImportError:
2162
1832
    GroupCompressor = PythonGroupCompressor
2163
1833