/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/bzr/pack_repo.py

  • Committer: Jelmer Vernooij
  • Date: 2019-01-13 17:32:22 UTC
  • mto: This revision was merged to the branch mainline in revision 7248.
  • Revision ID: jelmer@jelmer.uk-20190113173222-dteocq7209l6y0m6
Use tree timestamp when exporting.

This helps generate consistent hashes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import re
18
20
import sys
19
21
 
20
 
from bzrlib.lazy_import import lazy_import
 
22
from ..lazy_import import lazy_import
21
23
lazy_import(globals(), """
22
 
from itertools import izip
23
24
import time
24
25
 
25
 
from bzrlib import (
26
 
    chk_map,
 
26
from breezy import (
27
27
    cleanup,
 
28
    config,
28
29
    debug,
29
30
    graph,
30
31
    osutils,
31
 
    pack,
32
32
    transactions,
33
33
    ui,
34
 
    xml5,
35
 
    xml6,
36
 
    xml7,
37
 
    )
38
 
from bzrlib.index import (
 
34
    )
 
35
from breezy.bzr import (
 
36
    pack,
 
37
    )
 
38
from breezy.bzr.index import (
39
39
    CombinedGraphIndex,
40
 
    GraphIndexPrefixAdapter,
41
 
    )
42
 
from bzrlib.knit import (
43
 
    KnitPlainFactory,
44
 
    KnitVersionedFiles,
45
 
    _KnitGraphIndex,
46
 
    _DirectPackAccess,
47
 
    )
48
 
from bzrlib import tsort
 
40
    )
49
41
""")
50
 
from bzrlib import (
51
 
    bzrdir,
 
42
from .. import (
52
43
    errors,
53
44
    lockable_files,
54
45
    lockdir,
55
 
    revision as _mod_revision,
 
46
    )
 
47
from ..bzr import (
 
48
    btree_index,
56
49
    )
57
50
 
58
 
from bzrlib.decorators import needs_write_lock, only_raises
59
 
from bzrlib.btree_index import (
60
 
    BTreeGraphIndex,
61
 
    BTreeBuilder,
62
 
    )
63
 
from bzrlib.index import (
64
 
    GraphIndex,
65
 
    InMemoryGraphIndex,
66
 
    )
67
 
from bzrlib.repofmt.knitrepo import KnitRepository
68
 
from bzrlib.repository import (
69
 
    CommitBuilder,
70
 
    MetaDirRepositoryFormat,
71
 
    RepositoryFormat,
72
 
    RootCommitBuilder,
73
 
    StreamSource,
74
 
    )
75
 
from bzrlib.trace import (
 
51
from ..decorators import (
 
52
    only_raises,
 
53
    )
 
54
from ..lock import LogicalLockResult
 
55
from ..repository import (
 
56
    _LazyListJoin,
 
57
    RepositoryWriteLockResult,
 
58
    )
 
59
from ..bzr.repository import (
 
60
    MetaDirRepository,
 
61
    RepositoryFormatMetaDir,
 
62
    )
 
63
from ..sixish import (
 
64
    reraise,
 
65
    viewitems,
 
66
    )
 
67
from ..bzr.vf_repository import (
 
68
    MetaDirVersionedFileRepository,
 
69
    MetaDirVersionedFileRepositoryFormat,
 
70
    VersionedFileCommitBuilder,
 
71
    )
 
72
from ..trace import (
76
73
    mutter,
77
74
    note,
78
75
    warning,
79
76
    )
80
77
 
81
78
 
82
 
class PackCommitBuilder(CommitBuilder):
83
 
    """A subclass of CommitBuilder to add texts with pack semantics.
84
 
 
85
 
    Specifically this uses one knit object rather than one knit object per
86
 
    added text, reducing memory and object pressure.
87
 
    """
88
 
 
89
 
    def __init__(self, repository, parents, config, timestamp=None,
90
 
                 timezone=None, committer=None, revprops=None,
91
 
                 revision_id=None):
92
 
        CommitBuilder.__init__(self, repository, parents, config,
93
 
            timestamp=timestamp, timezone=timezone, committer=committer,
94
 
            revprops=revprops, revision_id=revision_id)
95
 
        self._file_graph = graph.Graph(
96
 
            repository._pack_collection.text_index.combined_index)
97
 
 
98
 
    def _heads(self, file_id, revision_ids):
99
 
        keys = [(file_id, revision_id) for revision_id in revision_ids]
100
 
        return set([key[1] for key in self._file_graph.heads(keys)])
101
 
 
102
 
 
103
 
class PackRootCommitBuilder(RootCommitBuilder):
104
 
    """A subclass of RootCommitBuilder to add texts with pack semantics.
105
 
 
106
 
    Specifically this uses one knit object rather than one knit object per
107
 
    added text, reducing memory and object pressure.
108
 
    """
109
 
 
110
 
    def __init__(self, repository, parents, config, timestamp=None,
111
 
                 timezone=None, committer=None, revprops=None,
112
 
                 revision_id=None):
113
 
        CommitBuilder.__init__(self, repository, parents, config,
114
 
            timestamp=timestamp, timezone=timezone, committer=committer,
115
 
            revprops=revprops, revision_id=revision_id)
116
 
        self._file_graph = graph.Graph(
117
 
            repository._pack_collection.text_index.combined_index)
118
 
 
119
 
    def _heads(self, file_id, revision_ids):
120
 
        keys = [(file_id, revision_id) for revision_id in revision_ids]
121
 
        return set([key[1] for key in self._file_graph.heads(keys)])
 
79
class PackCommitBuilder(VersionedFileCommitBuilder):
 
80
    """Subclass of VersionedFileCommitBuilder to add texts with pack semantics.
 
81
 
 
82
    Specifically this uses one knit object rather than one knit object per
 
83
    added text, reducing memory and object pressure.
 
84
    """
 
85
 
 
86
    def __init__(self, repository, parents, config, timestamp=None,
 
87
                 timezone=None, committer=None, revprops=None,
 
88
                 revision_id=None, lossy=False):
 
89
        VersionedFileCommitBuilder.__init__(self, repository, parents, config,
 
90
                                            timestamp=timestamp, timezone=timezone, committer=committer,
 
91
                                            revprops=revprops, revision_id=revision_id, lossy=lossy)
 
92
        self._file_graph = graph.Graph(
 
93
            repository._pack_collection.text_index.combined_index)
 
94
 
 
95
    def _heads(self, file_id, revision_ids):
 
96
        keys = [(file_id, revision_id) for revision_id in revision_ids]
 
97
        return {key[1] for key in self._file_graph.heads(keys)}
122
98
 
123
99
 
124
100
class Pack(object):
139
115
        }
140
116
 
141
117
    def __init__(self, revision_index, inventory_index, text_index,
142
 
        signature_index, chk_index=None):
 
118
                 signature_index, chk_index=None):
143
119
        """Create a pack instance.
144
120
 
145
121
        :param revision_index: A GraphIndex for determining what revisions are
175
151
        """
176
152
        missing_items = {}
177
153
        for (index_name, external_refs, index) in [
178
 
            ('texts',
179
 
                self._get_external_refs(self.text_index),
180
 
                self._pack_collection.text_index.combined_index),
181
 
            ('inventories',
182
 
                self._get_external_refs(self.inventory_index),
183
 
                self._pack_collection.inventory_index.combined_index),
184
 
            ]:
 
154
                ('texts',
 
155
                    self._get_external_refs(self.text_index),
 
156
                    self._pack_collection.text_index.combined_index),
 
157
                ('inventories',
 
158
                    self._get_external_refs(self.inventory_index),
 
159
                    self._pack_collection.inventory_index.combined_index),
 
160
                ]:
185
161
            missing = external_refs.difference(
186
162
                k for (idx, k, v, r) in
187
163
                index.iter_entries(external_refs))
229
205
        unlimited_cache = False
230
206
        if index_type == 'chk':
231
207
            unlimited_cache = True
232
 
        setattr(self, index_type + '_index',
233
 
            self.index_class(self.index_transport,
234
 
                self.index_name(index_type, self.name),
235
 
                self.index_sizes[self.index_offset(index_type)],
236
 
                unlimited_cache=unlimited_cache))
 
208
        index = self.index_class(self.index_transport,
 
209
                                 self.index_name(index_type, self.name),
 
210
                                 self.index_sizes[self.index_offset(
 
211
                                     index_type)],
 
212
                                 unlimited_cache=unlimited_cache)
 
213
        if index_type == 'chk':
 
214
            index._leaf_factory = btree_index._gcchk_factory
 
215
        setattr(self, index_type + '_index', index)
 
216
 
 
217
    def __lt__(self, other):
 
218
        if not isinstance(other, Pack):
 
219
            raise TypeError(other)
 
220
        return (id(self) < id(other))
 
221
 
 
222
    def __hash__(self):
 
223
        return hash((type(self), self.revision_index, self.inventory_index,
 
224
                     self.text_index, self.signature_index, self.chk_index))
237
225
 
238
226
 
239
227
class ExistingPack(Pack):
240
228
    """An in memory proxy for an existing .pack and its disk indices."""
241
229
 
242
230
    def __init__(self, pack_transport, name, revision_index, inventory_index,
243
 
        text_index, signature_index, chk_index=None):
 
231
                 text_index, signature_index, chk_index=None):
244
232
        """Create an ExistingPack object.
245
233
 
246
234
        :param pack_transport: The transport where the pack file resides.
247
235
        :param name: The name of the pack on disk in the pack_transport.
248
236
        """
249
237
        Pack.__init__(self, revision_index, inventory_index, text_index,
250
 
            signature_index, chk_index)
 
238
                      signature_index, chk_index)
251
239
        self.name = name
252
240
        self.pack_transport = pack_transport
253
241
        if None in (revision_index, inventory_index, text_index,
254
 
                signature_index, name, pack_transport):
 
242
                    signature_index, name, pack_transport):
255
243
            raise AssertionError()
256
244
 
257
245
    def __eq__(self, other):
265
253
            self.__class__.__module__, self.__class__.__name__, id(self),
266
254
            self.pack_transport, self.name)
267
255
 
 
256
    def __hash__(self):
 
257
        return hash((type(self), self.name))
 
258
 
268
259
 
269
260
class ResumedPack(ExistingPack):
270
261
 
271
262
    def __init__(self, name, revision_index, inventory_index, text_index,
272
 
        signature_index, upload_transport, pack_transport, index_transport,
273
 
        pack_collection, chk_index=None):
 
263
                 signature_index, upload_transport, pack_transport, index_transport,
 
264
                 pack_collection, chk_index=None):
274
265
        """Create a ResumedPack object."""
275
266
        ExistingPack.__init__(self, pack_transport, name, revision_index,
276
 
            inventory_index, text_index, signature_index,
277
 
            chk_index=chk_index)
 
267
                              inventory_index, text_index, signature_index,
 
268
                              chk_index=chk_index)
278
269
        self.upload_transport = upload_transport
279
270
        self.index_transport = index_transport
280
271
        self.index_sizes = [None, None, None, None]
306
297
    def abort(self):
307
298
        self.upload_transport.delete(self.file_name())
308
299
        indices = [self.revision_index, self.inventory_index, self.text_index,
309
 
            self.signature_index]
 
300
                   self.signature_index]
310
301
        if self.chk_index is not None:
311
302
            indices.append(self.chk_index)
312
303
        for index in indices:
320
311
        for index_type in index_types:
321
312
            old_name = self.index_name(index_type, self.name)
322
313
            new_name = '../indices/' + old_name
323
 
            self.upload_transport.rename(old_name, new_name)
 
314
            self.upload_transport.move(old_name, new_name)
324
315
            self._replace_index_with_readonly(index_type)
325
316
        new_name = '../packs/' + self.file_name()
326
 
        self.upload_transport.rename(self.file_name(), new_name)
 
317
        self.upload_transport.move(self.file_name(), new_name)
327
318
        self._state = 'finished'
328
319
 
329
320
    def _get_external_refs(self, index):
354
345
        else:
355
346
            chk_index = None
356
347
        Pack.__init__(self,
357
 
            # Revisions: parents list, no text compression.
358
 
            index_builder_class(reference_lists=1),
359
 
            # Inventory: We want to map compression only, but currently the
360
 
            # knit code hasn't been updated enough to understand that, so we
361
 
            # have a regular 2-list index giving parents and compression
362
 
            # source.
363
 
            index_builder_class(reference_lists=2),
364
 
            # Texts: compression and per file graph, for all fileids - so two
365
 
            # reference lists and two elements in the key tuple.
366
 
            index_builder_class(reference_lists=2, key_elements=2),
367
 
            # Signatures: Just blobs to store, no compression, no parents
368
 
            # listing.
369
 
            index_builder_class(reference_lists=0),
370
 
            # CHK based storage - just blobs, no compression or parents.
371
 
            chk_index=chk_index
372
 
            )
 
348
                      # Revisions: parents list, no text compression.
 
349
                      index_builder_class(reference_lists=1),
 
350
                      # Inventory: We want to map compression only, but currently the
 
351
                      # knit code hasn't been updated enough to understand that, so we
 
352
                      # have a regular 2-list index giving parents and compression
 
353
                      # source.
 
354
                      index_builder_class(reference_lists=2),
 
355
                      # Texts: compression and per file graph, for all fileids - so two
 
356
                      # reference lists and two elements in the key tuple.
 
357
                      index_builder_class(reference_lists=2, key_elements=2),
 
358
                      # Signatures: Just blobs to store, no compression, no parents
 
359
                      # listing.
 
360
                      index_builder_class(reference_lists=0),
 
361
                      # CHK based storage - just blobs, no compression or parents.
 
362
                      chk_index=chk_index
 
363
                      )
373
364
        self._pack_collection = pack_collection
374
365
        # When we make readonly indices, we need this.
375
366
        self.index_class = pack_collection._index_class
400
391
            self.random_name, mode=self._file_mode)
401
392
        if 'pack' in debug.debug_flags:
402
393
            mutter('%s: create_pack: pack stream open: %s%s t+%6.3fs',
403
 
                time.ctime(), self.upload_transport.base, self.random_name,
404
 
                time.time() - self.start_time)
 
394
                   time.ctime(), self.upload_transport.base, self.random_name,
 
395
                   time.time() - self.start_time)
