~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 15:30:59 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909153059-sb038agvd38ci2q8
more link fixes in the User Guide

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
 
 
19
17
import re
20
18
import sys
21
19
 
26
24
 
27
25
from bzrlib import (
28
26
    chk_map,
29
 
    cleanup,
30
 
    config,
31
27
    debug,
32
28
    graph,
33
29
    osutils,
34
30
    pack,
35
31
    transactions,
36
 
    tsort,
37
32
    ui,
 
33
    xml5,
 
34
    xml6,
 
35
    xml7,
38
36
    )
39
37
from bzrlib.index import (
40
38
    CombinedGraphIndex,
41
39
    GraphIndexPrefixAdapter,
42
40
    )
 
41
from bzrlib.knit import (
 
42
    KnitPlainFactory,
 
43
    KnitVersionedFiles,
 
44
    _KnitGraphIndex,
 
45
    _DirectPackAccess,
 
46
    )
 
47
from bzrlib import tsort
43
48
""")
44
49
from bzrlib import (
45
 
    btree_index,
 
50
    bzrdir,
46
51
    errors,
47
52
    lockable_files,
48
53
    lockdir,
 
54
    revision as _mod_revision,
49
55
    )
50
56
 
51
 
from bzrlib.decorators import (
52
 
    needs_read_lock,
53
 
    needs_write_lock,
54
 
    only_raises,
55
 
    )
56
 
from bzrlib.lock import LogicalLockResult
 
57
from bzrlib.decorators import needs_write_lock
 
58
from bzrlib.btree_index import (
 
59
    BTreeGraphIndex,
 
60
    BTreeBuilder,
 
61
    )
 
62
from bzrlib.index import (
 
63
    GraphIndex,
 
64
    InMemoryGraphIndex,
 
65
    )
 
66
from bzrlib.repofmt.knitrepo import KnitRepository
57
67
from bzrlib.repository import (
58
 
    _LazyListJoin,
59
 
    MetaDirRepository,
60
 
    RepositoryFormatMetaDir,
61
 
    RepositoryWriteLockResult,
62
 
    )
63
 
from bzrlib.vf_repository import (
64
 
    MetaDirVersionedFileRepository,
65
 
    MetaDirVersionedFileRepositoryFormat,
66
 
    VersionedFileCommitBuilder,
67
 
    VersionedFileRootCommitBuilder,
 
68
    CommitBuilder,
 
69
    MetaDirRepositoryFormat,
 
70
    RepositoryFormat,
 
71
    RootCommitBuilder,
 
72
    StreamSource,
68
73
    )
69
74
from bzrlib.trace import (
70
75
    mutter,
71
 
    note,
72
76
    warning,
73
77
    )
74
78
 
75
79
 
76
 
class PackCommitBuilder(VersionedFileCommitBuilder):
77
 
    """Subclass of VersionedFileCommitBuilder to add texts with pack semantics.
 
80
class PackCommitBuilder(CommitBuilder):
 
81
    """A subclass of CommitBuilder to add texts with pack semantics.
78
82
 
79
83
    Specifically this uses one knit object rather than one knit object per
80
84
    added text, reducing memory and object pressure.
82
86
 
83
87
    def __init__(self, repository, parents, config, timestamp=None,
84
88
                 timezone=None, committer=None, revprops=None,
85
 
                 revision_id=None, lossy=False):
86
 
        VersionedFileCommitBuilder.__init__(self, repository, parents, config,
 
89
                 revision_id=None):
 
90
        CommitBuilder.__init__(self, repository, parents, config,
87
91
            timestamp=timestamp, timezone=timezone, committer=committer,
88
 
            revprops=revprops, revision_id=revision_id, lossy=lossy)
 
92
            revprops=revprops, revision_id=revision_id)
89
93
        self._file_graph = graph.Graph(
90
94
            repository._pack_collection.text_index.combined_index)
91
95
 
94
98
        return set([key[1] for key in self._file_graph.heads(keys)])
95
99
 
96
100
 
97
 
class PackRootCommitBuilder(VersionedFileRootCommitBuilder):
 
101
class PackRootCommitBuilder(RootCommitBuilder):
98
102
    """A subclass of RootCommitBuilder to add texts with pack semantics.
99
103
 
100
104
    Specifically this uses one knit object rather than one knit object per
103
107
 
104
108
    def __init__(self, repository, parents, config, timestamp=None,
105
109
                 timezone=None, committer=None, revprops=None,
106
 
                 revision_id=None, lossy=False):
107
 
        super(PackRootCommitBuilder, self).__init__(repository, parents,
108
 
            config, timestamp=timestamp, timezone=timezone,
109
 
            committer=committer, revprops=revprops, revision_id=revision_id,
110
 
            lossy=lossy)
 
110
                 revision_id=None):
 
111
        CommitBuilder.__init__(self, repository, parents, config,
 
112
            timestamp=timestamp, timezone=timezone, committer=committer,
 
113
            revprops=revprops, revision_id=revision_id)
111
114
        self._file_graph = graph.Graph(
112
115
            repository._pack_collection.text_index.combined_index)
113
116
 
221
224
        return self.index_name('text', name)
222
225
 
223
226
    def _replace_index_with_readonly(self, index_type):
224
 
        unlimited_cache = False
225
 
        if index_type == 'chk':
226
 
            unlimited_cache = True
227
 
        index = self.index_class(self.index_transport,
228
 
                    self.index_name(index_type, self.name),
229
 
                    self.index_sizes[self.index_offset(index_type)],
230
 
                    unlimited_cache=unlimited_cache)
231
 
        if index_type == 'chk':
232
 
            index._leaf_factory = btree_index._gcchk_factory
233
 
        setattr(self, index_type + '_index', index)
 
227
        setattr(self, index_type + '_index',
 
228
            self.index_class(self.index_transport,
 
229
                self.index_name(index_type, self.name),
 
230
                self.index_sizes[self.index_offset(index_type)]))
234
231
 
235
232
 
236
233
class ExistingPack(Pack):
317
314
        for index_type in index_types:
318
315
            old_name = self.index_name(index_type, self.name)
319
316
            new_name = '../indices/' + old_name
320
 
            self.upload_transport.move(old_name, new_name)
 
317
            self.upload_transport.rename(old_name, new_name)
321
318
            self._replace_index_with_readonly(index_type)
322
319
        new_name = '../packs/' + self.file_name()
323
 
        self.upload_transport.move(self.file_name(), new_name)
 
320
        self.upload_transport.rename(self.file_name(), new_name)
324
321
        self._state = 'finished'
325
322
 
326
323
    def _get_external_refs(self, index):
481
478
        # visible is smaller.  On the other hand none will be seen until
482
479
        # they're in the names list.
483
480
        self.index_sizes = [None, None, None, None]
484
 
        self._write_index('revision', self.revision_index, 'revision',
485
 
            suspend)
 
481
        self._write_index('revision', self.revision_index, 'revision', suspend)
486
482
        self._write_index('inventory', self.inventory_index, 'inventory',
487
483
            suspend)
488
484
        self._write_index('text', self.text_index, 'file texts', suspend)
492
488
            self.index_sizes.append(None)
493
489
            self._write_index('chk', self.chk_index,
494
490
                'content hash bytes', suspend)
