~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Patch Queue Manager
  • Date: 2015-09-30 16:43:21 UTC
  • mfrom: (6603.2.2 fix-keep-dirty)
  • Revision ID: pqm@pqm.ubuntu.com-20150930164321-ct2v2qnmvimqt8qf
(vila) Avoid associating dirty patch headers with the previous file in the
 patch. (Colin Watson)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import re
18
20
import sys
19
21
 
25
27
from bzrlib import (
26
28
    chk_map,
27
29
    cleanup,
 
30
    config,
28
31
    debug,
29
32
    graph,
30
33
    osutils,
31
34
    pack,
32
35
    transactions,
 
36
    tsort,
33
37
    ui,
34
 
    xml5,
35
 
    xml6,
36
 
    xml7,
37
38
    )
38
39
from bzrlib.index import (
39
40
    CombinedGraphIndex,
40
41
    GraphIndexPrefixAdapter,
41
42
    )
42
 
from bzrlib.knit import (
43
 
    KnitPlainFactory,
44
 
    KnitVersionedFiles,
45
 
    _KnitGraphIndex,
46
 
    _DirectPackAccess,
47
 
    )
48
 
from bzrlib import tsort
49
43
""")
50
44
from bzrlib import (
51
 
    bzrdir,
 
45
    btree_index,
52
46
    errors,
53
47
    lockable_files,
54
48
    lockdir,
55
 
    revision as _mod_revision,
56
49
    )
57
50
 
58
 
from bzrlib.decorators import needs_write_lock, only_raises
59
 
from bzrlib.btree_index import (
60
 
    BTreeGraphIndex,
61
 
    BTreeBuilder,
62
 
    )
63
 
from bzrlib.index import (
64
 
    GraphIndex,
65
 
    InMemoryGraphIndex,
66
 
    )
67
 
from bzrlib.repofmt.knitrepo import KnitRepository
 
51
from bzrlib.decorators import (
 
52
    needs_read_lock,
 
53
    needs_write_lock,
 
54
    only_raises,
 
55
    )
 
56
from bzrlib.lock import LogicalLockResult
68
57
from bzrlib.repository import (
69
 
    CommitBuilder,
70
 
    MetaDirRepositoryFormat,
71
 
    RepositoryFormat,
72
 
    RootCommitBuilder,
73
 
    StreamSource,
 
58
    _LazyListJoin,
 
59
    MetaDirRepository,
 
60
    RepositoryFormatMetaDir,
 
61
    RepositoryWriteLockResult,
 
62
    )
 
63
from bzrlib.vf_repository import (
 
64
    MetaDirVersionedFileRepository,
 
65
    MetaDirVersionedFileRepositoryFormat,
 
66
    VersionedFileCommitBuilder,
 
67
    VersionedFileRootCommitBuilder,
74
68
    )
75
69
from bzrlib.trace import (
76
70
    mutter,
79
73
    )
80
74
 
81
75
 
82
 
class PackCommitBuilder(CommitBuilder):
83
 
    """A subclass of CommitBuilder to add texts with pack semantics.
 
76
class PackCommitBuilder(VersionedFileCommitBuilder):
 
77
    """Subclass of VersionedFileCommitBuilder to add texts with pack semantics.
84
78
 
85
79
    Specifically this uses one knit object rather than one knit object per
86
80
    added text, reducing memory and object pressure.
88
82
 
89
83
    def __init__(self, repository, parents, config, timestamp=None,
90
84
                 timezone=None, committer=None, revprops=None,
91
 
                 revision_id=None):
92
 
        CommitBuilder.__init__(self, repository, parents, config,
 
85
                 revision_id=None, lossy=False):
 
86
        VersionedFileCommitBuilder.__init__(self, repository, parents, config,
93
87
            timestamp=timestamp, timezone=timezone, committer=committer,
94
 
            revprops=revprops, revision_id=revision_id)
 
88
            revprops=revprops, revision_id=revision_id, lossy=lossy)
95
89
        self._file_graph = graph.Graph(
96
90
            repository._pack_collection.text_index.combined_index)
97
91
 
100
94
        return set([key[1] for key in self._file_graph.heads(keys)])
101
95
 
102
96
 
103
 
class PackRootCommitBuilder(RootCommitBuilder):
 
97
class PackRootCommitBuilder(VersionedFileRootCommitBuilder):
104
98
    """A subclass of RootCommitBuilder to add texts with pack semantics.
105
99
 
106
100
    Specifically this uses one knit object rather than one knit object per
109
103
 
110
104
    def __init__(self, repository, parents, config, timestamp=None,
111
105
                 timezone=None, committer=None, revprops=None,
112
 
                 revision_id=None):
113
 
        CommitBuilder.__init__(self, repository, parents, config,
114
 
            timestamp=timestamp, timezone=timezone, committer=committer,
115
 
            revprops=revprops, revision_id=revision_id)
 
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)
116
111
        self._file_graph = graph.Graph(
117
112
            repository._pack_collection.text_index.combined_index)
118
113
 
229
224
        unlimited_cache = False
230
225
        if index_type == 'chk':
231
226
            unlimited_cache = True
232
 
        setattr(self, index_type + '_index',
233
 
            self.index_class(self.index_transport,
234
 
                self.index_name(index_type, self.name),
235
 
                self.index_sizes[self.index_offset(index_type)],
236
 
                unlimited_cache=unlimited_cache))
 
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)
237
234
 
238
235
 
239
236
class ExistingPack(Pack):
320
317
        for index_type in index_types:
321
318
            old_name = self.index_name(index_type, self.name)
322
319
            new_name = '../indices/' + old_name
323
 
            self.upload_transport.rename(old_name, new_name)
 
320
            self.upload_transport.move(old_name, new_name)
324
321
            self._replace_index_with_readonly(index_type)
325
322
        new_name = '../packs/' + self.file_name()
326
 
        self.upload_transport.rename(self.file_name(), new_name)
 
323
        self.upload_transport.move(self.file_name(), new_name)
327
324
        self._state = 'finished'
328
325
 
329
326
    def _get_external_refs(self, index):
484
481
        # visible is smaller.  On the other hand none will be seen until
485
482
        # they're in the names list.
486
483
        self.index_sizes = [None, None, None, None]
487
 
        self._write_index('revision', self.revision_index, 'revision', suspend)
 
484
        self._write_index('revision', self.revision_index, 'revision',
 
485
            suspend)
488
486
        self._write_index('inventory', self.inventory_index, 'inventory',
489
487
            suspend)
490
488
        self._write_index('text', self.text_index, 'file texts', suspend)
494
492
            self.index_sizes.append(None)
495
493
            self._write_index('chk', self.chk_index,
496
494
                'content hash bytes', suspend)
497
 
        self.write_stream.close()
 
495
        self.write_stream.close(
 
496
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
498
497
        # Note that this will clobber an existing pack with the same name,
499
498
        # without checking for hash collisions. While this is undesirable this
500
499
        # is something that can be rectified in a subsequent release. One way
509
508
        new_name = self.name + '.pack'
510
509
        if not suspend:
511
510
            new_name = '../packs/' + new_name
512
 
        self.upload_transport.rename(self.random_name, new_name)
 
511
        self.upload_transport.move(self.random_name, new_name)
513
512
        self._state = 'finished'
514
513
        if 'pack' in debug.debug_flags:
515
514
            # XXX: size might be interesting?
543
542
            transport = self.upload_transport
544
543
        else:
545
544
            transport = self.index_transport
546
 
        self.index_sizes[self.index_offset(index_type)] = transport.put_file(
547
 
            index_name, index.finish(), mode=self._file_mode)
 
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)
548
553
        if 'pack' in debug.debug_flags:
549
554
            # XXX: size might be interesting?
550
555
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
672
677
        # What text keys to copy. None for 'all texts'. This is set by
673
678
        # _copy_inventory_texts
674
679
        self._text_filter = None
675
 
        self._extra_init()
676
 
 
677
 
    def _extra_init(self):
678
 
        """A template hook to allow extending the constructor trivially."""
679
 
 
680
 
    def _pack_map_and_index_list(self, index_attribute):
681
 
        """Convert a list of packs to an index pack map and index list.
682
 
 
683
 
        :param index_attribute: The attribute that the desired index is found
684
 
            on.
685
 
        :return: A tuple (map, list) where map contains the dict from
686
 
            index:pack_tuple, and list contains the indices in the preferred
687
 
            access order.
688
 
        """
689
 
        indices = []
690
 
        pack_map = {}
691
 
        for pack_obj in self.packs:
692
 
            index = getattr(pack_obj, index_attribute)
693
 
            indices.append(index)
694
 
            pack_map[index] = pack_obj
695
 
        return pack_map, indices
696
 
 
697
 
    def _index_contents(self, indices, key_filter=None):
698
 
        """Get an iterable of the index contents from a pack_map.
699
 
 
700
 
        :param indices: The list of indices to query
701
 
        :param key_filter: An optional filter to limit the keys returned.
702
 
        """
703
 
        all_index = CombinedGraphIndex(indices)
704
 
        if key_filter is None:
705
 
            return all_index.iter_all_entries()
706
 
        else:
707
 
            return all_index.iter_entries(key_filter)
708
680
 
709
681
    def pack(self, pb=None):
710
682
        """Create a new pack by reading data from other packs.
721
693
        :return: A Pack object, or None if nothing was copied.
722
694
        """
723
695
        # open a pack - using the same name as the last temporary file
724
 
        # - which has already been flushed, so its safe.
 
696
        # - which has already been flushed, so it's safe.
725
697
        # XXX: - duplicate code warning with start_write_group; fix before