405
396
        # A list of byte sequences to be written to the new pack, and the
406
397
        # aggregate size of them.  Stored as a list rather than separate
407
398
        # variables so that the _write_data closure below can update them.
411
402
        # robertc says- this is a closure rather than a method on the object
412
403
        # so that the variables are locals, and faster than accessing object
413
404
        # members.
 
405
 
414
406
        def _write_data(bytes, flush=False, _buffer=self._buffer,
415
 
            _write=self.write_stream.write, _update=self._hash.update):
 
407
                        _write=self.write_stream.write, _update=self._hash.update):
416
408
            _buffer[0].append(bytes)
417
409
            _buffer[1] += len(bytes)
418
410
            # buffer cap
419
411
            if _buffer[1] > self._cache_limit or flush:
420
 
                bytes = ''.join(_buffer[0])
 
412
                bytes = b''.join(_buffer[0])
421
413
                _write(bytes)
422
414
                _update(bytes)
423
415
                _buffer[:] = [[], 0]
451
443
    def data_inserted(self):
452
444
        """True if data has been added to this pack."""
453
445
        return bool(self.get_revision_count() or
454
 
            self.inventory_index.key_count() or
455
 
            self.text_index.key_count() or
456
 
            self.signature_index.key_count() or
457
 
            (self.chk_index is not None and self.chk_index.key_count()))
 
446
                    self.inventory_index.key_count() or
 
447
                    self.text_index.key_count() or
 
448
                    self.signature_index.key_count() or
 
449
                    (self.chk_index is not None and self.chk_index.key_count()))
458
450
 
459
451
    def finish_content(self):
460
452
        if self.name is not None:
461
453
            return
462
454
        self._writer.end()
463
455
        if self._buffer[1]:
464
 
            self._write_data('', flush=True)
 
456
            self._write_data(b'', flush=True)
465
457
        self.name = self._hash.hexdigest()
466
458
 
467
459
    def finish(self, suspend=False):
484
476
        # visible is smaller.  On the other hand none will be seen until
485
477
        # they're in the names list.
486
478
        self.index_sizes = [None, None, None, None]
487
 
        self._write_index('revision', self.revision_index, 'revision', suspend)
 
479
        self._write_index('revision', self.revision_index, 'revision',
 
480
                          suspend)
488
481
        self._write_index('inventory', self.inventory_index, 'inventory',
489
 
            suspend)
 
482
                          suspend)
490
483
        self._write_index('text', self.text_index, 'file texts', suspend)
491
484
        self._write_index('signature', self.signature_index,
492
 
            'revision signatures', suspend)
 
485
                          'revision signatures', suspend)
493
486
        if self.chk_index is not None:
494
487
            self.index_sizes.append(None)
495
488
            self._write_index('chk', self.chk_index,
496
 
                'content hash bytes', suspend)
497
 
        self.write_stream.close()
 
489
                              'content hash bytes', suspend)
 
490
        self.write_stream.close(
 
491
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
498
492
        # Note that this will clobber an existing pack with the same name,
499
493
        # without checking for hash collisions. While this is undesirable this
500
494
        # is something that can be rectified in a subsequent release. One way
509
503
        new_name = self.name + '.pack'
510
504
        if not suspend:
511
505
            new_name = '../packs/' + new_name
512
 
        self.upload_transport.rename(self.random_name, new_name)
 
506
        self.upload_transport.move(self.random_name, new_name)
513
507
        self._state = 'finished'
514
508
        if 'pack' in debug.debug_flags:
515
509
            # XXX: size might be interesting?
516
510
            mutter('%s: create_pack: pack finished: %s%s->%s t+%6.3fs',
517
 
                time.ctime(), self.upload_transport.base, self.random_name,
518
 
                new_name, time.time() - self.start_time)
 
511
                   time.ctime(), self.upload_transport.base, self.random_name,
 
512
                   new_name, time.time() - self.start_time)
519
513
 
520
514
    def flush(self):
521
515
        """Flush any current data."""
522
516
        if self._buffer[1]:
523
 
            bytes = ''.join(self._buffer[0])
 
517
            bytes = b''.join(self._buffer[0])
524
518
            self.write_stream.write(bytes)
525
519
            self._hash.update(bytes)
526
520
            self._buffer[:] = [[], 0]
543
537
            transport = self.upload_transport
544
538
        else:
545
539
            transport = self.index_transport
546
 
        self.index_sizes[self.index_offset(index_type)] = transport.put_file(
547
 
            index_name, index.finish(), mode=self._file_mode)
 
540
        index_tempfile = index.finish()
 
541
        index_bytes = index_tempfile.read()
 
542
        write_stream = transport.open_write_stream(index_name,
 
543
                                                   mode=self._file_mode)
 
544
        write_stream.write(index_bytes)
 
545
        write_stream.close(
 
546
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
 
547
        self.index_sizes[self.index_offset(index_type)] = len(index_bytes)
548
548
        if 'pack' in debug.debug_flags:
549
549
            # XXX: size might be interesting?
550
550
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
551
 
                time.ctime(), label, self.upload_transport.base,
552
 
                self.random_name, time.time() - self.start_time)
 
551
                   time.ctime(), label, self.upload_transport.base,
 
552
                   self.random_name, time.time() - self.start_time)
553
553
        # Replace the writable index on this object with a readonly,
554
554
        # presently unloaded index. We should alter
555
555
        # the index layer to make its finish() error if add_node is
612
612
        """
613
613
        if self.add_callback is not None:
614
614
            raise AssertionError(
615
 
                "%s already has a writable index through %s" % \
 
615
                "%s already has a writable index through %s" %
616
616
                (self, self.add_callback))
617
617
        # allow writing: queue writes to a new index
618
618
        self.add_index(index, pack)
638
638
        del self.combined_index._indices[pos]
639
639
        del self.combined_index._index_names[pos]
640
640
        if (self.add_callback is not None and
641
 
            getattr(index, 'add_nodes', None) == self.add_callback):
 
641
                getattr(index, 'add_nodes', None) == self.add_callback):
642
642
            self.add_callback = None
643
643
            self.data_access.set_writer(None, None, (None, None))
644
644
 
672
672
        # What text keys to copy. None for 'all texts'. This is set by
673
673
        # _copy_inventory_texts
674
674
        self._text_filter = None
675
 
        self._extra_init()
676
 
 
677
 
    def _extra_init(self):
678
 
        """A template hook to allow extending the constructor trivially."""
679
 
 
680
 
    def _pack_map_and_index_list(self, index_attribute):
681
 
        """Convert a list of packs to an index pack map and index list.
682
 
 
683
 
        :param index_attribute: The attribute that the desired index is found
684
 
            on.
685
 
        :return: A tuple (map, list) where map contains the dict from
686
 
            index:pack_tuple, and list contains the indices in the preferred
687
 
            access order.
688
 
        """
689
 
        indices = []
690
 
        pack_map = {}
691
 
        for pack_obj in self.packs:
692
 
            index = getattr(pack_obj, index_attribute)
693
 
            indices.append(index)
694
 
            pack_map[index] = pack_obj
695
 
        return pack_map, indices
696
 
 
697
 
    def _index_contents(self, indices, key_filter=None):
698
 
        """Get an iterable of the index contents from a pack_map.
699
 
 
700
 
        :param indices: The list of indices to query
701
 
        :param key_filter: An optional filter to limit the keys returned.
702
 
        """
703
 
        all_index = CombinedGraphIndex(indices)
704
 
        if key_filter is None:
705
 
            return all_index.iter_all_entries()
706
 
        else:
707
 
            return all_index.iter_entries(key_filter)
708
675
 
709
676
    def pack(self, pb=None):
710
677
        """Create a new pack by reading data from other packs.
721
688
        :return: A Pack object, or None if nothing was copied.
722
689
        """
723
690
        # open a pack - using the same name as the last temporary file
724
 
        # - which has already been flushed, so its safe.
 
691
        # - which has already been flushed, so it's safe.
725
692
        # XXX: - duplicate code warning with start_write_group; fix before
726
693
        #      considering 'done'.
727
694
        if self._pack_collection._new_pack is not None:
735
702
            else:
736
703
                self.revision_ids = frozenset(self.revision_ids)
737
704
                self.revision_keys = frozenset((revid,) for revid in
738
 
                    self.revision_ids)
 
705
                                               self.revision_ids)
739
706
        if pb is None:
740
707
            self.pb = ui.ui_factory.nested_progress_bar()
741
708
        else:
749
716
    def open_pack(self):
750
717
        """Open a pack for the pack we are creating."""
751
718
        new_pack = self._pack_collection.pack_factory(self._pack_collection,
752
 
                upload_suffix=self.suffix,
753
 
                file_mode=self._pack_collection.repo.bzrdir._get_file_mode())
 
719
                                                      upload_suffix=self.suffix,
 
720
                                                      file_mode=self._pack_collection.repo.controldir._get_file_mode())
754
721
        # We know that we will process all nodes in order, and don't need to
755
722
        # query, so don't combine any indices spilled to disk until we are done
756
723
        new_pack.revision_index.set_optimize(combine_backing_indices=False)
759
726
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
760
727
        return new_pack
761
728
 
762
 
    def _update_pack_order(self, entries, index_to_pack_map):
763
 
        """Determine how we want our packs to be ordered.
764
 
 
765
 
        This changes the sort order of the self.packs list so that packs unused
766
 
        by 'entries' will be at the end of the list, so that future requests
767
 
        can avoid probing them.  Used packs will be at the front of the
768
 
        self.packs list, in the order of their first use in 'entries'.
769
 
 
770
 
        :param entries: A list of (index, ...) tuples
771
 
        :param index_to_pack_map: A mapping from index objects to pack objects.
772
 
        """
773
 
        packs = []
774
 
        seen_indexes = set()
775
 
        for entry in entries:
776
 
            index = entry[0]
777
 
            if index not in seen_indexes:
778
 
                packs.append(index_to_pack_map[index])
779
 
                seen_indexes.add(index)
780
 
        if len(packs) == len(self.packs):
781
 
            if 'pack' in debug.debug_flags:
782
 
                mutter('Not changing pack list, all packs used.')
783
 
            return
784
 
        seen_packs = set(packs)
785
 
        for pack in self.packs:
786
 
            if pack not in seen_packs:
787
 
                packs.append(pack)
788
 
                seen_packs.add(pack)
789
 
        if 'pack' in debug.debug_flags:
790
 
            old_names = [p.access_tuple()[1] for p in self.packs]
791
 
            new_names = [p.access_tuple()[1] for p in packs]
792
 
            mutter('Reordering packs\nfrom: %s\n  to: %s',
793
 
                   old_names, new_names)
794
 
        self.packs = packs
795
 
 
796
729
    def _copy_revision_texts(self):
797
730
        """Copy revision data to the new pack."""
798
 
        # select revisions
799
 
        if self.revision_ids:
800
 
            revision_keys = [(revision_id,) for revision_id in self.revision_ids]
801
 
        else:
802
 
            revision_keys = None
803
 
        # select revision keys
804
 
        revision_index_map, revision_indices = self._pack_map_and_index_list(
805
 
            'revision_index')
806
 
        revision_nodes = self._index_contents(revision_indices, revision_keys)
807
 
        revision_nodes = list(revision_nodes)
808
 
        self._update_pack_order(revision_nodes, revision_index_map)
809
 
        # copy revision keys and adjust values
810
 
        self.pb.update("Copying revision texts", 1)
811
 
        total_items, readv_group_iter = self._revision_node_readv(revision_nodes)
812
 
        list(self._copy_nodes_graph(revision_index_map, self.new_pack._writer,
813
 
            self.new_pack.revision_index, readv_group_iter, total_items))
814
 
        if 'pack' in debug.debug_flags:
815
 
            mutter('%s: create_pack: revisions copied: %s%s %d items t+%6.3fs',
816
 
                time.ctime(), self._pack_collection._upload_transport.base,
817
 
                self.new_pack.random_name,
818
 
                self.new_pack.revision_index.key_count(),
819
 
                time.time() - self.new_pack.start_time)
820
 
        self._revision_keys = revision_keys
 
731
        raise NotImplementedError(self._copy_revision_texts)
821
732
 
822
733
    def _copy_inventory_texts(self):
823
734
        """Copy the inventory texts to the new pack.
826
737
 
827
738
        Sets self._text_filter appropriately.