495
 
        self.write_stream.close(
496
 
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
 
491
        self.write_stream.close()
497
492
        # Note that this will clobber an existing pack with the same name,
498
493
        # without checking for hash collisions. While this is undesirable this
499
494
        # is something that can be rectified in a subsequent release. One way
508
503
        new_name = self.name + '.pack'
509
504
        if not suspend:
510
505
            new_name = '../packs/' + new_name
511
 
        self.upload_transport.move(self.random_name, new_name)
 
506
        self.upload_transport.rename(self.random_name, new_name)
512
507
        self._state = 'finished'
513
508
        if 'pack' in debug.debug_flags:
514
509
            # XXX: size might be interesting?
542
537
            transport = self.upload_transport
543
538
        else:
544
539
            transport = self.index_transport
545
 
        index_tempfile = index.finish()
546
 
        index_bytes = index_tempfile.read()
547
 
        write_stream = transport.open_write_stream(index_name,
548
 
            mode=self._file_mode)
549
 
        write_stream.write(index_bytes)
550
 
        write_stream.close(
551
 
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
552
 
        self.index_sizes[self.index_offset(index_type)] = len(index_bytes)
 
540
        self.index_sizes[self.index_offset(index_type)] = transport.put_file(
 
541
            index_name, index.finish(), mode=self._file_mode)
553
542
        if 'pack' in debug.debug_flags:
554
543
            # XXX: size might be interesting?
555
544
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
592
581
                                             flush_func=flush_func)
593
582
        self.add_callback = None
594
583
 
 
584
    def replace_indices(self, index_to_pack, indices):
 
585
        """Replace the current mappings with fresh ones.
 
586
 
 
587
        This should probably not be used eventually, rather incremental add and
 
588
        removal of indices. It has been added during refactoring of existing
 
589
        code.
 
590
 
 
591
        :param index_to_pack: A mapping from index objects to
 
592
            (transport, name) tuples for the pack file data.
 
593
        :param indices: A list of indices.
 
594
        """
 
595
        # refresh the revision pack map dict without replacing the instance.
 
596
        self.index_to_pack.clear()
 
597
        self.index_to_pack.update(index_to_pack)
 
598
        # XXX: API break - clearly a 'replace' method would be good?
 
599
        self.combined_index._indices[:] = indices
 
600
        # the current add nodes callback for the current writable index if
 
601
        # there is one.
 
602
        self.add_callback = None
 
603
 
595
604
    def add_index(self, index, pack):
596
605
        """Add index to the aggregate, which is an index for Pack pack.
597
606
 
604
613
        # expose it to the index map
605
614
        self.index_to_pack[index] = pack.access_tuple()
606
615
        # put it at the front of the linear index list
607
 
        self.combined_index.insert_index(0, index, pack.name)
 
616
        self.combined_index.insert_index(0, index)
608
617
 
609
618
    def add_writable_index(self, index, pack):
610
619
        """Add an index which is able to have data added to it.
630
639
        self.data_access.set_writer(None, None, (None, None))
631
640
        self.index_to_pack.clear()
632
641
        del self.combined_index._indices[:]
633
 
        del self.combined_index._index_names[:]
634
642
        self.add_callback = None
635
643
 
636
 
    def remove_index(self, index):
 
644
    def remove_index(self, index, pack):
637
645
        """Remove index from the indices used to answer queries.
638
646
 
639
647
        :param index: An index from the pack parameter.
 
648
        :param pack: A Pack instance.
640
649
        """
641
650
        del self.index_to_pack[index]
642
 
        pos = self.combined_index._indices.index(index)
643
 
        del self.combined_index._indices[pos]
644
 
        del self.combined_index._index_names[pos]
 
651
        self.combined_index._indices.remove(index)
645
652
        if (self.add_callback is not None and
646
653
            getattr(index, 'add_nodes', None) == self.add_callback):
647
654
            self.add_callback = None
677
684
        # What text keys to copy. None for 'all texts'. This is set by
678
685
        # _copy_inventory_texts
679
686
        self._text_filter = None
 
687
        self._extra_init()
 
688
 
 
689
    def _extra_init(self):
 
690
        """A template hook to allow extending the constructor trivially."""
 
691
 
 
692
    def _pack_map_and_index_list(self, index_attribute):
 
693
        """Convert a list of packs to an index pack map and index list.
 
694
 
 
695
        :param index_attribute: The attribute that the desired index is found
 
696
            on.
 
697
        :return: A tuple (map, list) where map contains the dict from
 
698
            index:pack_tuple, and list contains the indices in the preferred
 
699
            access order.
 
700
        """
 
701
        indices = []
 
702
        pack_map = {}
 
703
        for pack_obj in self.packs:
 
704
            index = getattr(pack_obj, index_attribute)
 
705
            indices.append(index)
 
706
            pack_map[index] = pack_obj
 
707
        return pack_map, indices
 
708
 
 
709
    def _index_contents(self, indices, key_filter=None):
 
710
        """Get an iterable of the index contents from a pack_map.
 
711
 
 
712
        :param indices: The list of indices to query
 
713
        :param key_filter: An optional filter to limit the keys returned.
 
714
        """
 
715
        all_index = CombinedGraphIndex(indices)
 
716
        if key_filter is None:
 
717
            return all_index.iter_all_entries()
 
718
        else:
 
719
            return all_index.iter_entries(key_filter)
680
720
 
681
721
    def pack(self, pb=None):
682
722
        """Create a new pack by reading data from other packs.
693
733
        :return: A Pack object, or None if nothing was copied.
694
734
        """
695
735
        # open a pack - using the same name as the last temporary file
696
 
        # - which has already been flushed, so it's safe.
 
736
        # - which has already been flushed, so its safe.
697
737
        # XXX: - duplicate code warning with start_write_group; fix before
698
738
        #      considering 'done'.
699
739
        if self._pack_collection._new_pack is not None:
731
771
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
732
772
        return new_pack
733
773
 
 
774
    def _update_pack_order(self, entries, index_to_pack_map):
 
775
        """Determine how we want our packs to be ordered.
 
776
 
 
777
        This changes the sort order of the self.packs list so that packs unused
 
778
        by 'entries' will be at the end of the list, so that future requests
 
779
        can avoid probing them.  Used packs will be at the front of the
 
780
        self.packs list, in the order of their first use in 'entries'.
 
781
 
 
782
        :param entries: A list of (index, ...) tuples
 
783
        :param index_to_pack_map: A mapping from index objects to pack objects.
 
784
        """
 
785
        packs = []
 
786
        seen_indexes = set()
 
787
        for entry in entries:
 
788
            index = entry[0]
 
789
            if index not in seen_indexes:
 
790
                packs.append(index_to_pack_map[index])
 
791
                seen_indexes.add(index)
 
792
        if len(packs) == len(self.packs):
 
793
            if 'pack' in debug.debug_flags:
 
794
                mutter('Not changing pack list, all packs used.')
 
795
            return
 
796
        seen_packs = set(packs)
 
797
        for pack in self.packs:
 
798
            if pack not in seen_packs:
 
799
                packs.append(pack)
 
800
                seen_packs.add(pack)
 
801
        if 'pack' in debug.debug_flags:
 
802
            old_names = [p.access_tuple()[1] for p in self.packs]
 
803
            new_names = [p.access_tuple()[1] for p in packs]
 
804
            mutter('Reordering packs\nfrom: %s\n  to: %s',
 
805
                   old_names, new_names)
 
806
        self.packs = packs
 
807
 
734
808
    def _copy_revision_texts(self):
735
809
        """Copy revision data to the new pack."""
736
 
        raise NotImplementedError(self._copy_revision_texts)
 
810
        # select revisions
 
811
        if self.revision_ids:
 
812
            revision_keys = [(revision_id,) for revision_id in self.revision_ids]
 
813
        else:
 
814
            revision_keys = None
 
815
        # select revision keys
 
816
        revision_index_map, revision_indices = self._pack_map_and_index_list(
 
817
            'revision_index')
 
818
        revision_nodes = self._index_contents(revision_indices, revision_keys)
 
819
        revision_nodes = list(revision_nodes)
 
820
        self._update_pack_order(revision_nodes, revision_index_map)
 
821
        # copy revision keys and adjust values
 
822
        self.pb.update("Copying revision texts", 1)
 
823
        total_items, readv_group_iter = self._revision_node_readv(revision_nodes)
 
824
        list(self._copy_nodes_graph(revision_index_map, self.new_pack._writer,
 
825
            self.new_pack.revision_index, readv_group_iter, total_items))
 
826
        if 'pack' in debug.debug_flags:
 
827
            mutter('%s: create_pack: revisions copied: %s%s %d items t+%6.3fs',
 
828
                time.ctime(), self._pack_collection._upload_transport.base,
 
829
                self.new_pack.random_name,
 
830
                self.new_pack.revision_index.key_count(),
 
831
                time.time() - self.new_pack.start_time)
 
832
        self._revision_keys = revision_keys
737
833
 
738
834
    def _copy_inventory_texts(self):
739
835
        """Copy the inventory texts to the new pack.
742
838
 
743
839
        Sets self._text_filter appropriately.
744
840
        """
745
 
        raise NotImplementedError(self._copy_inventory_texts)
 
841
        # select inventory keys
 
842
        inv_keys = self._revision_keys # currently the same keyspace, and note that
 
843
        # querying for keys here could introduce a bug where an inventory item
 
844
        # is missed, so do not change it to query separately without cross
 
845
        # checking like the text key check below.
 
846
        inventory_index_map, inventory_indices = self._pack_map_and_index_list(
 
847
            'inventory_index')
 
848
        inv_nodes = self._index_contents(inventory_indices, inv_keys)
 
849
        # copy inventory keys and adjust values
 
850
        # XXX: Should be a helper function to allow different inv representation
 
851
        # at this point.
 
852
        self.pb.update("Copying inventory texts", 2)
 
853
        total_items, readv_group_iter = self._least_readv_node_readv(inv_nodes)
 
854
        # Only grab the output lines if we will be processing them
 
855
        output_lines = bool(self.revision_ids)
 
856
        inv_lines = self._copy_nodes_graph(inventory_index_map,
 
857
            self.new_pack._writer, self.new_pack.inventory_index,
 
858
            readv_group_iter, total_items, output_lines=output_lines)
 
859
        if self.revision_ids:
 
860
            self._process_inventory_lines(inv_lines)
 
861
        else:
 
862
            # eat the iterator to cause it to execute.
 
863
            list(inv_lines)
 
864
            self._text_filter = None
 
865
        if 'pack' in debug.debug_flags:
 
866
            mutter('%s: create_pack: inventories copied: %s%s %d items t+%6.3fs',
 
867
                time.ctime(), self._pack_collection._upload_transport.base,
 
868
                self.new_pack.random_name,
 
869
                self.new_pack.inventory_index.key_count(),
 
870
                time.time() - self.new_pack.start_time)
746
871
 
747
872
    def _copy_text_texts(self):
748
 
        raise NotImplementedError(self._copy_text_texts)
 
873
        # select text keys
 
874
        text_index_map, text_nodes = self._get_text_nodes()
 
875
        if self._text_filter is not None:
 
876
            # We could return the keys copied as part of the return value from
 
877
            # _copy_nodes_graph but this doesn't work all that well with the
 
878
            # need to get line output too, so we check separately, and as we're
 
879
            # going to buffer everything anyway, we check beforehand, which
 
880
            # saves reading knit data over the wire when we know there are
 
881
            # mising records.
 
882
            text_nodes = set(text_nodes)
 
883
            present_text_keys = set(_node[1] for _node in text_nodes)
 
884
            missing_text_keys = set(self._text_filter) - present_text_keys
 
885
            if missing_text_keys:
 
886
                # TODO: raise a specific error that can handle many missing
 
887
                # keys.
 
888
                mutter("missing keys during fetch: %r", missing_text_keys)
 
889
                a_missing_key = missing_text_keys.pop()
 
890
                raise errors.RevisionNotPresent(a_missing_key[1],
 
891
                    a_missing_key[0])
 
892
        # copy text keys and adjust values
 
893
        self.pb.update("Copying content texts", 3)
 
894
        total_items, readv_group_iter = self._least_readv_node_readv(text_nodes)
 
895
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
 
896
            self.new_pack.text_index, readv_group_iter, total_items))
 
897
        self._log_copied_texts()
749
898
 
750
899
    def _create_pack_from_packs(self):
751
 
        raise NotImplementedError(self._create_pack_from_packs)
 
900
        self.pb.update("Opening pack", 0, 5)
 
901
        self.new_pack = self.open_pack()
 
902
        new_pack = self.new_pack
 
903
        # buffer data - we won't be reading-back during the pack creation and
 
904
        # this makes a significant difference on sftp pushes.
 
905
        new_pack.set_write_cache_size(1024*1024)
 
906
        if 'pack' in debug.debug_flags:
 
907
            plain_pack_list = ['%s%s' % (a_pack.pack_transport.base, a_pack.name)
 
908
                for a_pack in self.packs]
 
909
            if self.revision_ids is not None:
 
910
                rev_count = len(self.revision_ids)
 
911
            else:
 
912
                rev_count = 'all'
 
913
            mutter('%s: create_pack: creating pack from source packs: '
 
914
                '%s%s %s revisions wanted %s t=0',
 
915
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
916
                plain_pack_list, rev_count)
 
917
        self._copy_revision_texts()
 
918
        self._copy_inventory_texts()
 
919
        self._copy_text_texts()
 
920
        # select signature keys
 
921
        signature_filter = self._revision_keys # same keyspace
 
922
        signature_index_map, signature_indices = self._pack_map_and_index_list(
 
923
            'signature_index')
 
924
        signature_nodes = self._index_contents(signature_indices,
 
925
            signature_filter)
 
926
        # copy signature keys and adjust values
 
927
        self.pb.update("Copying signature texts", 4)
 
928
        self._copy_nodes(signature_nodes, signature_index_map, new_pack._writer,
 
929
            new_pack.signature_index)
 
930
        if 'pack' in debug.debug_flags:
 
931
            mutter('%s: create_pack: revision signatures copied: %s%s %d items t+%6.3fs',
 
932
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
933
                new_pack.signature_index.key_count(),
 
934
                time.time() - new_pack.start_time)
 
935
        # copy chk contents
 
936
        # NB XXX: how to check CHK references are present? perhaps by yielding
 
937
        # the items? How should that interact with stacked repos?
 
938
        if new_pack.chk_index is not None:
 
939
            self._copy_chks()
 
940
            if 'pack' in debug.debug_flags:
 
941
                mutter('%s: create_pack: chk content copied: %s%s %d items t+%6.3fs',
 
942
                    time.ctime(), self._pack_collection._upload_transport.base,
 
943
                    new_pack.random_name,
 
944
                    new_pack.chk_index.key_count(),
 
945
                    time.time() - new_pack.start_time)
 
946
        new_pack._check_references()
 
947
        if not self._use_pack(new_pack):
 
948
            new_pack.abort()
 
949
            return None
 
950
        self.pb.update("Finishing pack", 5)
 
951
        new_pack.finish()
 
952
        self._pack_collection.allocate(new_pack)
 
953
        return new_pack
 
954
 
 
955
    def _copy_chks(self, refs=None):
 
956
        # XXX: Todo, recursive follow-pointers facility when fetching some
 
957
        # revisions only.
 
958
        chk_index_map, chk_indices = self._pack_map_and_index_list(
 
959
            'chk_index')
 
960
        chk_nodes = self._index_contents(chk_indices, refs)
 
961
        new_refs = set()
 
962
        # TODO: This isn't strictly tasteful as we are accessing some private
 
963
        #       variables (_serializer). Perhaps a better way would be to have
 
964
        #       Repository._deserialise_chk_node()
 
965
        search_key_func = chk_map.search_key_registry.get(
 
966
            self._pack_collection.repo._serializer.search_key_name)
 
967
        def accumlate_refs(lines):
 
968
            # XXX: move to a generic location
 
969
            # Yay mismatch:
 
970
            bytes = ''.join(lines)
 
971
            node = chk_map._deserialise(bytes, ("unknown",), search_key_func)
 
972
            new_refs.update(node.refs())
 
973
        self._copy_nodes(chk_nodes, chk_index_map, self.new_pack._writer,
 
974
            self.new_pack.chk_index, output_lines=accumlate_refs)
 
975
        return new_refs
 
976
 
 
977
    def _copy_nodes(self, nodes, index_map, writer, write_index,
 
978
        output_lines=None):
 
979
        """Copy knit nodes between packs with no graph references.
 
980
 
 
981
        :param output_lines: Output full texts of copied items.
 
982
        """
 
983
        pb = ui.ui_factory.nested_progress_bar()
 
984
        try:
 
985
            return self._do_copy_nodes(nodes, index_map, writer,
 
986
                write_index, pb, output_lines=output_lines)
 
987
        finally:
 
988
            pb.finished()
 
989
 
 
990
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb,
 
991
        output_lines=None):
 
992
        # for record verification
 
993
        knit = KnitVersionedFiles(None, None)
 
994
        # plan a readv on each source pack:
 
995
        # group by pack
 
996
        nodes = sorted(nodes)
 
997
        # how to map this into knit.py - or knit.py into this?
 
998
        # we don't want the typical knit logic, we want grouping by pack
 
999
        # at this point - perhaps a helper library for the following code
 
1000
        # duplication points?
 
1001
        request_groups = {}
 
1002
        for index, key, value in nodes:
 
1003
            if index not in request_groups:
 
1004
                request_groups[index] = []
 
1005
            request_groups[index].append((key, value))
 
1006
        record_index = 0
 
1007
        pb.update("Copied record", record_index, len(nodes))
 
1008
        for index, items in request_groups.iteritems():
 
1009
            pack_readv_requests = []
 
1010
            for key, value in items:
 
1011
                # ---- KnitGraphIndex.get_position
 
1012
                bits = value[1:].split(' ')
 
1013
                offset, length = int(bits[0]), int(bits[1])
 
1014
                pack_readv_requests.append((offset, length, (key, value[0])))
 
1015
            # linear scan up the pack
 
1016
            pack_readv_requests.sort()
 
1017
            # copy the data
 
1018
            pack_obj = index_map[index]
 
1019
            transport, path = pack_obj.access_tuple()
 
1020
            try:
 