726
698
        #      considering 'done'.
727
699
        if self._pack_collection._new_pack is not None:
759
731
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
760
732
        return new_pack
761
733
 
762
 
    def _update_pack_order(self, entries, index_to_pack_map):
763
 
        """Determine how we want our packs to be ordered.
764
 
 
765
 
        This changes the sort order of the self.packs list so that packs unused
766
 
        by 'entries' will be at the end of the list, so that future requests
767
 
        can avoid probing them.  Used packs will be at the front of the
768
 
        self.packs list, in the order of their first use in 'entries'.
769
 
 
770
 
        :param entries: A list of (index, ...) tuples
771
 
        :param index_to_pack_map: A mapping from index objects to pack objects.
772
 
        """
773
 
        packs = []
774
 
        seen_indexes = set()
775
 
        for entry in entries:
776
 
            index = entry[0]
777
 
            if index not in seen_indexes:
778
 
                packs.append(index_to_pack_map[index])
779
 
                seen_indexes.add(index)
780
 
        if len(packs) == len(self.packs):
781
 
            if 'pack' in debug.debug_flags:
782
 
                mutter('Not changing pack list, all packs used.')
783
 
            return
784
 
        seen_packs = set(packs)
785
 
        for pack in self.packs:
786
 
            if pack not in seen_packs:
787
 
                packs.append(pack)
788
 
                seen_packs.add(pack)
789
 
        if 'pack' in debug.debug_flags:
790
 
            old_names = [p.access_tuple()[1] for p in self.packs]
791
 
            new_names = [p.access_tuple()[1] for p in packs]
792
 
            mutter('Reordering packs\nfrom: %s\n  to: %s',
793
 
                   old_names, new_names)
794
 
        self.packs = packs
795
 
 
796
734
    def _copy_revision_texts(self):
797
735
        """Copy revision data to the new pack."""
798
 
        # select revisions
799
 
        if self.revision_ids:
800
 
            revision_keys = [(revision_id,) for revision_id in self.revision_ids]
801
 
        else:
802
 
            revision_keys = None
803
 
        # select revision keys
804
 
        revision_index_map, revision_indices = self._pack_map_and_index_list(
805
 
            'revision_index')
806
 
        revision_nodes = self._index_contents(revision_indices, revision_keys)
807
 
        revision_nodes = list(revision_nodes)
808
 
        self._update_pack_order(revision_nodes, revision_index_map)
809
 
        # copy revision keys and adjust values
810
 
        self.pb.update("Copying revision texts", 1)
811
 
        total_items, readv_group_iter = self._revision_node_readv(revision_nodes)
812
 
        list(self._copy_nodes_graph(revision_index_map, self.new_pack._writer,
813
 
            self.new_pack.revision_index, readv_group_iter, total_items))
814
 
        if 'pack' in debug.debug_flags:
815
 
            mutter('%s: create_pack: revisions copied: %s%s %d items t+%6.3fs',
816
 
                time.ctime(), self._pack_collection._upload_transport.base,
817
 
                self.new_pack.random_name,
818
 
                self.new_pack.revision_index.key_count(),
819
 
                time.time() - self.new_pack.start_time)
820
 
        self._revision_keys = revision_keys
 
736
        raise NotImplementedError(self._copy_revision_texts)
821
737
 
822
738
    def _copy_inventory_texts(self):
823
739
        """Copy the inventory texts to the new pack.
826
742
 
827
743
        Sets self._text_filter appropriately.
828
744
        """
829
 
        # select inventory keys
830
 
        inv_keys = self._revision_keys # currently the same keyspace, and note that
831
 
        # querying for keys here could introduce a bug where an inventory item
832
 
        # is missed, so do not change it to query separately without cross
833
 
        # checking like the text key check below.
834
 
        inventory_index_map, inventory_indices = self._pack_map_and_index_list(
835
 
            'inventory_index')
836
 
        inv_nodes = self._index_contents(inventory_indices, inv_keys)
837
 
        # copy inventory keys and adjust values
838
 
        # XXX: Should be a helper function to allow different inv representation
839
 
        # at this point.
840
 
        self.pb.update("Copying inventory texts", 2)
841
 
        total_items, readv_group_iter = self._least_readv_node_readv(inv_nodes)
842
 
        # Only grab the output lines if we will be processing them
843
 
        output_lines = bool(self.revision_ids)
844
 
        inv_lines = self._copy_nodes_graph(inventory_index_map,
845
 
            self.new_pack._writer, self.new_pack.inventory_index,
846
 
            readv_group_iter, total_items, output_lines=output_lines)
847
 
        if self.revision_ids:
848
 
            self._process_inventory_lines(inv_lines)
849
 
        else:
850
 
            # eat the iterator to cause it to execute.
851
 
            list(inv_lines)
852
 
            self._text_filter = None
853
 
        if 'pack' in debug.debug_flags:
854
 
            mutter('%s: create_pack: inventories copied: %s%s %d items t+%6.3fs',
855
 
                time.ctime(), self._pack_collection._upload_transport.base,
856
 
                self.new_pack.random_name,
857
 
                self.new_pack.inventory_index.key_count(),
858
 
                time.time() - self.new_pack.start_time)
 
745
        raise NotImplementedError(self._copy_inventory_texts)
859
746
 
860
747
    def _copy_text_texts(self):
861
 
        # select text keys
862
 
        text_index_map, text_nodes = self._get_text_nodes()
863
 
        if self._text_filter is not None:
864
 
            # We could return the keys copied as part of the return value from
865
 
            # _copy_nodes_graph but this doesn't work all that well with the
866
 
            # need to get line output too, so we check separately, and as we're
867
 
            # going to buffer everything anyway, we check beforehand, which
868
 
            # saves reading knit data over the wire when we know there are
869
 
            # mising records.
870
 
            text_nodes = set(text_nodes)
871
 
            present_text_keys = set(_node[1] for _node in text_nodes)
872
 
            missing_text_keys = set(self._text_filter) - present_text_keys
873
 
            if missing_text_keys:
874
 
                # TODO: raise a specific error that can handle many missing
875
 
                # keys.
876
 
                mutter("missing keys during fetch: %r", missing_text_keys)
877
 
                a_missing_key = missing_text_keys.pop()
878
 
                raise errors.RevisionNotPresent(a_missing_key[1],
879
 
                    a_missing_key[0])
880
 
        # copy text keys and adjust values
881
 
        self.pb.update("Copying content texts", 3)
882
 
        total_items, readv_group_iter = self._least_readv_node_readv(text_nodes)
883
 
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
884
 
            self.new_pack.text_index, readv_group_iter, total_items))
885
 
        self._log_copied_texts()
 
748
        raise NotImplementedError(self._copy_text_texts)
886
749
 
887
750
    def _create_pack_from_packs(self):
888
 
        self.pb.update("Opening pack", 0, 5)
889
 
        self.new_pack = self.open_pack()
890
 
        new_pack = self.new_pack
891
 
        # buffer data - we won't be reading-back during the pack creation and
892
 
        # this makes a significant difference on sftp pushes.
893
 
        new_pack.set_write_cache_size(1024*1024)
894
 
        if 'pack' in debug.debug_flags:
895
 
            plain_pack_list = ['%s%s' % (a_pack.pack_transport.base, a_pack.name)
896
 
                for a_pack in self.packs]
897
 
            if self.revision_ids is not None:
898
 
                rev_count = len(self.revision_ids)
899
 
            else:
900
 
                rev_count = 'all'
901
 
            mutter('%s: create_pack: creating pack from source packs: '
902
 
                '%s%s %s revisions wanted %s t=0',
903
 
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
904
 
                plain_pack_list, rev_count)
905
 
        self._copy_revision_texts()
906
 
        self._copy_inventory_texts()
907
 
        self._copy_text_texts()
908
 
        # select signature keys
909
 
        signature_filter = self._revision_keys # same keyspace
910
 
        signature_index_map, signature_indices = self._pack_map_and_index_list(
911
 
            'signature_index')
912
 
        signature_nodes = self._index_contents(signature_indices,
913
 
            signature_filter)
914
 
        # copy signature keys and adjust values
915
 
        self.pb.update("Copying signature texts", 4)
916
 
        self._copy_nodes(signature_nodes, signature_index_map, new_pack._writer,
917
 
            new_pack.signature_index)
918
 
        if 'pack' in debug.debug_flags:
919
 
            mutter('%s: create_pack: revision signatures copied: %s%s %d items t+%6.3fs',
920
 
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
921
 
                new_pack.signature_index.key_count(),
922
 
                time.time() - new_pack.start_time)
923
 
        # copy chk contents
924
 
        # NB XXX: how to check CHK references are present? perhaps by yielding
925
 
        # the items? How should that interact with stacked repos?
926
 
        if new_pack.chk_index is not None:
927
 
            self._copy_chks()
928
 
            if 'pack' in debug.debug_flags:
929
 
                mutter('%s: create_pack: chk content copied: %s%s %d items t+%6.3fs',
930
 
                    time.ctime(), self._pack_collection._upload_transport.base,
931
 
                    new_pack.random_name,
932
 
                    new_pack.chk_index.key_count(),
933
 
                    time.time() - new_pack.start_time)
934
 
        new_pack._check_references()
935
 
        if not self._use_pack(new_pack):
936
 
            new_pack.abort()
937
 
            return None
938
 
        self.pb.update("Finishing pack", 5)
939
 
        new_pack.finish()
940
 
        self._pack_collection.allocate(new_pack)
941
 
        return new_pack
942
 
 
943
 
    def _copy_chks(self, refs=None):