828
739
        """
829
 
        # select inventory keys
830
 
        inv_keys = self._revision_keys # currently the same keyspace, and note that
831
 
        # querying for keys here could introduce a bug where an inventory item
832
 
        # is missed, so do not change it to query separately without cross
833
 
        # checking like the text key check below.
834
 
        inventory_index_map, inventory_indices = self._pack_map_and_index_list(
835
 
            'inventory_index')
836
 
        inv_nodes = self._index_contents(inventory_indices, inv_keys)
837
 
        # copy inventory keys and adjust values
838
 
        # XXX: Should be a helper function to allow different inv representation
839
 
        # at this point.
840
 
        self.pb.update("Copying inventory texts", 2)
841
 
        total_items, readv_group_iter = self._least_readv_node_readv(inv_nodes)
842
 
        # Only grab the output lines if we will be processing them
843
 
        output_lines = bool(self.revision_ids)
844
 
        inv_lines = self._copy_nodes_graph(inventory_index_map,
845
 
            self.new_pack._writer, self.new_pack.inventory_index,
846
 
            readv_group_iter, total_items, output_lines=output_lines)
847
 
        if self.revision_ids:
848
 
            self._process_inventory_lines(inv_lines)
849
 
        else:
850
 
            # eat the iterator to cause it to execute.
851
 
            list(inv_lines)
852
 
            self._text_filter = None
853
 
        if 'pack' in debug.debug_flags:
854
 
            mutter('%s: create_pack: inventories copied: %s%s %d items t+%6.3fs',
855
 
                time.ctime(), self._pack_collection._upload_transport.base,
856
 
                self.new_pack.random_name,
857
 
                self.new_pack.inventory_index.key_count(),
858
 
                time.time() - self.new_pack.start_time)
 
740
        raise NotImplementedError(self._copy_inventory_texts)
859
741
 
860
742
    def _copy_text_texts(self):
861
 
        # select text keys
862
 
        text_index_map, text_nodes = self._get_text_nodes()
863
 
        if self._text_filter is not None:
864
 
            # We could return the keys copied as part of the return value from
865
 
            # _copy_nodes_graph but this doesn't work all that well with the
866
 
            # need to get line output too, so we check separately, and as we're
867
 
            # going to buffer everything anyway, we check beforehand, which
868
 
            # saves reading knit data over the wire when we know there are
869
 
            # mising records.
870
 
            text_nodes = set(text_nodes)
871
 
            present_text_keys = set(_node[1] for _node in text_nodes)
872
 
            missing_text_keys = set(self._text_filter) - present_text_keys
873
 
            if missing_text_keys:
874
 
                # TODO: raise a specific error that can handle many missing
875
 
                # keys.
876
 
                mutter("missing keys during fetch: %r", missing_text_keys)
877
 
                a_missing_key = missing_text_keys.pop()
878
 
                raise errors.RevisionNotPresent(a_missing_key[1],
879
 
                    a_missing_key[0])
880
 
        # copy text keys and adjust values
881
 
        self.pb.update("Copying content texts", 3)
882
 
        total_items, readv_group_iter = self._least_readv_node_readv(text_nodes)
883
 
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
884
 
            self.new_pack.text_index, readv_group_iter, total_items))
885
 
        self._log_copied_texts()
 
743
        raise NotImplementedError(self._copy_text_texts)
886
744
 
887
745
    def _create_pack_from_packs(self):
888
 
        self.pb.update("Opening pack", 0, 5)
889
 
        self.new_pack = self.open_pack()
890
 
        new_pack = self.new_pack
891
 
        # buffer data - we won't be reading-back during the pack creation and
892
 
        # this makes a significant difference on sftp pushes.
893
 
        new_pack.set_write_cache_size(1024*1024)
894
 
        if 'pack' in debug.debug_flags:
895
 
            plain_pack_list = ['%s%s' % (a_pack.pack_transport.base, a_pack.name)
896
 
                for a_pack in self.packs]
897
 
            if self.revision_ids is not None:
898
 
                rev_count = len(self.revision_ids)
899
 
            else:
900
 
                rev_count = 'all'
901
 
            mutter('%s: create_pack: creating pack from source packs: '
902
 
                '%s%s %s revisions wanted %s t=0',
903
 
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
904
 
                plain_pack_list, rev_count)
905
 
        self._copy_revision_texts()
906
 
        self._copy_inventory_texts()
907
 
        self._copy_text_texts()
908
 
        # select signature keys
909
 
        signature_filter = self._revision_keys # same keyspace
910
 
        signature_index_map, signature_indices = self._pack_map_and_index_list(
911
 
            'signature_index')
912
 
        signature_nodes = self._index_contents(signature_indices,
913
 
            signature_filter)
914
 
        # copy signature keys and adjust values
915
 
        self.pb.update("Copying signature texts", 4)
916
 
        self._copy_nodes(signature_nodes, signature_index_map, new_pack._writer,
917
 
            new_pack.signature_index)
918
 
        if 'pack' in debug.debug_flags:
919
 
            mutter('%s: create_pack: revision signatures copied: %s%s %d items t+%6.3fs',
920
 
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
921
 
                new_pack.signature_index.key_count(),
922
 
                time.time() - new_pack.start_time)
923
 
        # copy chk contents
924
 
        # NB XXX: how to check CHK references are present? perhaps by yielding
925
 
        # the items? How should that interact with stacked repos?
926
 
        if new_pack.chk_index is not None:
927
 
            self._copy_chks()
928
 
            if 'pack' in debug.debug_flags:
929
 
                mutter('%s: create_pack: chk content copied: %s%s %d items t+%6.3fs',
930
 
                    time.ctime(), self._pack_collection._upload_transport.base,
931
 
                    new_pack.random_name,
932
 
                    new_pack.chk_index.key_count(),
933
 
                    time.time() - new_pack.start_time)
934
 
        new_pack._check_references()
935
 
        if not self._use_pack(new_pack):
936
 
            new_pack.abort()
937
 
            return None
938
 
        self.pb.update("Finishing pack", 5)
939
 
        new_pack.finish()
940
 
        self._pack_collection.allocate(new_pack)
941
 
        return new_pack
942
 
 
943
 
    def _copy_chks(self, refs=None):
944
 
        # XXX: Todo, recursive follow-pointers facility when fetching some
945
 
        # revisions only.
946
 
        chk_index_map, chk_indices = self._pack_map_and_index_list(
947
 
            'chk_index')
948
 
        chk_nodes = self._index_contents(chk_indices, refs)
949
 
        new_refs = set()
950
 
        # TODO: This isn't strictly tasteful as we are accessing some private
951
 
        #       variables (_serializer). Perhaps a better way would be to have
952
 
        #       Repository._deserialise_chk_node()
953
 
        search_key_func = chk_map.search_key_registry.get(
954
 
            self._pack_collection.repo._serializer.search_key_name)
955
 
        def accumlate_refs(lines):
956
 
            # XXX: move to a generic location
957
 
            # Yay mismatch:
958
 
            bytes = ''.join(lines)
959
 
            node = chk_map._deserialise(bytes, ("unknown",), search_key_func)
960
 
            new_refs.update(node.refs())
961
 
        self._copy_nodes(chk_nodes, chk_index_map, self.new_pack._writer,
962
 
            self.new_pack.chk_index, output_lines=accumlate_refs)
963
 
        return new_refs
964
 
 
965
 
    def _copy_nodes(self, nodes, index_map, writer, write_index,
966
 
        output_lines=None):
967
 
        """Copy knit nodes between packs with no graph references.
968
 
 
969
 
        :param output_lines: Output full texts of copied items.
970
 
        """
971
 
        pb = ui.ui_factory.nested_progress_bar()
972
 
        try:
973
 
            return self._do_copy_nodes(nodes, index_map, writer,
974
 
                write_index, pb, output_lines=output_lines)
975
 
        finally:
976
 
            pb.finished()
977
 
 
978
 
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb,
979
 
        output_lines=None):
980
 
        # for record verification
981
 
        knit = KnitVersionedFiles(None, None)
982
 
        # plan a readv on each source pack:
983
 
        # group by pack
984
 
        nodes = sorted(nodes)
985
 
        # how to map this into knit.py - or knit.py into this?
986
 
        # we don't want the typical knit logic, we want grouping by pack
987
 
        # at this point - perhaps a helper library for the following code
988
 
        # duplication points?
989
 
        request_groups = {}
990
 
        for index, key, value in nodes:
991
 
            if index not in request_groups:
992
 
                request_groups[index] = []
993
 
            request_groups[index].append((key, value))
994
 
        record_index = 0
995
 
        pb.update("Copied record", record_index, len(nodes))
996
 
        for index, items in request_groups.iteritems():
997
 
            pack_readv_requests = []
998
 
            for key, value in items:
999
 
                # ---- KnitGraphIndex.get_position
1000
 
                bits = value[1:].split(' ')
1001
 
                offset, length = int(bits[0]), int(bits[1])
1002
 
                pack_readv_requests.append((offset, length, (key, value[0])))
1003
 
            # linear scan up the pack
1004
 
            pack_readv_requests.sort()
1005
 
            # copy the data
1006
 
            pack_obj = index_map[index]
1007
 
            transport, path = pack_obj.access_tuple()
1008
 
            try:
1009
 
                reader = pack.make_readv_reader(transport, path,
1010
 
                    [offset[0:2] for offset in pack_readv_requests])
1011
 
            except errors.NoSuchFile:
1012
 
                if self._reload_func is not None:
1013
 
                    self._reload_func()
1014
 
                raise
1015
 
            for (names, read_func), (_1, _2, (key, eol_flag)) in \
1016
 
                izip(reader.iter_records(), pack_readv_requests):
1017
 
                raw_data = read_func(None)
1018
 
                # check the header only
1019
 
                if output_lines is not None:
1020
 
                    output_lines(knit._parse_record(key[-1], raw_data)[0])
1021
 
                else:
1022
 
                    df, _ = knit._parse_record_header(key, raw_data)
1023
 
                    df.close()
1024
 
                pos, size = writer.add_bytes_record(raw_data, names)
1025
 
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
1026
 
                pb.update("Copied record", record_index)
1027
 
                record_index += 1
1028
 
 
1029
 
    def _copy_nodes_graph(self, index_map, writer, write_index,
1030
 
        readv_group_iter, total_items, output_lines=False):
1031
 
        """Copy knit nodes between packs.
1032
 
 
1033
 
        :param output_lines: Return lines present in the copied data as
1034
 
            an iterator of line,version_id.
1035
 
        """
1036
 
        pb = ui.ui_factory.nested_progress_bar()
1037
 
        try:
1038
 
            for result in self._do_copy_nodes_graph(index_map, writer,
1039
 
                write_index, output_lines, pb, readv_group_iter, total_items):
1040
 
                yield result
1041
 
        except Exception:
1042
 
            # Python 2.4 does not permit try:finally: in a generator.
1043
 
            pb.finished()
1044
 
            raise
1045
 
        else:
1046
 
            pb.finished()
1047
 
 
1048
 
    def _do_copy_nodes_graph(self, index_map, writer, write_index,
1049
 
        output_lines, pb, readv_group_iter, total_items):
1050
 
        # for record verification
1051
 
        knit = KnitVersionedFiles(None, None)
1052
 
        # for line extraction when requested (inventories only)
1053
 
        if output_lines:
1054
 
            factory = KnitPlainFactory()
1055
 
        record_index = 0
1056
 
        pb.update("Copied record", record_index, total_items)
1057
 
        for index, readv_vector, node_vector in readv_group_iter:
1058
 
            # copy the data
1059
 
            pack_obj = index_map[index]
1060
 
            transport, path = pack_obj.access_tuple()
1061
 
            try:
1062
 
                reader = pack.make_readv_reader(transport, path, readv_vector)
1063
 
            except errors.NoSuchFile:
1064
 
                if self._reload_func is not None:
1065
 
                    self._reload_func()
1066
 
                raise
1067
 
            for (names, read_func), (key, eol_flag, references) in \
1068
 
                izip(reader.iter_records(), node_vector):
1069
 
                raw_data = read_func(None)
1070
 
                if output_lines:
1071
 
                    # read the entire thing
1072
 
                    content, _ = knit._parse_record(key[-1], raw_data)
1073
 
                    if len(references[-1]) == 0:
1074
 
                        line_iterator = factory.get_fulltext_content(content)
1075
 
                    else:
1076
 
                        line_iterator = factory.get_linedelta_content(content)
1077
 
                    for line in line_iterator:
1078
 
                        yield line, key
1079
 
                else:
1080
 
                    # check the header only
1081
 
                    df, _ = knit._parse_record_header(key, raw_data)
1082
 
                    df.close()
1083
 
                pos, size = writer.add_bytes_record(raw_data, names)
1084
 
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size), references)
1085
 
                pb.update("Copied record", record_index)
1086
 
                record_index += 1
1087
 
 
1088
 
    def _get_text_nodes(self):
1089
 
        text_index_map, text_indices = self._pack_map_and_index_list(
1090
 
            'text_index')
1091
 
        return text_index_map, self._index_contents(text_indices,
1092
 
            self._text_filter)
1093
 
 
1094
 
    def _least_readv_node_readv(self, nodes):
1095
 
        """Generate request groups for nodes using the least readv's.
1096
 
 
1097
 
        :param nodes: An iterable of graph index nodes.
1098
 
        :return: Total node count and an iterator of the data needed to perform
1099
 
            readvs to obtain the data for nodes. Each item yielded by the
1100
 
            iterator is a tuple with:
1101
 
            index, readv_vector, node_vector. readv_vector is a list ready to
1102
 
            hand to the transport readv method, and node_vector is a list of
1103
 
            (key, eol_flag, references) for the node retrieved by the
1104
 
            matching readv_vector.
1105
 
        """
1106
 
        # group by pack so we do one readv per pack
1107
 
        nodes = sorted(nodes)
1108
 
        total = len(nodes)
1109
 
        request_groups = {}
1110
 
        for index, key, value, references in nodes:
1111
 
            if index not in request_groups:
1112
 
                request_groups[index] = []
1113
 
            request_groups[index].append((key, value, references))
1114
 
        result = []
1115
 
        for index, items in request_groups.iteritems():
1116
 
            pack_readv_requests = []
1117
 
            for key, value, references in items:
1118
 
                # ---- KnitGraphIndex.get_position
1119
 
                bits = value[1:].split(' ')
1120
 
                offset, length = int(bits[0]), int(bits[1])
1121
 
                pack_readv_requests.append(
1122
 
                    ((offset, length), (key, value[0], references)))
1123
 
            # linear scan up the pack to maximum range combining.
1124
 
            pack_readv_requests.sort()
1125
 
            # split out the readv and the node data.
1126
 
            pack_readv = [readv for readv, node in pack_readv_requests]
1127
 
            node_vector = [node for readv, node in pack_readv_requests]
1128
 
            result.append((index, pack_readv, node_vector))
1129
 
        return total, result
 
746
        raise NotImplementedError(self._create_pack_from_packs)
1130
747
 
1131
748
    def _log_copied_texts(self):
1132
749
        if 'pack' in debug.debug_flags:
1133
750
            mutter('%s: create_pack: file texts copied: %s%s %d items t+%6.3fs',
1134
 
                time.ctime(), self._pack_collection._upload_transport.base,
1135
 
                self.new_pack.random_name,
1136
 
                self.new_pack.text_index.key_count(),
1137
 
                time.time() - self.new_pack.start_time)
1138
 
 
1139
 
    def _process_inventory_lines(self, inv_lines):
1140
 
        """Use up the inv_lines generator and setup a text key filter."""
1141
 
        repo = self._pack_collection.repo
1142
 
        fileid_revisions = repo._find_file_ids_from_xml_inventory_lines(
1143
 
            inv_lines, self.revision_keys)
1144
 
        text_filter = []
1145
 
        for fileid, file_revids in fileid_revisions.iteritems():
1146
 
            text_filter.extend([(fileid, file_revid) for file_revid in file_revids])
1147
 
        self._text_filter = text_filter
1148
 
 
1149
 
    def _revision_node_readv(self, revision_nodes):
1150
 
        """Return the total revisions and the readv's to issue.