1021
                reader = pack.make_readv_reader(transport, path,
 
1022
                    [offset[0:2] for offset in pack_readv_requests])
 
1023
            except errors.NoSuchFile:
 
1024
                if self._reload_func is not None:
 
1025
                    self._reload_func()
 
1026
                raise
 
1027
            for (names, read_func), (_1, _2, (key, eol_flag)) in \
 
1028
                izip(reader.iter_records(), pack_readv_requests):
 
1029
                raw_data = read_func(None)
 
1030
                # check the header only
 
1031
                if output_lines is not None:
 
1032
                    output_lines(knit._parse_record(key[-1], raw_data)[0])
 
1033
                else:
 
1034
                    df, _ = knit._parse_record_header(key, raw_data)
 
1035
                    df.close()
 
1036
                pos, size = writer.add_bytes_record(raw_data, names)
 
1037
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
 
1038
                pb.update("Copied record", record_index)
 
1039
                record_index += 1
 
1040
 
 
1041
    def _copy_nodes_graph(self, index_map, writer, write_index,
 
1042
        readv_group_iter, total_items, output_lines=False):
 
1043
        """Copy knit nodes between packs.
 
1044
 
 
1045
        :param output_lines: Return lines present in the copied data as
 
1046
            an iterator of line,version_id.
 
1047
        """
 
1048
        pb = ui.ui_factory.nested_progress_bar()
 
1049
        try:
 
1050
            for result in self._do_copy_nodes_graph(index_map, writer,
 
1051
                write_index, output_lines, pb, readv_group_iter, total_items):
 
1052
                yield result
 
1053
        except Exception:
 
1054
            # Python 2.4 does not permit try:finally: in a generator.
 
1055
            pb.finished()
 
1056
            raise
 
1057
        else:
 
1058
            pb.finished()
 
1059
 
 
1060
    def _do_copy_nodes_graph(self, index_map, writer, write_index,
 
1061
        output_lines, pb, readv_group_iter, total_items):
 
1062
        # for record verification
 
1063
        knit = KnitVersionedFiles(None, None)
 
1064
        # for line extraction when requested (inventories only)
 
1065
        if output_lines:
 
1066
            factory = KnitPlainFactory()
 
1067
        record_index = 0
 
1068
        pb.update("Copied record", record_index, total_items)
 
1069
        for index, readv_vector, node_vector in readv_group_iter:
 
1070
            # copy the data
 
1071
            pack_obj = index_map[index]
 
1072
            transport, path = pack_obj.access_tuple()
 
1073
            try:
 
1074
                reader = pack.make_readv_reader(transport, path, readv_vector)
 
1075
            except errors.NoSuchFile:
 
1076
                if self._reload_func is not None:
 
1077
                    self._reload_func()
 
1078
                raise
 
1079
            for (names, read_func), (key, eol_flag, references) in \
 
1080
                izip(reader.iter_records(), node_vector):
 
1081
                raw_data = read_func(None)
 
1082
                if output_lines:
 
1083
                    # read the entire thing
 
1084
                    content, _ = knit._parse_record(key[-1], raw_data)
 
1085
                    if len(references[-1]) == 0:
 
1086
                        line_iterator = factory.get_fulltext_content(content)
 
1087
                    else:
 
1088
                        line_iterator = factory.get_linedelta_content(content)
 
1089
                    for line in line_iterator:
 
1090
                        yield line, key
 
1091
                else:
 
1092
                    # check the header only
 
1093
                    df, _ = knit._parse_record_header(key, raw_data)
 
1094
                    df.close()
 
1095
                pos, size = writer.add_bytes_record(raw_data, names)
 
1096
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size), references)
 
1097
                pb.update("Copied record", record_index)
 
1098
                record_index += 1
 
1099
 
 
1100
    def _get_text_nodes(self):
 
1101
        text_index_map, text_indices = self._pack_map_and_index_list(
 
1102
            'text_index')
 
1103
        return text_index_map, self._index_contents(text_indices,
 
1104
            self._text_filter)
 
1105
 
 
1106
    def _least_readv_node_readv(self, nodes):
 
1107
        """Generate request groups for nodes using the least readv's.
 
1108
 
 
1109
        :param nodes: An iterable of graph index nodes.
 
1110
        :return: Total node count and an iterator of the data needed to perform
 
1111
            readvs to obtain the data for nodes. Each item yielded by the
 
1112
            iterator is a tuple with:
 
1113
            index, readv_vector, node_vector. readv_vector is a list ready to
 
1114
            hand to the transport readv method, and node_vector is a list of
 
1115
            (key, eol_flag, references) for the the node retrieved by the
 
1116
            matching readv_vector.
 
1117
        """
 
1118
        # group by pack so we do one readv per pack
 
1119
        nodes = sorted(nodes)
 
1120
        total = len(nodes)
 
1121
        request_groups = {}
 
1122
        for index, key, value, references in nodes:
 
1123
            if index not in request_groups:
 
1124
                request_groups[index] = []
 
1125
            request_groups[index].append((key, value, references))
 
1126
        result = []
 
1127
        for index, items in request_groups.iteritems():
 
1128
            pack_readv_requests = []
 
1129
            for key, value, references in items:
 
1130
                # ---- KnitGraphIndex.get_position
 
1131
                bits = value[1:].split(' ')
 
1132
                offset, length = int(bits[0]), int(bits[1])
 
1133
                pack_readv_requests.append(
 
1134
                    ((offset, length), (key, value[0], references)))
 
1135
            # linear scan up the pack to maximum range combining.
 
1136
            pack_readv_requests.sort()
 
1137
            # split out the readv and the node data.
 
1138
            pack_readv = [readv for readv, node in pack_readv_requests]
 
1139
            node_vector = [node for readv, node in pack_readv_requests]
 
1140
            result.append((index, pack_readv, node_vector))
 
1141
        return total, result
752
1142
 
753
1143
    def _log_copied_texts(self):
754
1144
        if 'pack' in debug.debug_flags:
758
1148
                self.new_pack.text_index.key_count(),
759
1149
                time.time() - self.new_pack.start_time)
760
1150
 
 
1151
    def _process_inventory_lines(self, inv_lines):
 
1152
        """Use up the inv_lines generator and setup a text key filter."""
 
1153
        repo = self._pack_collection.repo
 
1154
        fileid_revisions = repo._find_file_ids_from_xml_inventory_lines(
 
1155
            inv_lines, self.revision_keys)
 
1156
        text_filter = []
 
1157
        for fileid, file_revids in fileid_revisions.iteritems():
 
1158
            text_filter.extend([(fileid, file_revid) for file_revid in file_revids])
 
1159
        self._text_filter = text_filter
 
1160
 
 
1161
    def _revision_node_readv(self, revision_nodes):
 
1162
        """Return the total revisions and the readv's to issue.
 
1163
 
 
1164
        :param revision_nodes: The revision index contents for the packs being
 
1165
            incorporated into the new pack.
 
1166
        :return: As per _least_readv_node_readv.
 
1167
        """
 
1168
        return self._least_readv_node_readv(revision_nodes)
 
1169
 
761
1170
    def _use_pack(self, new_pack):
762
1171
        """Return True if new_pack should be used.
763
1172
 
767
1176
        return new_pack.data_inserted()
768
1177
 
769
1178
 
 
1179
class OptimisingPacker(Packer):
 
1180
    """A packer which spends more time to create better disk layouts."""
 
1181
 
 
1182
    def _revision_node_readv(self, revision_nodes):
 
1183
        """Return the total revisions and the readv's to issue.
 
1184
 
 
1185
        This sort places revisions in topological order with the ancestors
 
1186
        after the children.
 
1187
 
 
1188
        :param revision_nodes: The revision index contents for the packs being
 
1189
            incorporated into the new pack.
 
1190
        :return: As per _least_readv_node_readv.
 
1191
        """
 
1192
        # build an ancestors dict
 
1193
        ancestors = {}
 
1194
        by_key = {}
 
1195
        for index, key, value, references in revision_nodes:
 
1196
            ancestors[key] = references[0]
 
1197
            by_key[key] = (index, value, references)
 
1198
        order = tsort.topo_sort(ancestors)
 
1199
        total = len(order)
 
1200
        # Single IO is pathological, but it will work as a starting point.
 
1201
        requests = []
 
1202
        for key in reversed(order):
 
1203
            index, value, references = by_key[key]
 
1204
            # ---- KnitGraphIndex.get_position
 
1205
            bits = value[1:].split(' ')
 
1206
            offset, length = int(bits[0]), int(bits[1])
 
1207
            requests.append(
 
1208
                (index, [(offset, length)], [(key, value[0], references)]))
 
1209
        # TODO: combine requests in the same index that are in ascending order.
 
1210
        return total, requests
 
1211
 
 
1212
    def open_pack(self):
 
1213
        """Open a pack for the pack we are creating."""
 
1214
        new_pack = super(OptimisingPacker, self).open_pack()
 
1215
        # Turn on the optimization flags for all the index builders.
 
1216
        new_pack.revision_index.set_optimize(for_size=True)
 
1217
        new_pack.inventory_index.set_optimize(for_size=True)
 
1218
        new_pack.text_index.set_optimize(for_size=True)
 
1219
        new_pack.signature_index.set_optimize(for_size=True)
 
1220
        return new_pack
 
1221
 
 
1222
 
 
1223
class ReconcilePacker(Packer):
 
1224
    """A packer which regenerates indices etc as it copies.
 
1225
 
 
1226
    This is used by ``bzr reconcile`` to cause parent text pointers to be
 
1227
    regenerated.
 