944
 
        # XXX: Todo, recursive follow-pointers facility when fetching some
945
 
        # revisions only.
946
 
        chk_index_map, chk_indices = self._pack_map_and_index_list(
947
 
            'chk_index')
948
 
        chk_nodes = self._index_contents(chk_indices, refs)
949
 
        new_refs = set()
950
 
        # TODO: This isn't strictly tasteful as we are accessing some private
951
 
        #       variables (_serializer). Perhaps a better way would be to have
952
 
        #       Repository._deserialise_chk_node()
953
 
        search_key_func = chk_map.search_key_registry.get(
954
 
            self._pack_collection.repo._serializer.search_key_name)
955
 
        def accumlate_refs(lines):
956
 
            # XXX: move to a generic location
957
 
            # Yay mismatch:
958
 
            bytes = ''.join(lines)
959
 
            node = chk_map._deserialise(bytes, ("unknown",), search_key_func)
960
 
            new_refs.update(node.refs())
961
 
        self._copy_nodes(chk_nodes, chk_index_map, self.new_pack._writer,
962
 
            self.new_pack.chk_index, output_lines=accumlate_refs)
963
 
        return new_refs
964
 
 
965
 
    def _copy_nodes(self, nodes, index_map, writer, write_index,
966
 
        output_lines=None):
967
 
        """Copy knit nodes between packs with no graph references.
968
 
 
969
 
        :param output_lines: Output full texts of copied items.
970
 
        """
971
 
        pb = ui.ui_factory.nested_progress_bar()
972
 
        try:
973
 
            return self._do_copy_nodes(nodes, index_map, writer,
974
 
                write_index, pb, output_lines=output_lines)
975
 
        finally:
976
 
            pb.finished()
977
 
 
978
 
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb,
979
 
        output_lines=None):
980
 
        # for record verification
981
 
        knit = KnitVersionedFiles(None, None)
982
 
        # plan a readv on each source pack:
983
 
        # group by pack
984
 
        nodes = sorted(nodes)
985
 
        # how to map this into knit.py - or knit.py into this?
986
 
        # we don't want the typical knit logic, we want grouping by pack
987
 
        # at this point - perhaps a helper library for the following code
988
 
        # duplication points?
989
 
        request_groups = {}
990
 
        for index, key, value in nodes:
991
 
            if index not in request_groups:
992
 
                request_groups[index] = []
993
 
            request_groups[index].append((key, value))
994
 
        record_index = 0
995
 
        pb.update("Copied record", record_index, len(nodes))
996
 
        for index, items in request_groups.iteritems():
997
 
            pack_readv_requests = []
998
 
            for key, value in items:
999
 
                # ---- KnitGraphIndex.get_position
1000
 
                bits = value[1:].split(' ')
1001
 
                offset, length = int(bits[0]), int(bits[1])
1002
 
                pack_readv_requests.append((offset, length, (key, value[0])))
1003
 
            # linear scan up the pack
1004
 
            pack_readv_requests.sort()
1005
 
            # copy the data
1006
 
            pack_obj = index_map[index]
1007
 
            transport, path = pack_obj.access_tuple()
1008
 
            try:
1009
 
                reader = pack.make_readv_reader(transport, path,
1010
 
                    [offset[0:2] for offset in pack_readv_requests])
1011
 
            except errors.NoSuchFile:
1012
 
                if self._reload_func is not None:
1013
 
                    self._reload_func()
1014
 
                raise
1015
 
            for (names, read_func), (_1, _2, (key, eol_flag)) in \
1016
 
                izip(reader.iter_records(), pack_readv_requests):
1017
 
                raw_data = read_func(None)
1018
 
                # check the header only
1019
 
                if output_lines is not None:
1020
 
                    output_lines(knit._parse_record(key[-1], raw_data)[0])
1021
 
                else:
1022
 
                    df, _ = knit._parse_record_header(key, raw_data)
1023
 
                    df.close()
1024
 
                pos, size = writer.add_bytes_record(raw_data, names)
1025
 
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
1026
 
                pb.update("Copied record", record_index)
1027
 
                record_index += 1
1028
 
 
1029
 
    def _copy_nodes_graph(self, index_map, writer, write_index,
1030
 
        readv_group_iter, total_items, output_lines=False):
1031
 
        """Copy knit nodes between packs.
1032
 
 
1033
 
        :param output_lines: Return lines present in the copied data as
1034
 
            an iterator of line,version_id.
1035
 
        """
1036
 
        pb = ui.ui_factory.nested_progress_bar()
1037
 
        try:
1038
 
            for result in self._do_copy_nodes_graph(index_map, writer,
1039
 
                write_index, output_lines, pb, readv_group_iter, total_items):
1040
 
                yield result
1041
 
        except Exception:
1042
 
            # Python 2.4 does not permit try:finally: in a generator.
1043
 
            pb.finished()
1044
 
            raise
1045
 
        else:
1046
 
            pb.finished()
1047
 
 
1048
 
    def _do_copy_nodes_graph(self, index_map, writer, write_index,
1049
 
        output_lines, pb, readv_group_iter, total_items):
1050
 
        # for record verification
1051
 
        knit = KnitVersionedFiles(None, None)
1052
 
        # for line extraction when requested (inventories only)
1053
 
        if output_lines:
1054
 
            factory = KnitPlainFactory()
1055
 
        record_index = 0
1056
 
        pb.update("Copied record", record_index, total_items)
1057
 
        for index, readv_vector, node_vector in readv_group_iter:
1058
 
            # copy the data
1059
 
            pack_obj = index_map[index]
1060
 
            transport, path = pack_obj.access_tuple()
1061
 
            try:
1062
 
                reader = pack.make_readv_reader(transport, path, readv_vector)
1063
 
            except errors.NoSuchFile:
1064
 
                if self._reload_func is not None:
1065
 
                    self._reload_func()
1066
 
                raise
1067
 
            for (names, read_func), (key, eol_flag, references) in \
1068
 
                izip(reader.iter_records(), node_vector):
1069
 
                raw_data = read_func(None)
1070
 
                if output_lines:
1071
 
                    # read the entire thing
1072
 
                    content, _ = knit._parse_record(key[-1], raw_data)
1073
 
                    if len(references[-1]) == 0:
1074
 
                        line_iterator = factory.get_fulltext_content(content)
1075
 
                    else:
1076
 
                        line_iterator = factory.get_linedelta_content(content)
1077
 
                    for line in line_iterator:
1078
 
                        yield line, key
1079
 
                else:
1080
 
                    # check the header only
1081
 
                    df, _ = knit._parse_record_header(key, raw_data)
1082
 
                    df.close()
1083
 
                pos, size = writer.add_bytes_record(raw_data, names)
1084
 
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size), references)
1085
 
                pb.update("Copied record", record_index)
1086
 
                record_index += 1
1087
 
 
1088
 
    def _get_text_nodes(self):
1089
 
        text_index_map, text_indices = self._pack_map_and_index_list(
1090
 
            'text_index')
1091
 
        return text_index_map, self._index_contents(text_indices,
1092
 
            self._text_filter)
1093
 
 
1094
 
    def _least_readv_node_readv(self, nodes):
1095
 
        """Generate request groups for nodes using the least readv's.
1096
 
 
1097
 
        :param nodes: An iterable of graph index nodes.
1098
 
        :return: Total node count and an iterator of the data needed to perform
1099
 
            readvs to obtain the data for nodes. Each item yielded by the
1100
 
            iterator is a tuple with:
1101
 
            index, readv_vector, node_vector. readv_vector is a list ready to
1102
 
            hand to the transport readv method, and node_vector is a list of
1103
 
            (key, eol_flag, references) for the node retrieved by the
1104
 
            matching readv_vector.
1105
 
        """
1106
 
        # group by pack so we do one readv per pack
1107
 
        nodes = sorted(nodes)
1108
 
        total = len(nodes)
1109
 
        request_groups = {}
1110
 
        for index, key, value, references in nodes:
1111
 
            if index not in request_groups:
1112
 
                request_groups[index] = []
1113
 
            request_groups[index].append((key, value, references))
1114
 
        result = []
1115
 
        for index, items in request_groups.iteritems():
1116
 
            pack_readv_requests = []
1117
 
            for key, value, references in items:
1118
 
                # ---- KnitGraphIndex.get_position
1119
 
                bits = value[1:].split(' ')
1120
 
                offset, length = int(bits[0]), int(bits[1])
1121
 
                pack_readv_requests.append(
1122
 
                    ((offset, length), (key, value[0], references)))
1123
 
            # linear scan up the pack to maximum range combining.
1124
 
            pack_readv_requests.sort()
1125
 
            # split out the readv and the node data.
1126
 
            pack_readv = [readv for readv, node in pack_readv_requests]
1127
 
            node_vector = [node for readv, node in pack_readv_requests]
1128
 
            result.append((index, pack_readv, node_vector))
1129
 
        return total, result
 
751
        raise NotImplementedError(self._create_pack_from_packs)
1130
752
 
1131
753
    def _log_copied_texts(self):
1132
754
        if 'pack' in debug.debug_flags:
1136
758
                self.new_pack.text_index.key_count(),
1137
759
                time.time() - self.new_pack.start_time)
1138
760
 
1139
 
    def _process_inventory_lines(self, inv_lines):
1140
 
        """Use up the inv_lines generator and setup a text key filter."""
1141
 
        repo = self._pack_collection.repo
1142
 
        fileid_revisions = repo._find_file_ids_from_xml_inventory_lines(
1143
 
            inv_lines, self.revision_keys)
1144
 
        text_filter = []