1151
 
 
1152
 
        :param revision_nodes: The revision index contents for the packs being
1153
 
            incorporated into the new pack.
1154
 
        :return: As per _least_readv_node_readv.
1155
 
        """
1156
 
        return self._least_readv_node_readv(revision_nodes)
 
751
                   time.ctime(), self._pack_collection._upload_transport.base,
 
752
                   self.new_pack.random_name,
 
753
                   self.new_pack.text_index.key_count(),
 
754
                   time.time() - self.new_pack.start_time)
1157
755
 
1158
756
    def _use_pack(self, new_pack):
1159
757
        """Return True if new_pack should be used.
1164
762
        return new_pack.data_inserted()
1165
763
 
1166
764
 
1167
 
class OptimisingPacker(Packer):
1168
 
    """A packer which spends more time to create better disk layouts."""
1169
 
 
1170
 
    def _revision_node_readv(self, revision_nodes):
1171
 
        """Return the total revisions and the readv's to issue.
1172
 
 
1173
 
        This sort places revisions in topological order with the ancestors
1174
 
        after the children.
1175
 
 
1176
 
        :param revision_nodes: The revision index contents for the packs being
1177
 
            incorporated into the new pack.
1178
 
        :return: As per _least_readv_node_readv.
1179
 
        """
1180
 
        # build an ancestors dict
1181
 
        ancestors = {}
1182
 
        by_key = {}
1183
 
        for index, key, value, references in revision_nodes:
1184
 
            ancestors[key] = references[0]
1185
 
            by_key[key] = (index, value, references)
1186
 
        order = tsort.topo_sort(ancestors)
1187
 
        total = len(order)
1188
 
        # Single IO is pathological, but it will work as a starting point.
1189
 
        requests = []
1190
 
        for key in reversed(order):
1191
 
            index, value, references = by_key[key]
1192
 
            # ---- KnitGraphIndex.get_position
1193
 
            bits = value[1:].split(' ')
1194
 
            offset, length = int(bits[0]), int(bits[1])
1195
 
            requests.append(
1196
 
                (index, [(offset, length)], [(key, value[0], references)]))
1197
 
        # TODO: combine requests in the same index that are in ascending order.
1198
 
        return total, requests
1199
 
 
1200
 
    def open_pack(self):
1201
 
        """Open a pack for the pack we are creating."""
1202
 
        new_pack = super(OptimisingPacker, self).open_pack()
1203
 
        # Turn on the optimization flags for all the index builders.
1204
 
        new_pack.revision_index.set_optimize(for_size=True)
1205
 
        new_pack.inventory_index.set_optimize(for_size=True)
1206
 
        new_pack.text_index.set_optimize(for_size=True)
1207
 
        new_pack.signature_index.set_optimize(for_size=True)
1208
 
        return new_pack
1209
 
 
1210
 
 
1211
 
class ReconcilePacker(Packer):
1212
 
    """A packer which regenerates indices etc as it copies.
1213
 
 
1214
 
    This is used by ``bzr reconcile`` to cause parent text pointers to be
1215
 
    regenerated.
1216
 
    """
1217
 
 
1218
 
    def _extra_init(self):
1219
 
        self._data_changed = False
1220
 
 
1221
 
    def _process_inventory_lines(self, inv_lines):
1222
 
        """Generate a text key reference map rather for reconciling with."""
1223
 
        repo = self._pack_collection.repo
1224
 
        refs = repo._find_text_key_references_from_xml_inventory_lines(
1225
 
            inv_lines)
1226
 
        self._text_refs = refs
1227
 
        # during reconcile we:
1228
 
        #  - convert unreferenced texts to full texts
1229
 
        #  - correct texts which reference a text not copied to be full texts
1230
 
        #  - copy all others as-is but with corrected parents.
1231
 
        #  - so at this point we don't know enough to decide what becomes a full
1232
 
        #    text.
1233
 
        self._text_filter = None
1234
 
 
1235
 
    def _copy_text_texts(self):
1236
 
        """generate what texts we should have and then copy."""
1237
 
        self.pb.update("Copying content texts", 3)
1238
 
        # we have three major tasks here:
1239
 
        # 1) generate the ideal index
1240
 
        repo = self._pack_collection.repo
1241
 
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
1242
 
            _1, key, _2, refs in
1243
 
            self.new_pack.revision_index.iter_all_entries()])
1244
 
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
1245
 
        # 2) generate a text_nodes list that contains all the deltas that can
1246
 
        #    be used as-is, with corrected parents.
1247
 
        ok_nodes = []
1248
 
        bad_texts = []
1249
 
        discarded_nodes = []
1250
 
        NULL_REVISION = _mod_revision.NULL_REVISION
1251
 
        text_index_map, text_nodes = self._get_text_nodes()
1252
 
        for node in text_nodes:
1253
 
            # 0 - index
1254
 
            # 1 - key
1255
 
            # 2 - value
1256
 
            # 3 - refs
1257
 
            try:
1258
 
                ideal_parents = tuple(ideal_index[node[1]])
1259
 
            except KeyError:
1260
 
                discarded_nodes.append(node)
1261
 
                self._data_changed = True
1262
 
            else:
1263
 
                if ideal_parents == (NULL_REVISION,):
1264
 
                    ideal_parents = ()
1265
 
                if ideal_parents == node[3][0]:
1266
 
                    # no change needed.
1267
 
                    ok_nodes.append(node)
1268
 
                elif ideal_parents[0:1] == node[3][0][0:1]:
1269
 
                    # the left most parent is the same, or there are no parents
1270
 
                    # today. Either way, we can preserve the representation as
1271
 
                    # long as we change the refs to be inserted.
1272
 
                    self._data_changed = True
1273
 
                    ok_nodes.append((node[0], node[1], node[2],
1274
 
                        (ideal_parents, node[3][1])))
1275
 
                    self._data_changed = True
1276
 
                else:
1277
 
                    # Reinsert this text completely
1278
 
                    bad_texts.append((node[1], ideal_parents))
1279
 
                    self._data_changed = True
1280
 
        # we're finished with some data.
1281
 
        del ideal_index
1282
 
        del text_nodes
1283
 
        # 3) bulk copy the ok data
1284
 
        total_items, readv_group_iter = self._least_readv_node_readv(ok_nodes)
1285
 
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
1286
 
            self.new_pack.text_index, readv_group_iter, total_items))
1287
 
        # 4) adhoc copy all the other texts.
1288
 
        # We have to topologically insert all texts otherwise we can fail to
1289
 
        # reconcile when parts of a single delta chain are preserved intact,
1290
 
        # and other parts are not. E.g. Discarded->d1->d2->d3. d1 will be
1291
 
        # reinserted, and if d3 has incorrect parents it will also be
1292
 
        # reinserted. If we insert d3 first, d2 is present (as it was bulk
1293
 
        # copied), so we will try to delta, but d2 is not currently able to be
1294
 
        # extracted because it's basis d1 is not present. Topologically sorting
1295
 
        # addresses this. The following generates a sort for all the texts that
1296
 
        # are being inserted without having to reference the entire text key
1297
 
        # space (we only topo sort the revisions, which is smaller).
1298
 
        topo_order = tsort.topo_sort(ancestors)
1299
 
        rev_order = dict(zip(topo_order, range(len(topo_order))))
1300
 
        bad_texts.sort(key=lambda key:rev_order.get(key[0][1], 0))
1301
 
        transaction = repo.get_transaction()
1302
 
        file_id_index = GraphIndexPrefixAdapter(
1303
 
            self.new_pack.text_index,
1304
 
            ('blank', ), 1,
1305
 
            add_nodes_callback=self.new_pack.text_index.add_nodes)
1306
 
        data_access = _DirectPackAccess(
1307
 
                {self.new_pack.text_index:self.new_pack.access_tuple()})
1308
 
        data_access.set_writer(self.new_pack._writer, self.new_pack.text_index,
1309
 
            self.new_pack.access_tuple())
1310
 
        output_texts = KnitVersionedFiles(
1311
 
            _KnitGraphIndex(self.new_pack.text_index,
1312
 
                add_callback=self.new_pack.text_index.add_nodes,
1313
 
                deltas=True, parents=True, is_locked=repo.is_locked),
1314
 
            data_access=data_access, max_delta_chain=200)
1315
 
        for key, parent_keys in bad_texts:
1316
 
            # We refer to the new pack to delta data being output.
1317
 
            # A possible improvement would be to catch errors on short reads
1318
 
            # and only flush then.
1319
 
            self.new_pack.flush()
1320
 
            parents = []
1321
 
            for parent_key in parent_keys:
1322
 
                if parent_key[0] != key[0]:
1323
 
                    # Graph parents must match the fileid
1324
 
                    raise errors.BzrError('Mismatched key parent %r:%r' %
1325
 
                        (key, parent_keys))
1326
 
                parents.append(parent_key[1])
1327
 
            text_lines = osutils.split_lines(repo.texts.get_record_stream(
1328
 
                [key], 'unordered', True).next().get_bytes_as('fulltext'))
1329
 
            output_texts.add_lines(key, parent_keys, text_lines,
1330
 
                random_id=True, check_content=False)
1331
 
        # 5) check that nothing inserted has a reference outside the keyspace.
1332
 
        missing_text_keys = self.new_pack.text_index._external_references()
1333
 
        if missing_text_keys:
1334
 
            raise errors.BzrCheckError('Reference to missing compression parents %r'
1335
 
                % (missing_text_keys,))
1336
 
        self._log_copied_texts()
1337
 
 
1338
 
    def _use_pack(self, new_pack):
1339
 
        """Override _use_pack to check for reconcile having changed content."""
1340
 
        # XXX: we might be better checking this at the copy time.
1341
 
        original_inventory_keys = set()
1342
 
        inv_index = self._pack_collection.inventory_index.combined_index
1343
 
        for entry in inv_index.iter_all_entries():
1344
 
            original_inventory_keys.add(entry[1])
1345
 
        new_inventory_keys = set()
1346
 
        for entry in new_pack.inventory_index.iter_all_entries():
1347
 
            new_inventory_keys.add(entry[1])
1348
 
        if new_inventory_keys != original_inventory_keys:
1349
 
            self._data_changed = True
1350
 
        return new_pack.data_inserted() and self._data_changed
1351
 
 
1352
 
 
1353
765
class RepositoryPackCollection(object):
1354
766
    """Management of packs within a repository.
1355
767
 
1356
768
    :ivar _names: map of {pack_name: (index_size,)}
1357
769
    """
1358
770
 
1359
 
    pack_factory = NewPack
1360
 
    resumed_pack_factory = ResumedPack
 
771
    pack_factory = None
 
772
    resumed_pack_factory = None
 
773
    normal_packer_class = None
 
774
    optimising_packer_class = None
1361
775
 
1362
776
    def __init__(self, repo, transport, index_transport, upload_transport,
1363
777
                 pack_transport, index_builder_class, index_class,
1383
797
        self._index_builder_class = index_builder_class
1384
798
        self._index_class = index_class
1385
799
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3,
1386
 
            '.cix': 4}
 
800
                                '.cix': 4}
1387
801
        self.packs = []
1388
802
        # name:Pack mapping
1389
803
        self._names = None
1399
813
        self.text_index = AggregateIndex(self.reload_pack_names, flush)
1400
814
        self.signature_index = AggregateIndex(self.reload_pack_names, flush)
1401
815
        all_indices = [self.revision_index, self.inventory_index,
1402
 
                self.text_index, self.signature_index]
 
816
                       self.text_index, self.signature_index]
1403
817
        if use_chk_index:
1404
818
            self.chk_index = AggregateIndex(self.reload_pack_names, flush)
1405
819
            all_indices.append(self.chk_index)
1414
828
                set(all_combined).difference([combined_idx]))
1415
829
        # resumed packs
1416
830
        self._resumed_packs = []
 
831
        self.config_stack = config.LocationStack(self.transport.base)
1417
832
 
1418
833
    def __repr__(self):
1419
834
        return '%s(%r)' % (self.__class__.__name__, self.repo)
1501
916
        num_old_packs = sum([len(po[1]) for po in pack_operations])
1502
917
        num_revs_affected = sum([po[0] for po in pack_operations])
1503
918
        mutter('Auto-packing repository %s, which has %d pack files, '
1504
 
            'containing %d revisions. Packing %d files into %d affecting %d'
1505
 
            ' revisions', self, total_packs, total_revisions, num_old_packs,
1506
 
            num_new_packs, num_revs_affected)
1507
 
        result = self._execute_pack_operations(pack_operations,
1508
 
                                      reload_func=self._restart_autopack)
1509
 
        mutter('Auto-packing repository %s completed', self)
 
919
               'containing %d revisions. Packing %d files into %d affecting %d'
 
920
               ' revisions', str(
 
921
                   self), total_packs, total_revisions, num_old_packs,
 
922
               num_new_packs, num_revs_affected)
 
923
        result = self._execute_pack_operations(pack_operations, packer_class=self.normal_packer_class,
 
924
                                               reload_func=self._restart_autopack)
 
925
        mutter('Auto-packing repository %s completed', str(self))
1510
926
        return result
1511
927
 
1512
 
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
 
928
    def _execute_pack_operations(self, pack_operations, packer_class,
1513
929
                                 reload_func=None):
1514
930
        """Execute a series of pack operations.
1515
931
 
1516
932
        :param pack_operations: A list of [revision_count, packs_to_combine].
1517
 
        :param _packer_class: The class of packer to use (default: Packer).
 
933
        :param packer_class: The class of packer to use
1518
934
        :return: The new pack names.
1519
935
        """
1520
936
        for revision_count, packs in pack_operations:
1521
937
            # we may have no-ops from the setup logic
1522
938
            if len(packs) == 0:
1523
939
                continue
1524
 
            packer = _packer_class(self, packs, '.autopack',
1525
 
                                   reload_func=reload_func)
 
940
            packer = packer_class(self, packs, '.autopack',
 
941
                                  reload_func=reload_func)
1526
942
            try:
1527
 
                packer.pack()
 
943
                result = packer.pack()
1528
944
            except errors.RetryWithNewPacks:
1529
945
                # An exception is propagating out of this context, make sure
1530
946
                # this packer has cleaned up. Packer() doesn't set its new_pack