1228
    """
 
1229
 
 
1230
    def _extra_init(self):
 
1231
        self._data_changed = False
 
1232
 
 
1233
    def _process_inventory_lines(self, inv_lines):
 
1234
        """Generate a text key reference map rather for reconciling with."""
 
1235
        repo = self._pack_collection.repo
 
1236
        refs = repo._find_text_key_references_from_xml_inventory_lines(
 
1237
            inv_lines)
 
1238
        self._text_refs = refs
 
1239
        # during reconcile we:
 
1240
        #  - convert unreferenced texts to full texts
 
1241
        #  - correct texts which reference a text not copied to be full texts
 
1242
        #  - copy all others as-is but with corrected parents.
 
1243
        #  - so at this point we don't know enough to decide what becomes a full
 
1244
        #    text.
 
1245
        self._text_filter = None
 
1246
 
 
1247
    def _copy_text_texts(self):
 
1248
        """generate what texts we should have and then copy."""
 
1249
        self.pb.update("Copying content texts", 3)
 
1250
        # we have three major tasks here:
 
1251
        # 1) generate the ideal index
 
1252
        repo = self._pack_collection.repo
 
1253
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
 
1254
            _1, key, _2, refs in
 
1255
            self.new_pack.revision_index.iter_all_entries()])
 
1256
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
 
1257
        # 2) generate a text_nodes list that contains all the deltas that can
 
1258
        #    be used as-is, with corrected parents.
 
1259
        ok_nodes = []
 
1260
        bad_texts = []
 
1261
        discarded_nodes = []
 
1262
        NULL_REVISION = _mod_revision.NULL_REVISION
 
1263
        text_index_map, text_nodes = self._get_text_nodes()
 
1264
        for node in text_nodes:
 
1265
            # 0 - index
 
1266
            # 1 - key
 
1267
            # 2 - value
 
1268
            # 3 - refs
 
1269
            try:
 
1270
                ideal_parents = tuple(ideal_index[node[1]])
 
1271
            except KeyError:
 
1272
                discarded_nodes.append(node)
 
1273
                self._data_changed = True
 
1274
            else:
 
1275
                if ideal_parents == (NULL_REVISION,):
 
1276
                    ideal_parents = ()
 
1277
                if ideal_parents == node[3][0]:
 
1278
                    # no change needed.
 
1279
                    ok_nodes.append(node)
 
1280
                elif ideal_parents[0:1] == node[3][0][0:1]:
 
1281
                    # the left most parent is the same, or there are no parents
 
1282
                    # today. Either way, we can preserve the representation as
 
1283
                    # long as we change the refs to be inserted.
 
1284
                    self._data_changed = True
 
1285
                    ok_nodes.append((node[0], node[1], node[2],
 
1286
                        (ideal_parents, node[3][1])))
 
1287
                    self._data_changed = True
 
1288
                else:
 
1289
                    # Reinsert this text completely
 
1290
                    bad_texts.append((node[1], ideal_parents))
 
1291
                    self._data_changed = True
 
1292
        # we're finished with some data.
 
1293
        del ideal_index
 
1294
        del text_nodes
 
1295
        # 3) bulk copy the ok data
 
1296
        total_items, readv_group_iter = self._least_readv_node_readv(ok_nodes)
 
1297
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
 
1298
            self.new_pack.text_index, readv_group_iter, total_items))
 
1299
        # 4) adhoc copy all the other texts.
 
1300
        # We have to topologically insert all texts otherwise we can fail to
 
1301
        # reconcile when parts of a single delta chain are preserved intact,
 
1302
        # and other parts are not. E.g. Discarded->d1->d2->d3. d1 will be
 
1303
        # reinserted, and if d3 has incorrect parents it will also be
 
1304
        # reinserted. If we insert d3 first, d2 is present (as it was bulk
 
1305
        # copied), so we will try to delta, but d2 is not currently able to be
 
1306
        # extracted because it's basis d1 is not present. Topologically sorting
 
1307
        # addresses this. The following generates a sort for all the texts that
 
1308
        # are being inserted without having to reference the entire text key
 
1309
        # space (we only topo sort the revisions, which is smaller).
 
1310
        topo_order = tsort.topo_sort(ancestors)
 
1311
        rev_order = dict(zip(topo_order, range(len(topo_order))))
 
1312
        bad_texts.sort(key=lambda key:rev_order.get(key[0][1], 0))
 
1313
        transaction = repo.get_transaction()
 
1314
        file_id_index = GraphIndexPrefixAdapter(
 
1315
            self.new_pack.text_index,
 
1316
            ('blank', ), 1,
 
1317
            add_nodes_callback=self.new_pack.text_index.add_nodes)
 
1318
        data_access = _DirectPackAccess(
 
1319
                {self.new_pack.text_index:self.new_pack.access_tuple()})
 
1320
        data_access.set_writer(self.new_pack._writer, self.new_pack.text_index,
 
1321
            self.new_pack.access_tuple())
 
1322
        output_texts = KnitVersionedFiles(
 
1323
            _KnitGraphIndex(self.new_pack.text_index,
 
1324
                add_callback=self.new_pack.text_index.add_nodes,
 
1325
                deltas=True, parents=True, is_locked=repo.is_locked),
 
1326
            data_access=data_access, max_delta_chain=200)
 
1327
        for key, parent_keys in bad_texts:
 
1328
            # We refer to the new pack to delta data being output.
 
1329
            # A possible improvement would be to catch errors on short reads
 
1330
            # and only flush then.
 
1331
            self.new_pack.flush()
 
1332
            parents = []
 
1333
            for parent_key in parent_keys:
 
1334
                if parent_key[0] != key[0]:
 
1335
                    # Graph parents must match the fileid
 
1336
                    raise errors.BzrError('Mismatched key parent %r:%r' %
 
1337
                        (key, parent_keys))
 
1338
                parents.append(parent_key[1])
 
1339
            text_lines = osutils.split_lines(repo.texts.get_record_stream(
 
1340
                [key], 'unordered', True).next().get_bytes_as('fulltext'))
 
1341
            output_texts.add_lines(key, parent_keys, text_lines,
 
1342
                random_id=True, check_content=False)
 
1343
        # 5) check that nothing inserted has a reference outside the keyspace.
 
1344
        missing_text_keys = self.new_pack.text_index._external_references()
 
1345
        if missing_text_keys:
 
1346
            raise errors.BzrCheckError('Reference to missing compression parents %r'
 
1347
                % (missing_text_keys,))
 
1348
        self._log_copied_texts()
 
1349
 
 
1350
    def _use_pack(self, new_pack):
 
1351
        """Override _use_pack to check for reconcile having changed content."""
 
1352
        # XXX: we might be better checking this at the copy time.
 
1353
        original_inventory_keys = set()
 
1354
        inv_index = self._pack_collection.inventory_index.combined_index
 
1355
        for entry in inv_index.iter_all_entries():
 
1356
            original_inventory_keys.add(entry[1])
 
1357
        new_inventory_keys = set()
 
1358
        for entry in new_pack.inventory_index.iter_all_entries():
 
1359
            new_inventory_keys.add(entry[1])
 
1360
        if new_inventory_keys != original_inventory_keys:
 
1361
            self._data_changed = True
 
1362
        return new_pack.data_inserted() and self._data_changed
 
1363
 
 
1364
 
770
1365
class RepositoryPackCollection(object):
771
1366
    """Management of packs within a repository.
772
1367
 
773
1368
    :ivar _names: map of {pack_name: (index_size,)}
774
1369
    """
775
1370
 
776
 
    pack_factory = None
777
 
    resumed_pack_factory = None
778
 
    normal_packer_class = None
779
 
    optimising_packer_class = None
 
1371
    pack_factory = NewPack
 
1372
    resumed_pack_factory = ResumedPack
780
1373
 
781
1374
    def __init__(self, repo, transport, index_transport, upload_transport,
782
1375
                 pack_transport, index_builder_class, index_class,
817
1410
        self.inventory_index = AggregateIndex(self.reload_pack_names, flush)
818
1411
        self.text_index = AggregateIndex(self.reload_pack_names, flush)
819
1412
        self.signature_index = AggregateIndex(self.reload_pack_names, flush)
820
 
        all_indices = [self.revision_index, self.inventory_index,
821
 
                self.text_index, self.signature_index]
822
1413
        if use_chk_index:
823
1414
            self.chk_index = AggregateIndex(self.reload_pack_names, flush)
824
 
            all_indices.append(self.chk_index)
825
1415
        else:
826
1416
            # used to determine if we're using a chk_index elsewhere.
827
1417
            self.chk_index = None
828
 
        # Tell all the CombinedGraphIndex objects about each other, so they can
829
 
        # share hints about which pack names to search first.
830
 
        all_combined = [agg_idx.combined_index for agg_idx in all_indices]
831
 
        for combined_idx in all_combined:
832
 
            combined_idx.set_sibling_indices(
833
 
                set(all_combined).difference([combined_idx]))
834
1418
        # resumed packs
835
1419
        self._resumed_packs = []
836
 
        self.config_stack = config.LocationStack(self.transport.base)
837
 
 
838
 
    def __repr__(self):
839
 
        return '%s(%r)' % (self.__class__.__name__, self.repo)
840
1420
 
841
1421
    def add_pack_to_memory(self, pack):
842
1422
        """Make a Pack object available to the repository to satisfy queries.
924
1504
            'containing %d revisions. Packing %d files into %d affecting %d'
925
1505
            ' revisions', self, total_packs, total_revisions, num_old_packs,
926
1506
            num_new_packs, num_revs_affected)
927
 
        result = self._execute_pack_operations(pack_operations, packer_class=self.normal_packer_class,
 
1507
        result = self._execute_pack_operations(pack_operations,
928
1508
                                      reload_func=self._restart_autopack)
929
1509
        mutter('Auto-packing repository %s completed', self)
930
1510
        return result
931
1511
 
932
 
    def _execute_pack_operations(self, pack_operations, packer_class,
933
 
            reload_func=None):
 
1512
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
 
1513
                                 reload_func=None):
934
1514
        """Execute a series of pack operations.
935
1515
 
936
1516
        :param pack_operations: A list of [revision_count, packs_to_combine].
937
 
        :param packer_class: The class of packer to use
 
1517
        :param _packer_class: The class of packer to use (default: Packer).
938
1518
        :return: The new pack names.
939
1519
        """
940
1520
        for revision_count, packs in pack_operations:
941
1521
            # we may have no-ops from the setup logic
942
1522
            if len(packs) == 0:
943
1523
                continue