1145
 
        for fileid, file_revids in fileid_revisions.iteritems():
1146
 
            text_filter.extend([(fileid, file_revid) for file_revid in file_revids])
1147
 
        self._text_filter = text_filter
1148
 
 
1149
 
    def _revision_node_readv(self, revision_nodes):
1150
 
        """Return the total revisions and the readv's to issue.
1151
 
 
1152
 
        :param revision_nodes: The revision index contents for the packs being
1153
 
            incorporated into the new pack.
1154
 
        :return: As per _least_readv_node_readv.
1155
 
        """
1156
 
        return self._least_readv_node_readv(revision_nodes)
1157
 
 
1158
761
    def _use_pack(self, new_pack):
1159
762
        """Return True if new_pack should be used.
1160
763
 
1164
767
        return new_pack.data_inserted()
1165
768
 
1166
769
 
1167
 
class OptimisingPacker(Packer):
1168
 
    """A packer which spends more time to create better disk layouts."""
1169
 
 
1170
 
    def _revision_node_readv(self, revision_nodes):
1171
 
        """Return the total revisions and the readv's to issue.
1172
 
 
1173
 
        This sort places revisions in topological order with the ancestors
1174
 
        after the children.
1175
 
 
1176
 
        :param revision_nodes: The revision index contents for the packs being
1177
 
            incorporated into the new pack.
1178
 
        :return: As per _least_readv_node_readv.
1179
 
        """
1180
 
        # build an ancestors dict
1181
 
        ancestors = {}
1182
 
        by_key = {}
1183
 
        for index, key, value, references in revision_nodes:
1184
 
            ancestors[key] = references[0]
1185
 
            by_key[key] = (index, value, references)
1186
 
        order = tsort.topo_sort(ancestors)
1187
 
        total = len(order)
1188
 
        # Single IO is pathological, but it will work as a starting point.
1189
 
        requests = []
1190
 
        for key in reversed(order):
1191
 
            index, value, references = by_key[key]
1192
 
            # ---- KnitGraphIndex.get_position
1193
 
            bits = value[1:].split(' ')
1194
 
            offset, length = int(bits[0]), int(bits[1])
1195
 
            requests.append(
1196
 
                (index, [(offset, length)], [(key, value[0], references)]))
1197
 
        # TODO: combine requests in the same index that are in ascending order.
1198
 
        return total, requests
1199
 
 
1200
 
    def open_pack(self):
1201
 
        """Open a pack for the pack we are creating."""
1202
 
        new_pack = super(OptimisingPacker, self).open_pack()
1203
 
        # Turn on the optimization flags for all the index builders.
1204
 
        new_pack.revision_index.set_optimize(for_size=True)
1205
 
        new_pack.inventory_index.set_optimize(for_size=True)
1206
 
        new_pack.text_index.set_optimize(for_size=True)
1207
 
        new_pack.signature_index.set_optimize(for_size=True)
1208
 
        return new_pack
1209
 
 
1210
 
 
1211
 
class ReconcilePacker(Packer):
1212
 
    """A packer which regenerates indices etc as it copies.
1213
 
 
1214
 
    This is used by ``bzr reconcile`` to cause parent text pointers to be
1215
 
    regenerated.
1216
 
    """
1217
 
 
1218
 
    def _extra_init(self):
1219
 
        self._data_changed = False
1220
 
 
1221
 
    def _process_inventory_lines(self, inv_lines):
1222
 
        """Generate a text key reference map rather for reconciling with."""
1223
 
        repo = self._pack_collection.repo
1224
 
        refs = repo._find_text_key_references_from_xml_inventory_lines(
1225
 
            inv_lines)
1226
 
        self._text_refs = refs
1227
 
        # during reconcile we:
1228
 
        #  - convert unreferenced texts to full texts
1229
 
        #  - correct texts which reference a text not copied to be full texts
1230
 
        #  - copy all others as-is but with corrected parents.
1231
 
        #  - so at this point we don't know enough to decide what becomes a full
1232
 
        #    text.
1233
 
        self._text_filter = None
1234
 
 
1235
 
    def _copy_text_texts(self):
1236
 
        """generate what texts we should have and then copy."""
1237
 
        self.pb.update("Copying content texts", 3)
1238
 
        # we have three major tasks here:
1239
 
        # 1) generate the ideal index
1240
 
        repo = self._pack_collection.repo
1241
 
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
1242
 
            _1, key, _2, refs in
1243
 
            self.new_pack.revision_index.iter_all_entries()])
1244
 
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
1245
 
        # 2) generate a text_nodes list that contains all the deltas that can
1246
 
        #    be used as-is, with corrected parents.
1247
 
        ok_nodes = []
1248
 
        bad_texts = []
1249
 
        discarded_nodes = []
1250
 
        NULL_REVISION = _mod_revision.NULL_REVISION
1251
 
        text_index_map, text_nodes = self._get_text_nodes()
1252
 
        for node in text_nodes:
1253
 
            # 0 - index
1254
 
            # 1 - key
1255
 
            # 2 - value
1256
 
            # 3 - refs
1257
 
            try:
1258
 
                ideal_parents = tuple(ideal_index[node[1]])
1259
 
            except KeyError:
1260
 
                discarded_nodes.append(node)
1261
 
                self._data_changed = True
1262
 
            else:
1263
 
                if ideal_parents == (NULL_REVISION,):
1264
 
                    ideal_parents = ()
1265
 
                if ideal_parents == node[3][0]:
1266
 
                    # no change needed.
1267
 
                    ok_nodes.append(node)
1268
 
                elif ideal_parents[0:1] == node[3][0][0:1]:
1269
 
                    # the left most parent is the same, or there are no parents
1270
 
                    # today. Either way, we can preserve the representation as
1271
 
                    # long as we change the refs to be inserted.
1272
 
                    self._data_changed = True
1273
 
                    ok_nodes.append((node[0], node[1], node[2],
1274
 
                        (ideal_parents, node[3][1])))
1275
 
                    self._data_changed = True
1276
 
                else:
1277
 
                    # Reinsert this text completely
1278
 
                    bad_texts.append((node[1], ideal_parents))
1279
 
                    self._data_changed = True
1280
 
        # we're finished with some data.
1281
 
        del ideal_index
1282
 
        del text_nodes
1283
 
        # 3) bulk copy the ok data
1284
 
        total_items, readv_group_iter = self._least_readv_node_readv(ok_nodes)
1285
 
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
1286
 
            self.new_pack.text_index, readv_group_iter, total_items))
1287
 
        # 4) adhoc copy all the other texts.
1288
 
        # We have to topologically insert all texts otherwise we can fail to
1289
 
        # reconcile when parts of a single delta chain are preserved intact,
1290
 
        # and other parts are not. E.g. Discarded->d1->d2->d3. d1 will be
1291
 
        # reinserted, and if d3 has incorrect parents it will also be
1292
 
        # reinserted. If we insert d3 first, d2 is present (as it was bulk
1293
 
        # copied), so we will try to delta, but d2 is not currently able to be
1294
 
        # extracted because it's basis d1 is not present. Topologically sorting
1295
 
        # addresses this. The following generates a sort for all the texts that
1296
 
        # are being inserted without having to reference the entire text key
1297
 
        # space (we only topo sort the revisions, which is smaller).
1298
 
        topo_order = tsort.topo_sort(ancestors)
1299
 
        rev_order = dict(zip(topo_order, range(len(topo_order))))
1300
 
        bad_texts.sort(key=lambda key:rev_order.get(key[0][1], 0))
1301
 
        transaction = repo.get_transaction()
1302
 
        file_id_index = GraphIndexPrefixAdapter(
1303
 
            self.new_pack.text_index,
1304
 
            ('blank', ), 1,
1305
 
            add_nodes_callback=self.new_pack.text_index.add_nodes)
1306
 
        data_access = _DirectPackAccess(
1307
 
                {self.new_pack.text_index:self.new_pack.access_tuple()})
1308
 
        data_access.set_writer(self.new_pack._writer, self.new_pack.text_index,
1309
 
            self.new_pack.access_tuple())
1310
 
        output_texts = KnitVersionedFiles(
1311
 
            _KnitGraphIndex(self.new_pack.text_index,
1312
 
                add_callback=self.new_pack.text_index.add_nodes,
1313
 
                deltas=True, parents=True, is_locked=repo.is_locked),
1314
 
            data_access=data_access, max_delta_chain=200)
1315
 
        for key, parent_keys in bad_texts:
1316
 
            # We refer to the new pack to delta data being output.
1317
 
            # A possible improvement would be to catch errors on short reads
1318
 
            # and only flush then.
1319
 
            self.new_pack.flush()
1320
 
            parents = []
1321
 
            for parent_key in parent_keys:
1322
 
                if parent_key[0] != key[0]:
1323
 
                    # Graph parents must match the fileid
1324
 
                    raise errors.BzrError('Mismatched key parent %r:%r' %
1325
 
                        (key, parent_keys))
1326
 
                parents.append(parent_key[1])
1327
 
            text_lines = osutils.split_lines(repo.texts.get_record_stream(
1328
 
                [key], 'unordered', True).next().get_bytes_as('fulltext'))
1329
 
            output_texts.add_lines(key, parent_keys, text_lines,
1330
 
                random_id=True, check_content=False)
1331
 
        # 5) check that nothing inserted has a reference outside the keyspace.
1332
 
        missing_text_keys = self.new_pack.text_index._external_references()
1333
 
        if missing_text_keys:
1334
 
            raise errors.BzrCheckError('Reference to missing compression parents %r'
1335
 
                % (missing_text_keys,))
1336
 
        self._log_copied_texts()
1337
 
 
1338
 
    def _use_pack(self, new_pack):
1339
 
        """Override _use_pack to check for reconcile having changed content."""
1340
 
        # XXX: we might be better checking this at the copy time.
1341
 
        original_inventory_keys = set()
1342
 
        inv_index = self._pack_collection.inventory_index.combined_index
1343
 
        for entry in inv_index.iter_all_entries():
1344
 
            original_inventory_keys.add(entry[1])
1345
 
        new_inventory_keys = set()
1346
 
        for entry in new_pack.inventory_index.iter_all_entries():
1347
 
            new_inventory_keys.add(entry[1])
1348
 
        if new_inventory_keys != original_inventory_keys:
1349
 
            self._data_changed = True
1350
 
        return new_pack.data_inserted() and self._data_changed
1351
 
 
1352
 
 
1353
770
class RepositoryPackCollection(object):
1354
771
    """Management of packs within a repository.