1533
949
                if packer.new_pack is not None:
1534
950
                    packer.new_pack.abort()
1535
951
                raise
 
952
            if result is None:
 
953
                return
1536
954
            for pack in packs:
1537
955
                self._remove_pack_from_memory(pack)
1538
956
        # record the newly available packs and stop advertising the old
1570
988
        # XXX: the following may want to be a class, to pack with a given
1571
989
        # policy.
1572
990
        mutter('Packing repository %s, which has %d pack files, '
1573
 
            'containing %d revisions with hint %r.', self, total_packs,
1574
 
            total_revisions, hint)
 
991
               'containing %d revisions with hint %r.', str(self), total_packs,
 
992
               total_revisions, hint)
 
993
        while True:
 
994
            try:
 
995
                self._try_pack_operations(hint)
 
996
            except RetryPackOperations:
 
997
                continue
 
998
            break
 
999
 
 
1000
        if clean_obsolete_packs:
 
1001
            self._clear_obsolete_packs()
 
1002
 
 
1003
    def _try_pack_operations(self, hint):
 
1004
        """Calculate the pack operations based on the hint (if any), and
 
1005
        execute them.
 
1006
        """
1575
1007
        # determine which packs need changing
1576
1008
        pack_operations = [[0, []]]
1577
1009
        for pack in self.all_packs():
1580
1012
                # or this pack was included in the hint.
1581
1013
                pack_operations[-1][0] += pack.get_revision_count()
1582
1014
                pack_operations[-1][1].append(pack)
1583
 
        self._execute_pack_operations(pack_operations, OptimisingPacker)
1584
 
 
1585
 
        if clean_obsolete_packs:
1586
 
            self._clear_obsolete_packs()
 
1015
        self._execute_pack_operations(pack_operations,
 
1016
                                      packer_class=self.optimising_packer_class,
 
1017
                                      reload_func=self._restart_pack_operations)
1587
1018
 
1588
1019
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1589
1020
        """Plan a pack operation.
1599
1030
        pack_operations = [[0, []]]
1600
1031
        # plan out what packs to keep, and what to reorganise
1601
1032
        while len(existing_packs):
1602
 
            # take the largest pack, and if its less than the head of the
 
1033
            # take the largest pack, and if it's less than the head of the
1603
1034
            # distribution chart we will include its contents in the new pack
1604
 
            # for that position. If its larger, we remove its size from the
 
1035
            # for that position. If it's larger, we remove its size from the
1605
1036
            # distribution chart
1606
1037
            next_pack_rev_count, next_pack = existing_packs.pop(0)
1607
1038
            if next_pack_rev_count >= pack_distribution[0]:
1633
1064
            final_pack_list.extend(pack_files)
1634
1065
        if len(final_pack_list) == 1:
1635
1066
            raise AssertionError('We somehow generated an autopack with a'
1636
 
                ' single pack file being moved.')
 
1067
                                 ' single pack file being moved.')
1637
1068
            return []
1638
1069
        return [[final_rev_count, final_pack_list]]
1639
1070
 
1642
1073
 
1643
1074
        :return: True if the disk names had not been previously read.
1644
1075
        """
1645
 
        # NB: if you see an assertion error here, its probably access against
 
1076
        # NB: if you see an assertion error here, it's probably access against
1646
1077
        # an unlocked repo. Naughty.
1647
1078
        if not self.repo.is_locked():
1648
1079
            raise errors.ObjectNotLocked(self.repo)
1650
1081
            self._names = {}
1651
1082
            self._packs_at_load = set()
1652
1083
            for index, key, value in self._iter_disk_pack_index():
1653
 
                name = key[0]
 
1084
                name = key[0].decode('ascii')
1654
1085
                self._names[name] = self._parse_index_sizes(value)
1655
 
                self._packs_at_load.add((key, value))
 
1086
                self._packs_at_load.add((name, value))
1656
1087
            result = True
1657
1088
        else:
1658
1089
            result = False
1662
1093
 
1663
1094
    def _parse_index_sizes(self, value):
1664
1095
        """Parse a string of index sizes."""
1665
 
        return tuple([int(digits) for digits in value.split(' ')])
 
1096
        return tuple(int(digits) for digits in value.split(b' '))
1666
1097
 
1667
1098
    def get_pack_by_name(self, name):
1668
1099
        """Get a Pack object by name.
1678
1109
            txt_index = self._make_index(name, '.tix')
1679
1110
            sig_index = self._make_index(name, '.six')
1680
1111
            if self.chk_index is not None:
1681
 
                chk_index = self._make_index(name, '.cix', unlimited_cache=True)
 
1112
                chk_index = self._make_index(name, '.cix', is_chk=True)
1682
1113
            else:
1683
1114
                chk_index = None
1684
1115
            result = ExistingPack(self._pack_transport, name, rev_index,
1685
 
                inv_index, txt_index, sig_index, chk_index)
 
1116
                                  inv_index, txt_index, sig_index, chk_index)
1686
1117
            self.add_pack_to_memory(result)
1687
1118
            return result
1688
1119
 
1704
1135
            sig_index = self._make_index(name, '.six', resume=True)
1705
1136
            if self.chk_index is not None:
1706
1137
                chk_index = self._make_index(name, '.cix', resume=True,
1707
 
                                             unlimited_cache=True)
 
1138
                                             is_chk=True)
1708
1139
            else:
1709
1140
                chk_index = None
1710
1141
            result = self.resumed_pack_factory(name, rev_index, inv_index,
1711
 
                txt_index, sig_index, self._upload_transport,
1712
 
                self._pack_transport, self._index_transport, self,
1713
 
                chk_index=chk_index)
1714
 
        except errors.NoSuchFile, e:
 
1142
                                               txt_index, sig_index, self._upload_transport,
 
1143
                                               self._pack_transport, self._index_transport, self,
 
1144
                                               chk_index=chk_index)
 
1145
        except errors.NoSuchFile as e:
1715
1146
            raise errors.UnresumableWriteGroup(self.repo, [name], str(e))
1716
1147
        self.add_pack_to_memory(result)
1717
1148
        self._resumed_packs.append(result)
1738
1169
        :return: An iterator of the index contents.
1739
1170
        """
1740
1171
        return self._index_class(self.transport, 'pack-names', None
1741
 
                ).iter_all_entries()
 
1172
                                 ).iter_all_entries()
1742
1173
 
1743
 
    def _make_index(self, name, suffix, resume=False, unlimited_cache=False):
 
1174
    def _make_index(self, name, suffix, resume=False, is_chk=False):
1744
1175
        size_offset = self._suffix_offsets[suffix]
1745
1176
        index_name = name + suffix
1746
1177
        if resume:
1749
1180
        else:
1750
1181
            transport = self._index_transport
1751
1182
            index_size = self._names[name][size_offset]
1752
 
        return self._index_class(transport, index_name, index_size,
1753
 
                                 unlimited_cache=unlimited_cache)
 
1183
        index = self._index_class(transport, index_name, index_size,
 
1184
                                  unlimited_cache=is_chk)
 
1185
        if is_chk and self._index_class is btree_index.BTreeGraphIndex:
 
1186
            index._leaf_factory = btree_index._gcchk_factory
 
1187
        return index
1754
1188
 
1755
1189
    def _max_pack_count(self, total_revisions):
1756
1190
        """Return the maximum number of packs to use for total revisions.
1785
1219
        """
1786
1220
        for pack in packs:
1787
1221
            try:
1788
 
                pack.pack_transport.rename(pack.file_name(),
1789
 
                    '../obsolete_packs/' + pack.file_name())
1790
 
            except (errors.PathError, errors.TransportError), e:
 
1222
                try:
 
1223
                    pack.pack_transport.move(pack.file_name(),
 
1224
                                             '../obsolete_packs/' + pack.file_name())
 
1225
                except errors.NoSuchFile:
 
1226
                    # perhaps obsolete_packs was removed? Let's create it and
 
1227
                    # try again
 
1228
                    try:
 
1229
                        pack.pack_transport.mkdir('../obsolete_packs/')
 
1230
                    except errors.FileExists:
 
1231
                        pass
 
1232
                    pack.pack_transport.move(pack.file_name(),
 
1233
                                             '../obsolete_packs/' + pack.file_name())
 
1234
            except (errors.PathError, errors.TransportError) as e:
1791
1235
                # TODO: Should these be warnings or mutters?
1792
1236
                mutter("couldn't rename obsolete pack, skipping it:\n%s"
1793
1237
                       % (e,))
1799
1243
                suffixes.append('.cix')
1800
1244
            for suffix in suffixes:
1801
1245
                try:
1802
 
                    self._index_transport.rename(pack.name + suffix,
1803
 
                        '../obsolete_packs/' + pack.name + suffix)
1804
 
                except (errors.PathError, errors.TransportError), e:
 
1246
                    self._index_transport.move(pack.name + suffix,
 
1247
                                               '../obsolete_packs/' + pack.name + suffix)
 
1248
                except (errors.PathError, errors.TransportError) as e:
1805
1249
                    mutter("couldn't rename obsolete index, skipping it:\n%s"
1806
1250
                           % (e,))
1807
1251
 
1837
1281
 
1838
1282
    def _remove_pack_indices(self, pack, ignore_missing=False):
1839
1283
        """Remove the indices for pack from the aggregated indices.
1840
 
        
 
1284
 
1841
1285
        :param ignore_missing: Suppress KeyErrors from calling remove_index.
1842
1286
        """
1843
 
        for index_type in Pack.index_definitions.keys():
 
1287
        for index_type in Pack.index_definitions:
1844
1288
            attr_name = index_type + '_index'
1845
1289
            aggregate_index = getattr(self, attr_name)
1846
1290
            if aggregate_index is not None:
1888
1332
        # load the disk nodes across
1889
1333
        disk_nodes = set()
1890
1334
        for index, key, value in self._iter_disk_pack_index():
1891
 
            disk_nodes.add((key, value))
 
1335
            disk_nodes.add((key[0].decode('ascii'), value))
1892
1336
        orig_disk_nodes = set(disk_nodes)
1893
1337
 
1894
1338
        # do a two-way diff against our original content
1895
1339
        current_nodes = set()
1896
 
        for name, sizes in self._names.iteritems():
 
1340
        for name, sizes in viewitems(self._names):
1897
1341
            current_nodes.add(
1898
 
                ((name, ), ' '.join(str(size) for size in sizes)))
 
1342
                (name, b' '.join(b'%d' % size for size in sizes)))
1899
1343
 
1900
1344
        # Packs no longer present in the repository, which were present when we
1901
1345
        # locked the repository
1925
1369
        new_names = dict(disk_nodes)
1926
1370
        # drop no longer present nodes
1927
1371
        for pack in self.all_packs():
1928
 
            if (pack.name,) not in new_names:
 
1372
            if pack.name not in new_names:
1929
1373
                removed.append(pack.name)
1930
1374
                self._remove_pack_from_memory(pack)
1931
1375
        # add new nodes/refresh existing ones
1932
 
        for key, value in disk_nodes:
1933
 
            name = key[0]
 
1376
        for name, value in disk_nodes:
1934
1377
            sizes = self._parse_index_sizes(value)
1935
1378
            if name in self._names:
1936
1379
                # existing
1942
1385
                    # disk index because the set values are the same, unless
1943
1386
                    # the only index shows up as deleted by the set difference
1944
1387
                    # - which it may. Until there is a specific test for this,
1945
 
                    # assume its broken. RBC 20071017.
 
1388
                    # assume it's broken. RBC 20071017.
1946
1389
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
1947
1390
                    self._names[name] = sizes
1948
1391
                    self.get_pack_by_name(name)
1977
1420
            # TODO: handle same-name, index-size-changes here -
1978
1421
            # e.g. use the value from disk, not ours, *unless* we're the one
1979
1422
            # changing it.
1980
 
            for key, value in disk_nodes:
1981
 
                builder.add_node(key, value)
 
1423
            for name, value in disk_nodes:
 
1424
                builder.add_node((name.encode('ascii'), ), value)
1982
1425
            self.transport.put_file('pack-names', builder.finish(),
1983
 
                mode=self.repo.bzrdir._get_file_mode())
 
1426
                                    mode=self.repo.controldir._get_file_mode())
1984
1427
            self._packs_at_load = disk_nodes
1985
1428
            if clear_obsolete_packs:
1986
1429
                to_preserve = None
1987
1430
                if obsolete_packs:
1988
 
                    to_preserve = set([o.name for o in obsolete_packs])
 
1431
                    to_preserve = {o.name for o in obsolete_packs}
1989
1432
                already_obsolete = self._clear_obsolete_packs(to_preserve)
1990
1433
        finally:
1991
1434
            self._unlock_names()
2000
1443
            obsolete_packs = [o for o in obsolete_packs
2001
1444
                              if o.name not in already_obsolete]
2002
1445
            self._obsolete_packs(obsolete_packs)
2003
 
        return [new_node[0][0] for new_node in new_nodes]
 
1446
        return [new_node[0] for new_node in new_nodes]
2004
1447
 
2005
1448
    def reload_pack_names(self):
2006
1449
        """Sync our pack listing with what is present in the repository.
2012
1455
        :return: True if the in-memory list of packs has been altered at all.
2013
1456
        """
2014
1457
        # The ensure_loaded call is to handle the case where the first call
2015
 
        # made involving the collection was to reload_pack_names, where we 
2016
 
        # don't have a view of disk contents. Its a bit of a bandaid, and
2017
 
        # causes two reads of pack-names, but its a rare corner case not struck
2018
 
        # with regular push/pull etc.
 
1458
        # made involving the collection was to reload_pack_names, where we
 
1459
        # don't have a view of disk contents. It's a bit of a bandaid, and
 
1460
        # causes two reads of pack-names, but it's a rare corner case not
 
1461
        # struck with regular push/pull etc.
2019
1462
        first_read = self.ensure_loaded()
2020
1463
        if first_read:
2021
1464
            return True
2040
1483
            raise
2041
1484
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
2042
1485
 
 
1486
    def _restart_pack_operations(self):
 
1487
        """Reload the pack names list, and restart the autopack code."""
 
1488
        if not self.reload_pack_names():
 
1489
            # Re-raise the original exception, because something went missing
 
1490
            # and a restart didn't find it
 