944
 
            packer = packer_class(self, packs, '.autopack',
 
1524
            packer = _packer_class(self, packs, '.autopack',
945
1525
                                   reload_func=reload_func)
946
1526
            try:
947
 
                result = packer.pack()
 
1527
                packer.pack()
948
1528
            except errors.RetryWithNewPacks:
949
1529
                # An exception is propagating out of this context, make sure
950
1530
                # this packer has cleaned up. Packer() doesn't set its new_pack
953
1533
                if packer.new_pack is not None:
954
1534
                    packer.new_pack.abort()
955
1535
                raise
956
 
            if result is None:
957
 
                return
958
1536
            for pack in packs:
959
1537
                self._remove_pack_from_memory(pack)
960
1538
        # record the newly available packs and stop advertising the old
961
1539
        # packs
962
 
        to_be_obsoleted = []
963
 
        for _, packs in pack_operations:
964
 
            to_be_obsoleted.extend(packs)
965
 
        result = self._save_pack_names(clear_obsolete_packs=True,
966
 
                                       obsolete_packs=to_be_obsoleted)
 
1540
        result = self._save_pack_names(clear_obsolete_packs=True)
 
1541
        # Move the old packs out of the way now they are no longer referenced.
 
1542
        for revision_count, packs in pack_operations:
 
1543
            self._obsolete_packs(packs)
967
1544
        return result
968
1545
 
969
1546
    def _flush_new_pack(self):
982
1559
        """Is the collection already packed?"""
983
1560
        return not (self.repo._format.pack_compresses or (len(self._names) > 1))
984
1561
 
985
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1562
    def pack(self, hint=None):
986
1563
        """Pack the pack collection totally."""
987
1564
        self.ensure_loaded()
988
1565
        total_packs = len(self._names)
994
1571
        mutter('Packing repository %s, which has %d pack files, '
995
1572
            'containing %d revisions with hint %r.', self, total_packs,
996
1573
            total_revisions, hint)
997
 
        while True:
998
 
            try:
999
 
                self._try_pack_operations(hint)
1000
 
            except RetryPackOperations:
1001
 
                continue
1002
 
            break
1003
 
 
1004
 
        if clean_obsolete_packs:
1005
 
            self._clear_obsolete_packs()
1006
 
 
1007
 
    def _try_pack_operations(self, hint):
1008
 
        """Calculate the pack operations based on the hint (if any), and
1009
 
        execute them.
1010
 
        """
1011
1574
        # determine which packs need changing
1012
1575
        pack_operations = [[0, []]]
1013
1576
        for pack in self.all_packs():
1016
1579
                # or this pack was included in the hint.
1017
1580
                pack_operations[-1][0] += pack.get_revision_count()
1018
1581
                pack_operations[-1][1].append(pack)
1019
 
        self._execute_pack_operations(pack_operations,
1020
 
            packer_class=self.optimising_packer_class,
1021
 
            reload_func=self._restart_pack_operations)
 
1582
        self._execute_pack_operations(pack_operations, OptimisingPacker)
1022
1583
 
1023
1584
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1024
1585
        """Plan a pack operation.
1034
1595
        pack_operations = [[0, []]]
1035
1596
        # plan out what packs to keep, and what to reorganise
1036
1597
        while len(existing_packs):
1037
 
            # take the largest pack, and if it's less than the head of the
 
1598
            # take the largest pack, and if its less than the head of the
1038
1599
            # distribution chart we will include its contents in the new pack
1039
 
            # for that position. If it's larger, we remove its size from the
 
1600
            # for that position. If its larger, we remove its size from the
1040
1601
            # distribution chart
1041
1602
            next_pack_rev_count, next_pack = existing_packs.pop(0)
1042
1603
            if next_pack_rev_count >= pack_distribution[0]:
1077
1638
 
1078
1639
        :return: True if the disk names had not been previously read.
1079
1640
        """
1080
 
        # NB: if you see an assertion error here, it's probably access against
 
1641
        # NB: if you see an assertion error here, its probably access against
1081
1642
        # an unlocked repo. Naughty.
1082
1643
        if not self.repo.is_locked():
1083
1644
            raise errors.ObjectNotLocked(self.repo)
1113
1674
            txt_index = self._make_index(name, '.tix')
1114
1675
            sig_index = self._make_index(name, '.six')
1115
1676
            if self.chk_index is not None:
1116
 
                chk_index = self._make_index(name, '.cix', is_chk=True)
 
1677
                chk_index = self._make_index(name, '.cix')
1117
1678
            else:
1118
1679
                chk_index = None
1119
1680
            result = ExistingPack(self._pack_transport, name, rev_index,
1138
1699
            txt_index = self._make_index(name, '.tix', resume=True)
1139
1700
            sig_index = self._make_index(name, '.six', resume=True)
1140
1701
            if self.chk_index is not None:
1141
 
                chk_index = self._make_index(name, '.cix', resume=True,
1142
 
                                             is_chk=True)
 
1702
                chk_index = self._make_index(name, '.cix', resume=True)
1143
1703
            else:
1144
1704
                chk_index = None
1145
1705
            result = self.resumed_pack_factory(name, rev_index, inv_index,
1175
1735
        return self._index_class(self.transport, 'pack-names', None
1176
1736
                ).iter_all_entries()
1177
1737
 
1178
 
    def _make_index(self, name, suffix, resume=False, is_chk=False):
 
1738
    def _make_index(self, name, suffix, resume=False):
1179
1739
        size_offset = self._suffix_offsets[suffix]
1180
1740
        index_name = name + suffix
1181
1741
        if resume:
1184
1744
        else:
1185
1745
            transport = self._index_transport
1186
1746
            index_size = self._names[name][size_offset]
1187
 
        index = self._index_class(transport, index_name, index_size,
1188
 
                                  unlimited_cache=is_chk)
1189
 
        if is_chk and self._index_class is btree_index.BTreeGraphIndex: 
1190
 
            index._leaf_factory = btree_index._gcchk_factory
1191
 
        return index
 
1747
        return self._index_class(transport, index_name, index_size)
1192
1748
 
1193
1749
    def _max_pack_count(self, total_revisions):
1194
1750
        """Return the maximum number of packs to use for total revisions.
1222
1778
        :param return: None.
1223
1779
        """
1224
1780
        for pack in packs:
1225
 
            try:
1226
 
                try:
1227
 
                    pack.pack_transport.move(pack.file_name(),
1228
 
                        '../obsolete_packs/' + pack.file_name())
1229
 
                except errors.NoSuchFile:
1230
 
                    # perhaps obsolete_packs was removed? Let's create it and
1231
 
                    # try again
1232
 
                    try:
1233
 
                        pack.pack_transport.mkdir('../obsolete_packs/')
1234
 
                    except errors.FileExists:
1235
 
                        pass
1236
 
                    pack.pack_transport.move(pack.file_name(),
1237
 
                        '../obsolete_packs/' + pack.file_name())
1238
 
            except (errors.PathError, errors.TransportError), e:
1239
 
                # TODO: Should these be warnings or mutters?
1240
 
                mutter("couldn't rename obsolete pack, skipping it:\n%s"
1241
 
                       % (e,))
 
1781
            pack.pack_transport.rename(pack.file_name(),
 
1782
                '../obsolete_packs/' + pack.file_name())
1242
1783
            # TODO: Probably needs to know all possible indices for this pack
1243
1784
            # - or maybe list the directory and move all indices matching this
1244
1785
            # name whether we recognize it or not?
1246
1787
            if self.chk_index is not None:
1247
1788
                suffixes.append('.cix')
1248
1789
            for suffix in suffixes:
1249
 
                try:
1250
 
                    self._index_transport.move(pack.name + suffix,
1251
 
                        '../obsolete_packs/' + pack.name + suffix)
1252
 
                except (errors.PathError, errors.TransportError), e:
1253
 
                    mutter("couldn't rename obsolete index, skipping it:\n%s"
1254
 
                           % (e,))
 
1790
                self._index_transport.rename(pack.name + suffix,
 
1791
                    '../obsolete_packs/' + pack.name + suffix)
1255
1792
 
1256
1793
    def pack_distribution(self, total_revisions):
1257
1794
        """Generate a list of the number of revisions to put in each pack.
1283
1820
        self._remove_pack_indices(pack)
1284
1821
        self.packs.remove(pack)
1285
1822
 
1286
 
    def _remove_pack_indices(self, pack, ignore_missing=False):
1287
 
        """Remove the indices for pack from the aggregated indices.
1288
 
        
1289
 
        :param ignore_missing: Suppress KeyErrors from calling remove_index.
1290
 
        """
1291
 
        for index_type in Pack.index_definitions.keys():
1292
 
            attr_name = index_type + '_index'
1293
 
            aggregate_index = getattr(self, attr_name)
1294
 
            if aggregate_index is not None:
1295
 
                pack_index = getattr(pack, attr_name)
1296
 
                try:
1297
 
                    aggregate_index.remove_index(pack_index)
1298
 
                except KeyError:
1299
 
                    if ignore_missing:
1300
 
                        continue
1301
 
                    raise
 
1823
    def _remove_pack_indices(self, pack):
 
1824
        """Remove the indices for pack from the aggregated indices."""
 
1825
        self.revision_index.remove_index(pack.revision_index, pack)
 
1826
        self.inventory_index.remove_index(pack.inventory_index, pack)
 
1827
        self.text_index.remove_index(pack.text_index, pack)
 
1828
        self.signature_index.remove_index(pack.signature_index, pack)
 
1829
        if self.chk_index is not None:
 
1830
            self.chk_index.remove_index(pack.chk_index, pack)
1302
1831
 
1303
1832
    def reset(self):
1304
1833
        """Clear all cached data."""
1337
1866
        disk_nodes = set()
1338
1867
        for index, key, value in self._iter_disk_pack_index():
1339
1868
            disk_nodes.add((key, value))
1340
 
        orig_disk_nodes = set(disk_nodes)
1341
1869
 
1342
1870
        # do a two-way diff against our original content
1343
1871
        current_nodes = set()
1356
1884
        disk_nodes.difference_update(deleted_nodes)
1357
1885
        disk_nodes.update(new_nodes)
1358
1886
 
1359
 
        return disk_nodes, deleted_nodes, new_nodes, orig_disk_nodes
 
1887
        return disk_nodes, deleted_nodes, new_nodes
1360
1888
 
1361
1889
    def _syncronize_pack_names_from_disk_nodes(self, disk_nodes):
1362
1890
        """Given the correct set of pack files, update our saved info.
1390
1918
                    # disk index because the set values are the same, unless
1391
1919
                    # the only index shows up as deleted by the set difference
1392
1920
                    # - which it may. Until there is a specific test for this,
1393
 
                    # assume it's broken. RBC 20071017.
 
1921
                    # assume its broken. RBC 20071017.
1394
1922
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
1395
1923
                    self._names[name] = sizes
1396
1924
                    self.get_pack_by_name(name)
1402
1930
                added.append(name)
1403
1931
        return removed, added, modified
1404
1932
 
1405
 
    def _save_pack_names(self, clear_obsolete_packs=False, obsolete_packs=None):
 
1933
    def _save_pack_names(self, clear_obsolete_packs=False):
1406
1934
        """Save the list of packs.
1407
1935
 
1408
1936
        This will take out the mutex around the pack names list for the
1412
1940
 
1413
1941
        :param clear_obsolete_packs: If True, clear out the contents of the
1414
1942
            obsolete_packs directory.
1415
 
        :param obsolete_packs: Packs that are obsolete once the new pack-names
1416
 
            file has been written.
1417
1943
        :return: A list of the names saved that were not previously on disk.
1418
1944
        """
1419
 
        already_obsolete = []
1420
1945
        self.lock_names()
1421
1946
        try:
1422
1947
            builder = self._index_builder_class()
1423
 
            (disk_nodes, deleted_nodes, new_nodes,
1424
 
             orig_disk_nodes) = self._diff_pack_names()
 
1948
            disk_nodes, deleted_nodes, new_nodes = self._diff_pack_names()
1425
1949
            # TODO: handle same-name, index-size-changes here -
1426
1950
            # e.g. use the value from disk, not ours, *unless* we're the one
1427
1951
            # changing it.
1429
1953
                builder.add_node(key, value)
1430
1954
            self.transport.put_file('pack-names', builder.finish(),
1431
1955
                mode=self.repo.bzrdir._get_file_mode())
 
1956
            # move the baseline forward
1432
1957
            self._packs_at_load = disk_nodes
1433
1958
            if clear_obsolete_packs:
1434
 
                to_preserve = None
1435
 
                if obsolete_packs:
1436
 
                    to_preserve = set([o.name for o in obsolete_packs])
1437
 
                already_obsolete = self._clear_obsolete_packs(to_preserve)
 
1959
                self._clear_obsolete_packs()
1438
1960
        finally:
1439
1961
            self._unlock_names()
1440
1962
        # synchronise the memory packs list with what we just wrote:
1441
1963
        self._syncronize_pack_names_from_disk_nodes(disk_nodes)
1442
 
        if obsolete_packs:
1443
 
            # TODO: We could add one more condition here. "if o.name not in
1444
 
            #       orig_disk_nodes and o != the new_pack we haven't written to
1445
 
            #       disk yet. However, the new pack object is not easily
1446
 
            #       accessible here (it would have to be passed through the
1447
 
            #       autopacking code, etc.)
1448
 
            obsolete_packs = [o for o in obsolete_packs
1449
 
                              if o.name not in already_obsolete]
1450
 
            self._obsolete_packs(obsolete_packs)
1451
1964
        return [new_node[0][0] for new_node in new_nodes]
1452
1965
 
1453
1966
    def reload_pack_names(self):
1461
1974
        """
1462
1975
        # The ensure_loaded call is to handle the case where the first call
1463
1976
        # made involving the collection was to reload_pack_names, where we 
1464
 
        # don't have a view of disk contents. It's a bit of a bandaid, and
1465
 
        # causes two reads of pack-names, but it's a rare corner case not
1466
 
        # struck with regular push/pull etc.
 
1977
        # don't have a view of disk contents. Its a bit of a bandaid, and
 
1978
        # causes two reads of pack-names, but its a rare corner case not struck
 
1979
        # with regular push/pull etc.
1467
1980
        first_read = self.ensure_loaded()
1468
1981
        if first_read:
1469
1982
            return True
1470
1983
        # out the new value.
1471
 
        (disk_nodes, deleted_nodes, new_nodes,
1472
 
         orig_disk_nodes) = self._diff_pack_names()
1473
 
        # _packs_at_load is meant to be the explicit list of names in
1474
 
        # 'pack-names' at then start. As such, it should not contain any
1475
 
        # pending names that haven't been written out yet.
1476
 
        self._packs_at_load = orig_disk_nodes
 
1984
        disk_nodes, _, _ = self._diff_pack_names()
 
1985
        self._packs_at_load = disk_nodes
1477
1986
        (removed, added,
1478
1987
         modified) = self._syncronize_pack_names_from_disk_nodes(disk_nodes)
1479
1988
        if removed or added or modified:
1488
1997
            raise
1489
1998
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
1490
1999
 
1491
 
    def _restart_pack_operations(self):
1492
 
        """Reload the pack names list, and restart the autopack code."""
1493
 
        if not self.reload_pack_names():
1494
 
            # Re-raise the original exception, because something went missing
1495
 
            # and a restart didn't find it
1496
 
            raise
1497
 
        raise RetryPackOperations(self.repo, False, sys.exc_info())
1498
 
 
1499
 
    def _clear_obsolete_packs(self, preserve=None):
 
2000
    def _clear_obsolete_packs(self):
1500
2001
        """Delete everything from the obsolete-packs directory.
1501
 
 
1502
 
        :return: A list of pack identifiers (the filename without '.pack') that
1503
 
            were found in obsolete_packs.
1504
2002
        """
1505
 
        found = []
1506
2003
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
1507
 
        if preserve is None:
1508
 
            preserve = set()
1509
 
        try:
1510
 
            obsolete_pack_files = obsolete_pack_transport.list_dir('.')
1511
 
        except errors.NoSuchFile:
1512
 
            return found
1513
 
        for filename in obsolete_pack_files:
1514
 
            name, ext = osutils.splitext(filename)
1515
 
            if ext == '.pack':
1516
 
                found.append(name)
1517
 
            if name in preserve:
1518
 
                continue
 
2004
        for filename in obsolete_pack_transport.list_dir('.'):
1519
2005
            try:
1520
2006
                obsolete_pack_transport.delete(filename)
1521
2007
            except (errors.PathError, errors.TransportError), e:
1522
 
                warning("couldn't delete obsolete pack, skipping it:\n%s"
1523
 
                        % (e,))
1524
 
        return found
 
2008
                warning("couldn't delete obsolete pack, skipping it:\n%s" % (e,))
1525
2009
 
1526
2010
    def _start_write_group(self):
1527
2011
        # Do not permit preparation for writing if we're not in a 'write lock'.
1554
2038
        # FIXME: just drop the transient index.
1555
2039
        # forget what names there are
1556
2040
        if self._new_pack is not None:
1557
 
            operation = cleanup.OperationWithCleanups(self._new_pack.abort)
1558
 
            operation.add_cleanup(setattr, self, '_new_pack', None)
1559
 
            # If we aborted while in the middle of finishing the write
1560
 
            # group, _remove_pack_indices could fail because the indexes are
1561
 
            # already gone.  But they're not there we shouldn't fail in this
1562
 
            # case, so we pass ignore_missing=True.
1563
 
            operation.add_cleanup(self._remove_pack_indices, self._new_pack,
1564
 
                ignore_missing=True)
1565
 
            operation.run_simple()
 
2041
            try:
 
2042
                self._new_pack.abort()
 
2043
            finally:
 
2044
                # XXX: If we aborted while in the middle of finishing the write
 
2045
                # group, _remove_pack_indices can fail because the indexes are
 
2046
                # already gone.  If they're not there we shouldn't fail in this
 
2047
                # case.  -- mbp 20081113
 
2048
                self._remove_pack_indices(self._new_pack)
 
2049
                self._new_pack = None
1566
2050
        for resumed_pack in self._resumed_packs:
1567
 
            operation = cleanup.OperationWithCleanups(resumed_pack.abort)
1568
 
            # See comment in previous finally block.
1569
 
            operation.add_cleanup(self._remove_pack_indices, resumed_pack,
1570
 
                ignore_missing=True)
1571
 
            operation.run_simple()
 
2051
            try:
 
2052
                resumed_pack.abort()
 
2053
            finally:
 
2054
                # See comment in previous finally block.
 
2055
                try:
 
2056
                    self._remove_pack_indices(resumed_pack)
 
2057
                except KeyError:
 
2058
                    pass
1572
2059
        del self._resumed_packs[:]
1573
2060
 
1574
2061
    def _remove_resumed_pack_indices(self):
1579
2066
    def _check_new_inventories(self):
1580
2067
        """Detect missing inventories in this write group.
1581
2068
 
1582
 
        :returns: list of strs, summarising any problems found.  If the list is
1583
 
            empty no problems were found.
 
2069
        :returns: set of missing keys.  Note that not every missing key is
 
2070
            guaranteed to be reported.
1584
2071
        """
1585
2072
        # The base implementation does no checks.  GCRepositoryPackCollection
1586
2073
        # overrides this.
1587
 
        return []
 
2074
        return set()
1588
2075
        
1589
2076
    def _commit_write_group(self):
1590
2077
        all_missing = set()
1600
2087
            raise errors.BzrCheckError(
1601
2088
                "Repository %s has missing compression parent(s) %r "
1602
2089
                 % (self.repo, sorted(all_missing)))
1603
 
        problems = self._check_new_inventories()
1604
 
        if problems:
1605
 
            problems_summary = '\n'.join(problems)
 
2090
        all_missing = self._check_new_inventories()
 
2091
        if all_missing:
1606
2092
            raise errors.BzrCheckError(
1607
 
                "Cannot add revision(s) to repository: " + problems_summary)
 
2093
                "Repository %s missing keys for new revisions %r "
 
2094
                 % (self.repo, sorted(all_missing)))
1608
2095
        self._remove_pack_indices(self._new_pack)
1609
2096
        any_new_content = False
1610
2097
        if self._new_pack.data_inserted():
1653
2140
            self._resume_pack(token)
1654
2141
 
1655
2142
 
1656
 
class PackRepository(MetaDirVersionedFileRepository):
 
2143
class KnitPackRepository(KnitRepository):
1657
2144
    """Repository with knit objects stored inside pack containers.
1658
2145
 
1659
2146
    The layering for a KnitPackRepository is:
1662
2149
    ===================================================
1663
2150
    Tuple based apis below, string based, and key based apis above
1664
2151
    ---------------------------------------------------
1665
 
    VersionedFiles
 
2152
    KnitVersionedFiles
1666
2153
      Provides .texts, .revisions etc
1667
2154
      This adapts the N-tuple keys to physical knit records which only have a
1668
2155
      single string identifier (for historical reasons), which in older formats
1678
2165
 
1679
2166
    """
1680
2167
 
1681
 
    # These attributes are inherited from the Repository base class. Setting
1682
 
    # them to None ensures that if the constructor is changed to not initialize
1683
 
    # them, or a subclass fails to call the constructor, that an error will
1684
 
    # occur rather than the system working but generating incorrect data.
1685
 
    _commit_builder_class = None
1686
 
    _serializer = None
1687
 
 
1688
2168
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
1689
2169
        _serializer):
1690
 
        MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
1691
 
        self._commit_builder_class = _commit_builder_class
1692
 
        self._serializer = _serializer
 
2170
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
 
2171
            _commit_builder_class, _serializer)
 
2172
        index_transport = self._transport.clone('indices')
 
2173
        self._pack_collection = RepositoryPackCollection(self, self._transport,
 
2174
            index_transport,
 
2175
            self._transport.clone('upload'),
 
2176
            self._transport.clone('packs'),
 
2177
            _format.index_builder_class,
 
2178
            _format.index_class,
 
2179
            use_chk_index=self._format.supports_chks,
 
2180
            )
 
2181
        self.inventories = KnitVersionedFiles(
 
2182
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
 
2183
                add_callback=self._pack_collection.inventory_index.add_callback,
 
2184
                deltas=True, parents=True, is_locked=self.is_locked),
 
2185
            data_access=self._pack_collection.inventory_index.data_access,
 
2186
            max_delta_chain=200)
 
2187
        self.revisions = KnitVersionedFiles(
 
2188
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
 
2189
                add_callback=self._pack_collection.revision_index.add_callback,
 
2190
                deltas=False, parents=True, is_locked=self.is_locked,
 
2191
                track_external_parent_refs=True),
 
2192
            data_access=self._pack_collection.revision_index.data_access,
 
2193
            max_delta_chain=0)
 
2194
        self.signatures = KnitVersionedFiles(
 
2195
            _KnitGraphIndex(self._pack_collection.signature_index.combined_index,
 
2196
                add_callback=self._pack_collection.signature_index.add_callback,
 
2197
                deltas=False, parents=False, is_locked=self.is_locked),
 
2198
            data_access=self._pack_collection.signature_index.data_access,
 
2199
            max_delta_chain=0)
 
2200
        self.texts = KnitVersionedFiles(
 
2201
            _KnitGraphIndex(self._pack_collection.text_index.combined_index,
 
2202
                add_callback=self._pack_collection.text_index.add_callback,
 
2203
                deltas=True, parents=True, is_locked=self.is_locked),
 
2204
            data_access=self._pack_collection.text_index.data_access,
 
2205
            max_delta_chain=200)
 
2206
        if _format.supports_chks:
 
2207
            # No graph, no compression:- references from chks are between
 
2208
            # different objects not temporal versions of the same; and without
 
2209
            # some sort of temporal structure knit compression will just fail.
 
2210
            self.chk_bytes = KnitVersionedFiles(
 
2211
                _KnitGraphIndex(self._pack_collection.chk_index.combined_index,
 
2212
                    add_callback=self._pack_collection.chk_index.add_callback,
 
2213
                    deltas=False, parents=False, is_locked=self.is_locked),
 
2214
                data_access=self._pack_collection.chk_index.data_access,
 
2215
                max_delta_chain=0)
 
2216
        else:
 
2217
            self.chk_bytes = None
 
2218
        # True when the repository object is 'write locked' (as opposed to the
 
2219
        # physical lock only taken out around changes to the pack-names list.)
 
2220
        # Another way to represent this would be a decorator around the control
 
2221
        # files object that presents logical locks as physical ones - if this
 
2222
        # gets ugly consider that alternative design. RBC 20071011
 
2223
        self._write_lock_count = 0
 
2224
        self._transaction = None
 
2225
        # for tests
 
2226
        self._reconcile_does_inventory_gc = True
1693
2227
        self._reconcile_fixes_text_parents = True
1694
 
        if self._format.supports_external_lookups:
1695
 
            self._unstacked_provider = graph.CachingParentsProvider(
1696
 
                self._make_parents_provider_unstacked())
1697
 
        else:
1698
 
            self._unstacked_provider = graph.CachingParentsProvider(self)
1699
 
        self._unstacked_provider.disable_cache()
 
2228
        self._reconcile_backsup_inventory = False
1700
2229
 
1701
 
    @needs_read_lock
1702
 
    def _all_revision_ids(self):
1703
 
        """See Repository.all_revision_ids()."""
1704
 
        return [key[0] for key in self.revisions.keys()]
 
2230
    def _warn_if_deprecated(self):
 
2231
        # This class isn't deprecated, but one sub-format is
 
2232
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
 
2233
            from bzrlib import repository
 
2234
            if repository._deprecation_warning_done:
 
2235
                return
 
2236
            repository._deprecation_warning_done = True
 
2237
            warning("Format %s for %s is deprecated - please use"
 
2238
                    " 'bzr upgrade --1.6.1-rich-root'"
 
2239
                    % (self._format, self.bzrdir.transport.base))
1705
2240
 
1706
2241
    def _abort_write_group(self):
1707
2242
        self.revisions._index._key_dependencies.clear()
1708
2243
        self._pack_collection._abort_write_group()
1709
2244
 
 
2245
    def _get_source(self, to_format):
 
2246
        if to_format.network_name() == self._format.network_name():
 
2247
            return KnitPackStreamSource(self, to_format)
 
2248
        return super(KnitPackRepository, self)._get_source(to_format)
 
2249
 
1710
2250
    def _make_parents_provider(self):
1711
 
        if not self._format.supports_external_lookups:
1712
 
            return self._unstacked_provider
1713
 
        return graph.StackedParentsProvider(_LazyListJoin(
1714
 
            [self._unstacked_provider], self._fallback_repositories))
 
2251
        return graph.CachingParentsProvider(self)
1715
2252
 
1716
2253
    def _refresh_data(self):
1717
2254
        if not self.is_locked():
1718
2255
            return
1719
2256
        self._pack_collection.reload_pack_names()
1720
 
        self._unstacked_provider.disable_cache()
1721
 
        self._unstacked_provider.enable_cache()
1722
2257
 
1723
2258
    def _start_write_group(self):
1724
2259
        self._pack_collection._start_write_group()
1726
2261
    def _commit_write_group(self):
1727
2262
        hint = self._pack_collection._commit_write_group()
1728
2263
        self.revisions._index._key_dependencies.clear()
1729
 
        # The commit may have added keys that were previously cached as
1730
 
        # missing, so reset the cache.
1731
 
        self._unstacked_provider.disable_cache()
1732
 
        self._unstacked_provider.enable_cache()
1733
2264
        return hint
1734
2265
 
1735
2266
    def suspend_write_group(self):
1762
2293
        return self._write_lock_count
1763
2294
 
1764
2295
    def lock_write(self, token=None):
1765
 
        """Lock the repository for writes.
1766
 
 
1767
 
        :return: A bzrlib.repository.RepositoryWriteLockResult.
1768
 
        """
1769
2296
        locked = self.is_locked()
1770
2297
        if not self._write_lock_count and locked:
1771
2298
            raise errors.ReadOnlyError(self)
1773
2300
        if self._write_lock_count == 1:
1774
2301
            self._transaction = transactions.WriteTransaction()
1775
2302
        if not locked:
1776
 
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
1777
 
                note('%r was write locked again', self)
1778
 
            self._prev_lock = 'w'
1779
 
            self._unstacked_provider.enable_cache()
1780
2303
            for repo in self._fallback_repositories:
1781
2304
                # Writes don't affect fallback repos
1782
2305
                repo.lock_read()
1783
2306
            self._refresh_data()
1784
 
        return RepositoryWriteLockResult(self.unlock, None)
1785
2307
 
1786
2308
    def lock_read(self):
1787
 
        """Lock the repository for reads.
1788
 
 
1789
 
        :return: A bzrlib.lock.LogicalLockResult.
1790
 
        """
1791
2309
        locked = self.is_locked()
1792
2310
        if self._write_lock_count:
1793
2311
            self._write_lock_count += 1
1794
2312
        else:
1795
2313
            self.control_files.lock_read()
1796
2314
        if not locked:
1797
 
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
1798
 
                note('%r was read locked again', self)
1799
 
            self._prev_lock = 'r'
1800
 
            self._unstacked_provider.enable_cache()
1801
2315
            for repo in self._fallback_repositories:
1802
2316
                repo.lock_read()
1803
2317
            self._refresh_data()
1804
 
        return LogicalLockResult(self.unlock)
1805
2318
 
1806
2319
    def leave_lock_in_place(self):
1807
2320
        # not supported - raise an error
1812
2325
        raise NotImplementedError(self.dont_leave_lock_in_place)
1813
2326
 
1814
2327
    @needs_write_lock
1815
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2328
    def pack(self, hint=None):
1816
2329
        """Compress the data within the repository.
1817
2330
 
1818
2331
        This will pack all the data to a single pack. In future it may
1819
2332
        recompress deltas or do other such expensive operations.
1820
2333
        """
1821
 
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
2334
        self._pack_collection.pack(hint=hint)
1822
2335
 
1823
2336
    @needs_write_lock
1824
2337
    def reconcile(self, other=None, thorough=False):
1829
2342
        return reconciler
1830
2343
 
1831
2344
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
1832
 
        raise NotImplementedError(self._reconcile_pack)
 
2345
        packer = ReconcilePacker(collection, packs, extension, revs)
 
2346
        return packer.pack(pb)
1833
2347
 
1834
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1835
2348
    def unlock(self):
1836
2349
        if self._write_lock_count == 1 and self._write_group is not None:
1837
2350
            self.abort_write_group()
1838
 
            self._unstacked_provider.disable_cache()
1839
2351
            self._transaction = None
1840
2352
            self._write_lock_count = 0
1841
2353
            raise errors.BzrError(
1851
2363
            self.control_files.unlock()
1852
2364
 
1853
2365
        if not self.is_locked():
1854
 
            self._unstacked_provider.disable_cache()
1855
2366
            for repo in self._fallback_repositories:
1856
2367
                repo.unlock()
1857
2368
 
1858
2369
 
1859
 
class RepositoryFormatPack(MetaDirVersionedFileRepositoryFormat):
 
2370
class KnitPackStreamSource(StreamSource):
 
2371
    """A StreamSource used to transfer data between same-format KnitPack repos.
 
2372
 
 
2373
    This source assumes:
 
2374
        1) Same serialization format for all objects
 
2375
        2) Same root information
 
2376
        3) XML format inventories
 