1355
772
 
1356
773
    :ivar _names: map of {pack_name: (index_size,)}
1357
774
    """
1358
775
 
1359
 
    pack_factory = NewPack
1360
 
    resumed_pack_factory = ResumedPack
 
776
    pack_factory = None
 
777
    resumed_pack_factory = None
 
778
    normal_packer_class = None
 
779
    optimising_packer_class = None
1361
780
 
1362
781
    def __init__(self, repo, transport, index_transport, upload_transport,
1363
782
                 pack_transport, index_builder_class, index_class,
1414
833
                set(all_combined).difference([combined_idx]))
1415
834
        # resumed packs
1416
835
        self._resumed_packs = []
 
836
        self.config_stack = config.LocationStack(self.transport.base)
1417
837
 
1418
838
    def __repr__(self):
1419
839
        return '%s(%r)' % (self.__class__.__name__, self.repo)
1504
924
            'containing %d revisions. Packing %d files into %d affecting %d'
1505
925
            ' revisions', self, total_packs, total_revisions, num_old_packs,
1506
926
            num_new_packs, num_revs_affected)
1507
 
        result = self._execute_pack_operations(pack_operations,
 
927
        result = self._execute_pack_operations(pack_operations, packer_class=self.normal_packer_class,
1508
928
                                      reload_func=self._restart_autopack)
1509
929
        mutter('Auto-packing repository %s completed', self)
1510
930
        return result
1511
931
 
1512
 
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
1513
 
                                 reload_func=None):
 
932
    def _execute_pack_operations(self, pack_operations, packer_class,
 
933
            reload_func=None):
1514
934
        """Execute a series of pack operations.
1515
935
 
1516
936
        :param pack_operations: A list of [revision_count, packs_to_combine].
1517
 
        :param _packer_class: The class of packer to use (default: Packer).
 
937
        :param packer_class: The class of packer to use
1518
938
        :return: The new pack names.
1519
939
        """
1520
940
        for revision_count, packs in pack_operations:
1521
941
            # we may have no-ops from the setup logic
1522
942
            if len(packs) == 0:
1523
943
                continue
1524
 
            packer = _packer_class(self, packs, '.autopack',
 
944
            packer = packer_class(self, packs, '.autopack',
1525
945
                                   reload_func=reload_func)
1526
946
            try:
1527
 
                packer.pack()
 
947
                result = packer.pack()
1528
948
            except errors.RetryWithNewPacks:
1529
949
                # An exception is propagating out of this context, make sure
1530
950
                # this packer has cleaned up. Packer() doesn't set its new_pack
1533
953
                if packer.new_pack is not None:
1534
954
                    packer.new_pack.abort()
1535
955
                raise
 
956
            if result is None:
 
957
                return
1536
958
            for pack in packs:
1537
959
                self._remove_pack_from_memory(pack)
1538
960
        # record the newly available packs and stop advertising the old
1560
982
        """Is the collection already packed?"""
1561
983
        return not (self.repo._format.pack_compresses or (len(self._names) > 1))
1562
984
 
1563
 
    def pack(self, hint=None):
 
985
    def pack(self, hint=None, clean_obsolete_packs=False):
1564
986
        """Pack the pack collection totally."""
1565
987
        self.ensure_loaded()
1566
988
        total_packs = len(self._names)
1572
994
        mutter('Packing repository %s, which has %d pack files, '
1573
995
            'containing %d revisions with hint %r.', self, total_packs,
1574
996
            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
        """
1575
1011
        # determine which packs need changing
1576
1012
        pack_operations = [[0, []]]
1577
1013
        for pack in self.all_packs():
1580
1016
                # or this pack was included in the hint.
1581
1017
                pack_operations[-1][0] += pack.get_revision_count()
1582
1018
                pack_operations[-1][1].append(pack)
1583
 
        self._execute_pack_operations(pack_operations, OptimisingPacker)
 
1019
        self._execute_pack_operations(pack_operations,
 
1020
            packer_class=self.optimising_packer_class,
 
1021
            reload_func=self._restart_pack_operations)
1584
1022
 
1585
1023
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1586
1024
        """Plan a pack operation.
1596
1034
        pack_operations = [[0, []]]
1597
1035
        # plan out what packs to keep, and what to reorganise
1598
1036
        while len(existing_packs):
1599
 
            # take the largest pack, and if its less than the head of the
 
1037
            # take the largest pack, and if it's less than the head of the
1600
1038
            # distribution chart we will include its contents in the new pack
1601
 
            # for that position. If its larger, we remove its size from the
 
1039
            # for that position. If it's larger, we remove its size from the
1602
1040
            # distribution chart
1603
1041
            next_pack_rev_count, next_pack = existing_packs.pop(0)
1604
1042
            if next_pack_rev_count >= pack_distribution[0]:
1639
1077
 
1640
1078
        :return: True if the disk names had not been previously read.
1641
1079
        """
1642
 
        # NB: if you see an assertion error here, its probably access against
 
1080
        # NB: if you see an assertion error here, it's probably access against
1643
1081
        # an unlocked repo. Naughty.
1644
1082
        if not self.repo.is_locked():
1645
1083
            raise errors.ObjectNotLocked(self.repo)
1675
1113
            txt_index = self._make_index(name, '.tix')
1676
1114
            sig_index = self._make_index(name, '.six')
1677
1115
            if self.chk_index is not None:
1678
 
                chk_index = self._make_index(name, '.cix', unlimited_cache=True)
 
1116
                chk_index = self._make_index(name, '.cix', is_chk=True)
1679
1117
            else:
1680
1118
                chk_index = None
1681
1119
            result = ExistingPack(self._pack_transport, name, rev_index,
1701
1139
            sig_index = self._make_index(name, '.six', resume=True)
1702
1140
            if self.chk_index is not None:
1703
1141
                chk_index = self._make_index(name, '.cix', resume=True,
1704
 
                                             unlimited_cache=True)
 
1142
                                             is_chk=True)
1705
1143
            else:
1706
1144
                chk_index = None
1707
1145
            result = self.resumed_pack_factory(name, rev_index, inv_index,
1737
1175
        return self._index_class(self.transport, 'pack-names', None
1738
1176
                ).iter_all_entries()
1739
1177
 
1740
 
    def _make_index(self, name, suffix, resume=False, unlimited_cache=False):
 
1178
    def _make_index(self, name, suffix, resume=False, is_chk=False):
1741
1179
        size_offset = self._suffix_offsets[suffix]
1742
1180
        index_name = name + suffix
1743
1181
        if resume:
1746
1184
        else:
1747
1185
            transport = self._index_transport
1748
1186
            index_size = self._names[name][size_offset]
1749
 
        return self._index_class(transport, index_name, index_size,
1750
 
                                 unlimited_cache=unlimited_cache)
 
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
1751
1192
 
1752
1193
    def _max_pack_count(self, total_revisions):
1753
1194
        """Return the maximum number of packs to use for total revisions.
1782
1223
        """
1783
1224
        for pack in packs:
1784
1225
            try:
1785
 
                pack.pack_transport.rename(pack.file_name(),
1786
 
                    '../obsolete_packs/' + pack.file_name())
 
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())
1787
1238
            except (errors.PathError, errors.TransportError), e:
1788
1239
                # TODO: Should these be warnings or mutters?