1491
            raise
 
1492
        raise RetryPackOperations(self.repo, False, sys.exc_info())
 
1493
 
2043
1494
    def _clear_obsolete_packs(self, preserve=None):
2044
1495
        """Delete everything from the obsolete-packs directory.
2045
1496
 
2050
1501
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
2051
1502
        if preserve is None:
2052
1503
            preserve = set()
2053
 
        for filename in obsolete_pack_transport.list_dir('.'):
 
1504
        try:
 
1505
            obsolete_pack_files = obsolete_pack_transport.list_dir('.')
 
1506
        except errors.NoSuchFile:
 
1507
            return found
 
1508
        for filename in obsolete_pack_files:
2054
1509
            name, ext = osutils.splitext(filename)
2055
1510
            if ext == '.pack':
2056
1511
                found.append(name)
2058
1513
                continue
2059
1514
            try:
2060
1515
                obsolete_pack_transport.delete(filename)
2061
 
            except (errors.PathError, errors.TransportError), e:
 
1516
            except (errors.PathError, errors.TransportError) as e:
2062
1517
                warning("couldn't delete obsolete pack, skipping it:\n%s"
2063
1518
                        % (e,))
2064
1519
        return found
2068
1523
        if not self.repo.is_write_locked():
2069
1524
            raise errors.NotWriteLocked(self)
2070
1525
        self._new_pack = self.pack_factory(self, upload_suffix='.pack',
2071
 
            file_mode=self.repo.bzrdir._get_file_mode())
 
1526
                                           file_mode=self.repo.controldir._get_file_mode())
2072
1527
        # allow writing: queue writes to a new index
2073
1528
        self.revision_index.add_writable_index(self._new_pack.revision_index,
2074
 
            self._new_pack)
 
1529
                                               self._new_pack)
2075
1530
        self.inventory_index.add_writable_index(self._new_pack.inventory_index,
2076
 
            self._new_pack)
 
1531
                                                self._new_pack)
2077
1532
        self.text_index.add_writable_index(self._new_pack.text_index,
2078
 
            self._new_pack)
 
1533
                                           self._new_pack)
2079
1534
        self._new_pack.text_index.set_optimize(combine_backing_indices=False)
2080
1535
        self.signature_index.add_writable_index(self._new_pack.signature_index,
2081
 
            self._new_pack)
 
1536
                                                self._new_pack)
2082
1537
        if self.chk_index is not None:
2083
1538
            self.chk_index.add_writable_index(self._new_pack.chk_index,
2084
 
                self._new_pack)
 
1539
                                              self._new_pack)
2085
1540
            self.repo.chk_bytes._index._add_callback = self.chk_index.add_callback
2086
 
            self._new_pack.chk_index.set_optimize(combine_backing_indices=False)
 
1541
            self._new_pack.chk_index.set_optimize(
 
1542
                combine_backing_indices=False)
2087
1543
 
2088
1544
        self.repo.inventories._index._add_callback = self.inventory_index.add_callback
2089
1545
        self.repo.revisions._index._add_callback = self.revision_index.add_callback
2101
1557
            # already gone.  But they're not there we shouldn't fail in this
2102
1558
            # case, so we pass ignore_missing=True.
2103
1559
            operation.add_cleanup(self._remove_pack_indices, self._new_pack,
2104
 
                ignore_missing=True)
 
1560
                                  ignore_missing=True)
2105
1561
            operation.run_simple()
2106
1562
        for resumed_pack in self._resumed_packs:
2107
1563
            operation = cleanup.OperationWithCleanups(resumed_pack.abort)
2108
1564
            # See comment in previous finally block.
2109
1565
            operation.add_cleanup(self._remove_pack_indices, resumed_pack,
2110
 
                ignore_missing=True)
 
1566
                                  ignore_missing=True)
2111
1567
            operation.run_simple()
2112
1568
        del self._resumed_packs[:]
2113
1569
 
2125
1581
        # The base implementation does no checks.  GCRepositoryPackCollection
2126
1582
        # overrides this.
2127
1583
        return []
2128
 
        
 
1584
 
2129
1585
    def _commit_write_group(self):
2130
1586
        all_missing = set()
2131
1587
        for prefix, versioned_file in (
2139
1595
        if all_missing:
2140
1596
            raise errors.BzrCheckError(
2141
1597
                "Repository %s has missing compression parent(s) %r "
2142
 
                 % (self.repo, sorted(all_missing)))
 
1598
                % (self.repo, sorted(all_missing)))
2143
1599
        problems = self._check_new_inventories()
2144
1600
        if problems:
2145
1601
            problems_summary = '\n'.join(problems)
2193
1649
            self._resume_pack(token)
2194
1650
 
2195
1651
 
2196
 
class KnitPackRepository(KnitRepository):
 
1652
class PackRepository(MetaDirVersionedFileRepository):
2197
1653
    """Repository with knit objects stored inside pack containers.
2198
1654
 
2199
1655
    The layering for a KnitPackRepository is:
2202
1658
    ===================================================
2203
1659
    Tuple based apis below, string based, and key based apis above
2204
1660
    ---------------------------------------------------
2205
 
    KnitVersionedFiles
 
1661
    VersionedFiles
2206
1662
      Provides .texts, .revisions etc
2207
1663
      This adapts the N-tuple keys to physical knit records which only have a
2208
1664
      single string identifier (for historical reasons), which in older formats
2218
1674
 
2219
1675
    """
2220
1676
 
2221
 
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
2222
 
        _serializer):
2223
 
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
2224
 
            _commit_builder_class, _serializer)
2225
 
        index_transport = self._transport.clone('indices')
2226
 
        self._pack_collection = RepositoryPackCollection(self, self._transport,
2227
 
            index_transport,
2228
 
            self._transport.clone('upload'),
2229
 
            self._transport.clone('packs'),
2230
 
            _format.index_builder_class,
2231
 
            _format.index_class,
2232
 
            use_chk_index=self._format.supports_chks,
2233
 
            )
2234
 
        self.inventories = KnitVersionedFiles(
2235
 
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
2236
 
                add_callback=self._pack_collection.inventory_index.add_callback,
2237
 
                deltas=True, parents=True, is_locked=self.is_locked),
2238
 
            data_access=self._pack_collection.inventory_index.data_access,
2239
 
            max_delta_chain=200)
2240
 
        self.revisions = KnitVersionedFiles(
2241
 
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
2242
 
                add_callback=self._pack_collection.revision_index.add_callback,
2243
 
                deltas=False, parents=True, is_locked=self.is_locked,
2244
 
                track_external_parent_refs=True),
2245
 
            data_access=self._pack_collection.revision_index.data_access,
2246
 
            max_delta_chain=0)
2247
 
        self.signatures = KnitVersionedFiles(
2248
 
            _KnitGraphIndex(self._pack_collection.signature_index.combined_index,
2249
 
                add_callback=self._pack_collection.signature_index.add_callback,
2250
 
                deltas=False, parents=False, is_locked=self.is_locked),
2251
 
            data_access=self._pack_collection.signature_index.data_access,
2252
 
            max_delta_chain=0)
2253
 
        self.texts = KnitVersionedFiles(
2254
 
            _KnitGraphIndex(self._pack_collection.text_index.combined_index,
2255
 
                add_callback=self._pack_collection.text_index.add_callback,
2256
 
                deltas=True, parents=True, is_locked=self.is_locked),
2257
 
            data_access=self._pack_collection.text_index.data_access,
2258
 
            max_delta_chain=200)
2259
 
        if _format.supports_chks:
2260
 
            # No graph, no compression:- references from chks are between
2261
 
            # different objects not temporal versions of the same; and without
2262
 
            # some sort of temporal structure knit compression will just fail.
2263
 
            self.chk_bytes = KnitVersionedFiles(
2264
 
                _KnitGraphIndex(self._pack_collection.chk_index.combined_index,
2265
 
                    add_callback=self._pack_collection.chk_index.add_callback,
2266
 
                    deltas=False, parents=False, is_locked=self.is_locked),
2267
 
                data_access=self._pack_collection.chk_index.data_access,
2268
 
                max_delta_chain=0)
2269
 
        else:
2270
 
            self.chk_bytes = None
2271
 
        # True when the repository object is 'write locked' (as opposed to the
2272
 
        # physical lock only taken out around changes to the pack-names list.)
2273
 
        # Another way to represent this would be a decorator around the control
2274
 
        # files object that presents logical locks as physical ones - if this
2275
 
        # gets ugly consider that alternative design. RBC 20071011
2276
 
        self._write_lock_count = 0
2277
 
        self._transaction = None
2278
 
        # for tests
2279
 
        self._reconcile_does_inventory_gc = True
 
1677
    # These attributes are inherited from the Repository base class. Setting
 
1678
    # them to None ensures that if the constructor is changed to not initialize
 
1679
    # them, or a subclass fails to call the constructor, that an error will
 
1680
    # occur rather than the system working but generating incorrect data.
 
1681
    _commit_builder_class = None
 
1682
    _serializer = None
 
1683
 
 
1684
    def __init__(self, _format, a_controldir, control_files, _commit_builder_class,
 
1685
                 _serializer):
 
1686
        MetaDirRepository.__init__(self, _format, a_controldir, control_files)
 
1687
        self._commit_builder_class = _commit_builder_class
 
1688
        self._serializer = _serializer
2280
1689
        self._reconcile_fixes_text_parents = True
2281
 
        self._reconcile_backsup_inventory = False
 
1690
        if self._format.supports_external_lookups:
 
1691
            self._unstacked_provider = graph.CachingParentsProvider(
 
1692
                self._make_parents_provider_unstacked())
 
1693
        else:
 
1694
            self._unstacked_provider = graph.CachingParentsProvider(self)
 
1695
        self._unstacked_provider.disable_cache()
2282
1696
 
2283
 
    def _warn_if_deprecated(self, branch=None):
2284
 
        # This class isn't deprecated, but one sub-format is
2285
 
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
2286
 
            super(KnitPackRepository, self)._warn_if_deprecated(branch)
 
1697
    def _all_revision_ids(self):
 
1698
        """See Repository.all_revision_ids()."""
 
1699
        with self.lock_read():
 
1700
            return [key[0] for key in self.revisions.keys()]
2287
1701
 
2288
1702
    def _abort_write_group(self):
2289
1703
        self.revisions._index._key_dependencies.clear()
2290
1704
        self._pack_collection._abort_write_group()
2291
1705
 
2292
 
    def _get_source(self, to_format):
2293
 
        if to_format.network_name() == self._format.network_name():
2294
 
            return KnitPackStreamSource(self, to_format)
2295
 
        return super(KnitPackRepository, self)._get_source(to_format)
2296
 
 
2297
1706
    def _make_parents_provider(self):
2298
 
        return graph.CachingParentsProvider(self)
 
1707
        if not self._format.supports_external_lookups:
 
1708
            return self._unstacked_provider
 
1709
        return graph.StackedParentsProvider(_LazyListJoin(
 
1710
            [self._unstacked_provider], self._fallback_repositories))
2299
1711
 
2300
1712
    def _refresh_data(self):
2301
1713
        if not self.is_locked():
2302
1714
            return
2303
1715
        self._pack_collection.reload_pack_names()
 
1716
        self._unstacked_provider.disable_cache()
 
1717
        self._unstacked_provider.enable_cache()
2304
1718
 
2305
1719
    def _start_write_group(self):
2306
1720
        self._pack_collection._start_write_group()
2308
1722
    def _commit_write_group(self):
2309
1723
        hint = self._pack_collection._commit_write_group()
2310
1724
        self.revisions._index._key_dependencies.clear()
 
1725
        # The commit may have added keys that were previously cached as
 
1726
        # missing, so reset the cache.
 
1727
        self._unstacked_provider.disable_cache()
 
1728
        self._unstacked_provider.enable_cache()
2311
1729
        return hint
2312
1730
 
2313
1731
    def suspend_write_group(self):
2340
1758
        return self._write_lock_count
2341
1759
 
2342
1760
    def lock_write(self, token=None):
 
1761
        """Lock the repository for writes.
 
1762
 
 
1763
        :return: A breezy.repository.RepositoryWriteLockResult.
 
1764
        """
2343
1765
        locked = self.is_locked()
2344
1766
        if not self._write_lock_count and locked:
2345
1767
            raise errors.ReadOnlyError(self)
2350
1772
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
2351
1773
                note('%r was write locked again', self)
2352
1774
            self._prev_lock = 'w'
 
1775
            self._unstacked_provider.enable_cache()
2353
1776
            for repo in self._fallback_repositories:
2354
1777
                # Writes don't affect fallback repos
2355
1778
                repo.lock_read()
2356
1779
            self._refresh_data()
 
1780
        return RepositoryWriteLockResult(self.unlock, None)
2357
1781
 
2358
1782
    def lock_read(self):
 
1783
        """Lock the repository for reads.
 
1784
 
 
1785
        :return: A breezy.lock.LogicalLockResult.
 
1786
        """
2359
1787
        locked = self.is_locked()
2360
1788
        if self._write_lock_count:
2361
1789
            self._write_lock_count += 1
2365
1793
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
2366
1794
                note('%r was read locked again', self)
2367
1795
            self._prev_lock = 'r'
 
1796
            self._unstacked_provider.enable_cache()
2368
1797
            for repo in self._fallback_repositories:
2369
1798
                repo.lock_read()
2370
1799
            self._refresh_data()
 
1800
        return LogicalLockResult(self.unlock)
2371
1801
 
2372
1802
    def leave_lock_in_place(self):
2373
1803
        # not supported - raise an error
2377
1807
        # not supported - raise an error
2378
1808
        raise NotImplementedError(self.dont_leave_lock_in_place)
2379
1809
 
2380
 
    @needs_write_lock
2381
1810
    def pack(self, hint=None, clean_obsolete_packs=False):
2382
1811
        """Compress the data within the repository.
2383
1812
 
2384
1813
        This will pack all the data to a single pack. In future it may
2385
1814
        recompress deltas or do other such expensive operations.