2377
        4) Atomic inserts (so we can stream inventory texts before text
 
2378
           content)
 
2379
        5) No chk_bytes
 
2380
    """
 
2381
 
 
2382
    def __init__(self, from_repository, to_format):
 
2383
        super(KnitPackStreamSource, self).__init__(from_repository, to_format)
 
2384
        self._text_keys = None
 
2385
        self._text_fetch_order = 'unordered'
 
2386
 
 
2387
    def _get_filtered_inv_stream(self, revision_ids):
 
2388
        from_repo = self.from_repository
 
2389
        parent_ids = from_repo._find_parent_ids_of_revisions(revision_ids)
 
2390
        parent_keys = [(p,) for p in parent_ids]
 
2391
        find_text_keys = from_repo._find_text_key_references_from_xml_inventory_lines
 
2392
        parent_text_keys = set(find_text_keys(
 
2393
            from_repo._inventory_xml_lines_for_keys(parent_keys)))
 
2394
        content_text_keys = set()
 
2395
        knit = KnitVersionedFiles(None, None)
 
2396
        factory = KnitPlainFactory()
 
2397
        def find_text_keys_from_content(record):
 
2398
            if record.storage_kind not in ('knit-delta-gz', 'knit-ft-gz'):
 
2399
                raise ValueError("Unknown content storage kind for"
 
2400
                    " inventory text: %s" % (record.storage_kind,))
 
2401
            # It's a knit record, it has a _raw_record field (even if it was
 
2402
            # reconstituted from a network stream).
 
2403
            raw_data = record._raw_record
 
2404
            # read the entire thing
 
2405
            revision_id = record.key[-1]
 
2406
            content, _ = knit._parse_record(revision_id, raw_data)
 
2407
            if record.storage_kind == 'knit-delta-gz':
 
2408
                line_iterator = factory.get_linedelta_content(content)
 
2409
            elif record.storage_kind == 'knit-ft-gz':
 
2410
                line_iterator = factory.get_fulltext_content(content)
 
2411
            content_text_keys.update(find_text_keys(
 
2412
                [(line, revision_id) for line in line_iterator]))
 
2413
        revision_keys = [(r,) for r in revision_ids]
 
2414
        def _filtered_inv_stream():
 
2415
            source_vf = from_repo.inventories
 
2416
            stream = source_vf.get_record_stream(revision_keys,
 
2417
                                                 'unordered', False)
 
2418
            for record in stream:
 
2419
                if record.storage_kind == 'absent':
 
2420
                    raise errors.NoSuchRevision(from_repo, record.key)
 
2421
                find_text_keys_from_content(record)
 
2422
                yield record
 
2423
            self._text_keys = content_text_keys - parent_text_keys
 
2424
        return ('inventories', _filtered_inv_stream())
 
2425
 
 
2426
    def _get_text_stream(self):
 
2427
        # Note: We know we don't have to handle adding root keys, because both
 
2428
        # the source and target are the identical network name.
 
2429
        text_stream = self.from_repository.texts.get_record_stream(
 
2430
                        self._text_keys, self._text_fetch_order, False)
 
2431
        return ('texts', text_stream)
 
2432
 
 
2433
    def get_stream(self, search):
 
2434
        revision_ids = search.get_keys()
 
2435
        for stream_info in self._fetch_revision_texts(revision_ids):
 
2436
            yield stream_info
 
2437
        self._revision_keys = [(rev_id,) for rev_id in revision_ids]
 
2438
        yield self._get_filtered_inv_stream(revision_ids)
 
2439
        yield self._get_text_stream()
 
2440
 
 
2441
 
 
2442
 
 
2443
class RepositoryFormatPack(MetaDirRepositoryFormat):
1860
2444
    """Format logic for pack structured repositories.