1789
1240
                mutter("couldn't rename obsolete pack, skipping it:\n%s"
1796
1247
                suffixes.append('.cix')
1797
1248
            for suffix in suffixes:
1798
1249
                try:
1799
 
                    self._index_transport.rename(pack.name + suffix,
 
1250
                    self._index_transport.move(pack.name + suffix,
1800
1251
                        '../obsolete_packs/' + pack.name + suffix)
1801
1252
                except (errors.PathError, errors.TransportError), e:
1802
1253
                    mutter("couldn't rename obsolete index, skipping it:\n%s"
1939
1390
                    # disk index because the set values are the same, unless
1940
1391
                    # the only index shows up as deleted by the set difference
1941
1392
                    # - which it may. Until there is a specific test for this,
1942
 
                    # assume its broken. RBC 20071017.
 
1393
                    # assume it's broken. RBC 20071017.
1943
1394
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
1944
1395
                    self._names[name] = sizes
1945
1396
                    self.get_pack_by_name(name)
2010
1461
        """
2011
1462
        # The ensure_loaded call is to handle the case where the first call
2012
1463
        # made involving the collection was to reload_pack_names, where we 
2013
 
        # don't have a view of disk contents. Its a bit of a bandaid, and
2014
 
        # causes two reads of pack-names, but its a rare corner case not struck
2015
 
        # with regular push/pull etc.
 
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.
2016
1467
        first_read = self.ensure_loaded()
2017
1468
        if first_read:
2018
1469
            return True
2037
1488
            raise
2038
1489
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
2039
1490
 
 
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
 
2040
1499
    def _clear_obsolete_packs(self, preserve=None):
2041
1500
        """Delete everything from the obsolete-packs directory.
2042
1501
 
2047
1506
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
2048
1507
        if preserve is None:
2049
1508
            preserve = set()
2050
 
        for filename in obsolete_pack_transport.list_dir('.'):
 
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:
2051
1514
            name, ext = osutils.splitext(filename)
2052
1515
            if ext == '.pack':
2053
1516
                found.append(name)
2190
1653
            self._resume_pack(token)
2191
1654
 
2192
1655
 
2193
 
class KnitPackRepository(KnitRepository):
 
1656
class PackRepository(MetaDirVersionedFileRepository):
2194
1657
    """Repository with knit objects stored inside pack containers.
2195
1658
 
2196
1659
    The layering for a KnitPackRepository is:
2199
1662
    ===================================================
2200
1663
    Tuple based apis below, string based, and key based apis above
2201
1664
    ---------------------------------------------------
2202
 
    KnitVersionedFiles
 
1665
    VersionedFiles
2203
1666
      Provides .texts, .revisions etc
2204
1667
      This adapts the N-tuple keys to physical knit records which only have a
2205
1668
      single string identifier (for historical reasons), which in older formats
2215
1678
 
2216
1679
    """
2217
1680
 
 
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
 
2218
1688
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
2219
1689
        _serializer):
2220
 
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
2221
 
            _commit_builder_class, _serializer)
2222
 
        index_transport = self._transport.clone('indices')
2223
 
        self._pack_collection = RepositoryPackCollection(self, self._transport,
2224
 
            index_transport,
2225
 
            self._transport.clone('upload'),
2226
 
            self._transport.clone('packs'),
2227
 
            _format.index_builder_class,
2228
 
            _format.index_class,
2229
 
            use_chk_index=self._format.supports_chks,
2230
 
            )
2231
 
        self.inventories = KnitVersionedFiles(
2232
 
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
2233
 
                add_callback=self._pack_collection.inventory_index.add_callback,
2234
 
                deltas=True, parents=True, is_locked=self.is_locked),
2235
 
            data_access=self._pack_collection.inventory_index.data_access,
2236
 
            max_delta_chain=200)
2237
 
        self.revisions = KnitVersionedFiles(
2238
 
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
2239
 
                add_callback=self._pack_collection.revision_index.add_callback,
2240
 
                deltas=False, parents=True, is_locked=self.is_locked,
2241
 
                track_external_parent_refs=True),
2242
 
            data_access=self._pack_collection.revision_index.data_access,
2243
 
            max_delta_chain=0)
2244
 
        self.signatures = KnitVersionedFiles(
2245
 
            _KnitGraphIndex(self._pack_collection.signature_index.combined_index,
2246
 
                add_callback=self._pack_collection.signature_index.add_callback,
2247
 
                deltas=False, parents=False, is_locked=self.is_locked),
2248
 
            data_access=self._pack_collection.signature_index.data_access,
2249
 
            max_delta_chain=0)
2250
 
        self.texts = KnitVersionedFiles(
2251
 
            _KnitGraphIndex(self._pack_collection.text_index.combined_index,
2252
 
                add_callback=self._pack_collection.text_index.add_callback,
2253
 
                deltas=True, parents=True, is_locked=self.is_locked),
2254
 
            data_access=self._pack_collection.text_index.data_access,
2255
 
            max_delta_chain=200)
2256
 
        if _format.supports_chks:
2257
 
            # No graph, no compression:- references from chks are between
2258
 
            # different objects not temporal versions of the same; and without
2259
 
            # some sort of temporal structure knit compression will just fail.
2260
 
            self.chk_bytes = KnitVersionedFiles(
2261
 
                _KnitGraphIndex(self._pack_collection.chk_index.combined_index,
2262
 
                    add_callback=self._pack_collection.chk_index.add_callback,
2263
 
                    deltas=False, parents=False, is_locked=self.is_locked),
2264
 
                data_access=self._pack_collection.chk_index.data_access,
2265
 
                max_delta_chain=0)
2266
 
        else:
2267
 
            self.chk_bytes = None
2268
 
        # True when the repository object is 'write locked' (as opposed to the
2269
 
        # physical lock only taken out around changes to the pack-names list.)
2270
 
        # Another way to represent this would be a decorator around the control
2271
 
        # files object that presents logical locks as physical ones - if this
2272
 
        # gets ugly consider that alternative design. RBC 20071011
2273
 
        self._write_lock_count = 0
2274
 
        self._transaction = None
2275
 
        # for tests
2276
 
        self._reconcile_does_inventory_gc = True
 
1690
        MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
 
1691
        self._commit_builder_class = _commit_builder_class
 
1692
        self._serializer = _serializer
2277
1693
        self._reconcile_fixes_text_parents = True
2278
 
        self._reconcile_backsup_inventory = False
 
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()
2279
1700
 
2280
 
    def _warn_if_deprecated(self, branch=None):
2281
 
        # This class isn't deprecated, but one sub-format is
2282
 
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
2283
 
            super(KnitPackRepository, self)._warn_if_deprecated(branch)
 
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()]
2284
1705
 
2285
1706
    def _abort_write_group(self):
2286
1707
        self.revisions._index._key_dependencies.clear()
2287
1708
        self._pack_collection._abort_write_group()
2288
1709
 
2289
 
    def _get_source(self, to_format):
2290
 
        if to_format.network_name() == self._format.network_name():
2291
 
            return KnitPackStreamSource(self, to_format)
2292
 
        return super(KnitPackRepository, self)._get_source(to_format)
2293
 
 
2294
1710
    def _make_parents_provider(self):
2295
 
        return graph.CachingParentsProvider(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))
2296
1715
 
2297
1716
    def _refresh_data(self):
2298
1717
        if not self.is_locked():
2299
1718
            return
2300
1719
        self._pack_collection.reload_pack_names()
 
1720
        self._unstacked_provider.disable_cache()
 
1721
        self._unstacked_provider.enable_cache()
2301
1722
 
2302
1723
    def _start_write_group(self):
2303
1724
        self._pack_collection._start_write_group()
2305
1726
    def _commit_write_group(self):
2306
1727
        hint = self._pack_collection._commit_write_group()
2307
1728
        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()
2308
1733
        return hint
2309
1734
 
2310
1735
    def suspend_write_group(self):
2337
1762
        return self._write_lock_count
2338
1763
 
2339
1764
    def lock_write(self, token=None):
 
1765
        """Lock the repository for writes.
 
1766
 
 
1767
        :return: A bzrlib.repository.RepositoryWriteLockResult.
 
1768
        """
2340
1769
        locked = self.is_locked()
2341
1770
        if not self._write_lock_count and locked:
2342
1771
            raise errors.ReadOnlyError(self)
2347
1776
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
2348
1777
                note('%r was write locked again', self)
2349
1778
            self._prev_lock = 'w'
 
1779
            self._unstacked_provider.enable_cache()
2350
1780
            for repo in self._fallback_repositories:
2351
1781
                # Writes don't affect fallback repos
2352
1782
                repo.lock_read()
2353
1783
            self._refresh_data()
 
1784
        return RepositoryWriteLockResult(self.unlock, None)
2354
1785
 
2355
1786
    def lock_read(self):
 
1787
        """Lock the repository for reads.
 
1788
 
 
1789
        :return: A bzrlib.lock.LogicalLockResult.
 
1790
        """
2356
1791
        locked = self.is_locked()
2357
1792
        if self._write_lock_count:
2358
1793
            self._write_lock_count += 1
2362
1797
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
2363
1798
                note('%r was read locked again', self)
2364
1799
            self._prev_lock = 'r'
 
1800
            self._unstacked_provider.enable_cache()
2365
1801
            for repo in self._fallback_repositories:
2366
1802
                repo.lock_read()
2367
1803
            self._refresh_data()
 
1804
        return LogicalLockResult(self.unlock)
2368
1805
 
2369
1806
    def leave_lock_in_place(self):
2370
1807
        # not supported - raise an error
2375
1812
        raise NotImplementedError(self.dont_leave_lock_in_place)
2376
1813
 
2377
1814
    @needs_write_lock
2378
 
    def pack(self, hint=None):
 
1815
    def pack(self, hint=None, clean_obsolete_packs=False):
2379
1816
        """Compress the data within the repository.
2380
1817
 
2381
1818
        This will pack all the data to a single pack. In future it may
2382
1819
        recompress deltas or do other such expensive operations.
2383
1820
        """
2384
 
        self._pack_collection.pack(hint=hint)
 
1821
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
2385
1822
 
2386
1823
    @needs_write_lock
2387
1824
    def reconcile(self, other=None, thorough=False):
2392
1829
        return reconciler
2393
1830
 
2394
1831
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
2395
 
        packer = ReconcilePacker(collection, packs, extension, revs)
2396
 
        return packer.pack(pb)
 
1832
        raise NotImplementedError(self._reconcile_pack)
2397
1833
 
2398
1834
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2399
1835
    def unlock(self):
2400
1836
        if self._write_lock_count == 1 and self._write_group is not None:
2401
1837
            self.abort_write_group()
 
1838
            self._unstacked_provider.disable_cache()
2402
1839
            self._transaction = None
2403
1840
            self._write_lock_count = 0