2386
1815
        """
2387
 
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1816
        with self.lock_write():
 
1817
            self._pack_collection.pack(
 
1818
                hint=hint, clean_obsolete_packs=clean_obsolete_packs)
2388
1819
 
2389
 
    @needs_write_lock
2390
1820
    def reconcile(self, other=None, thorough=False):
2391
1821
        """Reconcile this repository."""
2392
 
        from bzrlib.reconcile import PackReconciler
2393
 
        reconciler = PackReconciler(self, thorough=thorough)
2394
 
        reconciler.reconcile()
2395
 
        return reconciler
 
1822
        from .reconcile import PackReconciler
 
1823
        with self.lock_write():
 
1824
            reconciler = PackReconciler(self, thorough=thorough)
 
1825
            return reconciler.reconcile()
2396
1826
 
2397
1827
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
2398
 
        packer = ReconcilePacker(collection, packs, extension, revs)
2399
 
        return packer.pack(pb)
 
1828
        raise NotImplementedError(self._reconcile_pack)
2400
1829
 
2401
1830
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2402
1831
    def unlock(self):
2403
1832
        if self._write_lock_count == 1 and self._write_group is not None:
2404
1833
            self.abort_write_group()
 
1834
            self._unstacked_provider.disable_cache()
2405
1835
            self._transaction = None
2406
1836
            self._write_lock_count = 0
2407
1837
            raise errors.BzrError(
2417
1847
            self.control_files.unlock()
2418
1848
 
2419
1849
        if not self.is_locked():
 
1850
            self._unstacked_provider.disable_cache()
2420
1851
            for repo in self._fallback_repositories:
2421
1852
                repo.unlock()
2422
1853
 
2423
1854
 
2424
 
class KnitPackStreamSource(StreamSource):
2425
 
    """A StreamSource used to transfer data between same-format KnitPack repos.
2426
 
 
2427
 
    This source assumes:
2428
 
        1) Same serialization format for all objects
2429
 
        2) Same root information
2430
 
        3) XML format inventories
2431
 
        4) Atomic inserts (so we can stream inventory texts before text
2432
 
           content)
2433
 
        5) No chk_bytes
2434
 
    """
2435
 
 
2436
 
    def __init__(self, from_repository, to_format):
2437
 
        super(KnitPackStreamSource, self).__init__(from_repository, to_format)
2438
 
        self._text_keys = None
2439
 
        self._text_fetch_order = 'unordered'
2440
 
 
2441
 
    def _get_filtered_inv_stream(self, revision_ids):
2442
 
        from_repo = self.from_repository
2443
 
        parent_ids = from_repo._find_parent_ids_of_revisions(revision_ids)
2444
 
        parent_keys = [(p,) for p in parent_ids]
2445
 
        find_text_keys = from_repo._find_text_key_references_from_xml_inventory_lines
2446
 
        parent_text_keys = set(find_text_keys(
2447
 
            from_repo._inventory_xml_lines_for_keys(parent_keys)))
2448
 
        content_text_keys = set()
2449
 
        knit = KnitVersionedFiles(None, None)
2450
 
        factory = KnitPlainFactory()
2451
 
        def find_text_keys_from_content(record):
2452
 
            if record.storage_kind not in ('knit-delta-gz', 'knit-ft-gz'):
2453
 
                raise ValueError("Unknown content storage kind for"
2454
 
                    " inventory text: %s" % (record.storage_kind,))
2455
 
            # It's a knit record, it has a _raw_record field (even if it was
2456
 
            # reconstituted from a network stream).
2457
 
            raw_data = record._raw_record
2458
 
            # read the entire thing
2459
 
            revision_id = record.key[-1]
2460
 
            content, _ = knit._parse_record(revision_id, raw_data)
2461
 
            if record.storage_kind == 'knit-delta-gz':
2462
 
                line_iterator = factory.get_linedelta_content(content)
2463
 
            elif record.storage_kind == 'knit-ft-gz':
2464
 
                line_iterator = factory.get_fulltext_content(content)
2465
 
            content_text_keys.update(find_text_keys(
2466
 
                [(line, revision_id) for line in line_iterator]))
2467
 
        revision_keys = [(r,) for r in revision_ids]
2468
 
        def _filtered_inv_stream():
2469
 
            source_vf = from_repo.inventories
2470
 
            stream = source_vf.get_record_stream(revision_keys,
2471
 
                                                 'unordered', False)
2472
 
            for record in stream:
2473
 
                if record.storage_kind == 'absent':
2474
 
                    raise errors.NoSuchRevision(from_repo, record.key)
2475
 
                find_text_keys_from_content(record)
2476
 
                yield record
2477
 
            self._text_keys = content_text_keys - parent_text_keys
2478
 
        return ('inventories', _filtered_inv_stream())
2479
 
 
2480
 
    def _get_text_stream(self):
2481
 
        # Note: We know we don't have to handle adding root keys, because both
2482
 
        # the source and target are the identical network name.
2483
 
        text_stream = self.from_repository.texts.get_record_stream(
2484
 
                        self._text_keys, self._text_fetch_order, False)
2485
 
        return ('texts', text_stream)
2486
 
 
2487
 
    def get_stream(self, search):
2488
 
        revision_ids = search.get_keys()
2489
 
        for stream_info in self._fetch_revision_texts(revision_ids):
2490
 
            yield stream_info
2491
 
        self._revision_keys = [(rev_id,) for rev_id in revision_ids]
2492
 
        yield self._get_filtered_inv_stream(revision_ids)
2493
 
        yield self._get_text_stream()
2494
 
 
2495
 
 
2496
 
 
2497
 
class RepositoryFormatPack(MetaDirRepositoryFormat):
 
1855
class RepositoryFormatPack(MetaDirVersionedFileRepositoryFormat):
2498
1856
    """Format logic for pack structured repositories.
2499
1857
 
2500
1858
    This repository format has:
2530
1888
    index_class = None
2531
1889
    _fetch_uses_deltas = True
2532
1890
    fast_deltas = False
 
1891
    supports_funky_characters = True
 
1892
    revision_graph_can_have_wrong_parents = True
2533
1893
 
2534
 
    def initialize(self, a_bzrdir, shared=False):
 
1894
    def initialize(self, a_controldir, shared=False):
2535
1895
        """Create a pack based repository.
2536
1896
 
2537
 
        :param a_bzrdir: bzrdir to contain the new repository; must already
 
1897
        :param a_controldir: bzrdir to contain the new repository; must already
2538
1898
            be initialized.
2539
1899
        :param shared: If true the repository will be initialized as a shared
2540
1900
                       repository.
2541
1901
        """
2542
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1902
        mutter('creating repository in %s.', a_controldir.transport.base)
2543
1903
        dirs = ['indices', 'obsolete_packs', 'packs', 'upload']
2544
1904
        builder = self.index_builder_class()
2545
1905
        files = [('pack-names', builder.finish())]
2546
1906
        utf8_files = [('format', self.get_format_string())]
2547
1907
 
2548
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
2549
 
        repository = self.open(a_bzrdir=a_bzrdir, _found=True)
2550
 
        self._run_post_repo_init_hooks(repository, a_bzrdir, shared)
 
1908
        self._upload_blank_content(
 
1909
            a_controldir, dirs, files, utf8_files, shared)
 
1910
        repository = self.open(a_controldir=a_controldir, _found=True)
 
1911
        self._run_post_repo_init_hooks(repository, a_controldir, shared)
2551
1912
        return repository
2552
1913
 
2553
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1914
    def open(self, a_controldir, _found=False, _override_transport=None):
2554
1915
        """See RepositoryFormat.open().
2555
1916
 
2556
1917
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
2558
1919
                                    than normal. I.e. during 'upgrade'.
2559
1920
        """
2560
1921
        if not _found:
2561
 
            format = RepositoryFormat.find_format(a_bzrdir)
 
1922
            format = RepositoryFormatMetaDir.find_format(a_controldir)
2562
1923
        if _override_transport is not None:
2563
1924
            repo_transport = _override_transport
2564
1925
        else:
2565
 
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1926
            repo_transport = a_controldir.get_repository_transport(None)
2566
1927
        control_files = lockable_files.LockableFiles(repo_transport,
2567
 
                                'lock', lockdir.LockDir)
 
1928
                                                     'lock', lockdir.LockDir)
2568
1929
        return self.repository_class(_format=self,
2569
 
                              a_bzrdir=a_bzrdir,
2570
 
                              control_files=control_files,
2571
 
                              _commit_builder_class=self._commit_builder_class,
2572
 
                              _serializer=self._serializer)
2573
 
 
2574
 
 
2575
 
class RepositoryFormatKnitPack1(RepositoryFormatPack):
2576
 
    """A no-subtrees parameterized Pack repository.
2577
 
 
2578
 
    This format was introduced in 0.92.
2579
 
    """
2580
 
 
2581
 
    repository_class = KnitPackRepository
2582
 
    _commit_builder_class = PackCommitBuilder
2583
 
    @property
2584
 
    def _serializer(self):
2585
 
        return xml5.serializer_v5
2586
 
    # What index classes to use
2587
 
    index_builder_class = InMemoryGraphIndex
2588
 
    index_class = GraphIndex
2589
 
 
2590
 
    def _get_matching_bzrdir(self):
2591
 
        return bzrdir.format_registry.make_bzrdir('pack-0.92')
2592
 
 
2593
 
    def _ignore_setting_bzrdir(self, format):
2594
 
        pass
2595
 
 
2596
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2597
 
 
2598
 
    def get_format_string(self):
2599
 
        """See RepositoryFormat.get_format_string()."""
2600
 
        return "Bazaar pack repository format 1 (needs bzr 0.92)\n"
2601
 
 
2602
 
    def get_format_description(self):
2603
 
        """See RepositoryFormat.get_format_description()."""
2604
 
        return "Packs containing knits without subtree support"
2605
 
 
2606
 
 
2607
 
class RepositoryFormatKnitPack3(RepositoryFormatPack):
2608
 
    """A subtrees parameterized Pack repository.
2609
 
 
2610
 
    This repository format uses the xml7 serializer to get:
2611
 
     - support for recording full info about the tree root
2612
 
     - support for recording tree-references
2613
 
 
2614
 
    This format was introduced in 0.92.
2615
 
    """
2616
 
 
2617
 
    repository_class = KnitPackRepository
2618
 
    _commit_builder_class = PackRootCommitBuilder
2619
 
    rich_root_data = True
2620
 
    experimental = True
2621
 
    supports_tree_reference = True
2622
 
    @property
2623
 
    def _serializer(self):
2624
 
        return xml7.serializer_v7
2625
 
    # What index classes to use
2626
 
    index_builder_class = InMemoryGraphIndex
2627
 
    index_class = GraphIndex
2628
 
 
2629
 
    def _get_matching_bzrdir(self):
2630
 
        return bzrdir.format_registry.make_bzrdir(
2631
 
            'pack-0.92-subtree')
2632
 
 
2633
 
    def _ignore_setting_bzrdir(self, format):
2634
 
        pass
2635
 
 
2636
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2637
 
 
2638
 
    def get_format_string(self):
2639
 
        """See RepositoryFormat.get_format_string()."""
2640
 
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
2641
 
 
2642
 
    def get_format_description(self):
2643
 
        """See RepositoryFormat.get_format_description()."""
2644
 
        return "Packs containing knits with subtree support\n"
2645
 
 
2646
 
 
2647
 
class RepositoryFormatKnitPack4(RepositoryFormatPack):
2648
 
    """A rich-root, no subtrees parameterized Pack repository.
2649
 
 
2650
 
    This repository format uses the xml6 serializer to get:
2651
 
     - support for recording full info about the tree root
2652
 
 
2653
 
    This format was introduced in 1.0.
2654
 
    """
2655
 
 
2656
 
    repository_class = KnitPackRepository
2657
 
    _commit_builder_class = PackRootCommitBuilder
2658
 
    rich_root_data = True
2659
 
    supports_tree_reference = False
2660
 
    @property
2661
 
    def _serializer(self):
2662
 
        return xml6.serializer_v6
2663
 
    # What index classes to use
2664
 
    index_builder_class = InMemoryGraphIndex
2665
 
    index_class = GraphIndex
2666
 
 
2667
 
    def _get_matching_bzrdir(self):
2668
 
        return bzrdir.format_registry.make_bzrdir(
2669
 
            'rich-root-pack')
2670
 
 
2671
 
    def _ignore_setting_bzrdir(self, format):
2672
 
        pass
2673
 
 
2674
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2675
 
 
2676
 
    def get_format_string(self):
2677
 
        """See RepositoryFormat.get_format_string()."""
2678
 
        return ("Bazaar pack repository format 1 with rich root"
2679
 
                " (needs bzr 1.0)\n")
2680
 
 
2681
 
    def get_format_description(self):
2682
 
        """See RepositoryFormat.get_format_description()."""
2683
 
        return "Packs containing knits with rich root support\n"
2684
 
 
2685
 
 
2686
 
class RepositoryFormatKnitPack5(RepositoryFormatPack):
2687
 
    """Repository that supports external references to allow stacking.
2688
 
 
2689
 
    New in release 1.6.
2690
 
 
2691
 
    Supports external lookups, which results in non-truncated ghosts after
2692
 
    reconcile compared to pack-0.92 formats.
2693
 
    """
2694
 
 
2695
 
    repository_class = KnitPackRepository
2696
 
    _commit_builder_class = PackCommitBuilder
2697
 
    supports_external_lookups = True
2698
 
    # What index classes to use
2699
 
    index_builder_class = InMemoryGraphIndex
2700
 
    index_class = GraphIndex
2701
 
 
2702
 
    @property
2703
 
    def _serializer(self):
2704
 
        return xml5.serializer_v5
2705
 
 
2706
 
    def _get_matching_bzrdir(self):
2707
 
        return bzrdir.format_registry.make_bzrdir('1.6')
2708
 
 
2709
 
    def _ignore_setting_bzrdir(self, format):
2710
 
        pass
2711
 
 
2712
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2713
 
 
2714
 
    def get_format_string(self):
2715
 
        """See RepositoryFormat.get_format_string()."""
2716
 
        return "Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n"
2717
 
 
2718
 
    def get_format_description(self):
2719
 
        """See RepositoryFormat.get_format_description()."""
2720
 
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
2721
 
 
2722
 
 
2723
 
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
2724
 
    """A repository with rich roots and stacking.
2725
 
 
2726
 
    New in release 1.6.1.
2727
 
 
2728
 
    Supports stacking on other repositories, allowing data to be accessed
2729
 
    without being stored locally.
2730
 
    """