1861
2445
 
1862
2446
    This repository format has:
1892
2476
    index_class = None
1893
2477
    _fetch_uses_deltas = True
1894
2478
    fast_deltas = False
1895
 
    supports_funky_characters = True
1896
 
    revision_graph_can_have_wrong_parents = True
1897
2479
 
1898
2480
    def initialize(self, a_bzrdir, shared=False):
1899
2481
        """Create a pack based repository.
1910
2492
        utf8_files = [('format', self.get_format_string())]
1911
2493
 
1912
2494
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1913
 
        repository = self.open(a_bzrdir=a_bzrdir, _found=True)
1914
 
        self._run_post_repo_init_hooks(repository, a_bzrdir, shared)
1915
 
        return repository
 
2495
        return self.open(a_bzrdir=a_bzrdir, _found=True)
1916
2496
 
1917
2497
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1918
2498
        """See RepositoryFormat.open().
1922
2502
                                    than normal. I.e. during 'upgrade'.
1923
2503
        """
1924
2504
        if not _found:
1925
 
            format = RepositoryFormatMetaDir.find_format(a_bzrdir)
 
2505
            format = RepositoryFormat.find_format(a_bzrdir)
1926
2506
        if _override_transport is not None:
1927
2507
            repo_transport = _override_transport
1928
2508
        else:
1936
2516
                              _serializer=self._serializer)
1937
2517
 
1938
2518
 
1939
 
class RetryPackOperations(errors.RetryWithNewPacks):
1940
 
    """Raised when we are packing and we find a missing file.
1941
 
 
1942
 
    Meant as a signaling exception, to tell the RepositoryPackCollection.pack
1943
 
    code it should try again.
1944
 
    """
1945
 
 
1946
 
    internal_error = True
1947
 
 
1948
 
    _fmt = ("Pack files have changed, reload and try pack again."
1949
 
            " context: %(context)s %(orig_error)s")
1950
 
 
1951
 
 
1952
 
class _DirectPackAccess(object):
1953
 
    """Access to data in one or more packs with less translation."""
1954
 
 
1955
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
1956
 
        """Create a _DirectPackAccess object.
1957
 
 
1958
 
        :param index_to_packs: A dict mapping index objects to the transport
1959
 
            and file names for obtaining data.
1960
 
        :param reload_func: A function to call if we determine that the pack
1961
 
            files have moved and we need to reload our caches. See
1962
 
            bzrlib.repo_fmt.pack_repo.AggregateIndex for more details.
1963
 
        """
1964
 
        self._container_writer = None
1965
 
        self._write_index = None
1966
 
        self._indices = index_to_packs
1967
 
        self._reload_func = reload_func
1968
 
        self._flush_func = flush_func
1969
 
 
1970
 
    def add_raw_records(self, key_sizes, raw_data):
1971
 
        """Add raw knit bytes to a storage area.
1972
 
 
1973
 
        The data is spooled to the container writer in one bytes-record per
1974
 
        raw data item.
1975
 
 
1976
 
        :param sizes: An iterable of tuples containing the key and size of each
1977
 
            raw data segment.
1978
 
        :param raw_data: A bytestring containing the data.
1979
 
        :return: A list of memos to retrieve the record later. Each memo is an
1980
 
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
1981
 
            length), where the index field is the write_index object supplied
1982
 
            to the PackAccess object.
1983
 
        """
1984
 
        if type(raw_data) is not str:
1985
 
            raise AssertionError(
1986
 
                'data must be plain bytes was %s' % type(raw_data))
1987
 
        result = []
1988
 
        offset = 0
1989
 
        for key, size in key_sizes:
1990
 
            p_offset, p_length = self._container_writer.add_bytes_record(
1991
 
                raw_data[offset:offset+size], [])
1992
 
            offset += size
1993
 
            result.append((self._write_index, p_offset, p_length))
1994
 
        return result
1995
 
 
1996
 
    def flush(self):
1997
 
        """Flush pending writes on this access object.
1998
 
 
1999
 
        This will flush any buffered writes to a NewPack.
2000
 
        """
2001
 
        if self._flush_func is not None:
2002
 
            self._flush_func()
2003
 
 
2004
 
    def get_raw_records(self, memos_for_retrieval):
2005
 
        """Get the raw bytes for a records.
2006
 
 
2007
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
2008
 
            length) memo for retrieving the bytes. The Pack access method
2009
 
            looks up the pack to use for a given record in its index_to_pack
2010
 
            map.
2011
 
        :return: An iterator over the bytes of the records.
2012
 
        """
2013
 
        # first pass, group into same-index requests
2014
 
        request_lists = []
2015
 
        current_index = None
2016
 
        for (index, offset, length) in memos_for_retrieval:
2017
 
            if current_index == index:
2018
 
                current_list.append((offset, length))
2019
 
            else:
2020
 
                if current_index is not None:
2021
 
                    request_lists.append((current_index, current_list))
2022
 
                current_index = index
2023
 
                current_list = [(offset, length)]
2024
 
        # handle the last entry
2025
 
        if current_index is not None:
2026
 
            request_lists.append((current_index, current_list))
2027
 
        for index, offsets in request_lists:
2028
 
            try:
2029
 
                transport, path = self._indices[index]
2030
 
            except KeyError:
2031
 
                # A KeyError here indicates that someone has triggered an index
2032
 
                # reload, and this index has gone missing, we need to start
2033
 
                # over.
2034
 
                if self._reload_func is None:
2035
 
                    # If we don't have a _reload_func there is nothing that can
2036
 
                    # be done
2037
 
                    raise
2038
 
                raise errors.RetryWithNewPacks(index,
2039
 
                                               reload_occurred=True,
2040
 
                                               exc_info=sys.exc_info())
2041
 
            try:
2042
 
                reader = pack.make_readv_reader(transport, path, offsets)
2043
 
                for names, read_func in reader.iter_records():
2044
 
                    yield read_func(None)
2045
 
            except errors.NoSuchFile:
2046
 
                # A NoSuchFile error indicates that a pack file has gone
2047
 
                # missing on disk, we need to trigger a reload, and start over.
2048
 
                if self._reload_func is None:
2049
 
                    raise
2050
 
                raise errors.RetryWithNewPacks(transport.abspath(path),
2051
 
                                               reload_occurred=False,
2052
 
                                               exc_info=sys.exc_info())
2053
 
 
2054
 
    def set_writer(self, writer, index, transport_packname):
2055
 
        """Set a writer to use for adding data."""
2056
 
        if index is not None:
2057
 
            self._indices[index] = transport_packname
2058
 
        self._container_writer = writer
2059
 
        self._write_index = index
2060
 
 
2061
 
    def reload_or_raise(self, retry_exc):
2062
 
        """Try calling the reload function, or re-raise the original exception.
2063
 
 
2064
 
        This should be called after _DirectPackAccess raises a
2065
 
        RetryWithNewPacks exception. This function will handle the common logic
2066
 
        of determining when the error is fatal versus being temporary.
2067
 
        It will also make sure that the original exception is raised, rather
2068
 
        than the RetryWithNewPacks exception.
2069
 
 
2070
 
        If this function returns, then the calling function should retry
2071
 
        whatever operation was being performed. Otherwise an exception will
2072
 
        be raised.
2073
 
 
2074
 
        :param retry_exc: A RetryWithNewPacks exception.
2075
 
        """
2076
 
        is_error = False
2077
 
        if self._reload_func is None:
2078
 
            is_error = True
2079
 
        elif not self._reload_func():
2080
 
            # The reload claimed that nothing changed
2081
 
            if not retry_exc.reload_occurred:
2082
 
                # If there wasn't an earlier reload, then we really were
2083
 
                # expecting to find changes. We didn't find them, so this is a
2084
 
                # hard error
2085
 
                is_error = True
2086
 
        if is_error:
2087
 
            exc_class, exc_value, exc_traceback = retry_exc.exc_info
2088
 
            raise exc_class, exc_value, exc_traceback
2089
 
 
2090
 
 
 
2519
class RepositoryFormatKnitPack1(RepositoryFormatPack):
 
2520
    """A no-subtrees parameterized Pack repository.
 
2521
 
 
2522
    This format was introduced in 0.92.
 