2404
1841
            raise errors.BzrError(
2414
1851
            self.control_files.unlock()
2415
1852
 
2416
1853
        if not self.is_locked():
 
1854
            self._unstacked_provider.disable_cache()
2417
1855
            for repo in self._fallback_repositories:
2418
1856
                repo.unlock()
2419
1857
 
2420
1858
 
2421
 
class KnitPackStreamSource(StreamSource):
2422
 
    """A StreamSource used to transfer data between same-format KnitPack repos.
2423
 
 
2424
 
    This source assumes:
2425
 
        1) Same serialization format for all objects
2426
 
        2) Same root information
2427
 
        3) XML format inventories
2428
 
        4) Atomic inserts (so we can stream inventory texts before text
2429
 
           content)
2430
 
        5) No chk_bytes
2431
 
    """
2432
 
 
2433
 
    def __init__(self, from_repository, to_format):
2434
 
        super(KnitPackStreamSource, self).__init__(from_repository, to_format)
2435
 
        self._text_keys = None
2436
 
        self._text_fetch_order = 'unordered'
2437
 
 
2438
 
    def _get_filtered_inv_stream(self, revision_ids):
2439
 
        from_repo = self.from_repository
2440
 
        parent_ids = from_repo._find_parent_ids_of_revisions(revision_ids)
2441
 
        parent_keys = [(p,) for p in parent_ids]
2442
 
        find_text_keys = from_repo._find_text_key_references_from_xml_inventory_lines
2443
 
        parent_text_keys = set(find_text_keys(
2444
 
            from_repo._inventory_xml_lines_for_keys(parent_keys)))
2445
 
        content_text_keys = set()
2446
 
        knit = KnitVersionedFiles(None, None)
2447
 
        factory = KnitPlainFactory()
2448
 
        def find_text_keys_from_content(record):
2449
 
            if record.storage_kind not in ('knit-delta-gz', 'knit-ft-gz'):
2450
 
                raise ValueError("Unknown content storage kind for"
2451
 
                    " inventory text: %s" % (record.storage_kind,))
2452
 
            # It's a knit record, it has a _raw_record field (even if it was
2453
 
            # reconstituted from a network stream).
2454
 
            raw_data = record._raw_record
2455
 
            # read the entire thing
2456
 
            revision_id = record.key[-1]
2457
 
            content, _ = knit._parse_record(revision_id, raw_data)
2458
 
            if record.storage_kind == 'knit-delta-gz':
2459
 
                line_iterator = factory.get_linedelta_content(content)
2460
 
            elif record.storage_kind == 'knit-ft-gz':
2461
 
                line_iterator = factory.get_fulltext_content(content)
2462
 
            content_text_keys.update(find_text_keys(
2463
 
                [(line, revision_id) for line in line_iterator]))
2464
 
        revision_keys = [(r,) for r in revision_ids]
2465
 
        def _filtered_inv_stream():
2466
 
            source_vf = from_repo.inventories
2467
 
            stream = source_vf.get_record_stream(revision_keys,
2468
 
                                                 'unordered', False)
2469
 
            for record in stream:
2470
 
                if record.storage_kind == 'absent':
2471
 
                    raise errors.NoSuchRevision(from_repo, record.key)
2472
 
                find_text_keys_from_content(record)
2473
 
                yield record
2474
 
            self._text_keys = content_text_keys - parent_text_keys
2475
 
        return ('inventories', _filtered_inv_stream())
2476
 
 
2477
 
    def _get_text_stream(self):
2478
 
        # Note: We know we don't have to handle adding root keys, because both
2479
 
        # the source and target are the identical network name.
2480
 
        text_stream = self.from_repository.texts.get_record_stream(
2481
 
                        self._text_keys, self._text_fetch_order, False)
2482
 
        return ('texts', text_stream)
2483
 
 
2484
 
    def get_stream(self, search):
2485
 
        revision_ids = search.get_keys()
2486
 
        for stream_info in self._fetch_revision_texts(revision_ids):
2487
 
            yield stream_info
2488
 
        self._revision_keys = [(rev_id,) for rev_id in revision_ids]
2489
 
        yield self._get_filtered_inv_stream(revision_ids)
2490
 
        yield self._get_text_stream()
2491
 
 
2492
 
 
2493
 
 
2494
 
class RepositoryFormatPack(MetaDirRepositoryFormat):
 
1859
class RepositoryFormatPack(MetaDirVersionedFileRepositoryFormat):
2495
1860
    """Format logic for pack structured repositories.
2496
1861
 
2497
1862
    This repository format has:
2527
1892
    index_class = None
2528
1893
    _fetch_uses_deltas = True
2529
1894
    fast_deltas = False
 
1895
    supports_funky_characters = True
 
1896
    revision_graph_can_have_wrong_parents = True
2530
1897
 
2531
1898
    def initialize(self, a_bzrdir, shared=False):
2532
1899
        """Create a pack based repository.
2543
1910
        utf8_files = [('format', self.get_format_string())]
2544
1911
 
2545
1912
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
2546
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1913
        repository = self.open(a_bzrdir=a_bzrdir, _found=True)
 
1914
        self._run_post_repo_init_hooks(repository, a_bzrdir, shared)
 
1915
        return repository
2547
1916
 
2548
1917
    def open(self, a_bzrdir, _found=False, _override_transport=None):
2549
1918
        """See RepositoryFormat.open().
2553
1922
                                    than normal. I.e. during 'upgrade'.
2554
1923
        """
2555
1924
        if not _found:
2556
 
            format = RepositoryFormat.find_format(a_bzrdir)
 
1925
            format = RepositoryFormatMetaDir.find_format(a_bzrdir)
2557
1926
        if _override_transport is not None:
2558
1927
            repo_transport = _override_transport
2559
1928
        else:
2567
1936
                              _serializer=self._serializer)
2568
1937
 
2569
1938
 
2570
 
class RepositoryFormatKnitPack1(RepositoryFormatPack):
2571
 
    """A no-subtrees parameterized Pack repository.
2572
 
 
2573
 
    This format was introduced in 0.92.
2574
 
    """
2575
 
 
2576
 
    repository_class = KnitPackRepository
2577
 
    _commit_builder_class = PackCommitBuilder
2578
 
    @property
2579
 
    def _serializer(self):
2580
 
        return xml5.serializer_v5
2581
 
    # What index classes to use
2582
 
    index_builder_class = InMemoryGraphIndex
2583
 
    index_class = GraphIndex
2584
 
 
2585
 
    def _get_matching_bzrdir(self):
2586
 
        return bzrdir.format_registry.make_bzrdir('pack-0.92')
2587
 
 
2588
 
    def _ignore_setting_bzrdir(self, format):
2589
 
        pass
2590
 
 
2591
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2592
 
 
2593
 
    def get_format_string(self):
2594
 
        """See RepositoryFormat.get_format_string()."""
2595
 
        return "Bazaar pack repository format 1 (needs bzr 0.92)\n"
2596
 
 
2597
 
    def get_format_description(self):
2598
 
        """See RepositoryFormat.get_format_description()."""
2599
 
        return "Packs containing knits without subtree support"
2600
 
 
2601
 
 
2602
 
class RepositoryFormatKnitPack3(RepositoryFormatPack):
2603
 
    """A subtrees parameterized Pack repository.
2604
 
 
2605
 
    This repository format uses the xml7 serializer to get:
2606
 
     - support for recording full info about the tree root
2607
 
     - support for recording tree-references
2608
 
 
2609
 
    This format was introduced in 0.92.
2610
 
    """
2611
 
 
2612
 
    repository_class = KnitPackRepository
2613
 
    _commit_builder_class = PackRootCommitBuilder
2614
 
    rich_root_data = True
2615
 
    experimental = True
2616
 
    supports_tree_reference = True
2617
 
    @property
2618
 
    def _serializer(self):
2619
 
        return xml7.serializer_v7
2620
 
    # What index classes to use
2621
 
    index_builder_class = InMemoryGraphIndex
2622
 
    index_class = GraphIndex
2623
 
 
2624
 
    def _get_matching_bzrdir(self):
2625
 
        return bzrdir.format_registry.make_bzrdir(
2626
 
            'pack-0.92-subtree')
2627
 
 
2628
 
    def _ignore_setting_bzrdir(self, format):
2629
 
        pass
2630
 
 
2631
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2632
 
 
2633
 
    def get_format_string(self):
2634
 
        """See RepositoryFormat.get_format_string()."""
2635
 
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
2636
 
 
2637
 
    def get_format_description(self):
2638
 
        """See RepositoryFormat.get_format_description()."""
2639
 
        return "Packs containing knits with subtree support\n"
2640
 
 
2641
 
 
2642
 
class RepositoryFormatKnitPack4(RepositoryFormatPack):
2643
 
    """A rich-root, no subtrees parameterized Pack repository.
2644
 
 
2645
 
    This repository format uses the xml6 serializer to get:
2646
 
     - support for recording full info about the tree root
2647
 
 
2648
 
    This format was introduced in 1.0.
2649
 
    """
2650
 
 
2651
 
    repository_class = KnitPackRepository
2652
 
    _commit_builder_class = PackRootCommitBuilder
2653
 
    rich_root_data = True
2654
 
    supports_tree_reference = False
2655
 
    @property
2656
 
    def _serializer(self):
2657
 
        return xml6.serializer_v6
2658
 
    # What index classes to use
2659
 
    index_builder_class = InMemoryGraphIndex
2660
 
    index_class = GraphIndex
2661
 
 
2662
 
    def _get_matching_bzrdir(self):
2663
 
        return bzrdir.format_registry.make_bzrdir(
2664
 
            'rich-root-pack')
2665
 
 
2666
 
    def _ignore_setting_bzrdir(self, format):