2731
 
 
2732
 
    repository_class = KnitPackRepository
2733
 
    _commit_builder_class = PackRootCommitBuilder
2734
 
    rich_root_data = True
2735
 
    supports_tree_reference = False # no subtrees
2736
 
    supports_external_lookups = True
2737
 
    # What index classes to use
2738
 
    index_builder_class = InMemoryGraphIndex
2739
 
    index_class = GraphIndex
2740
 
 
2741
 
    @property
2742
 
    def _serializer(self):
2743
 
        return xml6.serializer_v6
2744
 
 
2745
 
    def _get_matching_bzrdir(self):
2746
 
        return bzrdir.format_registry.make_bzrdir(
2747
 
            '1.6.1-rich-root')
2748
 
 
2749
 
    def _ignore_setting_bzrdir(self, format):
2750
 
        pass
2751
 
 
2752
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2753
 
 
2754
 
    def get_format_string(self):
2755
 
        """See RepositoryFormat.get_format_string()."""
2756
 
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
2757
 
 
2758
 
    def get_format_description(self):
2759
 
        return "Packs 5 rich-root (adds stacking support, requires bzr 1.6.1)"
2760
 
 
2761
 
 
2762
 
class RepositoryFormatKnitPack5RichRootBroken(RepositoryFormatPack):
2763
 
    """A repository with rich roots and external references.
2764
 
 
2765
 
    New in release 1.6.
2766
 
 
2767
 
    Supports external lookups, which results in non-truncated ghosts after
2768
 
    reconcile compared to pack-0.92 formats.
2769
 
 
2770
 
    This format was deprecated because the serializer it uses accidentally
2771
 
    supported subtrees, when the format was not intended to. This meant that
2772
 
    someone could accidentally fetch from an incorrect repository.
2773
 
    """
2774
 
 
2775
 
    repository_class = KnitPackRepository
2776
 
    _commit_builder_class = PackRootCommitBuilder
2777
 
    rich_root_data = True
2778
 
    supports_tree_reference = False # no subtrees
2779
 
 
2780
 
    supports_external_lookups = True
2781
 
    # What index classes to use
2782
 
    index_builder_class = InMemoryGraphIndex
2783
 
    index_class = GraphIndex
2784
 
 
2785
 
    @property
2786
 
    def _serializer(self):
2787
 
        return xml7.serializer_v7
2788
 
 
2789
 
    def _get_matching_bzrdir(self):
2790
 
        matching = bzrdir.format_registry.make_bzrdir(
2791
 
            '1.6.1-rich-root')
2792
 
        matching.repository_format = self
2793
 
        return matching
2794
 
 
2795
 
    def _ignore_setting_bzrdir(self, format):
2796
 
        pass
2797
 
 
2798
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2799
 
 
2800
 
    def get_format_string(self):
2801
 
        """See RepositoryFormat.get_format_string()."""
2802
 
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
2803
 
 
2804
 
    def get_format_description(self):
2805
 
        return ("Packs 5 rich-root (adds stacking support, requires bzr 1.6)"
2806
 
                " (deprecated)")
2807
 
 
2808
 
 
2809
 
class RepositoryFormatKnitPack6(RepositoryFormatPack):
2810
 
    """A repository with stacking and btree indexes,
2811
 
    without rich roots or subtrees.
2812
 
 
2813
 
    This is equivalent to pack-1.6 with B+Tree indices.
2814
 
    """
2815
 
 
2816
 
    repository_class = KnitPackRepository
2817
 
    _commit_builder_class = PackCommitBuilder
2818
 
    supports_external_lookups = True
2819
 
    # What index classes to use
2820
 
    index_builder_class = BTreeBuilder
2821
 
    index_class = BTreeGraphIndex
2822
 
 
2823
 
    @property
2824
 
    def _serializer(self):
2825
 
        return xml5.serializer_v5
2826
 
 
2827
 
    def _get_matching_bzrdir(self):
2828
 
        return bzrdir.format_registry.make_bzrdir('1.9')
2829
 
 
2830
 
    def _ignore_setting_bzrdir(self, format):
2831
 
        pass
2832
 
 
2833
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2834
 
 
2835
 
    def get_format_string(self):
2836
 
        """See RepositoryFormat.get_format_string()."""
2837
 
        return "Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n"
2838
 
 
2839
 
    def get_format_description(self):
2840
 
        """See RepositoryFormat.get_format_description()."""
2841
 
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
2842
 
 
2843
 
 
2844
 
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
2845
 
    """A repository with rich roots, no subtrees, stacking and btree indexes.
2846
 
 
2847
 
    1.6-rich-root with B+Tree indices.
2848
 
    """
2849
 
 
2850
 
    repository_class = KnitPackRepository
2851
 
    _commit_builder_class = PackRootCommitBuilder
2852
 
    rich_root_data = True
2853
 
    supports_tree_reference = False # no subtrees
2854
 
    supports_external_lookups = True
2855
 
    # What index classes to use
2856
 
    index_builder_class = BTreeBuilder
2857
 
    index_class = BTreeGraphIndex
2858
 
 
2859
 
    @property
2860
 
    def _serializer(self):
2861
 
        return xml6.serializer_v6
2862
 
 
2863
 
    def _get_matching_bzrdir(self):
2864
 
        return bzrdir.format_registry.make_bzrdir(
2865
 
            '1.9-rich-root')
2866
 
 
2867
 
    def _ignore_setting_bzrdir(self, format):
2868
 
        pass
2869
 
 
2870
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2871
 
 
2872
 
    def get_format_string(self):
2873
 
        """See RepositoryFormat.get_format_string()."""
2874
 
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
2875
 
 
2876
 
    def get_format_description(self):
2877
 
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
2878
 
 
2879
 
 
2880
 
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
2881
 
    """A subtrees development repository.
2882
 
 
2883
 
    This format should be retained until the second release after bzr 1.7.
2884
 
 
2885
 
    1.6.1-subtree[as it might have been] with B+Tree indices.
2886
 
 
2887
 
    This is [now] retained until we have a CHK based subtree format in
2888
 
    development.
2889
 
    """
2890
 
 
2891
 
    repository_class = KnitPackRepository
2892
 
    _commit_builder_class = PackRootCommitBuilder
2893
 
    rich_root_data = True
2894
 
    experimental = True
2895
 
    supports_tree_reference = True
2896
 
    supports_external_lookups = True
2897
 
    # What index classes to use
2898
 
    index_builder_class = BTreeBuilder
2899
 
    index_class = BTreeGraphIndex
2900
 
 
2901
 
    @property
2902
 
    def _serializer(self):
2903
 
        return xml7.serializer_v7
2904
 
 
2905
 
    def _get_matching_bzrdir(self):
2906
 
        return bzrdir.format_registry.make_bzrdir(
2907
 
            'development-subtree')
2908
 
 
2909
 
    def _ignore_setting_bzrdir(self, format):
2910
 
        pass
2911
 
 
2912
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2913
 
 
2914
 
    def get_format_string(self):
2915
 
        """See RepositoryFormat.get_format_string()."""
2916
 
        return ("Bazaar development format 2 with subtree support "
2917
 
            "(needs bzr.dev from before 1.8)\n")
2918
 
 
2919
 
    def get_format_description(self):
2920
 
        """See RepositoryFormat.get_format_description()."""
2921
 
        return ("Development repository format, currently the same as "
2922
 
            "1.6.1-subtree with B+Tree indices.\n")
2923
 
 
 
1930
                                     a_controldir=a_controldir,
 
1931
                                     control_files=control_files,
 
1932
                                     _commit_builder_class=self._commit_builder_class,
 
1933
                                     _serializer=self._serializer)
 
1934
 
 
1935
 
 
1936
class RetryPackOperations(errors.RetryWithNewPacks):
 
1937
    """Raised when we are packing and we find a missing file.
 
1938
 
 
1939
    Meant as a signaling exception, to tell the RepositoryPackCollection.pack
 
1940
    code it should try again.
 
1941
    """
 
1942
 
 
1943
    internal_error = True
 
1944
 
 
1945
    _fmt = ("Pack files have changed, reload and try pack again."
 
1946
            " context: %(context)s %(orig_error)s")
 
1947
 
 
1948
 
 
1949
class _DirectPackAccess(object):
 
1950
    """Access to data in one or more packs with less translation."""
 
1951
 
 
1952
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
 
1953
        """Create a _DirectPackAccess object.
 
1954
 
 
1955
        :param index_to_packs: A dict mapping index objects to the transport
 
1956
            and file names for obtaining data.
 
1957
        :param reload_func: A function to call if we determine that the pack
 
1958
            files have moved and we need to reload our caches. See
 
1959
            breezy.repo_fmt.pack_repo.AggregateIndex for more details.
 
1960
        """
 
1961
        self._container_writer = None
 
1962
        self._write_index = None
 
1963
        self._indices = index_to_packs
 
1964
        self._reload_func = reload_func
 
1965
        self._flush_func = flush_func
 
1966
 
 
1967
    def add_raw_records(self, key_sizes, raw_data):
 
1968
        """Add raw knit bytes to a storage area.
 
1969
 
 
1970
        The data is spooled to the container writer in one bytes-record per
 
1971
        raw data item.
 
1972
 
 
1973
        :param sizes: An iterable of tuples containing the key and size of each
 
1974
            raw data segment.
 
1975
        :param raw_data: A bytestring containing the data.
 
1976
        :return: A list of memos to retrieve the record later. Each memo is an
 
1977
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
 
1978
            length), where the index field is the write_index object supplied
 
1979
            to the PackAccess object.
 
1980
        """
 
1981
        if not isinstance(raw_data, bytes):
 
1982
            raise AssertionError(
 
1983
                'data must be plain bytes was %s' % type(raw_data))
 
1984
        result = []
 
1985
        offset = 0
 
1986
        for key, size in key_sizes:
 
1987
            p_offset, p_length = self._container_writer.add_bytes_record(
 
1988
                raw_data[offset:offset + size], [])
 
1989
            offset += size
 
1990
            result.append((self._write_index, p_offset, p_length))
 
1991
        return result
 
1992
 
 
1993
    def flush(self):
 
1994
        """Flush pending writes on this access object.
 
1995
 
 
1996
        This will flush any buffered writes to a NewPack.
 
1997
        """
 
1998
        if self._flush_func is not None:
 
1999
            self._flush_func()
 
2000
 
 
2001
    def get_raw_records(self, memos_for_retrieval):
 
2002
        """Get the raw bytes for a records.
 
2003
 
 
2004
        :param memos_for_retrieval: An iterable containing the (index, pos,
 
2005
            length) memo for retrieving the bytes. The Pack access method
 
2006
            looks up the pack to use for a given record in its index_to_pack
 
2007
            map.
 
2008
        :return: An iterator over the bytes of the records.
 
2009
        """
 
2010
        # first pass, group into same-index requests
 
2011
        request_lists = []
 
2012
        current_index = None
 
2013
        for (index, offset, length) in memos_for_retrieval:
 
2014
            if current_index == index:
 
2015
                current_list.append((offset, length))
 
2016
            else:
 
2017
                if current_index is not None:
 
2018
                    request_lists.append((current_index, current_list))
 
2019
                current_index = index
 
2020
                current_list = [(offset, length)]
 
2021
        # handle the last entry
 
2022
        if current_index is not None:
 
2023
            request_lists.append((current_index, current_list))
 
2024
        for index, offsets in request_lists:
 
2025
            try:
 
2026
                transport, path = self._indices[index]
 
2027
            except KeyError:
 
2028
                # A KeyError here indicates that someone has triggered an index
 
2029
                # reload, and this index has gone missing, we need to start
 
2030
                # over.
 
2031
                if self._reload_func is None:
 
2032
                    # If we don't have a _reload_func there is nothing that can
 
2033
                    # be done
 
2034
                    raise
 
2035
                raise errors.RetryWithNewPacks(index,
 
2036
                                               reload_occurred=True,
 
2037
                                               exc_info=sys.exc_info())
 
2038
            try:
 
2039
                reader = pack.make_readv_reader(transport, path, offsets)
 
2040
                for names, read_func in reader.iter_records():
 
2041
                    yield read_func(None)
 
2042
            except errors.NoSuchFile:
 
2043
                # A NoSuchFile error indicates that a pack file has gone
 
2044
                # missing on disk, we need to trigger a reload, and start over.
 
2045
                if self._reload_func is None:
 
2046
                    raise
 
2047
                raise errors.RetryWithNewPacks(transport.abspath(path),
 
2048
                                               reload_occurred=False,
 
2049
                                               exc_info=sys.exc_info())
 
2050
 
 
2051
    def set_writer(self, writer, index, transport_packname):
 
2052
        """Set a writer to use for adding data."""
 
2053
        if index is not None:
 
2054
            self._indices[index] = transport_packname
 
2055
        self._container_writer = writer
 
2056
        self._write_index = index
 
2057
 
 
2058
    def reload_or_raise(self, retry_exc):
 
2059
        """Try calling the reload function, or re-raise the original exception.
 
2060
 
 
2061
        This should be called after _DirectPackAccess raises a
 
2062
        RetryWithNewPacks exception. This function will handle the common logic
 
2063
        of determining when the error is fatal versus being temporary.
 
2064
        It will also make sure that the original exception is raised, rather
 
2065
        than the RetryWithNewPacks exception.
 
2066
 
 
2067
        If this function returns, then the calling function should retry
 
2068
        whatever operation was being performed. Otherwise an exception will
 
2069
        be raised.
 
2070
 
 
2071
        :param retry_exc: A RetryWithNewPacks exception.
 
2072
        """
 
2073
        is_error = False
 
2074
        if self._reload_func is None:
 
2075
            is_error = True
 
2076
        elif not self._reload_func():
 
2077
            # The reload claimed that nothing changed
 
2078
            if not retry_exc.reload_occurred:
 
2079
                # If there wasn't an earlier reload, then we really were
 
2080
                # expecting to find changes. We didn't find them, so this is a
 
2081
                # hard error
 
2082
                is_error = True
 
2083
        if is_error:
 
2084
            # GZ 2017-03-27: No real reason this needs the original traceback.
 
2085
            reraise(*retry_exc.exc_info)