2523
    """
 
2524
 
 
2525
    repository_class = KnitPackRepository
 
2526
    _commit_builder_class = PackCommitBuilder
 
2527
    @property
 
2528
    def _serializer(self):
 
2529
        return xml5.serializer_v5
 
2530
    # What index classes to use
 
2531
    index_builder_class = InMemoryGraphIndex
 
2532
    index_class = GraphIndex
 
2533
 
 
2534
    def _get_matching_bzrdir(self):
 
2535
        return bzrdir.format_registry.make_bzrdir('pack-0.92')
 
2536
 
 
2537
    def _ignore_setting_bzrdir(self, format):
 
2538
        pass
 
2539
 
 
2540
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2541
 
 
2542
    def get_format_string(self):
 
2543
        """See RepositoryFormat.get_format_string()."""
 
2544
        return "Bazaar pack repository format 1 (needs bzr 0.92)\n"
 
2545
 
 
2546
    def get_format_description(self):
 
2547
        """See RepositoryFormat.get_format_description()."""
 
2548
        return "Packs containing knits without subtree support"
 
2549
 
 
2550
 
 
2551
class RepositoryFormatKnitPack3(RepositoryFormatPack):
 
2552
    """A subtrees parameterized Pack repository.
 
2553
 
 
2554
    This repository format uses the xml7 serializer to get:
 
2555
     - support for recording full info about the tree root
 
2556
     - support for recording tree-references
 
2557
 
 
2558
    This format was introduced in 0.92.
 
2559
    """
 
2560
 
 
2561
    repository_class = KnitPackRepository
 
2562
    _commit_builder_class = PackRootCommitBuilder
 
2563
    rich_root_data = True
 
2564
    supports_tree_reference = True
 
2565
    @property
 
2566
    def _serializer(self):
 
2567
        return xml7.serializer_v7
 
2568
    # What index classes to use
 
2569
    index_builder_class = InMemoryGraphIndex
 
2570
    index_class = GraphIndex
 
2571
 
 
2572
    def _get_matching_bzrdir(self):
 
2573
        return bzrdir.format_registry.make_bzrdir(
 
2574
            'pack-0.92-subtree')
 
2575
 
 
2576
    def _ignore_setting_bzrdir(self, format):
 
2577
        pass
 
2578
 
 
2579
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2580
 
 
2581
    def get_format_string(self):
 
2582
        """See RepositoryFormat.get_format_string()."""
 
2583
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
 
2584
 
 
2585
    def get_format_description(self):
 
2586
        """See RepositoryFormat.get_format_description()."""
 
2587
        return "Packs containing knits with subtree support\n"
 
2588
 
 
2589
 
 
2590
class RepositoryFormatKnitPack4(RepositoryFormatPack):
 
2591
    """A rich-root, no subtrees parameterized Pack repository.
 
2592
 
 
2593
    This repository format uses the xml6 serializer to get:
 
2594
     - support for recording full info about the tree root
 
2595
 
 
2596
    This format was introduced in 1.0.
 
2597
    """
 
2598
 
 
2599
    repository_class = KnitPackRepository
 
2600
    _commit_builder_class = PackRootCommitBuilder
 
2601
    rich_root_data = True
 
2602
    supports_tree_reference = False
 
2603
    @property
 
2604
    def _serializer(self):
 
2605
        return xml6.serializer_v6
 
2606
    # What index classes to use
 
2607
    index_builder_class = InMemoryGraphIndex
 
2608
    index_class = GraphIndex
 
2609
 
 
2610
    def _get_matching_bzrdir(self):
 
2611
        return bzrdir.format_registry.make_bzrdir(
 
2612
            'rich-root-pack')
 
2613
 
 
2614
    def _ignore_setting_bzrdir(self, format):
 
2615
        pass
 
2616
 
 
2617
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2618
 
 
2619
    def get_format_string(self):
 
2620
        """See RepositoryFormat.get_format_string()."""
 
2621
        return ("Bazaar pack repository format 1 with rich root"
 
2622
                " (needs bzr 1.0)\n")
 
2623
 
 
2624
    def get_format_description(self):
 
2625
        """See RepositoryFormat.get_format_description()."""
 
2626
        return "Packs containing knits with rich root support\n"
 
2627
 
 
2628
 
 
2629
class RepositoryFormatKnitPack5(RepositoryFormatPack):
 
2630
    """Repository that supports external references to allow stacking.
 
2631
 
 
2632
    New in release 1.6.
 
2633
 
 
2634
    Supports external lookups, which results in non-truncated ghosts after
 
2635
    reconcile compared to pack-0.92 formats.
 
2636
    """
 
2637
 
 
2638
    repository_class = KnitPackRepository
 
2639
    _commit_builder_class = PackCommitBuilder
 
2640
    supports_external_lookups = True
 
2641
    # What index classes to use
 
2642
    index_builder_class = InMemoryGraphIndex
 
2643
    index_class = GraphIndex
 
2644
 
 
2645
    @property
 
2646
    def _serializer(self):
 
2647
        return xml5.serializer_v5
 
2648
 
 
2649
    def _get_matching_bzrdir(self):
 
2650
        return bzrdir.format_registry.make_bzrdir('1.6')
 
2651
 
 
2652
    def _ignore_setting_bzrdir(self, format):
 
2653
        pass
 
2654
 
 
2655
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2656
 
 
2657
    def get_format_string(self):
 
2658
        """See RepositoryFormat.get_format_string()."""
 
2659
        return "Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n"
 
2660
 
 
2661
    def get_format_description(self):
 
2662
        """See RepositoryFormat.get_format_description()."""
 
2663
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
 
2664
 
 
2665
 
 
2666
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
 
2667
    """A repository with rich roots and stacking.
 
2668
 
 
2669
    New in release 1.6.1.
 
2670
 
 
2671
    Supports stacking on other repositories, allowing data to be accessed
 
2672
    without being stored locally.
 
2673
    """
 
2674
 
 
2675
    repository_class = KnitPackRepository
 
2676
    _commit_builder_class = PackRootCommitBuilder
 
2677
    rich_root_data = True
 
2678
    supports_tree_reference = False # no subtrees
 
2679
    supports_external_lookups = True
 
2680
    # What index classes to use
 
2681
    index_builder_class = InMemoryGraphIndex
 
2682
    index_class = GraphIndex
 
2683
 
 
2684
    @property
 
2685
    def _serializer(self):
 
2686
        return xml6.serializer_v6
 
2687
 
 
2688
    def _get_matching_bzrdir(self):
 
2689
        return bzrdir.format_registry.make_bzrdir(
 
2690
            '1.6.1-rich-root')
 
2691
 
 
2692
    def _ignore_setting_bzrdir(self, format):
 
2693
        pass
 
2694
 
 
2695
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2696
 
 
2697
    def get_format_string(self):
 
2698
        """See RepositoryFormat.get_format_string()."""
 
2699
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
 
2700
 
 
2701
    def get_format_description(self):
 
2702
        return "Packs 5 rich-root (adds stacking support, requires bzr 1.6.1)"
 
2703
 
 
2704
 
 
2705
class RepositoryFormatKnitPack5RichRootBroken(RepositoryFormatPack):
 
2706
    """A repository with rich roots and external references.
 
2707
 
 
2708
    New in release 1.6.
 
2709
 
 
2710
    Supports external lookups, which results in non-truncated ghosts after
 
2711
    reconcile compared to pack-0.92 formats.
 
2712
 
 
2713
    This format was deprecated because the serializer it uses accidentally
 
2714
    supported subtrees, when the format was not intended to. This meant that
 
2715
    someone could accidentally fetch from an incorrect repository.
 
2716
    """
 
2717
 
 
2718
    repository_class = KnitPackRepository
 
2719
    _commit_builder_class = PackRootCommitBuilder
 
2720
    rich_root_data = True
 
2721
    supports_tree_reference = False # no subtrees
 
2722
 
 
2723
    supports_external_lookups = True
 
2724
    # What index classes to use
 
2725
    index_builder_class = InMemoryGraphIndex
 
2726
    index_class = GraphIndex
 
2727
 
 
2728
    @property
 
2729
    def _serializer(self):
 
2730
        return xml7.serializer_v7
 
2731
 
 
2732
    def _get_matching_bzrdir(self):
 
2733
        matching = bzrdir.format_registry.make_bzrdir(
 
2734
            '1.6.1-rich-root')
 
2735
        matching.repository_format = self
 
2736
        return matching
 
2737
 
 
2738
    def _ignore_setting_bzrdir(self, format):
 
2739
        pass
 
2740
 
 
2741
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2742
 
 
2743
    def get_format_string(self):
 
2744
        """See RepositoryFormat.get_format_string()."""
 
2745
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
 
2746
 
 
2747
    def get_format_description(self):
 
2748
        return ("Packs 5 rich-root (adds stacking support, requires bzr 1.6)"
 
2749
                " (deprecated)")
 
2750
 
 
2751
 
 
2752
class RepositoryFormatKnitPack6(RepositoryFormatPack):
 
2753
    """A repository with stacking and btree indexes,
 
2754
    without rich roots or subtrees.
 
2755
 
 
2756
    This is equivalent to pack-1.6 with B+Tree indices.
 
2757
    """
 
2758
 
 
2759
    repository_class = KnitPackRepository
 
2760
    _commit_builder_class = PackCommitBuilder
 
2761
    supports_external_lookups = True
 
2762
    # What index classes to use
 
2763
    index_builder_class = BTreeBuilder
 
2764
    index_class = BTreeGraphIndex
 
2765
 
 
2766
    @property
 
2767
    def _serializer(self):
 
2768
        return xml5.serializer_v5
 
2769
 
 
2770
    def _get_matching_bzrdir(self):
 
2771
        return bzrdir.format_registry.make_bzrdir('1.9')
 
2772
 
 
2773
    def _ignore_setting_bzrdir(self, format):
 
2774
        pass
 
2775
 
 
2776
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2777
 
 
2778
    def get_format_string(self):
 
2779
        """See RepositoryFormat.get_format_string()."""
 
2780
        return "Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n"
 
2781
 
 
2782
    def get_format_description(self):
 
2783
        """See RepositoryFormat.get_format_description()."""
 
2784
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
 
2785
 
 
2786
 
 
2787
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
 
2788
    """A repository with rich roots, no subtrees, stacking and btree indexes.
 
2789
 
 
2790
    1.6-rich-root with B+Tree indices.
 
2791
    """
 
2792
 
 
2793
    repository_class = KnitPackRepository
 
2794
    _commit_builder_class = PackRootCommitBuilder
 
2795
    rich_root_data = True
 
2796
    supports_tree_reference = False # no subtrees
 
2797
    supports_external_lookups = True
 
2798
    # What index classes to use
 
2799
    index_builder_class = BTreeBuilder
 
2800
    index_class = BTreeGraphIndex
 
2801
 
 
2802
    @property
 
2803
    def _serializer(self):
 
2804
        return xml6.serializer_v6
 
2805
 
 
2806
    def _get_matching_bzrdir(self):
 
2807
        return bzrdir.format_registry.make_bzrdir(
 
2808
            '1.9-rich-root')
 
2809
 
 
2810
    def _ignore_setting_bzrdir(self, format):
 
2811
        pass
 
2812
 
 
2813
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2814
 
 
2815
    def get_format_string(self):
 
2816
        """See RepositoryFormat.get_format_string()."""
 
2817
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
 
2818
 
 
2819
    def get_format_description(self):
 
2820
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
 
2821
 
 
2822
 
 
2823
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
 
2824
    """A subtrees development repository.
 
2825
 
 
2826
    This format should be retained until the second release after bzr 1.7.
 
2827
 
 
2828
    1.6.1-subtree[as it might have been] with B+Tree indices.
 
2829
 
 
2830
    This is [now] retained until we have a CHK based subtree format in
 
2831
    development.
 
2832
    """
 
2833
 
 
2834
    repository_class = KnitPackRepository
 
2835
    _commit_builder_class = PackRootCommitBuilder
 
2836
    rich_root_data = True
 
2837
    supports_tree_reference = True
 
2838
    supports_external_lookups = True
 
2839
    # What index classes to use
 
2840
    index_builder_class = BTreeBuilder
 
2841
    index_class = BTreeGraphIndex
 
2842
 
 
2843
    @property
 
2844
    def _serializer(self):
 
2845
        return xml7.serializer_v7
 
2846
 
 
2847
    def _get_matching_bzrdir(self):
 
2848
        return bzrdir.format_registry.make_bzrdir(
 
2849
            'development-subtree')
 
2850
 
 
2851
    def _ignore_setting_bzrdir(self, format):
 
2852
        pass
 
2853
 
 
2854
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2855
 
 
2856
    def get_format_string(self):
 
2857
        """See RepositoryFormat.get_format_string()."""
 
2858
        return ("Bazaar development format 2 with subtree support "
 
2859
            "(needs bzr.dev from before 1.8)\n")
 
2860
 
 
2861
    def get_format_description(self):
 
2862
        """See RepositoryFormat.get_format_description()."""
 
2863
        return ("Development repository format, currently the same as "
 
2864
            "1.6.1-subtree with B+Tree indices.\n")
2091
2865