2667
 
        pass
2668
 
 
2669
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2670
 
 
2671
 
    def get_format_string(self):
2672
 
        """See RepositoryFormat.get_format_string()."""
2673
 
        return ("Bazaar pack repository format 1 with rich root"
2674
 
                " (needs bzr 1.0)\n")
2675
 
 
2676
 
    def get_format_description(self):
2677
 
        """See RepositoryFormat.get_format_description()."""
2678
 
        return "Packs containing knits with rich root support\n"
2679
 
 
2680
 
 
2681
 
class RepositoryFormatKnitPack5(RepositoryFormatPack):
2682
 
    """Repository that supports external references to allow stacking.
2683
 
 
2684
 
    New in release 1.6.
2685
 
 
2686
 
    Supports external lookups, which results in non-truncated ghosts after
2687
 
    reconcile compared to pack-0.92 formats.
2688
 
    """
2689
 
 
2690
 
    repository_class = KnitPackRepository
2691
 
    _commit_builder_class = PackCommitBuilder
2692
 
    supports_external_lookups = True
2693
 
    # What index classes to use
2694
 
    index_builder_class = InMemoryGraphIndex
2695
 
    index_class = GraphIndex
2696
 
 
2697
 
    @property
2698
 
    def _serializer(self):
2699
 
        return xml5.serializer_v5
2700
 
 
2701
 
    def _get_matching_bzrdir(self):
2702
 
        return bzrdir.format_registry.make_bzrdir('1.6')
2703
 
 
2704
 
    def _ignore_setting_bzrdir(self, format):
2705
 
        pass
2706
 
 
2707
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2708
 
 
2709
 
    def get_format_string(self):
2710
 
        """See RepositoryFormat.get_format_string()."""
2711
 
        return "Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n"
2712
 
 
2713
 
    def get_format_description(self):
2714
 
        """See RepositoryFormat.get_format_description()."""
2715
 
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
2716
 
 
2717
 
 
2718
 
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
2719
 
    """A repository with rich roots and stacking.
2720
 
 
2721
 
    New in release 1.6.1.
2722
 
 
2723
 
    Supports stacking on other repositories, allowing data to be accessed
2724
 
    without being stored locally.
2725
 
    """
2726
 
 
2727
 
    repository_class = KnitPackRepository
2728
 
    _commit_builder_class = PackRootCommitBuilder
2729
 
    rich_root_data = True
2730
 
    supports_tree_reference = False # no subtrees
2731
 
    supports_external_lookups = True
2732
 
    # What index classes to use
2733
 
    index_builder_class = InMemoryGraphIndex
2734
 
    index_class = GraphIndex
2735
 
 
2736
 
    @property
2737
 
    def _serializer(self):
2738
 
        return xml6.serializer_v6
2739
 
 
2740
 
    def _get_matching_bzrdir(self):
2741
 
        return bzrdir.format_registry.make_bzrdir(
2742
 
            '1.6.1-rich-root')
2743
 
 
2744
 
    def _ignore_setting_bzrdir(self, format):
2745
 
        pass
2746
 
 
2747
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2748
 
 
2749
 
    def get_format_string(self):
2750
 
        """See RepositoryFormat.get_format_string()."""
2751
 
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
2752
 
 
2753
 
    def get_format_description(self):
2754
 
        return "Packs 5 rich-root (adds stacking support, requires bzr 1.6.1)"
2755
 
 
2756
 
 
2757
 
class RepositoryFormatKnitPack5RichRootBroken(RepositoryFormatPack):
2758
 
    """A repository with rich roots and external references.
2759
 
 
2760
 
    New in release 1.6.
2761
 
 
2762
 
    Supports external lookups, which results in non-truncated ghosts after
2763
 
    reconcile compared to pack-0.92 formats.
2764
 
 
2765
 
    This format was deprecated because the serializer it uses accidentally
2766
 
    supported subtrees, when the format was not intended to. This meant that
2767
 
    someone could accidentally fetch from an incorrect repository.
2768
 
    """
2769
 
 
2770
 
    repository_class = KnitPackRepository
2771
 
    _commit_builder_class = PackRootCommitBuilder
2772
 
    rich_root_data = True
2773
 
    supports_tree_reference = False # no subtrees
2774
 
 
2775
 
    supports_external_lookups = True
2776
 
    # What index classes to use
2777
 
    index_builder_class = InMemoryGraphIndex
2778
 
    index_class = GraphIndex
2779
 
 
2780
 
    @property
2781
 
    def _serializer(self):
2782
 
        return xml7.serializer_v7
2783
 
 
2784
 
    def _get_matching_bzrdir(self):
2785
 
        matching = bzrdir.format_registry.make_bzrdir(
2786
 
            '1.6.1-rich-root')
2787
 
        matching.repository_format = self
2788
 
        return matching
2789
 
 
2790
 
    def _ignore_setting_bzrdir(self, format):
2791
 
        pass
2792
 
 
2793
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2794
 
 
2795
 
    def get_format_string(self):
2796
 
        """See RepositoryFormat.get_format_string()."""
2797
 
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
2798
 
 
2799
 
    def get_format_description(self):
2800
 
        return ("Packs 5 rich-root (adds stacking support, requires bzr 1.6)"
2801
 
                " (deprecated)")
2802
 
 
2803
 
 
2804
 
class RepositoryFormatKnitPack6(RepositoryFormatPack):
2805
 
    """A repository with stacking and btree indexes,
2806
 
    without rich roots or subtrees.
2807
 
 
2808
 
    This is equivalent to pack-1.6 with B+Tree indices.
2809
 
    """
2810
 
 
2811
 
    repository_class = KnitPackRepository
2812
 
    _commit_builder_class = PackCommitBuilder
2813
 
    supports_external_lookups = True
2814
 
    # What index classes to use
2815
 
    index_builder_class = BTreeBuilder
2816
 
    index_class = BTreeGraphIndex
2817
 
 
2818
 
    @property
2819
 
    def _serializer(self):
2820
 
        return xml5.serializer_v5
2821
 
 
2822
 
    def _get_matching_bzrdir(self):
2823
 
        return bzrdir.format_registry.make_bzrdir('1.9')
2824
 
 
2825
 
    def _ignore_setting_bzrdir(self, format):
2826
 
        pass
2827
 
 
2828
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2829
 
 
2830
 
    def get_format_string(self):
2831
 
        """See RepositoryFormat.get_format_string()."""
2832
 
        return "Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n"
2833
 
 
2834
 
    def get_format_description(self):
2835
 
        """See RepositoryFormat.get_format_description()."""
2836
 
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
2837
 
 
2838
 
 
2839
 
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
2840
 
    """A repository with rich roots, no subtrees, stacking and btree indexes.
2841
 
 
2842
 
    1.6-rich-root with B+Tree indices.
2843
 
    """
2844
 
 
2845
 
    repository_class = KnitPackRepository
2846
 
    _commit_builder_class = PackRootCommitBuilder
2847
 
    rich_root_data = True
2848
 
    supports_tree_reference = False # no subtrees
2849
 
    supports_external_lookups = True
2850
 
    # What index classes to use
2851
 
    index_builder_class = BTreeBuilder
2852
 
    index_class = BTreeGraphIndex
2853
 
 
2854
 
    @property
2855
 
    def _serializer(self):
2856
 
        return xml6.serializer_v6
2857
 
 
2858
 
    def _get_matching_bzrdir(self):
2859
 
        return bzrdir.format_registry.make_bzrdir(
2860
 
            '1.9-rich-root')
2861
 
 
2862
 
    def _ignore_setting_bzrdir(self, format):
2863
 
        pass
2864
 
 
2865
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2866
 
 
2867
 
    def get_format_string(self):
2868
 
        """See RepositoryFormat.get_format_string()."""
2869
 
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
2870
 
 
2871
 
    def get_format_description(self):
2872
 
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
2873
 
 
2874
 
 
2875
 
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
2876
 
    """A subtrees development repository.
2877
 
 
2878
 
    This format should be retained until the second release after bzr 1.7.
2879
 
 
2880
 
    1.6.1-subtree[as it might have been] with B+Tree indices.
2881
 
 
2882
 
    This is [now] retained until we have a CHK based subtree format in
2883
 
    development.
2884
 
    """
2885
 
 
2886
 
    repository_class = KnitPackRepository
2887
 
    _commit_builder_class = PackRootCommitBuilder
2888
 
    rich_root_data = True
2889
 
    experimental = True
2890
 
    supports_tree_reference = True
2891
 
    supports_external_lookups = True
2892
 
    # What index classes to use
2893
 
    index_builder_class = BTreeBuilder
2894
 
    index_class = BTreeGraphIndex
2895
 
 
2896
 
    @property
2897
 
    def _serializer(self):
2898
 
        return xml7.serializer_v7
2899
 
 
2900
 
    def _get_matching_bzrdir(self):
2901
 
        return bzrdir.format_registry.make_bzrdir(
2902
 
            'development-subtree')
2903
 
 
2904
 
    def _ignore_setting_bzrdir(self, format):
2905
 
        pass
2906
 
 
2907
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2908
 
 
2909
 
    def get_format_string(self):
2910
 
        """See RepositoryFormat.get_format_string()."""
2911
 
        return ("Bazaar development format 2 with subtree support "
2912
 
            "(needs bzr.dev from before 1.8)\n")
2913
 
 
2914
 
    def get_format_description(self):
2915
 
        """See RepositoryFormat.get_format_description()."""
2916
 
        return ("Development repository format, currently the same as "
2917
 
            "1.6.1-subtree with B+Tree indices.\n")
 
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
 
2918
2091